DtCulturalFeatureSetController Class Reference

DtCulturalFeatureSetController is a controller component responsible for handling DtSetDataRequests for cultural features. More...

Inheritance diagram for DtCulturalFeatureSetController:

List of all members.

Public Member Functions
	DtCulturalFeatureSetController (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
	(const DtString&,DtVrfObject*,DtSimManager*,
virtual	~DtCulturalFeatureSetController ()
	destructor
virtual DtString	type () const
	Returns a string identifies the class type of component.
virtual void	processSetAltitude (DtSimMessage *msg)
Static Public Member Functions
static DtSimComponent *	creator (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
	(const DtString&,DtVrfObject*,DtSimManager*,
Protected Member Functions
	DtCulturalFeatureSetController ()
	default constructor; should not be called.
	DtCulturalFeatureSetController (const DtCulturalFeatureSetController &orig)
	copy constructor
const DtCulturalFeatureSetController &	operator= (const DtCulturalFeatureSetController &orig)
	assignment operator

---

Detailed Description

DtCulturalFeatureSetController is a controller component responsible for handling DtSetDataRequests for cultural features.

End User Description: The DtCulturalFeatureSetController controller component handles all of DtSetDataRequest messages that the DtLocalEntitySetController, but handles DtSetAltitudeRequests in a way more appropriate for cultural features. Specifically, it handles set altitude requests differently. If the cultural feature is gravity aligned, then it does not clamp to terrain. Otherwise, it does.

Developer Description: Instances of DtCulturalFeatureSetController derive from DtLocalEntitySetController, which register for all the set messages that affect a local entity and set the state repository as appropriate. In addition, it registers for and processes set altitude messages. When it receives a set altitude message, if the cultural feature is configured to be gravity-aligned (it checks its state repository), then it respects the altitude in the message. Otherwise, it clamps to the ground.

Uses Descriptor Type: DtComponentDescriptor

---

Constructor & Destructor Documentation

DtCulturalFeatureSetController::DtCulturalFeatureSetController	(	const DtString &	name,
		DtVrfObject *	owner,
		DtSimManager *	simManager,
		DtComponentDescriptor *	desc = 0,
		DtReaderWriterRegistry *	parentRegistry = 0
	)

(const DtString&,DtVrfObject*,DtSimManager*,

Parameters:

name	Reader writer name of this component.
owner	The DtVrfObject that owns this component
simManager	The simulation manager (provides access to terrain, message interface, simulation clock).
desc	The component descriptor used to initialize this component.
parentRegistry	Pointer to the parent reader writer registry (the containing object that reads/writes this object).

(const DtString&,DtVrfObject*,DtSimManager*, DtComponentDescriptor*,DtReaderWriterRegistry* parentRegistry)

virtual DtCulturalFeatureSetController::~DtCulturalFeatureSetController

(

)

[virtual]

destructor

DtCulturalFeatureSetController::DtCulturalFeatureSetController

(

)

[protected]

default constructor; should not be called.

Here because the compiler will generate an unprotected one otherwise.

DtCulturalFeatureSetController::DtCulturalFeatureSetController

(

const DtCulturalFeatureSetController &

orig

)

[protected]

copy constructor

---

Member Function Documentation

virtual DtString DtCulturalFeatureSetController::type

(

)

const [virtual]

Returns a string identifies the class type of component.

Type values are defined in compTypes.h. DtSimComponent creation functions are registered with the DtSimComponentFactory using the type values as the key.

Returns:

DtCulturalFeatureSetControllerType

Reimplemented from DtLocalEntitySetController.

virtual void DtCulturalFeatureSetController::processSetAltitude

(

DtSimMessage *

msg

)

[virtual]

Reimplemented from DtLocalEntitySetController.

static DtSimComponent* DtCulturalFeatureSetController::creator	(	const DtString &	name,
		DtVrfObject *	owner,
		DtSimManager *	simManager,
		DtComponentDescriptor *	desc = 0,
		DtReaderWriterRegistry *	parentRegistry = 0
	)		[static]

(const DtString&,DtVrfObject*,DtSimManager*,

Parameters:

name	Reader writer name of this component.
owner	The DtVrfObject that owns this component
simManager	The simulation manager (provides access to terrain, message interface, simulation clock).
desc	The component descriptor used to initialize this component.
parentRegistry	Pointer to the parent reader writer registry (the containing object that reads/writes this object).

(const DtString&,DtVrfObject*,DtSimManager*, DtComponentDescriptor*,DtReaderWriterRegistry* parentRegistry)

Returns:

New instance of this class.

Reimplemented from DtLocalEntitySetController.

const DtCulturalFeatureSetController& DtCulturalFeatureSetController::operator=

(

const DtCulturalFeatureSetController &

orig

)

[protected]

assignment operator

---

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

• include/vrfmodel/culturalFeatureSetCtlr.h