VR-Forces 4.0.4 Class Documentation
Public Member Functions | Protected Member Functions | Protected Attributes
makVrv::DtTreeRecord Class Reference

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

List of all members.

Public Member Functions

 DtTreeRecord ()
 CTOR.
 DtTreeRecord (DtUniqueID id, const DtVector &pos, const std::string &modelDefinitionName)
 CTOR.
 DtTreeRecord (const DtTreeRecord &orig)
 Copy Constructor.
const DtTreeRecordoperator= (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 DtVectorposition () 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.

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

Detailed Description

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


Constructor & Destructor Documentation

CTOR.

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

CTOR.

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.

void makVrv::DtTreeRecord::copyHelper ( const DtTreeRecord orig) [protected]

Non virtual. Called by copy ctor and assignment operator.


Member Data Documentation

std::string makVrv::DtTreeRecord::myModelDefinition [protected]

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

Document ID: Generated on Fri Jun 29 16:33:32 EDT 2012 from SVN revision 116588
Copyright © 2005-2012 VT MÄK Inc. All Rights Reserved (www.mak.com)