A virtual base class for a particle effect from a model definition. More...

Inheritance diagram for makVrv::DtParticleSystemModelInstance:

Public Member Functions
virtual void	setIntensity (float intensity)=0
	Set the effect intensity. More...

virtual void	setScale (float scale)=0
	Set the effect scale. More...

virtual void	setIgnoreModelScaling (bool ignoreModelScaling)=0
	Sets Whether ignore scaling the particle by distance when you enable the "XR" mode. More...

virtual bool	ignoreModelScaling () const =0
	Get whether model scaling is disabled for this model instance. More...

virtual void	setDuration (double seconds)=0
	Set the effect duration. More...

virtual void	setWind (const DtVector &windVector, const DtVector &up)=0
	Set the effect wind. More...

virtual void	setMaxParticlesToEmit (int max)=0
	Set the maximum number of particles to emit. More...

virtual bool	realize (DtModelDefinition &definition)=0
	Attempt to realize a definition. More...

virtual osg::Node *	getOrLoadFromDefinition (DtModelDefinition &definition)=0
	Load a node from a file, or from the cache if possible. More...

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

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

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

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

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

virtual void	resume ()=0
	resume the particle emitters. More...

virtual void	setVisible (bool isVisible)=0
	stops the emission of particles More...

virtual void	setOffset (const DtVector &offset)=0
	sets the offset of the particles system rel to model origin or articulated part More...

virtual void	setArtPart (int artPart)=0
	sets the articulated articulated part to attach system to. More...

virtual void	setPosition (double x, double y, double z)=0
	sets the position of the system explicitly. More...

virtual void	setPosition (int index, double x, double y, double z)=0
	sets the position of a sub emitter . 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 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
	DtParticleSystemModelInstance (DtDe &de)
	Create the effect, no op constructor. More...

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

	DtOsgModelInstance (DtDe &de)
	CTOR. More...

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

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::signal< void(const std::string &) >	signal_dynamicSensorRegionAdded
	Signal raised when a dynamic sensor region is added. More...

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

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

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

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

Detailed Description

A virtual base class for a particle effect from a model definition.

Constructor & Destructor Documentation

makVrv::DtParticleSystemModelInstance::DtParticleSystemModelInstance ( DtDe & de )

inlineprotected

Create the effect, no op constructor.

Member Function Documentation

virtual void makVrv::DtParticleSystemModelInstance::setIntensity ( float intensity )

pure virtual

Set the effect intensity.

Implemented in makVrv::DtFxParticleSystemModelInstance, and makVrv::DtParticleRotorWashModelInstance.

virtual void makVrv::DtParticleSystemModelInstance::setScale ( float scale )

pure virtual

Set the effect scale.

Implemented in makVrv::DtFxParticleSystemModelInstance, and makVrv::DtParticleRotorWashModelInstance.

virtual void makVrv::DtParticleSystemModelInstance::setIgnoreModelScaling ( bool ignoreModelScaling )

pure virtual

Sets Whether ignore scaling the particle by distance when you enable the "XR" mode.

This can be configured from "ignoreModelScaling" in the model definition. Default is true.

Implemented in makVrv::DtFxParticleSystemModelInstance.

virtual bool makVrv::DtParticleSystemModelInstance::ignoreModelScaling ( ) const

pure virtual

Get whether model scaling is disabled for this model instance.

Implemented in makVrv::DtFxParticleSystemModelInstance.

virtual void makVrv::DtParticleSystemModelInstance::setDuration ( double seconds )

pure virtual

Set the effect duration.

Implemented in makVrv::DtFxParticleSystemModelInstance.

virtual void makVrv::DtParticleSystemModelInstance::setWind	(	const DtVector &	windVector,
		const DtVector &	up
	)

pure virtual

Set the effect wind.

Implemented in makVrv::DtFxParticleSystemModelInstance.

virtual void makVrv::DtParticleSystemModelInstance::setMaxParticlesToEmit ( int max )

pure virtual

Set the maximum number of particles to emit.

Implemented in makVrv::DtFxParticleSystemModelInstance.

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

pure virtual

Attempt to realize a definition.

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

Reimplemented from makVrv::DtOsgModelInstance.

Implemented in makVrv::DtFxParticleSystemModelInstance.

virtual osg::Node* makVrv::DtParticleSystemModelInstance::getOrLoadFromDefinition ( DtModelDefinition & definition )

pure virtual

Load a node from a file, or from the cache if possible.

Implemented in makVrv::DtFxParticleSystemModelInstance.

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

pure virtual

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

Reimplemented from makVrv::DtOsgModelInstance.

Implemented in makVrv::DtFxParticleSystemModelInstance.

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

pure virtual

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

Reimplemented from makVrv::DtOsgModelInstance.

Implemented in makVrv::DtFxParticleSystemModelInstance.

virtual void makVrv::DtParticleSystemModelInstance::stop ( )

pure virtual

Tell the model to stop emitting particles.

Implemented in makVrv::DtFxParticleSystemModelInstance, and makVrv::DtParticleRotorWashModelInstance.

virtual void makVrv::DtParticleSystemModelInstance::start ( )

pure virtual

Tell the model to start emitting particles.

Implemented in makVrv::DtFxParticleSystemModelInstance, and makVrv::DtParticleRotorWashModelInstance.

virtual void makVrv::DtParticleSystemModelInstance::pause ( )

pure virtual

Freeze the particle emitters.

Implemented in makVrv::DtFxParticleSystemModelInstance.

virtual void makVrv::DtParticleSystemModelInstance::resume ( )

pure virtual

resume the particle emitters.

Implemented in makVrv::DtFxParticleSystemModelInstance.

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

pure virtual

stops the emission of particles

Implements makVrv::DtModelInstance.

Implemented in makVrv::DtFxParticleSystemModelInstance, and makVrv::DtParticleRotorWashModelInstance.

virtual void makVrv::DtParticleSystemModelInstance::setOffset ( const DtVector & offset )

pure virtual

sets the offset of the particles system rel to model origin or articulated part

Implemented in makVrv::DtFxParticleSystemModelInstance, and makVrv::DtParticleRotorWashModelInstance.

virtual void makVrv::DtParticleSystemModelInstance::setArtPart ( int artPart )

pure virtual

sets the articulated articulated part to attach system to.

Implemented in makVrv::DtFxParticleSystemModelInstance.

virtual void makVrv::DtParticleSystemModelInstance::setPosition	(	double	x,
		double	y,
		double	z
	)

pure virtual

sets the position of the system explicitly.

Implemented in makVrv::DtFxParticleSystemModelInstance.

virtual void makVrv::DtParticleSystemModelInstance::setPosition	(	int	index,
		double	x,
		double	y,
		double	z
	)

pure virtual

sets the position of a sub emitter .

Implemented in makVrv::DtFxParticleSystemModelInstance.

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

/data/exports/nrhent7-1/nightly/docs/vrForces.vrf4-8-branch/include/vrvOsg/DtParticleSystemModelInstance.h

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation