VR-Forces 5.0.1 Developer's Guide
 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. This call can't be instantiated itself.

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

Public Types

enum  AlphaToCoverageState { USE_GLOBAL, FORCE_OFF, FORCE_ON }
 

Public Member Functions

virtual ~DtOsgModelInstance ()
 
virtual bool realize (DtModelDefinition &definition)
 
virtual bool cloneInstance (DtModelDefinition &definition)
 
virtual void addToConnector (DtOsgSceneConnector *connector)
 
virtual bool removeFromConnector (DtOsgSceneConnector *connector)
 
virtual bool saveModelToFile (const std::string &filename) const
 
virtual void enableColorBlending (bool b)
 
virtual void setBlendColor (float r, float g, float b, float a)
 
virtual void enableTexture (bool onOff)
 
virtual osg::Node * rootNode ()
 
virtual const osg::Node * rootNode () const
 
virtual osg::Node * sensorNode ()
 
virtual const osg::Node * sensorNode () const
 
- Public Member Functions inherited from makVrv::DtModelInstance
 DtModelInstance (DtDe &de)
 
virtual ~DtModelInstance ()
 
const std::string & realizedDefinitionName () const
 
const DtVector & boundingBoxExtents () const
 
void getBoundingBoxExtents (double &x, double &y, double &z) const
 
const DtVector & boundingBoxCenter () const
 
void getBoundingBoxCenter (double &x, double &y, double &z) const
 
void getBoundingBoxComponents (DtVector &minimum, DtVector &maximum)
 
const DtVector & allGeometryboundingBoxExtents () const
 
void getAllGeometryBoundingBoxExtents (double &x, double &y, double &z) const
 
const DtVector & allGeometryboundingBoxCenter () const
 
void getAllGeometryBoundingBoxCenter (double &x, double &y, double &z) const
 
void getAllGeometryBoundingBoxComponents (DtVector &minimum, DtVector &maximum)
 
virtual void setContributesToBound (bool trueOrFalse)
 
bool contributesToBound () const
 
virtual void setVisible (bool isVisible)=0
 

Static Public Member Functions

static osg::Vec4 readVec4 (const std::string &paramName, const DtModelDefinition &definition, const osg::Vec4 &initValue=osg::Vec4(1, 1, 1, 1))
 
static osg::Vec3 readVec3 (const std::string &paramName, const DtModelDefinition &definition, const osg::Vec3 &initValue=osg::Vec3(1, 1, 1))
 
- 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

 DtOsgModelInstance (DtDe &de)
 
virtual void updateColorBlending ()
 
virtual void updateColorBlending (osg::Node *node)
 
virtual void enableTexture (osg::Node *root, bool onOff)
 
virtual void updateBoundingBoxViaContents ()
 
virtual void setRootNode (osg::Node *node)
 
virtual void setUpDepthTest (osg::StateSet *stateSet)
 

Protected Attributes

osg::ref_ptr< osg::Node > myModelRoot
 
osg::ref_ptr< osg::StateSet > myCachedState
 
SensorRegionStateMap mySensorRegionMap
 
AlphaToCoverageState myAlphaToCoverageState
 
DtSignalConnectionManager myConnections
 
bool myModelInstanceShaderSet
 
- Protected Attributes inherited from makVrv::DtModelInstance
DtDe & myDe
 
std::string myRealizedModelDefinitionName
 
DtVector myBoundingBoxCenter
 
DtVector myBoundingBoxExtents
 
DtVector myBoundingBoxMinimum
 
DtVector myBoundingBoxMaximum
 
DtVector myAllGeometryBoundingBoxCenter
 
DtVector myAllGeometryBoundingBoxExtents
 
DtVector myAllGeometryBoundingBoxMinimum
 
DtVector myAllGeometryBoundingBoxMaximum
 
bool myContributesToBound
 
bool myColorBlendingEnabled
 
float myBlendRed
 
float myBlendBlue
 
float myBlendGreen
 
float myBlendAlpha
 
typedef std::unordered_map
< std::string, bool > 		SensorRegionStateMap
 
boost::signalslib::signal
< void(const std::string &) > 		signal_dynamicSensorRegionAdded
 
boost::signalslib::signal
< void(const std::string
&, bool) > 		signal_dynamicSensorRegionChanged
 
boost::signalslib::signal
< void(bool)> 		signal_atcModeEnableChanged
 
virtual void setDynamicSensorRegion (const std::string &region, bool state)
 
virtual bool dynamicSensorRegion (const std::string &region)
 
virtual const
SensorRegionStateMap & 		dynamicSensorRegionMap () const
 
virtual void slot_atcGlobalModelEnableChanged ()
 
virtual bool alphaToCoverageEnabled ()
 
virtual void registerLightPoints (const std::string &groupName, bool daylightControlledLights)
 

Additional Inherited Members

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

Member Typedef Documentation

typedef std::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::DtAttachableEllipsoidArcModelInstance, makVrv::DtArcModelInstance, makVrv::DtOsgOverlayEllipseArcModelInstance, makVrv::DtOsgOverlayDirectionLineModelInstance, makVrv::DtOverlaySegmentedLineModelInstance, makVrv::Dt3DSegmentedLineModelInstance, makVrv::DtExtrudedLineModelInstance, makVrv::DtFxParticleSystemModelInstance, makVrv::Dt3DTextModelInstance, makVrv::DtArticulatingCylinderModelInstance, makVrv::DtEllipsoidArcModelInstance, makVrv::DtPolygonModelInstance, makVrv::DtCuboidModelInstance, makVrv::DtCylinderModelInstance, makVrv::DtEllipsoidModelInstance, makVrv::DtCubeModelInstance, makVrv::DtParticleSystemModelInstance, makVrv::DtRibbonModelInstance, makVrv::DtRectangularPyramidModelInstance, makVrv::DtTacticalSmokeModelInstance, makVrv::DtDecalModelInstance, makVrv::DtOverlayGreatCircleArcModelInstance, makVrv::DtDiGuyModelInstance, makVrv::Dt3DGreatCircleArcModelInstance, and makVrv::DtOsgSimpleModelInstance.

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

Attempt to clone the basic geometry. Can be done in the background. If the model instance can't clone the definition it should return false.

Reimplemented from makVrv::DtModelInstance.

Reimplemented in makVrv::DtOsgSimpleModelInstance.

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

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

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

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::DtAttachableEllipsoidArcModelInstance, makVrv::Dt3DSegmentedLineModelInstance, makVrv::DtPolygonModelInstance, makVrv::DtExtrudedLineModelInstance, makVrv::DtExtrudedModelInstance, makVrv::DtFxParticleSystemModelInstance, makVrv::Dt3DTextModelInstance, makVrv::DtArticulatingCylinderModelInstance, makVrv::DtEllipsoidArcModelInstance, makVrv::DtCuboidModelInstance, makVrv::DtParticleSystemModelInstance, makVrv::DtRibbonModelInstance, makVrv::DtDecalModelInstance, makVrv::DtRectangularPyramidModelInstance, makVrv::DtProjectedTextModelInstance, makVrv::DtScribeBoxModelInstance, and makVrv::DtDrawModelInstance.

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

Get the model instance's root node.

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

Get the model instance's sensor node, .

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

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

Get the model instance's sensor node, .

Reimplemented in makVrv::DtRibbonModelInstance, 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::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.

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

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,
const osg::Vec4 &  initValue = osg::Vec4(1, 1, 1, 1) 
)
static
static osg::Vec3 makVrv::DtOsgModelInstance::readVec3 ( const std::string &  paramName,
const DtModelDefinition &  definition,
const osg::Vec3 &  initValue = osg::Vec3(1, 1, 1) 
)
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.

virtual void makVrv::DtOsgModelInstance::setUpDepthTest ( osg::StateSet *  stateSet)
protectedvirtual

Helper function to set up a depth test on a state set taking into account whether reverse z is enabled or not.

Member Data Documentation

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

Signal raised when a dynamic sensor region is added.

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

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

boost::signalslib::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 Mon Jun 20 00:38:30 EDT 2022 from SVN revision 244029
Copyright © 2005-2021 MAK Technologies. All Rights Reserved (www.mak.com)