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)
DtTaitBryan	relativeOrientation () const
	Orientation of the sensor relative to the host entity.
void	setRelativeOrientation (const DtTaitBryan &ori)
virtual void	setTargetedEntity (const DtGlobalObjectDesignator &target)
	Entity being tracked.
virtual const DtGlobalObjectDesignator &	targetedEntity () const
virtual void	setTargetedLocation (const DtVector &target)
	Location being tracked.
virtual const DtVector &	targetedLocation () const
virtual void	setTrackingMode (DtSensorTrackingMode mode)
	Tracking mode.
virtual DtSensorTrackingMode	trackingMode () const
DtFloat64	radius () const
	The radius of the field of view (distance from entity to max range).
void	setRadius (DtFloat64 rad)
DtFloat64	xHalfAngle () const
	Half width of the FOV along the x-axis, measured in radians.
void	setXHalfAngle (DtFloat64 angle)
DtFloat64	yHalfAngle () const
	Half width of the FOV along the y-axis, measured in radians.
void	setYHalfAngle (DtFloat64 angle)
DtFloat64	minAzimuthAngle () const
	Minimum azimuth angle at which sensor can be aimed, measured in radians.
void	setMinAzimuthAngle (DtFloat64 angle)
DtFloat64	maxAzimuthAngle () const
	Maximum azimuth angle at which sensor can be aimed, measured in radians.
void	setMaxAzimuthAngle (DtFloat64 angle)
DtFloat64	minElevationAngle () const
	Minimum elevation angle at which sensor can be aimed, measured in radians.
void	setMinElevationAngle (DtFloat64 angle)
DtFloat64	maxElevationAngle () const
	Maximum elevation angle at which sensor can be aimed, measured in radians.
void	setMaxElevationAngle (DtFloat64 angle)
DtFloat64	maxZoomLevel () const
	Maximum zoom factor.
void	setMaxZoomLevel (DtFloat64 level)
DtFloat64	currentZoomLevel () const
	Current zoom factor.
void	setCurrentZoomLevel (DtFloat64 level)
DtU32	color () const
	Field of view color.
void	setColor (DtU32 c)

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
DtRectangularPyramidPublisher *	myFovPublisher
DtVrfObject *	myHostEntity
DtString	mySensorFieldOfViewId

Private Member Functions
	DtVrfSensorFieldOfView (const DtVrfSensorFieldOfView &orig)
	Not implemented.
DtVrfSensorFieldOfView &	operator= (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

)

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

)

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

virtual

Entity being tracked.

virtual const DtGlobalObjectDesignator& DtVrfSensorFieldOfView::targetedEntity ( ) const

virtual

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

virtual

Location being tracked.

virtual const DtVector& DtVrfSensorFieldOfView::targetedLocation ( ) const

virtual

virtual void DtVrfSensorFieldOfView::setTrackingMode ( DtSensorTrackingMode  mode )

virtual

Tracking mode.

virtual DtSensorTrackingMode DtVrfSensorFieldOfView::trackingMode ( ) const

virtual

DtFloat64 DtVrfSensorFieldOfView::radius

(

)

const

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

void DtVrfSensorFieldOfView::setRadius

(

DtFloat64

rad

)

DtFloat64 DtVrfSensorFieldOfView::xHalfAngle

(

)

const

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

void DtVrfSensorFieldOfView::setXHalfAngle

(

DtFloat64

angle

)

DtFloat64 DtVrfSensorFieldOfView::yHalfAngle

(

)

const

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

void DtVrfSensorFieldOfView::setYHalfAngle

(

DtFloat64

angle

)

DtFloat64 DtVrfSensorFieldOfView::minAzimuthAngle

(

)

const

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

void DtVrfSensorFieldOfView::setMinAzimuthAngle

(

DtFloat64

angle

)

DtFloat64 DtVrfSensorFieldOfView::maxAzimuthAngle

(

)

const

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

void DtVrfSensorFieldOfView::setMaxAzimuthAngle

(

DtFloat64

angle

)

DtFloat64 DtVrfSensorFieldOfView::minElevationAngle

(

)

const

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

void DtVrfSensorFieldOfView::setMinElevationAngle

(

DtFloat64

angle

)

DtFloat64 DtVrfSensorFieldOfView::maxElevationAngle

(

)

const

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

void DtVrfSensorFieldOfView::setMaxElevationAngle

(

DtFloat64

angle

)

DtFloat64 DtVrfSensorFieldOfView::maxZoomLevel

(

)

const

Maximum zoom factor.

void DtVrfSensorFieldOfView::setMaxZoomLevel

(

DtFloat64

level

)

DtFloat64 DtVrfSensorFieldOfView::currentZoomLevel

(

)

const

Current zoom factor.

void DtVrfSensorFieldOfView::setCurrentZoomLevel

(

DtFloat64

level

)

DtU32 DtVrfSensorFieldOfView::color

(

)

const

Field of view color.

void DtVrfSensorFieldOfView::setColor

(

DtU32

c

)

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:

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.tot/include/vrfmodel/vrfSensorFieldOfView.h