makVrv::DtOverlayManager Class Reference

Abstract base class for managing the overlays.

Inheritance diagram for makVrv::DtOverlayManager:

Public Types
enum	DefaultOverlays {   InvalidOverlay = 0, ModelSet_3D_Overlay, ModelSet_3D_XR_Overlay, ModelSet_3D_Sensor_Overlay,   ModelSet_3D_Icons_Overlay, ModelSet_3D_Images_Overlay, ModelSet_2D_Icons_Overlay, ModelSet_2D_Images_Overlay,   ModelSet_UserStart, ModelSet_UserEnd = ModelSet_UserStart + 16, Channel_SpecificStart, Channel_SpecificEnd = Channel_SpecificStart + 128,   RemoteDisplayOverlay, RemoteDisplayWorldOverlay, SensorViewOverlay, UserStart }

Public Member Functions
	DtOverlayManager ()
virtual	~DtOverlayManager ()
	DtOverlayManager (const DtOverlayManager &)=delete
DtOverlayManager &	operator= (const DtOverlayManager &)=delete
virtual void	render (DtChannel *channel, const DtOverlayRenderData &overlayRenderData, const DtObserverRenderData &channelRenderData, const double *currentProjectionMatrix)=0
virtual void	releaseResources ()=0
virtual DtOverlayRendererInterface &	overlayRenderer (unsigned int layerId)=0
virtual DtOverlayRendererInterface &	overlayRendererEmptyScene (DtChannel *channel)=0
virtual DtOverlayRendererInterface &	overlayRenderer (DtChannel *channel)=0
virtual DtOverlayRendererInterface &	overlayRenderer3D (DtChannel *channel)=0
virtual DtOverlayRendererInterface &	overlayRenderer2DNormalized (DtChannel *channel)=0
virtual DtOverlayRendererInterface &	overlayRenderer (DtChannel *channel, DtModelSetId modelSet)=0
virtual DtWidgetPicker &	widgetPicker (unsigned int layerId)=0
virtual DtWidgetPicker &	widgetPicker (DtChannel *channel)=0
virtual DtWidgetPicker &	widgetPicker3D (DtChannel *channel)=0
virtual DtWidgetPicker &	widgetPicker2DNormalized (DtChannel *channel)=0
virtual DtWidgetPicker &	widgetPicker (DtChannel *channel, DtModelSetId modelSet)=0
virtual void	enableOverlayOnChannel (unsigned int layerId, bool enabled, DtChannel &channel)=0
virtual bool	handleMouseEvent (const DtMouseEvent &ev, DtChannel &channel)=0
virtual void	destroyOverlayLayer (unsigned int layerId)=0
virtual bool	overlayLayerIsVisible (unsigned int layerId) const =0
virtual void	setOverlayLayerVisibility (unsigned int layerId, bool visible)=0

Static Public Member Functions
static DefaultOverlays	modelSetToOverlay (DtModelSetId modelSet)

Public Attributes
boost::signalslib::signal < void(DtChannel *channel, DefaultOverlays overlay)>	signal_overlayAboutToBeRendered

Member Enumeration Documentation

enum makVrv::DtOverlayManager::DefaultOverlays

Enumerator
InvalidOverlay
ModelSet_3D_Overlay
ModelSet_3D_XR_Overlay
ModelSet_3D_Sensor_Overlay
ModelSet_3D_Icons_Overlay
ModelSet_3D_Images_Overlay
ModelSet_2D_Icons_Overlay
ModelSet_2D_Images_Overlay
ModelSet_UserStart
ModelSet_UserEnd
Channel_SpecificStart
Channel_SpecificEnd
RemoteDisplayOverlay
RemoteDisplayWorldOverlay
SensorViewOverlay
UserStart

Constructor & Destructor Documentation

makVrv::DtOverlayManager::DtOverlayManager

(

)

CTOR.

virtual makVrv::DtOverlayManager::~DtOverlayManager ( )

virtual

DTOR.

makVrv::DtOverlayManager::DtOverlayManager ( const DtOverlayManager &  )

delete

Copy CTOR (Not Implemented)

Member Function Documentation

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

delete

Assignment Operator (Not Implemented)

virtual void makVrv::DtOverlayManager::render ( DtChannel *  channel, const DtOverlayRenderData &  overlayRenderData, const DtObserverRenderData &  channelRenderData, const double *  currentProjectionMatrix  )

pure virtual

Render.

Implemented in makVrv::DtOsgOverlayManager.

virtual void makVrv::DtOverlayManager::releaseResources ( )

pure virtual

Release any resources.

Implemented in makVrv::DtOsgOverlayManager.

virtual DtOverlayRendererInterface& makVrv::DtOverlayManager::overlayRenderer ( unsigned int  layerId )

pure virtual

Get the renderer for any layer.

Implemented in makVrv::DtOsgOverlayManager.

virtual DtOverlayRendererInterface& makVrv::DtOverlayManager::overlayRendererEmptyScene ( DtChannel *  channel )

pure virtual

Get the renderer for a channel-specific layer. This overlay will return a layer where the camera maintains a fixed position.

Implemented in makVrv::DtOsgOverlayManager.

virtual DtOverlayRendererInterface& makVrv::DtOverlayManager::overlayRenderer ( DtChannel *  channel )

pure virtual

Implemented in makVrv::DtOsgOverlayManager.

virtual DtOverlayRendererInterface& makVrv::DtOverlayManager::overlayRenderer3D ( DtChannel *  channel )

pure virtual

Implemented in makVrv::DtOsgOverlayManager.

virtual DtOverlayRendererInterface& makVrv::DtOverlayManager::overlayRenderer2DNormalized ( DtChannel *  channel )

pure virtual

Implemented in makVrv::DtOsgOverlayManager.

virtual DtOverlayRendererInterface& makVrv::DtOverlayManager::overlayRenderer ( DtChannel *  channel, DtModelSetId  modelSet  )

pure virtual

Get the renderer for a channel-specific layer. This overlay will return a layer where the camera is the current eye position in the channel.

Implemented in makVrv::DtOsgOverlayManager.

virtual DtWidgetPicker& makVrv::DtOverlayManager::widgetPicker ( unsigned int  layerId )

pure virtual

Implemented in makVrv::DtOsgOverlayManager.

virtual DtWidgetPicker& makVrv::DtOverlayManager::widgetPicker ( DtChannel *  channel )

pure virtual

Get the widget picker for a channel-specific layer. Uses fixed position camera.

Implemented in makVrv::DtOsgOverlayManager.

virtual DtWidgetPicker& makVrv::DtOverlayManager::widgetPicker3D ( DtChannel *  channel )

pure virtual

Implemented in makVrv::DtOsgOverlayManager.

virtual DtWidgetPicker& makVrv::DtOverlayManager::widgetPicker2DNormalized ( DtChannel *  channel )

pure virtual

Implemented in makVrv::DtOsgOverlayManager.

virtual DtWidgetPicker& makVrv::DtOverlayManager::widgetPicker ( DtChannel *  channel, DtModelSetId  modelSet  )

pure virtual

Get the widget picker for a channel-specific layer. Uses eye position camera.

Implemented in makVrv::DtOsgOverlayManager.

static DefaultOverlays makVrv::DtOverlayManager::modelSetToOverlay ( DtModelSetId  modelSet )

static

Convert model set to overlay.

virtual void makVrv::DtOverlayManager::enableOverlayOnChannel ( unsigned int  layerId, bool  enabled, DtChannel &  channel  )

pure virtual

Implemented in makVrv::DtOsgOverlayManager.

virtual bool makVrv::DtOverlayManager::handleMouseEvent ( const DtMouseEvent &  ev, DtChannel &  channel  )

pure virtual

Handle a mouse event returns true if the event was consumed. returns false if it was not.

Implemented in makVrv::DtOsgOverlayManager, and makVrf::DtVrfOsgOverlayManager.

virtual void makVrv::DtOverlayManager::destroyOverlayLayer ( unsigned int  layerId )

pure virtual

Clear and destroy an overlay layer.

Implemented in makVrv::DtOsgOverlayManager.

virtual bool makVrv::DtOverlayManager::overlayLayerIsVisible ( unsigned int  layerId ) const

pure virtual

Get whether an overlay layer is visible.

Implemented in makVrv::DtOsgOverlayManager.

virtual void makVrv::DtOverlayManager::setOverlayLayerVisibility ( unsigned int  layerId, bool  visible  )

pure virtual

Set whether an overlay layer is visible.

Parameters

Input
visible	true if to show the layer, false if to hide the layer.

Implemented in makVrv::DtOsgOverlayManager.

Member Data Documentation

boost::signalslib::signal<void (DtChannel* channel, DefaultOverlays overlay)> makVrv::DtOverlayManager::signal_overlayAboutToBeRendered

---

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

• /data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-1-branch/include/vrvCore/DtOverlayManager.h