VR-Forces 4.0.4 Class Documentation
Classes | Public Member Functions | Protected Types | Protected Member Functions | Protected Attributes
makVrv::DtOsgOverlayManager Class Reference

The OSG overlay manager managers 2D graphical overlays. More...

Inheritance diagram for makVrv::DtOsgOverlayManager:
Inheritance graph
[legend]

List of all members.

Classes

class  DtPickableOverlay

Public Member Functions

 DtOsgOverlayManager (DtDe &de)
 CTOR.
 ~DtOsgOverlayManager ()
 DTOR.
DtDede ()
virtual bool handleMouseEvent (const DtMouseEvent &ev, DtChannel &channel)
 Handle a mouse event returns true if the event was consumed.
bool processWidgetEvent (DtElementID id, const DtMouseEvent &ev, DtChannel &channel)
 Process event on the element.
virtual void render (DtChannel *channel, bool projectedGeocentricEffect, float projectedGeocentricAlpha, double *position, double *matrix, double viewportSize[2])
 Render.
virtual void releaseResources ()
 Release any resources.
virtual
DtOsgOverlayResourceProvider
resourceProvider ()
 Get the resource provider.
DtOverlayRendereroverlayRenderer (unsigned int layerId)
 Get the renderer for any layer.
DtOverlayRendereroverlayRenderer (DtChannel *channel)
 Get the renderer for a channel-specific layer.
DtOverlayRendereroverlayRenderer3D (DtChannel *channel)
virtual void enableOverlayOnChannel (unsigned int layerId, bool enabled, DtChannel &channel)
 Enable an overlay on a channel.
DtWidgetPickerwidgetPicker (unsigned int layerId)
 Get the widget picker for any layer.
DtWidgetPickerwidgetPicker (DtChannel *channel)
 Get the widget picker for a channel-specific layer.
DtWidgetPickerwidgetPicker3D (DtChannel *channel)
virtual void destroyOverlayLayer (unsigned int layerId)
 Clear and destroy an overlay layer.
virtual bool overlayLayerIsVisible (unsigned int layerId) const
 Get whether an overlay layer is visible.
virtual void setOverlayLayerVisibility (unsigned int layerId, bool visible)
 Set whether an overlay layer is visible.
virtual void setPerformanceStatsOverlayEnabled (bool show)
 Set whether IG performance stats overlay is enabled.
virtual bool performanceStatsOverlayEnabled () const
 Get whether IG performance stats overlay is enabled.

Protected Types

typedef boost::unordered_map
< DtChannel *, unsigned int > 
ChannelSpecificOverlayMap
typedef boost::unordered_map
< unsigned int,
DtPickableOverlay * > 
OverlayMap
typedef boost::unordered_map
< DtChannel *, std::set
< unsigned int > > 
ChannelOverlayMap

Protected Member Functions

virtual void slot_channelToBeDestroyed (DtChannel *)
 Remove channel-specific overlay, if one exists.
unsigned int allocateChannelSpecificLayerId ()
 Get an unused channel specific layer id; throws exception if none are left.
void destroyChannelSpecificOverlayLayer (const ChannelSpecificOverlayMap &map, DtChannel *channel)
DtOverlayRendereroverlayRenderer (ChannelSpecificOverlayMap &map, DtChannel *channel)
 Get the renderer for a channel-specific layer.
DtWidgetPickerwidgetPicker (ChannelSpecificOverlayMap &map, DtChannel *channel)
 Get the widget picker for a channel-specific layer.

Protected Attributes

DtDemyDe
DtSignalConnectionManager myConnections
OverlayMap myOverlays
ChannelOverlayMap myChannelOverlayMap
ChannelSpecificOverlayMap myChannelSpecific2DOverlayMap
ChannelSpecificOverlayMap myChannelSpecific3DOverlayMap
bool myChannelSpecificLayerIdUsageList [Channel_SpecificEnd-Channel_SpecificStart+1]
DtOsgOverlayResourceProvidermyProvider

Detailed Description

The OSG overlay manager managers 2D graphical overlays.


Member Typedef Documentation

typedef boost::unordered_map<DtChannel*, unsigned int> makVrv::DtOsgOverlayManager::ChannelSpecificOverlayMap [protected]
typedef boost::unordered_map<unsigned int,DtPickableOverlay*> makVrv::DtOsgOverlayManager::OverlayMap [protected]
typedef boost::unordered_map<DtChannel*, std::set<unsigned int> > makVrv::DtOsgOverlayManager::ChannelOverlayMap [protected]

Constructor & Destructor Documentation

CTOR.

DTOR.


Member Function Documentation

virtual bool makVrv::DtOsgOverlayManager::handleMouseEvent ( const DtMouseEvent ev,
DtChannel channel 
) [virtual]

Handle a mouse event returns true if the event was consumed.

returns false if it was not.

Implements makVrv::DtOverlayManager.

Process event on the element.

Returns:
true if the event was consumed. returns false if it was not.
virtual void makVrv::DtOsgOverlayManager::render ( DtChannel channel,
bool  projectedGeocentricEffect,
float  projectedGeocentricAlpha,
double *  position,
double *  matrix,
double  viewportSize[2] 
) [virtual]

Render.

Implements makVrv::DtOverlayManager.

Release any resources.

Implements makVrv::DtOverlayManager.

Get the resource provider.

Get the renderer for any layer.

Get the renderer for a channel-specific layer.

virtual void makVrv::DtOsgOverlayManager::enableOverlayOnChannel ( unsigned int  layerId,
bool  enabled,
DtChannel channel 
) [virtual]

Enable an overlay on a channel.

Implements makVrv::DtOverlayManager.

Get the widget picker for any layer.

Get the widget picker for a channel-specific layer.

virtual void makVrv::DtOsgOverlayManager::destroyOverlayLayer ( unsigned int  layerId) [virtual]

Clear and destroy an overlay layer.

Implements makVrv::DtOverlayManager.

virtual bool makVrv::DtOsgOverlayManager::overlayLayerIsVisible ( unsigned int  layerId) const [virtual]

Get whether an overlay layer is visible.

Implements makVrv::DtOverlayManager.

virtual void makVrv::DtOsgOverlayManager::setOverlayLayerVisibility ( unsigned int  layerId,
bool  visible 
) [virtual]

Set whether an overlay layer is visible.

Parameters:
Input
visibletrue if to show the layer, false if to hide the layer.

Implements makVrv::DtOverlayManager.

Set whether IG performance stats overlay is enabled.

Implements makVrv::DtOverlayManager.

Get whether IG performance stats overlay is enabled.

Implements makVrv::DtOverlayManager.

virtual void makVrv::DtOsgOverlayManager::slot_channelToBeDestroyed ( DtChannel ) [protected, virtual]

Remove channel-specific overlay, if one exists.

Get an unused channel specific layer id; throws exception if none are left.

Get the renderer for a channel-specific layer.

Get the widget picker for a channel-specific layer.


Member Data Documentation


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

Document ID: Generated on Fri Jun 29 16:33:32 EDT 2012 from SVN revision 116588
Copyright © 2005-2012 VT MÄK Inc. All Rights Reserved (www.mak.com)