makVrv::DtCigiViewManager Class Reference

This class manages mapping between CIGI views and VRV observers / channels.

Classes
struct	DtViewControlAction
struct	DtViewControlPosition
struct	DtViewDefinitionAction

Public Types
enum	CIGI_GROUP_ATTACH_TYPE { CigiAttachTypeTether = 252, CigiAttachTypeMimic = 253, CigiAttachTypeFollow = 254, CigiAttachTypeTrack = 255 }
using	DtViewGroup = std::set< int >
using	GroupIdToGroupMap = std::map< int, DtViewGroup >
using	ViewIdToPositionMap = std::map< int, DtViewControlPosition >

Public Member Functions
virtual	~DtCigiViewManager ()
virtual void	reset ()
virtual DtViewControlPosition	viewControlPosition (int viewId, const DtViewControlAction &action)
virtual void	addViewToGroup (int viewId, int groupId)
virtual void	removeViewFromGroups (int viewId)
virtual std::string	viewIdKeyword (int viewId)
virtual bool	retrieveConfiguration (DtDe &de, int viewId, std::string &displayName, std::string &windowName, std::string &channelName, DtChannelConfiguration &config)
virtual int	maxRenderOrder (DtDe &de, int viewId, std::string &displayName, std::string &windowName)
virtual DtObserver *	findObserverFromCigiViewId (DtDe &de, int viewId)
virtual DtChannel *	findChannelFromCigiViewId (DtDe &de, int viewId)
virtual void	getViewNames (DtDe &de, int viewId, std::string &displayName, std::string &windowName, std::string &channelName)
virtual const ViewIdToPositionMap &	viewIdToPositionMap () const
virtual ViewIdToPositionMap &	viewIdToPositionMap ()
virtual const GroupIdToGroupMap &	groupIdToGroupMap () const
virtual GroupIdToGroupMap &	groupIdToGroupMap ()
	DtCigiViewManager (const DtCigiViewManager &)=delete
	DtCigiViewManager (DtCigiViewManager &&)=delete
DtCigiViewManager &	operator= (const DtCigiViewManager &)=delete
DtCigiViewManager &	operator= (DtCigiViewManager &&)=delete

Public Attributes
boost::signalslib::signal < void(int, DtViewDefinitionAction)>	signal_receivedViewDefinition
boost::signalslib::signal < void(int, DtViewControlAction)>	signal_receivedViewControl

Protected Member Functions
	DtCigiViewManager (DtCigiConnection &connection)
virtual void	slot_processViewDefinition (CigiBaseViewDef &viewDefinition)
virtual void	slot_viewControlReceived (CigiBaseViewCtrl &viewControl)

Protected Attributes
DtCigiConnection &	myConnection
DtSignalConnectionManager	myCigiConnectionSignals
ViewIdToPositionMap	myViewIdToPositionMap
GroupIdToGroupMap	myGroupIdToGroupMap

Friends
class	DtCigiViewManagerCreator

Member Typedef Documentation

using makVrv::DtCigiViewManager::DtViewGroup = std::set<int>

using makVrv::DtCigiViewManager::GroupIdToGroupMap = std::map<int, DtViewGroup>

using makVrv::DtCigiViewManager::ViewIdToPositionMap = std::map<int, DtViewControlPosition>

Member Enumeration Documentation

enum makVrv::DtCigiViewManager::CIGI_GROUP_ATTACH_TYPE

Enumerator
CigiAttachTypeTether
CigiAttachTypeMimic
CigiAttachTypeFollow
CigiAttachTypeTrack

Constructor & Destructor Documentation

virtual makVrv::DtCigiViewManager::~DtCigiViewManager ( )

virtual

DTOR.

makVrv::DtCigiViewManager::DtCigiViewManager ( const DtCigiViewManager &  )

delete

Not allowed.

makVrv::DtCigiViewManager::DtCigiViewManager ( DtCigiViewManager &&  )

delete

Not allowed.

makVrv::DtCigiViewManager::DtCigiViewManager ( DtCigiConnection &  connection )

protected

CTOR.

Member Function Documentation

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

virtual

Get the map that provides a DtViewControlPosition from a viewId.

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

virtual

Get the map that provides a DtViewControlPosition from a viewId.

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

virtual

Get the map that provides a DtViewGroup from a groupId.

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

virtual

Get the map that provides a DtViewGroup from a groupId.

virtual void makVrv::DtCigiViewManager::reset ( )

virtual

Reset the internal containers when the CIGI connection is reset via IGMode reset.

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

virtual

Returns the position specified by the action.

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

virtual

Adds the specified view to the specified group.

virtual void makVrv::DtCigiViewManager::removeViewFromGroups ( int  viewId )

virtual

Remove a view id from the first group it is in It should only be in one group.

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

virtual

Will return cigiView + viewId.

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

virtual

Gets the configuration for the particular view. This will run in the main render thread if the cigi connection is running in a separate thread.

virtual int makVrv::DtCigiViewManager::maxRenderOrder ( DtDe &  de, int  viewId, std::string &  displayName, std::string &  windowName  )

virtual

Get the maximum value of the render order from all channels on in param display and window. Allows for View Definition reorder to bring a channel to the front.

virtual DtObserver* makVrv::DtCigiViewManager::findObserverFromCigiViewId ( DtDe &  de, int  viewId  )

virtual

Get the observer associated with this cigi view id. This will run in the main render thread if the cigi connection is running in a separate thread.

virtual DtChannel* makVrv::DtCigiViewManager::findChannelFromCigiViewId ( DtDe &  de, int  viewId  )

virtual

Find the channel with the cigi view id keyword This will run in the main render thread if the cigi connection is running in a separate thread.

virtual void makVrv::DtCigiViewManager::getViewNames ( DtDe &  de, int  viewId, std::string &  displayName, std::string &  windowName, std::string &  channelName  )

virtual

Get the display, window, channel name from the CIGI View ID.

DtCigiViewManager& makVrv::DtCigiViewManager::operator= ( const DtCigiViewManager &  )

delete

Not allowed.

DtCigiViewManager& makVrv::DtCigiViewManager::operator= ( DtCigiViewManager &&  )

delete

Not allowed.

virtual void makVrv::DtCigiViewManager::slot_processViewDefinition ( CigiBaseViewDef &  viewDefinition )

protectedvirtual

Processes View Definition messages. Packs a DtCigiViewController::DtViewDefinitionAction struct and emits a signal_receivedViewDefinition() from the connection.

virtual void makVrv::DtCigiViewManager::slot_viewControlReceived ( CigiBaseViewCtrl &  viewControl )

protectedvirtual

Slot processes view control messages.

Friends And Related Function Documentation

friend class DtCigiViewManagerCreator

friend

Member Data Documentation

boost::signalslib::signal<void( int, DtViewDefinitionAction )> makVrv::DtCigiViewManager::signal_receivedViewDefinition

Emitted when a CIGI View definition is received.

boost::signalslib::signal<void( int, DtViewControlAction )> makVrv::DtCigiViewManager::signal_receivedViewControl

Emitted when a CIGI View Control is received.

DtCigiConnection& makVrv::DtCigiViewManager::myConnection

protected

DtSignalConnectionManager makVrv::DtCigiViewManager::myCigiConnectionSignals

protected

ViewIdToPositionMap makVrv::DtCigiViewManager::myViewIdToPositionMap

protected

GroupIdToGroupMap makVrv::DtCigiViewManager::myGroupIdToGroupMap

protected

---

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

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