makVrv::DtTerrainContentItemKey Class Reference

DtTerrainContentItemKey.

Key of the terrain content item, represented by the TerrainContentItemType and id(Different meaning depends on the context of different content item type) or TerrainContentItemType and unique name(When there is no meaningful id associated with the item).

Public Member Functions
	DtTerrainContentItemKey ()
	DtTerrainContentItemKey (int type, int id, const DtTerrainContentItemKey &parentKey)
	DtTerrainContentItemKey (int type, const std::string &name, const DtTerrainContentItemKey &parentKey)
	DtTerrainContentItemKey (int type, const std::string &name, int parentType, int parentId)
	DtTerrainContentItemKey (int type, int id, int parentType, int parentId)
void	invalid ()
void	setType (int type)
void	setId (int id)
void	setParentType (int type)
void	setParentId (int id)
void	setParentKey (const DtTerrainContentItemKey &parentKey)

The unique name of the key.
Gets the name of the key.
int	myType
int	myId
int	myParentType
int	myParentId
bool	myUseName
std::string	myName
void	setName (const std::string &name)
const int	type () const
const int	id () const
const int	parentType () const
const int	parentId () const
std::string	name () const
const bool	useName () const
bool	operator< (const DtTerrainContentItemKey &) const
bool	operator== (const DtTerrainContentItemKey &) const

Constructor & Destructor Documentation

makVrv::DtTerrainContentItemKey::DtTerrainContentItemKey

(

)

Default CTOR.

makVrv::DtTerrainContentItemKey::DtTerrainContentItemKey	(	int	type,
		int	id,
		const DtTerrainContentItemKey &	parentKey
	)

CTOR.

Parameters

type	TerrainContentItemType enum, the type of the terrain content item.
id	The id of the terrain content item key.
parentKey	The key of the parent item.

makVrv::DtTerrainContentItemKey::DtTerrainContentItemKey	(	int	type,
		const std::string &	name,
		const DtTerrainContentItemKey &	parentKey
	)

CTOR.

Parameters

type	TerrainContentItemType enum, the type of the terrain content item.
name	The unique name of the terrain content item key.
parentKey	The key of the parent item.

makVrv::DtTerrainContentItemKey::DtTerrainContentItemKey	(	int	type,
		const std::string &	name,
		int	parentType,
		int	parentId
	)

CTOR.

Parameters

type	TerrainContentItemType enum, the type of the terrain content item.
name	The unique name of the terrain content item key.
parentType	The type of the parent item.
parentId	The id of the parent item.

makVrv::DtTerrainContentItemKey::DtTerrainContentItemKey	(	int	type,
		int	id,
		int	parentType,
		int	parentId
	)

CTOR.

Parameters

type	TerrainContentItemType enum, the type of the terrain content item.
id	The id of the terrain content item key.
parentType	The type of the parent item.
parentId	The id of the parent item.

Member Function Documentation

void makVrv::DtTerrainContentItemKey::invalid

(

)

Invalid the key.

void makVrv::DtTerrainContentItemKey::setType

(

int

type

)

Sets the type of the key.

Parameters

type	TerrainContentItemType enum, the type of the terrain content item.

void makVrv::DtTerrainContentItemKey::setId

(

int

id

)

Sets the id of the key.

Parameters

id	The unique index of the key, different meaning depends on the context of different content item type.

void makVrv::DtTerrainContentItemKey::setParentType

(

int

type

)

Sets the type of the parent key.

Parameters

type	TerrainContentItemType enum, the type of the terrain content item.

void makVrv::DtTerrainContentItemKey::setParentId

(

int

id

)

Sets the id of the parent key.

Parameters

id	The unique index of the key, different meaning depends on the context of different content item type.

void makVrv::DtTerrainContentItemKey::setParentKey

(

const DtTerrainContentItemKey &

parentKey

)

Sets the key of the parent.

Parameters

parentKey

The key of the parent.

void makVrv::DtTerrainContentItemKey::setName

(

const std::string &

name

)

Gets the type of the key.

Returns

TerrainContentItemType enum, the type of the terrain content item.

const int makVrv::DtTerrainContentItemKey::type

(

)

const

Gets the type of the key.

Returns

TerrainContentItemType enum, the type of the terrain content item.

const int makVrv::DtTerrainContentItemKey::id

(

)

const

Gets the id of the key.

Returns

The unique index of the key, different meaning depends on the context of different content item type.

const int makVrv::DtTerrainContentItemKey::parentType

(

)

const

Gets the type of the parent key.

Returns

TerrainContentItemType enum, the type of the terrain content item.

const int makVrv::DtTerrainContentItemKey::parentId

(

)

const

Gets the id of the parent key.

Returns

The unique index of the parent key, different meaning depends on the context of different content item type.

std::string makVrv::DtTerrainContentItemKey::name

(

)

const

Gets the type of the key.

Returns

TerrainContentItemType enum, the type of the terrain content item.

const bool makVrv::DtTerrainContentItemKey::useName

(

)

const

Whether this key uses name as comparison instead of id.

bool makVrv::DtTerrainContentItemKey::operator<

(

const DtTerrainContentItemKey &

)

const

The less operator override.

bool makVrv::DtTerrainContentItemKey::operator==

(

const DtTerrainContentItemKey &

)

const

The eaqul operator override.

Member Data Documentation

int makVrv::DtTerrainContentItemKey::myType

protected

Gets the type of the key.

Returns

TerrainContentItemType enum, the type of the terrain content item.

int makVrv::DtTerrainContentItemKey::myId

protected

Gets the type of the key.

Returns

TerrainContentItemType enum, the type of the terrain content item.

int makVrv::DtTerrainContentItemKey::myParentType

protected

Gets the type of the key.

Returns

TerrainContentItemType enum, the type of the terrain content item.

int makVrv::DtTerrainContentItemKey::myParentId

protected

Gets the type of the key.

Returns

TerrainContentItemType enum, the type of the terrain content item.

bool makVrv::DtTerrainContentItemKey::myUseName

protected

Gets the type of the key.

Returns

TerrainContentItemType enum, the type of the terrain content item.

std::string makVrv::DtTerrainContentItemKey::myName

protected

Gets the type of the key.

Returns

TerrainContentItemType enum, the type of the terrain content item.

---

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

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