DtTritonDynamicOceanObject is the triton-based implementation of a DtDynamicOceanObject. More...

Inheritance diagram for makVrv::DtTritonDynamicOceanObject:

Public Member Functions
	DtTritonDynamicOceanObject (DtDe &, DtUniqueID id)
	CTOR.
virtual	~DtTritonDynamicOceanObject ()
	DTOR.
virtual void	setSeaLevel (double meters)
	Set the sea level, in meters.
virtual void	setLodAltitude (int meters)
	Set the altitude above which dynamic ocean will LOD out.
virtual void	setWindSpeed (double metersPerSecond)
	Set the wind speed.
virtual void	setWindDirection (double radiansClockwiseFromNorth)
	Set the wind direction in radians from north (clockwise).
virtual void	setWindFetch (double meters)
	Set the fetch length. in meters.
virtual void	setWindDrivenSeaState (bool enabled)
	Set sea state is wind-driven or driven by Douglas Scale.
virtual void	setDouglasSeaState (int seaState, double seaStateDirection, int swellState, double swellStateDirection)
	Set sea state based on Douglas sea state parameters.
virtual void	setSeaChoppiness (double chop)
	Set the amount of chop on the sea.
virtual void	setUnderwaterVisibilityEnabled (bool enabled)
	Set / Get underwater visibility enabled.
virtual void	setUnderwaterVisibility (double meters)
	Set the maximum visibility under water in meters.
virtual void	setSurfaceTransparency (double transparency)
	Set the transparency of the water surface around coastlines.
virtual void	setSurgeDepth (double meters)
	Set surge depth.
virtual void	setDepthOffset (double meters)
	Set depth offset.
virtual void	addSwell (double lengthInMeters, double heightInMeters, double radiansClockwiseFromNorth)
	Add a swell.
virtual void	clearSwells ()
	Clear all swells.
Public Member Functions inherited from makVrv::DtDynamicOceanObject
	DtDynamicOceanObject (DtDe &de, DtUniqueID id)
	CTOR.
virtual	~DtDynamicOceanObject ()
	DTOR.
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 (int &seaState, double &seaStateDirection, int &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
	Get the list of swells.
virtual void	setWaterCurrentSpeed (float speed)
	Set / get the speed of water currents in meters per second.
virtual float	waterCurrentSpeed () const
virtual void	setWaterCurrentDirection (float direction)
	Set / get the direction of water currents in radians from north (clockwise).
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
int	myDouglasSeaState
double	myDouglasSeaDirection
int	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

Detailed Description

DtTritonDynamicOceanObject is the triton-based implementation of a DtDynamicOceanObject.

This object is distributed, and will typically be created and interfaced to using a DtDynamicOceanObjectAgent.

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	(	int	seaState,
		double	seaStateDirection,
		int	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.

Member Data Documentation

DtDe& makVrv::DtTritonDynamicOceanObject::myDe

protected

DtTritonManager& makVrv::DtTritonDynamicOceanObject::myTritonManager

protected

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

/exports/nfedora7-1/nightly/docs/vrforcesDevelopment.tot/include/vrvTriton/DtTritonDynamicOceanObject.h

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation