VR-Forces 5.0.2 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 Member Functions | Protected Attributes | Private Member Functions | Friends
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.

Inheritance diagram for makVrv::DtCigiLosBasicResponse:
Inheritance graph
[legend]

Public Member Functions

virtual ~DtCigiLosBasicResponse ()
 
DtCigiLosBasicResponseoperator= (const DtCigiLosBasicResponse &rhs)
 
virtual unsigned int losId () const
 
virtual void setLosId (unsigned int id)
 
virtual unsigned int hostFrameNumber () const
 
virtual void setHostFrameNumber (unsigned int frameNum)
 
virtual bool rangeValid () const
 
virtual void setRangeValid (bool valid)
 
virtual double range () const
 
virtual void setRange (double r)
 
virtual DtUniqueID entityHit () const
 
virtual void setEntityHit (DtUniqueID source)
 
virtual int cigiEntityHit () const
 
virtual void setCigiEntityHit (int source)
 
virtual std::string connectionObjectEntityHit () const
 
virtual void setConnectionObjectEntityHit (std::string source)
 
virtual bool endpointVisible () const
 
virtual void setEndpointVisible (bool vis)
 
virtual unsigned int responseCount () const
 
virtual void setResponseCount (unsigned int count)
 

Protected Member Functions

 DtCigiLosBasicResponse ()
 

Protected Attributes

unsigned int myLosId
 
unsigned int myHostFrameNumber
 
bool myRangeValid
 
bool myEndpointVisible
 
unsigned int myResponseCount
 
DtUniqueID myEntityHit
 
int myCigiEntityHit
 
std::string myConnectionObjectEntityHit
 
double myRange
 

Private Member Functions

 DtCigiLosBasicResponse (const DtCigiLosBasicResponse &orig)
 

Friends

class DtCigiLosBasicResponseCreator
 

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

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

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

Get/Set the hostFrameNumber for this request. If the request is periodic, this will be updated for each request.

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

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

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

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

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

virtual std::string makVrv::DtCigiLosBasicResponse::connectionObjectEntityHit ( ) const
virtual

Get/Set the DtElementAttributeConnectionObjectID entity ID of the object that is hit for the LOS request.

virtual void makVrv::DtCigiLosBasicResponse::setConnectionObjectEntityHit ( std::string  source)
virtual

Get/Set the DtElementAttributeConnectionObjectID entity ID of the object that is hit for the LOS request.

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

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

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.

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
std::string makVrv::DtCigiLosBasicResponse::myConnectionObjectEntityHit
protected
double makVrv::DtCigiLosBasicResponse::myRange
protected

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

Document ID: Generated on Sun Dec 4 20:22:03 EST 2022 from SVN revision 249613
Copyright © 2005-2021 MAK Technologies. All Rights Reserved (www.mak.com)