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.
const 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.
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	setOrientation (const DtDegrees &orientation)
virtual DtDegrees	orientation (void) const

Static Public Member Functions
static void	getRandomizedScaleAndOrientation (float &fScale, DtDegrees &orientation, DtUniqueID id)

Protected Types
typedef boost::mt19937	RandomGenEngine
typedef boost::uniform_real	RandomDistributionTypeForScale
typedef boost::variate_generator < RandomGenEngine, RandomDistributionTypeForScale >	RandomGeneratorForScale
typedef boost::uniform_int	RandomDistributionTypeForOrientation
typedef boost::variate_generator < RandomGenEngine, RandomDistributionTypeForOrientation >	RandomGeneratorForOrientation

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

Protected Attributes
DtUniqueID	myUniqueId
DtVector	myPosition
std::string	myModelDefinition
float	myScale
DtDegrees	myOrientation

Static Protected Attributes
static RandomGenEngine	myRandomGenEngine
static RandomDistributionTypeForScale	myRandomDistributionTypeForScale
static RandomGeneratorForScale	myRandomGeneratorScale
static RandomDistributionTypeForOrientation	myRandomDistributionTypeForOrientation
static RandomGeneratorForOrientation	myRandomGeneratorOrientation

Detailed Description

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

Member Typedef Documentation

typedef boost::mt19937 makVrv::DtTreeRecord::RandomGenEngine

protected

typedef boost::uniform_real makVrv::DtTreeRecord::RandomDistributionTypeForScale

protected

typedef boost::variate_generator<RandomGenEngine,RandomDistributionTypeForScale> makVrv::DtTreeRecord::RandomGeneratorForScale

protected

typedef boost::uniform_int makVrv::DtTreeRecord::RandomDistributionTypeForOrientation

protected

typedef boost::variate_generator<RandomGenEngine,RandomDistributionTypeForOrientation> makVrv::DtTreeRecord::RandomGeneratorForOrientation

protected

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

const 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.

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::setOrientation ( const DtDegrees &  orientation )

virtual

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

virtual

static void makVrv::DtTreeRecord::getRandomizedScaleAndOrientation ( float &  fScale, DtDegrees &  orientation, DtUniqueID  id  )

static

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

DtVector makVrv::DtTreeRecord::myPosition

protected

std::string makVrv::DtTreeRecord::myModelDefinition

protected

float makVrv::DtTreeRecord::myScale

protected

DtDegrees makVrv::DtTreeRecord::myOrientation

protected

RandomGenEngine makVrv::DtTreeRecord::myRandomGenEngine

staticprotected

RandomDistributionTypeForScale makVrv::DtTreeRecord::myRandomDistributionTypeForScale

staticprotected

RandomGeneratorForScale makVrv::DtTreeRecord::myRandomGeneratorScale

staticprotected

RandomDistributionTypeForOrientation makVrv::DtTreeRecord::myRandomDistributionTypeForOrientation

staticprotected

RandomGeneratorForOrientation makVrv::DtTreeRecord::myRandomGeneratorOrientation

staticprotected

---

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

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.tot/include/vrvCore/DtTreeRecord.h