A model of a triton tidalStreamWake is used to interface with the triton API to generate a Kelvin tidalStreamWake effect. More...

Inheritance diagram for makVrv::DtTritonTidalStreamWakeModel:

[legend]

Public Member Functions
	DtTritonTidalStreamWakeModel (DtDe &de, DtUniqueID id)
	CTOR.
virtual	~DtTritonTidalStreamWakeModel ()
	DTOR.
virtual void	setModelDefinition (const std::string &modelDef)
	Initialize this model from a model-definition.
virtual std::string	modelDefinition () const
	Get the model definition name set, if any.
virtual void	addToScene (const DtUniqueID &sceneObjectId, int modelSet, int visualizerType)
	AddToScene is called by the scene object with which this model is associated after it has been initialized.
virtual void	removeFromScene ()
	Destroy the triton tidalStreamWake object.
virtual void	setVisible (bool isVisible)
	Set the visible state of the model.
virtual void	setIsSupportModel (bool isSupport)
	Unused, but required for all DtModels.

virtual void	setWakeLength (double wakeLength)
	Set /get the length of the wake generated.
virtual double	wakeLength () const

virtual void	setWakeOffset (double wakeLength)
	Set /get an offset for the wake start in the direction opposite the.
virtual double	wakeOffset () const

virtual void	setDraft (double draft)
	Set / get the distance underwater this object extends.
virtual double	draft () const

virtual void	setMaxWaveAmplitude (double amplitude)
	Set / get the maximum wake wave amplitude generated by this object.
virtual double	maxWaveAmplitude () const

virtual void	setLodDistance (double lodDistance)
	Set / get the maximum wake wave amplitude generated by this object.
virtual double	lodDistance () const
Public Member Functions inherited from makVrv::DtTidalStreamWakeModel
	DtTidalStreamWakeModel (DtDe &de, DtUniqueID id)
	CTOR.
virtual	~DtTidalStreamWakeModel ()
	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 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 bool	isProp ()
	Return whether or not this model was added as a prop.
virtual DtModelInstance *	modelInstance ()
	Get the model instance.
virtual const DtModelInstance *	modelInstance () const
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 DtTritonTidalStreamWakeModelInstance *	tidalStreamWakeModelInstance ()
	Get a properly cast version of the model instance this model creates.
virtual DtTritonTidalStreamWakeModelInstance *	tidalStreamWakeModelInstance () const
	Get a properly cast const version of the model instance this model creates.
virtual DtVector	currentPosition () const
	Get the object's current position that this tidal stream wake is attached to.
virtual DtSceneObject *	sceneObject () const
	Get the helo's current orientation that this tidalStreamWake is attached to.
virtual void	calcDefaults ()
	Calculate defaults for geometric parameters based on the ship model's bounding geometry.
virtual void	setIsOverWater (bool overWater)
	Called by the tidalStreamWake updater to tell us if we are over water.
virtual void	slot_oceanAddedToScene ()
	If a tidalStreamWake is requested and Triton hasn't been initialized, this model connects to the DtTritonManager's signal_addedToScene signal, and creates the tidalStreamWake (and disconnects) when the signal is raised.

Protected Attributes
boost::signalslib::connection	myTritonManagerConnection
std::string	myModelDefinitionName
double	myLodDistance
	in meters; values <= 0 indicate no LOD (always show wake)

Friends
class	DtTritonTidalStreamWakeUpdater
	Allow the updater to use our protected methods.

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

Detailed Description

A model of a triton tidalStreamWake is used to interface with the triton API to generate a Kelvin tidalStreamWake effect.

Constructor & Destructor Documentation

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

CTOR.

virtual makVrv::DtTritonTidalStreamWakeModel::~DtTritonTidalStreamWakeModel ( )

virtual

DTOR.

Member Function Documentation

virtual void makVrv::DtTritonTidalStreamWakeModel::setModelDefinition ( const std::string & modelDef )

virtual

Initialize this model from a model-definition.

Implements makVrv::DtTidalStreamWakeModel.

virtual std::string makVrv::DtTritonTidalStreamWakeModel::modelDefinition ( ) const

virtual

Get the model definition name set, if any.

Implements makVrv::DtTidalStreamWakeModel.

virtual void makVrv::DtTritonTidalStreamWakeModel::setWakeLength ( double wakeLength )

virtual

Set /get the length of the wake generated.

Implements makVrv::DtTidalStreamWakeModel.

virtual double makVrv::DtTritonTidalStreamWakeModel::wakeLength ( ) const

virtual

Implements makVrv::DtTidalStreamWakeModel.

virtual void makVrv::DtTritonTidalStreamWakeModel::setWakeOffset ( double wakeLength )

virtual

Set /get an offset for the wake start in the direction opposite the.

wake motion (to move the wake at or even behind the object it is attached to

Implements makVrv::DtTidalStreamWakeModel.

virtual double makVrv::DtTritonTidalStreamWakeModel::wakeOffset ( ) const

virtual

Implements makVrv::DtTidalStreamWakeModel.

virtual void makVrv::DtTritonTidalStreamWakeModel::setDraft ( double draft )

virtual

Set / get the distance underwater this object extends.

Implements makVrv::DtTidalStreamWakeModel.

virtual double makVrv::DtTritonTidalStreamWakeModel::draft ( ) const

virtual

Implements makVrv::DtTidalStreamWakeModel.

virtual void makVrv::DtTritonTidalStreamWakeModel::setMaxWaveAmplitude ( double amplitude )

virtual

Set / get the maximum wake wave amplitude generated by this object.

Implements makVrv::DtTidalStreamWakeModel.

virtual double makVrv::DtTritonTidalStreamWakeModel::maxWaveAmplitude ( ) const

virtual

Implements makVrv::DtTidalStreamWakeModel.

virtual void makVrv::DtTritonTidalStreamWakeModel::setLodDistance ( double lodDistance )

virtual

Set / get the maximum wake wave amplitude generated by this object.

Implements makVrv::DtTidalStreamWakeModel.

virtual double makVrv::DtTritonTidalStreamWakeModel::lodDistance ( ) const

virtual

Implements makVrv::DtTidalStreamWakeModel.

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

virtual

AddToScene is called by the scene object with which this model is associated after it has been initialized.

If the tidalStreamWake should be visible, this will cause the triton tidalStreamWake object to be created

Implements makVrv::DtModel.

virtual void makVrv::DtTritonTidalStreamWakeModel::removeFromScene ( )

virtual

Destroy the triton tidalStreamWake object.

Implements makVrv::DtModel.

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

virtual

Set the visible state of the model.

Parameters

[in] isVisible is the new visible state; true = visible, false = hidden.

Reimplemented from makVrv::DtModel.

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

inlinevirtual

Unused, but required for all DtModels.

Implements makVrv::DtModel.

virtual DtTritonTidalStreamWakeModelInstance* makVrv::DtTritonTidalStreamWakeModel::tidalStreamWakeModelInstance ( )

protectedvirtual

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

virtual DtTritonTidalStreamWakeModelInstance* makVrv::DtTritonTidalStreamWakeModel::tidalStreamWakeModelInstance ( ) const

protectedvirtual

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

virtual DtVector makVrv::DtTritonTidalStreamWakeModel::currentPosition ( ) const

protectedvirtual

Get the object's current position that this tidal stream wake is attached to.

virtual DtSceneObject* makVrv::DtTritonTidalStreamWakeModel::sceneObject ( ) const

protectedvirtual

Get the helo's current orientation that this tidalStreamWake is attached to.

Get the scene object that owns this model (and the ship's model)

virtual void makVrv::DtTritonTidalStreamWakeModel::calcDefaults ( )

protectedvirtual

Calculate defaults for geometric parameters based on the ship model's bounding geometry.

virtual void makVrv::DtTritonTidalStreamWakeModel::setIsOverWater ( bool overWater )

protectedvirtual

Called by the tidalStreamWake updater to tell us if we are over water.

virtual void makVrv::DtTritonTidalStreamWakeModel::slot_oceanAddedToScene ( )

protectedvirtual

If a tidalStreamWake is requested and Triton hasn't been initialized, this model connects to the DtTritonManager's signal_addedToScene signal, and creates the tidalStreamWake (and disconnects) when the signal is raised.

Friends And Related Function Documentation

friend class DtTritonTidalStreamWakeUpdater

friend

Allow the updater to use our protected methods.

Member Data Documentation

boost::signalslib::connection makVrv::DtTritonTidalStreamWakeModel::myTritonManagerConnection

protected

std::string makVrv::DtTritonTidalStreamWakeModel::myModelDefinitionName

protected

double makVrv::DtTritonTidalStreamWakeModel::myLodDistance

protected

in meters; values <= 0 indicate no LOD (always show wake)

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

/exports/nfedora7-1/nightly/docs/vrforcesDevelopment.tot/include/vrvTriton/DtTritonTidalStreamWakeModel.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