makVrv::DtRectangularPyramidModelInstance Class Reference

Model instance to draw a rectangular pyramid. More...

Inheritance diagram for makVrv::DtRectangularPyramidModelInstance:

Public Member Functions
	DtRectangularPyramidModelInstance (makVrv::DtDe &de)
	CTOR Instantiates a new DtRectangularPyramidModelInstance.
virtual	~DtRectangularPyramidModelInstance ()
	Virtual DTOR (no-op) (OSG manages created scene objects)
void	update ()
	Performs periodic updates, if necessary.
Inherited Methods
virtual void	addToConnector (makVrv::DtOsgSceneConnector *connector)
	Tell the model instance to add itself to the provided node.
virtual bool	removeFromConnector (makVrv::DtOsgSceneConnector *connector)
	Tell the model instance to remove itself from the provided node.
virtual bool	realize (makVrv::DtModelDefinition &definition)
	Attempt to realize a definition.
virtual void	setVisible (bool isVisible)
	no-op
Setters
virtual void	setRelativePosition (double x, double y, double z)
	Set the relative position of the rectangular pyramid Sets the position of the model instance relative to the parent node.
virtual void	setOrientation (double yaw, double pitch, double roll)
	Set the relative orientation of the rectangular pyramid Sets the orientation of the model instance relative to the parent node.
virtual void	setSize (double slantHeight)
	Sets the size of the rectangular pyramid.
virtual void	setColor (float r, float g, float b, float a)
	Sets both the inside and outside colors.
void	setInnerColor (float r, float g, float b, float a)
	Sets the inside color.
void	setOuterColor (float r, float g, float b, float a)
	Sets the outside color.
virtual void	setXHalfAngle (double xHalfAngle)
	Set the half angle amount in the x direction.
virtual void	setYHalfAngle (double yHalfAngle)
	Set the half angle amount in the y direction.
virtual void	setShowLines (bool showLines)
	Set whether the wireframe outlines are visible on the geometry Sets whether the wireframe lines for the rectangular pyramid should be drawn If set, the wireframe lines are drawn in addition to the geometry faces.
virtual void	setLinesHaveAlpha (bool lineAlpha)
	Set whether the wireframe outlines should be rendered with alpha Sets whether the alpha component of the pyramid's colors should apply to the wireframe outlines as well as the faces, or just to the faces.
Public Member Functions inherited from makVrv::DtOsgModelInstance
virtual	~DtOsgModelInstance ()
	DTOR.
virtual bool	saveModelToFile (const std::string &filename) const
	Attempt to save the model to a file.
virtual void	enableColorBlending (bool b)
	Enable / disable coloring on all models in the scene object Note about enableColorBlending: If this particular model has instancing enabled then this flag is set to false and color blending is handled by the instance manager.
virtual void	setBlendColor (float r, float g, float b, float a)
	set the model's color
virtual void	enableTexture (bool onOff)
virtual osg::Node *	rootNode ()
	Get the model instance's root node.
virtual const osg::Node *	rootNode () const
virtual osg::Node *	sensorNode ()
	Get the model instance's sensor node, .
virtual const osg::Node *	sensorNode () const
virtual void	addDynamicSensorRegion (const std::string &region)
	Add an active region state.
virtual void	setDynamicSensorRegion (const std::string &region, bool state)
	Set the state of an active region.
virtual bool	dynamicSensorRegion (const std::string &region)
	Get the current state of the specified sensor region.
SensorRegionStateMap const	dynamicSensorRegionMap () const
	Get the map containing all regions and their current states.
Public Member Functions inherited from makVrv::DtModelInstance
	DtModelInstance (DtDe &de)
	CTOR.
virtual	~DtModelInstance ()
	DTOR.
const std::string &	realizedDefinitionName () const
	Get the name of the definition that this model instance was realized with.
const DtVector &	boundingBoxExtents () const
	Get the bounding box extents of the model instance.
void	getBoundingBoxExtents (double &x, double &y, double &z) const
	Get the bounding box extents of the model instance.
const DtVector &	boundingBoxCenter () const
	Get the bounding box center of the model instance.
void	getBoundingBoxCenter (double &x, double &y, double &z) const
	Get the bounding box center of the model instance.
void	getBoundingBoxComponents (DtVector &minimum, DtVector &maximum)
virtual void	setContributesToBound (bool trueOrFalse)
	Set whether this model instance contributes to an object's overall bounding volume.
bool	contributesToBound () const
	Get whether this model instance contributes to an object's overall bounding volume.

Protected Member Functions
Updaters
virtual void	updateGeometry ()
	Builds the geometry using the defined parameters in myParameters Updates the vertices and faces used to render the rectangular pyramid arc model then updates the geometry's colors.
virtual void	updateGeometryColors ()
	Updates the color(s) of the sphere Updates the colors of the vertices on the pyramid model's geometry or sets the dirtyColors flag if lockUpdates is set.
virtual void	updateGeometryWireframeState ()
	Updates the state of the geometry's wireframe Updates the visibility / alpha state of the geometry's wireframe.
virtual void	updateGeometryTransforms ()
	Updates the scaling and location applied to the sphere Updates the scaling applied to the model (the rectangular pyramid model's dimensions)
Protected Member Functions inherited from makVrv::DtOsgModelInstance
virtual void	updateColorBlending ()
	calls update color blending with the model root.
virtual void	updateColorBlending (osg::Node *node)
virtual void	enableTexture (osg::Node *root, bool onOff)
virtual void	updateBoundingBoxViaContents ()
	DtOsgModelInstance (DtDe &de)
	CTOR.
virtual void	setRootNode (osg::Node *node)
	Set the model instance's root node.

Static Protected Member Functions
static void	clampAngle (double &val, double minAngle, double maxAngle)
	Clamps the given angle value to the given range.

Protected Attributes
osg::ref_ptr < osg::MatrixTransform >	myTransform
osg::ref_ptr< osg::Group >	myBlendNode
osg::ref_ptr< osg::Group >	myWireNode
osg::ref_ptr< osg::Geometry >	myGeometry
osg::ref_ptr< osg::Geode >	myFrontGeode
osg::ref_ptr< osg::Geode >	myBackGeode
bool	myDirtyGeometry
bool	myDirtyColors
bool	myDirtyTransforms
bool	myDirtyWireframe
osg::Vec3d	myRelativePosition
osg::Quat	myRelativeOrientation
osg::Vec3d	myDimensions
double	myXHalfAngle
double	myYHalfAngle
int	myCenterVertexIndex
osg::Vec4	myInnerColor
osg::Vec4	myOuterColor
bool	myShowLines
bool	myLineAlphaFlag
Protected Attributes inherited from makVrv::DtOsgModelInstance
osg::ref_ptr< osg::Node >	myModelRoot
osg::ref_ptr< osg::StateSet >	myCachedState
SensorRegionStateMap	mySensorRegionMap
Protected Attributes inherited from makVrv::DtModelInstance
DtDe &	myDe
std::string	myRealizedModelDefinitionName
DtVector	myBoundingBoxCenter
DtVector	myBoundingBoxExtents
DtVector	myBoundingBoxMinimum
DtVector	myBoundingBoxMaximum
bool	myContributesToBound
bool	myColorBlendingEnabled
float	myBlendRed
float	myBlendBlue
float	myBlendGreen
float	myBlendAlpha

Additional Inherited Members
Public Types inherited from makVrv::DtOsgModelInstance
typedef boost::unordered_map < std::string, bool >	SensorRegionStateMap
	Dynamic Sensor Region methods.
Static Public Member Functions inherited from makVrv::DtOsgModelInstance
static osg::Vec4	readVec4 (const std::string &paramName, const DtModelDefinition &definition)
static osg::Vec3	readVec3 (const std::string &paramName, const DtModelDefinition &definition)
Public Attributes inherited from makVrv::DtOsgModelInstance
boost::signal< void(const std::string &) >	signal_dynamicSensorRegionAdded
	Signal raised when a dynamic sensor region is added.
boost::signal< void(const std::string &, bool) >	signal_dynamicSensorRegionChanged
	Signal raised when a dynamic sensor region's state changes.
Public Attributes inherited from makVrv::DtModelInstance
boost::signal< void(DtModelInstance *)>	signal_modelInstanceChanged

Detailed Description

Model instance to draw a rectangular pyramid.

Constructor & Destructor Documentation

makVrv::DtRectangularPyramidModelInstance::DtRectangularPyramidModelInstance

(

makVrv::DtDe &

de

)

CTOR Instantiates a new DtRectangularPyramidModelInstance.

See Also

makVrv::DtOsgModelInstance::DtOsgModelInstance( DtDe& )

virtual makVrv::DtRectangularPyramidModelInstance::~DtRectangularPyramidModelInstance ( )

virtual

Virtual DTOR (no-op) (OSG manages created scene objects)

Member Function Documentation

virtual void makVrv::DtRectangularPyramidModelInstance::addToConnector ( makVrv::DtOsgSceneConnector *  connector )

virtual

Tell the model instance to add itself to the provided node.

See Also

makVrv::DtOsgModelInstance::addToConnector( DtOsgSceneConnector* )

Reimplemented from makVrv::DtOsgModelInstance.

virtual bool makVrv::DtRectangularPyramidModelInstance::removeFromConnector ( makVrv::DtOsgSceneConnector *  connector )

virtual

Tell the model instance to remove itself from the provided node.

See Also

makVrv::DtOsgModelInstance::removeFromConnector( DtOsgSceneConnector* )

Reimplemented from makVrv::DtOsgModelInstance.

virtual bool makVrv::DtRectangularPyramidModelInstance::realize ( makVrv::DtModelDefinition &  definition )

virtual

Attempt to realize a definition.

See Also

makVrv::DtModelInstance::realize( DtModelDefinition& )

Reimplemented from makVrv::DtModelInstance.

virtual void makVrv::DtRectangularPyramidModelInstance::setVisible ( bool  isVisible )

inlinevirtual

no-op

See Also

DtModelInstance::setVisible( bool )

Implements makVrv::DtModelInstance.

virtual void makVrv::DtRectangularPyramidModelInstance::setRelativePosition ( double  x, double  y, double  z  )

virtual

Set the relative position of the rectangular pyramid Sets the position of the model instance relative to the parent node.

Parameters

x	the relative x translation
y	the relative y translation
z	the relative z translation

virtual void makVrv::DtRectangularPyramidModelInstance::setOrientation ( double  yaw, double  pitch, double  roll  )

virtual

Set the relative orientation of the rectangular pyramid Sets the orientation of the model instance relative to the parent node.

Parameters

yaw	the yaw, -DtTaitBryan::psi()
pitch	the pitch, DtTaitBryan::theta()
roll	the roll, DtTaitBryan::phi()

virtual void makVrv::DtRectangularPyramidModelInstance::setSize ( double  slantHeight )

virtual

Sets the size of the rectangular pyramid.

Parameters

slantHeight

the length of the pyramid's slant height.

virtual void makVrv::DtRectangularPyramidModelInstance::setColor ( float  r, float  g, float  b, float  a  )

virtual

Sets both the inside and outside colors.

Sets the color of the entire rectangular pyramid.

Parameters

r	the red component of the color
g	the green component of the color
b	the blue component of the color
a	the alpha component of the color

void makVrv::DtRectangularPyramidModelInstance::setInnerColor	(	float	r,
		float	g,
		float	b,
		float	a
	)

Sets the inside color.

Sets the color of the internal of the rectangular pyramid.

Parameters

r	the red component of the color
g	the green component of the color
b	the blue component of the color
a	the alpha component of the color

void makVrv::DtRectangularPyramidModelInstance::setOuterColor	(	float	r,
		float	g,
		float	b,
		float	a
	)

Sets the outside color.

Sets the color of the external of the rectangular pyramid.

Parameters

r	the red component of the color
g	the green component of the color
b	the blue component of the color
a	the alpha component of the color

virtual void makVrv::DtRectangularPyramidModelInstance::setXHalfAngle ( double  xHalfAngle )

virtual

Set the half angle amount in the x direction.

Parameters

xHalfAngle

the half-angle in the x direction.

virtual void makVrv::DtRectangularPyramidModelInstance::setYHalfAngle ( double  yHalfAngle )

virtual

Set the half angle amount in the y direction.

Parameters

yHalfAngle

the half-angle in the y direction.

virtual void makVrv::DtRectangularPyramidModelInstance::setShowLines ( bool  showLines )

virtual

Set whether the wireframe outlines are visible on the geometry Sets whether the wireframe lines for the rectangular pyramid should be drawn If set, the wireframe lines are drawn in addition to the geometry faces.

Parameters

showLines

whether the lines should be visible or hidden

virtual void makVrv::DtRectangularPyramidModelInstance::setLinesHaveAlpha ( bool  lineAlpha )

virtual

Set whether the wireframe outlines should be rendered with alpha Sets whether the alpha component of the pyramid's colors should apply to the wireframe outlines as well as the faces, or just to the faces.

Parameters

whether

the lines should be affected by the color's alpha values.

void makVrv::DtRectangularPyramidModelInstance::update

(

)

Performs periodic updates, if necessary.

virtual void makVrv::DtRectangularPyramidModelInstance::updateGeometry ( )

protectedvirtual

Builds the geometry using the defined parameters in myParameters Updates the vertices and faces used to render the rectangular pyramid arc model then updates the geometry's colors.

virtual void makVrv::DtRectangularPyramidModelInstance::updateGeometryColors ( )

protectedvirtual

Updates the color(s) of the sphere Updates the colors of the vertices on the pyramid model's geometry or sets the dirtyColors flag if lockUpdates is set.

virtual void makVrv::DtRectangularPyramidModelInstance::updateGeometryWireframeState ( )

protectedvirtual

Updates the state of the geometry's wireframe Updates the visibility / alpha state of the geometry's wireframe.

virtual void makVrv::DtRectangularPyramidModelInstance::updateGeometryTransforms ( )

protectedvirtual

Updates the scaling and location applied to the sphere Updates the scaling applied to the model (the rectangular pyramid model's dimensions)

static void makVrv::DtRectangularPyramidModelInstance::clampAngle ( double &  val, double  minAngle, double  maxAngle  )

staticprotected

Clamps the given angle value to the given range.

Parameters

val	reference to variable containing the angle to clamp.
minAngle	the min angle the clamped value is allowed to have.
maxAngle	the max angle the clamped value is allowed to have.

Member Data Documentation

osg::ref_ptr<osg::MatrixTransform> makVrv::DtRectangularPyramidModelInstance::myTransform

protected

osg::ref_ptr<osg::Group> makVrv::DtRectangularPyramidModelInstance::myBlendNode

protected

osg::ref_ptr<osg::Group> makVrv::DtRectangularPyramidModelInstance::myWireNode

protected

osg::ref_ptr<osg::Geometry> makVrv::DtRectangularPyramidModelInstance::myGeometry

protected

osg::ref_ptr<osg::Geode> makVrv::DtRectangularPyramidModelInstance::myFrontGeode

protected

osg::ref_ptr<osg::Geode> makVrv::DtRectangularPyramidModelInstance::myBackGeode

protected

bool makVrv::DtRectangularPyramidModelInstance::myDirtyGeometry

protected

bool makVrv::DtRectangularPyramidModelInstance::myDirtyColors

protected

bool makVrv::DtRectangularPyramidModelInstance::myDirtyTransforms

protected

bool makVrv::DtRectangularPyramidModelInstance::myDirtyWireframe

protected

osg::Vec3d makVrv::DtRectangularPyramidModelInstance::myRelativePosition

protected

osg::Quat makVrv::DtRectangularPyramidModelInstance::myRelativeOrientation

protected

osg::Vec3d makVrv::DtRectangularPyramidModelInstance::myDimensions

protected

double makVrv::DtRectangularPyramidModelInstance::myXHalfAngle

protected

double makVrv::DtRectangularPyramidModelInstance::myYHalfAngle

protected

int makVrv::DtRectangularPyramidModelInstance::myCenterVertexIndex

protected

osg::Vec4 makVrv::DtRectangularPyramidModelInstance::myInnerColor

protected

osg::Vec4 makVrv::DtRectangularPyramidModelInstance::myOuterColor

protected

bool makVrv::DtRectangularPyramidModelInstance::myShowLines

protected

bool makVrv::DtRectangularPyramidModelInstance::myLineAlphaFlag

protected

---

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

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.tot/include/vrvOsg/DtRectangularPyramidModelInstance.h