A DtCigiViewControl receives messages from the DtCigiConnection and actually changes the channel settings or attaches an observer. More...

Classes
struct	DtViewControlAction
	Structure for a view control action. More...

struct	DtViewControlPosition
	Structure for the position of a view. More...

struct	DtViewDefinitionAction
	Structure defines a view definition action. More...

Public Types
enum	CIGI_GROUP_ATTACH_TYPE { CigiAttachTypeTether = 252, CigiAttachTypeMimic = 253, CigiAttachTypeFollow = 254, CigiAttachTypeTrack = 255 }

typedef std::set< int >	DtViewGroup

typedef std::map< int, DtViewGroup >	GroupIdToGroupMap

typedef std::map< int, DtViewControlPosition >	ViewIdToPositionMap

Public Member Functions
virtual	~DtCigiViewController ()
	Destructor. More...

virtual std::string	viewIdKeyword (int viewId)
	Will return cigiView + viewId. More...

virtual bool	retrieveConfiguration (int viewId, std::string &displayName, std::string &windowName, std::string &channelName, DtChannelConfiguration &config)
	Gets the configuration for the particular view. More...


virtual const ViewIdToPositionMap &	viewIdToPositionMap () const
	Get the map that provides a DtViewControlPosition from a viewId. More...

virtual ViewIdToPositionMap &	viewIdToPositionMap ()


virtual const GroupIdToGroupMap &	groupIdToGroupMap () const
	Get the map that provides a DtViewGroup from a groupId. More...

virtual GroupIdToGroupMap &	groupIdToGroupMap ()

Protected Member Functions
	DtCigiViewController (DtDe &de, DtCigiConnection &connection)
	Constructor. More...

virtual void	modifyConfiguration (const std::string &displayName, const std::string &windowName, const std::string &channelName, const DtChannelConfiguration &config)
	Changes the channel configuration. More...

virtual void	attachObserver (int viewId, const DtViewControlAction &action, DtObserverObject::AttachType attachType=DtObserverObject::AttachTypeMimic, int artPartID=0)
	Attach the observer of the specified view, using the parameters in action. More...

virtual DtViewControlPosition	viewControlPosition (int viewId, const DtViewControlAction &action)
	Returns the position specified by the action. More...

virtual void	addViewToGroup (int viewId, int groupId)
	Adds the specified view to the specified group. More...

virtual void	slot_onViewDefinitionReceived (int viewId, DtCigiViewController::DtViewDefinitionAction action)
	Called when we receive a view definition. More...

virtual void	performSetViewDefinition (int viewId, const DtCigiViewController::DtViewDefinitionAction &action)
	Perform the view definition action in a thread-safe way. More...

virtual void	slot_onViewControlReceived (int viewId, DtCigiViewController::DtViewControlAction action)
	Called when a view control is received. More...

virtual void	performSetViewControl (int viewId, const DtCigiViewController::DtViewControlAction &action)
	Perform the view control in a thread-safe way. More...

virtual void	slot_onViewMagnificationReceived (int viewId, float magValue, bool viewIsGroup)
	Called when a view magnification is received. More...

virtual void	performSetViewMagnification (int viewId, float magValue, bool viewIsGroup)
	Perform the operation requested in slot_onViewMagnificationReceived in the main (render) thread. More...

virtual void	slot_onLodScaleReceived (int viewId, float scale, bool viewIsGroup)
	Called when a lod scale setting is received. More...

virtual void	performSetLodScale (int viewId, float scale, bool viewIsGroup)
	Perform the operation requested in slot_onLodScaleReceived in the main (render) thread. More...

virtual void	slot_onAttachViewToArtPartReceived (int viewId, int groupId, DtUniqueID entityId, int artPartId)
	Called when a view or view group is attached to an articulated part This method checks if the Cigi connection is using a thread, if so queues the function. More...

virtual void	performAttachViewToArtPart (int viewId, int groupId, DtUniqueID entityId, int artPartId)
	Perform the operation requested in slot_onAttachViewToArtPartReceived. More...

virtual void	slot_onSensorControlRequest (DtSensorResponder::DtSensorRequestData *request)
	Signal sent from DtSensorResponder This method checks if the Cigi connection is using a thread, if so queues the function. More...

virtual void	performSensorControlRequest (DtSensorResponder::DtSensorRequestData &request)
	Performs the sensor operation on the ViewId in the request. More...

Protected Attributes
DtDe &	myDe

DtCigiConnection &	myCigiConnection

DtSignalConnectionManager	myConnections

DtMasterSensorController *	myMasterSensorController
	This can only be used from the render thread! More...

ViewIdToPositionMap	myViewIdToPositionMap

GroupIdToGroupMap	myGroupIdToGroupMap

Friends
class	DtCigiViewControllerCreator

Detailed Description

A DtCigiViewControl receives messages from the DtCigiConnection and actually changes the channel settings or attaches an observer.

Member Typedef Documentation

typedef std::set<int> makVrv::DtCigiViewController::DtViewGroup

typedef std::map<int, DtViewGroup> makVrv::DtCigiViewController::GroupIdToGroupMap

typedef std::map<int, DtViewControlPosition> makVrv::DtCigiViewController::ViewIdToPositionMap

Member Enumeration Documentation

enum makVrv::DtCigiViewController::CIGI_GROUP_ATTACH_TYPE

Enumerator
CigiAttachTypeTether
CigiAttachTypeMimic
CigiAttachTypeFollow
CigiAttachTypeTrack

Constructor & Destructor Documentation

virtual makVrv::DtCigiViewController::~DtCigiViewController ( )

virtual

Destructor.

makVrv::DtCigiViewController::DtCigiViewController	(	DtDe &	de,
		DtCigiConnection &	connection
	)

protected

Constructor.

Member Function Documentation

virtual std::string makVrv::DtCigiViewController::viewIdKeyword ( int viewId )

virtual

Will return cigiView + viewId.

virtual const ViewIdToPositionMap& makVrv::DtCigiViewController::viewIdToPositionMap ( ) const

virtual

Get the map that provides a DtViewControlPosition from a viewId.

virtual ViewIdToPositionMap& makVrv::DtCigiViewController::viewIdToPositionMap ( )

virtual

virtual const GroupIdToGroupMap& makVrv::DtCigiViewController::groupIdToGroupMap ( ) const

virtual

Get the map that provides a DtViewGroup from a groupId.

virtual GroupIdToGroupMap& makVrv::DtCigiViewController::groupIdToGroupMap ( )

virtual

virtual bool makVrv::DtCigiViewController::retrieveConfiguration	(	int	viewId,
		std::string &	displayName,
		std::string &	windowName,
		std::string &	channelName,
		DtChannelConfiguration &	config
	)

virtual

Gets the configuration for the particular view.

virtual void makVrv::DtCigiViewController::modifyConfiguration	(	const std::string &	displayName,
		const std::string &	windowName,
		const std::string &	channelName,
		const DtChannelConfiguration &	config
	)

protectedvirtual

Changes the channel configuration.

virtual void makVrv::DtCigiViewController::attachObserver	(	int	viewId,
		const DtViewControlAction &	action,
		DtObserverObject::AttachType	attachType = `DtObserverObject::AttachTypeMimic`,
		int	artPartID = `0`
	)

protectedvirtual

Attach the observer of the specified view, using the parameters in action.

virtual DtViewControlPosition makVrv::DtCigiViewController::viewControlPosition	(	int	viewId,
		const DtViewControlAction &	action
	)

protectedvirtual

Returns the position specified by the action.

virtual void makVrv::DtCigiViewController::addViewToGroup	(	int	viewId,
		int	groupId
	)

protectedvirtual

Adds the specified view to the specified group.

virtual void makVrv::DtCigiViewController::slot_onViewDefinitionReceived	(	int	viewId,
		DtCigiViewController::DtViewDefinitionAction	action
	)

protectedvirtual

Called when we receive a view definition.

virtual void makVrv::DtCigiViewController::performSetViewDefinition	(	int	viewId,
		const DtCigiViewController::DtViewDefinitionAction &	action
	)

protectedvirtual

Perform the view definition action in a thread-safe way.

virtual void makVrv::DtCigiViewController::slot_onViewControlReceived	(	int	viewId,
		DtCigiViewController::DtViewControlAction	action
	)

protectedvirtual

Called when a view control is received.

virtual void makVrv::DtCigiViewController::performSetViewControl	(	int	viewId,
		const DtCigiViewController::DtViewControlAction &	action
	)

protectedvirtual

Perform the view control in a thread-safe way.

virtual void makVrv::DtCigiViewController::slot_onViewMagnificationReceived	(	int	viewId,
		float	magValue,
		bool	viewIsGroup
	)

protectedvirtual

Called when a view magnification is received.

virtual void makVrv::DtCigiViewController::performSetViewMagnification	(	int	viewId,
		float	magValue,
		bool	viewIsGroup
	)

protectedvirtual

Perform the operation requested in slot_onViewMagnificationReceived in the main (render) thread.

virtual void makVrv::DtCigiViewController::slot_onLodScaleReceived	(	int	viewId,
		float	scale,
		bool	viewIsGroup
	)

protectedvirtual

Called when a lod scale setting is received.

virtual void makVrv::DtCigiViewController::performSetLodScale	(	int	viewId,
		float	scale,
		bool	viewIsGroup
	)

protectedvirtual

Perform the operation requested in slot_onLodScaleReceived in the main (render) thread.

virtual void makVrv::DtCigiViewController::slot_onAttachViewToArtPartReceived	(	int	viewId,
		int	groupId,
		DtUniqueID	entityId,
		int	artPartId
	)

protectedvirtual

Called when a view or view group is attached to an articulated part This method checks if the Cigi connection is using a thread, if so queues the function.

virtual void makVrv::DtCigiViewController::performAttachViewToArtPart	(	int	viewId,
		int	groupId,
		DtUniqueID	entityId,
		int	artPartId
	)

protectedvirtual

Perform the operation requested in slot_onAttachViewToArtPartReceived.

virtual void makVrv::DtCigiViewController::slot_onSensorControlRequest ( DtSensorResponder::DtSensorRequestData * request )

protectedvirtual

Signal sent from DtSensorResponder This method checks if the Cigi connection is using a thread, if so queues the function.

virtual void makVrv::DtCigiViewController::performSensorControlRequest ( DtSensorResponder::DtSensorRequestData & request )

protectedvirtual

Performs the sensor operation on the ViewId in the request.

Friends And Related Function Documentation

friend class DtCigiViewControllerCreator

friend

Member Data Documentation

DtDe& makVrv::DtCigiViewController::myDe

protected

DtCigiConnection& makVrv::DtCigiViewController::myCigiConnection

protected

DtSignalConnectionManager makVrv::DtCigiViewController::myConnections

protected

DtMasterSensorController* makVrv::DtCigiViewController::myMasterSensorController

protected

This can only be used from the render thread!

ViewIdToPositionMap makVrv::DtCigiViewController::myViewIdToPositionMap

protected

GroupIdToGroupMap makVrv::DtCigiViewController::myGroupIdToGroupMap

protected

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

/data/exports/nrhent7-1/nightly/docs/vrForces.vrf4-8-branch/include/vrvCigi/DtCigiViewController.h

Classes

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Friends

Detailed Description

Member Typedef Documentation

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation