DtVisualSignaturePropagatorDescriptor Class Reference

DtVisualSignaturePropagatorDescriptor; descriptor for the DtVisualSignaturePropagator component. More...

Inheritance diagram for DtVisualSignaturePropagatorDescriptor:

List of all members.

Public Member Functions
	DtVisualSignaturePropagatorDescriptor (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL)
	real constructor
	DtVisualSignaturePropagatorDescriptor (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL)
	DtVisualSignaturePropagatorDescriptor (const DtVisualSignaturePropagatorDescriptor &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	copy constructor
DtVisualSignaturePropagatorDescriptor &	operator= (const DtVisualSignaturePropagatorDescriptor &orig)
	assignment
virtual	~DtVisualSignaturePropagatorDescriptor ()
virtual DtString	type () const
	Returns the type of component this descriptor describes.
virtual DtSignaturePropagatorDescriptor *	clone (DtReaderWriterRegistry *parentRegistry=NULL) const
virtual double	reductionFactor () const
	Accessor/mutator for myReductionFactor.
virtual void	setReductionFactor (double factor)
	Accessor/mutator for myReductionFactor.
virtual bool	checkSmokeIntersections () const
	Accessor/mutator for myCheckSmoke.
virtual void	setCheckSmokeIntersections (bool check)
	Accessor/mutator for myCheckSmoke.
virtual const DtObjectType &	smokeType () const
	Accessor/mutator for mySmokeType.
virtual void	setSmokeType (const DtObjectType &type)
	Accessor/mutator for mySmokeType.
virtual double	minSmokeBlockDistance () const
virtual void	setMinSmokeBlockDistance (double value)
virtual double	minSmokeBlockDensity () const
virtual void	setMinSmokeBlockDensity (double value)
Static Public Member Functions
static DtSignaturePropagatorDescriptor *	creator ()
Protected Attributes
parameters
These parameters are available for setting in the OPD files.
DtRwReal	myReductionFactor
	Parameter Name: reduction-factor Parameter Description: Factor that reduces visibility based on weather state Parameter Default Value: 0.0 .
DtRwBoolean	myCheckSmoke
	Parameter Name: check-smoke Parameter Description: Determines whether the propagator should check of any smoke objects that might be in between the sensor and the surrounding objects Parameter Default Value: True .
DtRwObjectType	mySmokeType
	Parameter Name: smoke-type Parameter Description: The object type of the smoke objects to check for intersection Parameter Default Value: .
DtRwReal	myMinSmokeBlockDistance
	Parameter Name: min-smoke-block-distance Parameter Description: The maximum distance that a viewer may look though a smoke cloud before their view is blocked completely.
DtRwReal	myMinSmokeBlockDensity
	Parameter Name: min-smoke-block-density Parameter Description: The minimum smoke cloud density that will block the sensor.
Private Member Functions
	DtVisualSignaturePropagatorDescriptor ()
	default constructor; not implemented

---

Detailed Description

DtVisualSignaturePropagatorDescriptor; descriptor for the DtVisualSignaturePropagator component.

Descriptor containing configuration parameters for the DtStandardSignaturePropagator class.

---

Constructor & Destructor Documentation

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

real constructor

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

DtVisualSignaturePropagatorDescriptor::DtVisualSignaturePropagatorDescriptor	(	const DtVisualSignaturePropagatorDescriptor &	orig,
		DtReaderWriterRegistry *	parentRegistry = NULL
	)

copy constructor

virtual DtVisualSignaturePropagatorDescriptor::~DtVisualSignaturePropagatorDescriptor

(

)

[virtual]

DtVisualSignaturePropagatorDescriptor::DtVisualSignaturePropagatorDescriptor

(

)

[private]

default constructor; not implemented

---

Member Function Documentation

DtVisualSignaturePropagatorDescriptor& DtVisualSignaturePropagatorDescriptor::operator=

(

const DtVisualSignaturePropagatorDescriptor &

orig

)

assignment

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

DtVisualSignaturePropagatorDescriptorType

Reimplemented from DtStandardPropagatorDescriptor.

virtual DtSignaturePropagatorDescriptor* DtVisualSignaturePropagatorDescriptor::clone

(

DtReaderWriterRegistry *

parentRegistry = NULL

)

const [virtual]

Reimplemented from DtStandardPropagatorDescriptor.

static DtSignaturePropagatorDescriptor* DtVisualSignaturePropagatorDescriptor::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 DtStandardPropagatorDescriptor.

virtual double DtVisualSignaturePropagatorDescriptor::reductionFactor

(

)

const [virtual]

Accessor/mutator for myReductionFactor.

virtual void DtVisualSignaturePropagatorDescriptor::setReductionFactor

(

double

factor

)

[virtual]

Accessor/mutator for myReductionFactor.

virtual bool DtVisualSignaturePropagatorDescriptor::checkSmokeIntersections

(

)

const [virtual]

Accessor/mutator for myCheckSmoke.

virtual void DtVisualSignaturePropagatorDescriptor::setCheckSmokeIntersections

(

bool

check

)

[virtual]

Accessor/mutator for myCheckSmoke.

virtual const DtObjectType& DtVisualSignaturePropagatorDescriptor::smokeType

(

)

const [virtual]

Accessor/mutator for mySmokeType.

virtual void DtVisualSignaturePropagatorDescriptor::setSmokeType

(

const DtObjectType &

type

)

[virtual]

Accessor/mutator for mySmokeType.

virtual double DtVisualSignaturePropagatorDescriptor::minSmokeBlockDistance

(

)

const [virtual]

See also:

myMinSmokeBlockDistance

virtual void DtVisualSignaturePropagatorDescriptor::setMinSmokeBlockDistance

(

double

value

)

[virtual]

See also:

myMinSmokeBlockDistance

virtual double DtVisualSignaturePropagatorDescriptor::minSmokeBlockDensity

(

)

const [virtual]

See also:

myMinSmokeBlockDensity

virtual void DtVisualSignaturePropagatorDescriptor::setMinSmokeBlockDensity

(

double

value

)

[virtual]

See also:

myMinSmokeBlockDensity

---

Member Data Documentation

DtRwReal DtVisualSignaturePropagatorDescriptor::myReductionFactor [protected]

Parameter Name: reduction-factor
Parameter Description: Factor that reduces visibility based on weather state
Parameter Default Value: 0.0
.

DtRwBoolean DtVisualSignaturePropagatorDescriptor::myCheckSmoke [protected]

Parameter Name: check-smoke
Parameter Description: Determines whether the propagator should check of any smoke objects that might be in between the sensor and the surrounding objects
Parameter Default Value: True
.

DtRwObjectType DtVisualSignaturePropagatorDescriptor::mySmokeType [protected]

Parameter Name: smoke-type
Parameter Description: The object type of the smoke objects to check for intersection
Parameter Default Value:
.

DtRwReal DtVisualSignaturePropagatorDescriptor::myMinSmokeBlockDistance [protected]

Parameter Name: min-smoke-block-distance
Parameter Description: The maximum distance that a viewer may look though a smoke cloud before their view is blocked completely.

Any distance greater than the one specified here will block the sensor. This only applies to smoke clouds of greater density than the min-smoke-block-density. Parameter Units: meters Parameter Default Value: 2

DtRwReal DtVisualSignaturePropagatorDescriptor::myMinSmokeBlockDensity [protected]

Parameter Name: min-smoke-block-density
Parameter Description: The minimum smoke cloud density that will block the sensor.

Any smoke clouds less than this density are ignored. Parameter Units: percent (0 - 1.0) Parameter Default Value: 0.25

---

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

• include/vrfobjparam/visualSignaturePropagatorDesc.h