makVrv::DtOceanLayer Class Reference

The ocean layer is a type of terrain layer which contains information about an area that should be rendered as dynamic water. More...

Inheritance diagram for makVrv::DtOceanLayer:

Public Member Functions
	DtOceanLayer (DtDe &de, DtAgentManagerInterface &sceneInterface)
	CTOR.
	~DtOceanLayer ()
	DTOR.
virtual void	getRecord (makArchives::DtOceanLayerRecord &rec) const
	Fill out a DtFeatureLayerRecord with the current terrain info.
virtual void	setFromRecord (const makArchives::DtOceanLayerRecord &rec)
	Populate a DtFeatureLayer from a DtFeatureLayerRecord.
virtual const std::string &	name () const
	Get the name of the Ocean Layer.
virtual void	setName (const std::string &name)
	Set the name of the ocean layer.
virtual double	seaLevel () const
	Get the height of the ocean layer.
virtual void	setSeaLevel (double seaLevel)
	Set the height of the ocean layer.
virtual int	lodRange () const
	Get the altitude at which the Ocean LOD's out.
virtual void	setLodRange (int lodRange)
	Set the altitude at which the Ocean LOD's out.
Public Member Functions inherited from makVrv::DtTerrainLayer
	DtTerrainLayer (DtDe &de, DtAgentManagerInterface &sceneInterface)
	CTOR.
virtual	~DtTerrainLayer ()
	DTOR.
virtual void	addProp (DtProp *prop)
	Add prop based on the DtPropRecord.
virtual bool	addPropFromRecord (const makArchives::DtPropRecord &record)
	Add prop based on the DtPropRecord.
virtual DtProp *	findProp (DtUniqueID id)
	Finds a pointer to the prop on the feature layer with the same identifiers as the passed in prop.
virtual bool	destroyProp (DtUniqueID id)
	Destroys the prop with the unique name.
const PropMap &	props () const
	Get the container of props associated with the layer.
const PropNameSet &	propNames () const
	Get the set of prop names used in this layer.

Protected Attributes
std::string	myName
double	mySeaLevel
int	myLodRange
Protected Attributes inherited from makVrv::DtTerrainLayer
DtDe &	myDe
DtAgentManagerInterface &	mySceneInterface

Additional Inherited Members
Public Types inherited from makVrv::DtTerrainLayer
typedef std::map< DtUniqueID, DtProp * >	PropMap
	List of props.
typedef boost::unordered_set < std::string >	PropNameSet
	Set of prop names.

Detailed Description

The ocean layer is a type of terrain layer which contains information about an area that should be rendered as dynamic water.

Constructor & Destructor Documentation

makVrv::DtOceanLayer::DtOceanLayer	(	DtDe &	de,
		DtAgentManagerInterface &	sceneInterface
	)

CTOR.

makVrv::DtOceanLayer::~DtOceanLayer

(

)

DTOR.

Member Function Documentation

virtual void makVrv::DtOceanLayer::getRecord ( makArchives::DtOceanLayerRecord &  rec ) const

virtual

Fill out a DtFeatureLayerRecord with the current terrain info.

virtual void makVrv::DtOceanLayer::setFromRecord ( const makArchives::DtOceanLayerRecord &  rec )

virtual

Populate a DtFeatureLayer from a DtFeatureLayerRecord.

virtual const std::string& makVrv::DtOceanLayer::name ( ) const

virtual

Get the name of the Ocean Layer.

virtual void makVrv::DtOceanLayer::setName ( const std::string &  name )

virtual

Set the name of the ocean layer.

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

virtual

Get the height of the ocean layer.

virtual void makVrv::DtOceanLayer::setSeaLevel ( double  seaLevel )

virtual

Set the height of the ocean layer.

Raises DtTerrainSignaler::signal_oceanLayerSeaLevelChanged

virtual int makVrv::DtOceanLayer::lodRange ( ) const

virtual

Get the altitude at which the Ocean LOD's out.

virtual void makVrv::DtOceanLayer::setLodRange ( int  lodRange )

virtual

Set the altitude at which the Ocean LOD's out.

Raises DtTerrainSignaler::signal_oceanLayerLodRangeChanged

Member Data Documentation

std::string makVrv::DtOceanLayer::myName

protected

double makVrv::DtOceanLayer::mySeaLevel

protected

int makVrv::DtOceanLayer::myLodRange

protected

---

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

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