A model of a triton water impact, used to interface with the triton API to generate a water impact effect. More...

Inheritance diagram for makVrv::DtTritonWaterImpactModel:

Public Member Functions
	DtTritonWaterImpactModel (DtDe &de, DtUniqueID id)
	CTOR.
virtual	~DtTritonWaterImpactModel ()
	DTOR.
virtual void	setModelDefinition (const std::string &str)
	Set the model definition (and cause the effect to be created).
virtual void	createEffect ()
	The effect is actually created when a model definition is set.
virtual void	addToScene (const DtUniqueID &sceneObjectId, int modelSet, int visualizerType)
	Unused, but required for all DtModels.
virtual void	removeFromScene ()
	Destroy the triton water impact object.
virtual void	setSolid (bool isSolid)
	Unused, but required for all DtModels.

virtual void	setImpactLocation (const DtVector &location)
	Set/get the location of the water impact.
virtual const DtVector &	impactLocation () const
	Set/get the location of the water impact.

virtual void	setMunitionSpeed (double speed)
	Set/get the speed of the munition as it enters the water.
virtual double	munitionSpeed () const
	Set/get the speed of the munition as it enters the water.

virtual void	setSprayScale (double scale)
	Set/get the scale of the spray generated - 0. eliminates the spray.
virtual double	sprayScale () const
	Set/get the scale of the spray generated - 0. eliminates the spray.

virtual void	setMunitionMass (double mass)
	Set/get the mass of the munition.
virtual double	munitionMass () const
	Set/get the mass of the munition.

virtual void	setImpactDiameter (double diameter)
	Set/get the diameter of the impact effect.
virtual double	impactDiameter () const
	Set/get the diameter of the impact effect.
Public Member Functions inherited from makVrv::DtWaterImpactModel
	DtWaterImpactModel (DtDe &de, DtUniqueID id)
	CTOR.
virtual	~DtWaterImpactModel ()
	DTOR.
Public Member Functions inherited from makVrv::DtModel
	DtModel (DtDe &de, DtUniqueID id)
	CTOR.
virtual	~DtModel ()
	DTOR.
virtual void	saveModelToFile (const std::string &filename)
virtual std::string	className () const
	Get the class name of the model instance owner.
unsigned int	transformSize () const
	Get the number of position/orientations this model has.
virtual void	setPosition (int vtx, const DtVector &position)
	Set the position of a control vertex in the model.
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	setOrientation (int vtx, const DtTaitBryan &orientation)
	Set the orientation of a vertex in the model.
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 void	setVisible (bool isVisible)
	Set the visible state of the model.
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	removedFromSceneObject ()
	Called when the model was removed from a scene object.
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.

Protected Member Functions
virtual DtTritonWaterImpactModelInstance *	waterImpactModelInstance ()
	Get a properly cast version of the model instance this model creates.
virtual DtTritonWaterImpactModelInstance *	waterImpactModelInstance () const
	Get a properly cast const version of the model instance this model creates.

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 Attributes inherited from makVrv::DtModel
DtDe &	myDe
const DtUniqueID	myUniqueId

Detailed Description

A model of a triton water impact, used to interface with the triton API to generate a water impact effect.

Constructor & Destructor Documentation

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

CTOR.

virtual makVrv::DtTritonWaterImpactModel::~DtTritonWaterImpactModel ( )

virtual

DTOR.

Member Function Documentation

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

virtual

Set the model definition (and cause the effect to be created).

Schema is type WaterImpact.

Reimplemented from makVrv::DtModel.

virtual void makVrv::DtTritonWaterImpactModel::setImpactLocation ( const DtVector & location )

virtual

Set/get the location of the water impact.

Implements makVrv::DtWaterImpactModel.

virtual const DtVector& makVrv::DtTritonWaterImpactModel::impactLocation ( ) const

virtual

Set/get the location of the water impact.

virtual void makVrv::DtTritonWaterImpactModel::setMunitionSpeed ( double speed )

virtual

Set/get the speed of the munition as it enters the water.

Implements makVrv::DtWaterImpactModel.

virtual double makVrv::DtTritonWaterImpactModel::munitionSpeed ( ) const

virtual

Set/get the speed of the munition as it enters the water.

virtual void makVrv::DtTritonWaterImpactModel::setSprayScale ( double scale )

virtual

Set/get the scale of the spray generated - 0. eliminates the spray.

Implements makVrv::DtWaterImpactModel.

virtual double makVrv::DtTritonWaterImpactModel::sprayScale ( ) const

virtual

Set/get the scale of the spray generated - 0. eliminates the spray.

virtual void makVrv::DtTritonWaterImpactModel::setMunitionMass ( double mass )

virtual

Set/get the mass of the munition.

Implements makVrv::DtWaterImpactModel.

virtual double makVrv::DtTritonWaterImpactModel::munitionMass ( ) const

virtual

Set/get the mass of the munition.

virtual void makVrv::DtTritonWaterImpactModel::setImpactDiameter ( double diameter )

virtual

Set/get the diameter of the impact effect.

Implements makVrv::DtWaterImpactModel.

virtual double makVrv::DtTritonWaterImpactModel::impactDiameter ( ) const

virtual

Set/get the diameter of the impact effect.

virtual void makVrv::DtTritonWaterImpactModel::createEffect ( )

virtual

The effect is actually created when a model definition is set.

If no model definition is provided, call this instead.

Implements makVrv::DtWaterImpactModel.

virtual void makVrv::DtTritonWaterImpactModel::addToScene	(	const DtUniqueID &	sceneObjectId,
		int	modelSet,
		int	visualizerType
	)

inlinevirtual

Unused, but required for all DtModels.

Implements makVrv::DtModel.

virtual void makVrv::DtTritonWaterImpactModel::removeFromScene ( )

virtual

Destroy the triton water impact object.

Implements makVrv::DtModel.

virtual void makVrv::DtTritonWaterImpactModel::setSolid ( bool isSolid )

inlinevirtual

Unused, but required for all DtModels.

Implements makVrv::DtModel.

virtual DtTritonWaterImpactModelInstance* makVrv::DtTritonWaterImpactModel::waterImpactModelInstance ( )

protectedvirtual

Get a properly cast version of the model instance this model creates.

virtual DtTritonWaterImpactModelInstance* makVrv::DtTritonWaterImpactModel::waterImpactModelInstance ( ) const

protectedvirtual

Get a properly cast const version of the model instance this model creates.

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

/exports/nfedora7-1/nightly/docs/vrforcesDevelopment.tot/include/vrvTriton/DtTritonWaterImpactModel.h

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation