VizKit::VisualItemIdentifier Class Reference

Identifier of an item (like e.g. More...

#include <VisualItemIdentifier.h>

List of all members.

Public Member Functions
	VisualItemIdentifier ()
	The constructor.
	VisualItemIdentifier (const char *const aName)
	Another constructor.
	~VisualItemIdentifier ()
	The destructor.
	VisualItemIdentifier (const VisualItemIdentifier &other)
	Copy constructor.
VisualItemIdentifier &	operator= (const VisualItemIdentifier &other)
	Assignment operator.
bool	operator< (const VisualItemIdentifier &other) const
	Less than operator.
bool	operator== (const VisualItemIdentifier &other) const
	Equality operator.
bool	operator!= (const VisualItemIdentifier &other)
	Inequality operator.
const char *const	getName (void)
	Returns the name (NULL if there is none).
Static Public Member Functions
static VisualItemIdentifier *	createVisualItemIdentifier (const char *const aName)
	Returns a VisualItemIdentifier identified by name.
Private Types
typedef std::map< std::string, uint32 >	VisualItemIdentifierNameTokenMap
	A VisualItemIdentifierTokenNameMap is a map of names and tokens.
typedef VisualItemIdentifierNameTokenMap::iterator	VisualItemIdentifierNameTokenMapIterator
	A VisualItemIdentifierNameTokenMapIterator is an iterator of a VisualItemIdentifierNameTokenMap.
Private Member Functions
	VisualItemIdentifier (const char *const aName, uint32 aToken)
	Private constructor.
void	copy (const VisualItemIdentifier &other)
	Copy method for assignment operator and copy constructor.
Static Private Member Functions
static uint32	getNextToken ()
	Internal method to receive the next valid token.
Private Attributes
char *	name
	The optional identifier name (for shared VisualItemIdentifiers).
uint32	token
	The internal identifier of the VisualItemIdentifier.
Static Private Attributes
static VisualItemIdentifierNameTokenMap	visualItemIdentifierNameTokenMap
	A map of names and tokens.

---

Detailed Description

Identifier of an item (like e.g.

a VisualNurbs or a VisualAnimationComponent). The internal token of the identifier stays the same across copy operations. Comparisons of copied instances yield equal result. Identifiers can be shared by supplying a name. If another VisualItemIdentifier with the same name has been created already, it is returned by VisualItemIdentifierRegistry's getVisualItemIdentifier().

---

Member Typedef Documentation

typedef std::map<std::string, uint32> VizKit::VisualItemIdentifier::VisualItemIdentifierNameTokenMap [private]

A VisualItemIdentifierTokenNameMap is a map of names and tokens.

typedef VisualItemIdentifierNameTokenMap::iterator VizKit::VisualItemIdentifier::VisualItemIdentifierNameTokenMapIterator [private]

A VisualItemIdentifierNameTokenMapIterator is an iterator of a VisualItemIdentifierNameTokenMap.

---

Constructor & Destructor Documentation

VisualItemIdentifier::VisualItemIdentifier

(

)

The constructor.

VisualItemIdentifier::VisualItemIdentifier

(

const char *const

aName

)

Another constructor.

Parameters:

aName

An optional identifier name (for shared VisualItemIdentifiers).

VisualItemIdentifier::~VisualItemIdentifier

(

)

The destructor.

VisualItemIdentifier::VisualItemIdentifier

(

const VisualItemIdentifier &

other

)

Copy constructor.

Parameters:

other

Another VisualItemIdentifier.

VisualItemIdentifier::VisualItemIdentifier	(	const char *const	aName,
		uint32	aToken
	)		[private]

Private constructor.

Parameters:

aName	Name of VisualItemIdentifier.
aToken	Token of VisualItemIdentifier.

---

Member Function Documentation

void VisualItemIdentifier::copy

(

const VisualItemIdentifier &

other

)

[private]

Copy method for assignment operator and copy constructor.

Parameters:

other

Another VisualItemIdentifier.

VisualItemIdentifier * VisualItemIdentifier::createVisualItemIdentifier

(

const char *const

aName

)

[static]

Returns a VisualItemIdentifier identified by name.

By using a name as token, the same identifier can be used at different places.

Parameters:

aName

The name of the VisualItemIdentifier.

Returns:

A pointer to a visualItemIdentifier identified by its name.

Remarks:

The caller has to release the allocated memory by calling delete() on the pointer.

const char *const VisualItemIdentifier::getName

(

void

)

Returns the name (NULL if there is none).

Returns:

The optional identifier name.

uint32 VisualItemIdentifier::getNextToken

(

)

[static, private]

Internal method to receive the next valid token.

bool VisualItemIdentifier::operator!=

(

const VisualItemIdentifier &

other

)

Inequality operator.

Parameters:

other

Another VisualItemIdentifier.

bool VisualItemIdentifier::operator<

(

const VisualItemIdentifier &

other

)

const

Less than operator.

Parameters:

other

Another VisualItemIdentifier.

Remarks:

The less than operator is used by std::map for find() and sorting (if VisualItemIdentifier is used as key_type).

VisualItemIdentifier & VisualItemIdentifier::operator=

(

const VisualItemIdentifier &

other

)

Assignment operator.

bool VisualItemIdentifier::operator==

(

const VisualItemIdentifier &

other

)

const

Equality operator.

Parameters:

other

Another VisualItemIdentifier.

---

Member Data Documentation

char* VizKit::VisualItemIdentifier::name [private]

The optional identifier name (for shared VisualItemIdentifiers).

uint32 VizKit::VisualItemIdentifier::token [private]

The internal identifier of the VisualItemIdentifier.

Remarks:

The internal identifier stays the same across copies and instances. Since it is typed as 32bit unsigned integer the number of identifiers is limited to 4294967296.

VisualItemIdentifier::VisualItemIdentifierNameTokenMap VisualItemIdentifier::visualItemIdentifierNameTokenMap [static, private]

A map of names and tokens.

---

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

• vizkit/source/Tools/VisualItemIdentifier.h
• vizkit/source/Tools/VisualItemIdentifier.cpp