makVrv::DtTerrainPatch Class Reference

A container for a single piece of terrain, containing settings needed to recreate it.

Inheritance diagram for makVrv::DtTerrainPatch:

Public Types
enum	GdbSurface {   AsphaltOrOtherHardSurface =0, Boulder =1, Building =2, CultivatedFields =3,   DeepBrook =4, DeepLake =5, DeepPond =6, DeepRiver =7,   DeepStream =8, DirtRoad =9, DryGround =10, EuroRailRoad =11,   Flimsy =12, Forest =13, Grass =14, GravelRoad =15,   Icy =16, IcyGround =17, Moon =18, Mud =19,   MuddyRoad =20, Ocean =21, Orchards =22, PavedRoad =23,   Rock =24, Sand =25, ShallowBrook =26, ShallowLake =27,   ShallowPond =28, ShallowRiver =29, ShallowStream =30, SnowGround =31,   SoftSoil =32, Swamp =33, Tree =34, USRailRoad =35,   UndefinedSoilType =36, Unspecified =37, UnspecifiedBodyOfWater =38, UnspecifiedCulturalFeature =39,   UnspecifiedEnvStateGround =40, WetGround =41 }
Public Types inherited from makVrv::DtTerrainLayer
typedef std::map< DtUniqueID, DtProp * >	PropMap
typedef boost::unordered_set < std::string >	PropNameSet

Public Member Functions
virtual	~DtTerrainPatch ()
DtDe &	de ()
const DtDe &	de () const
void	setIsMinimapOnly (bool onlyForMinimap)
bool	isMinimapOnly () const
DtOverlaySettings &	overlaySettings ()
const DtOverlaySettings &	overlaySettings () const
DtTerrainTreeSettings &	terrainTreeSettings ()
const DtTerrainTreeSettings &	terrainTreeSettings () const
const makArchives::DtTerrainPatchRecord::ExtractionOperations &	extractionOperations () const
const makArchives::DtTerrainPatchRecord::OceanExtractionOperations &	oceanExtractionOperations () const
void	extractNodesToTrees (std::string const &searchExp, bool isRegEx, std::string const &treeSpecies)
DtTerrainPatchRecord methods
virtual void	getRecord (makArchives::DtTerrainPatchRecord &rec) const
virtual void	setFromRecord (const makArchives::DtTerrainPatchRecord &rec)
Accessors
const std::string &	definition () const
DtUniqueID	uniqueID () const
DtTerrainPatchObjectAgent *	findObjectAgent ()
const DtTerrainPatchObjectAgent *	findObjectAgent () const
Surface visibility settings
void	setSurfaceVisible (int surfaceId, bool state)
bool	surfaceVisible (int surfaceId)
DtSurfacesSettings::SurfaceIdList const &	surfaceIds ()
void	loadSurfacesSettings ()
Prop management
virtual void	setExtractedNodeAsPropModel (DtProp *prop, bool setObjectPosition=false)
virtual int	countNodes (const std::string &rules) const
virtual void	extractNodes (const std::string &rule, bool isRegEx)
virtual void	moveNode (DtSceneObjectAgent *objectDriver, DtModelAgent *model, const std::string &rule, unsigned int index)
virtual void	addExtractNodeOperation (std::string const &searchExp, bool isRegEx, std::string const &propType, unsigned int count)
void	extractNodesToProps (const std::string &exp, bool isRegEx, const std::string &type, const std::string &modelDefinition)
void	extractNodesToSpeedTrees (const std::string &exp, bool isRegEx, const std::string &modelDefinition)
void	executeExtractionOperation (const makArchives::DtExtractionOperationRecord &extractionRec)
Static Ocean management
virtual void	requestOceanExtraction (const std::string &rule, bool isRegEx)
virtual void	extractOceanNodes (const std::string &rule, bool isRegEx)
virtual void	addOceanExtractNodeOperation (std::string const &searchExp, bool isRegEx)
virtual void	addOceanExtractNodeOperationIfExtracted (std::string const &searchExp, bool isRegEx)
void	executeOceanExtractionOperation (const makArchives::DtOceanExtractionOperationRecord &extractionRec)
virtual void	extractSpeedTreeNodes (const std::string &rule, const bool isRegEx, const std::string &stModelDefinition)
void	executeSpeedTreeExtractionOperation (const makArchives::DtSpeedTreeExtractionOperationRecord &extractionRec)
virtual void	addSpeedTreeExtractOperation (std::string const &searchExp, bool isRegEx, const std::string &modelDefinition)
Public Member Functions inherited from makVrv::DtTerrainLayer
	DtTerrainLayer (DtDe &de, DtAgentManagerInterface &sceneInterface)
virtual	~DtTerrainLayer ()
virtual void	addProp (DtProp *prop)
virtual bool	addPropFromRecord (const makArchives::DtPropRecord &record)
virtual DtProp *	findProp (DtUniqueID id)
virtual bool	destroyProp (DtUniqueID id)
const PropMap &	props () const
const PropNameSet &	propNames () const
void	selectionChanged (const DtSelectionManager::IdSet &selected, const DtSelectionManager::IdSet &de)

Protected Member Functions
	DtTerrainPatch (DtDe &de, DtAgentManagerInterface &sceneInterface, const std::string &terrainDefinition, bool minimapOnly=false)
void	onTerrainPatchObjectAvailable (DtUniqueID id)
void	executeExtractionOperations (const makArchives::DtTerrainPatchRecord::ExtractionOperations &ops)
void	executeOceanExtractionOperations (const makArchives::DtTerrainPatchRecord::OceanExtractionOperations &ops)
void	executeSpeedTreeExtractionOperations (const makArchives::DtTerrainPatchRecord::SpeedTreeExtractionOperations &ops)
void	createPropsFromRecord (const makArchives::DtPropSettingsRecord &propSettings)
void	getPropSettingsRecord (makArchives::DtPropSettingsRecord &record) const
void	setPatchObjectTerrainTreeData (DtTerrainPatchObject &tpo)
void	createPropsFromExtraction (DtTerrainPatchObject &tpo, makArchives::DtPropRecord *protoTypeRecord, const std::string &exp, bool isRegEx, const std::vector< std::string > &matches)
virtual void	slot_oceanNodesExtracted (DtTerrainPatchObject &tpo, bool extracted, std::string const &searchExp, bool isRegEx)

Protected Attributes
std::string	myDefinition
DtTerrainPatchObjectAgent *	myTerrainAgent
DtOverlaySettings	myOverlaySettings
DtSurfacesSettings	mySurfacesSettings
DtTerrainTreeSettings	myTerrainTreeSettings
makArchives::DtTerrainPatchRecord::ExtractionOperations	myExtractionHistory
makArchives::DtTerrainPatchRecord::OceanExtractionOperations	myOceanExtractionHistory
makArchives::DtTerrainPatchRecord::SpeedTreeExtractionOperations	mySpeedTreeExtrationHistory
bool	myIsMinimapOnly
Protected Attributes inherited from makVrv::DtTerrainLayer
DtDe &	myDe
DtAgentManagerInterface &	mySceneInterface

Private Member Functions
	DtTerrainPatch (const DtTerrainPatch &copy)
DtTerrainPatch &	operator= (const DtTerrainPatch &copy)

Friends
class	DtTerrainPatchCreator

Additional Inherited Members
Public Attributes inherited from makVrv::DtTerrainLayer
boost::signalslib::signal < void(const DtSelectionManager::IdSet &selected, const DtSelectionManager::IdSet &deselected)>	signal_currentSelectionChanged

Member Enumeration Documentation

enum makVrv::DtTerrainPatch::GdbSurface

GDB Surface IDs.

Enumerator
AsphaltOrOtherHardSurface
Boulder
Building
CultivatedFields
DeepBrook
DeepLake
DeepPond
DeepRiver
DeepStream
DirtRoad
DryGround
EuroRailRoad
Flimsy
Forest
Grass
GravelRoad
Icy
IcyGround
Moon
Mud
MuddyRoad
Ocean
Orchards
PavedRoad
Rock
Sand
ShallowBrook
ShallowLake
ShallowPond
ShallowRiver
ShallowStream
SnowGround
SoftSoil
Swamp
Tree
USRailRoad
UndefinedSoilType
Unspecified
UnspecifiedBodyOfWater
UnspecifiedCulturalFeature
UnspecifiedEnvStateGround
WetGround

Constructor & Destructor Documentation

virtual makVrv::DtTerrainPatch::~DtTerrainPatch ( )

virtual

DTOR.

makVrv::DtTerrainPatch::DtTerrainPatch ( const DtTerrainPatch &  copy )

private

makVrv::DtTerrainPatch::DtTerrainPatch ( DtDe &  de, DtAgentManagerInterface &  sceneInterface, const std::string &  terrainDefinition, bool  minimapOnly = false  )

protected

Protected CTOR, use DtTerrainPatchCreator to create an instance of this class.

Member Function Documentation

DtTerrainPatch& makVrv::DtTerrainPatch::operator= ( const DtTerrainPatch &  copy )

private

virtual void makVrv::DtTerrainPatch::getRecord ( makArchives::DtTerrainPatchRecord &  rec ) const

virtual

Fill out a DtTerrainRecord with the current terrain info.

virtual void makVrv::DtTerrainPatch::setFromRecord ( const makArchives::DtTerrainPatchRecord &  rec )

virtual

Populate a DtTerrainPatch from a DtTerrainPatchRecord.

const std::string& makVrv::DtTerrainPatch::definition

(

)

const

Get the definition.

DtUniqueID makVrv::DtTerrainPatch::uniqueID

(

)

const

Get the unique id of the terrain patch object (from the agent).

DtTerrainPatchObjectAgent* makVrv::DtTerrainPatch::findObjectAgent

(

)

Get the terrain patch object agent; note that this may return NULL if the patch did not create a patch object (which can happen if the patch is designated for the minimap modelset and that modelset isn't realized.

const DtTerrainPatchObjectAgent* makVrv::DtTerrainPatch::findObjectAgent

(

)

const

Get the definition.

DtDe& makVrv::DtTerrainPatch::de ( )

inline

Get the de.

const DtDe& makVrv::DtTerrainPatch::de ( ) const

inline

Get the de.

void makVrv::DtTerrainPatch::setIsMinimapOnly

(

bool

onlyForMinimap

)

set the flag that indicates that this patch should only appear in the minimap modelset

bool makVrv::DtTerrainPatch::isMinimapOnly

(

)

const

Is this patch only used by the minimap?

DtOverlaySettings& makVrv::DtTerrainPatch::overlaySettings

(

)

Get the overlay settings.

const DtOverlaySettings& makVrv::DtTerrainPatch::overlaySettings

(

)

const

Get the overlay settings.

DtTerrainTreeSettings& makVrv::DtTerrainPatch::terrainTreeSettings

(

)

Get the terrain tree settings.

const DtTerrainTreeSettings& makVrv::DtTerrainPatch::terrainTreeSettings

(

)

const

Get the terrain tree settings.

const makArchives::DtTerrainPatchRecord::ExtractionOperations& makVrv::DtTerrainPatch::extractionOperations

(

)

const

ExtractionOperations accessor.

const makArchives::DtTerrainPatchRecord::OceanExtractionOperations& makVrv::DtTerrainPatch::oceanExtractionOperations

(

)

const

OceanExtractionOperations accessor.

void makVrv::DtTerrainPatch::setSurfaceVisible	(	int	surfaceId,
		bool	state
	)

Set a surface's visibility.

bool makVrv::DtTerrainPatch::surfaceVisible

(

int

surfaceId

)

Check a surface's visibility.

DtSurfacesSettings::SurfaceIdList const& makVrv::DtTerrainPatch::surfaceIds

(

)

Get a list of all surface IDs for this terrain patch.

void makVrv::DtTerrainPatch::loadSurfacesSettings

(

)

Load the surfaces settings from a file.

virtual void makVrv::DtTerrainPatch::setExtractedNodeAsPropModel ( DtProp *  prop, bool  setObjectPosition = false  )

virtual

Make the prop's model be the extracted nodes via the prop's search expression and index.

Parameters

setObjectPosition

sets the position of the prop to the location of extracted nodes

virtual int makVrv::DtTerrainPatch::countNodes ( const std::string &  rules ) const

virtual

Count the number of nodes matching the rules.

virtual void makVrv::DtTerrainPatch::extractNodes ( const std::string &  rule, bool  isRegEx  )

virtual

Extract nodes from the terrain patch using a given rule.

virtual void makVrv::DtTerrainPatch::moveNode ( DtSceneObjectAgent *  objectDriver, DtModelAgent *  model, const std::string &  rule, unsigned int  index  )

virtual

Move a node located by the rule + index into a model and sets the location of the object to the location of the node.

virtual void makVrv::DtTerrainPatch::addExtractNodeOperation ( std::string const &  searchExp, bool  isRegEx, std::string const &  propType, unsigned int  count  )

virtual

Add a prop extraction rule.

void makVrv::DtTerrainPatch::extractNodesToProps	(	const std::string &	exp,
		bool	isRegEx,
		const std::string &	type,
		const std::string &	modelDefinition
	)

Wrapper around extractProps for the benefit of executeExtractionOperation.

void makVrv::DtTerrainPatch::extractNodesToSpeedTrees	(	const std::string &	exp,
		bool	isRegEx,
		const std::string &	modelDefinition
	)

Wrapper around extract external references as speed trees.

void makVrv::DtTerrainPatch::executeExtractionOperation

(

const makArchives::DtExtractionOperationRecord &

extractionRec

)

Execute a single extraction operation.

virtual void makVrv::DtTerrainPatch::requestOceanExtraction ( const std::string &  rule, bool  isRegEx  )

virtual

requestOceanExtraction() is called from the GUI. If any extraction actually happens, and extraction operation will be registered for saving out to file

virtual void makVrv::DtTerrainPatch::extractOceanNodes ( const std::string &  rule, bool  isRegEx  )

virtual

Extract ocean nodes from the terrain patch using a given rule.

virtual void makVrv::DtTerrainPatch::addOceanExtractNodeOperation ( std::string const &  searchExp, bool  isRegEx  )

virtual

Add a ocean extraction rule. This is used when loading a .mtf file to track existing extraction operations.

virtual void makVrv::DtTerrainPatch::addOceanExtractNodeOperationIfExtracted ( std::string const &  searchExp, bool  isRegEx  )

virtual

Conditionally add an ocean extraction rule. This is used by requestOceanExtraction(). It prevents operations that won't do anything from being added to the ocean extraction operation list.

void makVrv::DtTerrainPatch::executeOceanExtractionOperation

(

const makArchives::DtOceanExtractionOperationRecord &

extractionRec

)

Execute a single extraction operation.

virtual void makVrv::DtTerrainPatch::extractSpeedTreeNodes ( const std::string &  rule, const bool  isRegEx, const std::string &  stModelDefinition  )

virtual

Extract osg nodes from the terrain patch using a given rule and replace them by speed trees models.

void makVrv::DtTerrainPatch::executeSpeedTreeExtractionOperation

(

const makArchives::DtSpeedTreeExtractionOperationRecord &

extractionRec

)

Execute a single speed tree extraction operation.

virtual void makVrv::DtTerrainPatch::addSpeedTreeExtractOperation ( std::string const &  searchExp, bool  isRegEx, const std::string &  modelDefinition  )

virtual

Add a speed tree extraction operation to the historic records.

void makVrv::DtTerrainPatch::extractNodesToTrees	(	std::string const &	searchExp,
		bool	isRegEx,
		std::string const &	treeSpecies
	)

Extract all trees fitting searchExp on this terrain patch and replace them with treeSpecies (not currently used) this is use when trees models are extracted by props.

void makVrv::DtTerrainPatch::onTerrainPatchObjectAvailable ( DtUniqueID  id )

protected

Slot for signaling when a patch has an object.

void makVrv::DtTerrainPatch::executeExtractionOperations ( const makArchives::DtTerrainPatchRecord::ExtractionOperations &  ops )

protected

Execute all extraction operations.

Warning

This will delete ops.

void makVrv::DtTerrainPatch::executeOceanExtractionOperations ( const makArchives::DtTerrainPatchRecord::OceanExtractionOperations &  ops )

protected

Execute all ocean extraction operations.

Warning

This will delete ops.

void makVrv::DtTerrainPatch::executeSpeedTreeExtractionOperations ( const makArchives::DtTerrainPatchRecord::SpeedTreeExtractionOperations &  ops )

protected

Execute all speed tree extraction operations.

Warning

This will delete ops.

void makVrv::DtTerrainPatch::createPropsFromRecord ( const makArchives::DtPropSettingsRecord &  propSettings )

protected

Restore settings for extracted props.

void makVrv::DtTerrainPatch::getPropSettingsRecord ( makArchives::DtPropSettingsRecord &  record ) const

protected

Create a prop settings record from all props owned by this patch.

void makVrv::DtTerrainPatch::setPatchObjectTerrainTreeData ( DtTerrainPatchObject &  tpo )

protected

Set tree data (randomization) for this terrain patch object based on the DtTerrainPatch record.

void makVrv::DtTerrainPatch::createPropsFromExtraction ( DtTerrainPatchObject &  tpo, makArchives::DtPropRecord *  protoTypeRecord, const std::string &  exp, bool  isRegEx, const std::vector< std::string > &  matches  )

protected

Create props from an extraction. Expects the terrain patch object the props came from, a prototype prop record, the search expression, whether the search expression was a regexp, and the list of search expression matches.

virtual void makVrv::DtTerrainPatch::slot_oceanNodesExtracted ( DtTerrainPatchObject &  tpo, bool  extracted, std::string const &  searchExp, bool  isRegEx  )

protectedvirtual

This slot is connected to the terrain patch signaler's signal_oceanNodesExtracted when a request for ocean extraction is initiated. If the signal raised is true, an ocean extraction operation will be added to the extraction list.

Friends And Related Function Documentation

friend class DtTerrainPatchCreator

friend

Member Data Documentation

std::string makVrv::DtTerrainPatch::myDefinition

protected

DtTerrainPatchObjectAgent* makVrv::DtTerrainPatch::myTerrainAgent

protected

DtOverlaySettings makVrv::DtTerrainPatch::myOverlaySettings

protected

DtSurfacesSettings makVrv::DtTerrainPatch::mySurfacesSettings

protected

DtTerrainTreeSettings makVrv::DtTerrainPatch::myTerrainTreeSettings

protected

makArchives::DtTerrainPatchRecord::ExtractionOperations makVrv::DtTerrainPatch::myExtractionHistory

protected

makArchives::DtTerrainPatchRecord::OceanExtractionOperations makVrv::DtTerrainPatch::myOceanExtractionHistory

protected

makArchives::DtTerrainPatchRecord::SpeedTreeExtractionOperations makVrv::DtTerrainPatch::mySpeedTreeExtrationHistory

protected

bool makVrv::DtTerrainPatch::myIsMinimapOnly

protected

---

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

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