VR-Forces Development_Version Class Documentation
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
List of all members | Public Member Functions | Protected Member Functions | Protected Attributes | Private Member Functions
DtVrfSensorFieldOfView Class Reference

DtVrfSensorFieldOfView manages a VR-Link sensor field of view (FOV) publisher, and sets all the values associated with a sensor's field of view. More...

Public Member Functions

 DtVrfSensorFieldOfView (DtVrfObject *hostEntity, const DtString &id)
virtual ~DtVrfSensorFieldOfView ()
virtual void tick ()
 Tick the publisher.
bool init ()
 Calls createPublisher.
DtString id () const
 Location of the sensor relative to the host entity.
DtVector relativeLocation () const
 Location of the sensor relative to the host entity.
void setRelativeLocation (const DtVector &loc)
 Location of the sensor relative to the host entity.
DtTaitBryan relativeOrientation () const
 Orientation of the sensor relative to the host entity.
void setRelativeOrientation (const DtTaitBryan &ori)
 Orientation of the sensor relative to the host entity.
virtual void setTargetedEntity (const DtGlobalObjectDesignator &target)
 Entity being tracked.
virtual const
DtGlobalObjectDesignator & 
targetedEntity () const
 Entity being tracked.
virtual void setTargetedLocation (const DtVector &target)
 Location being tracked.
virtual const DtVectortargetedLocation () const
 Location being tracked.
virtual void setTrackingMode (DtSensorTrackingMode mode)
 Tracking mode.
virtual DtSensorTrackingMode trackingMode () const
 Tracking mode.
DtFloat64 radius () const
 The radius of the field of view (distance from entity to max range).
void setRadius (DtFloat64 rad)
 The radius of the field of view (distance from entity to max range).
DtFloat64 xHalfAngle () const
 Half width of the FOV along the x-axis, measured in radians.
void setXHalfAngle (DtFloat64 angle)
 Half width of the FOV along the x-axis, measured in radians.
DtFloat64 yHalfAngle () const
 Half width of the FOV along the y-axis, measured in radians.
void setYHalfAngle (DtFloat64 angle)
 Half width of the FOV along the y-axis, measured in radians.
DtFloat64 minAzimuthAngle () const
 Minimum azimuth angle at which sensor can be aimed, measured in radians.
void setMinAzimuthAngle (DtFloat64 angle)
 Minimum azimuth angle at which sensor can be aimed, measured in radians.
DtFloat64 maxAzimuthAngle () const
 Maximum azimuth angle at which sensor can be aimed, measured in radians.
void setMaxAzimuthAngle (DtFloat64 angle)
 Maximum azimuth angle at which sensor can be aimed, measured in radians.
DtFloat64 minElevationAngle () const
 Minimum elevation angle at which sensor can be aimed, measured in radians.
void setMinElevationAngle (DtFloat64 angle)
 Minimum elevation angle at which sensor can be aimed, measured in radians.
DtFloat64 maxElevationAngle () const
 Maximum elevation angle at which sensor can be aimed, measured in radians.
void setMaxElevationAngle (DtFloat64 angle)
 Maximum elevation angle at which sensor can be aimed, measured in radians.
DtFloat64 maxZoomLevel () const
 Maximum zoom factor.
void setMaxZoomLevel (DtFloat64 level)
 Maximum zoom factor.
DtFloat64 currentZoomLevel () const
 Current zoom factor.
void setCurrentZoomLevel (DtFloat64 level)
 Current zoom factor.
DtU32 color () const
 Field of view color.
void setColor (DtU32 c)
 Field of view color.

Protected Member Functions

virtual bool createPublisher ()
 Creates a new publisher on the current exercise connection.
virtual bool initSensorFieldOfView ()
 Initializes the sensor field of view SR.

Protected Attributes

DtRectangularPyramidPublishermyFovPublisher
DtVrfObjectmyHostEntity
DtString mySensorFieldOfViewId

Private Member Functions

 DtVrfSensorFieldOfView (const DtVrfSensorFieldOfView &orig)
 Not implemented.
DtVrfSensorFieldOfViewoperator= (const DtVrfSensorFieldOfView &orig)
 Not implemented.
 DtVrfSensorFieldOfView ()
 Not implemented.

Detailed Description

DtVrfSensorFieldOfView manages a VR-Link sensor field of view (FOV) publisher, and sets all the values associated with a sensor's field of view.

The emitter system can be initialized from a DtSesnorFieldOfViewEntry RW class. tick() must be called periodically to tick the VRL publisher.

Constructor & Destructor Documentation

DtVrfSensorFieldOfView::DtVrfSensorFieldOfView ( const DtVrfSensorFieldOfView orig)
private

Not implemented.

DtVrfSensorFieldOfView::DtVrfSensorFieldOfView ( )
private

Not implemented.

DtVrfSensorFieldOfView::DtVrfSensorFieldOfView ( DtVrfObject hostEntity,
const DtString id 
)
virtual DtVrfSensorFieldOfView::~DtVrfSensorFieldOfView ( )
virtual

Member Function Documentation

DtVrfSensorFieldOfView& DtVrfSensorFieldOfView::operator= ( const DtVrfSensorFieldOfView orig)
private

Not implemented.

virtual void DtVrfSensorFieldOfView::tick ( )
virtual

Tick the publisher.

bool DtVrfSensorFieldOfView::init ( )

Calls createPublisher.

DtString DtVrfSensorFieldOfView::id ( ) const

Location of the sensor relative to the host entity.

DtVector DtVrfSensorFieldOfView::relativeLocation ( ) const

Location of the sensor relative to the host entity.

void DtVrfSensorFieldOfView::setRelativeLocation ( const DtVector loc)

Location of the sensor relative to the host entity.

DtTaitBryan DtVrfSensorFieldOfView::relativeOrientation ( ) const

Orientation of the sensor relative to the host entity.

When set, targeted entity will be cleared out.

void DtVrfSensorFieldOfView::setRelativeOrientation ( const DtTaitBryan &  ori)

Orientation of the sensor relative to the host entity.

When set, targeted entity will be cleared out.

virtual void DtVrfSensorFieldOfView::setTargetedEntity ( const DtGlobalObjectDesignator &  target)
virtual

Entity being tracked.

virtual const DtGlobalObjectDesignator& DtVrfSensorFieldOfView::targetedEntity ( ) const
virtual

Entity being tracked.

virtual void DtVrfSensorFieldOfView::setTargetedLocation ( const DtVector target)
virtual

Location being tracked.

virtual const DtVector& DtVrfSensorFieldOfView::targetedLocation ( ) const
virtual

Location being tracked.

virtual void DtVrfSensorFieldOfView::setTrackingMode ( DtSensorTrackingMode  mode)
virtual

Tracking mode.

virtual DtSensorTrackingMode DtVrfSensorFieldOfView::trackingMode ( ) const
virtual

Tracking mode.

DtFloat64 DtVrfSensorFieldOfView::radius ( ) const

The radius of the field of view (distance from entity to max range).

void DtVrfSensorFieldOfView::setRadius ( DtFloat64  rad)

The radius of the field of view (distance from entity to max range).

DtFloat64 DtVrfSensorFieldOfView::xHalfAngle ( ) const

Half width of the FOV along the x-axis, measured in radians.

void DtVrfSensorFieldOfView::setXHalfAngle ( DtFloat64  angle)

Half width of the FOV along the x-axis, measured in radians.

DtFloat64 DtVrfSensorFieldOfView::yHalfAngle ( ) const

Half width of the FOV along the y-axis, measured in radians.

void DtVrfSensorFieldOfView::setYHalfAngle ( DtFloat64  angle)

Half width of the FOV along the y-axis, measured in radians.

DtFloat64 DtVrfSensorFieldOfView::minAzimuthAngle ( ) const

Minimum azimuth angle at which sensor can be aimed, measured in radians.

void DtVrfSensorFieldOfView::setMinAzimuthAngle ( DtFloat64  angle)

Minimum azimuth angle at which sensor can be aimed, measured in radians.

DtFloat64 DtVrfSensorFieldOfView::maxAzimuthAngle ( ) const

Maximum azimuth angle at which sensor can be aimed, measured in radians.

void DtVrfSensorFieldOfView::setMaxAzimuthAngle ( DtFloat64  angle)

Maximum azimuth angle at which sensor can be aimed, measured in radians.

DtFloat64 DtVrfSensorFieldOfView::minElevationAngle ( ) const

Minimum elevation angle at which sensor can be aimed, measured in radians.

void DtVrfSensorFieldOfView::setMinElevationAngle ( DtFloat64  angle)

Minimum elevation angle at which sensor can be aimed, measured in radians.

DtFloat64 DtVrfSensorFieldOfView::maxElevationAngle ( ) const

Maximum elevation angle at which sensor can be aimed, measured in radians.

void DtVrfSensorFieldOfView::setMaxElevationAngle ( DtFloat64  angle)

Maximum elevation angle at which sensor can be aimed, measured in radians.

DtFloat64 DtVrfSensorFieldOfView::maxZoomLevel ( ) const

Maximum zoom factor.

void DtVrfSensorFieldOfView::setMaxZoomLevel ( DtFloat64  level)

Maximum zoom factor.

DtFloat64 DtVrfSensorFieldOfView::currentZoomLevel ( ) const

Current zoom factor.

void DtVrfSensorFieldOfView::setCurrentZoomLevel ( DtFloat64  level)

Current zoom factor.

DtU32 DtVrfSensorFieldOfView::color ( ) const

Field of view color.

void DtVrfSensorFieldOfView::setColor ( DtU32  c)

Field of view color.

virtual bool DtVrfSensorFieldOfView::createPublisher ( )
protectedvirtual

Creates a new publisher on the current exercise connection.

virtual bool DtVrfSensorFieldOfView::initSensorFieldOfView ( )
protectedvirtual

Initializes the sensor field of view SR.

Member Data Documentation

DtRectangularPyramidPublisher* DtVrfSensorFieldOfView::myFovPublisher
protected
DtVrfObject* DtVrfSensorFieldOfView::myHostEntity
protected
DtString DtVrfSensorFieldOfView::mySensorFieldOfViewId
protected

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

Document ID: Generated on Mon Jul 4 01:00:18 EDT 2016 from SVN revision 166489
Copyright © 2005-2015 VT MÄK. All Rights Reserved (www.mak.com)