VR-Forces 5.0.3 Developer's Guide
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
List of all members | Public Member Functions | Protected Attributes
DtSignaturePropagatorArgs Class Reference

Contains the DtSignaturePropagatorArgs class declaration.

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.

Public Member Functions

 DtSignaturePropagatorArgs ()
 
 DtSignaturePropagatorArgs (const DtSignaturePropagatorArgs &orig)
 
DtSignaturePropagatorArgsoperator= (const DtSignaturePropagatorArgs &orig)
 
virtual ~DtSignaturePropagatorArgs ()
 
virtual void setTargetObject (DtSimObjectReference obj)
 
virtual DtSimObjectReference targetObject () const
 
virtual void setViewingObject (DtSimObjectReference obj)
 
virtual DtSimObjectReference viewingObject () const
 
virtual void setViewpointLocalLocation (const DtVector &loc)
 
virtual DtVector viewpointLocalLocation () const
 
virtual void setMinSignatureThreshold (double sig)
 
virtual double minSignatureThreshold () const
 
virtual void setLosValueIfDataUnavailable (bool v)
 
virtual bool losValueIfDataUnavailable () const
 
virtual void setDebug (bool d)
 
virtual bool debug () const
 

Protected Attributes

DtVector myViewpointLocalLocation
 
DtSimObjectReference myTargetObject
 
DtSimObjectReference myViewingObject
 
double myMinimumSignatureThreshold
 
bool myLosValueIfDataUnavaialble
 
bool myDebug
 

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 ( DtSimObjectReference  obj)
virtual

The object that is the originator of the signature.

virtual DtSimObjectReference DtSignaturePropagatorArgs::targetObject ( ) const
virtual

Returns the target object.

virtual void DtSignaturePropagatorArgs::setViewingObject ( DtSimObjectReference  obj)
virtual

The object that is the viewer of the signature.

virtual DtSimObjectReference 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
virtual bool DtSignaturePropagatorArgs::losValueIfDataUnavailable ( ) const
virtual
virtual void DtSignaturePropagatorArgs::setDebug ( bool  d)
virtual

Set and access myDebug.

virtual bool DtSignaturePropagatorArgs::debug ( ) const
virtual

Set and access myDebug.

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.

DtSimObjectReference DtSignaturePropagatorArgs::myTargetObject
protected

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

DtSimObjectReference 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.

bool DtSignaturePropagatorArgs::myDebug
protected

This flag indicates that detailed debugging info should be printed to the console, i.e. with DtWarn to prevent network overload. Normally it will be set if the notify level of the entity is Debug and there is an additional debug-detail parameter set true in the component descriptor.


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

Document ID: Generated on Thu Jun 1 17:58:13 EDT 2023 from SVN revision 255404
Copyright © 2005-2021 MAK Technologies. All Rights Reserved (www.mak.com)