makVrv::DtTritonBreakingWavesMapManager Class Reference

A class to manage automatic periodic updating of a breaking wave direction map generated from shapefiles. More...

Public Member Functions
virtual	~DtTritonBreakingWavesMapManager ()
	Destructor. More...
void	setupBreakingWavesMap (void)
	Sets up the breaking waves map's resources. More...
void	setBreakingWavesMapResolution (float resolution)
	Set the breaking waves map resolution in meters per texel. More...
float	getBreakingWavesMapResolution () const
	Gets the meters represented by one texel of the breaking waves map. More...
bool	updateBreakingWaves (unsigned int frameNum, const osg::Vec3 &currentPosition, bool isGeocentric)
	Updates the breaking waves map as needed; call once per frame. More...
const osg::Matrix &	breakingWavesMapMatrix ()
	Retrieve the matrix to transform world coordinate to texture coords. More...
const osg::Texture2D *	breakingWavesMapTexture ()
	Retrieve the breaking waves map itself Raw pointer since it is held in a ref pointer in this class. More...
bool	hasBreakingWavesMap () const
	Whether a breaking wave map has been generated. More...
void	forceUpdate ()
	Force a breaking waves map update on the next frame. More...

Protected Member Functions
	DtTritonBreakingWavesMapManager (DtTritonDrawable *parentDrawable, makVrv::DtDe &de)
	Constructor. More...
void	cleanup ()
	called by the destructor to clean up the osg ref pointers used by this class More...

Protected Attributes
osg::Vec3	myLastBreakingWavesUpdatePos
bool	myForceUpdate
float	myResolution
double	myLastUpdateTime
bool	myHasBreakingWaves
osg::ref_ptr< osg::Texture2D >	myBreakingWavesMap
osg::ref_ptr< osg::Image >	myBreakingWavesImage
osg::Matrix	myBreakingWavesMapMatrix
int	myBreakingWavesMapDimension
makVrv::DtDe &	myDe
DtTritonDrawable *	myDrawable
DtSignalConnectionManager	myConnections

Private Member Functions
	DtTritonBreakingWavesMapManager ()
	Default Constructor not implemented. More...
	DtTritonBreakingWavesMapManager (const DtTritonBreakingWavesMapManager &other)
	Copy Constructor not implemented – Copy Not Allowed. More...
DtTritonBreakingWavesMapManager &	operator= (const DtTritonBreakingWavesMapManager &other)
	Assignment Operator Not implemented – Assignment Not Allowed. More...

Friends
class	DtTritonBreakingWavesMapManagerCreator
	friend class for creating this class More...

Detailed Description

A class to manage automatic periodic updating of a breaking wave direction map generated from shapefiles.

Constructor & Destructor Documentation

virtual makVrv::DtTritonBreakingWavesMapManager::~DtTritonBreakingWavesMapManager ( )

virtual

Destructor.

makVrv::DtTritonBreakingWavesMapManager::DtTritonBreakingWavesMapManager ( DtTritonDrawable *  parentDrawable, makVrv::DtDe &  de  )

protected

Constructor.

makVrv::DtTritonBreakingWavesMapManager::DtTritonBreakingWavesMapManager ( )

private

Default Constructor not implemented.

makVrv::DtTritonBreakingWavesMapManager::DtTritonBreakingWavesMapManager ( const DtTritonBreakingWavesMapManager &  other )

private

Copy Constructor not implemented – Copy Not Allowed.

Member Function Documentation

DtTritonBreakingWavesMapManager& makVrv::DtTritonBreakingWavesMapManager::operator= ( const DtTritonBreakingWavesMapManager &  other )

private

Assignment Operator Not implemented – Assignment Not Allowed.

void makVrv::DtTritonBreakingWavesMapManager::setupBreakingWavesMap

(

void

)

Sets up the breaking waves map's resources.

void makVrv::DtTritonBreakingWavesMapManager::setBreakingWavesMapResolution

(

float

resolution

)

Set the breaking waves map resolution in meters per texel.

float makVrv::DtTritonBreakingWavesMapManager::getBreakingWavesMapResolution

(

)

const

Gets the meters represented by one texel of the breaking waves map.

bool makVrv::DtTritonBreakingWavesMapManager::updateBreakingWaves	(	unsigned int	frameNum,
		const osg::Vec3 &	currentPosition,
		bool	isGeocentric
	)

Updates the breaking waves map as needed; call once per frame.

Returns true if there is a new breaking waves map ready.

const osg::Matrix& makVrv::DtTritonBreakingWavesMapManager::breakingWavesMapMatrix

(

)

Retrieve the matrix to transform world coordinate to texture coords.

const osg::Texture2D* makVrv::DtTritonBreakingWavesMapManager::breakingWavesMapTexture

(

)

Retrieve the breaking waves map itself Raw pointer since it is held in a ref pointer in this class.

bool makVrv::DtTritonBreakingWavesMapManager::hasBreakingWavesMap

(

)

const

Whether a breaking wave map has been generated.

void makVrv::DtTritonBreakingWavesMapManager::forceUpdate

(

)

Force a breaking waves map update on the next frame.

void makVrv::DtTritonBreakingWavesMapManager::cleanup ( )

protected

called by the destructor to clean up the osg ref pointers used by this class

Friends And Related Function Documentation

friend class DtTritonBreakingWavesMapManagerCreator

friend

friend class for creating this class

Member Data Documentation

osg::Vec3 makVrv::DtTritonBreakingWavesMapManager::myLastBreakingWavesUpdatePos

protected

bool makVrv::DtTritonBreakingWavesMapManager::myForceUpdate

protected

float makVrv::DtTritonBreakingWavesMapManager::myResolution

protected

double makVrv::DtTritonBreakingWavesMapManager::myLastUpdateTime

protected

bool makVrv::DtTritonBreakingWavesMapManager::myHasBreakingWaves

protected

osg::ref_ptr<osg::Texture2D> makVrv::DtTritonBreakingWavesMapManager::myBreakingWavesMap

protected

osg::ref_ptr<osg::Image> makVrv::DtTritonBreakingWavesMapManager::myBreakingWavesImage

protected

osg::Matrix makVrv::DtTritonBreakingWavesMapManager::myBreakingWavesMapMatrix

protected

int makVrv::DtTritonBreakingWavesMapManager::myBreakingWavesMapDimension

protected

makVrv::DtDe& makVrv::DtTritonBreakingWavesMapManager::myDe

protected

DtTritonDrawable* makVrv::DtTritonBreakingWavesMapManager::myDrawable

protected

DtSignalConnectionManager makVrv::DtTritonBreakingWavesMapManager::myConnections

protected

---

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

• /data/exports/nrhent7-1/nightly/docs/vrForces.vrf4-8-branch/include/vrvTriton/DtTritonBreakingWavesMapManager.h