SimTK::MobilizedBody::Weld Class Reference

Zero mobilities. More...

#include <MobilizedBody.h>

Inheritance diagram for SimTK::MobilizedBody::Weld:

List of all members.

Public Member Functions
	Weld ()
	Note: there is no "reverse" weld, because "reverse" refers to how the q's and u's are defined and there are none.
	Weld (MobilizedBody &parent, const Body &)
	By default the parent body frame and the body's own frame are used as the inboard and outboard mobilizer frames, resp.
	Weld (MobilizedBody &parent, const Transform &inbFrame, const Body &, const Transform &outbFrame)
	Use this constructor to specify mobilizer frames which are not coincident with the body frames.
Weld &	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.
Weld &	addOutboardDecoration (const Transform &X_MD, const DecorativeGeometry &g)
	Add decorative geometry specified relative to the outboard mobilizer frame M attached to body B.
Weld &	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.
Weld &	setDefaultInboardFrame (const Transform &X_PF)
	Change this mobilizer's frame F on the parent body P.
Weld &	setDefaultOutboardFrame (const Transform &X_BM)
	Change this mobilizer's frame M fixed on this (the outboard) body B.
	SimTK_INSERT_DERIVED_HANDLE_DECLARATIONS (Weld, WeldImpl, MobilizedBody)

---

Detailed Description

Zero mobilities.

This degenerate "mobilizer" serves only to weld together the M frame of a body to the F frame on its parent.

---

Constructor & Destructor Documentation

SimTK::MobilizedBody::Weld::Weld

(

)

Note: there is no "reverse" weld, because "reverse" refers to how the q's and u's are defined and there are none.

SimTK::MobilizedBody::Weld::Weld	(	MobilizedBody &	parent,
		const Body &
	)

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

SimTK::MobilizedBody::Weld::Weld	(	MobilizedBody &	parent,
		const Transform &	inbFrame,
		const Body &	,
		const Transform &	outbFrame
	)

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

---

Member Function Documentation

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

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

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

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

Weld& SimTK::MobilizedBody::Weld::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::Weld::SimTK_INSERT_DERIVED_HANDLE_DECLARATIONS	(	Weld	,
		WeldImpl	,
		MobilizedBody
	)

---

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

• MobilizedBody.h