terrainSelection.h File Reference

Contains the typedefs and related functions that comprise the DtTerrainSelection interface. More...

Go to the source code of this file.

Typedefs
typedef DtAllTypesPolygon	DtTerrainElement
	The DtTerrainElement typedef is meant as an abstraction for future development. More...
typedef std::set < DtTerrainElement * >	DtTerrainSelection
	A DtTerrainSelection is a collection of DtTerrainElements, which have been selected, presumably by the user in order to perform an operation on them. More...
typedef DtTerrainSelection::iterator	DtTerrainElementIter
typedef DtTerrainSelection::const_iterator	DtTerrainElementConstIter

Functions
DT_DLL_gdb void	DtRemoveFromSelection (DtTerrainSelection &primarySelection, const DtTerrainSelection &selectionToRemove)
DT_DLL_gdb void	DtToggleSelection (DtTerrainSelection &primarySelection, const DtTerrainSelection &selectionToToggle)
DT_DLL_gdb void	DtAddToSelection (DtTerrainSelection &primarySelection, const DtTerrainSelection &selectionToAdd)
DT_DLL_gdb bool	xyPointInPolygon (const DtAllTypesPolygon &polygon, const DtPoint &point)

Detailed Description

Contains the typedefs and related functions that comprise the DtTerrainSelection interface.

Typedef Documentation

typedef DtAllTypesPolygon DtTerrainElement

The DtTerrainElement typedef is meant as an abstraction for future development.

The DtTerrainElement will eventually represent any element, whether it's a polygon, a vector network element, a tile, or some other primitive of some type, that is used to represent the physical terrain.

typedef std::set<DtTerrainElement*> DtTerrainSelection

A DtTerrainSelection is a collection of DtTerrainElements, which have been selected, presumably by the user in order to perform an operation on them.

Used most commonly by the terrain selection tool in order to allow the user to set soil types in the Terrain Database Tool application.

typedef DtTerrainSelection::iterator DtTerrainElementIter

typedef DtTerrainSelection::const_iterator DtTerrainElementConstIter

Function Documentation

DT_DLL_gdb void DtRemoveFromSelection	(	DtTerrainSelection &	primarySelection,
		const DtTerrainSelection &	selectionToRemove
	)

DT_DLL_gdb void DtToggleSelection	(	DtTerrainSelection &	primarySelection,
		const DtTerrainSelection &	selectionToToggle
	)

DT_DLL_gdb void DtAddToSelection	(	DtTerrainSelection &	primarySelection,
		const DtTerrainSelection &	selectionToAdd
	)

DT_DLL_gdb bool xyPointInPolygon	(	const DtAllTypesPolygon &	polygon,
		const DtPoint &	point
	)

Returns

A boolean indicating whether or not the specified point is inside the polygon when the point and polygon are projected onto the xy plane.