The (abstract) interface for a model of a Kelvin wake.

Inheritance diagram for makVrv::DtWakeModel:

Public Member Functions
	DtWakeModel (DtDe &de, DtUniqueID id)

virtual	~DtWakeModel ()

virtual void	setModelDefinition (const std::string &def)=0

virtual void	setSprayEnabled (bool b)=0

virtual void	setSternWaveEnabled (bool b)=0

virtual void	setWakeOffset (double offset)=0

virtual void	setBowSprayOffset (double offset)=0

virtual void	setBowWaveOffset (double offset)=0

virtual void	setSternWaveOffset (double offset)=0

virtual void	setShipLength (double length)=0

virtual void	setBeamWidth (double width)=0

virtual void	setPropWashEnabled (bool b)=0

virtual void	setPropWashOffset (double offset)=0

virtual void	setPropWashFadeTime (double fadeTime)=0

virtual void	setDraft (double draft)=0

virtual void	setSprayVelocityScale (double scale)=0

virtual void	setBowWaveScale (double scale)=0

virtual void	setMaxBowWaveAmplitude (double amplitude)=0

virtual void	setBowSize (double size)=0

virtual void	setSpraySizeScale (double scale)=0

virtual void	setNumHullSprays (int numSprays)=0

virtual void	setHullSprayStart (double extent)=0

virtual void	setHullSprayEnd (double extent)=0

virtual void	setHullSprayVelocityScale (double scale)=0

virtual void	setHullSpraySizeScale (double scale)=0

virtual void	setHullSprayVerticalOffset (double offset)=0

Public Member Functions inherited from makVrv::DtModel
	DtModel (DtDe &de, DtUniqueID id)

virtual	~DtModel ()

DtModelInstance *	createModelInstance (const std::string &modelDefName, bool realize=true)

virtual const std::string &	modelDefinitionName ()

virtual void	saveModelToFile (const std::string &filename)

virtual const std::string &	className () const

virtual DtUniqueID	uniqueId () const

unsigned int	transformSize () const

virtual void	setPosition (int vtx, const DtVector &position)

virtual const DtVector &	position (int vtx=0) const

virtual void	removePosition (int vtx)

virtual void	setPositionOffset (const DtVector &positionOffset)

virtual const DtVector &	positionOffset () const

virtual void	setOrientation (int vtx, const DtTaitBryan &orientation)

virtual void	setPositionAndOrientation (int vtx, const DtVector &positionOffset, const DtTaitBryan &orientation)

virtual const DtTaitBryan &	orientation (int vtx=0) const

virtual void	setOrientationOffset (const DtTaitBryan &orientationOffset)

virtual const DtTaitBryan &	orientationOffset () const

virtual void	enableColorBlending (bool b)

virtual void	setBlendColor (float r, float g, float b, float a)

virtual void	getBlendColor (float &r, float &g, float &b, float &a)

virtual bool	colorBlendingEnabled () const

virtual void	setColor (float r, float g, float b, float a)

virtual void	enableLighting (bool l)

virtual DtModelSetId	modelSet () const

const DtVector &	boundingBoxExtents () const

void	getBoundingBoxExtents (double &x, double &y, double &z) const

const DtVector &	boundingBoxCenter () const

virtual void	getBoundingBoxCenter (double &x, double &y, double &z) const

virtual void	getBoundingBoxComponents (DtVector &minimum, DtVector &maximum)

void	setContributesToBound (bool trueOrFalse)

bool	contributesToBound () const

DtDe &	de ()

virtual void	setModelInstance (DtModelInstance *modelInstance)

virtual void	promoteBackgroundModelInstance (const DtModelDefinition &defintion)

virtual void	setVisible (bool isVisible)

virtual bool	visible () const

DtUniqueID	sceneObjectId () const

virtual void	addedToSceneObjectAsProp (const DtUniqueID &sceneObj)

virtual void	addedToSceneObject (const DtUniqueID &sceneObj, DtModelSetId modelSet, int visualizerType)

virtual void	setElementId (DtElementID id)

virtual void	removedFromSceneObject ()

virtual void	setIsSupportModel (bool isSupport)=0

virtual void	setSolid (bool isSolid)

virtual bool	isProp ()

virtual void	updateMinLastFrameDistance (float distance)

virtual void	resetLastFrameDistance ()

virtual float	minLastFrameDistance () const

virtual DtModelInstance *	modelInstance ()

virtual const DtModelInstance *	modelInstance () const

int	visualizerType () const

virtual bool	supportsMultithreadedLoad ()

virtual void	backgroundLoad ()

virtual void	foregroundLoad ()

virtual bool	isActivelyBackgroundLoading ()

virtual DtLoaderHandle *	getLoadQueueHandle ()

Additional Inherited Members
Public Attributes inherited from makVrv::DtModel
boost::signalslib::signal < void(DtModel *)>	signal_modelToBeDestroyed

boost::signalslib::signal < void(DtModel *)>	signal_modelChanged

boost::signalslib::signal < bool(DtModel *, bool), SlotReturnOR >	signal_visibilityChangeRequested

boost::signalslib::signal < void(DtModelInstance , DtModel )>	signal_modelInstanceCreated

boost::signalslib::signal < void(DtModelInstance , DtModel )>	signal_modelInstanceToBeDestroyed

Protected Types inherited from makVrv::DtModel
typedef std::vector < ObjectTransform >	TransformList

Protected Member Functions inherited from makVrv::DtModel
virtual void	addToScene (const DtUniqueID &sceneObjectId, DtModelSetId modelSet, int visualizerType)=0

virtual void	addToSceneAsProp (const DtUniqueID &sceneObjectId)

virtual void	removeFromScene ()=0

virtual void	initializeModelInstance ()

void	slot_modelInstanceChanged (DtModelInstance *instance)

virtual void	waitAndClearLoadHandle ()

virtual void	removedFromLoadQueue ()

virtual void	setDoneBackgroundLoading ()

virtual void	setActivelyBackgroundLoading ()

Protected Attributes inherited from makVrv::DtModel
DtLoaderHandle *	myInLoadQueueHandle

DtDe &	myDe

const DtUniqueID	myUniqueId

DtUniqueID	myElementId

DtUniqueID	myParentSceneObjectID

bool	myColorBlendingEnabled

DtModelInstance *	myBackgroundModelInstance

float	myMinLastFrameDistance

TransformList	myTransforms

DtModelInstance *	myModelInstance

DtModelSetId	myModelSet

int	myVisualizerType

bool	myContributesToBound

bool	myIsPropFlag

float	myBlendColor [4]

bool	myVisibleFlag

DtVector	myPositionOffset

DtTaitBryan	myOrientationOffset

std::string	myModelDefinitionName

bool	myRequireModelInstance = true

Static Protected Attributes inherited from makVrv::DtModel
static bool	theInittedState

Constructor & Destructor Documentation

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

CTOR.

virtual makVrv::DtWakeModel::~DtWakeModel ( )

virtual

DTOR.

Member Function Documentation

virtual void makVrv::DtWakeModel::setModelDefinition ( const std::string & def )

pure virtual

Override the set model definition function. Use this to parse a model after it is loaded.

Reimplemented from makVrv::DtModel.

Implemented in makVrv::DtTritonWakeModel.

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

pure virtual

Enable or disable spray at the bow and hull of the ship.

Implemented in makVrv::DtTritonWakeModel.

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

pure virtual

Enable or disable a stern wave.

Implemented in makVrv::DtTritonWakeModel.

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

pure virtual

Set the distance from the center of the ship to the origin point of the circles use to generate the wake.

Implemented in makVrv::DtTritonWakeModel.

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

pure virtual

Set the distance from the wake origin to where the spray appears, if enabled.

Implemented in makVrv::DtTritonWakeModel.

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

pure virtual

Set the distance from the wake origin to where the bow wake appears.

Implemented in makVrv::DtTritonWakeModel.

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

pure virtual

Set the distance from the wake origin to where the stern wakes appear.

Implemented in makVrv::DtTritonWakeModel.

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

pure virtual

Set the length of the ship.

Implemented in makVrv::DtTritonWakeModel.

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

pure virtual

Set the beam width (widest point) of the ship.

Implemented in makVrv::DtTritonWakeModel.

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

pure virtual

Set whether prop wash effects are enabled.

Implemented in makVrv::DtTritonWakeModel.

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

pure virtual

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

Implemented in makVrv::DtTritonWakeModel.

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

pure virtual

Set the amount of time, in seconds, over which the prop wash will dissipate.

Implemented in makVrv::DtTritonWakeModel.

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

pure virtual

Set the draft, or the distance the hull extends underwater. Used to influence the bow wake.

Implemented in makVrv::DtTritonWakeModel.

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

pure virtual

Set the velocity scaling for bow spray effects.

Implemented in makVrv::DtTritonWakeModel.

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

pure virtual

Set the scaling for bow wave effects.

Implemented in makVrv::DtTritonWakeModel.

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

pure virtual

Set the max amplitude for bow waves.

Implemented in makVrv::DtTritonWakeModel.

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

pure virtual

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

Implemented in makVrv::DtTritonWakeModel.

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

pure virtual

Set the particle size scaling for size of bow spray effects.

Implemented in makVrv::DtTritonWakeModel.

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

pure virtual

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

Implemented in makVrv::DtTritonWakeModel.

virtual void makVrv::DtWakeModel::setHullSprayStart ( double extent )

pure virtual

Set the start offset along the vector toward the ship's bow that hull spray particles are emitted.

Implemented in makVrv::DtTritonWakeModel.

virtual void makVrv::DtWakeModel::setHullSprayEnd ( double extent )

pure virtual

Set the end offset along the vector toward the ship's bow that hull spray particles are emitted.

Implemented in makVrv::DtTritonWakeModel.

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

pure virtual

Set the initial velocity of hull spray particles as a percent of the ship velocity.

Implemented in makVrv::DtTritonWakeModel.

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

pure virtual

Set the initial size of hull spray particles.

Implemented in makVrv::DtTritonWakeModel.

virtual void makVrv::DtWakeModel::setHullSprayVerticalOffset ( double offset )

pure virtual

Set the initial vertical offset of hull spray particles.

Implemented in makVrv::DtTritonWakeModel.

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

/data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-1-branch/include/vrvCore/DtWakeModel.h

Public Member Functions

Additional Inherited Members

Constructor & Destructor Documentation

Member Function Documentation