A render-side CIGI Frame is an object who is responsible for processing CIGI requests, belonging to the same CIGI frame, in the same render frame.

Supports the following properties that come from CIGI requests

Entity Releated Properties
- Position
- Orientation
View Related Properties
- Attached Location
- Is Bounding Volume Used for Attached Offsets
- Attach Type
- Primary Attachment
- Part Attachment
- Attached Orientation
- Attached X/Y/Z
- Attached Pitch/Roll/Yaw

This class has an agent implementation, see DtRenderSideCigiFrameAgent, which is used by the CIGI connection. The CIGI connection calls processFrameNumber(unsigned int) on CIGI Frames whose network packets have been processed on the network-side, e.g. read off the socket and decoded.

Classes
struct	DtCigiFrameObserverValues

struct	DtCigiFrameSceneObjectValues

struct	DtCigiFrameValues

Public Member Functions
	DtRenderSideCigiFrame (DtDe &de, DtUniqueID id)

virtual	~DtRenderSideCigiFrame ()

virtual void	reset ()

virtual void	setEntityPosition (unsigned int frameId, DtUniqueID sceneObjectId, const DtVector &position)

virtual void	setEntityOrientation (unsigned int frameId, DtUniqueID sceneObjectId, const DtTaitBryan &orientation)

virtual void	setObserverAttachedLocation (unsigned int frameId, const std::string &observerName, const DtVector &attachedPosition)

virtual void	setObserverUsesBoundingVolumeForAttachedOffsets (unsigned int frameId, const std::string &observerName, bool usesBoundingVolumeForAttachedOffsets)

virtual void	setObserverAttachType (unsigned int frameId, const std::string &observerName, int attachType)

virtual void	setObserverPrimaryAttachment (unsigned int frameId, const std::string &observerName, const DtObserver::ElementList &objects)

virtual void	setObserverPartAttachment (unsigned int frameId, const std::string &observerName, int partId)

virtual void	setObserverAttachedOrientation (unsigned int frameId, const std::string &observerName, const DtVector &attachedOrientation)

virtual void	setObserverAttachedX (unsigned int frameId, const std::string &observerName, double attachedX)

virtual void	setObserverAttachedY (unsigned int frameId, const std::string &observerName, double attachedY)

virtual void	setObserverAttachedZ (unsigned int frameId, const std::string &observerName, double attachedZ)

virtual void	setObserverAttachedYaw (unsigned int frameId, const std::string &observerName, double attachedYaw)

virtual void	setObserverAttachedPitch (unsigned int frameId, const std::string &observerName, double attachedPitch)

virtual void	setObserverAttachedRoll (unsigned int frameId, const std::string &observerName, double attachedRoll)

virtual void	processFrameNumber (unsigned int frameId)

Protected Member Functions
DtObserverObject *	findObserverObjectByName (const std::string &observerName) const

Protected Attributes
DtDe &	myDe

DtUniqueID	myUniqueId

std::map< unsigned int, DtCigiFrameValues >	myFrameIdToValuesMap

std::mutex	myMapMutex

Constructor & Destructor Documentation

makVrv::DtRenderSideCigiFrame::DtRenderSideCigiFrame	(	DtDe &	de,
		DtUniqueID	id
	)

CTOR.

virtual makVrv::DtRenderSideCigiFrame::~DtRenderSideCigiFrame ( )

virtual

Virtual DTOR.

Member Function Documentation

virtual void makVrv::DtRenderSideCigiFrame::reset ( )

virtual

Reset myFrameIdToValuesMap.

virtual void makVrv::DtRenderSideCigiFrame::setEntityPosition	(	unsigned int	frameId,
		DtUniqueID	sceneObjectId,
		const DtVector &	position
	)

virtual

Parameters

frameId	The frame id this property is set for
sceneObjectId	The unique id of the scene object that the passed in property will be applied to
position	A vector representing the new world position of the scene object

virtual void makVrv::DtRenderSideCigiFrame::setEntityOrientation	(	unsigned int	frameId,
		DtUniqueID	sceneObjectId,
		const DtTaitBryan &	orientation
	)

virtual

Parameters

frameId	The frame id this property is set for
sceneObjectId	The unique id of the scene object that the passed in property will be applied to
orientation	Tait bryan angles representing the new orientation of the scene object

virtual void makVrv::DtRenderSideCigiFrame::setObserverAttachedLocation	(	unsigned int	frameId,
		const std::string &	observerName,
		const DtVector &	attachedPosition
	)

virtual

Parameters

frameId	The frame id this property is set for
observerName	The observer to apply the passed in property to
attachedPosition	A vector representing the new local attached position of the observer

virtual void makVrv::DtRenderSideCigiFrame::setObserverUsesBoundingVolumeForAttachedOffsets	(	unsigned int	frameId,
		const std::string &	observerName,
		bool	usesBoundingVolumeForAttachedOffsets
	)

virtual

For use with DtObserver::setUsesBoundingVolumeForAttachedOffsets.

Parameters

frameId	The frame id this property is set for
observerName	The observer to apply the passed in property to
usesBoundingVolumeForAttachedOffsets	A boolean representing the whether or not the observer will use the scene object's bounding volume for attached offsets

virtual void makVrv::DtRenderSideCigiFrame::setObserverAttachType	(	unsigned int	frameId,
		const std::string &	observerName,
		int	attachType
	)

virtual

Parameters

frameId	The frame id this property is set for
observerName	The observer to apply the passed in property to
attachType	An integer representing the new attach type of the observer, see DtObserverObject::AttachType enumeration

virtual void makVrv::DtRenderSideCigiFrame::setObserverPrimaryAttachment	(	unsigned int	frameId,
		const std::string &	observerName,
		const DtObserver::ElementList &	objects
	)

virtual

Parameters

frameId	The frame id this property is set for
observerName	The observer to apply the passed in property to
objects	A list of ids of all elements the observer is attached to

virtual void makVrv::DtRenderSideCigiFrame::setObserverPartAttachment	(	unsigned int	frameId,
		const std::string &	observerName,
		int	partId
	)

virtual

Parameters

frameId	The frame id this observer orientation is set for
observerName	The observer to apply the passed in property to
partId	An integer identifier of the part the observer is attached to

virtual void makVrv::DtRenderSideCigiFrame::setObserverAttachedOrientation	(	unsigned int	frameId,
		const std::string &	observerName,
		const DtVector &	attachedOrientation
	)

virtual

Parameters

frameId	The frame id this property is set for
observerName	The observer to apply the passed in property to
attachedOrientation	A vector whose components are psi (x), theta (y), phi (z)

virtual void makVrv::DtRenderSideCigiFrame::setObserverAttachedX	(	unsigned int	frameId,
		const std::string &	observerName,
		double	attachedX
	)

virtual

Parameters

frameId	The frame id this property is set for
observerName	The observer to apply the passed in property to
attachedX	The X offset, in meters, of the observer when attached

virtual void makVrv::DtRenderSideCigiFrame::setObserverAttachedY	(	unsigned int	frameId,
		const std::string &	observerName,
		double	attachedY
	)

virtual

Parameters

frameId	The frame id this property is set for
observerName	The observer to apply the passed in property to
attachedX	The Y offset, in meters, of the observer when attached

virtual void makVrv::DtRenderSideCigiFrame::setObserverAttachedZ	(	unsigned int	frameId,
		const std::string &	observerName,
		double	attachedZ
	)

virtual

Parameters

frameId	The frame id this property is set for
observerName	The observer to apply the passed in property to
attachedX	The Z offset, in meters, of the observer when attached

virtual void makVrv::DtRenderSideCigiFrame::setObserverAttachedYaw	(	unsigned int	frameId,
		const std::string &	observerName,
		double	attachedYaw
	)

virtual

Parameters

frameId	The frame id this property is set for
observerName	The observer to apply the passed in property to
attachedYaw	The Yaw angle, in radians, of the observer when attached

virtual void makVrv::DtRenderSideCigiFrame::setObserverAttachedPitch	(	unsigned int	frameId,
		const std::string &	observerName,
		double	attachedPitch
	)

virtual

Parameters

frameId	The frame id this observer orientation is set for
observerName	The observer to apply the passed in property to
attachedPitch	The Pitch angle, in radians, of the observer when attached

virtual void makVrv::DtRenderSideCigiFrame::setObserverAttachedRoll	(	unsigned int	frameId,
		const std::string &	observerName,
		double	attachedRoll
	)

virtual

Parameters

frameId	The frame id this property is set for
observerName	The observer to apply the passed in property to
attachedRoll	The Roll angle, in radians, of the observer when attached

virtual void makVrv::DtRenderSideCigiFrame::processFrameNumber ( unsigned int frameId )

virtual

Parameters

frameId The frame id to process

DtObserverObject* makVrv::DtRenderSideCigiFrame::findObserverObjectByName ( const std::string & observerName ) const

protected

Member Data Documentation

DtDe& makVrv::DtRenderSideCigiFrame::myDe

protected

DtUniqueID makVrv::DtRenderSideCigiFrame::myUniqueId

protected

std::map<unsigned int, DtCigiFrameValues> makVrv::DtRenderSideCigiFrame::myFrameIdToValuesMap

protected

std::mutex makVrv::DtRenderSideCigiFrame::myMapMutex

protected

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

/data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-2-branch/include/vrvCigi/DtRenderSideCigiFrame.h

Classes

Public Member Functions

Protected Member Functions

Protected Attributes

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation