DtMovementBasedTerrainPreloadControllerDescriptor Class Reference

Descriptor for the DtMovementBasedTerrainPreloadController class. More...

Inheritance diagram for DtMovementBasedTerrainPreloadControllerDescriptor:

List of all members.

Public Member Functions
	DtMovementBasedTerrainPreloadControllerDescriptor (const DtString &componentName, DtReaderWriterRegistry *parentRegistry=0)
	real constructor
	DtMovementBasedTerrainPreloadControllerDescriptor (const DtMovementBasedTerrainPreloadControllerDescriptor &orig, DtReaderWriterRegistry *parentRegistry=0)
	copy constructor
virtual	~DtMovementBasedTerrainPreloadControllerDescriptor ()
DtMovementBasedTerrainPreloadControllerDescriptor &	operator= (const DtMovementBasedTerrainPreloadControllerDescriptor &orig)
	assignment
virtual DtString	type () const
	Returns the type of component this descriptor describes.
virtual DtComponentDescriptor *	clone (DtReaderWriterRegistry *parentRegistry=0) const
virtual DtString	geometryType () const
	Accessor/mutator for myGeometryType.
virtual void	setGeometryType (const DtString &type)
	Accessor/mutator for myGeometryType.
virtual double	minPreloadDistance () const
	Accessor/mutator for #myMinPreloadRadius.
virtual void	setMinPreloadDistance (double distance)
	Accessor/mutator for #myMinPreloadRadius.
virtual double	maxPreloadDistance () const
	Accessor/mutator for #myMaxPreloadRadius.
virtual void	setMaxPreloadDistance (double distance)
	Accessor/mutator for #myMaxPreloadRadius.
Static Public Member Functions
static DtComponentDescriptor *	creator ()
Protected Member Functions
	DtMovementBasedTerrainPreloadControllerDescriptor ()
	default constructor; not implemented
Protected Attributes
parameters
These parameters are available for setting in the OPD files.
DtRwString	myGeometryType
	Parameter Name: geometry-type Parameter Description: Type of geometry used to define the preload for this entity.
DtRwReal	myMinPreloadDistance
	Parameter Name: min-preload-distance Parameter Description: Minimum distance from the entity to preload terrain.
DtRwReal	myMaxPreloadDistance
	Parameter Name: max-preload-distance Parameter Description: Maximum distance from the entity to preload terrain.

---

Detailed Description

Descriptor for the DtMovementBasedTerrainPreloadController class.

Contains parameters that can be specified in the parameter database for this controller.

---

Constructor & Destructor Documentation

DtMovementBasedTerrainPreloadControllerDescriptor::DtMovementBasedTerrainPreloadControllerDescriptor	(	const DtString &	componentName,
		DtReaderWriterRegistry *	parentRegistry = 0
	)

real constructor

DtMovementBasedTerrainPreloadControllerDescriptor::DtMovementBasedTerrainPreloadControllerDescriptor	(	const DtMovementBasedTerrainPreloadControllerDescriptor &	orig,
		DtReaderWriterRegistry *	parentRegistry = 0
	)

copy constructor

virtual DtMovementBasedTerrainPreloadControllerDescriptor::~DtMovementBasedTerrainPreloadControllerDescriptor

(

)

[virtual]

DtMovementBasedTerrainPreloadControllerDescriptor::DtMovementBasedTerrainPreloadControllerDescriptor

(

)

[protected]

default constructor; not implemented

---

Member Function Documentation

DtMovementBasedTerrainPreloadControllerDescriptor& DtMovementBasedTerrainPreloadControllerDescriptor::operator=

(

const DtMovementBasedTerrainPreloadControllerDescriptor &

orig

)

assignment

virtual DtString DtMovementBasedTerrainPreloadControllerDescriptor::type

(

)

const [virtual]

Returns the type of component this descriptor describes.

Used to create the descriptor on read from an mtl file. Component descriptor type strings are defined in compDescTypes.h.

Returns:

DtMovementBasedTerrainPreloadControllerDescriptorType

Reimplemented from DtTerrainPreloadControllerDescriptor.

virtual DtComponentDescriptor* DtMovementBasedTerrainPreloadControllerDescriptor::clone

(

DtReaderWriterRegistry *

parentRegistry = 0

)

const [virtual]

Reimplemented from DtTerrainPreloadControllerDescriptor.

static DtComponentDescriptor* DtMovementBasedTerrainPreloadControllerDescriptor::creator

(

)

[static]

Returns:

Newly created instance of this class, with an empty DtReaderWriter name. Creation methods are registered with a DtComponentDescriptorFactory, so they can be created on demand as they are read in from a parameter database file.

Reimplemented from DtTerrainPreloadControllerDescriptor.

virtual DtString DtMovementBasedTerrainPreloadControllerDescriptor::geometryType

(

)

const [virtual]

Accessor/mutator for myGeometryType.

virtual void DtMovementBasedTerrainPreloadControllerDescriptor::setGeometryType

(

const DtString &

type

)

[virtual]

Accessor/mutator for myGeometryType.

virtual double DtMovementBasedTerrainPreloadControllerDescriptor::minPreloadDistance

(

)

const [virtual]

Accessor/mutator for #myMinPreloadRadius.

virtual void DtMovementBasedTerrainPreloadControllerDescriptor::setMinPreloadDistance

(

double

distance

)

[virtual]

Accessor/mutator for #myMinPreloadRadius.

virtual double DtMovementBasedTerrainPreloadControllerDescriptor::maxPreloadDistance

(

)

const [virtual]

Accessor/mutator for #myMaxPreloadRadius.

virtual void DtMovementBasedTerrainPreloadControllerDescriptor::setMaxPreloadDistance

(

double

distance

)

[virtual]

Accessor/mutator for #myMaxPreloadRadius.

---

Member Data Documentation

DtRwString DtMovementBasedTerrainPreloadControllerDescriptor::myGeometryType [protected]

Parameter Name: geometry-type
Parameter Description: Type of geometry used to define the preload for this entity.

Parameter Values: "sphere" "chord" Parameter Default Value: "chord"

DtRwReal DtMovementBasedTerrainPreloadControllerDescriptor::myMinPreloadDistance [protected]

Parameter Name: min-preload-distance
Parameter Description: Minimum distance from the entity to preload terrain.

This distance will be used when the entity is stopped, or moving slowly. Parameter Units: meters Parameter Default Value: 2.0

DtRwReal DtMovementBasedTerrainPreloadControllerDescriptor::myMaxPreloadDistance [protected]

Parameter Name: max-preload-distance
Parameter Description: Maximum distance from the entity to preload terrain.

This will cap the preload distance to this value when the entity is moving quickly. Parameter Units: meters Parameter Default Value: 1000.0

---

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

• include/vrfobjparam/movementBasedTerrainPreloadControllerDescriptor.h