ciTerrain Class Reference

Public Types
enum	enumProjectionType { UTM, LVCS }
enum	enumTextureType { MCM, EMAT }

Public Member Functions
char *	getName ()
void	setName (const char *name)
char *	getTerrainFilepath ()
void	setTerrainFilepath (char *terrainFilepath)
int	getProjectionType ()
void	setProjectionType (int projectionType)
int	getTextureType ()
void	setTextureType (int textureType)
void	getSWOrigin (double &latitude, double &longitude)
void	setSWOrigin (double latitude, double longitude)
void	getPositionOffset (double &x, double &y)
void	setPositionOffset (double x, double y)
char *	getMtlsysFilepath ()
void	setMtlsysFilepath (char *mtlsysFilepath)
double	getThermalSpinup ()
void	setThermalSpinup (double thermalSpinup)
void	setVisbility (bool visibility)
bool	getVisbility ()
bool	getEnableTrees ()
void	setEnableTrees (bool flag)
bool	getEnableTreeWind ()
void	setEnableTreeWind (bool flag)
bool	getForceTreeBillboards ()
void	setForceTreeBillboards (bool flag)
bool	getEnableTerrainObjects ()
void	setEnableTerrainObjects (bool flag)
void	setAltitude (double altitude)
double	getAltitude ()
void	setLodScale (double scale)
double	getLodScale ()
bool	getTerrainCenterEnabled ()
void	setTerrainCenterEnabled (bool enabled)
int	getBrdf ()
void	setBrdf (int brdf)
double	getRoughness ()
void	setRoughness (double roughness)
bool	archive (std::ofstream &outf)
bool	serialize (char *filepath)
bool	loadXML (clXMLNode *terrainNode)
bool	parseXML (clXML &xmlDocument)
bool	loadXMLNode (std::string tag, char *nodeString)
bool	loadXMLNode (std::string tag, bool *nodeBool)
bool	loadXMLNode (std::string tag, int *nodeBool)
bool	loadXMLNode (std::string tag, double *nodeBool)
void	saveXML (clXML *xmlDocument)
ciTerrain	operator= (ciTerrain &obj)
	ciTerrain ()
	ciTerrain (ciTerrain &obj)
virtual	~ciTerrain ()

Protected Attributes
char	m_name [128]
char	m_terrainFilepath [512]
int	m_projectionType
int	m_textureType
double	m_swOriginLatitude
double	m_swOriginLongitude
double	m_offsetX
double	m_offsetY
char	m_mtlsysFilepath [512]
double	m_thermalSpinup
bool	m_visibility
bool	m_trees
bool	m_treeWind
bool	m_terrainObjects
double	m_altitude
bool	m_forceTreeBillboards
double	m_lodScale
bool	m_terrainCenterEnabled
int	m_brdf
double	m_roughness
clXMLNode *	m_parentNode

Detailed Description

ciTerrain class declaration

Member Enumeration Documentation

enum ciTerrain::enumProjectionType

Description

Enumerates the defined terrain projection types

Enumerator:

UTM	0
LVCS	1

enum ciTerrain::enumTextureType

Description

Enumerates the defined terrain texture types

Enumerator:

MCM	0
EMAT	1

Constructor & Destructor Documentation

ciTerrain::ciTerrain

(

)

Default constructor.

ciTerrain::ciTerrain

(

ciTerrain &

obj

)

Copy constructor.

Parameters

obj	- ciTerrain object to be copied.

virtual ciTerrain::~ciTerrain ( )

virtual

Member Function Documentation

char* ciTerrain::getName ( )

inline

gets the name associated with the terrain database.

Returns

The name associated with the terrain database.

References m_name.

void ciTerrain::setName ( const char *  name )

inline

sets the name associated with the terrain database.

Parameters

name	- The name to be associated with the terrain database.

Returns

void.

References m_name.

char* ciTerrain::getTerrainFilepath ( )

inline

gets the filename and path of the terrain database.

Returns

The complete path and filename of the terrain database.

void ciTerrain::setTerrainFilepath ( char *  terrainFilepath )

inline

sets the filename and path of the terrain database.

Parameters

terrainFilepath

- The complete path and filename of the terrain database.

Returns

void.

int ciTerrain::getProjectionType ( )

inline

gets terrain projection type.

Returns

The enumerated terrain projection type.

void ciTerrain::setProjectionType ( int  projectionType )

inline

sets terrain projection type.

Parameters

projectionType

- The enumerated terrain projection type.

Returns

void.

int ciTerrain::getTextureType ( )

inline

gets terrain Texture type.

Returns

The enumerated terrain Texture type.

void ciTerrain::setTextureType ( int  textureType )

inline

sets terrain Texture type.

Parameters

textureType

- The enumerated terrain Texture type.

Returns

void.

void ciTerrain::getSWOrigin	(	double &	latitude,
		double &	longitude
	)

gets the south west origin latitude and longitude of the database.

Parameters

latitude	- The south west origin latitude.
longitude	- The south west origin longitude.

Returns

void.

void ciTerrain::setSWOrigin	(	double	latitude,
		double	longitude
	)

gets the south west origin latitude and longitude of the database.

Parameters

latitude	- The south west origin latitude.
longitude	- The south west origin longitude.

Returns

void.

void ciTerrain::getPositionOffset	(	double &	x,
		double &	y
	)

gets the x,y offset of the database.

Parameters

x	- The x offset in world coordinates.
y	- The y offset in world coordinates.

Returns

void.

void ciTerrain::setPositionOffset	(	double	x,
		double	y
	)

sets the x,y offset of the database.

Parameters

x	- The x offset in world coordinates.
y	- The y offset in world coordinates.

Returns

void.

char* ciTerrain::getMtlsysFilepath ( )

inline

gets the filename and path of the material system database associated with the terrain.

Returns

The complete path and filename of the material system database.

void ciTerrain::setMtlsysFilepath ( char *  mtlsysFilepath )

inline

sets the filename and path of the material system database associated with the terrain.

Parameters

mtlsysFilepath

- The complete path and filename of the material system database.

Returns

void.

double ciTerrain::getThermalSpinup ( )

inline

gets the thermal spin-up period.

Returns

Thermal spin-up period [hrs].

void ciTerrain::setThermalSpinup ( double  thermalSpinup )

inline

gets the thermal spin-up period.

Parameters

thermalSpinup

- Thermal spin-up period [hrs].

Returns

void.

void ciTerrain::setVisbility ( bool  visibility )

inline

Sets the visibility flag.

Parameters

visibility

- new visibility flag.

Returns

void.

bool ciTerrain::getVisbility ( )

inline

Gets the visibility flag.

Returns

The current setting for the visibility flag.

bool ciTerrain::getEnableTrees ( )

inline

Returns

bool

void ciTerrain::setEnableTrees ( bool  flag )

inline

Parameters

bool

flag

bool ciTerrain::getEnableTreeWind ( )

inline

Returns

bool

void ciTerrain::setEnableTreeWind ( bool  flag )

inline

Parameters

bool

flag

bool ciTerrain::getForceTreeBillboards ( )

inline

Returns

bool

void ciTerrain::setForceTreeBillboards ( bool  flag )

inline

Parameters

bool

flag

bool ciTerrain::getEnableTerrainObjects ( )

inline

Returns

bool

void ciTerrain::setEnableTerrainObjects ( bool  flag )

inline

Parameters

bool

flag

void ciTerrain::setAltitude ( double  altitude )

inline

Parameters

double

altitude

double ciTerrain::getAltitude ( )

inline

Returns

double

void ciTerrain::setLodScale ( double  scale )

inline

Parameters

double

scale

double ciTerrain::getLodScale ( )

inline

Returns

double

bool ciTerrain::getTerrainCenterEnabled ( )

inline

Returns

bool

void ciTerrain::setTerrainCenterEnabled ( bool  enabled )

inline

Parameters

double

enabled

int ciTerrain::getBrdf

(

)

void ciTerrain::setBrdf

(

int

brdf

)

double ciTerrain::getRoughness

(

)

void ciTerrain::setRoughness

(

double

roughness

)

bool ciTerrain::archive

(

std::ofstream &

outf

)

Description:

Saves the ciTerrain object to file.

Parameters

filepath	- complete path and filename to the file
flags	- file io flags to be set.

Returns

true if sucessful

bool ciTerrain::serialize

(

char *

filepath

)

Description:

Loads the ciTerrain object from file.

Parameters

filepath

- complete path and filename to the file

Returns

true if sucessful

bool ciTerrain::loadXML

(

clXMLNode *

terrainNode

)

bool ciTerrain::parseXML

(

clXML &

xmlDocument

)

bool ciTerrain::loadXMLNode	(	std::string	tag,
		char *	nodeString
	)

Parameters

std::string	tag
char	*nodeString

Returns

bool

bool ciTerrain::loadXMLNode	(	std::string	tag,
		bool *	nodeBool
	)

Parameters

std::string	tag
bool	*nodeBool

Returns

bool

bool ciTerrain::loadXMLNode	(	std::string	tag,
		int *	nodeBool
	)

Parameters

std::string	tag
int	*nodeBool

Returns

bool

bool ciTerrain::loadXMLNode	(	std::string	tag,
		double *	nodeBool
	)

Parameters

std::string	tag
double	*nodeBool

Returns

bool

void ciTerrain::saveXML

(

clXML *

xmlDocument

)

ciTerrain ciTerrain::operator=

(

ciTerrain &

obj

)

Assignment operator.

Parameters

obj	- ciTerrain object to be assigned.

Returns

The assigned ciTerrain object.

Member Data Documentation

char ciTerrain::m_name[128]

protected

Name applied to the terrain, i.e., "Ft. Irwin".

char ciTerrain::m_terrainFilepath[512]

protected

Complete path and filename of the terrain database.

int ciTerrain::m_projectionType

protected

Terrain database projection type.

int ciTerrain::m_textureType

protected

Terrain database texture type.

double ciTerrain::m_swOriginLatitude

protected

Southwest latitude of the database origin [deg].

double ciTerrain::m_swOriginLongitude

protected

Southwest longitude of the database origin [deg].

double ciTerrain::m_offsetX

protected

X position offset from the database origin [database units].

double ciTerrain::m_offsetY

protected

Y position offset from the database origin [database units].

char ciTerrain::m_mtlsysFilepath[512]

protected

Complete path and filename of the material system database.

double ciTerrain::m_thermalSpinup

protected

Thermal spin-up period [hrs].

bool ciTerrain::m_visibility

protected

visibility flag.

bool ciTerrain::m_trees

protected

bool ciTerrain::m_treeWind

protected

bool ciTerrain::m_terrainObjects

protected

double ciTerrain::m_altitude

protected

bool ciTerrain::m_forceTreeBillboards

protected

double ciTerrain::m_lodScale

protected

bool ciTerrain::m_terrainCenterEnabled

protected

Use terrain centering in configFileIO?

int ciTerrain::m_brdf

protected

double ciTerrain::m_roughness

protected

clXMLNode* ciTerrain::m_parentNode

protected

---

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

• ciTerrain.h