VR-Forces 4.6.1 Class Documentation
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
List of all members | Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes
makVrv::DtOsgModelInstance Class Reference
vrvOsg

The base class for simple OSG based model instances. More...

Inheritance diagram for makVrv::DtOsgModelInstance:
Inheritance graph
[legend]

Public Types

enum  AlphaToCoverageState { USE_GLOBAL, FORCE_OFF, FORCE_ON }
 The possible states of a control point. More...

Public Member Functions

virtual ~DtOsgModelInstance ()
 DTOR.
virtual bool realize (DtModelDefinition &definition)
 Attempt to realize a definition.
virtual void addToConnector (DtOsgSceneConnector *connector)
 Brief Tell the model instance to add itself to the provided node.
virtual bool removeFromConnector (DtOsgSceneConnector *connector)
 Brief Tell the model instance to remove itself from the provided node.
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
- 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.
virtual void setVisible (bool isVisible)=0
 Set whether the model is visible or not.

Static Public Member Functions

static osg::Vec4 readVec4 (const std::string &paramName, const DtModelDefinition &definition)
static osg::Vec3 readVec3 (const std::string &paramName, const DtModelDefinition &definition)
- Static Public Member Functions inherited from makVrv::DtModelInstance
static float readFloat (const std::string &paramName, const DtModelDefinition &definition)
static DtVector readVector (const std::string &paramName, const DtModelDefinition &definition)

Protected Member Functions

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.

Protected Attributes

osg::ref_ptr< osg::Node > myModelRoot
osg::ref_ptr< osg::StateSet > myCachedState
SensorRegionStateMap mySensorRegionMap
AlphaToCoverageState myAlphaToCoverageState
DtSignalConnectionManager myConnections
bool myModelInstanceShaderSet
 Has this model instance had a shader generated for it? Used for classes (ex.
- 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
typedef boost::unordered_map
< std::string, bool > 		SensorRegionStateMap
 Dynamic Sensor Region methods.
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.
boost::signal< void(bool)> signal_atcModeEnableChanged
 Signal raised when alpha to coverage for this model is changed.
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.
virtual void slot_atcGlobalModelEnableChanged ()
 Slot to handle the global alpha to coverage signal for entities.
virtual bool alphaToCoverageEnabled ()
 Get the current setting for alpha to coverage for this model.
virtual void registerLightPoints (const std::string &groupName, bool daylightControlledLights)
 loop over all this models light points and register them with the light point manager daylightControlled is only used if the light points do not already have a type specified

Additional Inherited Members

- Public Attributes inherited from makVrv::DtModelInstance
boost::signal< void(DtModelInstance *)> signal_modelInstanceChanged

Detailed Description

The base class for simple OSG based model instances.

This call can't be instantiated itself.

Member Typedef Documentation

typedef boost::unordered_map<std::string, bool> makVrv::DtOsgModelInstance::SensorRegionStateMap

Dynamic Sensor Region methods.

How Dynamic Sensor Region states are stored

Member Enumeration Documentation

enum makVrv::DtOsgModelInstance::AlphaToCoverageState

The possible states of a control point.

Enumerator:
USE_GLOBAL 
FORCE_OFF 
FORCE_ON 

Constructor & Destructor Documentation

virtual makVrv::DtOsgModelInstance::~DtOsgModelInstance ( )
virtual

DTOR.

makVrv::DtOsgModelInstance::DtOsgModelInstance ( DtDe &  de)
protected

CTOR.

Member Function Documentation

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

Attempt to realize a definition.

If the model instance can't realize the definition it should return false.

Reimplemented from makVrv::DtModelInstance.

Reimplemented in makVrv::DtOsgOverlayEllipseArcModelInstance, makVrv::DtOverlaySegmentedLineModelInstance, makVrv::Dt3DSegmentedLineModelInstance, makVrv::DtOsgOverlayDirectionLineModelInstance, makVrv::DtExtrudedLineModelInstance, makVrv::DtExtrudedModelInstance, makVrv::Dt3DTextModelInstance, makVrv::DtEffectModelInstance, makVrv::DtParticleSystemModelInstance, makVrv::DtArticulatingCylinderModelInstance, makVrv::DtEllipsoidArcModelInstance, makVrv::DtAnimationModelInstance, makVrv::DtPolygonModelInstance, makVrv::DtTacticalSmokeModelInstance, makVrv::DtCuboidModelInstance, makVrv::DtRectangularPyramidModelInstance, makVrv::DtCylinderModelInstance, makVrv::DtEllipsoidModelInstance, makVrv::DtCubeModelInstance, makVrv::DtOverlayGreatCircleArcModelInstance, makVrv::DtAttachableEllipsoidArcModelInstance, makVrv::Dt3DGreatCircleArcModelInstance, makVrv::DtRibbonModelInstance, makVrv::DtDecalModelInstance, makVrv::DtOsgSimpleModelInstance, and makVrv::DtDiGuyModelInstance.

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

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

Reimplemented in makVrv::DtTacticalSmokeModelInstance, makVrv::Dt3DSegmentedLineModelInstance, makVrv::DtPolygonModelInstance, makVrv::DtExtrudedLineModelInstance, makVrv::DtExtrudedModelInstance, makVrv::DtParticleSystemModelInstance, makVrv::Dt3DTextModelInstance, makVrv::DtEffectModelInstance, makVrv::DtArticulatingCylinderModelInstance, makVrv::DtEllipsoidArcModelInstance, makVrv::DtAnimationModelInstance, makVrv::DtCuboidModelInstance, makVrv::DtRibbonModelInstance, makVrv::DtRectangularPyramidModelInstance, makVrv::DtMovablePolygonModel::DtMovablePolygonModelInstance, makVrv::DtProjectedTextModelInstance, makVrv::DtDecalModelInstance, makVrv::DtAttachableEllipsoidArcModelInstance, makVrv::DtDrawModelInstance, and makVrv::DtScribeBoxModelInstance.

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

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

Returns true if the node was removed.

Reimplemented in makVrv::DtTacticalSmokeModelInstance, makVrv::Dt3DSegmentedLineModelInstance, makVrv::DtPolygonModelInstance, makVrv::DtExtrudedLineModelInstance, makVrv::DtExtrudedModelInstance, makVrv::DtParticleSystemModelInstance, makVrv::Dt3DTextModelInstance, makVrv::DtEffectModelInstance, makVrv::DtArticulatingCylinderModelInstance, makVrv::DtEllipsoidArcModelInstance, makVrv::DtAnimationModelInstance, makVrv::DtCuboidModelInstance, makVrv::DtRibbonModelInstance, makVrv::DtRectangularPyramidModelInstance, makVrv::DtProjectedTextModelInstance, makVrv::DtDecalModelInstance, makVrv::DtAttachableEllipsoidArcModelInstance, makVrv::DtDrawModelInstance, and makVrv::DtScribeBoxModelInstance.

virtual osg::Node* makVrv::DtOsgModelInstance::rootNode ( )
virtual

Get the model instance's root node.

Reimplemented in makVrv::DtExtrudedModelInstance.

virtual const osg::Node* makVrv::DtOsgModelInstance::rootNode ( ) const
virtual
virtual osg::Node* makVrv::DtOsgModelInstance::sensorNode ( )
virtual

Get the model instance's sensor node, .

Reimplemented in makVrv::DtAnimationModelInstance, makVrv::DtRibbonModelInstance, and makVrv::DtDiGuyModelInstance.

virtual const osg::Node* makVrv::DtOsgModelInstance::sensorNode ( ) const
virtual

Reimplemented in makVrv::DtRibbonModelInstance, makVrv::DtAnimationModelInstance, and makVrv::DtDiGuyModelInstance.

virtual bool makVrv::DtOsgModelInstance::saveModelToFile ( const std::string &  filename) const
virtual

Attempt to save the model to a file.

Reimplemented from makVrv::DtModelInstance.

virtual void makVrv::DtOsgModelInstance::enableColorBlending ( bool  b)
virtual

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.

It should not be set to true if the model has instancing enabled.

Reimplemented from makVrv::DtModelInstance.

Reimplemented in makVrv::DtPolygonModelInstance.

virtual void makVrv::DtOsgModelInstance::setBlendColor ( float  r,
float  g,
float  b,
float  a 
)
virtual

set the model's color

Reimplemented from makVrv::DtModelInstance.

virtual void makVrv::DtOsgModelInstance::enableTexture ( bool  onOff)
virtual
virtual void makVrv::DtOsgModelInstance::addDynamicSensorRegion ( const std::string &  region)
virtual

Add an active region state.

virtual void makVrv::DtOsgModelInstance::setDynamicSensorRegion ( const std::string &  region,
bool  state 
)
virtual

Set the state of an active region.

virtual bool makVrv::DtOsgModelInstance::dynamicSensorRegion ( const std::string &  region)
virtual

Get the current state of the specified sensor region.

SensorRegionStateMap const makVrv::DtOsgModelInstance::dynamicSensorRegionMap ( ) const

Get the map containing all regions and their current states.

virtual void makVrv::DtOsgModelInstance::slot_atcGlobalModelEnableChanged ( )
virtual

Slot to handle the global alpha to coverage signal for entities.

Reimplemented in makVrv::DtScribeBoxModelInstance.

virtual bool makVrv::DtOsgModelInstance::alphaToCoverageEnabled ( )
virtual

Get the current setting for alpha to coverage for this model.

virtual void makVrv::DtOsgModelInstance::registerLightPoints ( const std::string &  groupName,
bool  daylightControlledLights 
)
virtual

loop over all this models light points and register them with the light point manager daylightControlled is only used if the light points do not already have a type specified

static osg::Vec4 makVrv::DtOsgModelInstance::readVec4 ( const std::string &  paramName,
const DtModelDefinition &  definition 
)
static
static osg::Vec3 makVrv::DtOsgModelInstance::readVec3 ( const std::string &  paramName,
const DtModelDefinition &  definition 
)
static
virtual void makVrv::DtOsgModelInstance::updateColorBlending ( )
protectedvirtual

calls update color blending with the model root.

Override to use a different root

virtual void makVrv::DtOsgModelInstance::updateColorBlending ( osg::Node *  node)
protectedvirtual
virtual void makVrv::DtOsgModelInstance::enableTexture ( osg::Node *  root,
bool  onOff 
)
protectedvirtual
virtual void makVrv::DtOsgModelInstance::updateBoundingBoxViaContents ( )
protectedvirtual

Reimplemented in makVrv::DtDiGuyModelInstance.

virtual void makVrv::DtOsgModelInstance::setRootNode ( osg::Node *  node)
protectedvirtual

Set the model instance's root node.

Reimplemented in makVrv::DtDiGuyModelInstance.

Member Data Documentation

boost::signal< void(const std::string&) > makVrv::DtOsgModelInstance::signal_dynamicSensorRegionAdded

Signal raised when a dynamic sensor region is added.

boost::signal< void(const std::string&, bool) > makVrv::DtOsgModelInstance::signal_dynamicSensorRegionChanged

Signal raised when a dynamic sensor region's state changes.

boost::signal<void(bool)> makVrv::DtOsgModelInstance::signal_atcModeEnableChanged

Signal raised when alpha to coverage for this model is changed.

osg::ref_ptr<osg::Node> makVrv::DtOsgModelInstance::myModelRoot
protected
osg::ref_ptr<osg::StateSet> makVrv::DtOsgModelInstance::myCachedState
protected
SensorRegionStateMap makVrv::DtOsgModelInstance::mySensorRegionMap
protected
AlphaToCoverageState makVrv::DtOsgModelInstance::myAlphaToCoverageState
protected
DtSignalConnectionManager makVrv::DtOsgModelInstance::myConnections
protected
bool makVrv::DtOsgModelInstance::myModelInstanceShaderSet
protected

Has this model instance had a shader generated for it? Used for classes (ex.

Dt3DSegmentedLineModelInstance) which call DtOsgShaderUtils::generateModelInstanceShaders

The documentation for this class was generated from the following file:
Document ID: Generated on Wed Jul 25 16:57:45 EDT 2018 from SVN revision 190790
Copyright © 2005-2018 VT MÄK. All Rights Reserved (www.mak.com)