The base dynamic ocean object. An actual (do-nothing) implementation is provided so that an implementing plugin (such as triton) does not need to exist for the application to run.

Inheritance diagram for makVrv::DtDynamicOceanObject:

[legend]

Classes
class	OceanSwell

Public Types
typedef std::list< OceanSwell >	OceanSwellList

Public Member Functions
	DtDynamicOceanObject (DtDe &de, DtUniqueID id)

virtual	~DtDynamicOceanObject ()


virtual void	setSeaLevel (double meters)

virtual double	seaLevel () const


virtual void	setLodAltitude (int meters)

virtual int	lodAltitude () const


virtual void	setWindSpeed (double metersPerSecond)

virtual double	windSpeed () const


virtual void	setWindDirection (double radiansClockwiseFromNorth)

virtual double	windDirection () const


virtual void	setWindFetch (double meters)

virtual double	windFetch () const


virtual void	setWindDrivenSeaState (bool enabled)

virtual bool	windDrivenSeaState () const


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

virtual void	getDouglasSeaState (DtDouglasSeaState::Scale &seaState, double &seaStateDirection, DtDouglasSwellState::Scale &swellState, double &swellStateDirection) const


virtual void	setSeaChoppiness (double chop)

virtual double	seaChoppiness () const


virtual void	setUnderwaterVisibilityEnabled (bool enabled)

virtual bool	underwaterVisibilityEnabled () const


virtual void	setUnderwaterVisibility (double meters)

virtual double	underwaterVisibility () const


virtual void	setSurfaceTransparency (double transparency)

virtual double	surfaceTransparency () const


virtual void	setSurgeDepth (double meters)

virtual double	surgeDepth () const


virtual void	setDepthOffset (double meters)

virtual double	depthOffset () const


virtual void	addSwell (double lengthInMeters, double heightInMeters, double radiansClockwiseFromNorth)

virtual void	addSwell (const OceanSwell &swell)

virtual const OceanSwellList &	getSwells () const

virtual void	clearSwells ()


virtual void	setWaterCurrentSpeed (float speed)

virtual float	waterCurrentSpeed () const


virtual void	setWaterCurrentDirection (float direction)

virtual float	waterCurrentDirection () const


virtual bool	LockHeightData ()

virtual bool	UnLockHeightData ()

virtual bool	IsLockedHeightData () const

Member Typedef Documentation

typedef std::list<OceanSwell> makVrv::DtDynamicOceanObject::OceanSwellList

Constructor & Destructor Documentation

makVrv::DtDynamicOceanObject::DtDynamicOceanObject	(	DtDe &	de,
		DtUniqueID	id
	)

CTOR.

virtual makVrv::DtDynamicOceanObject::~DtDynamicOceanObject ( )

virtual

DTOR.

Member Function Documentation

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

virtual

Set / Get the sea level, in meters.

Reimplemented in makVrv::DtTritonDynamicOceanObject.

virtual double makVrv::DtDynamicOceanObject::seaLevel ( ) const

virtual

Set / Get the sea level, in meters.

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

virtual

Set / Get the altitude above which dynamic ocean will LOD out.

Reimplemented in makVrv::DtTritonDynamicOceanObject.

virtual int makVrv::DtDynamicOceanObject::lodAltitude ( ) const

virtual

Set / Get the altitude above which dynamic ocean will LOD out.

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

virtual

Set / Get the wind speed in meters per second.

Reimplemented in makVrv::DtTritonDynamicOceanObject.

virtual double makVrv::DtDynamicOceanObject::windSpeed ( ) const

virtual

Set / Get the wind speed in meters per second.

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

virtual

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

Reimplemented in makVrv::DtTritonDynamicOceanObject.

virtual double makVrv::DtDynamicOceanObject::windDirection ( ) const

virtual

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

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

virtual

Set / Get the fetch length in meters.

Reimplemented in makVrv::DtTritonDynamicOceanObject.

virtual double makVrv::DtDynamicOceanObject::windFetch ( ) const

virtual

Set / Get the fetch length in meters.

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

virtual

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

Reimplemented in makVrv::DtTritonDynamicOceanObject.

virtual bool makVrv::DtDynamicOceanObject::windDrivenSeaState ( ) const

virtual

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

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

virtual

Set / Get sea state based on Douglas sea state parameters.

Reimplemented in makVrv::DtTritonDynamicOceanObject.

virtual void makVrv::DtDynamicOceanObject::getDouglasSeaState	(	DtDouglasSeaState::Scale &	seaState,
		double &	seaStateDirection,
		DtDouglasSwellState::Scale &	swellState,
		double &	swellStateDirection
	)		const

virtual

Set / Get sea state based on Douglas sea state parameters.

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

virtual

Set / Get the amount of chop on the sea as a normalized value.

Reimplemented in makVrv::DtTritonDynamicOceanObject.

virtual double makVrv::DtDynamicOceanObject::seaChoppiness ( ) const

virtual

Set / Get the amount of chop on the sea as a normalized value.

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

virtual

Set / Get underwater visibility enabled.

Reimplemented in makVrv::DtTritonDynamicOceanObject.

virtual bool makVrv::DtDynamicOceanObject::underwaterVisibilityEnabled ( ) const

virtual

Set / Get underwater visibility enabled.

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

virtual

Set / Get the maximum visibility under water in meters.

Reimplemented in makVrv::DtTritonDynamicOceanObject.

virtual double makVrv::DtDynamicOceanObject::underwaterVisibility ( ) const

virtual

Set / Get the maximum visibility under water in meters.

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

virtual

Set / Get the transparency of the water surface around coastlines as a normalized value.

Reimplemented in makVrv::DtTritonDynamicOceanObject.

virtual double makVrv::DtDynamicOceanObject::surfaceTransparency ( ) const

virtual

Set / Get the transparency of the water surface around coastlines as a normalized value.

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

virtual

Set / Get surge depth.

Reimplemented in makVrv::DtTritonDynamicOceanObject.

virtual double makVrv::DtDynamicOceanObject::surgeDepth ( ) const

virtual

Set / Get surge depth.

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

virtual

Set / Get surge depth offset.

Reimplemented in makVrv::DtTritonDynamicOceanObject.

virtual double makVrv::DtDynamicOceanObject::depthOffset ( ) const

virtual

Set / Get surge depth offset.

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

virtual

Manager ocean swells.

Reimplemented in makVrv::DtTritonDynamicOceanObject.

virtual void makVrv::DtDynamicOceanObject::addSwell ( const OceanSwell & swell )

virtual

Manager ocean swells.

virtual const OceanSwellList& makVrv::DtDynamicOceanObject::getSwells ( ) const

virtual

Get the list of swells.

virtual void makVrv::DtDynamicOceanObject::clearSwells ( )

virtual

Clear all swells.

Reimplemented in makVrv::DtTritonDynamicOceanObject.

virtual void makVrv::DtDynamicOceanObject::setWaterCurrentSpeed ( float speed )

virtual

Set / get the speed of water currents in meters per second.

virtual float makVrv::DtDynamicOceanObject::waterCurrentSpeed ( ) const

virtual

Set / get the speed of water currents in meters per second.

virtual void makVrv::DtDynamicOceanObject::setWaterCurrentDirection ( float direction )

virtual

Set / get the direction of water currents in radians from north (clockwise).

virtual float makVrv::DtDynamicOceanObject::waterCurrentDirection ( ) const

virtual

Set / get the direction of water currents in radians from north (clockwise).

virtual bool makVrv::DtDynamicOceanObject::LockHeightData ( )

virtual

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

Reimplemented in makVrv::DtTritonDynamicOceanObject.

virtual bool makVrv::DtDynamicOceanObject::UnLockHeightData ( )

virtual

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

Reimplemented in makVrv::DtTritonDynamicOceanObject.

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

virtual

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

Reimplemented in makVrv::DtTritonDynamicOceanObject.

Member Data Documentation

double makVrv::DtDynamicOceanObject::mySeaLevel

protected

int makVrv::DtDynamicOceanObject::myLodAltitude

protected

double makVrv::DtDynamicOceanObject::myWindSpeed

protected

double makVrv::DtDynamicOceanObject::myWindDirection

protected

double makVrv::DtDynamicOceanObject::myWindFetch

protected

bool makVrv::DtDynamicOceanObject::myWindDrivenSeaStateEnabled

protected

DtDouglasSeaState::Scale makVrv::DtDynamicOceanObject::myDouglasSeaState

protected

double makVrv::DtDynamicOceanObject::myDouglasSeaDirection

protected

DtDouglasSwellState::Scale makVrv::DtDynamicOceanObject::myDouglasSwellState

protected

double makVrv::DtDynamicOceanObject::myDouglasSwellDirection

protected

double makVrv::DtDynamicOceanObject::mySeaChoppiness

protected

double makVrv::DtDynamicOceanObject::myUnderwaterVisibility

protected

double makVrv::DtDynamicOceanObject::mySurfaceTransparency

protected

double makVrv::DtDynamicOceanObject::mySurgeDepth

protected

double makVrv::DtDynamicOceanObject::myDepthOffset

protected

float makVrv::DtDynamicOceanObject::myWaterCurrentSpeed

protected

float makVrv::DtDynamicOceanObject::myWaterCurrentDirection

protected

bool makVrv::DtDynamicOceanObject::myUnderwaterVisibilityEnabled

protected

OceanSwellList makVrv::DtDynamicOceanObject::myOceanSwells

protected

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

/data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-2-branch/include/vrvCore/DtDynamicOceanObject.h

Protected Attributes
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

Classes

Public Types

Public Member Functions

Protected Attributes

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation