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

#include <DecorationSubsystem.h>

Inheritance diagram for SimTK::DecorationSubsystem:

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. More...

	SimTK_PIMPL_DOWNCAST (DecorationSubsystem, Subsystem)

class DecorationSubsystemGuts &	updGuts ()

const DecorationSubsystemGuts &	getGuts () const

Public Member Functions inherited from SimTK::Subsystem
	Subsystem ()

	Subsystem (const Subsystem &)

Subsystem &	operator= (const Subsystem &)

	~Subsystem ()

const String &	getName () const

const String &	getVersion () const

QIndex	allocateQ (State &, const Vector &qInit) const

UIndex	allocateU (State &, const Vector &uInit) const

ZIndex	allocateZ (State &, const Vector &zInit) const

DiscreteVariableIndex	allocateDiscreteVariable (State &, Stage invalidates, AbstractValue *v) const

DiscreteVariableIndex	allocateAutoUpdateDiscreteVariable (State &, Stage invalidates, AbstractValue *v, Stage updateDependsOn) const

CacheEntryIndex	allocateCacheEntry (const State &, Stage dependsOn, Stage computedBy, AbstractValue *v) const

CacheEntryIndex	allocateCacheEntry (const State &state, Stage g, AbstractValue *v) const

CacheEntryIndex	allocateLazyCacheEntry (const State &state, Stage earliest, AbstractValue *v) const

QErrIndex	allocateQErr (const State &, int nqerr) const

UErrIndex	allocateUErr (const State &, int nuerr) const

UDotErrIndex	allocateUDotErr (const State &, int nudoterr) const

EventTriggerByStageIndex	allocateEventTriggersByStage (const State &, Stage, int ntriggers) const

const Vector &	getQ (const State &) const

const Vector &	getU (const State &) const

const Vector &	getZ (const State &) const

const Vector &	getQDot (const State &) const

const Vector &	getUDot (const State &) const

const Vector &	getZDot (const State &) const

const Vector &	getQDotDot (const State &) const

const Vector &	getQErr (const State &) const

const Vector &	getUErr (const State &) const

const Vector &	getUDotErr (const State &) const

const Vector &	getMultipliers (const State &) const

const Vector &	getEventTriggersByStage (const State &, Stage) const

Vector &	updQ (State &) const

Vector &	updU (State &) const

Vector &	updZ (State &) const

void	setQ (State &s, const Vector &q) const

void	setU (State &s, const Vector &u) const

void	setZ (State &s, const Vector &z) const

Vector &	updQDot (const State &) const

Vector &	updUDot (const State &) const

Vector &	updZDot (const State &) const

Vector &	updQDotDot (const State &) const

Vector &	updQErr (const State &) const

Vector &	updUErr (const State &) const

Vector &	updUDotErr (const State &) const

Vector &	updMultipliers (const State &) const

Vector &	updEventTriggersByStage (const State &, Stage) const

Stage	getStage (const State &) const

const AbstractValue &	getDiscreteVariable (const State &s, DiscreteVariableIndex dx) const

Real	getDiscreteVarLastUpdateTime (const State &s, DiscreteVariableIndex dx) const

CacheEntryIndex	getDiscreteVarUpdateIndex (const State &s, DiscreteVariableIndex dx) const

const AbstractValue &	getDiscreteVarUpdateValue (const State &s, DiscreteVariableIndex dx) const

AbstractValue &	updDiscreteVarUpdateValue (const State &s, DiscreteVariableIndex dx) const

bool	isDiscreteVarUpdateValueRealized (const State &s, DiscreteVariableIndex dx) const

void	markDiscreteVarUpdateValueRealized (const State &s, DiscreteVariableIndex dx) const

AbstractValue &	updDiscreteVariable (State &, DiscreteVariableIndex) const

const AbstractValue &	getCacheEntry (const State &, CacheEntryIndex) const

AbstractValue &	updCacheEntry (const State &, CacheEntryIndex) const

bool	isCacheValueRealized (const State &, CacheEntryIndex) const

void	markCacheValueRealized (const State &, CacheEntryIndex) const

void	markCacheValueNotRealized (const State &, CacheEntryIndex) const

SystemQIndex	getQStart (const State &) const

int	getNQ (const State &) const

SystemUIndex	getUStart (const State &) const

int	getNU (const State &) const

SystemZIndex	getZStart (const State &) const

int	getNZ (const State &) const

SystemQErrIndex	getQErrStart (const State &) const

int	getNQErr (const State &) const

SystemUErrIndex	getUErrStart (const State &) const

int	getNUErr (const State &) const

SystemUDotErrIndex	getUDotErrStart (const State &) const

int	getNUDotErr (const State &) const

SystemMultiplierIndex	getMultipliersStart (const State &) const

int	getNMultipliers (const State &) const

SystemEventTriggerByStageIndex	getEventTriggerStartByStage (const State &, Stage) const

int	getNEventTriggersByStage (const State &, Stage) const

bool	isInSystem () const

bool	isInSameSystem (const Subsystem &otherSubsystem) const

const System &	getSystem () const

System &	updSystem ()

SubsystemIndex	getMySubsystemIndex () const

bool	isOwnerHandle () const

bool	isEmptyHandle () const

bool	isSameSubsystem (const Subsystem &otherSubsystem) const

bool	subsystemTopologyHasBeenRealized () const

void	invalidateSubsystemTopologyCache () const

MeasureIndex	adoptMeasure (AbstractMeasure &)

AbstractMeasure	getMeasure (MeasureIndex) const

template<class T >
Measure_< T >	getMeasure_ (MeasureIndex mx) const

const Subsystem::Guts &	getSubsystemGuts () const

Subsystem::Guts &	updSubsystemGuts ()

void	adoptSubsystemGuts (Subsystem::Guts *g)

void	setSystem (System &, SubsystemIndex)

	Subsystem (Subsystem::Guts *g)

bool	hasGuts () 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

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation