makVrv::DtTritonWakeModelInstance Class Reference

Implementation of a Triton wake model. More...

Inheritance diagram for makVrv::DtTritonWakeModelInstance:

Public Member Functions
	DtTritonWakeModelInstance (DtDe &de)
	CTOR.
virtual	~DtTritonWakeModelInstance ()
	DTOR.
virtual void	setVisible (bool isVisible)
	Set whether the wake is visible or not.
virtual void	setDefaultWakeOffset (double offset)
	Set a default value to use if setWakeOffset has not been called.
virtual void	setDefaultBowSprayOffset (double offset)
	Set a default value to use if setBowSprayOffset has not been called.
virtual void	setDefaultBowWaveOffset (double offset)
	Set a default value to use if setBowWaveOffset has not been called.
virtual void	setDefaultSternWaveOffset (double offset)
	Set a default value to use if setSternWaveOffset has not been called.
virtual void	setDefaultShipLength (double length)
	Set a default value to use if setHipLength has not been called.
virtual void	setDefaultBeamWidth (double width)
	Set a default value to use if setBeamWidth has not been called.
virtual void	setDefaultDraft (double draft)
	Set a default value to use if setDraft has not been called.
virtual void	setDefaultPropWashOffset (double offset)
	Set a default value to use if setPropWashOffset has not been called.
virtual void	setDefaultPropWashFadeTime (double fadeTime)
	Set a default value to use if setPropWashFadeTime has not been called.
virtual void	setDefaultSprayVelocityScale (double scale)
	Set a default value to use if setSprayVelocityScale has not been called.
virtual void	setDefaultBowWaveScale (double scale)
	Set a default value to use if setBowWaveScale has not been called.
virtual void	setDefaultMaxBowWaveAmplitude (double amplitude)
	Set a default value to use if setMaxBowWaveAmplitude has not been called.
virtual void	setDefaultBowSize (double size)
	Set a default value to use if setBowSize has not been called.
virtual void	setDefaultSpraySizeScale (double scale)
	Set a default value to use if setSpraySizeScale has not been called.
virtual void	setDefaultNumHullSprays (int sprays)
	Set a default value to use if setNumHullSprays has not been called.
virtual void	setDefaultHullSpraySizeScale (double scale)
	Set a default value to use if setHullSpraySizeScale has not been called.
virtual void	setDefaultHullSprayVelocityScale (double scale)
	Set a default value to use if setHullSprayVelocityScale has not been called.
virtual void	setDefaultHullSprayStart (double extent)
	Set a default value to use if setHullSprayStart has not been called.
virtual void	setDefaultHullSprayEnd (double extent)
	Set a default value to use if setHullSprayEnd has not been called.
virtual void	setDefaultHullSprayVerticalOffset (double offset)
	Set a default value to use if setHullSprayVerticalOffset has not been called.
bool	contributesToBound () const
	Get whether this model instance contributes to an object's overall bounding volume - in this, returns false.
virtual void	setSprayEnabled (bool b)
	Set/Get whether spray is enabled at the bow of the ship and along the hull.
virtual bool	sprayEnabled () const
virtual void	setSternWaveEnabled (bool b)
	Set/Get whether a stern wave is enabled at the stern of the ship (you will undoubtedly also need to setSternWaveOffset.
virtual bool	sternWaveEnabled () const
virtual void	setWakeOffset (double offset)
	Set/get an offset to the ship position that all wake effects are positioned relative to.
virtual double	wakeOffset () const
virtual void	setBowSprayOffset (double offset)
	Set/get the distance from the wake origin to where the spray at the bow appears, if enabled.
virtual double	bowSprayOffset () const
virtual void	setBowWaveOffset (double offset)
	Set/get the distance from the wake origin to where the bow wake wave appear.
virtual double	bowWaveOffset () const
virtual void	setSternWaveOffset (double offset)
	Set/get the distance from the wake origin to where the stern wake waves appear.
virtual double	sternWaveOffset () const
virtual void	setShipLength (double length)
	Set/get the length of the ship.
virtual double	shipLength () const
virtual void	setBeamWidth (double width)
	Set/get the beamwidth (widest point) of the ship.
virtual double	beamWidth () const
virtual void	setPropWashEnabled (bool b)
	Set/get whether prop wash effects are enabled.
virtual bool	propWashEnabled () const
virtual void	setPropWashOffset (double offset)
	Set/get the distance from the wake origin to where the prop wash appears, if enabled.
virtual double	propWashOffset () const
virtual void	setPropWashFadeTime (double fadeTime)
	Set/get the amount of time, in seconds, over which the prop wash will dissipate., if enabled.
virtual double	propWashFadeTime () const
virtual void	setDraft (double draft)
	Set/get the draft, or the distance the hull extends underwater.
virtual double	draft () const
virtual void	setSprayVelocityScale (double scale)
	Set/get the scaling for velocity of bow spray effects.
virtual double	sprayVelocityScale () const
virtual void	setBowWaveScale (double scale)
	Set/get the scaling for bow wave effects.
virtual double	bowWaveScale () const
virtual void	setMaxBowWaveAmplitude (double amplitude)
	Set/get the max amplitude for bow waves.
virtual double	maxBowWaveAmplitude () const
virtual void	setBowSize (double size)
	Set/get the size of the bow (0 for a pointy one.)
virtual double	bowSize () const
virtual void	setSpraySizeScale (double scale)
	Set/get the scaling for size of bow spray effects.
virtual double	spraySizeScale () const
virtual void	setNumHullSprays (int numSprays)
	Set/get the number of spray particle systems emitted along the hull of the ship.
virtual int	numHullSprays () const
virtual void	setHullSprayStartOffset (double offset)
	Set/get the start position along the vector toward the ship's bow that hull spray particles begin at.
virtual double	hullSprayStartOffset () const
virtual void	setHullSprayEndOffset (double offset)
	Set/get the start position along the vector toward the ship's bow that hull spray particles end at.
virtual double	hullSprayEndOffset () const
virtual void	setHullSprayVerticalOffset (double scale)
	Set/get the vertical offset of hull spray particle origin points.
virtual double	hullSprayVerticalOffset () const
virtual void	setHullSprayVelocityScale (double scale)
	Set/get the scaling applied to hull spray particle sizes.
virtual double	hullSprayVelocityScale () const
virtual void	setHullSpraySizeScale (double scale)
	Set/get the initial velocity of hull spray particles as a percent of the bow spray velocity.
virtual double	hullSpraySizeScale () const
Public Member Functions inherited from makVrv::DtModelInstance
	DtModelInstance (DtDe &de)
	CTOR.
virtual	~DtModelInstance ()
	DTOR.
virtual bool	realize (DtModelDefinition &definition)
	Attempt to realize a definition.
const std::string &	realizedDefinitionName () const
	Get the name of the definition that this model instance was realized with.
virtual bool	saveModelToFile (const std::string &filename) const
	Attempt to save the model to a file.
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.
void	getBoundingBoxCenter (double &x, double &y, double &z) const
	Get the bounding box center of the model instance.
void	getBoundingBoxComponents (DtVector &minimum, DtVector &maximum)
virtual void	setContributesToBound (bool trueOrFalse)
	Set whether this model instance contributes to an object's overall bounding volume.
virtual void	setBlendColor (float r, float g, float b, float a)
	set the model's color
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.

Protected Member Functions
Triton::WakeGenerator *	wakeGenerator ()
	Return a pointer to our wakeGenerator object (needed by the updater)
virtual void	slot_tritonAboutToBeDeleted ()
	Called by signal when triton is being deleted.

Protected Attributes
Triton::WakeGenerator *	myWakeGenerator
double	myShipLength
double	myBeamWidth
double	myWakeOffset
double	myBowSprayOffset
double	myBowWaveOffset
double	mySternWaveOffset
double	myPropWashOffset
double	myPropWashFadeTime
double	myDraft
double	mySprayVelocityScale
double	myBowWaveScale
double	myMaxBowWaveAmplitude
double	myBowSize
double	mySpraySizeScale
int	myNumHullSprays
double	myHullSpraySizeScale
double	myHullSprayStart
double	myHullSprayEnd
double	myHullSprayVelocityScale
double	myHullSprayVerticalOffset
bool	mySprayEnabled
bool	mySternWaveEnabled
bool	myPropWashEnabled
bool	myWakeOffsetSet
bool	myBowSprayOffsetSet
bool	myBowWaveOffsetSet
bool	mySternWaveOffsetSet
bool	myPropWashOffsetSet
bool	myPropWashFadeTimeSet
bool	myMaxBowWaveAmplitudeSet
bool	myAdjustBowWakePositionSet
bool	myNumHullSpraysSet
bool	myHullSprayEndSet
bool	myHullSprayStartSet
bool	myHullSprayVerticalOffsetSet
DtSignalConnectionManager	mySignals
Protected Attributes inherited from makVrv::DtModelInstance
DtDe &	myDe
std::string	myRealizedModelDefinitionName
DtVector	myBoundingBoxCenter
DtVector	myBoundingBoxExtents
DtVector	myBoundingBoxMinimum
DtVector	myBoundingBoxMaximum
bool	myContributesToBound
bool	myColorBlendingEnabled
float	myBlendRed
float	myBlendBlue
float	myBlendGreen
float	myBlendAlpha

Friends
class	DtTritonWakeUpdater
	Allow the updater to use our protected methods.
class	DtTritonWakeModel
	Allow the wake model to use our protected methods.

Additional Inherited Members
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::DtModelInstance
boost::signal< void(DtModelInstance *)>	signal_modelInstanceChanged

Detailed Description

Implementation of a Triton wake model.

DtTritonWakeModelInstance provides the implementation of a Kelvin wake effect represented by a DtTritonWakeModel, using the Triton Ocean interface.

Constructor & Destructor Documentation

makVrv::DtTritonWakeModelInstance::DtTritonWakeModelInstance

(

DtDe &

de

)

CTOR.

virtual makVrv::DtTritonWakeModelInstance::~DtTritonWakeModelInstance ( )

virtual

DTOR.

Member Function Documentation

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

virtual

Set whether the wake is visible or not.

Implements makVrv::DtModelInstance.

virtual void makVrv::DtTritonWakeModelInstance::setSprayEnabled ( bool  b )

virtual

Set/Get whether spray is enabled at the bow of the ship and along the hull.

virtual bool makVrv::DtTritonWakeModelInstance::sprayEnabled ( ) const

virtual

virtual void makVrv::DtTritonWakeModelInstance::setSternWaveEnabled ( bool  b )

virtual

Set/Get whether a stern wave is enabled at the stern of the ship (you will undoubtedly also need to setSternWaveOffset.

virtual bool makVrv::DtTritonWakeModelInstance::sternWaveEnabled ( ) const

virtual

virtual void makVrv::DtTritonWakeModelInstance::setWakeOffset ( double  offset )

virtual

Set/get an offset to the ship position that all wake effects are positioned relative to.

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

virtual

virtual void makVrv::DtTritonWakeModelInstance::setBowSprayOffset ( double  offset )

virtual

Set/get the distance from the wake origin to where the spray at the bow appears, if enabled.

virtual double makVrv::DtTritonWakeModelInstance::bowSprayOffset ( ) const

virtual

virtual void makVrv::DtTritonWakeModelInstance::setBowWaveOffset ( double  offset )

virtual

Set/get the distance from the wake origin to where the bow wake wave appear.

virtual double makVrv::DtTritonWakeModelInstance::bowWaveOffset ( ) const

virtual

virtual void makVrv::DtTritonWakeModelInstance::setSternWaveOffset ( double  offset )

virtual

Set/get the distance from the wake origin to where the stern wake waves appear.

virtual double makVrv::DtTritonWakeModelInstance::sternWaveOffset ( ) const

virtual

virtual void makVrv::DtTritonWakeModelInstance::setShipLength ( double  length )

virtual

Set/get the length of the ship.

virtual double makVrv::DtTritonWakeModelInstance::shipLength ( ) const

virtual

virtual void makVrv::DtTritonWakeModelInstance::setBeamWidth ( double  width )

virtual

Set/get the beamwidth (widest point) of the ship.

virtual double makVrv::DtTritonWakeModelInstance::beamWidth ( ) const

virtual

virtual void makVrv::DtTritonWakeModelInstance::setPropWashEnabled ( bool  b )

virtual

Set/get whether prop wash effects are enabled.

virtual bool makVrv::DtTritonWakeModelInstance::propWashEnabled ( ) const

virtual

virtual void makVrv::DtTritonWakeModelInstance::setPropWashOffset ( double  offset )

virtual

Set/get the distance from the wake origin to where the prop wash appears, if enabled.

virtual double makVrv::DtTritonWakeModelInstance::propWashOffset ( ) const

virtual

virtual void makVrv::DtTritonWakeModelInstance::setPropWashFadeTime ( double  fadeTime )

virtual

Set/get the amount of time, in seconds, over which the prop wash will dissipate., if enabled.

virtual double makVrv::DtTritonWakeModelInstance::propWashFadeTime ( ) const

virtual

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

virtual

Set/get the draft, or the distance the hull extends underwater.

Used to influence the bow wake.

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

virtual

virtual void makVrv::DtTritonWakeModelInstance::setSprayVelocityScale ( double  scale )

virtual

Set/get the scaling for velocity of bow spray effects.

virtual double makVrv::DtTritonWakeModelInstance::sprayVelocityScale ( ) const

virtual

virtual void makVrv::DtTritonWakeModelInstance::setBowWaveScale ( double  scale )

virtual

Set/get the scaling for bow wave effects.

virtual double makVrv::DtTritonWakeModelInstance::bowWaveScale ( ) const

virtual

virtual void makVrv::DtTritonWakeModelInstance::setMaxBowWaveAmplitude ( double  amplitude )

virtual

Set/get the max amplitude for bow waves.

virtual double makVrv::DtTritonWakeModelInstance::maxBowWaveAmplitude ( ) const

virtual

virtual void makVrv::DtTritonWakeModelInstance::setBowSize ( double  size )

virtual

Set/get the size of the bow (0 for a pointy one.)

virtual double makVrv::DtTritonWakeModelInstance::bowSize ( ) const

virtual

virtual void makVrv::DtTritonWakeModelInstance::setSpraySizeScale ( double  scale )

virtual

Set/get the scaling for size of bow spray effects.

virtual double makVrv::DtTritonWakeModelInstance::spraySizeScale ( ) const

virtual

virtual void makVrv::DtTritonWakeModelInstance::setNumHullSprays ( int  numSprays )

virtual

Set/get the number of spray particle systems emitted along the hull of the ship.

virtual int makVrv::DtTritonWakeModelInstance::numHullSprays ( ) const

virtual

virtual void makVrv::DtTritonWakeModelInstance::setHullSprayStartOffset ( double  offset )

virtual

Set/get the start position along the vector toward the ship's bow that hull spray particles begin at.

virtual double makVrv::DtTritonWakeModelInstance::hullSprayStartOffset ( ) const

virtual

virtual void makVrv::DtTritonWakeModelInstance::setHullSprayEndOffset ( double  offset )

virtual

Set/get the start position along the vector toward the ship's bow that hull spray particles end at.

virtual double makVrv::DtTritonWakeModelInstance::hullSprayEndOffset ( ) const

virtual

virtual void makVrv::DtTritonWakeModelInstance::setHullSprayVerticalOffset ( double  scale )

virtual

Set/get the vertical offset of hull spray particle origin points.

virtual double makVrv::DtTritonWakeModelInstance::hullSprayVerticalOffset ( ) const

virtual

virtual void makVrv::DtTritonWakeModelInstance::setHullSprayVelocityScale ( double  scale )

virtual

Set/get the scaling applied to hull spray particle sizes.

virtual double makVrv::DtTritonWakeModelInstance::hullSprayVelocityScale ( ) const

virtual

virtual void makVrv::DtTritonWakeModelInstance::setHullSpraySizeScale ( double  scale )

virtual

Set/get the initial velocity of hull spray particles as a percent of the bow spray velocity.

virtual double makVrv::DtTritonWakeModelInstance::hullSpraySizeScale ( ) const

virtual

virtual void makVrv::DtTritonWakeModelInstance::setDefaultWakeOffset ( double  offset )

virtual

Set a default value to use if setWakeOffset has not been called.

virtual void makVrv::DtTritonWakeModelInstance::setDefaultBowSprayOffset ( double  offset )

virtual

Set a default value to use if setBowSprayOffset has not been called.

virtual void makVrv::DtTritonWakeModelInstance::setDefaultBowWaveOffset ( double  offset )

virtual

Set a default value to use if setBowWaveOffset has not been called.

virtual void makVrv::DtTritonWakeModelInstance::setDefaultSternWaveOffset ( double  offset )

virtual

Set a default value to use if setSternWaveOffset has not been called.

virtual void makVrv::DtTritonWakeModelInstance::setDefaultShipLength ( double  length )

virtual

Set a default value to use if setHipLength has not been called.

virtual void makVrv::DtTritonWakeModelInstance::setDefaultBeamWidth ( double  width )

virtual

Set a default value to use if setBeamWidth has not been called.

virtual void makVrv::DtTritonWakeModelInstance::setDefaultDraft ( double  draft )

virtual

Set a default value to use if setDraft has not been called.

virtual void makVrv::DtTritonWakeModelInstance::setDefaultPropWashOffset ( double  offset )

virtual

Set a default value to use if setPropWashOffset has not been called.

virtual void makVrv::DtTritonWakeModelInstance::setDefaultPropWashFadeTime ( double  fadeTime )

virtual

Set a default value to use if setPropWashFadeTime has not been called.

virtual void makVrv::DtTritonWakeModelInstance::setDefaultSprayVelocityScale ( double  scale )

virtual

Set a default value to use if setSprayVelocityScale has not been called.

virtual void makVrv::DtTritonWakeModelInstance::setDefaultBowWaveScale ( double  scale )

virtual

Set a default value to use if setBowWaveScale has not been called.

virtual void makVrv::DtTritonWakeModelInstance::setDefaultMaxBowWaveAmplitude ( double  amplitude )

virtual

Set a default value to use if setMaxBowWaveAmplitude has not been called.

virtual void makVrv::DtTritonWakeModelInstance::setDefaultBowSize ( double  size )

virtual

Set a default value to use if setBowSize has not been called.

virtual void makVrv::DtTritonWakeModelInstance::setDefaultSpraySizeScale ( double  scale )

virtual

Set a default value to use if setSpraySizeScale has not been called.

virtual void makVrv::DtTritonWakeModelInstance::setDefaultNumHullSprays ( int  sprays )

virtual

Set a default value to use if setNumHullSprays has not been called.

virtual void makVrv::DtTritonWakeModelInstance::setDefaultHullSpraySizeScale ( double  scale )

virtual

Set a default value to use if setHullSpraySizeScale has not been called.

virtual void makVrv::DtTritonWakeModelInstance::setDefaultHullSprayVelocityScale ( double  scale )

virtual

Set a default value to use if setHullSprayVelocityScale has not been called.

virtual void makVrv::DtTritonWakeModelInstance::setDefaultHullSprayStart ( double  extent )

virtual

Set a default value to use if setHullSprayStart has not been called.

virtual void makVrv::DtTritonWakeModelInstance::setDefaultHullSprayEnd ( double  extent )

virtual

Set a default value to use if setHullSprayEnd has not been called.

virtual void makVrv::DtTritonWakeModelInstance::setDefaultHullSprayVerticalOffset ( double  offset )

virtual

Set a default value to use if setHullSprayVerticalOffset has not been called.

bool makVrv::DtTritonWakeModelInstance::contributesToBound

(

)

const

Get whether this model instance contributes to an object's overall bounding volume - in this, returns false.

Reimplemented from makVrv::DtModelInstance.

Triton::WakeGenerator* makVrv::DtTritonWakeModelInstance::wakeGenerator ( )

protected

Return a pointer to our wakeGenerator object (needed by the updater)

virtual void makVrv::DtTritonWakeModelInstance::slot_tritonAboutToBeDeleted ( )

protectedvirtual

Called by signal when triton is being deleted.

Friends And Related Function Documentation

friend class DtTritonWakeUpdater

friend

Allow the updater to use our protected methods.

friend class DtTritonWakeModel

friend

Allow the wake model to use our protected methods.

Member Data Documentation

Triton::WakeGenerator* makVrv::DtTritonWakeModelInstance::myWakeGenerator

protected

double makVrv::DtTritonWakeModelInstance::myShipLength

protected

double makVrv::DtTritonWakeModelInstance::myBeamWidth

protected

double makVrv::DtTritonWakeModelInstance::myWakeOffset

protected

double makVrv::DtTritonWakeModelInstance::myBowSprayOffset

protected

double makVrv::DtTritonWakeModelInstance::myBowWaveOffset

protected

double makVrv::DtTritonWakeModelInstance::mySternWaveOffset

protected

double makVrv::DtTritonWakeModelInstance::myPropWashOffset

protected

double makVrv::DtTritonWakeModelInstance::myPropWashFadeTime

protected

double makVrv::DtTritonWakeModelInstance::myDraft

protected

double makVrv::DtTritonWakeModelInstance::mySprayVelocityScale

protected

double makVrv::DtTritonWakeModelInstance::myBowWaveScale

protected

double makVrv::DtTritonWakeModelInstance::myMaxBowWaveAmplitude

protected

double makVrv::DtTritonWakeModelInstance::myBowSize

protected

double makVrv::DtTritonWakeModelInstance::mySpraySizeScale

protected

int makVrv::DtTritonWakeModelInstance::myNumHullSprays

protected

double makVrv::DtTritonWakeModelInstance::myHullSpraySizeScale

protected

double makVrv::DtTritonWakeModelInstance::myHullSprayStart

protected

double makVrv::DtTritonWakeModelInstance::myHullSprayEnd

protected

double makVrv::DtTritonWakeModelInstance::myHullSprayVelocityScale

protected

double makVrv::DtTritonWakeModelInstance::myHullSprayVerticalOffset

protected

bool makVrv::DtTritonWakeModelInstance::mySprayEnabled

protected

bool makVrv::DtTritonWakeModelInstance::mySternWaveEnabled

protected

bool makVrv::DtTritonWakeModelInstance::myPropWashEnabled

protected

bool makVrv::DtTritonWakeModelInstance::myWakeOffsetSet

protected

bool makVrv::DtTritonWakeModelInstance::myBowSprayOffsetSet

protected

bool makVrv::DtTritonWakeModelInstance::myBowWaveOffsetSet

protected

bool makVrv::DtTritonWakeModelInstance::mySternWaveOffsetSet

protected

bool makVrv::DtTritonWakeModelInstance::myPropWashOffsetSet

protected

bool makVrv::DtTritonWakeModelInstance::myPropWashFadeTimeSet

protected

bool makVrv::DtTritonWakeModelInstance::myMaxBowWaveAmplitudeSet

protected

bool makVrv::DtTritonWakeModelInstance::myAdjustBowWakePositionSet

protected

bool makVrv::DtTritonWakeModelInstance::myNumHullSpraysSet

protected

bool makVrv::DtTritonWakeModelInstance::myHullSprayEndSet

protected

bool makVrv::DtTritonWakeModelInstance::myHullSprayStartSet

protected

bool makVrv::DtTritonWakeModelInstance::myHullSprayVerticalOffsetSet

protected

DtSignalConnectionManager makVrv::DtTritonWakeModelInstance::mySignals

protected

---

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

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