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

Inheritance diagram for makVrv::DtWakeModel:

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

virtual	~DtWakeModel ()
	DTOR. More...

virtual void	setModelDefinition (const std::string &def)=0
	Override the set model definition function. More...

virtual void	setSprayEnabled (bool b)=0
	Enable or disable spray at the bow and hull of the ship. More...

virtual void	setSternWaveEnabled (bool b)=0
	Enable or disable a stern wave. More...

virtual void	setWakeOffset (double offset)=0
	Set the distance from the center of the ship to the origin point of the circles use to generate the wake. More...

virtual void	setBowSprayOffset (double offset)=0
	Set the distance from the wake origin to where the spray appears, if enabled. More...

virtual void	setBowWaveOffset (double offset)=0
	Set the distance from the wake origin to where the bow wake appears. More...

virtual void	setSternWaveOffset (double offset)=0
	Set the distance from the wake origin to where the stern wakes appear. More...

virtual void	setShipLength (double length)=0
	Set the length of the ship. More...

virtual void	setBeamWidth (double width)=0
	Set the beam width (widest point) of the ship. More...

virtual void	setPropWashEnabled (bool b)=0
	Set whether prop wash effects are enabled. More...

virtual void	setPropWashOffset (double offset)=0
	Set the distance from the wake origin to where the prop wash appears, if enabled. More...

virtual void	setPropWashFadeTime (double fadeTime)=0
	Set the amount of time, in seconds, over which the prop wash will dissipate. More...

virtual void	setDraft (double draft)=0
	Set the draft, or the distance the hull extends underwater. More...

virtual void	setSprayVelocityScale (double scale)=0
	Set the velocity scaling for bow spray effects. More...

virtual void	setBowWaveScale (double scale)=0
	Set the scaling for bow wave effects. More...

virtual void	setMaxBowWaveAmplitude (double amplitude)=0
	Set the max amplitude for bow waves. More...

virtual void	setBowSize (double size)=0
	Set the size of the bow (0 for a pointy one.) More...

virtual void	setSpraySizeScale (double scale)=0
	Set the particle size scaling for size of bow spray effects. More...

virtual void	setNumHullSprays (int numSprays)=0
	Set the number of spray particle systems emitted along the hull of the ship. More...

virtual void	setHullSprayStart (double extent)=0
	Set the start offset along the vector toward the ship's bow that hull spray particles are emitted. More...

virtual void	setHullSprayEnd (double extent)=0
	Set the end offset along the vector toward the ship's bow that hull spray particles are emitted. More...

virtual void	setHullSprayVelocityScale (double scale)=0
	Set the initial velocity of hull spray particles as a percent of the ship velocity. More...

virtual void	setHullSpraySizeScale (double scale)=0
	Set the initial size of hull spray particles. More...

virtual void	setHullSprayVerticalOffset (double offset)=0
	Set the initial vertical offset of hull spray particles. More...

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

virtual	~DtModel ()
	DTOR. More...

DtModelInstance *	createModelInstance (const std::string &modelDefName, bool realize=true)
	Set the model definition and creates an instance of the model. More...

virtual const std::string &	modelDefinitionName ()
	returns the model definition name. More...

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

virtual const std::string &	className () const
	Get the class name of the model instance owner. More...

unsigned int	transformSize () const
	Get the number of position/orientations this model has. More...

virtual void	setPosition (int vtx, const DtVector &position)
	Set the position of a control vertex in the model. More...

virtual const DtVector &	position (int vtx=0) const
	Get the Position of a given point. More...

virtual void	removePosition (int vtx)
	Remove a transform at the given position. More...

virtual void	setPositionOffset (const DtVector &positionOffset)
	Set the position offset of the model. More...

virtual const DtVector &	positionOffset () const
	Get the Position Offset of the model. More...

virtual void	setOrientation (int vtx, const DtTaitBryan &orientation)
	Set the orientation of a vertex in the model. More...

virtual void	setPositionAndOrientation (int vtx, const DtVector &positionOffset, const DtTaitBryan &orientation)
	Set the position and orientation of a vertex in the model at the same time. More...

virtual const DtTaitBryan &	orientation (int vtx=0) const
	Get the Orientation of a given point. More...

virtual void	setOrientationOffset (const DtTaitBryan &orientationOffset)
	Set the Orientation Offset of the model. More...

virtual const DtTaitBryan &	orientationOffset () const
	Get the Orientation Offset of the model. More...

virtual void	enableColorBlending (bool b)
	Enable / disable color blending for this model. More...

virtual void	setBlendColor (float r, float g, float b, float a)
	Set color to use if color blending is enabled. More...

virtual void	getBlendColor (float &r, float &g, float &b, float &a)
	Returns the blend color. More...

virtual bool	colorBlendingEnabled () const
	Returns whether or not blending is enabled. More...

virtual void	setColor (float r, float g, float b, float a)
	set the model's color More...

virtual void	enableLighting (bool l)
	set whether the model is lit; this may not be an option on all models More...

virtual int	modelSet () const
	Get the model set this model is part of. More...

const DtVector &	boundingBoxExtents () const
	Get the bounding box extents of the model instance. More...

void	getBoundingBoxExtents (double &x, double &y, double &z) const
	Get the bounding box extents of the model instance. More...

const DtVector &	boundingBoxCenter () const
	Get the bounding box center of the model instance. More...

virtual void	getBoundingBoxCenter (double &x, double &y, double &z) const
	Get the bounding box center of the model instance. More...

virtual void	getBoundingBoxComponents (DtVector &minimum, DtVector &maximum)
	Get the minimum and maximum X,Y,Z components of the bounding box. More...

void	setContributesToBound (bool trueOrFalse)
	Set whether this model instance contributes to an object's overall bounding volume. More...

bool	contributesToBound () const
	Get whether this model instance contributes to an object's overall bounding volume. More...

DtDe &	de ()
	Get the DtDe object. More...

virtual void	setModelInstance (DtModelInstance *modelInstance)
	Internally set the model instance pointer. More...

virtual void	promoteBackgroundModelInstance (DtModelDefinition &defintion)
	Internally set the model instance pointer to the background one, also realizes and sends signal. More...

virtual void	setVisible (bool isVisible)
	Set the visible state of the model. More...

virtual bool	visible () const
	Get the visible state of the model. More...

DtUniqueID	parentSceneObjectID () const
	Parent of the model. More...

virtual void	addedToSceneObjectAsProp (const DtUniqueID &sceneObj)
	Called when a scene object added the model as a prop. More...

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. More...

virtual void	setElementId (DtUniqueID id)
	Called when the element ID of the model's parent object is set. More...

virtual void	removedFromSceneObject ()
	Called when the model was removed from a scene object. More...

virtual void	setIsSupportModel (bool isSupport)=0
	Is this model part of the support group? (determines whether or not other scene objects can ground clamp to this model) More...

virtual void	setSolid (bool isSolid)
	Set whether or not other this model is drawn filled in. More...

virtual bool	isProp ()
	Return whether or not this model was added as a prop. More...

virtual void	updateMinLastFrameDistance (float distance)
	updates the closest distance to an observer over the last frame More...

virtual void	resetLastFrameDistance ()
	resets the closest distance to an observer More...

virtual float	minLastFrameDistance () const
	gets the closest distance to an observer last frame More...

virtual DtModelInstance *	modelInstance ()
	Get the model instance. More...

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. More...

virtual bool	supportsMultithreadedLoad ()
	can be quickly overridden to disable background loading More...

virtual void	backgroundLoad ()
	the chunk of loading that can safely happen in the background More...

virtual void	foregroundLoad ()
	the chunk of loading that must happen happen in the foreground, adding to scene graph etc. More...

virtual bool	isActivelyBackgroundLoading ()
	is this being actively loaded (it has a myInLoadQueueHandle object and it's loading) More...

virtual DtLoaderHandle *	getLoadQueueHandle ()
	returns the load queue object More...

Additional Inherited Members
Public Attributes inherited from makVrv::DtModel
boost::signal< void(DtModel *)>	signal_modelToBeDestroyed
	Signal emitted when the model is to be destroyed. More...

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. More...

boost::signal< void(DtModelInstance , DtModel )>	signal_modelInstanceCreated
	Signal emitted when the model instance is created. More...

boost::signal< void(DtModelInstance , DtModel )>	signal_modelInstanceToBeDestroyed
	Signal emitted when the model instance is to be destroyed. More...

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

Protected Member Functions inherited from makVrv::DtModel
virtual void	addToScene (const DtUniqueID &sceneObjectId, int modelSet, int visualizerType)=0
	Virtual Functions to be implemented, add this model to the scene. More...

virtual void	addToSceneAsProp (const DtUniqueID &sceneObjectId)
	Add this model to the scene as a prop. More...

virtual void	removeFromScene ()=0
	Virtual Functions to be implemented, remove this model from the scene. More...

virtual void	initializeModelInstance ()
	Push any state maintained by the model to the model instance. More...

void	slot_modelInstanceChanged (DtModelInstance *instance)
	Called when the model instance changed. More...

virtual void	waitAndClearLoadHandle ()
	avoids race condition, on destruction subclasses need to wait for the model to cleanly finish loading this can happen if an object times in and out very quickly More...

virtual void	removedFromLoadQueue ()
	deletes the myInLoadQueueHandle handle More...

virtual void	setDoneBackgroundLoading ()
	called by async task, updates myCurrentlyLoading atomic More...

virtual void	setActivelyBackgroundLoading ()
	called right before tbb task creation More...

Protected Attributes inherited from makVrv::DtModel
DtLoaderHandle *	myInLoadQueueHandle

DtDe &	myDe

const DtUniqueID	myUniqueId
	The unique id is constant after initialization. More...

bool	myColorBlendingEnabled
	The color blending enabled is needed to be set by the derived class so it doesn't get down to the model instances when instancing is enabled. More...

DtModelInstance *	myBackgroundModelInstance
	holds the model created in the background for a bit More...

float	myMinLastFrameDistance
	last frames mimimal distance to the camera, calculated by the instancing system More...

TransformList	myTransforms
	We keep our own copy in case we get updates before we get a model instance. More...

DtModelInstance *	myModelInstance

int	myModelSet

int	myVisualizerType

bool	myContributesToBound

DtUniqueID	myParentSceneObjectID

bool	myIsPropFlag

float	myBlendColor [4]

bool	myVisibleFlag

DtVector	myPositionOffset

DtTaitBryan	myOrientationOffset

std::string	myModelDefinitionName

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

Detailed Description

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

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.vrf4-8-branch/include/vrvCore/DtWakeModel.h

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation