makVrv::DtForestObject Class Reference

DtForestObject provides a way to make lots of trees. More...

Inheritance diagram for makVrv::DtForestObject:

Public Types
typedef boost::unordered_map < DtUniqueID, DtTreeRecord >	TreeRecordMap
typedef boost::unordered_map < std::string, DtTreeModel * >	TreeModelMap

Public Member Functions
virtual	~DtForestObject ()
	Destructor.
virtual DtDe &	de ()
	IG accessor.
Driver bound methods
These methods are bound to the driver.
void	addTree (const DtTreeRecord &record)
	Add a tree to the forest.
virtual void	removeTree (DtUniqueID treeId)=0
	Remove a tree from the forest.
virtual void	removeAllTrees ()=0
	Remove all trees.
virtual void	setTreeClippingPlane (float fFar)=0
	Set the distance that trees are clipped.
virtual void	getTreeClippingPlane (float &fFar)=0
	Get the clipping planes.
virtual void	setTree3DLodDistances (float fNear, float fFar)=0
	Set the distances for tree LOD's.
virtual void	getTree3DLodDistances (float &fNear, float &fFar)=0
	Set the distances for tree LOD's.
virtual void	setTreeBillboardDistances (float fStart, float fEnd)=0
	Set the distances for tree billboard LOD's.
virtual void	getTreeBillboardDistances (float &fStart, float &fEnd)=0
	Get the distances for tree billboard LOD's.
Unbound methods
These methods are NOT bound to the driver.
virtual void	addUniqueTree (const DtTreeRecord &record)=0
	Add a tree to the forest.
virtual DtTreeRecord *	findTreeRecord (DtUniqueID id)=0
	Find a DtTreeRecord based on it's id.
virtual DtTreeModel *	findTreeModel (const std::string &modelDef)=0
	Find a DtTreeModel from a model definition name.
virtual DtModelInstance *	findModelInstance (const std::string &modelDef)=0
	Find a DtModelInstance from a model definition name.
virtual DtModelDefinition *	findModelDefinition (const std::string &modelDef)
	Find a DtModelDefinition* from the model definition name.
virtual const TreeRecordMap &	treeRecordMap () const
	Return the treeRecordMap.

Protected Member Functions
	DtForestObject (DtDe &de, DtUniqueID id)
	Constructor is protected because this class is created via the creator pattern.
virtual bool	createTree (const DtTreeRecord &record)=0
	Create a Tree instance.
virtual void	slot_treeModelInstanceToBeDestroyed (const std::string &modelDef)=0
	Called when the model instance for a particular model definition is about to be destroyed.
virtual void	removeTreeModel (const std::string &modelDef)=0
	Remove a DtTreeModel of a particular model definition.
virtual void	slot_treeModelInstanceCreated (const std::string &modelDef)=0
	Called when the model instance for a particular model definition is created.
virtual DtTreeModel *	castUpdaterToTreeModel (DtAgentUpdateResolverInterface *updater)
	Casts a DtAgentUpdateResolverInterface to a DtTreeModel.

Protected Attributes
DtDe &	myDe
TreeRecordMap	myTreeRecordMap
TreeModelMap	myTreeModelMap

Friends
class	DtForestObjectClassesCreator
	This allows the protected constructor to be called by the DtForestCreator(2).
class	DtForestCreator

Detailed Description

DtForestObject provides a way to make lots of trees.

Member Typedef Documentation

typedef boost::unordered_map<DtUniqueID, DtTreeRecord> makVrv::DtForestObject::TreeRecordMap

typedef boost::unordered_map<std::string, DtTreeModel*> makVrv::DtForestObject::TreeModelMap

Constructor & Destructor Documentation

virtual makVrv::DtForestObject::~DtForestObject ( )

virtual

Destructor.

makVrv::DtForestObject::DtForestObject ( DtDe &  de, DtUniqueID  id  )

protected

Constructor is protected because this class is created via the creator pattern.

Member Function Documentation

void makVrv::DtForestObject::addTree

(

const DtTreeRecord &

record

)

Add a tree to the forest.

Non virtual. Calls virtual method addUniqueTree().

virtual void makVrv::DtForestObject::removeTree ( DtUniqueID  treeId )

pure virtual

Remove a tree from the forest.

Implemented in makVrv::DtSpeedTreeForest, and makVrv::DtOsgForest.

virtual void makVrv::DtForestObject::removeAllTrees ( )

pure virtual

Remove all trees.

Implemented in makVrv::DtOsgForest.

virtual void makVrv::DtForestObject::setTreeClippingPlane ( float  fFar )

pure virtual

Set the distance that trees are clipped.

Not implemented in DtOsgForest (only DtSpeedTreeForest).

Implemented in makVrv::DtOsgForest, and makVrv::DtSpeedTreeForest.

virtual void makVrv::DtForestObject::getTreeClippingPlane ( float &  fFar )

pure virtual

Get the clipping planes.

Implemented in makVrv::DtOsgForest.

virtual void makVrv::DtForestObject::setTree3DLodDistances ( float  fNear, float  fFar  )

pure virtual

Set the distances for tree LOD's.

Not implemented in DtOsgForest (only DtSpeedTreeForest).

Implemented in makVrv::DtOsgForest, and makVrv::DtSpeedTreeForest.

virtual void makVrv::DtForestObject::getTree3DLodDistances ( float &  fNear, float &  fFar  )

pure virtual

Set the distances for tree LOD's.

Not implemented in DtOsgForest (only DtSpeedTreeForest).

Implemented in makVrv::DtOsgForest.

virtual void makVrv::DtForestObject::setTreeBillboardDistances ( float  fStart, float  fEnd  )

pure virtual

Set the distances for tree billboard LOD's.

Not implemented in DtOsgForest (only DtSpeedTreeForest).

Implemented in makVrv::DtOsgForest, and makVrv::DtSpeedTreeForest.

virtual void makVrv::DtForestObject::getTreeBillboardDistances ( float &  fStart, float &  fEnd  )

pure virtual

Get the distances for tree billboard LOD's.

Not implemented in DtOsgForest (only DtSpeedTreeForest).

Implemented in makVrv::DtOsgForest.

virtual void makVrv::DtForestObject::addUniqueTree ( const DtTreeRecord &  record )

pure virtual

Add a tree to the forest.

Implemented in makVrv::DtOsgForest, and makVrv::DtSpeedTreeForest.

virtual DtTreeRecord* makVrv::DtForestObject::findTreeRecord ( DtUniqueID  id )

pure virtual

Find a DtTreeRecord based on it's id.

Implemented in makVrv::DtOsgForest.

virtual DtTreeModel* makVrv::DtForestObject::findTreeModel ( const std::string &  modelDef )

pure virtual

Find a DtTreeModel from a model definition name.

Implemented in makVrv::DtOsgForest.

virtual DtModelInstance* makVrv::DtForestObject::findModelInstance ( const std::string &  modelDef )

pure virtual

Find a DtModelInstance from a model definition name.

Implemented in makVrv::DtOsgForest.

virtual DtModelDefinition* makVrv::DtForestObject::findModelDefinition ( const std::string &  modelDef )

virtual

Find a DtModelDefinition* from the model definition name.

virtual const TreeRecordMap& makVrv::DtForestObject::treeRecordMap ( ) const

virtual

Return the treeRecordMap.

virtual DtDe& makVrv::DtForestObject::de ( )

virtual

IG accessor.

virtual bool makVrv::DtForestObject::createTree ( const DtTreeRecord &  record )

protectedpure virtual

Create a Tree instance.

Implemented in makVrv::DtOsgForest, and makVrv::DtSpeedTreeForest.

virtual void makVrv::DtForestObject::slot_treeModelInstanceToBeDestroyed ( const std::string &  modelDef )

protectedpure virtual

Called when the model instance for a particular model definition is about to be destroyed.

Implemented in makVrv::DtOsgForest, and makVrv::DtSpeedTreeForest.

virtual void makVrv::DtForestObject::removeTreeModel ( const std::string &  modelDef )

protectedpure virtual

Remove a DtTreeModel of a particular model definition.

Implemented in makVrv::DtOsgForest.

virtual void makVrv::DtForestObject::slot_treeModelInstanceCreated ( const std::string &  modelDef )

protectedpure virtual

Called when the model instance for a particular model definition is created.

Implemented in makVrv::DtOsgForest, and makVrv::DtSpeedTreeForest.

virtual DtTreeModel* makVrv::DtForestObject::castUpdaterToTreeModel ( DtAgentUpdateResolverInterface *  updater )

protectedvirtual

Casts a DtAgentUpdateResolverInterface to a DtTreeModel.

Reimplemented in makVrv::DtSpeedTreeForest.

Friends And Related Function Documentation

friend class DtForestObjectClassesCreator

friend

This allows the protected constructor to be called by the DtForestCreator(2).

friend class DtForestCreator

friend

Member Data Documentation

DtDe& makVrv::DtForestObject::myDe

protected

TreeRecordMap makVrv::DtForestObject::myTreeRecordMap

protected

TreeModelMap makVrv::DtForestObject::myTreeModelMap

mutableprotected

---

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

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