makVrv::DtTreeRecord Class Reference

A DtTreeRecord holds the requisite information needed to create a tree in a forest. More...

Public Member Functions
	DtTreeRecord ()
	CTOR.
	DtTreeRecord (DtUniqueID id, const DtVector &pos, const std::string &modelDefinitionName)
	CTOR.
	DtTreeRecord (const DtTreeRecord &orig)
	Copy Constructor.
DtTreeRecord &	operator= (const DtTreeRecord &orig)
	Assignment operator.
bool	operator== (const DtTreeRecord &other) const
	Returns true if the two DtTreeRecords have the same UniqueId.
bool	operator< (const DtTreeRecord &other) const
	Returns true if the two this records UniqueId is less than other's UniqueId.
virtual	~DtTreeRecord ()
	Virtual DTOR.
virtual void	setUniqueId (DtUniqueID id)
	Set the UniqueId of the this DtTreeRecord.
virtual DtUniqueID	uniqueId () const
	Get uniqueId of this DtTreeRecord.
void	setCellID (DtUniqueID id)
	Set an optional cellID of the this DtTreeRecord.
DtUniqueID	cellId (void) const
	Get the optional cellID of the this DtTreeRecord.
virtual void	setPostion (const DtVector &pos)
	Set position of the tree in scene coordinates.
virtual const DtVector &	position () const
	Return the position of the tree in scene coordinates.
virtual void	setModelDefinition (const std::string &modelDef)
	Set the model definition name of the tree.
virtual const std::string &	modelDefinition () const
	Return the model definition name of the tree.
virtual void	setScale (float fScale)
virtual float	scale (void) const
virtual void	setOrientationDegrees (const DtDegrees &orientation)
virtual DtDegrees	orientationDegrees (void) const
virtual const std::string &	treeType () const
virtual void	setTreeType (const std::string &val)
virtual const DtQuaternion &	orientation () const
virtual void	setOrientation (const DtQuaternion &val)

Static Public Member Functions
static void	getRandomizedScale (float &fScale, float fMinScale, float fMaxScale, DtUniqueID id)
static void	getRandomizedOrientation (DtDegrees &orientation, DtUniqueID id)

Protected Member Functions
void	copyHelper (const DtTreeRecord &orig)
	Non virtual. Called by copy ctor and assignment operator.

Protected Attributes
DtUniqueID	myUniqueId
DtUniqueID	myCellId
DtVector	myPosition
std::string	myModelDefinition
float	myScale
DtDegrees	myOrientationDegrees
std::string	myTreeType
DtQuaternion	myOrientation

Detailed Description

A DtTreeRecord holds the requisite information needed to create a tree in a forest.

Constructor & Destructor Documentation

makVrv::DtTreeRecord::DtTreeRecord

(

)

CTOR.

makVrv::DtTreeRecord::DtTreeRecord	(	DtUniqueID	id,
		const DtVector &	pos,
		const std::string &	modelDefinitionName
	)

CTOR.

makVrv::DtTreeRecord::DtTreeRecord

(

const DtTreeRecord &

orig

)

Copy Constructor.

virtual makVrv::DtTreeRecord::~DtTreeRecord ( )

virtual

Virtual DTOR.

Member Function Documentation

DtTreeRecord& makVrv::DtTreeRecord::operator=

(

const DtTreeRecord &

orig

)

Assignment operator.

bool makVrv::DtTreeRecord::operator==

(

const DtTreeRecord &

other

)

const

Returns true if the two DtTreeRecords have the same UniqueId.

bool makVrv::DtTreeRecord::operator<

(

const DtTreeRecord &

other

)

const

Returns true if the two this records UniqueId is less than other's UniqueId.

virtual void makVrv::DtTreeRecord::setUniqueId ( DtUniqueID  id )

virtual

Set the UniqueId of the this DtTreeRecord.

virtual DtUniqueID makVrv::DtTreeRecord::uniqueId ( ) const

virtual

Get uniqueId of this DtTreeRecord.

void makVrv::DtTreeRecord::setCellID

(

DtUniqueID

id

)

Set an optional cellID of the this DtTreeRecord.

DtUniqueID makVrv::DtTreeRecord::cellId

(

void

)

const

Get the optional cellID of the this DtTreeRecord.

virtual void makVrv::DtTreeRecord::setPostion ( const DtVector &  pos )

virtual

Set position of the tree in scene coordinates.

virtual const DtVector& makVrv::DtTreeRecord::position ( ) const

virtual

Return the position of the tree in scene coordinates.

virtual void makVrv::DtTreeRecord::setModelDefinition ( const std::string &  modelDef )

virtual

Set the model definition name of the tree.

virtual const std::string& makVrv::DtTreeRecord::modelDefinition ( ) const

virtual

Return the model definition name of the tree.

virtual void makVrv::DtTreeRecord::setScale ( float  fScale )

virtual

virtual float makVrv::DtTreeRecord::scale ( void  ) const

virtual

virtual void makVrv::DtTreeRecord::setOrientationDegrees ( const DtDegrees &  orientation )

virtual

virtual DtDegrees makVrv::DtTreeRecord::orientationDegrees ( void  ) const

virtual

static void makVrv::DtTreeRecord::getRandomizedScale ( float &  fScale, float  fMinScale, float  fMaxScale, DtUniqueID  id  )

static

static void makVrv::DtTreeRecord::getRandomizedOrientation ( DtDegrees &  orientation, DtUniqueID  id  )

static

virtual const std::string& makVrv::DtTreeRecord::treeType ( ) const

virtual

virtual void makVrv::DtTreeRecord::setTreeType ( const std::string &  val )

virtual

virtual const DtQuaternion& makVrv::DtTreeRecord::orientation ( ) const

virtual

virtual void makVrv::DtTreeRecord::setOrientation ( const DtQuaternion &  val )

virtual

void makVrv::DtTreeRecord::copyHelper ( const DtTreeRecord &  orig )

protected

Non virtual. Called by copy ctor and assignment operator.

Member Data Documentation

DtUniqueID makVrv::DtTreeRecord::myUniqueId

protected

DtUniqueID makVrv::DtTreeRecord::myCellId

protected

DtVector makVrv::DtTreeRecord::myPosition

protected

std::string makVrv::DtTreeRecord::myModelDefinition

protected

float makVrv::DtTreeRecord::myScale

protected

DtDegrees makVrv::DtTreeRecord::myOrientationDegrees

protected

std::string makVrv::DtTreeRecord::myTreeType

protected

DtQuaternion makVrv::DtTreeRecord::myOrientation

protected

---

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

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.vrf4-6-branch/include/vrvCore/DtTreeRecord.h