A model instance of a tactical smoke cloud consisting of several puffs of smoke. More...

Inheritance diagram for makVrv::DtTacticalSmokeModelInstance:

Public Member Functions
	DtTacticalSmokeModelInstance (DtDe &de)
	Initializing CTOR. More...

virtual	~DtTacticalSmokeModelInstance ()
	Virtual DTOR. More...

virtual bool	realize (DtModelDefinition &definition)
	Attempt to realize the instance of this model from a definition. More...

virtual void	setVisible (bool isVisible)
	Set the visible state of this object. More...

virtual void	setPuffPosition (int puffIndex, const DtVector &fxSysPosition)
	Set the position of a smoke-puff of particles. More...

virtual void	setWindDirection (const DtVector &winddir)
	Set the wind direction and intensity. More...

virtual void	slot_handleWindDirectionChanged (float dir)
	connection for the wind direction. More...

virtual void	slot_handleWindSpeedChanged (float speed)
	connection for the wind intensity. More...

virtual void	start ()
	Tell the model to start emitting particles. More...

virtual void	stop ()
	Tell the model to stop emitting particles. More...

virtual void	pause ()
	Freeze the particle emitters. More...

virtual void	resume ()
	Resume the animation. More...

Public Member Functions inherited from makVrv::DtOsgModelInstance
virtual	~DtOsgModelInstance ()
	DTOR. More...

virtual bool	cloneInstance (DtModelDefinition &definition)
	Attempt to clone the basic geometry. More...

virtual void	addToConnector (DtOsgSceneConnector *connector)
	Brief Tell the model instance to add itself to the provided node. More...

virtual bool	removeFromConnector (DtOsgSceneConnector *connector)
	Brief Tell the model instance to remove itself from the provided node. More...

virtual bool	saveModelToFile (const std::string &filename) const
	Attempt to save the model to a file. More...

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

virtual void	setBlendColor (float r, float g, float b, float a)
	set the model's color More...

virtual void	enableTexture (bool onOff)

virtual osg::Node *	rootNode ()
	Get the model instance's root node. More...

virtual const osg::Node *	rootNode () const

virtual osg::Node *	sensorNode ()
	Get the model instance's sensor node, . More...

virtual const osg::Node *	sensorNode () const

virtual void	addDynamicSensorRegion (const std::string &region)
	Add an active region state. More...

virtual void	setDynamicSensorRegion (const std::string &region, bool state)
	Set the state of an active region. More...

virtual bool	dynamicSensorRegion (const std::string &region)
	Get the current state of the specified sensor region. More...

SensorRegionStateMap const	dynamicSensorRegionMap () const
	Get the map containing all regions and their current states. More...

virtual void	slot_atcGlobalModelEnableChanged ()
	Slot to handle the global alpha to coverage signal for entities. More...

virtual bool	alphaToCoverageEnabled ()
	Get the current setting for alpha to coverage for this model. More...

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

Public Member Functions inherited from makVrv::DtModelInstance
	DtModelInstance (DtDe &de)
	CTOR. More...

virtual	~DtModelInstance ()
	DTOR. More...

const std::string &	realizedDefinitionName () const
	Get the name of the definition that this model instance was realized with. More...

const DtVector &	boundingBoxExtents () const
	Get the bounding box extents of the model instance. More...

void	getBoundingBoxExtents (double &x, double &y, double &z) const
	Get the bounding box extents of the model instance. More...

const DtVector &	boundingBoxCenter () const
	Get the bounding box center of the model instance. More...

void	getBoundingBoxCenter (double &x, double &y, double &z) const
	Get the bounding box center of the model instance. More...

void	getBoundingBoxComponents (DtVector &minimum, DtVector &maximum)
	Get the bounding box min/max of the model instance. More...

const DtVector &	allGeometryboundingBoxExtents () const
	functions for getting the allGeometry versions of the extents (they are calculated by traversing as if all switch paths are active) More...

void	getAllGeometryBoundingBoxExtents (double &x, double &y, double &z) const
	Get the all geometry version of bounding box extents of the model instance. More...

const DtVector &	allGeometryboundingBoxCenter () const
	Get the all geometry version of bounding box center of the model instance. More...

void	getAllGeometryBoundingBoxCenter (double &x, double &y, double &z) const
	Get the all geometry version of bounding box center of the model instance. More...

void	getAllGeometryBoundingBoxComponents (DtVector &minimum, DtVector &maximum)
	Get the all geometry version of bounding box min/max of the model instance. More...

virtual void	setContributesToBound (bool trueOrFalse)
	Set whether this model instance contributes to an object's overall bounding volume. More...

bool	contributesToBound () const
	Get whether this model instance contributes to an object's overall bounding volume. More...

Protected Member Functions
virtual void	destroyEffect ()
	Remove effect from scene-graph, destroy children and destroy effect. More...

virtual void	updateWind ()
	update the underlying wind params. More...

virtual void	createFxSystem (DtModelDefinition &definition)
	helper function to deal with multiple creation paths More...

Protected Member Functions inherited from makVrv::DtOsgModelInstance
	DtOsgModelInstance (DtDe &de)
	CTOR. More...

virtual void	updateColorBlending ()
	calls update color blending with the model root. More...

virtual void	updateColorBlending (osg::Node *node)

virtual void	enableTexture (osg::Node *root, bool onOff)

virtual void	updateBoundingBoxViaContents ()

virtual void	setRootNode (osg::Node *node)
	Set the model instance's root node. More...

virtual void	setUpDepthTest (osg::StateSet *stateSet)
	Helper function to set up a depth test on a state set taking into account whether reverse z is enabled or not. More...

Protected Attributes
DtParticleSystemModelInstance *	myFxCloud

DtVector	myPosition

DtSignalConnectionManager	myConnections

float	myWindSpeed

float	myWindDirection

DtVector	myUp

bool	myUpSet

Protected Attributes inherited from makVrv::DtOsgModelInstance
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. More...

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

Friends
class	DtTacticalSmokeModelInstanceCreator

Additional Inherited Members
Public Types inherited from makVrv::DtOsgModelInstance
enum	AlphaToCoverageState { USE_GLOBAL, FORCE_OFF, FORCE_ON }
	The possible states of a control point. More...

typedef boost::unordered_map < std::string, bool >	SensorRegionStateMap
	Dynamic Sensor Region methods. More...

Static Public Member Functions inherited from makVrv::DtOsgModelInstance
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)

Public Attributes inherited from makVrv::DtOsgModelInstance
boost::signalslib::signal < void(const std::string &) >	signal_dynamicSensorRegionAdded
	Signal raised when a dynamic sensor region is added. More...

boost::signalslib::signal < void(const std::string &, bool) >	signal_dynamicSensorRegionChanged
	Signal raised when a dynamic sensor region's state changes. More...

boost::signalslib::signal < void(bool)>	signal_atcModeEnableChanged
	Signal raised when alpha to coverage for this model is changed. More...

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

Detailed Description

A model instance of a tactical smoke cloud consisting of several puffs of smoke.

This requires the use of a new Fx Particle System (the model definition passed to ::realize() must contain an "FxSystem" parameter

Constructor & Destructor Documentation

makVrv::DtTacticalSmokeModelInstance::DtTacticalSmokeModelInstance ( DtDe & de )

Initializing CTOR.

Parameters

[in] de is a reference to the display engine.

virtual makVrv::DtTacticalSmokeModelInstance::~DtTacticalSmokeModelInstance ( )

virtual

Virtual DTOR.

Member Function Documentation

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

virtual

Attempt to realize the instance of this model from a definition.

Parameters

[in] definition is the model definition. The model definition must have an "fxSystem" parameter identifying the fx particle system to use

Return values

true	if the instance was realized.
false	otherwise.

Reimplemented from makVrv::DtOsgModelInstance.

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

virtual

Set the visible state of this object.

Currently unimplemented.

Parameters

[in] isVisible is the new visible state.

Implements makVrv::DtModelInstance.

virtual void makVrv::DtTacticalSmokeModelInstance::setPuffPosition	(	int	puffIndex,
		const DtVector &	fxSysPosition
	)

virtual

Set the position of a smoke-puff of particles.

Parameters

[in]	puffIndex	is the id of the the particle effect.
[in]	fxSysPosition	is the position of new particles (new fx system).

virtual void makVrv::DtTacticalSmokeModelInstance::setWindDirection ( const DtVector & winddir )

virtual

Set the wind direction and intensity.

Parameters

[in] winddir is the direction and intensity of the wind.

virtual void makVrv::DtTacticalSmokeModelInstance::slot_handleWindDirectionChanged ( float dir )

virtual

connection for the wind direction.

virtual void makVrv::DtTacticalSmokeModelInstance::slot_handleWindSpeedChanged ( float speed )

virtual

connection for the wind intensity.

virtual void makVrv::DtTacticalSmokeModelInstance::start ( )

virtual

Tell the model to start emitting particles.

virtual void makVrv::DtTacticalSmokeModelInstance::stop ( )

virtual

Tell the model to stop emitting particles.

virtual void makVrv::DtTacticalSmokeModelInstance::pause ( )

virtual

Freeze the particle emitters.

virtual void makVrv::DtTacticalSmokeModelInstance::resume ( )

virtual

Resume the animation.

virtual void makVrv::DtTacticalSmokeModelInstance::destroyEffect ( )

protectedvirtual

Remove effect from scene-graph, destroy children and destroy effect.

virtual void makVrv::DtTacticalSmokeModelInstance::updateWind ( )

protectedvirtual

update the underlying wind params.

virtual void makVrv::DtTacticalSmokeModelInstance::createFxSystem ( DtModelDefinition & definition )

protectedvirtual

helper function to deal with multiple creation paths

Friends And Related Function Documentation

friend class DtTacticalSmokeModelInstanceCreator

friend

Member Data Documentation

DtParticleSystemModelInstance* makVrv::DtTacticalSmokeModelInstance::myFxCloud

protected

DtVector makVrv::DtTacticalSmokeModelInstance::myPosition

protected

DtSignalConnectionManager makVrv::DtTacticalSmokeModelInstance::myConnections

protected

float makVrv::DtTacticalSmokeModelInstance::myWindSpeed

protected

float makVrv::DtTacticalSmokeModelInstance::myWindDirection

protected

DtVector makVrv::DtTacticalSmokeModelInstance::myUp

protected

bool makVrv::DtTacticalSmokeModelInstance::myUpSet

protected

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

/data/exports/nrhent7-1/nightly/docs/vrForces.vrf4-10-branch/include/vrvOsg/DtTacticalSmokeModelInstance.h

Public Member Functions

Protected Member Functions

Protected Attributes

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation