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

DtTacticalGraphicOverlayManager objects hold the state (visible or not) of tactical graphics overlays. More...

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

List of all members.

Classes

class  DtTacticalGraphicOverlayMember
 DtOverlayItem Holds information about the tactical graphics managed by the Tactical Graphic Overlay Manager. More...

Public Types

typedef std::list
< DtTacticalGraphicOverlay * > 
DtTacticalGraphicOverlayList
typedef std::vector
< DtElementEntry::ElementType
TacticalGraphicTypeVector

Public Member Functions

virtual ~DtTacticalGraphicOverlayManager ()
 Destructor.
virtual void addTacticalGraphic (const DtUniqueID &id, const std::string &name)
 Adds a tactical graphic with the given id and name.
virtual const std::string * tacticalGraphicName (const DtUniqueID &id) const
 Returns the name of the tactical graphic associated with the id if no graphic is found, returns 0.
virtual void removeTacticalGraphic (const DtUniqueID &id)
 Removes the tactical graphic with the given id from the manager emits signal_tacticalGraphicRemoved if graphic is found/removed.
virtual void renameTacticalGraphic (const DtUniqueID &id, const std::string &newName)
 Renames the tactical graphic with the given id to the new name inside the manager emits signal_tacticalGraphicRenamed if graphic is found/renamed.
virtual void renameTacticalGraphicOverlay (const DtUniqueID &id, const std::string &newName)
 Renames the tactical graphic's overlay to the new name inside the manager emits signal_tacticalGraphicOverlayRenamed if successful (id found and overlay renamed)
virtual void setTacticalGraphicVisible (const DtUniqueID &id, bool flag)
 Updates the visibility status of a tactical graphic inside the manager.
virtual std::string newOverlay ()
 Creates a new overlay with a default name.
virtual void addOverlay (const std::string name)
 Creates a new overlay with the given name.
virtual void deleteOverlay (const std::string &name)
 Removes the overlay with the given name from the manager.
virtual void renameOverlay (const std::string &oldName, const std::string &newName)
 Renames the overlay with the oldName to newName emits signal_overlayRenamed if overlay is successfully renamed.
virtual DtTacticalGraphicOverlayfindOverlay (const std::string &name) const
 Finds the overlay associated with the given name.
virtual
DtTacticalGraphicOverlayList 
overlays () const
 Returns the list of overlays currently registered in the manager.
virtual bool overlayVisible (const std::string &overlayName) const
 Set/Get the visible status of the given overlay.
virtual void setOverlayVisible (const std::string &overlayName, bool flag)
virtual bool overlayFiltered (const std::string &overlayName) const
 Set/Get the visible status of the given overlay.
virtual void setOverlayFiltered (const std::string &overlayName, bool flag)
virtual bool overlayLocked (const std::string &overlayName) const
 Set/Get the lock status of the given overlay.
virtual void setOverlayLocked (const std::string &overlayName, bool flag)
virtual const
DtTacticalGraphicOverlay
currentOverlay () const
 Set/Get the overlay marked as 'current overlay' inside the manager.
virtual void setCurrentOverlay (const std::string &name)
virtual void setTacticalGraphicTypes (const TacticalGraphicTypeVector &)
 Sets the types valid to be placed on an overlay layer.
virtual const
TacticalGraphicTypeVector
tacticalGraphicTypes () const
 Returns current tactical graphic types.
virtual bool isTacticalGraphic (const DtUniqueID &id) const
 Returns true if this particular element can be placed on an overlay layer.

Static Public Member Functions

static
DtTacticalGraphicOverlayManager
instance (DtDe &de)
static void registerInstance (DtDe &de, DtTacticalGraphicOverlayManager *mgr)

Public Attributes

boost::signal< void(const
DtUniqueID &, const
std::string &)> 
signal_tacticalGraphicAdded
boost::signal< void(const
DtUniqueID &, const
std::string &)> 
signal_tacticalGraphicRenamed
boost::signal< void(const
DtUniqueID &, const
std::string &)> 
signal_tacticalGraphicOverlayRenamed
boost::signal< void(const
DtUniqueID &)> 
signal_tacticalGraphicRemoved
boost::signal< void(const
std::string &)> 
signal_overlayAdded
boost::signal< void(const
std::string &)> 
signal_overlayDeleted
boost::signal< void(const
std::string &, bool)> 
signal_overlayFiltered
boost::signal< void(const
std::string &, bool)> 
signal_overlayVisibilityChanged
boost::signal< void(const
std::string &, const
std::string &)> 
signal_overlayRenamed
boost::signal< void(const
std::string &)> 
signal_currentOverlayChanged

Protected Types

typedef std::map< DtUniqueID,
DtTacticalGraphicOverlayMember
DtTacticalGraphicOverlayObjectMap
typedef std::list
< DtOverlayFilter * > 
DtTacticalGraphicOverlayFilterList

Protected Member Functions

virtual void slot_onElementsAdded (const DtElementData::ElementList &elements)
 Called by signal whenever elements are added.
virtual void slot_onElementAttributesChanged (const DtElementData::EntryAttributesList &attributes)
 Called by signal whenever element attributes change.
virtual void slot_onElementsRemoved (const DtElementData::UniqueIdList &elementIds)
 Called by signal whenever elements are removed.
virtual void addFilter (const std::string &name, DtOverlayFilter *filter, bool apply=false)
 DtTacticalGraphicOverlayManager (DtDe &de)
 Constructor.

Protected Attributes

DtDemyDe
DtTacticalGraphicOverlayList myOverlays
DtTacticalGraphicOverlayFilterList myFilters
DtTacticalGraphicOverlayObjectMap myTacticalGraphicNames
DtTacticalGraphicOverlaymyCurrentOverlay
DtSignalConnectionManager mySignals
TacticalGraphicTypeVector myTacticalGraphicTypes

Detailed Description

DtTacticalGraphicOverlayManager objects hold the state (visible or not) of tactical graphics overlays.


Member Typedef Documentation


Constructor & Destructor Documentation

Destructor.

Constructor.


Member Function Documentation

virtual void makVrv::DtTacticalGraphicOverlayManager::addTacticalGraphic ( const DtUniqueID id,
const std::string &  name 
) [virtual]

Adds a tactical graphic with the given id and name.

emits signal_tacticalGraphicAdded

virtual const std::string* makVrv::DtTacticalGraphicOverlayManager::tacticalGraphicName ( const DtUniqueID id) const [virtual]

Returns the name of the tactical graphic associated with the id if no graphic is found, returns 0.

Removes the tactical graphic with the given id from the manager emits signal_tacticalGraphicRemoved if graphic is found/removed.

virtual void makVrv::DtTacticalGraphicOverlayManager::renameTacticalGraphic ( const DtUniqueID id,
const std::string &  newName 
) [virtual]

Renames the tactical graphic with the given id to the new name inside the manager emits signal_tacticalGraphicRenamed if graphic is found/renamed.

virtual void makVrv::DtTacticalGraphicOverlayManager::renameTacticalGraphicOverlay ( const DtUniqueID id,
const std::string &  newName 
) [virtual]

Renames the tactical graphic's overlay to the new name inside the manager emits signal_tacticalGraphicOverlayRenamed if successful (id found and overlay renamed)

virtual void makVrv::DtTacticalGraphicOverlayManager::setTacticalGraphicVisible ( const DtUniqueID id,
bool  flag 
) [virtual]

Updates the visibility status of a tactical graphic inside the manager.

virtual std::string makVrv::DtTacticalGraphicOverlayManager::newOverlay ( ) [virtual]

Creates a new overlay with a default name.

virtual void makVrv::DtTacticalGraphicOverlayManager::addOverlay ( const std::string  name) [virtual]

Creates a new overlay with the given name.

Name must be not empty. emits signal_overlayAdded if overlay is successfully added inside the manager.

virtual void makVrv::DtTacticalGraphicOverlayManager::deleteOverlay ( const std::string &  name) [virtual]

Removes the overlay with the given name from the manager.

emits signal_overlayDeleted if overlay is successfully removed

virtual void makVrv::DtTacticalGraphicOverlayManager::renameOverlay ( const std::string &  oldName,
const std::string &  newName 
) [virtual]

Renames the overlay with the oldName to newName emits signal_overlayRenamed if overlay is successfully renamed.

virtual DtTacticalGraphicOverlay* makVrv::DtTacticalGraphicOverlayManager::findOverlay ( const std::string &  name) const [virtual]

Finds the overlay associated with the given name.

Returns the list of overlays currently registered in the manager.

virtual bool makVrv::DtTacticalGraphicOverlayManager::overlayVisible ( const std::string &  overlayName) const [virtual]

Set/Get the visible status of the given overlay.

virtual void makVrv::DtTacticalGraphicOverlayManager::setOverlayVisible ( const std::string &  overlayName,
bool  flag 
) [virtual]
virtual bool makVrv::DtTacticalGraphicOverlayManager::overlayFiltered ( const std::string &  overlayName) const [virtual]

Set/Get the visible status of the given overlay.

virtual void makVrv::DtTacticalGraphicOverlayManager::setOverlayFiltered ( const std::string &  overlayName,
bool  flag 
) [virtual]
virtual bool makVrv::DtTacticalGraphicOverlayManager::overlayLocked ( const std::string &  overlayName) const [virtual]

Set/Get the lock status of the given overlay.

A locked overlay means that the tactical graphics inside it cannot be edited/moved

virtual void makVrv::DtTacticalGraphicOverlayManager::setOverlayLocked ( const std::string &  overlayName,
bool  flag 
) [virtual]

Set/Get the overlay marked as 'current overlay' inside the manager.

virtual void makVrv::DtTacticalGraphicOverlayManager::setCurrentOverlay ( const std::string &  name) [virtual]

Sets the types valid to be placed on an overlay layer.

Returns current tactical graphic types.

Returns true if this particular element can be placed on an overlay layer.

virtual void makVrv::DtTacticalGraphicOverlayManager::slot_onElementsAdded ( const DtElementData::ElementList elements) [protected, virtual]

Called by signal whenever elements are added.

Called by signal whenever element attributes change.

virtual void makVrv::DtTacticalGraphicOverlayManager::slot_onElementsRemoved ( const DtElementData::UniqueIdList elementIds) [protected, virtual]

Called by signal whenever elements are removed.

virtual void makVrv::DtTacticalGraphicOverlayManager::addFilter ( const std::string &  name,
DtOverlayFilter filter,
bool  apply = false 
) [protected, virtual]

Member Data Documentation

boost::signal<void (const DtUniqueID&, const std::string&)> makVrv::DtTacticalGraphicOverlayManager::signal_tacticalGraphicAdded
boost::signal<void (const std::string&)> makVrv::DtTacticalGraphicOverlayManager::signal_overlayAdded
boost::signal<void (const std::string&)> makVrv::DtTacticalGraphicOverlayManager::signal_overlayDeleted
boost::signal<void (const std::string&, bool)> makVrv::DtTacticalGraphicOverlayManager::signal_overlayFiltered
boost::signal<void (const std::string&, const std::string&)> makVrv::DtTacticalGraphicOverlayManager::signal_overlayRenamed

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)