SimTK::Decorations Class Reference

This defines a single DecorativeGeometry object that is composed of a collection of other DecorativeGeometry objects. More...

#include <DecorativeGeometry.h>

Inheritance diagram for SimTK::Decorations:

Public Member Functions
	Decorations ()
	Construct an empty container for DecorativeGeometry objects. More...
	Decorations (const DecorativeGeometry &decoration)
	Construct a Decorations container initially consting of just a single DecorativeGeometry object. More...
Decorations &	addDecoration (const DecorativeGeometry &decoration)
	Add a DecorativeGeometry object to this collection. More...
Decorations &	addDecoration (const Transform &placement, const DecorativeGeometry &decoration)
	Add a DecorativeGeometry object to this collection and place it relative to the Decorations frame. More...
int	getNumDecorations () const
	Determine how many DecorativeGeometry objects are in this collection. More...
const DecorativeGeometry &	getDecoration (int i) const
	Get access to one of the DecorativeGeometry objects in this collection. More...
Decorations &	setBodyId (int b)
Decorations &	setTransform (const Transform &X_BD)
Decorations &	setResolution (Real r)
Decorations &	setScaleFactors (const Vec3 &s)
Decorations &	setColor (const Vec3 &rgb)
Decorations &	setOpacity (Real o)
Decorations &	setLineThickness (Real t)
Decorations &	setRepresentation (const Representation &r)
	SimTK_PIMPL_DOWNCAST (Decorations, DecorativeGeometry)
Public Member Functions inherited from SimTK::DecorativeGeometry
	DecorativeGeometry ()
	~DecorativeGeometry ()
	DecorativeGeometry (const DecorativeGeometry &)
DecorativeGeometry &	operator= (const DecorativeGeometry &)
DecorativeGeometry &	setBodyId (int)
	By default the geometry will be placed on ground. More...
DecorativeGeometry &	setTransform (const Transform &X_BG)
	This transform shifts the generated polygons with respect to this object's local frame. More...
DecorativeGeometry &	setResolution (Real)
	Each concrete DecorativeGeometry object is expected to have a default resolution that gets the point across but is cheap to draw and hence probably somewhat "chunky". More...
DecorativeGeometry &	setScaleFactors (const Vec3 &scale)
	Each concrete DecorativeGeometry object is expected to have a default size around "1", whatever that means for a particular object, and most objects also allow a user-specified size on construction. More...
DecorativeGeometry &	setScale (Real scale)
	Convenience method to set all three scale factors to the same value. More...
int	getBodyId () const
	Return the body to which this geometry is attached. More...
Real	getResolution () const
	Return the current setting of the "resolution" factor. More...
const Transform &	getTransform () const
	Return the current value of the object's transform. More...
const Vec3 &	getScaleFactors () const
	Return the current setting of the "scale" factors. More...
DecorativeGeometry &	setColor (const Vec3 &rgb)
	Request a specific color for this DecorativeGeometry object. More...
DecorativeGeometry &	setOpacity (Real)
	Request a level of transparency for this DecorativeGeometry. More...
DecorativeGeometry &	setLineThickness (Real)
	Request an adjustment to the default rendering of lines and curves. More...
const Vec3 &	getColor () const
	Return the color specified for this object, if any, otherwise Vec3(-1) indicating that the default color will be used. More...
Real	getOpacity () const
	Return the opacity specified for this object. More...
Real	getLineThickness () const
	Return the line thickness specified for this object, if any, otherwise return -1 to indicate that the default line thickness should be used. More...
DecorativeGeometry &	setFaceCamera (int shouldFace)
	Set whether the geometry acts as a billboard, always rotating to face the camera. More...
int	getFaceCamera () const
	Get whether the geometry acts as a billboard, always rotating to face the camera. More...
DecorativeGeometry &	setRepresentation (const Representation &)
	Request a particular rendering representation of this DecorativeGeometry object. More...
Representation	getRepresentation () const
	Returns drawing mode: -1 means "use default"; see above for others. More...
void	implementGeometry (DecorativeGeometryImplementation &) const
bool	isOwnerHandle () const
bool	isEmptyHandle () const
	DecorativeGeometry (class DecorativeGeometryRep *r)
bool	hasRep () const
const DecorativeGeometryRep &	getRep () const
DecorativeGeometryRep &	updRep ()

Additional Inherited Members
Public Types inherited from SimTK::DecorativeGeometry
enum	Representation {   DrawPoints = 1,   DrawWireframe = 2,   DrawSurface = 3,   DrawDefault = -1 }
Protected Attributes inherited from SimTK::DecorativeGeometry
DecorativeGeometryRep *	rep

Detailed Description

This defines a single DecorativeGeometry object that is composed of a collection of other DecorativeGeometry objects.

Parameters set for the parent object serve as defaults for the contained objects, but those objects can override the default.

Constructor & Destructor Documentation

SimTK::Decorations::Decorations

(

)

Construct an empty container for DecorativeGeometry objects.

SimTK::Decorations::Decorations ( const DecorativeGeometry &  decoration )

explicit

Construct a Decorations container initially consting of just a single DecorativeGeometry object.

Member Function Documentation

Decorations& SimTK::Decorations::addDecoration

(

const DecorativeGeometry &

decoration

)

Add a DecorativeGeometry object to this collection.

Decorations& SimTK::Decorations::addDecoration	(	const Transform &	placement,
		const DecorativeGeometry &	decoration
	)

Add a DecorativeGeometry object to this collection and place it relative to the Decorations frame.

int SimTK::Decorations::getNumDecorations

(

)

const

Determine how many DecorativeGeometry objects are in this collection.

const DecorativeGeometry& SimTK::Decorations::getDecoration

(

int

i

)

const

Get access to one of the DecorativeGeometry objects in this collection.

Decorations& SimTK::Decorations::setBodyId ( int  b )

inline

Decorations& SimTK::Decorations::setTransform ( const Transform &  X_BD )

inline

Decorations& SimTK::Decorations::setResolution ( Real  r )

inline

Decorations& SimTK::Decorations::setScaleFactors ( const Vec3 &  s )

inline

Decorations& SimTK::Decorations::setColor ( const Vec3 &  rgb )

inline

Decorations& SimTK::Decorations::setOpacity ( Real  o )

inline

Decorations& SimTK::Decorations::setLineThickness ( Real  t )

inline

Decorations& SimTK::Decorations::setRepresentation ( const Representation &  r )

inline

SimTK::Decorations::SimTK_PIMPL_DOWNCAST	(	Decorations	,
		DecorativeGeometry
	)

---

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

• DecorativeGeometry.h