DtSignaturePropagatorArgs Class Reference

Base class for arguments passed into DtSignaturePropagator::calculateApparentSignature. More...

List of all members.

Public Member Functions
	DtSignaturePropagatorArgs ()
	default constructor
	DtSignaturePropagatorArgs (const DtSignaturePropagatorArgs &orig)
	copy constructor
DtSignaturePropagatorArgs &	operator= (const DtSignaturePropagatorArgs &orig)
	assignment operator
virtual	~DtSignaturePropagatorArgs ()
	destructor
virtual void	setTargetObject (const DtVrfObject *obj)
	The object that is the originator of the signature.
virtual const DtVrfObject *	targetObject () const
	Returns the target object.
virtual void	setViewingObject (const DtVrfObject *obj)
	The object that is the viewer of the signature.
virtual const DtVrfObject *	viewingObject () const
	Returns the viewing object.
virtual void	setViewpointLocalLocation (const DtVector &loc)
virtual DtVector	viewpointLocalLocation () const
virtual void	setMinSignatureThreshold (double sig)
	The smallest signature value that is relevant for propagating the signature.
virtual double	minSignatureThreshold () const
	The smallest signature value that is relevant for propagating the signature.
virtual void	setLosValueIfDataUnavailable (bool v)
virtual bool	losValueIfDataUnavailable () const
Protected Attributes
DtVector	myViewpointLocalLocation
	The local location of the viewer of the signature i.e. the location we are trying to detect from.
const DtVrfObject *	myTargetObject
	The object that is the originator of the signature, the object to be detected.
const DtVrfObject *	myViewingObject
	The object that is the viewer of the signature, the object the sensor is on.
double	myMinimumSignatureThreshold
	The smallest signature value that is relevant for propagating the signature.
bool	myLosValueIfDataUnavaialble
	This parameter is only used in the case of paging or streaming terrains where the sensor calculation is done over an area where data is not yet available.

---

Detailed Description

Base class for arguments passed into DtSignaturePropagator::calculateApparentSignature.

This class simply encapsulates arguments for passing into the DtSignaturePropagator::calculateApparentSignature method. Some propagators may use derived version of this class that have more arguments.

---

Constructor & Destructor Documentation

DtSignaturePropagatorArgs::DtSignaturePropagatorArgs

(

)

default constructor

DtSignaturePropagatorArgs::DtSignaturePropagatorArgs

(

const DtSignaturePropagatorArgs &

orig

)

copy constructor

virtual DtSignaturePropagatorArgs::~DtSignaturePropagatorArgs

(

)

[virtual]

destructor

---

Member Function Documentation

DtSignaturePropagatorArgs& DtSignaturePropagatorArgs::operator=

(

const DtSignaturePropagatorArgs &

orig

)

assignment operator

virtual void DtSignaturePropagatorArgs::setViewpointLocalLocation

(

const DtVector &

loc

)

[virtual]

The local location of the viewer of the signature.

virtual DtVector DtSignaturePropagatorArgs::viewpointLocalLocation

(

)

const [virtual]

The local location of the viewer of the signature.

virtual void DtSignaturePropagatorArgs::setTargetObject

(

const DtVrfObject *

obj

)

[virtual]

The object that is the originator of the signature.

virtual const DtVrfObject* DtSignaturePropagatorArgs::targetObject

(

)

const [virtual]

Returns the target object.

virtual void DtSignaturePropagatorArgs::setViewingObject

(

const DtVrfObject *

obj

)

[virtual]

The object that is the viewer of the signature.

virtual const DtVrfObject* DtSignaturePropagatorArgs::viewingObject

(

)

const [virtual]

Returns the viewing object.

virtual void DtSignaturePropagatorArgs::setMinSignatureThreshold

(

double

sig

)

[virtual]

The smallest signature value that is relevant for propagating the signature.

Any results that fall below this value may be returned as 0. This parameter is for optimization, and is not mandatory. The default is 0, which will always return the correct value.

virtual double DtSignaturePropagatorArgs::minSignatureThreshold

(

)

const [virtual]

The smallest signature value that is relevant for propagating the signature.

Any results that fall below this value may be returned as 0. This parameter is for optimization, and is not mandatory. The default is 0, which will always return the correct value.

virtual void DtSignaturePropagatorArgs::setLosValueIfDataUnavailable

(

bool

v

)

[virtual]

See also:

myLosValueIfDataUnavaialble

virtual bool DtSignaturePropagatorArgs::losValueIfDataUnavailable

(

)

const [virtual]

See also:

myLosValueIfDataUnavaialble

---

Member Data Documentation

DtVector DtSignaturePropagatorArgs::myViewpointLocalLocation [protected]

The local location of the viewer of the signature i.e. the location we are trying to detect from.

const DtVrfObject* DtSignaturePropagatorArgs::myTargetObject [protected]

The object that is the originator of the signature, the object to be detected.

const DtVrfObject* DtSignaturePropagatorArgs::myViewingObject [protected]

The object that is the viewer of the signature, the object the sensor is on.

double DtSignaturePropagatorArgs::myMinimumSignatureThreshold [protected]

The smallest signature value that is relevant for propagating the signature.

Any results that fall below this value may be returned as 0. This parameter is for optimization, and is not mandatory. The default is 0, which will always return the correct value.

bool DtSignaturePropagatorArgs::myLosValueIfDataUnavaialble [protected]

This parameter is only used in the case of paging or streaming terrains where the sensor calculation is done over an area where data is not yet available.

This parameter holds the LOS value that will be used if the LOS check against the terrain results in a "data unavailable" state. If true, the LOS will be treated as if it is clear. If false, no data will be treated as if the LOS is blocked. Default value is false.

---

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

• include/vrfobjcore/signaturePropagatorArgs.h