makVrv::DtTerrain Class Reference

DtTerrain is a facade around terrain functionality.

Inheritance diagram for makVrv::DtTerrain:

Public Types
typedef std::list < DtTerrainPatch * >	TerrainPatches
typedef std::list < DtFeatureLayer * >	FeatureLayers
typedef std::list< DtOceanLayer * >	OceanLayers
typedef std::map< int, makArchives::DtTerrainOperationRecord >	TerrainOperationsMap

Public Member Functions
	DtTerrain (DtDe &de, DtAgentManagerInterface &sceneManagerInterface)
virtual	~DtTerrain ()
void	clear (bool reload=false)
bool	isPropNameUsed (const std::string &propName) const
virtual bool	getTerrainIntersection (double x, double y, double z, double upX, double upY, double upZ, double &retX, double &retY, double &retZ)
virtual void	clearElevationCache ()
virtual const std::string *	findOptionalParameter (const std::string &name) const
virtual void	setOptionalParameter (const std::string &name, const std::string &value)
virtual void	setOptionalParameters (const makArchives::DtTerrainRecord::OptionalParameterMap &)
virtual void	removeOptionalParameter (const std::string &name)
const makArchives::DtTerrainRecord::OptionalParameterMap &	optionalParameters () const
virtual const std::string &	description ()
virtual void	setDescription (const std::string &description)
virtual bool	useICO () const
virtual void	setUseICO (bool flag)
virtual unsigned int	maxPagedLODs () const
virtual void	setMaxPagedLODs (unsigned int maxPagedLODs)
virtual bool	reloadingTerrain ()
Terrain record methods
bool	globalScaleTerrain () const
void	updateGlobalScaleTerrain ()
virtual void	getRecord (makArchives::DtTerrainRecord &rec)
virtual void	setFromRecord (const makArchives::DtTerrainRecord &rec, bool clearFirst=true)
virtual void	reloadTerrain ()
Terrain Patch methods
virtual DtTerrainPatch &	addTerrainPatch (const makArchives::DtTerrainPatchRecord &rec)
virtual DtTerrainPatch &	addTerrainPatch (const std::string &terrainDefinitionName, bool minimapOnly=false)
virtual DtTerrainPatch *	findTerrainPatch (const std::string &terrainDefinitionName)
virtual DtTerrainPatch *	findTerrainPatch (DtUniqueID id)
virtual bool	removeTerrainPatch (const std::string &terrainDefinitionName, bool minimapOnly=false)
const TerrainPatches &	terrainPatches () const
TerrainPatches &	terrainPatches ()
bool	lightPointsEnabled () const
Terrain Operation methods
virtual const TerrainOperationsMap &	terrainOperationsMap () const
Feature Layer methods
virtual DtFeatureLayer &	addFeatureLayer (const makArchives::DtFeatureLayerRecord &rec, makArchives::DtTerrainOperationRecord::TargetApplication target=makArchives::DtTerrainOperationRecord::VisualizationAndSimulation)
virtual DtFeatureLayer &	addFeatureLayer (const std::string &featureLayerFilename, makArchives::DtTerrainOperationRecord::TargetApplication target=makArchives::DtTerrainOperationRecord::VisualizationAndSimulation)
virtual void	removeFeatureLayer (const std::string &featureLayerFilename)
virtual const FeatureLayers &	featureLayers () const
virtual FeatureLayers &	featureLayers ()
virtual DtFeatureLayer *	findFeatureLayer (const std::string &featureLayerFilename)
virtual DtStreamedFeatureLayer &	streamedFeatureLayer ()
virtual DtBuoyBeaconLayer &	buoyBeaconLayer ()
virtual DtDynamicFeatureLayer &	dynamicFeatureLayer ()
virtual DtNavigationLightManager &	navigationLightManager ()
virtual DtNavigationFeatureManager &	navigationDaymarkManager ()
virtual DtNavigationFeatureManager &	navigationTopmarkManager ()
Ocean Layer methods
virtual DtOceanLayer &	addOceanLayer (const makArchives::DtOceanLayerRecord &rec)
virtual DtOceanLayer &	addOceanLayer (const std::string &layerName)
virtual void	removeOceanLayer (const std::string &layerName)
virtual const OceanLayers &	oceanLayers () const
virtual OceanLayers &	oceanLayers ()
virtual DtOceanLayer *	findOceanLayer (const std::string &layerName)
virtual void	onOceanNodesExtracted (DtTerrainPatchObject &patchObject)
Prop methods
std::string	generatePropName (const std::string &propType)
Forest methods
virtual DtForest &	forest ()
Export methods
virtual bool	exportTerrainAndProps (const std::string &)

Protected Types
typedef std::map< std::string, int >	PropNameMap

Protected Member Functions
void	executeTerrainOperation (const makArchives::DtTerrainOperationRecord &operation, const makArchives::DtTerrainRecord &terrainRec)
void	addTerrainOperationRecord (const makArchives::DtTerrainOperationRecord &operation)
void	removeTerrainOperationRecord (const makArchives::DtTerrainOperationRecord &operation)
void	removeTerrainOperationRecord (int id)
void	clearTerrainOperations ()
void	slot_handleIsDayChanged (bool isDay)
virtual bool	checkIfTerrainOperationRecordsMatch (const makArchives::DtTerrainOperationRecord &left, const makArchives::DtTerrainOperationRecord &right)
virtual void	connectForestAndOceanSignals (void)

Protected Attributes
DtDe &	myDe
DtTerrainSignaler &	mySignaler
DtAgentManagerInterface &	myAgentManagerInterface
TerrainPatches	myTerrainPatches
FeatureLayers	myFeatureLayers
OceanLayers	myOceanLayers
DtForest *	myForest
DtBuoyBeaconLayer *	myBuoyLayer
DtStreamedFeatureLayer *	myStreamedFeatureLayer
DtDynamicFeatureLayer *	myDynamicFeatureLayer
DtNavigationLightManager *	myNavigationLightManager
DtNavigationFeatureManager *	myNavigationDaymarkManager
DtNavigationFeatureManager *	myNavigationTopmarkManager
TerrainOperationsMap	myTerrainOperationsMap
int	myNextTerrainOperationId
bool	myGlobalScaleFlag
PropNameMap	myPropNameMap
makArchives::DtTerrainRecord::OptionalParameterMap	myOptionalParameters
makArchives::DtTerrainRecord::GenericRecords	myGenericRecords
std::string	myDescription
bool	myUseICO
unsigned int	myMaxPagedLODs
bool	myReloadingTerrain
DtTexturedQuad *	myLogo

Additional Inherited Members
Private Types inherited from makVrv::DtSignalConnectionManager
typedef std::vector < boost::signalslib::connection >	Connections
Private Member Functions inherited from makVrv::DtSignalConnectionManager
	DtSignalConnectionManager ()
virtual	~DtSignalConnectionManager ()
void	manageConnection (const boost::signalslib::connection &conn)
DtSignalConnectionManager &	operator+= (const boost::signalslib::connection &conn)
bool	blockConnections (bool blocked)
int	numberOfConnections () const
void	disconnectSignals ()
bool	connectionsBlocked () const
Private Attributes inherited from makVrv::DtSignalConnectionManager
Connections	myConnections
bool	myConnectionsBlocked
bool	myIndiviualConnectionedBlocked
std::vector < boost::signalslib::shared_connection_block * >	mySharedConnectionsBlockManager

Member Typedef Documentation

typedef std::list<DtTerrainPatch*> makVrv::DtTerrain::TerrainPatches

typedef std::list<DtFeatureLayer*> makVrv::DtTerrain::FeatureLayers

typedef std::list<DtOceanLayer*> makVrv::DtTerrain::OceanLayers

typedef std::map<int, makArchives::DtTerrainOperationRecord> makVrv::DtTerrain::TerrainOperationsMap

Map of terrain operation ids, to terrain operations.

typedef std::map<std::string,int> makVrv::DtTerrain::PropNameMap

protected

Constructor & Destructor Documentation

makVrv::DtTerrain::DtTerrain	(	DtDe &	de,
		DtAgentManagerInterface &	sceneManagerInterface
	)

CTOR.

virtual makVrv::DtTerrain::~DtTerrain ( )

virtual

DTOR.

Member Function Documentation

void makVrv::DtTerrain::clear

(

bool

reload = false

)

Clear the terrain. If the terrain is being cleared because a reloadTerrain operation was requested, the reload flag will be set to true.

bool makVrv::DtTerrain::globalScaleTerrain

(

)

const

Checks to see if the terrain is a global scale terrain. Typically a global scale terrain takes a [nearly] complete representation of the globe.

void makVrv::DtTerrain::updateGlobalScaleTerrain

(

)

Rechecks if the terrain is of global scale. This function will emit the global scale changed signal from the signaler object if the scale changes.

virtual void makVrv::DtTerrain::getRecord ( makArchives::DtTerrainRecord &  rec )

virtual

Fill out a DtTerrainRecord with the current terrain info. Called by saveTerrain().

Reimplemented in makVrf::DtVrfTerrain.

virtual void makVrv::DtTerrain::setFromRecord ( const makArchives::DtTerrainRecord &  rec, bool  clearFirst = true  )

virtual

Populate a DtTerrain from a DtTerrainRecord. Called by loadTerrain(). If the clearFirst flag is true, DtTerrain::clear() will be called before populating the new terrain.

Reimplemented in makVrf::DtVrfTerrain.

virtual void makVrv::DtTerrain::reloadTerrain ( )

virtual

Request that the current terrain be reloaded.

virtual DtTerrainPatch& makVrv::DtTerrain::addTerrainPatch ( const makArchives::DtTerrainPatchRecord &  rec )

virtual

Create and add a new terrain patch driver. If a terrain patch already exists with the same name, it is deleted. Do not delete this terrain patch via the returned pointer. Instead, use deleteTerrainPatch().

virtual DtTerrainPatch& makVrv::DtTerrain::addTerrainPatch ( const std::string &  terrainDefinitionName, bool  minimapOnly = false  )

virtual

Create and add a new terrain patch driver. If a terrain patch already exists with the same name, it is deleted, unless minimapOnly is true (we allow the minimap to show the same patch in the main view). If minimapOnly is true and the minimap model set is not realized, the patch itself is still created (so we don't lose it on a subsequent save) but the terrain patch will not create a DtTerrainPatchObject and nothing is loaded/rendered for the patch. Do not delete this terrain patch via the returned pointer. Instead, use deleteTerrainPatch().

virtual DtTerrainPatch* makVrv::DtTerrain::findTerrainPatch ( const std::string &  terrainDefinitionName )

virtual

Return the DtTerrainPatchObjectAgent with the name terrainName.

virtual DtTerrainPatch* makVrv::DtTerrain::findTerrainPatch ( DtUniqueID  id )

virtual

Return the DtTerrainPatchObjectAgent with the unique id.

virtual bool makVrv::DtTerrain::removeTerrainPatch ( const std::string &  terrainDefinitionName, bool  minimapOnly = false  )

virtual

Find and delete a terrain.

Returns

Whether the terrain was found and deleted.

Parameters

terrainDefinitionName	The definition name of the terrain patch to be removed
minimapOnly	Whether the terrain patch being removed is only part of the minimap

const TerrainPatches& makVrv::DtTerrain::terrainPatches

(

)

const

Get the terrain drivers. Do not add or remove terrains while iterating.

TerrainPatches& makVrv::DtTerrain::terrainPatches

(

)

Get the terrain drivers. Do not add or remove terrains while iterating.

bool makVrv::DtTerrain::lightPointsEnabled

(

)

const

Are we showing point lights on the terrain?

virtual const TerrainOperationsMap& makVrv::DtTerrain::terrainOperationsMap ( ) const

virtual

virtual DtFeatureLayer& makVrv::DtTerrain::addFeatureLayer ( const makArchives::DtFeatureLayerRecord &  rec, makArchives::DtTerrainOperationRecord::TargetApplication  target = makArchives::DtTerrainOperationRecord::VisualizationAndSimulation  )

virtual

Add a feature layer. Calls addFeatureLayer with a given name. It then initializes the feature layer using the provided record.

virtual DtFeatureLayer& makVrv::DtTerrain::addFeatureLayer ( const std::string &  featureLayerFilename, makArchives::DtTerrainOperationRecord::TargetApplication  target = makArchives::DtTerrainOperationRecord::VisualizationAndSimulation  )

virtual

Create and add a DtFeatureLayer. If a DtFeatureLayer already exists with the same name, it is deleted. Do not delete this DtFeatureLayer via the returned pointer. Instead, use removeFeatureLayer().

Reimplemented in DtVrfTerrain.

virtual void makVrv::DtTerrain::removeFeatureLayer ( const std::string &  featureLayerFilename )

virtual

Remove a feature layer. Emits signal_terrainPatchToBeDeleted.

virtual const FeatureLayers& makVrv::DtTerrain::featureLayers ( ) const

virtual

Accessor for FeatureLayers.

virtual FeatureLayers& makVrv::DtTerrain::featureLayers ( )

virtual

Accessor for FeatureLayers.

virtual DtFeatureLayer* makVrv::DtTerrain::findFeatureLayer ( const std::string &  featureLayerFilename )

virtual

Return the DtFeatureLayer with the name featureLayerFilename.

virtual DtStreamedFeatureLayer& makVrv::DtTerrain::streamedFeatureLayer ( )

virtual

return the streamed feature layer

contains features streamed in and represented by 3d facades

virtual DtBuoyBeaconLayer& makVrv::DtTerrain::buoyBeaconLayer ( )

virtual

Return the buoy layer.

virtual DtDynamicFeatureLayer& makVrv::DtTerrain::dynamicFeatureLayer ( )

virtual

Return the dynamic feature layer. The dynamic feature layer contains entities which utilize .meta files for configuring and updating specific nodes in a model based on node annotations or node names.

virtual DtNavigationLightManager& makVrv::DtTerrain::navigationLightManager ( )

virtual

Return the nav light manager.

virtual DtNavigationFeatureManager& makVrv::DtTerrain::navigationDaymarkManager ( )

virtual

Return the nav daymark manager.

virtual DtNavigationFeatureManager& makVrv::DtTerrain::navigationTopmarkManager ( )

virtual

Return the nav topmark manager.

virtual DtOceanLayer& makVrv::DtTerrain::addOceanLayer ( const makArchives::DtOceanLayerRecord &  rec )

virtual

Add an ocean layer. Calls addOceanLayer with a given name. It then initializes the ocean layer using the provided record.

virtual DtOceanLayer& makVrv::DtTerrain::addOceanLayer ( const std::string &  layerName )

virtual

Create and add a DtOceanLayer. If a DtOceanLayer already exists with the same name, it is deleted. Do not delete this DtOceanLayer via the returned pointer. Instead, use removeOceanLayer().

virtual void makVrv::DtTerrain::removeOceanLayer ( const std::string &  layerName )

virtual

Remove a ocean layer. Emits signal_oceanLayerToBeDeleted.

virtual const OceanLayers& makVrv::DtTerrain::oceanLayers ( ) const

virtual

Accessor for OceanLayers.

virtual OceanLayers& makVrv::DtTerrain::oceanLayers ( )

virtual

Accessor for OceanLayers.

virtual DtOceanLayer* makVrv::DtTerrain::findOceanLayer ( const std::string &  layerName )

virtual

Return the DtOceanLayer with the name layerName.

virtual void makVrv::DtTerrain::onOceanNodesExtracted ( DtTerrainPatchObject &  patchObject )

virtual

Slot called when ocean nodes are extracted. If there aren't any ocean layers, DtTerrain will create one when this is called.

std::string makVrv::DtTerrain::generatePropName

(

const std::string &

propType

)

Generate a unique name for the prop.

virtual DtForest& makVrv::DtTerrain::forest ( )

virtual

Return the DtForestObjectDriver. This lazily creates one if it does not exist. There only needs to be one DtForestObjectDriver for the whole scene.

bool makVrv::DtTerrain::isPropNameUsed

(

const std::string &

propName

)

const

Checks whether a prop name is in use.

virtual bool makVrv::DtTerrain::getTerrainIntersection ( double  x, double  y, double  z, double  upX, double  upY, double  upZ, double &  retX, double &  retY, double &  retZ  )

virtual

Get the closest intersection to x,y,z. Note that the up values may not be used in the case of osgEarth patches (it will use the normal to the surface at x,y,z).

virtual void makVrv::DtTerrain::clearElevationCache ( )

virtual

If any of the terrain's patch objects is using an elevation cache, clear them (otherwise do nothing). Use after making a large number of successive calls, such as while extracting props from a shape file.

virtual bool makVrv::DtTerrain::exportTerrainAndProps ( const std::string &  )

virtual

Saves terrain geometry and props to specified file. This file will be saved in the format specified by the file extension. Currently only the .gdb extension is supported.

virtual const std::string* makVrv::DtTerrain::findOptionalParameter ( const std::string &  name ) const

virtual

Find an optional parameter. These optional parameters are provided because VR-Vantage and VR-Forces want to be able to share terrain files, and this makes whole process simpler.

virtual void makVrv::DtTerrain::setOptionalParameter ( const std::string &  name, const std::string &  value  )

virtual

Set an optional parameter.

virtual void makVrv::DtTerrain::setOptionalParameters ( const makArchives::DtTerrainRecord::OptionalParameterMap &  )

virtual

Set an optional parameters. This will overwrite any existing optional parameters.

virtual void makVrv::DtTerrain::removeOptionalParameter ( const std::string &  name )

virtual

Remove an optional parameter.

const makArchives::DtTerrainRecord::OptionalParameterMap& makVrv::DtTerrain::optionalParameters

(

)

const

Get the optional parameters.

virtual const std::string& makVrv::DtTerrain::description ( )

virtual

Get the terrains's description.

virtual void makVrv::DtTerrain::setDescription ( const std::string &  description )

virtual

Set the terrains's description.

virtual bool makVrv::DtTerrain::useICO ( ) const

virtual

Get the UseICO flag.

virtual void makVrv::DtTerrain::setUseICO ( bool  flag )

virtual

Set the UseICO flag.

virtual unsigned int makVrv::DtTerrain::maxPagedLODs ( ) const

virtual

Get max paged LOD target.

virtual void makVrv::DtTerrain::setMaxPagedLODs ( unsigned int  maxPagedLODs )

virtual

Set the max paged LOD target.

virtual bool makVrv::DtTerrain::reloadingTerrain ( )

inlinevirtual

is the terrain currently reloading

void makVrv::DtTerrain::executeTerrainOperation ( const makArchives::DtTerrainOperationRecord &  operation, const makArchives::DtTerrainRecord &  terrainRec  )

protected

Execute a terrain operation. For example, adding a terrain patch.

void makVrv::DtTerrain::addTerrainOperationRecord ( const makArchives::DtTerrainOperationRecord &  operation )

protected

Add a terrain operations record and emit signal_terrainOperationAdded.

void makVrv::DtTerrain::removeTerrainOperationRecord ( const makArchives::DtTerrainOperationRecord &  operation )

protected

Remove a previously added record.

void makVrv::DtTerrain::removeTerrainOperationRecord ( int  id )

protected

Removed a terrain operations record and emit signal_terrainOperationAdded.

void makVrv::DtTerrain::clearTerrainOperations ( )

protected

Remove all terrain operations from myTerrainOperationsMap emitting signals.

void makVrv::DtTerrain::slot_handleIsDayChanged ( bool  isDay )

protected

Turn on and off the lights when the sky object says to.

virtual bool makVrv::DtTerrain::checkIfTerrainOperationRecordsMatch ( const makArchives::DtTerrainOperationRecord &  left, const makArchives::DtTerrainOperationRecord &  right  )

protectedvirtual

Check if two DtTerrainOperationRecord match without comparing the application type field.

virtual void makVrv::DtTerrain::connectForestAndOceanSignals ( void  )

protectedvirtual

Member Data Documentation

DtDe& makVrv::DtTerrain::myDe

protected

DtTerrainSignaler& makVrv::DtTerrain::mySignaler

protected

DtAgentManagerInterface& makVrv::DtTerrain::myAgentManagerInterface

protected

TerrainPatches makVrv::DtTerrain::myTerrainPatches

protected

FeatureLayers makVrv::DtTerrain::myFeatureLayers

protected

OceanLayers makVrv::DtTerrain::myOceanLayers

protected

DtForest* makVrv::DtTerrain::myForest

protected

DtBuoyBeaconLayer* makVrv::DtTerrain::myBuoyLayer

protected

DtStreamedFeatureLayer* makVrv::DtTerrain::myStreamedFeatureLayer

protected

DtDynamicFeatureLayer* makVrv::DtTerrain::myDynamicFeatureLayer

protected

DtNavigationLightManager* makVrv::DtTerrain::myNavigationLightManager

protected

DtNavigationFeatureManager* makVrv::DtTerrain::myNavigationDaymarkManager

protected

DtNavigationFeatureManager* makVrv::DtTerrain::myNavigationTopmarkManager

protected

TerrainOperationsMap makVrv::DtTerrain::myTerrainOperationsMap

protected

int makVrv::DtTerrain::myNextTerrainOperationId

protected

bool makVrv::DtTerrain::myGlobalScaleFlag

protected

PropNameMap makVrv::DtTerrain::myPropNameMap

protected

makArchives::DtTerrainRecord::OptionalParameterMap makVrv::DtTerrain::myOptionalParameters

protected

makArchives::DtTerrainRecord::GenericRecords makVrv::DtTerrain::myGenericRecords

protected

std::string makVrv::DtTerrain::myDescription

protected

bool makVrv::DtTerrain::myUseICO

protected

unsigned int makVrv::DtTerrain::myMaxPagedLODs

protected

bool makVrv::DtTerrain::myReloadingTerrain

protected

DtTexturedQuad* makVrv::DtTerrain::myLogo

protected

---

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

• /data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-0-branch/include/vrvCore/DtTerrain.h