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.

Public Member Functions
	DtVrfSensorFieldOfView (DtLocalObject *hostEntity, const DtString &id)
virtual	~DtVrfSensorFieldOfView ()
bool	init ()
DtString	id () const
DtVector	relativeLocation () const
void	setRelativeLocation (const DtVector &loc)
DtTaitBryan	relativeOrientation () const
void	setRelativeOrientation (const DtTaitBryan &ori)
virtual void	setTargetedEntity (const DtUUID &target)
virtual const DtUUID &	targetedEntity () const
virtual void	setTargetedLocation (const DtVector &target)
virtual DtVector	targetedLocation () const
virtual void	setTrackingMode (DtSensorTrackingMode mode)
virtual DtSensorTrackingMode	trackingMode () const
DtFloat64	radius () const
void	setRadius (DtFloat64 rad)
DtFloat64	xHalfAngle () const
void	setXHalfAngle (DtFloat64 angle)
DtFloat64	yHalfAngle () const
void	setYHalfAngle (DtFloat64 angle)
DtFloat64	minAzimuthAngle () const
void	setMinAzimuthAngle (DtFloat64 angle)
DtFloat64	maxAzimuthAngle () const
void	setMaxAzimuthAngle (DtFloat64 angle)
DtFloat64	minElevationAngle () const
void	setMinElevationAngle (DtFloat64 angle)
DtFloat64	maxElevationAngle () const
void	setMaxElevationAngle (DtFloat64 angle)
DtFloat64	maxZoomLevel () const
void	setMaxZoomLevel (DtFloat64 level)
DtFloat64	currentZoomLevel () const
void	setCurrentZoomLevel (DtFloat64 level)
DtU32	color () const
void	setColor (DtU32 c)

Protected Member Functions
virtual bool	initSensorFieldOfView ()

Protected Attributes
makVrf::DtSensorFieldOfViewStateComponent *	mySensorFieldOfViewComponent
DtLocalObject *	myHostEntity
DtString	mySensorFieldOfViewId

Private Member Functions
	DtVrfSensorFieldOfView (const DtVrfSensorFieldOfView &orig)
DtVrfSensorFieldOfView &	operator= (const DtVrfSensorFieldOfView &orig)
	DtVrfSensorFieldOfView ()

Constructor & Destructor Documentation

DtVrfSensorFieldOfView::DtVrfSensorFieldOfView ( const DtVrfSensorFieldOfView &  orig )

private

Not implemented.

DtVrfSensorFieldOfView::DtVrfSensorFieldOfView ( )

private

Not implemented.

DtVrfSensorFieldOfView::DtVrfSensorFieldOfView	(	DtLocalObject *	hostEntity,
		const DtString &	id
	)

virtual DtVrfSensorFieldOfView::~DtVrfSensorFieldOfView ( )

virtual

Member Function Documentation

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

private

Not implemented.

bool DtVrfSensorFieldOfView::init

(

)

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 DtUUID &  target )

virtual

Entity being tracked.

virtual const DtUUID& DtVrfSensorFieldOfView::targetedEntity ( ) const

virtual

Entity being tracked.

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

virtual

Location being tracked.

virtual 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::initSensorFieldOfView ( )

protectedvirtual

Initializes the sensor field of view SR.

Member Data Documentation

makVrf::DtSensorFieldOfViewStateComponent* DtVrfSensorFieldOfView::mySensorFieldOfViewComponent

protected

DtLocalObject* DtVrfSensorFieldOfView::myHostEntity

protected

DtString DtVrfSensorFieldOfView::mySensorFieldOfViewId

protected

---

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

• /data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-0-branch/include/vrfmodel/vrfSensorFieldOfView.h