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

Inheritance diagram for makVrv::DtTidalStreamWakeModel:

Public Member Functions
	DtTidalStreamWakeModel (DtDe &de, DtUniqueID id)
	CTOR.
virtual	~DtTidalStreamWakeModel ()
	DTOR.

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

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

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

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

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

virtual void	setLodDistance (double lodDistance)=0
	Set / get the distance (m) to LOD out the tidal stream wake.
virtual double	lodDistance () const =0
	Set / get the distance (m) to LOD out the tidal stream wake.
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 void	setVisible (bool isVisible)
	Set the visible state of the model.
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	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)
virtual void	setSolid (bool isSolid)
	Set whether or not other this model is drawn filled in.
virtual DtModelInstance *	modelInstance ()
	Get the model instance.
virtual const DtModelInstance *	modelInstance () const
	Get the model instance.
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.

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
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.
virtual void	addToSceneAsProp (const DtUniqueID &sceneObjectId)
	Add this model to the scene as a prop.
virtual void	removeFromScene ()=0
	Virtual Functions to be implemented, remove this model from the scene.
virtual void	initializeModelInstance ()
	Push any state maintained by the model to the model instance.
void	slot_modelInstanceChanged (DtModelInstance *instance)
	Called when the model instance changed.
Protected Attributes inherited from makVrv::DtModel
DtDe &	myDe
const DtUniqueID	myUniqueId
bool	myColorBlendingEnabled

Detailed Description

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

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:

/exports/nfedora7-1/nightly/docs/vrforcesDevelopment.vrf4-3-branch/include/vrvCore/DtTidalStreamWakeModel.h

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation