makVrv::DtTerrainEditorInterface Class Reference

DtTerrainEditorInterface. More...

Inheritance diagram for makVrv::DtTerrainEditorInterface:

Classes
class	TerrainContentItemKey
	TerrainContentItemKey. More...

Public Types
enum	TerrainContentItemType {   Terrain, ImageLayerGroup, ElevationLayerGroup, ModelLayerGroup,   MaskLayerGroup, BuildingLayerGroup, LandCoverLayerGroup, GroundCoverLayerGroup,   RoadSurfaceLayerGroup, SplatLayerGroup, TerrainPatchGroup, OceanLayerGroup,   FeatureSourceGroup, FeatureLayerGroup, AerodromeLayerGroup, OsgEarthFeatureLayerGroup,   OsgEarthTerrainPatch, OpenFlightTerrainPatch, FeatureSource, FeatureLayer,   AerodromeLayer, OsgEarthFeatureLayer, OceanLayer, ImageLayer,   ElevationLayer, ModelLayer, MaskLayer, BuildingLayer,   LandCoverLayer, GroundCoverLayer, GroundCover, RoadSurfaceLayer,   SplatLayer, TreeWidget, CompositeImageLayer, CompositeElevationLayer,   CompositeParentLayer, CompositeChildLayer, UnknownType }

Public Member Functions
virtual void	addTerrainContentTopLevelItem (const TerrainContentItemKey &key, const std::string &displayName)=0
	Adds a top level terrain content item(no parent) to the terrain content tree widget. More...
virtual void	addTerrainContentItem (const TerrainContentItemKey &key, const TerrainContentItemKey &parentKey, const std::string &displayName, int index=-1, bool editable=false, bool checked=true)=0
	Adds a terrain content item to the terrain content tree widget. More...
virtual void	addOsgEarthFragmentContentTopLevelItem (const std::string &key, const std::string &displayName)=0
	Adds a top level osgEarth fragment(no parent) item to the osgEarth fragment tree widget. More...
virtual void	addOsgEarthFragmentContentItem (const std::string &key, const std::string &parentKey, const std::string &displayName)=0
	Adds an osgEarth fragment item to the osgEarth fragment tree widget. More...
virtual void	clearTreeWidgets ()=0
	Cleans the contents of all tree widgets. More...
virtual void	setFocusOnTerrainContentTreeWidgetItem (const TerrainContentItemKey &key, bool expanded=true)=0
	Sets focus on the terrain content tree widget item. More...
virtual void	removeTerrainContentTreeWidgetItem (const TerrainContentItemKey &key)=0
	Removes the terrain content tree widget item. More...
virtual bool	hasTerrainContentTreeWidgetItem (const TerrainContentItemKey &key)=0
	Check if the terrain content tree widget has the item specifiged with the key. More...
virtual bool	hasTerrainPropertyTreeWidgetItem (const TerrainContentItemKey &key)=0
	Check if the terrain property tree widget has the item specifiged with the key. More...
virtual void	cleanOsgEarthFragmentTreeWidget ()=0
	Clean the contents of osgEarth fragment tree. More...
virtual void	setSelectedOsgEarthFragmentKeys (const std::vector< TerrainContentItemKey > &keys)=0
	Sets all the TerrainContentItemKeys associated with the osgEarth fragment. More...
virtual void	moveTerrainContentTreeWidgetItem (TerrainContentItemKey key, bool up)=0
	Moves the terrain content tree widget item up/down. More...
virtual void	setGenerateCacheButtonEnabled (bool enabled)=0
	Enables/Disables the generate cache button. More...
virtual void	setGenerateBoundaryButtonEnabled (bool enabled)=0
	Enables/Disables the generate boundary button. More...
virtual void	setSaveTerrainButtonEnabled (bool enabled)=0
	Enables/Disables the save terrain button. More...
virtual void	setCommitChangeButtonEnabled (bool enabled)=0
	Enables/Disables the save terrain button. More...
virtual void	setRevertChangeButtonEnabled (bool enabled)=0
	Enables/Disables the revert change button. More...
virtual void	enableOsgEarthFragmentTabWidget (bool enabled)=0
	Enables/Disables the osgEarth fragment tab widget. More...
virtual void	resizeTerrainPropertyTreeWidget ()=0
	Resize the terrain property tree widget content. More...
virtual void	resizeTerrainFragmentTreeWidget ()=0
	Resize the terrain fragment tree widget content. More...
virtual void	setTerrainPropertyTreeItemName (const TerrainContentItemKey &key, const std::string &name)=0
	Sets the name entry to be displayed in the terrain property tree. More...
virtual void	setTerrainPropertyTreeItemVisibility (const TerrainContentItemKey &key, bool visible)=0
	Sets the visible entry to be displayed in the terrain property tree item. More...
virtual void	setTerrainContentTreeItemName (const TerrainContentItemKey &key, const std::string &name)=0
	Sets the name entry to be displayed in the terrain property tree item. More...
virtual void	setTerrainContentTreeItemVisibility (const TerrainContentItemKey &key, bool visible)=0
	Sets the visibility in the terrain content tree item. More...
virtual void	showTerrainPropertyTreeWidgetItem (const TerrainContentItemKey &key)=0
	Shows the terrain property tree item associated with the terrain content item. More...
virtual void	showTerrainPropertyTreeWidgetItems (const std::vector< TerrainContentItemKey > &keys)=0
	Shows the terrain property tree items associated with a list of terrain content items. More...
virtual void	setProperties (const TerrainContentItemKey &key, const DtTerrainEditorProperties *props)=0
	Set the properties for a given terrain content item. More...
virtual bool	properties (const TerrainContentItemKey &key, DtTerrainEditorProperties *props)=0
	Get the properties for a given terrain content item. More...
virtual void	showCacheDialog (const std::string &osgEarthTerrainDefinition)=0
	Shows the osgEarth cache dialog. More...
virtual DtUnicode	showSaveMtfFileDialog (const DtUnicode &directory)=0
	Shows the dialog about saving as mtf file(MAK Terrain Format). More...
virtual DtUnicode	showSaveOsgEarthFileDialog (const DtUnicode &directory)=0
	Shows the dialog about saving as earth file. More...
virtual void	showSaveFileConfirmationMessageBox (const DtUnicode &fileName)=0
	Shows the message box to confirm the saving of a file. More...
virtual bool	showWarnReloadTerrainMessageBox (bool &checked)=0
	Shows the dialog to warn the user of reloading the terrain. More...
virtual bool	showReloadTerrainAfterGenerateMaskMessageBox (const std::string &terrainPatch)=0
	Shows the dialog to reload the terrain after generating a mask. More...
virtual bool	showChooseLayerTypeMessageBox (const DtUnicode &url, int &type)=0
	Shows the message box that asks user to specify the type of the terrain layer when add new data to terrain. More...
virtual void	showFileExtensionNotSupportedMessageBox (const DtUnicode &fileName)=0
	Shows the message box that the files user are trying to drag into the terrain editor is not supported. More...
virtual void	setGenerateBoundaryModels (const std::vector< std::string > &models)=0
	Sets the list of models to generate boundary for. More...
virtual void	expandTerrainContentTreeWidget ()=0
	Expands all the items in terrain content tree widget. More...
virtual void	expandOsgEarthFragmentTreeWidget ()=0
	Expands all the items in osgEarth fragment tree widget. More...
virtual int	getIndexOfTerrainContentItem (const TerrainContentItemKey &key)=0
	Gets the index of the terrain content item. More...
virtual bool	checkIfNameDuplicate (const TerrainContentItemKey &key, const std::string &name)=0
	Checks if the name is duplicate for all the items that has the same parent as item. More...

Public Attributes
boost::signalslib::signal < void(const TerrainContentItemKey &key)>	signal_terrainPropertyTreeWidgetItem_currentItemChanged
	boost signals More...
boost::signalslib::signal < void(const TerrainContentItemKey &key)>	signal_terrainContentTreeWidget_itemDoubleClicked
	The signal emitted when double click on the terrain content item. More...
boost::signalslib::signal < void(const std::string &key)>	signal_osgEarthFragmentTreeWidget_currentItemChanged
	The signal emitted when the current item of the osgEarth fragment tree has changed. More...
boost::signalslib::signal < void(const TerrainContentItemKey &key)>	signal_terrainContentCommitChangesButtonReleased
	The signal emitted when user hits the commit changes button. More...
boost::signalslib::signal < void(const TerrainContentItemKey &key)>	signal_terrainContentRevertChangesButtonReleased
	The signal emitted when user hits the revert changes button. More...
boost::signalslib::signal < void(const std::vector < TerrainContentItemKey > &keys)>	signal_osgEarthFragmentCommitChangesButtonReleased
	The signal emitted when user hits the commit button when the osgEarth fragment Tab is enabled. More...
boost::signalslib::signal < void(const TerrainContentItemKey &key)>	signal_saveTerrainContentTreeWidgetItem
	The signal emitted when the user clicks save on the terrain content item through the context menu(if appliable). More...
boost::signalslib::signal < void(const TerrainContentItemKey &key)>	signal_deleteTerrainContentTreeWidgetItem
	The signal emitted when the user clicks save on the terrain content item. More...
boost::signalslib::signal< void()>	signal_generateBoundaryButton_released
	The signal emitted when user clicks on the generate boundary button. More...
boost::signalslib::signal < void(const DtUnicode &fileName, bool toFrontEnd, bool toSimEngine)>	signal_addFeatureLayerButtonReleased
	The signal emitted when user clicks on the add feature layer button(MAK Terrain Toolkit feature layer). More...
boost::signalslib::signal< void()>	signal_addOceanLayerButtonReleased
	The signal emitted when user clicks on the add ocean layer button. More...
boost::signalslib::signal < void(int type, const std::string &name, const std::string &driver, const DtUnicode &url)>	signal_osgEarthTerrainLayerRequestAdded
	The signal emitted when a terrain layer(Image/Elevation) has been added through the gui. More...
boost::signalslib::signal < void(const std::string &name, const std::string &driver, const DtUnicode &url, const std::string &wfsType)>	signal_osgEarthModelLayerRequestAdded
	The signal emitted when a model layer has been added through the gui. More...
boost::signalslib::signal < void(const std::string &definition, const std::string &name, bool geocentric, bool convexHull)>	signal_generateBoundary
	The signal emitted when receive the request to generate boundary for a given terrain patch. More...
boost::signalslib::signal< void()>	signal_saveOsgEarthTerrain
	The signal emitted when receive the request to save the osgEarth terrain through the context menu. More...
boost::signalslib::signal< void()>	signal_saveTerrain
	The signal emitted when receive the request to save the terrain(MTF terrain) through the context menu. More...
boost::signalslib::signal< void()>	signal_generateCacheButtonReleased
	The signal emitted when user clicks on the generate cache button. More...
boost::signalslib::signal < void(std::vector < std::string >)>	signal_addData
	The signal emitted when user drag and drop data into the terrain editor. More...
boost::signalslib::signal < void(const TerrainContentItemKey &key, bool visible)>	signal_visibleLayerVisiblityChanged
	The signal emitted when the visibility of the layer has changed. More...
boost::signalslib::signal < void(const TerrainContentItemKey &key, double opacity)>	signal_visibleLayerOpacityChanged
	The signal emitted when the opacity of the layer has changed. More...
boost::signalslib::signal < void(const TerrainContentItemKey &key, double minRange)>	signal_visibleLayerMinVisibleRangeChanged
	The signal emitted when the minimal visible range of the layer has changed. More...
boost::signalslib::signal < void(const TerrainContentItemKey &key, double maxRange)>	signal_visibleLayerMaxVisibleRangeChanged
	The signal emitted when the maximum visible range of the layer has changed. More...
boost::signalslib::signal < void(const TerrainContentItemKey &key, bool enabled)>	signal_osgEarthDebugModeStateChanged
	Signal emitted when the osgEarth debug mode state has changed. More...
boost::signalslib::signal < void(const TerrainContentItemKey &key, const std::string &description)>	signal_terrainDescriptionChanged
	Signal emitted when the description of the terrain has changed. More...
boost::signalslib::signal < void(const TerrainContentItemKey &key, int maxPagedLODs)>	signal_terrainMaxPagedLODsChanged
	Signal emitted when the maximum number of paged LODs for this terrain has changed. More...
boost::signalslib::signal < void(const TerrainContentItemKey &key, const std::string &name)>	signal_oceanLayerNameChanged
	Signal emitted when the name of the ocean layer has changed. More...
boost::signalslib::signal < void(const TerrainContentItemKey &key, double height)>	signal_oceanLayerHeightChanged
	Signal emitted when the height of the ocean layer has changed. More...
boost::signalslib::signal < void(const TerrainContentItemKey &key, int lod)>	signal_oceanLayerLodChanged
	Signal emitted when the lod of the ocean layer has changed. More...

Detailed Description

DtTerrainEditorInterface.

Interface class for editing the terrain in the scene. It supports adding/modifying image layer/elevation layer/model layer/terrain patch(OpenFlight etc)/ocean layer. It also has tools for generating cache data, generating boundary for a model, etc. It can save out the terrain as mtf file(MAK TERRAIN FORMAT).

Member Enumeration Documentation

enum makVrv::DtTerrainEditorInterface::TerrainContentItemType

Enumerator
Terrain
ImageLayerGroup
ElevationLayerGroup
ModelLayerGroup
MaskLayerGroup
BuildingLayerGroup
LandCoverLayerGroup
GroundCoverLayerGroup
RoadSurfaceLayerGroup
SplatLayerGroup
TerrainPatchGroup
OceanLayerGroup
FeatureSourceGroup
FeatureLayerGroup
AerodromeLayerGroup
OsgEarthFeatureLayerGroup
OsgEarthTerrainPatch
OpenFlightTerrainPatch
FeatureSource
FeatureLayer
AerodromeLayer
OsgEarthFeatureLayer
OceanLayer
ImageLayer
ElevationLayer
ModelLayer
MaskLayer
BuildingLayer
LandCoverLayer
GroundCoverLayer
GroundCover
RoadSurfaceLayer
SplatLayer
TreeWidget
CompositeImageLayer
CompositeElevationLayer
CompositeParentLayer
CompositeChildLayer
UnknownType

Member Function Documentation

virtual void makVrv::DtTerrainEditorInterface::addTerrainContentTopLevelItem ( const TerrainContentItemKey &  key, const std::string &  displayName  )

pure virtual

Adds a top level terrain content item(no parent) to the terrain content tree widget.

Parameters

key	The unique key of the terrain content item.
displayName	The name to be displayed in the tree.

Implemented in makVrv::DtTerrainEditorWidget.

virtual void makVrv::DtTerrainEditorInterface::addTerrainContentItem ( const TerrainContentItemKey &  key, const TerrainContentItemKey &  parentKey, const std::string &  displayName, int  index = -1, bool  editable = false, bool  checked = true  )

pure virtual

Adds a terrain content item to the terrain content tree widget.

Parameters

key	The unique key of the terrain content item.
displayName	The name to be displayed in the tree.
index	The sequence of the item under the parent item, default is -1 means inserts at last position.
editable	Whether this item is editable.
checked	Whether check the checkbox that associated with this item.

Implemented in makVrv::DtTerrainEditorWidget.

virtual void makVrv::DtTerrainEditorInterface::addOsgEarthFragmentContentTopLevelItem ( const std::string &  key, const std::string &  displayName  )

pure virtual

Adds a top level osgEarth fragment(no parent) item to the osgEarth fragment tree widget.

Parameters

key	The unique key of the osgEarth fragment item, usually the full url of the external reference.
displayName	The name to be displayed in the tree.

Implemented in makVrv::DtTerrainEditorWidget.

virtual void makVrv::DtTerrainEditorInterface::addOsgEarthFragmentContentItem ( const std::string &  key, const std::string &  parentKey, const std::string &  displayName  )

pure virtual

Adds an osgEarth fragment item to the osgEarth fragment tree widget.

Parameters

key	The unique key of the osgEarth fragment item, usually the full url of the external reference.
parentKey	The unique key of the osgEarth parent fragment item, usually the full url of the external reference.
displayName	The name to be displayed in the tree.

Implemented in makVrv::DtTerrainEditorWidget.

virtual void makVrv::DtTerrainEditorInterface::clearTreeWidgets ( )

pure virtual

Cleans the contents of all tree widgets.

Implemented in makVrv::DtTerrainEditorWidget.

virtual void makVrv::DtTerrainEditorInterface::setFocusOnTerrainContentTreeWidgetItem ( const TerrainContentItemKey &  key, bool  expanded = true  )

pure virtual

Sets focus on the terrain content tree widget item.

Parameters

key	The key of the terrain content tree widget item.
expanded	Whether expands the tree widget item.

Implemented in makVrv::DtTerrainEditorWidget.

virtual void makVrv::DtTerrainEditorInterface::removeTerrainContentTreeWidgetItem ( const TerrainContentItemKey &  key )

pure virtual

Removes the terrain content tree widget item.

Parameters

key	The key of the terrain content tree widget item.

Implemented in makVrv::DtTerrainEditorWidget.

virtual bool makVrv::DtTerrainEditorInterface::hasTerrainContentTreeWidgetItem ( const TerrainContentItemKey &  key )

pure virtual

Check if the terrain content tree widget has the item specifiged with the key.

Parameters

key	The key of the terrain content tree widget item.

Implemented in makVrv::DtTerrainEditorWidget.

virtual bool makVrv::DtTerrainEditorInterface::hasTerrainPropertyTreeWidgetItem ( const TerrainContentItemKey &  key )

pure virtual

Check if the terrain property tree widget has the item specifiged with the key.

Parameters

key	The key of the terrain property tree widget item.

Implemented in makVrv::DtTerrainEditorWidget.

virtual void makVrv::DtTerrainEditorInterface::cleanOsgEarthFragmentTreeWidget ( )

pure virtual

Clean the contents of osgEarth fragment tree.

Implemented in makVrv::DtTerrainEditorWidget.

virtual void makVrv::DtTerrainEditorInterface::setSelectedOsgEarthFragmentKeys ( const std::vector< TerrainContentItemKey > &  keys )

pure virtual

Sets all the TerrainContentItemKeys associated with the osgEarth fragment.

An osgEarth fragment(external reference file) earth file may have several terrain contents(models,images,etc).

Implemented in makVrv::DtTerrainEditorWidget.

virtual void makVrv::DtTerrainEditorInterface::moveTerrainContentTreeWidgetItem ( TerrainContentItemKey  key, bool  up  )

pure virtual

Moves the terrain content tree widget item up/down.

Parameters

key	The key of the terrain content tree widget item.
up	Moves the item up or down.

Implemented in makVrv::DtTerrainEditorWidget.

virtual void makVrv::DtTerrainEditorInterface::setGenerateCacheButtonEnabled ( bool  enabled )

pure virtual

Enables/Disables the generate cache button.

Parameters

enabled

Sets to true to enable, otherwise disable.

Implemented in makVrv::DtTerrainEditorWidget.

virtual void makVrv::DtTerrainEditorInterface::setGenerateBoundaryButtonEnabled ( bool  enabled )

pure virtual

Enables/Disables the generate boundary button.

Parameters

enabled

Sets to true to enable, otherwise disable.

Implemented in makVrv::DtTerrainEditorWidget.

virtual void makVrv::DtTerrainEditorInterface::setSaveTerrainButtonEnabled ( bool  enabled )

pure virtual

Enables/Disables the save terrain button.

Parameters

enabled

Sets to true to enable, otherwise disable.

Implemented in makVrv::DtTerrainEditorWidget.

virtual void makVrv::DtTerrainEditorInterface::setCommitChangeButtonEnabled ( bool  enabled )

pure virtual

Enables/Disables the save terrain button.

Parameters

enabled

Sets to true to enable, otherwise disable.

Implemented in makVrv::DtTerrainEditorWidget.

virtual void makVrv::DtTerrainEditorInterface::setRevertChangeButtonEnabled ( bool  enabled )

pure virtual

Enables/Disables the revert change button.

Parameters

enabled

Sets to true to enable, otherwise disable.

Implemented in makVrv::DtTerrainEditorWidget.

virtual void makVrv::DtTerrainEditorInterface::enableOsgEarthFragmentTabWidget ( bool  enabled )

pure virtual

Enables/Disables the osgEarth fragment tab widget.

Parameters

enabled

Sets to true to enable, otherwise disable.

Implemented in makVrv::DtTerrainEditorWidget.

virtual void makVrv::DtTerrainEditorInterface::resizeTerrainPropertyTreeWidget ( )

pure virtual

Resize the terrain property tree widget content.

Implemented in makVrv::DtTerrainEditorWidget.

virtual void makVrv::DtTerrainEditorInterface::resizeTerrainFragmentTreeWidget ( )

pure virtual

Resize the terrain fragment tree widget content.

Implemented in makVrv::DtTerrainEditorWidget.

virtual void makVrv::DtTerrainEditorInterface::setTerrainPropertyTreeItemName ( const TerrainContentItemKey &  key, const std::string &  name  )

pure virtual

Sets the name entry to be displayed in the terrain property tree.

Implemented in makVrv::DtTerrainEditorWidget.

virtual void makVrv::DtTerrainEditorInterface::setTerrainPropertyTreeItemVisibility ( const TerrainContentItemKey &  key, bool  visible  )

pure virtual

Sets the visible entry to be displayed in the terrain property tree item.

Implemented in makVrv::DtTerrainEditorWidget.

virtual void makVrv::DtTerrainEditorInterface::setTerrainContentTreeItemName ( const TerrainContentItemKey &  key, const std::string &  name  )

pure virtual

Sets the name entry to be displayed in the terrain property tree item.

Implemented in makVrv::DtTerrainEditorWidget.

virtual void makVrv::DtTerrainEditorInterface::setTerrainContentTreeItemVisibility ( const TerrainContentItemKey &  key, bool  visible  )

pure virtual

Sets the visibility in the terrain content tree item.

Implemented in makVrv::DtTerrainEditorWidget.

virtual void makVrv::DtTerrainEditorInterface::showTerrainPropertyTreeWidgetItem ( const TerrainContentItemKey &  key )

pure virtual

Shows the terrain property tree item associated with the terrain content item.

Parameters

key	The key of the terrain content item.

Implemented in makVrv::DtTerrainEditorWidget.

virtual void makVrv::DtTerrainEditorInterface::showTerrainPropertyTreeWidgetItems ( const std::vector< TerrainContentItemKey > &  keys )

pure virtual

Shows the terrain property tree items associated with a list of terrain content items.

Parameters

keys	A list of the keys of the terrain content items.

Implemented in makVrv::DtTerrainEditorWidget.

virtual void makVrv::DtTerrainEditorInterface::setProperties ( const TerrainContentItemKey &  key, const DtTerrainEditorProperties *  props  )

pure virtual

Set the properties for a given terrain content item.

Parameters

key	The key of the terrain content item.
props	The properties of for the given key.

Implemented in makVrv::DtTerrainEditorWidget.

virtual bool makVrv::DtTerrainEditorInterface::properties ( const TerrainContentItemKey &  key, DtTerrainEditorProperties *  props  )

pure virtual

Get the properties for a given terrain content item.

Parameters

key	The key of the terrain content item.
props	The properties to populate for the given key.

Implemented in makVrv::DtTerrainEditorWidget.

virtual void makVrv::DtTerrainEditorInterface::showCacheDialog ( const std::string &  osgEarthTerrainDefinition )

pure virtual

Shows the osgEarth cache dialog.

Parameters

osgEarthTerrainDefinition

The osgEarth terrain definition.

Implemented in makVrv::DtTerrainEditorWidget.

virtual DtUnicode makVrv::DtTerrainEditorInterface::showSaveMtfFileDialog ( const DtUnicode &  directory )

pure virtual

Shows the dialog about saving as mtf file(MAK Terrain Format).

Parameters

directory

The directory to save the mtf file.

Implemented in makVrv::DtTerrainEditorWidget.

virtual DtUnicode makVrv::DtTerrainEditorInterface::showSaveOsgEarthFileDialog ( const DtUnicode &  directory )

pure virtual

Shows the dialog about saving as earth file.

Parameters

directory

The directory to save the earth file.

Implemented in makVrv::DtTerrainEditorWidget.

virtual void makVrv::DtTerrainEditorInterface::showSaveFileConfirmationMessageBox ( const DtUnicode &  fileName )

pure virtual

Shows the message box to confirm the saving of a file.

Parameters

fileName

The file name of the file.

Implemented in makVrv::DtTerrainEditorWidget.

virtual bool makVrv::DtTerrainEditorInterface::showWarnReloadTerrainMessageBox ( bool &  checked )

pure virtual

Shows the dialog to warn the user of reloading the terrain.

Parameters

checked

Whether the not show again check box is checked by the user.

Implemented in makVrv::DtTerrainEditorWidget.

virtual bool makVrv::DtTerrainEditorInterface::showReloadTerrainAfterGenerateMaskMessageBox ( const std::string &  terrainPatch )

pure virtual

Shows the dialog to reload the terrain after generating a mask.

Parameters

terrainPatch

The name of the terrain patch to generate mask for.

Implemented in makVrv::DtTerrainEditorWidget.

virtual bool makVrv::DtTerrainEditorInterface::showChooseLayerTypeMessageBox ( const DtUnicode &  url, int &  type  )

pure virtual

Shows the message box that asks user to specify the type of the terrain layer when add new data to terrain.

Parameters

url	The source data of the layer.
type	The type of the layer.

Returns

Return true if user wants add this layer. Return false if use cancel the operation.

Implemented in makVrv::DtTerrainEditorWidget.

virtual void makVrv::DtTerrainEditorInterface::showFileExtensionNotSupportedMessageBox ( const DtUnicode &  fileName )

pure virtual

Shows the message box that the files user are trying to drag into the terrain editor is not supported.

Parameters

fileName

The name of the file.

Implemented in makVrv::DtTerrainEditorWidget.

virtual void makVrv::DtTerrainEditorInterface::setGenerateBoundaryModels ( const std::vector< std::string > &  models )

pure virtual

Sets the list of models to generate boundary for.

Parameters

models

A list of file names of the models.

Implemented in makVrv::DtTerrainEditorWidget.

virtual void makVrv::DtTerrainEditorInterface::expandTerrainContentTreeWidget ( )

pure virtual

Expands all the items in terrain content tree widget.

Implemented in makVrv::DtTerrainEditorWidget.

virtual void makVrv::DtTerrainEditorInterface::expandOsgEarthFragmentTreeWidget ( )

pure virtual

Expands all the items in osgEarth fragment tree widget.

Implemented in makVrv::DtTerrainEditorWidget.

virtual int makVrv::DtTerrainEditorInterface::getIndexOfTerrainContentItem ( const TerrainContentItemKey &  key )

pure virtual

Gets the index of the terrain content item.

Parameters

key	The key of the terrain content item. The index of the terrain content item under it's parent. Return -1 if the item not found.

Implemented in makVrv::DtTerrainEditorWidget.

virtual bool makVrv::DtTerrainEditorInterface::checkIfNameDuplicate ( const TerrainContentItemKey &  key, const std::string &  name  )

pure virtual

Checks if the name is duplicate for all the items that has the same parent as item.

Parameters

key	The key of the terrain content item.
name	The name to check.

Returns

Return true if the name is duplicate.

Implemented in makVrv::DtTerrainEditorWidget.

Member Data Documentation

boost::signalslib::signal<void(const TerrainContentItemKey& key)> makVrv::DtTerrainEditorInterface::signal_terrainPropertyTreeWidgetItem_currentItemChanged

boost signals

The signal emitted when the current item of the terrain property tree has changed.

Parameters

key	The key of the current selected terrain content tree item.

boost::signalslib::signal<void(const TerrainContentItemKey& key)> makVrv::DtTerrainEditorInterface::signal_terrainContentTreeWidget_itemDoubleClicked

The signal emitted when double click on the terrain content item.

Parameters

key	The key of the terrain content tree item.

boost::signalslib::signal<void(const std::string& key)> makVrv::DtTerrainEditorInterface::signal_osgEarthFragmentTreeWidget_currentItemChanged

The signal emitted when the current item of the osgEarth fragment tree has changed.

Parameters

key	The unique key of the osgEarth fragment item, usually the full url of the external reference.

boost::signalslib::signal<void(const TerrainContentItemKey& key)> makVrv::DtTerrainEditorInterface::signal_terrainContentCommitChangesButtonReleased

The signal emitted when user hits the commit changes button.

Parameters

key	The key of the current selected terrain content item.

boost::signalslib::signal<void(const TerrainContentItemKey& key)> makVrv::DtTerrainEditorInterface::signal_terrainContentRevertChangesButtonReleased

The signal emitted when user hits the revert changes button.

Parameters

key	The key of the current selected terrain content item.

boost::signalslib::signal<void(const std::vector<TerrainContentItemKey>& keys)> makVrv::DtTerrainEditorInterface::signal_osgEarthFragmentCommitChangesButtonReleased

The signal emitted when user hits the commit button when the osgEarth fragment Tab is enabled.

Parameters

keys	The keys of all the terrain content items that included in the selected external fragment file.

boost::signalslib::signal<void(const TerrainContentItemKey& key)> makVrv::DtTerrainEditorInterface::signal_saveTerrainContentTreeWidgetItem

The signal emitted when the user clicks save on the terrain content item through the context menu(if appliable).

Parameters

key	The key of the current selected terrain content item.

boost::signalslib::signal<void(const TerrainContentItemKey& key)> makVrv::DtTerrainEditorInterface::signal_deleteTerrainContentTreeWidgetItem

The signal emitted when the user clicks save on the terrain content item.

Parameters

key	The key of the current selected terrain content item.

boost::signalslib::signal<void()> makVrv::DtTerrainEditorInterface::signal_generateBoundaryButton_released

The signal emitted when user clicks on the generate boundary button.

boost::signalslib::signal<void(const DtUnicode& fileName, bool toFrontEnd, bool toSimEngine)> makVrv::DtTerrainEditorInterface::signal_addFeatureLayerButtonReleased

The signal emitted when user clicks on the add feature layer button(MAK Terrain Toolkit feature layer).

Parameters

fileName	The file name of the feature layer about to be added.
toFrontEnd	Whether or not the feature layer is applied to the front end
toSimEngine	Whether or not the feature layer is applied to the simulation engine

boost::signalslib::signal<void()> makVrv::DtTerrainEditorInterface::signal_addOceanLayerButtonReleased

The signal emitted when user clicks on the add ocean layer button.

Parameters

fileName

The file name of the ocean layer about to be added.

boost::signalslib::signal<void(int type, const std::string& name, const std::string& driver, const DtUnicode& url)> makVrv::DtTerrainEditorInterface::signal_osgEarthTerrainLayerRequestAdded

The signal emitted when a terrain layer(Image/Elevation) has been added through the gui.

Parameters

type	DtOsgEarthDataRequest::OsgEarthDataType enum, present the type of the layer.
name	The name of the layer, must be unique.
driver	The driver used to render this layer, required.
url	The URI of the layer, can be a local file path or remote URI.

boost::signalslib::signal<void(const std::string& name, const std::string& driver, const DtUnicode& url, const std::string& wfsType)> makVrv::DtTerrainEditorInterface::signal_osgEarthModelLayerRequestAdded

The signal emitted when a model layer has been added through the gui.

Parameters

name	The name of the layer, must be unique.
driver	The driver used to render this layer, required.
url	The URI of the layer, can be a local file path or remote URI.
wfsType	The wfs typename of the model layer, only appliable if the model source is wfs(OGC Web Feature Service).

boost::signalslib::signal<void(const std::string& definition, const std::string& name, bool geocentric, bool convexHull)> makVrv::DtTerrainEditorInterface::signal_generateBoundary

The signal emitted when receive the request to generate boundary for a given terrain patch.

Parameters

terrainPatchDefinition	The terrain definition of the terrain patch which used to generate boundary.
name	The name of the mask layer.
geocentric	If the terrain database is geocentric.
convexHull	Calculate a convex hull instead of a full boundary.

boost::signalslib::signal<void()> makVrv::DtTerrainEditorInterface::signal_saveOsgEarthTerrain

The signal emitted when receive the request to save the osgEarth terrain through the context menu.

boost::signalslib::signal<void()> makVrv::DtTerrainEditorInterface::signal_saveTerrain

The signal emitted when receive the request to save the terrain(MTF terrain) through the context menu.

boost::signalslib::signal<void()> makVrv::DtTerrainEditorInterface::signal_generateCacheButtonReleased

The signal emitted when user clicks on the generate cache button.

boost::signalslib::signal<void(std::vector<std::string>)> makVrv::DtTerrainEditorInterface::signal_addData

The signal emitted when user drag and drop data into the terrain editor.

boost::signalslib::signal<void(const TerrainContentItemKey& key, bool visible)> makVrv::DtTerrainEditorInterface::signal_visibleLayerVisiblityChanged

The signal emitted when the visibility of the layer has changed.

Parameters

key	The key of the current selected layer.
visible	The visibility of the layer.

boost::signalslib::signal<void(const TerrainContentItemKey& key, double opacity)> makVrv::DtTerrainEditorInterface::signal_visibleLayerOpacityChanged

The signal emitted when the opacity of the layer has changed.

Parameters

key	The key of the current selected layer.
opacity	The opacity of the layer[0..1].

boost::signalslib::signal<void(const TerrainContentItemKey& key, double minRange)> makVrv::DtTerrainEditorInterface::signal_visibleLayerMinVisibleRangeChanged

The signal emitted when the minimal visible range of the layer has changed.

Parameters

key	The key of the current selected layer.
minRange	The minimal visible range.

boost::signalslib::signal<void(const TerrainContentItemKey& key, double maxRange)> makVrv::DtTerrainEditorInterface::signal_visibleLayerMaxVisibleRangeChanged

The signal emitted when the maximum visible range of the layer has changed.

Parameters

key	The key of the current selected layer.
maxRange	The maximum visible range.

boost::signalslib::signal<void(const TerrainContentItemKey& key, bool enabled)> makVrv::DtTerrainEditorInterface::signal_osgEarthDebugModeStateChanged

Signal emitted when the osgEarth debug mode state has changed.

Parameters

key	The key of the current selected layer.
enabled	Whether or not osgEarth debug mode is enabled.

boost::signalslib::signal<void(const TerrainContentItemKey& key, const std::string& description)> makVrv::DtTerrainEditorInterface::signal_terrainDescriptionChanged

Signal emitted when the description of the terrain has changed.

Parameters

key	The key of the current selected layer.
description	The description of the terrain.

boost::signalslib::signal<void(const TerrainContentItemKey& key, int maxPagedLODs)> makVrv::DtTerrainEditorInterface::signal_terrainMaxPagedLODsChanged

Signal emitted when the maximum number of paged LODs for this terrain has changed.

Parameters

key	The key of the current selected layer.
maxPagedLODs	The maximum number of paged LODs to keep in memory for this terrain.

boost::signalslib::signal<void(const TerrainContentItemKey& key, const std::string& name)> makVrv::DtTerrainEditorInterface::signal_oceanLayerNameChanged

Signal emitted when the name of the ocean layer has changed.

Parameters

name	The name of the ocean layer.

boost::signalslib::signal<void(const TerrainContentItemKey& key, double height)> makVrv::DtTerrainEditorInterface::signal_oceanLayerHeightChanged

Signal emitted when the height of the ocean layer has changed.

Parameters

key	The key of the current selected layer.
height	The height of the ocean layer.

boost::signalslib::signal<void(const TerrainContentItemKey& key, int lod)> makVrv::DtTerrainEditorInterface::signal_oceanLayerLodChanged

Signal emitted when the lod of the ocean layer has changed.

Parameters

key	The key of the current selected layer.
lod	The altitude at which the Ocean LOD's out.

---

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

• /data/exports/nrhent7-1/nightly/docs/vrForces.vrf4-10-branch/include/vrvTerrainEditor/DtTerrainEditorInterface.h