VR-Forces 4.6.1 Class Documentation
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
List of all members | Classes | Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | Friends
makVrv::DtCigiViewController Class Reference

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< intDtViewGroup
typedef std::map< int,
DtViewGroup
GroupIdToGroupMap
typedef std::map< int,
DtViewControlPosition
ViewIdToPositionMap

Public Member Functions

virtual ~DtCigiViewController ()
 Destructor.
virtual std::string viewIdKeyword (int viewId)
 Will return cigiView + viewId.
virtual const ViewIdToPositionMapviewIdToPositionMap () const
 Get the map that provides a DtViewControlPosition from a viewId.
virtual ViewIdToPositionMapviewIdToPositionMap ()
virtual const GroupIdToGroupMapgroupIdToGroupMap () const
 Get the map that provides a DtViewGroup from a groupId.
virtual GroupIdToGroupMapgroupIdToGroupMap ()

Protected Member Functions

 DtCigiViewController (DtDe &de, DtCigiConnection &connection)
 Constructor.
virtual void modifyConfiguration (const std::string &displayName, const std::string &windowName, const std::string &channelName, const DtChannelConfiguration &config)
 Changes the channel configuration.
virtual bool retrieveConfiguration (int viewId, std::string &displayName, std::string &windowName, std::string &channelName, DtChannelConfiguration &config)
 Gets the configuration for the particular view.
virtual void attachObserver (int viewId, const DtViewControlAction &action, DtObserverObject::AttachType attachType=DtObserverObject::AttachTypeMimic)
 Attach the observer of the specified view, using the parameters in action.
virtual DtViewControlPosition viewControlPosition (int viewId, const DtViewControlAction &action)
 Returns the position specified by the action.
virtual void addViewToGroup (int viewId, int groupId)
 Adds the specified view to the specified group.
virtual void slot_onViewDefinitionReceived (int viewId, DtCigiViewController::DtViewDefinitionAction action)
 Called when we receive a view definition.
virtual void performSetViewDefinition (int viewId, const DtCigiViewController::DtViewDefinitionAction &action)
 Perform the view definition action in a thread-safe way.
virtual void slot_onViewControlReceived (int viewId, DtCigiViewController::DtViewControlAction action)
 Called when a view control is received.
virtual void performSetViewControl (int viewId, const DtCigiViewController::DtViewControlAction &action)
 Perform the view control in a thread-safe way.

Protected Attributes

DtDemyDe
DtCigiConnectionmyCigiConnection
DtSignalConnectionManager myConnections
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

Member Enumeration Documentation

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 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 bool makVrv::DtCigiViewController::retrieveConfiguration ( int  viewId,
std::string &  displayName,
std::string &  windowName,
std::string &  channelName,
DtChannelConfiguration config 
)
protectedvirtual

Gets the configuration for the particular view.

virtual void makVrv::DtCigiViewController::attachObserver ( int  viewId,
const DtViewControlAction action,
DtObserverObject::AttachType  attachType = DtObserverObject::AttachTypeMimic 
)
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.

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
ViewIdToPositionMap makVrv::DtCigiViewController::myViewIdToPositionMap
protected
GroupIdToGroupMap makVrv::DtCigiViewController::myGroupIdToGroupMap
protected

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

Document ID: Generated on Wed Jul 25 16:57:45 EDT 2018 from SVN revision 190790
Copyright © 2005-2018 VT MÄK. All Rights Reserved (www.mak.com)