DtTerrainPreloadControllerDescriptor Class Reference

Base class for the preload controller descriptors. More...

Inheritance diagram for DtTerrainPreloadControllerDescriptor:

List of all members.

Public Member Functions
	DtTerrainPreloadControllerDescriptor (const DtString &componentName, DtReaderWriterRegistry *parentRegistry=0)
	real constructor
	DtTerrainPreloadControllerDescriptor (const DtTerrainPreloadControllerDescriptor &orig, DtReaderWriterRegistry *parentRegistry=0)
	copy constructor
virtual	~DtTerrainPreloadControllerDescriptor ()
DtTerrainPreloadControllerDescriptor &	operator= (const DtTerrainPreloadControllerDescriptor &orig)
	assignment
virtual DtString	type () const
	Returns the type of component this descriptor describes.
virtual DtComponentDescriptor *	clone (DtReaderWriterRegistry *parentRegistry=0) const
virtual int	preloadPriority () const
	Accessor/mutator for myPreloadPriority.
virtual void	setPreloadPriority (const int &priority)
	Accessor/mutator for myPreloadPriority.
Static Public Member Functions
static DtComponentDescriptor *	creator ()
Protected Member Functions
	DtTerrainPreloadControllerDescriptor ()
	default constructor; not implemented
Protected Attributes
parameters
These parameters are available for setting in the OPD files.
DtRwInt	myPreloadPriority
	Parameter Name: preload-priority Parameter Description: Priority of preload commands generated by this entity relative to other terrain paging commands.

---

Detailed Description

Base class for the preload controller descriptors.

Contains parameters that can be specified in the parameter database.

---

Constructor & Destructor Documentation

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

real constructor

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

copy constructor

virtual DtTerrainPreloadControllerDescriptor::~DtTerrainPreloadControllerDescriptor

(

)

[virtual]

DtTerrainPreloadControllerDescriptor::DtTerrainPreloadControllerDescriptor

(

)

[protected]

default constructor; not implemented

---

Member Function Documentation

DtTerrainPreloadControllerDescriptor& DtTerrainPreloadControllerDescriptor::operator=

(

const DtTerrainPreloadControllerDescriptor &

orig

)

assignment

virtual DtString DtTerrainPreloadControllerDescriptor::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:

DtTerrainPreloadControllerDescriptorType

Reimplemented from DtComponentDescriptor.

Reimplemented in DtMovementBasedTerrainPreloadControllerDescriptor.

virtual DtComponentDescriptor* DtTerrainPreloadControllerDescriptor::clone

(

DtReaderWriterRegistry *

parentRegistry = 0

)

const [virtual]

Reimplemented from DtComponentDescriptor.

Reimplemented in DtMovementBasedTerrainPreloadControllerDescriptor.

static DtComponentDescriptor* DtTerrainPreloadControllerDescriptor::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 DtComponentDescriptor.

Reimplemented in DtMovementBasedTerrainPreloadControllerDescriptor.

virtual int DtTerrainPreloadControllerDescriptor::preloadPriority

(

)

const [virtual]

Accessor/mutator for myPreloadPriority.

virtual void DtTerrainPreloadControllerDescriptor::setPreloadPriority

(

const int &

priority

)

[virtual]

Accessor/mutator for myPreloadPriority.

---

Member Data Documentation

DtRwInt DtTerrainPreloadControllerDescriptor::myPreloadPriority [protected]

Parameter Name: preload-priority
Parameter Description: Priority of preload commands generated by this entity relative to other terrain paging commands.

Lower numbers == higher priority. See config/terrainOptions.mtl for more information on priorities. Parameter Units: N/A Parameter Default Value: 30

---

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

• include/vrfobjparam/terrainPreloadControllerDescriptor.h