A model of a tactical smoke cloud made up of several smoke-puffs. More...

Inheritance diagram for makVrv::DtOsgTacticalSmokeModel:

Public Member Functions
	DtOsgTacticalSmokeModel (DtDe &de, DtUniqueID id)
	Initializing CTOR.
virtual	~DtOsgTacticalSmokeModel ()
	Virtual DTOR.
virtual std::string	className () const
	Get the class name of the model.

virtual void	setPosition (int vtx, const DtVector &pos)
	Set the position of the model.
virtual void	setOrientation (int vtx, const DtTaitBryan &ori)
	Set the orientation of the model.
virtual void	setVisible (bool isVisible)
	Set the model visible in the scene or hidden.
virtual void	setIsSupportModel (bool isSupport)
	Set the geometry to be part of the support group.
virtual void	setDensity (int vtx, double dens)
	Set density of a smoke-puff of particles.
virtual void	setOneSigmas (int vtx, const DtVector &sigma)
	Set the one-sigma distance per orthogonal direction of a smoke-puff of particles.
virtual void	setWindDirection (const DtVector &winddir)
	Set the wind direction and intensity.
virtual void	start ()
	Tell the model to start emitting particles.
virtual void	stop ()
	Tell the model to stop emitting particles.
virtual void	pause ()
	Freeze the particle emitters.
virtual void	resume ()
	Resume emitting particles.

virtual void	addToScene (const DtUniqueID &id, int modelSet, int visualizerType)
	Add this model to the scene.
virtual void	removeFromScene ()
	Remove this model from the scene.
virtual void	setModelDefinition (const std::string &str)
	Sets the model definition on the model instance.
Public Member Functions inherited from makVrv::DtTacticalSmokeModel
	DtTacticalSmokeModel (DtDe &de, DtUniqueID id)
	Initializing CTOR.
virtual	~DtTacticalSmokeModel ()
	Virtual DTOR.
Public Member Functions inherited from makVrv::DtModel
	DtModel (DtDe &de, DtUniqueID id)
	CTOR.
virtual	~DtModel ()
	DTOR.
virtual void	saveModelToFile (const std::string &filename)
unsigned int	transformSize () const
	Get the number of position/orientations this model has.
virtual void	removePosition (int vtx)
	Remove a transform at the given position.
const DtVector &	position (int vtx=0) const
	Get the Position of a given point.
const DtTaitBryan &	orientation (int vtx=0) const
	Get the Orientation of a given point.
virtual void	enableColorBlending (bool b)
	Enable / disable color blending for this model.
virtual void	setBlendColor (float r, float g, float b, float a)
	Set color to use if color blending is enabled.
virtual void	getBlendColor (float &r, float &g, float &b, float &a)
	Returns the blend color.
virtual bool	colorBlendingEnabled () const
	Returns whether or not blending is enabled.
virtual void	setColor (float r, float g, float b, float a)
	set the model's color
virtual void	enableLighting (bool l)
	set whether the model is lit; this may not be an option on all models
virtual int	modelSet () const
	Get the model set this model is part of.
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.
virtual void	getBoundingBoxCenter (double &x, double &y, double &z) const
	Get the bounding box center of the model instance.
virtual void	getBoundingBoxComponents (DtVector &minimum, DtVector &maximum)
	Get the minimum and maximum X,Y,Z components of the bounding box.
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.
DtDe &	de ()
	Get the DtDe object.
virtual void	setModelInstance (DtModelInstance *modelInstance)
	Internally set the model instance pointer.
virtual bool	visible () const
	Get the visible state of the model.
DtUniqueID	parentSceneObjectID () const
	Parent of the model.
virtual void	addedToSceneObjectAsProp (const DtUniqueID &sceneObj)
	Called when a scene object added the model as a prop.
virtual void	addedToSceneObject (const DtUniqueID &sceneObj, int modelSet, int visualizerType)
	Called when a scene object added the model with the given model set and visualizer type.
virtual void	setElementId (DtUniqueID id)
	Called when the element ID of the model's parent object is set.
virtual void	removedFromSceneObject ()
	Called when the model was removed from a scene object.
virtual void	setSolid (bool isSolid)
	Set whether or not other this model is drawn filled in.
virtual DtModelInstance *	modelInstance ()
	Get the model instance.
virtual const DtModelInstance *	modelInstance () const
	Get the model instance.
int	visualizerType () const
	The visualizer type determines which channel-specific group node this model will be parented to, and consequently, which observer setting will cause it to be rendered in which channel.

Private Member Functions
void	removeInstanceFromScene ()
	Non-virtual helper to remove the instance from the scene.
DtTacticalSmokeModelInstance *	tacticalSmokeModelInstance ()
	A helper function to cast the base-class DtModelInstance pointer into a DtTacticalSmokeModelInstance pointer.
	DtOsgTacticalSmokeModel ()
	Default constructor.
	DtOsgTacticalSmokeModel (const DtOsgTacticalSmokeModel &)
	Copy constructor.
DtOsgTacticalSmokeModel &	operator= (const DtOsgTacticalSmokeModel &)
	Assignment Operator.

Private Attributes
DtOsgSceneConnector *	mySceneConnector
DtVector	myPosition
DtTaitBryan	myOrientation
bool	myPositionIsSet
bool	myOrientationIsSet
bool	myOrientUp
bool	myBasePositionSet

Additional Inherited Members
Public Attributes inherited from makVrv::DtModel
boost::signal< void(DtModel *)>	signal_modelToBeDestroyed
	Signal emitted when the model is to be destroyed.
boost::signal< void(DtModel *)>	signal_modelChanged
boost::signal< bool(DtModel *, bool), SlotReturnOR >	signal_visibilityChangeRequested
	Signal when the visibility has been requested, if any slot returns false, it will not change.
boost::signal< void(DtModelInstance , DtModel )>	signal_modelInstanceCreated
	Signal emitted when the model instance is created.
boost::signal< void(DtModelInstance , DtModel )>	signal_modelInstanceToBeDestroyed
	Signal emitted when the model instance is to be destroyed.
Protected Types inherited from makVrv::DtModel
typedef std::vector < ObjectTransform >	TransformList
Protected Member Functions inherited from makVrv::DtModel
virtual void	addToSceneAsProp (const DtUniqueID &sceneObjectId)
	Add this model to the scene as a prop.
virtual void	initializeModelInstance ()
	Push any state maintained by the model to the model instance.
void	slot_modelInstanceChanged (DtModelInstance *instance)
	Called when the model instance changed.
Protected Attributes inherited from makVrv::DtModel
DtDe &	myDe
const DtUniqueID	myUniqueId
bool	myColorBlendingEnabled

Detailed Description

A model of a tactical smoke cloud made up of several smoke-puffs.

Constructor & Destructor Documentation

makVrv::DtOsgTacticalSmokeModel::DtOsgTacticalSmokeModel	(	DtDe &	de,
		DtUniqueID	id
	)

Initializing CTOR.

Parameters

[in]	de	is a reference to the display engine.
[in]	id	is this model's unique ID for distributed systems.

virtual makVrv::DtOsgTacticalSmokeModel::~DtOsgTacticalSmokeModel ( )

virtual

Virtual DTOR.

makVrv::DtOsgTacticalSmokeModel::DtOsgTacticalSmokeModel ( )

private

Default constructor.

Note: Not implemented

makVrv::DtOsgTacticalSmokeModel::DtOsgTacticalSmokeModel ( const DtOsgTacticalSmokeModel & )

private

Copy constructor.

Note: Not implemented

Member Function Documentation

virtual std::string makVrv::DtOsgTacticalSmokeModel::className ( ) const

virtual

Get the class name of the model.

The class name is used to identify the type of instance to create.

Returns: The class name of the model.

Implements makVrv::DtTacticalSmokeModel.

virtual void makVrv::DtOsgTacticalSmokeModel::setPosition	(	int	vtx,
		const DtVector &	pos
	)

virtual

Set the position of the model.

Parameters

[in]	vtx	is the id of the the particle effect.
[in]	pos	is the position to set.

Implements makVrv::DtTacticalSmokeModel.

virtual void makVrv::DtOsgTacticalSmokeModel::setOrientation	(	int	vtx,
		const DtTaitBryan &	ori
	)

virtual

Set the orientation of the model.

Parameters

[in]	vtx	is the id of the the particle effect.
[in]	ori	is the orientation to set.

Implements makVrv::DtTacticalSmokeModel.

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

virtual

Set the model visible in the scene or hidden.

Parameters

[in] isVisible is the new visible state.

Reimplemented from makVrv::DtModel.

virtual void makVrv::DtOsgTacticalSmokeModel::setIsSupportModel ( bool isSupport )

virtual

Set the geometry to be part of the support group.

Parameters

[in] isSupport is the flag enabling interactions with the environment when set true, else no interactions occur when set false.

Implements makVrv::DtModel.

virtual void makVrv::DtOsgTacticalSmokeModel::setDensity	(	int	vtx,
		double	dens
	)

virtual

Set density of a smoke-puff of particles.

Parameters

[in]	vtx	is the id of the the particle effect.
[in]	dens	is the density of the particles where 1.0 is full density and 0.0 is no density (no smoke), default is 1.0.

Implements makVrv::DtTacticalSmokeModel.

virtual void makVrv::DtOsgTacticalSmokeModel::setOneSigmas	(	int	vtx,
		const DtVector &	sigma
	)

virtual

Set the one-sigma distance per orthogonal direction of a smoke-puff of particles.

Parameters

[in]	vtx	is the id of the the particle effect.
[in]	sigma	is the distance in each direction where the probability of particle distribution within that distance is one-sigma (68.3%) from the emitting position.

Implements makVrv::DtTacticalSmokeModel.

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

virtual

Set the wind direction and intensity.

Parameters

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

Implements makVrv::DtTacticalSmokeModel.

virtual void makVrv::DtOsgTacticalSmokeModel::start ( )

virtual

Tell the model to start emitting particles.

Implements makVrv::DtTacticalSmokeModel.

virtual void makVrv::DtOsgTacticalSmokeModel::stop ( )

virtual

Tell the model to stop emitting particles.

Implements makVrv::DtTacticalSmokeModel.

virtual void makVrv::DtOsgTacticalSmokeModel::pause ( )

virtual

Freeze the particle emitters.

Implements makVrv::DtTacticalSmokeModel.

virtual void makVrv::DtOsgTacticalSmokeModel::resume ( )

virtual

Resume emitting particles.

Implements makVrv::DtTacticalSmokeModel.

virtual void makVrv::DtOsgTacticalSmokeModel::addToScene	(	const DtUniqueID &	id,
		int	modelSet,
		int	visualizerType
	)

virtual

Add this model to the scene.

Implements makVrv::DtModel.

virtual void makVrv::DtOsgTacticalSmokeModel::removeFromScene ( )

virtual

Remove this model from the scene.

Implements makVrv::DtModel.

virtual void makVrv::DtOsgTacticalSmokeModel::setModelDefinition ( const std::string & str )

virtual

Sets the model definition on the model instance.

Reimplemented from makVrv::DtModel.

void makVrv::DtOsgTacticalSmokeModel::removeInstanceFromScene ( )

private

Non-virtual helper to remove the instance from the scene.

DtTacticalSmokeModelInstance* makVrv::DtOsgTacticalSmokeModel::tacticalSmokeModelInstance ( )

inlineprivate

A helper function to cast the base-class DtModelInstance pointer into a DtTacticalSmokeModelInstance pointer.

DtOsgTacticalSmokeModel& makVrv::DtOsgTacticalSmokeModel::operator= ( const DtOsgTacticalSmokeModel & )

private

Assignment Operator.

Note: Not implemented

Member Data Documentation

DtOsgSceneConnector* makVrv::DtOsgTacticalSmokeModel::mySceneConnector

private

DtVector makVrv::DtOsgTacticalSmokeModel::myPosition

private

DtTaitBryan makVrv::DtOsgTacticalSmokeModel::myOrientation

private

bool makVrv::DtOsgTacticalSmokeModel::myPositionIsSet

private

bool makVrv::DtOsgTacticalSmokeModel::myOrientationIsSet

private

bool makVrv::DtOsgTacticalSmokeModel::myOrientUp

private

bool makVrv::DtOsgTacticalSmokeModel::myBasePositionSet

private

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

/exports/nfedora7-1/nightly/docs/vrforcesDevelopment.vrf4-3-branch/include/vrvOsg/DtOsgTacticalSmokeModel.h

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation