FreeLine Class Reference

Five mobilities, representing unrestricted motion for a body which is inertialess along its own z axis. More...

#include <MobilizedBody.h>

Inheritance diagram for FreeLine:
MobilizedBody PIMPLHandle< MobilizedBody, MobilizedBodyImpl, true >

List of all members.

Public Member Functions

 FreeLine (Direction=Forward)
 FreeLine (MobilizedBody &parent, const Body &, Direction=Forward)
 By default the parent body frame and the body's own frame are used as the inboard and outboard mobilizer frames, resp.
 FreeLine (MobilizedBody &parent, const Transform &inbFrame, const Body &, const Transform &outbFrame, Direction=Forward)
 Use this constructor to specify mobilizer frames which are not coincident with the body frames.
FreeLineaddBodyDecoration (const Transform &X_BD, const DecorativeGeometry &g)
 Add decorative geometry specified relative to the new (outboard) body's reference frame B, or to the outboard mobilizer frame M attached to body B, or to the inboard mobilizer frame F attached to the parent body P.
FreeLineaddOutboardDecoration (const Transform &X_MD, const DecorativeGeometry &g)
 Add decorative geometry specified relative to the outboard mobilizer frame M attached to body B.
FreeLineaddInboardDecoration (const Transform &X_FD, const DecorativeGeometry &g)
 Add decorative geometry specified relative to the inboard mobilizer frame F attached to the parent body P.
FreeLinesetDefaultInboardFrame (const Transform &X_PF)
 Change this mobilizer's frame F on the parent body P.
FreeLinesetDefaultOutboardFrame (const Transform &X_BM)
 Change this mobilizer's frame M fixed on this (the outboard) body B.
 SimTK_INSERT_DERIVED_HANDLE_DECLARATIONS (FreeLine, FreeLineImpl, MobilizedBody)

Detailed Description

Five mobilities, representing unrestricted motion for a body which is inertialess along its own z axis.

The rotational generalized coordinates are the same as for the LineOrientation mobilizer. The translational coordinates are the same as in a Free mobilizer, or a Cartesian (Translation) mobilizer.


Constructor & Destructor Documentation

FreeLine ( Direction  = Forward  )  [explicit]
FreeLine ( MobilizedBody parent,
const Body ,
Direction  = Forward 
)

By default the parent body frame and the body's own frame are used as the inboard and outboard mobilizer frames, resp.

FreeLine ( MobilizedBody parent,
const Transform inbFrame,
const Body ,
const Transform outbFrame,
Direction  = Forward 
)

Use this constructor to specify mobilizer frames which are not coincident with the body frames.


Member Function Documentation

FreeLine& addBodyDecoration ( const Transform X_BD,
const DecorativeGeometry g 
) [inline]

Add decorative geometry specified relative to the new (outboard) body's reference frame B, or to the outboard mobilizer frame M attached to body B, or to the inboard mobilizer frame F attached to the parent body P.

Note that the body itself may already have had some decorative geometry on it when it was first put into this MobilizedBody; in that case this just adds more.

Reimplemented from MobilizedBody.

References MobilizedBody::addBodyDecoration().

FreeLine& addInboardDecoration ( const Transform X_FD,
const DecorativeGeometry  
) [inline]

Add decorative geometry specified relative to the inboard mobilizer frame F attached to the parent body P.

If body P already has decorative geometry on it, this just adds some more.

Reimplemented from MobilizedBody.

References MobilizedBody::addInboardDecoration().

FreeLine& addOutboardDecoration ( const Transform X_MD,
const DecorativeGeometry  
) [inline]

Add decorative geometry specified relative to the outboard mobilizer frame M attached to body B.

If body B already has decorative geometry on it, this just adds some more.

Reimplemented from MobilizedBody.

References MobilizedBody::addOutboardDecoration().

FreeLine& setDefaultInboardFrame ( const Transform X_PF  )  [inline]

Change this mobilizer's frame F on the parent body P.

Calling this method invalidates the MobilizedBody's topology, so the containing matter subsystem's realizeTopology() method must be called again. A reference to this MobilizedBody is returned so that this can be chained like an assignment operator.

Reimplemented from MobilizedBody.

References MobilizedBody::setDefaultInboardFrame().

FreeLine& setDefaultOutboardFrame ( const Transform X_BM  )  [inline]

Change this mobilizer's frame M fixed on this (the outboard) body B.

Calling this method invalidates the MobilizedBody's topology, so the containing matter subsystem's realizeTopology() method must be called again. A reference to this MobilizedBody is returned so that this can be chained like an assignment operator.

Reimplemented from MobilizedBody.

References MobilizedBody::setDefaultOutboardFrame().

SimTK_INSERT_DERIVED_HANDLE_DECLARATIONS ( FreeLine  ,
FreeLineImpl  ,
MobilizedBody   
)

The documentation for this class was generated from the following file:

Generated on Wed Dec 30 11:05:15 2009 for SimTKcore by  doxygen 1.6.1