makVrv::DtTritonDynamicOceanObject Class Reference

DtTritonDynamicOceanObject is the triton-based implementation of a DtDynamicOceanObject. This object is distributed, and will typically be created and interfaced to using a DtDynamicOceanObjectAgent.

Inheritance diagram for makVrv::DtTritonDynamicOceanObject:

Public Member Functions
	DtTritonDynamicOceanObject (DtDe &, DtUniqueID id)
virtual	~DtTritonDynamicOceanObject ()
virtual void	setSeaLevel (double meters)
virtual void	setLodAltitude (int meters)
virtual void	setWindSpeed (double metersPerSecond)
virtual void	setWindDirection (double radiansClockwiseFromNorth)
virtual void	setWindFetch (double meters)
virtual void	setWindDrivenSeaState (bool enabled)
virtual void	setDouglasSeaState (DtDouglasSeaState::Scale seaState, double seaStateDirection, DtDouglasSwellState::Scale swellState, double swellStateDirection)
virtual void	setSeaChoppiness (double chop)
virtual void	setUnderwaterVisibilityEnabled (bool enabled)
virtual void	setUnderwaterVisibility (double meters)
virtual void	setSurfaceTransparency (double transparency)
virtual void	setSurgeDepth (double meters)
virtual void	setDepthOffset (double meters)
virtual void	addSwell (double lengthInMeters, double heightInMeters, double radiansClockwiseFromNorth)
virtual void	clearSwells ()
virtual bool	LockHeightData () override
virtual bool	UnLockHeightData () override
virtual bool	IsLockedHeightData () const override
Public Member Functions inherited from makVrv::DtDynamicOceanObject
	DtDynamicOceanObject (DtDe &de, DtUniqueID id)
virtual	~DtDynamicOceanObject ()
virtual double	seaLevel () const
virtual int	lodAltitude () const
virtual double	windSpeed () const
virtual double	windDirection () const
virtual double	windFetch () const
virtual bool	windDrivenSeaState () const
virtual void	getDouglasSeaState (DtDouglasSeaState::Scale &seaState, double &seaStateDirection, DtDouglasSwellState::Scale &swellState, double &swellStateDirection) const
virtual double	seaChoppiness () const
virtual bool	underwaterVisibilityEnabled () const
virtual double	underwaterVisibility () const
virtual double	surfaceTransparency () const
virtual double	surgeDepth () const
virtual double	depthOffset () const
virtual void	addSwell (const OceanSwell &swell)
virtual const OceanSwellList &	getSwells () const
virtual void	setWaterCurrentSpeed (float speed)
virtual float	waterCurrentSpeed () const
virtual void	setWaterCurrentDirection (float direction)
virtual float	waterCurrentDirection () const

Protected Attributes
DtDe &	myDe
DtTritonManager &	myTritonManager
Protected Attributes inherited from makVrv::DtDynamicOceanObject
double	mySeaLevel
int	myLodAltitude
double	myWindSpeed
double	myWindDirection
double	myWindFetch
bool	myWindDrivenSeaStateEnabled
DtDouglasSeaState::Scale	myDouglasSeaState
double	myDouglasSeaDirection
DtDouglasSwellState::Scale	myDouglasSwellState
double	myDouglasSwellDirection
double	mySeaChoppiness
double	myUnderwaterVisibility
double	mySurfaceTransparency
double	mySurgeDepth
double	myDepthOffset
float	myWaterCurrentSpeed
float	myWaterCurrentDirection
bool	myUnderwaterVisibilityEnabled
OceanSwellList	myOceanSwells

Additional Inherited Members
Public Types inherited from makVrv::DtDynamicOceanObject
typedef std::list< OceanSwell >	OceanSwellList

Constructor & Destructor Documentation

makVrv::DtTritonDynamicOceanObject::DtTritonDynamicOceanObject	(	DtDe &	,
		DtUniqueID	id
	)

CTOR.

virtual makVrv::DtTritonDynamicOceanObject::~DtTritonDynamicOceanObject ( )

virtual

DTOR.

Member Function Documentation

virtual void makVrv::DtTritonDynamicOceanObject::setSeaLevel ( double  meters )

virtual

Set the sea level, in meters.

Reimplemented from makVrv::DtDynamicOceanObject.

virtual void makVrv::DtTritonDynamicOceanObject::setLodAltitude ( int  meters )

virtual

Set the altitude above which dynamic ocean will LOD out.

Reimplemented from makVrv::DtDynamicOceanObject.

virtual void makVrv::DtTritonDynamicOceanObject::setWindSpeed ( double  metersPerSecond )

virtual

Set the wind speed.

Reimplemented from makVrv::DtDynamicOceanObject.

virtual void makVrv::DtTritonDynamicOceanObject::setWindDirection ( double  radiansClockwiseFromNorth )

virtual

Set the wind direction in radians from north (clockwise).

Reimplemented from makVrv::DtDynamicOceanObject.

virtual void makVrv::DtTritonDynamicOceanObject::setWindFetch ( double  meters )

virtual

Set the fetch length. in meters.

Reimplemented from makVrv::DtDynamicOceanObject.

virtual void makVrv::DtTritonDynamicOceanObject::setWindDrivenSeaState ( bool  enabled )

virtual

Set sea state is wind-driven or driven by Douglas Scale.

Reimplemented from makVrv::DtDynamicOceanObject.

virtual void makVrv::DtTritonDynamicOceanObject::setDouglasSeaState ( DtDouglasSeaState::Scale  seaState, double  seaStateDirection, DtDouglasSwellState::Scale  swellState, double  swellStateDirection  )

virtual

Set sea state based on Douglas sea state parameters.

Reimplemented from makVrv::DtDynamicOceanObject.

virtual void makVrv::DtTritonDynamicOceanObject::setSeaChoppiness ( double  chop )

virtual

Set the amount of chop on the sea.

Note

This value may become obsolete.

Reimplemented from makVrv::DtDynamicOceanObject.

virtual void makVrv::DtTritonDynamicOceanObject::setUnderwaterVisibilityEnabled ( bool  enabled )

virtual

Set / Get underwater visibility enabled.

Reimplemented from makVrv::DtDynamicOceanObject.

virtual void makVrv::DtTritonDynamicOceanObject::setUnderwaterVisibility ( double  meters )

virtual

Set the maximum visibility under water in meters.

Reimplemented from makVrv::DtDynamicOceanObject.

virtual void makVrv::DtTritonDynamicOceanObject::setSurfaceTransparency ( double  transparency )

virtual

Set the transparency of the water surface around coastlines.

Reimplemented from makVrv::DtDynamicOceanObject.

virtual void makVrv::DtTritonDynamicOceanObject::setSurgeDepth ( double  meters )

virtual

Set surge depth.

Reimplemented from makVrv::DtDynamicOceanObject.

virtual void makVrv::DtTritonDynamicOceanObject::setDepthOffset ( double  meters )

virtual

Set depth offset.

Reimplemented from makVrv::DtDynamicOceanObject.

virtual void makVrv::DtTritonDynamicOceanObject::addSwell ( double  lengthInMeters, double  heightInMeters, double  radiansClockwiseFromNorth  )

virtual

Add a swell.

Reimplemented from makVrv::DtDynamicOceanObject.

virtual void makVrv::DtTritonDynamicOceanObject::clearSwells ( )

virtual

Clear all swells.

Reimplemented from makVrv::DtDynamicOceanObject.

virtual bool makVrv::DtTritonDynamicOceanObject::LockHeightData ( )

overridevirtual

If ocean height data is successfully locked, multiple Ocean::GetHeight calls can run in parallel from different threads.

Reimplemented from makVrv::DtDynamicOceanObject.

virtual bool makVrv::DtTritonDynamicOceanObject::UnLockHeightData ( )

overridevirtual

If ocean height data is successfully locked, multiple Ocean::GetHeight calls can run in parallel from different threads.

Reimplemented from makVrv::DtDynamicOceanObject.

virtual bool makVrv::DtTritonDynamicOceanObject::IsLockedHeightData ( ) const

overridevirtual

If ocean height data is successfully locked, multiple Ocean::GetHeight calls can run in parallel from different threads.

Reimplemented from makVrv::DtDynamicOceanObject.

Member Data Documentation

DtDe& makVrv::DtTritonDynamicOceanObject::myDe

protected

DtTritonManager& makVrv::DtTritonDynamicOceanObject::myTritonManager

protected

---

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

• /data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-1-branch/include/vrvTriton/DtTritonDynamicOceanObject.h