The base dynamic ocean object. More...

Inheritance diagram for makVrv::DtDynamicOceanObject:

Classes
class	OceanSwell
	A description of a single type of ocean swell. More...

Public Types
typedef std::list< OceanSwell >	OceanSwellList

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

virtual void	setSeaLevel (double meters)
	Set / Get the sea level, in meters.
virtual double	seaLevel () const

virtual void	setLodAltitude (int meters)
	Set / Get the altitude above which dynamic ocean will LOD out.
virtual int	lodAltitude () const

virtual void	setWindSpeed (double metersPerSecond)
	Set / Get the wind speed in meters per second.
virtual double	windSpeed () const

virtual void	setWindDirection (double radiansClockwiseFromNorth)
	Set / Get the wind direction in radians from north (clockwise).
virtual double	windDirection () const

virtual void	setWindFetch (double meters)
	Set / Get the fetch length in meters.
virtual double	windFetch () const

virtual void	setWindDrivenSeaState (bool enabled)
	Set / Get sea state is wind-driven or driven by Douglas Scale.
virtual bool	windDrivenSeaState () const

virtual void	setDouglasSeaState (int seaState, double seaStateDirection, int swellState, double swellStateDirection)
	Set / Get sea state based on Douglas sea state parameters.
virtual void	getDouglasSeaState (int &seaState, double &seaStateDirection, int &swellState, double &swellStateDirection) const

virtual void	setSeaChoppiness (double chop)
	Set / Get the amount of chop on the sea as a normalized value.
virtual double	seaChoppiness () const

virtual void	setUnderwaterVisibilityEnabled (bool enabled)
virtual bool	underwaterVisibilityEnabled () const

virtual void	setUnderwaterVisibility (double meters)
	Set / Get the maximum visibility under water in meters.
virtual double	underwaterVisibility () const

virtual void	setSurfaceTransparency (double transparency)
	Set / Get the transparency of the water surface around coastlines as a normalized value.
virtual double	surfaceTransparency () const

virtual void	setSurgeDepth (double meters)
	Set / Get surge depth.
virtual double	surgeDepth () const

virtual void	setDepthOffset (double meters)
	Set / Get surge depth offset.
virtual double	depthOffset () const

virtual void	addSwell (double lengthInMeters, double heightInMeters, double radiansClockwiseFromNorth)
	Manager ocean swells.
virtual void	addSwell (const OceanSwell &swell)
virtual const OceanSwellList &	getSwells () const
	Get the list of swells.
virtual void	clearSwells ()
	Clear all 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

Detailed Description

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.

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

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

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

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

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

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

virtual void makVrv::DtDynamicOceanObject::setDouglasSeaState	(	int	seaState,
		double	seaStateDirection,
		int	swellState,
		double	swellStateDirection
	)

virtual

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

Reimplemented in makVrv::DtTritonDynamicOceanObject.

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

virtual

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

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

virtual

Set / Get underwater visibility enabled.

Reimplemented in makVrv::DtTritonDynamicOceanObject.

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

virtual

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

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

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

virtual

Set / Get surge depth.

Reimplemented in makVrv::DtTritonDynamicOceanObject.

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

virtual

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

virtual

Set / Get surge depth offset.

Reimplemented in makVrv::DtTritonDynamicOceanObject.

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

virtual

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

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

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

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

int makVrv::DtDynamicOceanObject::myDouglasSeaState

protected

double makVrv::DtDynamicOceanObject::myDouglasSeaDirection

protected

int 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:

/exports/nfedora7-1/nightly/docs/vrforcesDevelopment.tot/include/vrvCore/DtDynamicOceanObject.h

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

Classes

Public Types

Public Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation