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

Public Member Functions
virtual	~DtForestObject ()
	Destructor. More...
virtual DtDe &	de ()
	IG accessor. More...
Driver bound methods
These methods are bound to the driver.
virtual void	addUniqueTree (DtTreeRecord &record)=0
	Add a tree to the forest. More...
virtual void	removeTree (DtUniqueID treeId)=0
	Remove a tree from the forest. More...
virtual void	removeAllTrees ()=0
	Remove all trees. More...
virtual void	setTreeClippingPlane (float fFar)=0
	Set the distance that trees are clipped. More...
virtual void	getTreeClippingPlane (float &fFar)=0
	Get the clipping planes. More...
virtual void	setTree3DLodDistances (float fNear, float fFar)=0
	Set the distances for tree LOD's. More...
virtual void	getTree3DLodDistances (float &fNear, float &fFar)=0
	Set the distances for tree LOD's. More...
virtual void	setTreeBillboardDistances (float fStart, float fEnd)=0
	Set the distances for tree billboard LOD's. More...
virtual void	getTreeBillboardDistances (float &fStart, float &fEnd)=0
	Get the distances for tree billboard LOD's. More...
virtual void	setBillboardFadeOutRange (float fRange)=0
	set the fade out distance for the billboards. The Range - Cull distance = start transition dist More...
virtual void	getBillboardFadeOutRange (float &fRange)=0
	get the fade out distance for the billboards. The Range - Cull distance = start transition dist More...
void	addTree (DtTreeRecord &record)
	Add a tree to the forest. More...

Protected Member Functions
	DtForestObject (DtDe &de, DtUniqueID id)
	Constructor is protected because this class is created via the creator pattern. More...

Protected Attributes
DtDe &	myDe

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

Detailed Description

DtForestObject provides a way to make lots of trees.

Member Typedef Documentation

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

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

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

pure virtual

Add a tree to the forest.

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

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::DtSpeedTreeForest, and 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::DtSpeedTreeForest, and makVrv::DtOsgForest.

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

pure virtual

Get the clipping planes.

Implemented in makVrv::DtSpeedTreeForest, and 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::DtSpeedTreeForest, and makVrv::DtOsgForest.

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::DtSpeedTreeForest, and 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::DtSpeedTreeForest, and makVrv::DtOsgForest.

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::DtSpeedTreeForest, and makVrv::DtOsgForest.

virtual void makVrv::DtForestObject::setBillboardFadeOutRange ( float  fRange )

pure virtual

set the fade out distance for the billboards. The Range - Cull distance = start transition dist

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

virtual void makVrv::DtForestObject::getBillboardFadeOutRange ( float &  fRange )

pure virtual

get the fade out distance for the billboards. The Range - Cull distance = start transition dist

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

void makVrv::DtForestObject::addTree

(

DtTreeRecord &

record

)

Add a tree to the forest.

Non virtual. Calls virtual method addUniqueTree().

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

virtual

IG accessor.

Friends And Related Function Documentation

friend class DtForestObjectClassesCreator

friend

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

friend class DtForestObjectCreator

friend

Member Data Documentation

DtDe& makVrv::DtForestObject::myDe

protected

---

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

• /data/exports/nrhent7-1/nightly/docs/vrForces.vrf4-10-branch/include/vrvCore/DtForestObject.h