DtObstructionSensorDescriptor Class Reference

DtObstructionSensorDescriptor is a DtComponentDescriptor that has the name of the DtObstructionSensor (if any) being used by this entity. More...

Inheritance diagram for DtObstructionSensorDescriptor:

List of all members.

Public Member Functions
	DtObstructionSensorDescriptor (const DtString &name, DtReaderWriterRegistry *parentRegistry=0)
	real constructor
	DtObstructionSensorDescriptor (const DtObstructionSensorDescriptor &orig, DtReaderWriterRegistry *parentRegistry=0)
	copy constructor
DtObstructionSensorDescriptor &	operator= (const DtObstructionSensorDescriptor &orig)
	assignment
virtual	~DtObstructionSensorDescriptor ()
	destructor
virtual DtString	type () const
	Returns the type of component this descriptor describes.
virtual DtComponentDescriptor *	clone (DtReaderWriterRegistry *parentRegistry=0) const
	returns a clone of this DtObstructionSensorDescriptor
virtual void	setStoppingDistanceFactor (DtReal distance)
	Accessor/mutator for myStoppingDistanceFactor.
virtual DtReal	stoppingDistanceFactor () const
	Accessor/mutator for myStoppingDistanceFactor.
virtual void	setLateralClearance (DtReal distance)
	Accessor/mutator for myLateralClearance.
virtual DtReal	lateralClearance () const
	Accessor/mutator for myLateralClearance.
virtual void	setObjectTypes (const DtRwObjectTypeList &objectTypes)
	Accessor/mutator for myObjectTypes.
virtual DtRwObjectTypeList &	objectTypes ()
	Accessor/mutator for myObjectTypes.
virtual const DtRwObjectTypeList &	objectTypes () const
	Accessor/mutator for myObjectTypes.
virtual void	setVectorObstructionTypes (const DtRwVectorObstructionTypeList &vectorObstructionTypes)
	Accessor/mutator for myVectorObstructionTypes.
virtual DtRwVectorObstructionTypeList &	vectorObstructionTypes ()
	Accessor/mutator for myVectorObstructionTypes.
virtual const DtRwVectorObstructionTypeList &	vectorObstructionTypes () const
	Accessor/mutator for myVectorObstructionTypes.
virtual void	setCheckObstructionsIfEmbarked (bool)
	Accessor/mutator for myCheckObstructionsIfEmbarked.
virtual bool	checkObstructionsIfEmbarked () const
	Accessor/mutator for myCheckObstructionsIfEmbarked.
Static Public Member Functions
static DtComponentDescriptor *	creator ()
Protected Member Functions
	DtObstructionSensorDescriptor ()
	default constructor; not implemented
Protected Attributes
parameters
parameters to define the collision volume and how close to stop These parameters are available for setting in the OPD files.
DtRwReal	myLateralClearance
	Parameter Name: lateral-clearance Parameter Description: Width added to the length of the bounding volume which is checked for potential collisions.
DtRwReal	myStoppingDistanceFactor
	Parameter Name: stopping-distance-factor Parameter Description: Factor by which the collision avoidance controller mulitiplies the current stopping distance to determine the length of the bounding volume which is checked for potential collisions.
DtRwBoolean	myCheckObstructionsIfEmbarked
	Parameter Name: check-obstructions-if-embarked Parameter Description: Flag indicating whether or not to check obstructions if the object is embarked.
DtRwObjectTypeList	myObjectTypes
	Parameter Name: object-types Parameter Description: Object types to treat as potential obstructions.
DtRwVectorObstructionTypeList	myVectorObstructionTypes
	Parameter Name: vector-obstruction-types Parameter Description: Types of vector features to treat as potential obstructions.

---

Detailed Description

DtObstructionSensorDescriptor is a DtComponentDescriptor that has the name of the DtObstructionSensor (if any) being used by this entity.

When available, this can be used to find out if the entity is colliding with or going to collide with an obstruction. The obstruction sensor can then report this current or impending collision via the appropriate ports.

---

Constructor & Destructor Documentation

DtObstructionSensorDescriptor::DtObstructionSensorDescriptor	(	const DtString &	name,
		DtReaderWriterRegistry *	parentRegistry = 0
	)

real constructor

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

copy constructor

virtual DtObstructionSensorDescriptor::~DtObstructionSensorDescriptor

(

)

[virtual]

destructor

DtObstructionSensorDescriptor::DtObstructionSensorDescriptor

(

)

[protected]

default constructor; not implemented

---

Member Function Documentation

DtObstructionSensorDescriptor& DtObstructionSensorDescriptor::operator=

(

const DtObstructionSensorDescriptor &

orig

)

assignment

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

DtObstructionSensorDescriptorType

Reimplemented from DtComponentDescriptor.

virtual void DtObstructionSensorDescriptor::setStoppingDistanceFactor

(

DtReal

distance

)

[virtual]

Accessor/mutator for myStoppingDistanceFactor.

virtual DtReal DtObstructionSensorDescriptor::stoppingDistanceFactor

(

)

const [virtual]

Accessor/mutator for myStoppingDistanceFactor.

virtual void DtObstructionSensorDescriptor::setLateralClearance

(

DtReal

distance

)

[virtual]

Accessor/mutator for myLateralClearance.

virtual DtReal DtObstructionSensorDescriptor::lateralClearance

(

)

const [virtual]

Accessor/mutator for myLateralClearance.

virtual void DtObstructionSensorDescriptor::setObjectTypes

(

const DtRwObjectTypeList &

objectTypes

)

[virtual]

Accessor/mutator for myObjectTypes.

virtual DtRwObjectTypeList& DtObstructionSensorDescriptor::objectTypes

(

)

[virtual]

Accessor/mutator for myObjectTypes.

virtual const DtRwObjectTypeList& DtObstructionSensorDescriptor::objectTypes

(

)

const [virtual]

Accessor/mutator for myObjectTypes.

virtual void DtObstructionSensorDescriptor::setVectorObstructionTypes

(

const DtRwVectorObstructionTypeList &

vectorObstructionTypes

)

[virtual]

Accessor/mutator for myVectorObstructionTypes.

virtual DtRwVectorObstructionTypeList& DtObstructionSensorDescriptor::vectorObstructionTypes

(

)

[virtual]

Accessor/mutator for myVectorObstructionTypes.

virtual const DtRwVectorObstructionTypeList& DtObstructionSensorDescriptor::vectorObstructionTypes

(

)

const [virtual]

Accessor/mutator for myVectorObstructionTypes.

virtual void DtObstructionSensorDescriptor::setCheckObstructionsIfEmbarked

(

bool

)

[virtual]

Accessor/mutator for myCheckObstructionsIfEmbarked.

virtual bool DtObstructionSensorDescriptor::checkObstructionsIfEmbarked

(

)

const [virtual]

Accessor/mutator for myCheckObstructionsIfEmbarked.

virtual DtComponentDescriptor* DtObstructionSensorDescriptor::clone

(

DtReaderWriterRegistry *

parentRegistry = 0

)

const [virtual]

returns a clone of this DtObstructionSensorDescriptor

Reimplemented from DtComponentDescriptor.

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

---

Member Data Documentation

DtRwReal DtObstructionSensorDescriptor::myLateralClearance [protected]

Parameter Name: lateral-clearance
Parameter Description: Width added to the length of the bounding volume which is checked for potential collisions.

Parameter Default Value: 6.
Parameter Units: meters

DtRwReal DtObstructionSensorDescriptor::myStoppingDistanceFactor [protected]

Parameter Name: stopping-distance-factor
Parameter Description: Factor by which the collision avoidance controller mulitiplies the current stopping distance to determine the length of the bounding volume which is checked for potential collisions.

Parameter Default Value: 3.

DtRwBoolean DtObstructionSensorDescriptor::myCheckObstructionsIfEmbarked [protected]

Parameter Name: check-obstructions-if-embarked
Parameter Description: Flag indicating whether or not to check obstructions if the object is embarked.

Parameter Default Value: false

DtRwObjectTypeList DtObstructionSensorDescriptor::myObjectTypes [protected]

Parameter Name: object-types
Parameter Description: Object types to treat as potential obstructions.

Parameter Default Value:

DtRwVectorObstructionTypeList DtObstructionSensorDescriptor::myVectorObstructionTypes [protected]

Parameter Name: vector-obstruction-types
Parameter Description: Types of vector features to treat as potential obstructions.

Parameter Default Value:

---

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

• include/vrfobjparam/obstructionSensorDesc.h