makVrv::DtCigiLosBasicResponse Class Reference

A DtCigiIntersectionHandler processes CIGI LOS Requests and packages the results into instances of this class if a Basic response was requested. More...

Inheritance diagram for makVrv::DtCigiLosBasicResponse:

Public Member Functions
virtual	~DtCigiLosBasicResponse ()
	DTOR.
DtCigiLosBasicResponse &	operator= (const DtCigiLosBasicResponse &rhs)
	Assignment operator.
virtual unsigned int	losId () const
	Get/Set the los id used by the host to request this los check.
virtual void	setLosId (unsigned int id)
virtual unsigned int	hostFrameNumber () const
	Get/Set the hostFrameNumber for this request.
virtual void	setHostFrameNumber (unsigned int frameNum)
virtual bool	rangeValid () const
	Get/Set the rangeValid flag.
virtual void	setRangeValid (bool valid)
virtual double	range () const
	The distance from the start of the intersector to the intersection.
virtual void	setRange (double r)
virtual DtUniqueID	entityHit () const
	Get/Set the scene object ID of the entity hit for this intersection, if any.
virtual void	setEntityHit (DtUniqueID source)
virtual int	cigiEntityHit () const
	Get/Set the cigi entity ID of the entity specified as the start point for the LOS request (or -1) if not set.
virtual void	setCigiEntityHit (int source)
virtual bool	endpointVisible () const
	Get/Set the endpointVisible flag.
virtual void	setEndpointVisible (bool vis)
virtual unsigned int	responseCount () const
	Get/Set the response count.
virtual void	setResponseCount (unsigned int count)

Protected Member Functions
	DtCigiLosBasicResponse ()
	(Protected) CTOR. Can only be constructed through DtCigiLosRequestCreator

Protected Attributes
unsigned int	myLosId
unsigned int	myHostFrameNumber
bool	myRangeValid
bool	myEndpointVisible
unsigned int	myResponseCount
DtUniqueID	myEntityHit
int	myCigiEntityHit
double	myRange

Private Member Functions
	DtCigiLosBasicResponse (const DtCigiLosBasicResponse &orig)
	(Unimplemented) Copy CTOR

Friends
class	DtCigiLosBasicResponseCreator
	Friended so that the creator can call the (protected) CTOR.

Detailed Description

A DtCigiIntersectionHandler processes CIGI LOS Requests and packages the results into instances of this class if a Basic response was requested.

Constructor & Destructor Documentation

virtual makVrv::DtCigiLosBasicResponse::~DtCigiLosBasicResponse ( )

virtual

DTOR.

makVrv::DtCigiLosBasicResponse::DtCigiLosBasicResponse ( )

protected

(Protected) CTOR. Can only be constructed through DtCigiLosRequestCreator

makVrv::DtCigiLosBasicResponse::DtCigiLosBasicResponse ( const DtCigiLosBasicResponse &  orig )

private

(Unimplemented) Copy CTOR

Member Function Documentation

DtCigiLosBasicResponse& makVrv::DtCigiLosBasicResponse::operator=

(

const DtCigiLosBasicResponse &

rhs

)

Assignment operator.

virtual unsigned int makVrv::DtCigiLosBasicResponse::losId ( ) const

virtual

Get/Set the los id used by the host to request this los check.

virtual void makVrv::DtCigiLosBasicResponse::setLosId ( unsigned int  id )

virtual

virtual unsigned int makVrv::DtCigiLosBasicResponse::hostFrameNumber ( ) const

virtual

Get/Set the hostFrameNumber for this request.

If the request is periodic, this will be updated for each request

virtual void makVrv::DtCigiLosBasicResponse::setHostFrameNumber ( unsigned int  frameNum )

virtual

virtual bool makVrv::DtCigiLosBasicResponse::rangeValid ( ) const

virtual

Get/Set the rangeValid flag.

If the request that generated this response was a segment request, then this indicates if the range is valid (basically, if an intersection occurred). For a vector request, the standard says that it indicates if an intersection occurs before the minimum range or beyond the maximum range specified, which doesn't make much sense, since no intersection test is supposed to be done in the first place before the min and after the max distances.

virtual void makVrv::DtCigiLosBasicResponse::setRangeValid ( bool  valid )

virtual

virtual double makVrv::DtCigiLosBasicResponse::range ( ) const

virtual

The distance from the start of the intersector to the intersection.

virtual void makVrv::DtCigiLosBasicResponse::setRange ( double  r )

virtual

virtual DtUniqueID makVrv::DtCigiLosBasicResponse::entityHit ( ) const

virtual

Get/Set the scene object ID of the entity hit for this intersection, if any.

set to 0 if there wasn't an entity intersection

virtual void makVrv::DtCigiLosBasicResponse::setEntityHit ( DtUniqueID  source )

virtual

virtual int makVrv::DtCigiLosBasicResponse::cigiEntityHit ( ) const

virtual

Get/Set the cigi entity ID of the entity specified as the start point for the LOS request (or -1) if not set.

virtual void makVrv::DtCigiLosBasicResponse::setCigiEntityHit ( int  source )

virtual

virtual bool makVrv::DtCigiLosBasicResponse::endpointVisible ( ) const

virtual

Get/Set the endpointVisible flag.

This field is only used if the original LOS request was a segment request. It indicates if the endpoint of the segment was visible (in other words, NO intersections were found along the segment).

virtual void makVrv::DtCigiLosBasicResponse::setEndpointVisible ( bool  vis )

virtual

virtual unsigned int makVrv::DtCigiLosBasicResponse::responseCount ( ) const

virtual

Get/Set the response count.

This is the total number of intersections that were found when the intersection test was performed. It's up to the host to keep track of all the responses it should expect for a given losId

virtual void makVrv::DtCigiLosBasicResponse::setResponseCount ( unsigned int  count )

virtual

Friends And Related Function Documentation

friend class DtCigiLosBasicResponseCreator

friend

Friended so that the creator can call the (protected) CTOR.

Member Data Documentation

unsigned int makVrv::DtCigiLosBasicResponse::myLosId

protected

unsigned int makVrv::DtCigiLosBasicResponse::myHostFrameNumber

protected

bool makVrv::DtCigiLosBasicResponse::myRangeValid

protected

bool makVrv::DtCigiLosBasicResponse::myEndpointVisible

protected

unsigned int makVrv::DtCigiLosBasicResponse::myResponseCount

protected

DtUniqueID makVrv::DtCigiLosBasicResponse::myEntityHit

protected

int makVrv::DtCigiLosBasicResponse::myCigiEntityHit

protected

double makVrv::DtCigiLosBasicResponse::myRange

protected

---

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

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.tot/include/vrvCigi/DtCigiLosBasicResponse.h