makVrv::DtOverlayManager Class Reference

Abstract base class for managing the overlays. More...

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 ()
virtual void	render (DtChannel *channel, bool projectedGeocentricEffect, float geocentricAlpha, double *position, double *matrix, double *projectionMatrix, double viewportSize[2])=0
	Render. More...
virtual void	releaseResources ()=0
	Release any resources. More...
virtual void	enableOverlayOnChannel (unsigned int layerId, bool enabled, DtChannel &channel)=0
virtual bool	handleMouseEvent (const DtMouseEvent &ev, DtChannel &channel)=0
	Handle a mouse event returns true if the event was consumed. More...
virtual void	destroyOverlayLayer (unsigned int layerId)=0
	Clear and destroy an overlay layer. More...
virtual bool	overlayLayerIsVisible (unsigned int layerId) const =0
	Get whether an overlay layer is visible. More...
virtual void	setOverlayLayerVisibility (unsigned int layerId, bool visible)=0
	Set whether an overlay layer is visible. More...

Static Public Member Functions
static DefaultOverlays	modelSetToOverlay (unsigned int modelSet)
	Convert model set to overlay. More...

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

Detailed Description

Abstract base class for managing the overlays.

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

(

)

virtual makVrv::DtOverlayManager::~DtOverlayManager ( )

virtual

Member Function Documentation

virtual void makVrv::DtOverlayManager::render ( DtChannel *  channel, bool  projectedGeocentricEffect, float  geocentricAlpha, double *  position, double *  matrix, double *  projectionMatrix, double  viewportSize[2]  )

pure virtual

Render.

Implemented in makVrv::DtOsgOverlayManager.

virtual void makVrv::DtOverlayManager::releaseResources ( )

pure virtual

Release any resources.

Implemented in makVrv::DtOsgOverlayManager.

static DefaultOverlays makVrv::DtOverlayManager::modelSetToOverlay ( unsigned int  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.

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::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.vrf4-8-branch/include/vrvCore/DtOverlayManager.h