SimTK::DecorationSubsystem Class Reference

This is the client-side handle class encapsulating the hidden implementation of the DecorationSubsystem. More...

#include <DecorationSubsystem.h>

Inheritance diagram for SimTK::DecorationSubsystem:

List of all members.

Public Member Functions
	DecorationSubsystem ()
	DecorationSubsystem (MultibodySystem &)
void	addBodyFixedDecoration (MobilizedBodyIndex bodyNum, const Transform &X_GD, const DecorativeGeometry &)
void	addRubberBandLine (MobilizedBodyIndex b1, const Vec3 &station1, MobilizedBodyIndex b2, const Vec3 &station2, const DecorativeLine &)
void	addDecorationGenerator (Stage stage, DecorationGenerator *generator)
	Add a DecorationGenerator that will be invoked to add dynamically generated geometry to the scene.
	SimTK_PIMPL_DOWNCAST (DecorationSubsystem, Subsystem)
class DecorationSubsystemGuts &	updGuts ()
const DecorationSubsystemGuts &	getGuts () const

---

Detailed Description

This is the client-side handle class encapsulating the hidden implementation of the DecorationSubsystem.

Any Subsystem can generate decorative geometry, so the methods for extracting the geometry are at the Subsystem level and thus inherited here. So the only significant methods here are those for adding decorative geometry to the System beyond that which is generated by the other subsystems.

---

Constructor & Destructor Documentation

SimTK::DecorationSubsystem::DecorationSubsystem

(

)

SimTK::DecorationSubsystem::DecorationSubsystem

(

MultibodySystem &

)

[explicit]

---

Member Function Documentation

void SimTK::DecorationSubsystem::addBodyFixedDecoration	(	MobilizedBodyIndex	bodyNum,
		const Transform &	X_GD,
		const DecorativeGeometry &
	)

void SimTK::DecorationSubsystem::addRubberBandLine	(	MobilizedBodyIndex	b1,
		const Vec3 &	station1,
		MobilizedBodyIndex	b2,
		const Vec3 &	station2,
		const DecorativeLine &
	)

void SimTK::DecorationSubsystem::addDecorationGenerator	(	Stage	stage,
		DecorationGenerator *	generator
	)

Add a DecorationGenerator that will be invoked to add dynamically generated geometry to the scene.

The DecorationSubsystem assumes ownership of the object passed to this method, and will delete it when the subsystem is deleted.

Parameters:

stage	the Stage the generator should be invoked at
generator	the DecorationGenerator to add

SimTK::DecorationSubsystem::SimTK_PIMPL_DOWNCAST	(	DecorationSubsystem	,
		Subsystem
	)

class DecorationSubsystemGuts& SimTK::DecorationSubsystem::updGuts

(

)

const DecorationSubsystemGuts& SimTK::DecorationSubsystem::getGuts

(

)

const

---

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

• DecorationSubsystem.h