makVrv::DtTerrainTreeSettings Class Reference

Class for setting and maintaining state for user-modifiable TerrainTree settings All of the TerrainTree-changing calls in the UI go through this, so that saving this class provides enough information to restore all of the TerrainTree settings to a terrain patch. More...

Public Member Functions
DtTerrainPatch *	patch ()
	Get associated terrain patch.
	~DtTerrainTreeSettings ()
	DTOR.
void	getRecord (makArchives::DtTerrainTreeSettingsRecord &rec) const
	Fill out a makArchives::DtTerrainTreeSettingsRecord with the values of this object.
void	setFromRecord (const makArchives::DtTerrainTreeSettingsRecord &rec)
	Fill out this object with the values of a makArchives::DtTerrainTreeSettingsRecord.
Tree Randomization Settings
bool	treeScaleRandomizationEnabled () const
	Returns whether tree scale randomization is enabled.
bool	treeOrientationRandomizationEnabled () const
	Returns whether tree orientation randomization is enabled.
double	treeMinScale () const
	Returns tree min scale.
double	treeMaxScale () const
	Returns tree max scale.
void	setTreeScaleRandomizationEnabled (bool enabled)
	Sets whether tree scale randomization is enabled.
void	setTreeOrientationRandomizationEnabled (bool enabled)
	Sets whether tree orientation randomization is enabled.
void	setTreeMinScale (double minScale)
	Sets minimum scale for trees.
void	setTreeMaxScale (double maxScale)
	Sets maximum scale for trees.

Protected Member Functions
	DtTerrainTreeSettings (DtTerrainPatch *patch=0)
	CTOR.
DtTerrainTreeSettings &	operator= (const DtTerrainTreeSettings &orig)
	Assignment operator Note that this does NOT change what patch is associated with the DtTerrainTreeSettings.
void	setPatch (DtTerrainPatch *patch)
	Set associated terrain patch and apply current TerrainTree settings to it This should only be called by the associated terrain patch to avoid situations where the patch doesn't know about it!
void	applyAllSettings ()
void	applyTerrainTreeSettings ()

Protected Attributes
DtTerrainPatch *	myPatch
makArchives::DtTerrainTreeSettingsRecord	myTerrainTreeSettingsRecord

Friends
class	DtTerrainPatch

Detailed Description

Class for setting and maintaining state for user-modifiable TerrainTree settings All of the TerrainTree-changing calls in the UI go through this, so that saving this class provides enough information to restore all of the TerrainTree settings to a terrain patch.

Constructor & Destructor Documentation

makVrv::DtTerrainTreeSettings::DtTerrainTreeSettings ( DtTerrainPatch *  patch = 0 )

explicitprotected

CTOR.

makVrv::DtTerrainTreeSettings::~DtTerrainTreeSettings

(

)

DTOR.

Member Function Documentation

DtTerrainTreeSettings& makVrv::DtTerrainTreeSettings::operator= ( const DtTerrainTreeSettings &  orig )

protected

Assignment operator Note that this does NOT change what patch is associated with the DtTerrainTreeSettings.

It only assigns all of the configuration from the source TerrainTree settings. To set the patch afterwards, use setPatch()

void makVrv::DtTerrainTreeSettings::setPatch ( DtTerrainPatch *  patch )

protected

Set associated terrain patch and apply current TerrainTree settings to it This should only be called by the associated terrain patch to avoid situations where the patch doesn't know about it!

DtTerrainPatch* makVrv::DtTerrainTreeSettings::patch

(

)

Get associated terrain patch.

void makVrv::DtTerrainTreeSettings::getRecord

(

makArchives::DtTerrainTreeSettingsRecord &

rec

)

const

Fill out a makArchives::DtTerrainTreeSettingsRecord with the values of this object.

void makVrv::DtTerrainTreeSettings::setFromRecord

(

const makArchives::DtTerrainTreeSettingsRecord &

rec

)

Fill out this object with the values of a makArchives::DtTerrainTreeSettingsRecord.

bool makVrv::DtTerrainTreeSettings::treeScaleRandomizationEnabled

(

)

const

Returns whether tree scale randomization is enabled.

bool makVrv::DtTerrainTreeSettings::treeOrientationRandomizationEnabled

(

)

const

Returns whether tree orientation randomization is enabled.

double makVrv::DtTerrainTreeSettings::treeMinScale

(

)

const

Returns tree min scale.

double makVrv::DtTerrainTreeSettings::treeMaxScale

(

)

const

Returns tree max scale.

void makVrv::DtTerrainTreeSettings::setTreeScaleRandomizationEnabled

(

bool

enabled

)

Sets whether tree scale randomization is enabled.

void makVrv::DtTerrainTreeSettings::setTreeOrientationRandomizationEnabled

(

bool

enabled

)

Sets whether tree orientation randomization is enabled.

void makVrv::DtTerrainTreeSettings::setTreeMinScale

(

double

minScale

)

Sets minimum scale for trees.

void makVrv::DtTerrainTreeSettings::setTreeMaxScale

(

double

maxScale

)

Sets maximum scale for trees.

void makVrv::DtTerrainTreeSettings::applyAllSettings ( )

protected

void makVrv::DtTerrainTreeSettings::applyTerrainTreeSettings ( )

protected

Friends And Related Function Documentation

friend class DtTerrainPatch

friend

Member Data Documentation

DtTerrainPatch* makVrv::DtTerrainTreeSettings::myPatch

protected

makArchives::DtTerrainTreeSettingsRecord makVrv::DtTerrainTreeSettings::myTerrainTreeSettingsRecord

protected

---

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

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.vrf4-4-branch/include/vrvCore/DtTerrainTreeSettings.h