DtCulturalFeatureParameters Class Reference

Contains the set of readable/writeable parameters associated with a cultural feature entity. More...

Inheritance diagram for DtCulturalFeatureParameters:

List of all members.

Public Member Functions
	DtCulturalFeatureParameters (const DtString &name=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=NULL)
	Constructor with parameters to set up read/writability correctly.
	DtCulturalFeatureParameters (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL)
const DtCulturalFeatureParameters &	operator= (const DtCulturalFeatureParameters &orig)
virtual	~DtCulturalFeatureParameters ()
	destructor
virtual DtVrfObjectParameters *	clone (const DtString &name=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=NULL) const
virtual DtVrfObjectParameters *	clone (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL) const
virtual bool	inheritValues (const DtVrfObjectParameters *benefactor)
	Values left unspecified may be inherited from a parameter block of the same type, typically an ancestor in the DIS/RPR entity type hierarchy. (
virtual DtString	type () const
	Should return the type of entity this is a parameter block for.
virtual void	inheritValuesFromThisType (const DtCulturalFeatureParameters *benefactor)
virtual bool	gravityAligned () const
	Accessor for myGravityAligned. Objects that are gravity aligned do no clamp to the terrain.
Static Public Member Functions
static DtVrfObjectParameters *	creator ()
Protected Member Functions
	DtCulturalFeatureParameters (const DtCulturalFeatureParameters &orig, const DtString &name=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=NULL)
	copy constructor
	DtCulturalFeatureParameters (const DtCulturalFeatureParameters &orig, const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL)
Protected Attributes
Parameters
These parameters are available for setting in the OPD files.
DtRwBoolean	myGravityAligned
	Parameter Name: gravity-aligned Parameter Description: Whether or not object clamps to the terrain.

---

Detailed Description

Contains the set of readable/writeable parameters associated with a cultural feature entity.

Developer Description: Used to hold parameters for the DtCulturalFeatureStateRepository class.

---

Constructor & Destructor Documentation

DtCulturalFeatureParameters::DtCulturalFeatureParameters	(	const DtString &	name = DtString::nullString(),
		DtReaderWriterRegistry *	parentRegistry = NULL
	)

Constructor with parameters to set up read/writability correctly.

DtCulturalFeatureParameters::DtCulturalFeatureParameters	(	const DtSymbolString &	name,
		DtReaderWriterRegistry *	parentRegistry = NULL
	)

DtCulturalFeatureParameters::DtCulturalFeatureParameters	(	const DtCulturalFeatureParameters &	orig,
		const DtString &	name = DtString::nullString(),
		DtReaderWriterRegistry *	parentRegistry = NULL
	)		[protected]

copy constructor

DtCulturalFeatureParameters::DtCulturalFeatureParameters	(	const DtCulturalFeatureParameters &	orig,
		const DtSymbolString &	name,
		DtReaderWriterRegistry *	parentRegistry = NULL
	)		[protected]

virtual DtCulturalFeatureParameters::~DtCulturalFeatureParameters

(

)

[virtual]

destructor

---

Member Function Documentation

const DtCulturalFeatureParameters& DtCulturalFeatureParameters::operator=

(

const DtCulturalFeatureParameters &

orig

)

virtual DtVrfObjectParameters* DtCulturalFeatureParameters::clone	(	const DtString &	name = DtString::nullString(),
		DtReaderWriterRegistry *	parentRegistry = NULL
	)		const [virtual]

Reimplemented from DtMovingObjectParameters.

virtual DtVrfObjectParameters* DtCulturalFeatureParameters::clone	(	const DtSymbolString &	name,
		DtReaderWriterRegistry *	parentRegistry = NULL
	)		const [virtual]

Reimplemented from DtMovingObjectParameters.

virtual bool DtCulturalFeatureParameters::inheritValues

(

const DtVrfObjectParameters *

benefactor

)

[virtual]

Values left unspecified may be inherited from a parameter block of the same type, typically an ancestor in the DIS/RPR entity type hierarchy. (

For example, US ground vehicle (1 1 225 0 0 0 0) and US Large wheeled utility vehicle (1 1 225 7 0 0 0) might both have DtGroundVehicleParameters parameter blocks. If some or even all parameters are left unspecified for (1 1 225 7 0 0 0), it can inherit them from (1 1 225 0 0 0 0), its DIS/RPR ancestor.
The direct ancestor of a parameter block might use a parameter type that is different (and most likely a class the parameter block is derived from). Every parameter block type also knows how to inherit from the type it is derived from. ( const DtVrfObjectParameters* benefactor)

Reimplemented from DtMovingObjectParameters.

virtual bool DtCulturalFeatureParameters::gravityAligned

(

)

const [virtual]

Accessor for myGravityAligned. Objects that are gravity aligned do no clamp to the terrain.

virtual DtString DtCulturalFeatureParameters::type

(

)

const [virtual]

Should return the type of entity this is a parameter block for.

Use the strings in vrfParamTypes.h.

Reimplemented from DtMovingObjectParameters.

virtual void DtCulturalFeatureParameters::inheritValuesFromThisType

(

const DtCulturalFeatureParameters *

benefactor

)

[virtual]

static DtVrfObjectParameters* DtCulturalFeatureParameters::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 DtMovingObjectParameters.

---

Member Data Documentation

DtRwBoolean DtCulturalFeatureParameters::myGravityAligned [protected]

Parameter Name: gravity-aligned
Parameter Description: Whether or not object clamps to the terrain.

If true, it does not

---

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

• include/vrfobjparam/culturalFeaturePar.h