makVrv::DtTidalStreamWakeModel Class Reference

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

Inheritance diagram for makVrv::DtTidalStreamWakeModel:

Public Member Functions
	DtTidalStreamWakeModel (DtDe &de, DtUniqueID id)
virtual	~DtTidalStreamWakeModel ()
virtual void	setModelDefinition (const std::string &def)=0
virtual std::string	modelDefinition () const =0
virtual void	setWakeLength (double wakeLength)=0
virtual double	wakeLength () const =0
virtual void	setWakeOffset (double wakeLength)=0
virtual double	wakeOffset () const =0
virtual void	setDraft (double draft)=0
virtual double	draft () const =0
virtual void	setMaxWaveAmplitude (double amplitude)=0
virtual double	maxWaveAmplitude () const =0
virtual void	setLodDistance (double lodDistance)=0
virtual double	lodDistance () const =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::DtTidalStreamWakeModel::DtTidalStreamWakeModel	(	DtDe &	de,
		DtUniqueID	id
	)

CTOR.

virtual makVrv::DtTidalStreamWakeModel::~DtTidalStreamWakeModel ( )

virtual

DTOR.

Member Function Documentation

virtual void makVrv::DtTidalStreamWakeModel::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::DtTritonTidalStreamWakeModel.

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

pure virtual

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

Implemented in makVrv::DtTritonTidalStreamWakeModel.

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

pure virtual

Set / get the length of the wake generated.

Implemented in makVrv::DtTritonTidalStreamWakeModel.

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

pure virtual

Set / get the length of the wake generated.

Implemented in makVrv::DtTritonTidalStreamWakeModel.

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

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

Implemented in makVrv::DtTritonTidalStreamWakeModel.

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

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

Implemented in makVrv::DtTritonTidalStreamWakeModel.

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

pure virtual

Set / get the distance underwater this object extends.

Implemented in makVrv::DtTritonTidalStreamWakeModel.

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

pure virtual

Set / get the distance underwater this object extends.

Implemented in makVrv::DtTritonTidalStreamWakeModel.

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

pure virtual

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

Implemented in makVrv::DtTritonTidalStreamWakeModel.

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

pure virtual

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

Implemented in makVrv::DtTritonTidalStreamWakeModel.

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

pure virtual

Set / get the distance (m) to LOD out the tidal stream wake.

Implemented in makVrv::DtTritonTidalStreamWakeModel.

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

pure virtual

Set / get the distance (m) to LOD out the tidal stream wake.

Implemented in makVrv::DtTritonTidalStreamWakeModel.

---

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

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