SimTK::MobilizedBody::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 SimTK::MobilizedBody::FreeLine:

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.
FreeLine &	addBodyDecoration (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.
FreeLine &	addOutboardDecoration (const Transform &X_MD, const DecorativeGeometry &g)
	Add decorative geometry specified relative to the outboard mobilizer frame M attached to body B.
FreeLine &	addInboardDecoration (const Transform &X_FD, const DecorativeGeometry &g)
	Add decorative geometry specified relative to the inboard mobilizer frame F attached to the parent body P.
FreeLine &	setDefaultInboardFrame (const Transform &X_PF)
	Change this mobilizer's frame F on the parent body P.
FreeLine &	setDefaultOutboardFrame (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

SimTK::MobilizedBody::FreeLine::FreeLine

(

Direction

= Forward

)

[explicit]

SimTK::MobilizedBody::FreeLine::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.

SimTK::MobilizedBody::FreeLine::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& SimTK::MobilizedBody::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 SimTK::MobilizedBody.

FreeLine& SimTK::MobilizedBody::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 SimTK::MobilizedBody.

FreeLine& SimTK::MobilizedBody::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 SimTK::MobilizedBody.

FreeLine& SimTK::MobilizedBody::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 SimTK::MobilizedBody.

FreeLine& SimTK::MobilizedBody::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 SimTK::MobilizedBody.

SimTK::MobilizedBody::FreeLine::SimTK_INSERT_DERIVED_HANDLE_DECLARATIONS	(	FreeLine	,
		FreeLineImpl	,
		MobilizedBody
	)

---

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

• MobilizedBody.h