GraphicLayer Class Reference

Adjusts the properties of a Graphic layer. More...

#include <GraphicLayer.h>

Inheritance diagram for GraphicLayer:

Inheritance graph

List of all members.

Public Member Functions

virtual GraphicObject * addObject (const GraphicObjectType &objectType)=0
virtual bool removeObject (GraphicObject *pObject, bool bDelete)=0
virtual void getObjects (std::list< GraphicObject * > &objects) const =0
virtual void getObjects (const GraphicObjectType &objectType, std::list< GraphicObject * > &objects) const =0
virtual unsigned int getNumObjects () const =0
virtual unsigned int getNumObjects (const GraphicObjectType &objectType) const =0
virtual GraphicObject * getObjectByName (const std::string &name) const =0
virtual bool selectObject (GraphicObject *pObject)=0
virtual void selectAllObjects ()=0
virtual bool isObjectSelected (GraphicObject *pObject) const =0
virtual void getSelectedObjects (std::list< GraphicObject * > &selectedObjects) const =0
virtual void getSelectedObjects (const GraphicObjectType &objectType, std::list< GraphicObject * > &selectedObjects) const =0
virtual unsigned int getNumSelectedObjects () const =0
virtual unsigned int getNumSelectedObjects (const GraphicObjectType &objectType) const =0
virtual bool deselectObject (GraphicObject *pObject)=0
virtual void deleteSelectedObjects ()=0
virtual void clear ()=0
virtual void deselectAllObjects ()=0
virtual void groupSelection ()=0
virtual void ungroupSelection ()=0
virtual void clearSelection ()=0
virtual void popFront ()=0
virtual void pushBack ()=0
virtual bool getShowLabels () const =0
virtual void setShowLabels (bool bShowLabels)=0
virtual LocationType correctCoordinate (const LocationType &coord) const =0
virtual bool getLayerLocked () const =0
virtual void setLayerLocked (bool bLocked)=0
virtual void setCurrentGraphicObjectType (GraphicObjectType type)=0
virtual GraphicObjectType getCurrentGraphicObjectType () const =0
virtual GraphicObject * hit (LocationType sceneCoord) const =0

Static Public Member Functions

static double getSettingAlpha ()
static bool hasSettingAlpha ()
static void setSettingAlpha (double newValue, bool setIfSame=false)
static std::string getSettingAlphaKey ()
static double getSettingApex ()
static bool hasSettingApex ()
static void setSettingApex (double newValue, bool setIfSame=false)
static std::string getSettingApexKey ()
static ArcRegion getSettingArcRegion ()
static bool hasSettingArcRegion ()
static void setSettingArcRegion (ArcRegion newValue, bool setIfSame=false)
static std::string getSettingArcRegionKey ()
static bool getSettingBorder ()
static bool hasSettingBorder ()
static void setSettingBorder (bool newValue, bool setIfSame=false)
static std::string getSettingBorderKey ()
static bool getSettingFill ()
static bool hasSettingFill ()
static void setSettingFill (bool newValue, bool setIfSame=false)
static std::string getSettingFillKey ()
static ColorType getSettingFillColor ()
static bool hasSettingFillColor ()
static void setSettingFillColor (ColorType newValue, bool setIfSame=false)
static std::string getSettingFillColorKey ()
static FillStyle getSettingFillStyle ()
static bool hasSettingFillStyle ()
static void setSettingFillStyle (FillStyle newValue, bool setIfSame=false)
static std::string getSettingFillStyleKey ()
static ColorType getSettingLineColor ()
static bool hasSettingLineColor ()
static void setSettingLineColor (ColorType newValue, bool setIfSame=false)
static std::string getSettingLineColorKey ()
static bool getSettingLineScaled ()
static bool hasSettingLineScaled ()
static void setSettingLineScaled (bool newValue, bool setIfSame=false)
static std::string getSettingLineScaledKey ()
static LineStyle getSettingLineStyle ()
static bool hasSettingLineStyle ()
static void setSettingLineStyle (LineStyle newValue, bool setIfSame=false)
static std::string getSettingLineStyleKey ()
static unsigned int getSettingLineWidth ()
static bool hasSettingLineWidth ()
static void setSettingLineWidth (unsigned int newValue, bool setIfSame=false)
static std::string getSettingLineWidthKey ()
static SymbolType getSettingHatchStyle ()
static bool hasSettingHatchStyle ()
static void setSettingHatchStyle (SymbolType newValue, bool setIfSame=false)
static std::string getSettingHatchStyleKey ()
static double getSettingRotation ()
static bool hasSettingRotation ()
static void setSettingRotation (double newValue, bool setIfSame=false)
static std::string getSettingRotationKey ()
static double getSettingStartAngle ()
static bool hasSettingStartAngle ()
static void setSettingStartAngle (double newValue, bool setIfSame=false)
static std::string getSettingStartAngleKey ()
static double getSettingStopAngle ()
static bool hasSettingStopAngle ()
static void setSettingStopAngle (double newValue, bool setIfSame=false)
static std::string getSettingStopAngleKey ()
static std::string getSettingSymbolName ()
static bool hasSettingSymbolName ()
static void setSettingSymbolName (std::string newValue, bool setIfSame=false)
static std::string getSettingSymbolNameKey ()
static unsigned int getSettingSymbolSize ()
static bool hasSettingSymbolSize ()
static void setSettingSymbolSize (unsigned int newValue, bool setIfSame=false)
static std::string getSettingSymbolSizeKey ()
static ColorType getSettingTextColor ()
static bool hasSettingTextColor ()
static void setSettingTextColor (ColorType newValue, bool setIfSame=false)
static std::string getSettingTextColorKey ()
static std::string getSettingTextFont ()
static bool hasSettingTextFont ()
static void setSettingTextFont (std::string newValue, bool setIfSame=false)
static std::string getSettingTextFontKey ()
static unsigned int getSettingTextFontSize ()
static bool hasSettingTextFontSize ()
static void setSettingTextFontSize (unsigned int newValue, bool setIfSame=false)
static std::string getSettingTextFontSizeKey ()
static bool getSettingTextBold ()
static bool hasSettingTextBold ()
static void setSettingTextBold (bool newValue, bool setIfSame=false)
static std::string getSettingTextBoldKey ()
static bool getSettingTextItalics ()
static bool hasSettingTextItalics ()
static void setSettingTextItalics (bool newValue, bool setIfSame=false)
static std::string getSettingTextItalicsKey ()
static bool getSettingTextUnderline ()
static bool hasSettingTextUnderline ()
static void setSettingTextUnderline (bool newValue, bool setIfSame=false)
static std::string getSettingTextUnderlineKey ()
static UnitSystem getSettingUnitSystem ()
static bool hasSettingUnitSystem ()
static void setSettingUnitSystem (UnitSystem newValue, bool setIfSame=false)
static std::string getSettingUnitSystemKey ()
static const std::string & signalObjectsSelected ()
static const std::string & signalObjectInsertionCompleted ()

Protected Member Functions

virtual ~GraphicLayer ()

Detailed Description

Adjusts the properties of a Graphic layer.

A graphic layer consists of a list of graphic objects. Each graphic object is individually selectable and can have its properties set. Setting a given property sets that property on each currently selected object and sets the value that all future objects will use as a default for that property.

This subclass of Subject will notify upon the following conditions:

See also:
Layer

Definition at line 45 of file GraphicLayer.h.

Constructor & Destructor Documentation

virtual GraphicLayer::~GraphicLayer (  )  [protected, virtual]

This should be destroyed by calling SpatialDataView::deleteLayer.

Definition at line 1456 of file GraphicLayer.h.

Member Function Documentation

static double GraphicLayer::getSettingAlpha (  )  [static]

Returns the current value for this setting.

If this setting does not exist in ConfigurationSettings, a verification error will be logged to the message log and potentially a verification error message box will be displayed to the user.

Please see Settings Macros for more details

Returns:
the current value for this setting.

Definition at line 58 of file GraphicLayer.h.

static bool GraphicLayer::hasSettingAlpha (  )  [static]

Returns true if this setting exists and has a value in ConfigurationSettings.

Please see Settings Macros for more details

Returns:
true if this setting exists, false otherwise.

Definition at line 65 of file GraphicLayer.h.

static void GraphicLayer::setSettingAlpha ( double  newValue,
bool  setIfSame = false 
) [static]

Changes the current value of this setting to the new value.

Please see Settings Macros for more details

Parameters:
newValue the new value for this setting.
setIfSame If true, the value will be set into ConfigurationSettings even if the newValue and existing value are the same. This has the side-effect of making the value a per-user setting and stored in the user's configuration file. If false, this value will only be set if the newValue and existing value are different. Therefore the value will only be stored in the user's configuration file if the newValue is unique to the user.

Definition at line 81 of file GraphicLayer.h.

static std::string GraphicLayer::getSettingAlphaKey (  )  [static]

Returns the key for this setting that could be passed to ConfigurationSettings::getSetting() or ConfigurationSettings::setSetting().

Please see Settings Macros for more details

Returns:
the key used for this setting.

Definition at line 89 of file GraphicLayer.h.

static double GraphicLayer::getSettingApex (  )  [static]

Returns the current value for this setting.

If this setting does not exist in ConfigurationSettings, a verification error will be logged to the message log and potentially a verification error message box will be displayed to the user.

Please see Settings Macros for more details

Returns:
the current value for this setting.

Definition at line 100 of file GraphicLayer.h.

static bool GraphicLayer::hasSettingApex (  )  [static]

Returns true if this setting exists and has a value in ConfigurationSettings.

Please see Settings Macros for more details

Returns:
true if this setting exists, false otherwise.

Definition at line 107 of file GraphicLayer.h.

static void GraphicLayer::setSettingApex ( double  newValue,
bool  setIfSame = false 
) [static]

Changes the current value of this setting to the new value.

Please see Settings Macros for more details

Parameters:
newValue the new value for this setting.
setIfSame If true, the value will be set into ConfigurationSettings even if the newValue and existing value are the same. This has the side-effect of making the value a per-user setting and stored in the user's configuration file. If false, this value will only be set if the newValue and existing value are different. Therefore the value will only be stored in the user's configuration file if the newValue is unique to the user.

Definition at line 123 of file GraphicLayer.h.

static std::string GraphicLayer::getSettingApexKey (  )  [static]

Returns the key for this setting that could be passed to ConfigurationSettings::getSetting() or ConfigurationSettings::setSetting().

Please see Settings Macros for more details

Returns:
the key used for this setting.

Definition at line 131 of file GraphicLayer.h.

static ArcRegion GraphicLayer::getSettingArcRegion (  )  [static]

Returns the current value for this setting.

If this setting does not exist in ConfigurationSettings, a verification error will be logged to the message log and potentially a verification error message box will be displayed to the user.

Please see Settings Macros for more details

Returns:
the current value for this setting.

Definition at line 142 of file GraphicLayer.h.

static bool GraphicLayer::hasSettingArcRegion (  )  [static]

Returns true if this setting exists and has a value in ConfigurationSettings.

Please see Settings Macros for more details

Returns:
true if this setting exists, false otherwise.

Definition at line 149 of file GraphicLayer.h.

static void GraphicLayer::setSettingArcRegion ( ArcRegion  newValue,
bool  setIfSame = false 
) [static]

Changes the current value of this setting to the new value.

Please see Settings Macros for more details

Parameters:
newValue the new value for this setting.
setIfSame If true, the value will be set into ConfigurationSettings even if the newValue and existing value are the same. This has the side-effect of making the value a per-user setting and stored in the user's configuration file. If false, this value will only be set if the newValue and existing value are different. Therefore the value will only be stored in the user's configuration file if the newValue is unique to the user.

Definition at line 165 of file GraphicLayer.h.

static std::string GraphicLayer::getSettingArcRegionKey (  )  [static]

Returns the key for this setting that could be passed to ConfigurationSettings::getSetting() or ConfigurationSettings::setSetting().

Please see Settings Macros for more details

Returns:
the key used for this setting.

Definition at line 173 of file GraphicLayer.h.

static bool GraphicLayer::getSettingBorder (  )  [static]

Returns the current value for this setting.

If this setting does not exist in ConfigurationSettings, a verification error will be logged to the message log and potentially a verification error message box will be displayed to the user.

Please see Settings Macros for more details

Returns:
the current value for this setting.

Definition at line 184 of file GraphicLayer.h.

static bool GraphicLayer::hasSettingBorder (  )  [static]

Returns true if this setting exists and has a value in ConfigurationSettings.

Please see Settings Macros for more details

Returns:
true if this setting exists, false otherwise.

Definition at line 191 of file GraphicLayer.h.

static void GraphicLayer::setSettingBorder ( bool  newValue,
bool  setIfSame = false 
) [static]

Changes the current value of this setting to the new value.

Please see Settings Macros for more details

Parameters:
newValue the new value for this setting.
setIfSame If true, the value will be set into ConfigurationSettings even if the newValue and existing value are the same. This has the side-effect of making the value a per-user setting and stored in the user's configuration file. If false, this value will only be set if the newValue and existing value are different. Therefore the value will only be stored in the user's configuration file if the newValue is unique to the user.

Definition at line 207 of file GraphicLayer.h.

static std::string GraphicLayer::getSettingBorderKey (  )  [static]

Returns the key for this setting that could be passed to ConfigurationSettings::getSetting() or ConfigurationSettings::setSetting().

Please see Settings Macros for more details

Returns:
the key used for this setting.

Definition at line 215 of file GraphicLayer.h.

static bool GraphicLayer::getSettingFill (  )  [static]

Returns the current value for this setting.

If this setting does not exist in ConfigurationSettings, a verification error will be logged to the message log and potentially a verification error message box will be displayed to the user.

Please see Settings Macros for more details

Returns:
the current value for this setting.

Definition at line 226 of file GraphicLayer.h.

static bool GraphicLayer::hasSettingFill (  )  [static]

Returns true if this setting exists and has a value in ConfigurationSettings.

Please see Settings Macros for more details

Returns:
true if this setting exists, false otherwise.

Definition at line 233 of file GraphicLayer.h.

static void GraphicLayer::setSettingFill ( bool  newValue,
bool  setIfSame = false 
) [static]

Changes the current value of this setting to the new value.

Please see Settings Macros for more details

Parameters:
newValue the new value for this setting.
setIfSame If true, the value will be set into ConfigurationSettings even if the newValue and existing value are the same. This has the side-effect of making the value a per-user setting and stored in the user's configuration file. If false, this value will only be set if the newValue and existing value are different. Therefore the value will only be stored in the user's configuration file if the newValue is unique to the user.

Definition at line 249 of file GraphicLayer.h.

static std::string GraphicLayer::getSettingFillKey (  )  [static]

Returns the key for this setting that could be passed to ConfigurationSettings::getSetting() or ConfigurationSettings::setSetting().

Please see Settings Macros for more details

Returns:
the key used for this setting.

Definition at line 257 of file GraphicLayer.h.

static ColorType GraphicLayer::getSettingFillColor (  )  [static]

Returns the current value for this setting.

If this setting does not exist in ConfigurationSettings, a verification error will be logged to the message log and potentially a verification error message box will be displayed to the user.

Please see Settings Macros for more details

Returns:
the current value for this setting.

Definition at line 268 of file GraphicLayer.h.

static bool GraphicLayer::hasSettingFillColor (  )  [static]

Returns true if this setting exists and has a value in ConfigurationSettings.

Please see Settings Macros for more details

Returns:
true if this setting exists, false otherwise.

Definition at line 275 of file GraphicLayer.h.

static void GraphicLayer::setSettingFillColor ( ColorType  newValue,
bool  setIfSame = false 
) [static]

Changes the current value of this setting to the new value.

Please see Settings Macros for more details

Parameters:
newValue the new value for this setting.
setIfSame If true, the value will be set into ConfigurationSettings even if the newValue and existing value are the same. This has the side-effect of making the value a per-user setting and stored in the user's configuration file. If false, this value will only be set if the newValue and existing value are different. Therefore the value will only be stored in the user's configuration file if the newValue is unique to the user.

Definition at line 291 of file GraphicLayer.h.

static std::string GraphicLayer::getSettingFillColorKey (  )  [static]

Returns the key for this setting that could be passed to ConfigurationSettings::getSetting() or ConfigurationSettings::setSetting().

Please see Settings Macros for more details

Returns:
the key used for this setting.

Definition at line 299 of file GraphicLayer.h.

static FillStyle GraphicLayer::getSettingFillStyle (  )  [static]

Returns the current value for this setting.

If this setting does not exist in ConfigurationSettings, a verification error will be logged to the message log and potentially a verification error message box will be displayed to the user.

Please see Settings Macros for more details

Returns:
the current value for this setting.

Definition at line 310 of file GraphicLayer.h.

static bool GraphicLayer::hasSettingFillStyle (  )  [static]

Returns true if this setting exists and has a value in ConfigurationSettings.

Please see Settings Macros for more details

Returns:
true if this setting exists, false otherwise.

Definition at line 317 of file GraphicLayer.h.

static void GraphicLayer::setSettingFillStyle ( FillStyle  newValue,
bool  setIfSame = false 
) [static]

Changes the current value of this setting to the new value.

Please see Settings Macros for more details

Parameters:
newValue the new value for this setting.
setIfSame If true, the value will be set into ConfigurationSettings even if the newValue and existing value are the same. This has the side-effect of making the value a per-user setting and stored in the user's configuration file. If false, this value will only be set if the newValue and existing value are different. Therefore the value will only be stored in the user's configuration file if the newValue is unique to the user.

Definition at line 333 of file GraphicLayer.h.

static std::string GraphicLayer::getSettingFillStyleKey (  )  [static]

Returns the key for this setting that could be passed to ConfigurationSettings::getSetting() or ConfigurationSettings::setSetting().

Please see Settings Macros for more details

Returns:
the key used for this setting.

Definition at line 341 of file GraphicLayer.h.

static ColorType GraphicLayer::getSettingLineColor (  )  [static]

Returns the current value for this setting.

If this setting does not exist in ConfigurationSettings, a verification error will be logged to the message log and potentially a verification error message box will be displayed to the user.

Please see Settings Macros for more details

Returns:
the current value for this setting.

Reimplemented in MeasurementLayer.

Definition at line 352 of file GraphicLayer.h.

static bool GraphicLayer::hasSettingLineColor (  )  [static]

Returns true if this setting exists and has a value in ConfigurationSettings.

Please see Settings Macros for more details

Returns:
true if this setting exists, false otherwise.

Reimplemented in MeasurementLayer.

Definition at line 359 of file GraphicLayer.h.

static void GraphicLayer::setSettingLineColor ( ColorType  newValue,
bool  setIfSame = false 
) [static]

Changes the current value of this setting to the new value.

Please see Settings Macros for more details

Parameters:
newValue the new value for this setting.
setIfSame If true, the value will be set into ConfigurationSettings even if the newValue and existing value are the same. This has the side-effect of making the value a per-user setting and stored in the user's configuration file. If false, this value will only be set if the newValue and existing value are different. Therefore the value will only be stored in the user's configuration file if the newValue is unique to the user.

Reimplemented in MeasurementLayer.

Definition at line 375 of file GraphicLayer.h.

static std::string GraphicLayer::getSettingLineColorKey (  )  [static]

Returns the key for this setting that could be passed to ConfigurationSettings::getSetting() or ConfigurationSettings::setSetting().

Please see Settings Macros for more details

Returns:
the key used for this setting.

Reimplemented in MeasurementLayer.

Definition at line 383 of file GraphicLayer.h.

static bool GraphicLayer::getSettingLineScaled (  )  [static]

Returns the current value for this setting.

If this setting does not exist in ConfigurationSettings, a verification error will be logged to the message log and potentially a verification error message box will be displayed to the user.

Please see Settings Macros for more details

Returns:
the current value for this setting.

Definition at line 394 of file GraphicLayer.h.

static bool GraphicLayer::hasSettingLineScaled (  )  [static]

Returns true if this setting exists and has a value in ConfigurationSettings.

Please see Settings Macros for more details

Returns:
true if this setting exists, false otherwise.

Definition at line 401 of file GraphicLayer.h.

static void GraphicLayer::setSettingLineScaled ( bool  newValue,
bool  setIfSame = false 
) [static]

Changes the current value of this setting to the new value.

Please see Settings Macros for more details

Parameters:
newValue the new value for this setting.
setIfSame If true, the value will be set into ConfigurationSettings even if the newValue and existing value are the same. This has the side-effect of making the value a per-user setting and stored in the user's configuration file. If false, this value will only be set if the newValue and existing value are different. Therefore the value will only be stored in the user's configuration file if the newValue is unique to the user.

Definition at line 417 of file GraphicLayer.h.

static std::string GraphicLayer::getSettingLineScaledKey (  )  [static]

Returns the key for this setting that could be passed to ConfigurationSettings::getSetting() or ConfigurationSettings::setSetting().

Please see Settings Macros for more details

Returns:
the key used for this setting.

Definition at line 425 of file GraphicLayer.h.

static LineStyle GraphicLayer::getSettingLineStyle (  )  [static]

Returns the current value for this setting.

If this setting does not exist in ConfigurationSettings, a verification error will be logged to the message log and potentially a verification error message box will be displayed to the user.

Please see Settings Macros for more details

Returns:
the current value for this setting.

Reimplemented in MeasurementLayer.

Definition at line 436 of file GraphicLayer.h.

static bool GraphicLayer::hasSettingLineStyle (  )  [static]

Returns true if this setting exists and has a value in ConfigurationSettings.

Please see Settings Macros for more details

Returns:
true if this setting exists, false otherwise.

Reimplemented in MeasurementLayer.

Definition at line 443 of file GraphicLayer.h.

static void GraphicLayer::setSettingLineStyle ( LineStyle  newValue,
bool  setIfSame = false 
) [static]

Changes the current value of this setting to the new value.

Please see Settings Macros for more details

Parameters:
newValue the new value for this setting.
setIfSame If true, the value will be set into ConfigurationSettings even if the newValue and existing value are the same. This has the side-effect of making the value a per-user setting and stored in the user's configuration file. If false, this value will only be set if the newValue and existing value are different. Therefore the value will only be stored in the user's configuration file if the newValue is unique to the user.

Reimplemented in MeasurementLayer.

Definition at line 459 of file GraphicLayer.h.

static std::string GraphicLayer::getSettingLineStyleKey (  )  [static]

Returns the key for this setting that could be passed to ConfigurationSettings::getSetting() or ConfigurationSettings::setSetting().

Please see Settings Macros for more details

Returns:
the key used for this setting.

Reimplemented in MeasurementLayer.

Definition at line 467 of file GraphicLayer.h.

static unsigned int GraphicLayer::getSettingLineWidth (  )  [static]

Returns the current value for this setting.

If this setting does not exist in ConfigurationSettings, a verification error will be logged to the message log and potentially a verification error message box will be displayed to the user.

Please see Settings Macros for more details

Returns:
the current value for this setting.

Reimplemented in MeasurementLayer.

Definition at line 478 of file GraphicLayer.h.

static bool GraphicLayer::hasSettingLineWidth (  )  [static]

Returns true if this setting exists and has a value in ConfigurationSettings.

Please see Settings Macros for more details

Returns:
true if this setting exists, false otherwise.

Reimplemented in MeasurementLayer.

Definition at line 485 of file GraphicLayer.h.

static void GraphicLayer::setSettingLineWidth ( unsigned int  newValue,
bool  setIfSame = false 
) [static]

Changes the current value of this setting to the new value.

Please see Settings Macros for more details

Parameters:
newValue the new value for this setting.
setIfSame If true, the value will be set into ConfigurationSettings even if the newValue and existing value are the same. This has the side-effect of making the value a per-user setting and stored in the user's configuration file. If false, this value will only be set if the newValue and existing value are different. Therefore the value will only be stored in the user's configuration file if the newValue is unique to the user.

Reimplemented in MeasurementLayer.

Definition at line 501 of file GraphicLayer.h.

static std::string GraphicLayer::getSettingLineWidthKey (  )  [static]

Returns the key for this setting that could be passed to ConfigurationSettings::getSetting() or ConfigurationSettings::setSetting().

Please see Settings Macros for more details

Returns:
the key used for this setting.

Reimplemented in MeasurementLayer.

Definition at line 509 of file GraphicLayer.h.

static SymbolType GraphicLayer::getSettingHatchStyle (  )  [static]

Returns the current value for this setting.

If this setting does not exist in ConfigurationSettings, a verification error will be logged to the message log and potentially a verification error message box will be displayed to the user.

Please see Settings Macros for more details

Returns:
the current value for this setting.

Definition at line 520 of file GraphicLayer.h.

static bool GraphicLayer::hasSettingHatchStyle (  )  [static]

Returns true if this setting exists and has a value in ConfigurationSettings.

Please see Settings Macros for more details

Returns:
true if this setting exists, false otherwise.

Definition at line 527 of file GraphicLayer.h.

static void GraphicLayer::setSettingHatchStyle ( SymbolType  newValue,
bool  setIfSame = false 
) [static]

Changes the current value of this setting to the new value.

Please see Settings Macros for more details

Parameters:
newValue the new value for this setting.
setIfSame If true, the value will be set into ConfigurationSettings even if the newValue and existing value are the same. This has the side-effect of making the value a per-user setting and stored in the user's configuration file. If false, this value will only be set if the newValue and existing value are different. Therefore the value will only be stored in the user's configuration file if the newValue is unique to the user.

Definition at line 543 of file GraphicLayer.h.

static std::string GraphicLayer::getSettingHatchStyleKey (  )  [static]

Returns the key for this setting that could be passed to ConfigurationSettings::getSetting() or ConfigurationSettings::setSetting().

Please see Settings Macros for more details

Returns:
the key used for this setting.

Definition at line 551 of file GraphicLayer.h.

static double GraphicLayer::getSettingRotation (  )  [static]

Returns the current value for this setting.

If this setting does not exist in ConfigurationSettings, a verification error will be logged to the message log and potentially a verification error message box will be displayed to the user.

Please see Settings Macros for more details

Returns:
the current value for this setting.

Definition at line 562 of file GraphicLayer.h.

static bool GraphicLayer::hasSettingRotation (  )  [static]

Returns true if this setting exists and has a value in ConfigurationSettings.

Please see Settings Macros for more details

Returns:
true if this setting exists, false otherwise.

Definition at line 569 of file GraphicLayer.h.

static void GraphicLayer::setSettingRotation ( double  newValue,
bool  setIfSame = false 
) [static]

Changes the current value of this setting to the new value.

Please see Settings Macros for more details

Parameters:
newValue the new value for this setting.
setIfSame If true, the value will be set into ConfigurationSettings even if the newValue and existing value are the same. This has the side-effect of making the value a per-user setting and stored in the user's configuration file. If false, this value will only be set if the newValue and existing value are different. Therefore the value will only be stored in the user's configuration file if the newValue is unique to the user.

Definition at line 585 of file GraphicLayer.h.

static std::string GraphicLayer::getSettingRotationKey (  )  [static]

Returns the key for this setting that could be passed to ConfigurationSettings::getSetting() or ConfigurationSettings::setSetting().

Please see Settings Macros for more details

Returns:
the key used for this setting.

Definition at line 593 of file GraphicLayer.h.

static double GraphicLayer::getSettingStartAngle (  )  [static]

Returns the current value for this setting.

If this setting does not exist in ConfigurationSettings, a verification error will be logged to the message log and potentially a verification error message box will be displayed to the user.

Please see Settings Macros for more details

Returns:
the current value for this setting.

Definition at line 604 of file GraphicLayer.h.

static bool GraphicLayer::hasSettingStartAngle (  )  [static]

Returns true if this setting exists and has a value in ConfigurationSettings.

Please see Settings Macros for more details

Returns:
true if this setting exists, false otherwise.

Definition at line 611 of file GraphicLayer.h.

static void GraphicLayer::setSettingStartAngle ( double  newValue,
bool  setIfSame = false 
) [static]

Changes the current value of this setting to the new value.

Please see Settings Macros for more details

Parameters:
newValue the new value for this setting.
setIfSame If true, the value will be set into ConfigurationSettings even if the newValue and existing value are the same. This has the side-effect of making the value a per-user setting and stored in the user's configuration file. If false, this value will only be set if the newValue and existing value are different. Therefore the value will only be stored in the user's configuration file if the newValue is unique to the user.

Definition at line 627 of file GraphicLayer.h.

static std::string GraphicLayer::getSettingStartAngleKey (  )  [static]

Returns the key for this setting that could be passed to ConfigurationSettings::getSetting() or ConfigurationSettings::setSetting().

Please see Settings Macros for more details

Returns:
the key used for this setting.

Definition at line 635 of file GraphicLayer.h.

static double GraphicLayer::getSettingStopAngle (  )  [static]

Returns the current value for this setting.

If this setting does not exist in ConfigurationSettings, a verification error will be logged to the message log and potentially a verification error message box will be displayed to the user.

Please see Settings Macros for more details

Returns:
the current value for this setting.

Definition at line 646 of file GraphicLayer.h.

static bool GraphicLayer::hasSettingStopAngle (  )  [static]

Returns true if this setting exists and has a value in ConfigurationSettings.

Please see Settings Macros for more details

Returns:
true if this setting exists, false otherwise.

Definition at line 653 of file GraphicLayer.h.

static void GraphicLayer::setSettingStopAngle ( double  newValue,
bool  setIfSame = false 
) [static]

Changes the current value of this setting to the new value.

Please see Settings Macros for more details

Parameters:
newValue the new value for this setting.
setIfSame If true, the value will be set into ConfigurationSettings even if the newValue and existing value are the same. This has the side-effect of making the value a per-user setting and stored in the user's configuration file. If false, this value will only be set if the newValue and existing value are different. Therefore the value will only be stored in the user's configuration file if the newValue is unique to the user.

Definition at line 669 of file GraphicLayer.h.

static std::string GraphicLayer::getSettingStopAngleKey (  )  [static]

Returns the key for this setting that could be passed to ConfigurationSettings::getSetting() or ConfigurationSettings::setSetting().

Please see Settings Macros for more details

Returns:
the key used for this setting.

Definition at line 677 of file GraphicLayer.h.

static std::string GraphicLayer::getSettingSymbolName (  )  [static]

Returns the current value for this setting.

If this setting does not exist in ConfigurationSettings, a verification error will be logged to the message log and potentially a verification error message box will be displayed to the user.

Please see Settings Macros for more details

Returns:
the current value for this setting.

Definition at line 688 of file GraphicLayer.h.

static bool GraphicLayer::hasSettingSymbolName (  )  [static]

Returns true if this setting exists and has a value in ConfigurationSettings.

Please see Settings Macros for more details

Returns:
true if this setting exists, false otherwise.

Definition at line 695 of file GraphicLayer.h.

static void GraphicLayer::setSettingSymbolName ( std::string  newValue,
bool  setIfSame = false 
) [static]

Changes the current value of this setting to the new value.

Please see Settings Macros for more details

Parameters:
newValue the new value for this setting.
setIfSame If true, the value will be set into ConfigurationSettings even if the newValue and existing value are the same. This has the side-effect of making the value a per-user setting and stored in the user's configuration file. If false, this value will only be set if the newValue and existing value are different. Therefore the value will only be stored in the user's configuration file if the newValue is unique to the user.

Definition at line 711 of file GraphicLayer.h.

static std::string GraphicLayer::getSettingSymbolNameKey (  )  [static]

Returns the key for this setting that could be passed to ConfigurationSettings::getSetting() or ConfigurationSettings::setSetting().

Please see Settings Macros for more details

@return the key used for this setting.

Definition at line 719 of file GraphicLayer.h.

static unsigned int GraphicLayer::getSettingSymbolSize (  )  [static]

Returns the current value for this setting.

If this setting does not exist in ConfigurationSettings, a verification error will be logged to the message log and potentially a verification error message box will be displayed to the user.

Please see Settings Macros for more details

Returns:
the current value for this setting.

Definition at line 730 of file GraphicLayer.h.

static bool GraphicLayer::hasSettingSymbolSize (  )  [static]

Returns true if this setting exists and has a value in ConfigurationSettings.

Please see Settings Macros for more details

Returns:
true if this setting exists, false otherwise.

Definition at line 737 of file GraphicLayer.h.

static void GraphicLayer::setSettingSymbolSize ( unsigned int  newValue,
bool  setIfSame = false 
) [static]

Changes the current value of this setting to the new value.

Please see Settings Macros for more details

Parameters:
newValue the new value for this setting.
setIfSame If true, the value will be set into ConfigurationSettings even if the newValue and existing value are the same. This has the side-effect of making the value a per-user setting and stored in the user's configuration file. If false, this value will only be set if the newValue and existing value are different. Therefore the value will only be stored in the user's configuration file if the newValue is unique to the user.

Definition at line 753 of file GraphicLayer.h.

static std::string GraphicLayer::getSettingSymbolSizeKey (  )  [static]

Returns the key for this setting that could be passed to ConfigurationSettings::getSetting() or ConfigurationSettings::setSetting().

Please see Settings Macros for more details

Returns:
the key used for this setting.

Definition at line 761 of file GraphicLayer.h.

static ColorType GraphicLayer::getSettingTextColor (  )  [static]

Returns the current value for this setting.

If this setting does not exist in ConfigurationSettings, a verification error will be logged to the message log and potentially a verification error message box will be displayed to the user.

Please see Settings Macros for more details

Returns:
the current value for this setting.

Reimplemented in MeasurementLayer.

Definition at line 772 of file GraphicLayer.h.

static bool GraphicLayer::hasSettingTextColor (  )  [static]

Returns true if this setting exists and has a value in ConfigurationSettings.

Please see Settings Macros for more details

Returns:
true if this setting exists, false otherwise.

Reimplemented in MeasurementLayer.

Definition at line 779 of file GraphicLayer.h.

static void GraphicLayer::setSettingTextColor ( ColorType  newValue,
bool  setIfSame = false 
) [static]

Changes the current value of this setting to the new value.

Please see Settings Macros for more details

Parameters:
newValue the new value for this setting.
setIfSame If true, the value will be set into ConfigurationSettings even if the newValue and existing value are the same. This has the side-effect of making the value a per-user setting and stored in the user's configuration file. If false, this value will only be set if the newValue and existing value are different. Therefore the value will only be stored in the user's configuration file if the newValue is unique to the user.

Reimplemented in MeasurementLayer.

Definition at line 795 of file GraphicLayer.h.

static std::string GraphicLayer::getSettingTextColorKey (  )  [static]

Returns the key for this setting that could be passed to ConfigurationSettings::getSetting() or ConfigurationSettings::setSetting().

Please see Settings Macros for more details

Returns:
the key used for this setting.

Reimplemented in MeasurementLayer.

Definition at line 803 of file GraphicLayer.h.

static std::string GraphicLayer::getSettingTextFont (  )  [static]

Returns the current value for this setting.

If this setting does not exist in ConfigurationSettings, a verification error will be logged to the message log and potentially a verification error message box will be displayed to the user.

Please see Settings Macros for more details

Returns:
the current value for this setting.

Reimplemented in MeasurementLayer.

Definition at line 814 of file GraphicLayer.h.

static bool GraphicLayer::hasSettingTextFont (  )  [static]

Returns true if this setting exists and has a value in ConfigurationSettings.

Please see Settings Macros for more details

Returns:
true if this setting exists, false otherwise.

Reimplemented in MeasurementLayer.

Definition at line 821 of file GraphicLayer.h.

static void GraphicLayer::setSettingTextFont ( std::string  newValue,
bool  setIfSame = false 
) [static]

Changes the current value of this setting to the new value.

Please see Settings Macros for more details

Parameters:
newValue the new value for this setting.
setIfSame If true, the value will be set into ConfigurationSettings even if the newValue and existing value are the same. This has the side-effect of making the value a per-user setting and stored in the user's configuration file. If false, this value will only be set if the newValue and existing value are different. Therefore the value will only be stored in the user's configuration file if the newValue is unique to the user.

Reimplemented in MeasurementLayer.

Definition at line 837 of file GraphicLayer.h.

static std::string GraphicLayer::getSettingTextFontKey (  )  [static]

Returns the key for this setting that could be passed to ConfigurationSettings::getSetting() or ConfigurationSettings::setSetting().

Please see Settings Macros for more details

@return the key used for this setting.

Reimplemented in MeasurementLayer.

Definition at line 845 of file GraphicLayer.h.

static unsigned int GraphicLayer::getSettingTextFontSize (  )  [static]

Returns the current value for this setting.

If this setting does not exist in ConfigurationSettings, a verification error will be logged to the message log and potentially a verification error message box will be displayed to the user.

Please see Settings Macros for more details

Returns:
the current value for this setting.

Reimplemented in MeasurementLayer.

Definition at line 856 of file GraphicLayer.h.

static bool GraphicLayer::hasSettingTextFontSize (  )  [static]

Returns true if this setting exists and has a value in ConfigurationSettings.

Please see Settings Macros for more details

Returns:
true if this setting exists, false otherwise.

Reimplemented in MeasurementLayer.

Definition at line 863 of file GraphicLayer.h.

static void GraphicLayer::setSettingTextFontSize ( unsigned int  newValue,
bool  setIfSame = false 
) [static]

Changes the current value of this setting to the new value.

Please see Settings Macros for more details

Parameters:
newValue the new value for this setting.
setIfSame If true, the value will be set into ConfigurationSettings even if the newValue and existing value are the same. This has the side-effect of making the value a per-user setting and stored in the user's configuration file. If false, this value will only be set if the newValue and existing value are different. Therefore the value will only be stored in the user's configuration file if the newValue is unique to the user.

Reimplemented in MeasurementLayer.

Definition at line 879 of file GraphicLayer.h.

static std::string GraphicLayer::getSettingTextFontSizeKey (  )  [static]

Returns the key for this setting that could be passed to ConfigurationSettings::getSetting() or ConfigurationSettings::setSetting().

Please see Settings Macros for more details

Returns:
the key used for this setting.

Reimplemented in MeasurementLayer.

Definition at line 887 of file GraphicLayer.h.

static bool GraphicLayer::getSettingTextBold (  )  [static]

Returns the current value for this setting.

If this setting does not exist in ConfigurationSettings, a verification error will be logged to the message log and potentially a verification error message box will be displayed to the user.

Please see Settings Macros for more details

Returns:
the current value for this setting.

Reimplemented in MeasurementLayer.

Definition at line 898 of file GraphicLayer.h.

static bool GraphicLayer::hasSettingTextBold (  )  [static]

Returns true if this setting exists and has a value in ConfigurationSettings.

Please see Settings Macros for more details

Returns:
true if this setting exists, false otherwise.

Reimplemented in MeasurementLayer.

Definition at line 905 of file GraphicLayer.h.

static void GraphicLayer::setSettingTextBold ( bool  newValue,
bool  setIfSame = false 
) [static]

Changes the current value of this setting to the new value.

Please see Settings Macros for more details

Parameters:
newValue the new value for this setting.
setIfSame If true, the value will be set into ConfigurationSettings even if the newValue and existing value are the same. This has the side-effect of making the value a per-user setting and stored in the user's configuration file. If false, this value will only be set if the newValue and existing value are different. Therefore the value will only be stored in the user's configuration file if the newValue is unique to the user.

Reimplemented in MeasurementLayer.

Definition at line 921 of file GraphicLayer.h.

static std::string GraphicLayer::getSettingTextBoldKey (  )  [static]

Returns the key for this setting that could be passed to ConfigurationSettings::getSetting() or ConfigurationSettings::setSetting().

Please see Settings Macros for more details

Returns:
the key used for this setting.

Reimplemented in MeasurementLayer.

Definition at line 929 of file GraphicLayer.h.

static bool GraphicLayer::getSettingTextItalics (  )  [static]

Returns the current value for this setting.

If this setting does not exist in ConfigurationSettings, a verification error will be logged to the message log and potentially a verification error message box will be displayed to the user.

Please see Settings Macros for more details

Returns:
the current value for this setting.

Reimplemented in MeasurementLayer.

Definition at line 940 of file GraphicLayer.h.

static bool GraphicLayer::hasSettingTextItalics (  )  [static]

Returns true if this setting exists and has a value in ConfigurationSettings.

Please see Settings Macros for more details

Returns:
true if this setting exists, false otherwise.

Reimplemented in MeasurementLayer.

Definition at line 947 of file GraphicLayer.h.

static void GraphicLayer::setSettingTextItalics ( bool  newValue,
bool  setIfSame = false 
) [static]

Changes the current value of this setting to the new value.

Please see Settings Macros for more details

Parameters:
newValue the new value for this setting.
setIfSame If true, the value will be set into ConfigurationSettings even if the newValue and existing value are the same. This has the side-effect of making the value a per-user setting and stored in the user's configuration file. If false, this value will only be set if the newValue and existing value are different. Therefore the value will only be stored in the user's configuration file if the newValue is unique to the user.

Reimplemented in MeasurementLayer.

Definition at line 963 of file GraphicLayer.h.

static std::string GraphicLayer::getSettingTextItalicsKey (  )  [static]

Returns the key for this setting that could be passed to ConfigurationSettings::getSetting() or ConfigurationSettings::setSetting().

Please see Settings Macros for more details

Returns:
the key used for this setting.

Reimplemented in MeasurementLayer.

Definition at line 971 of file GraphicLayer.h.

static bool GraphicLayer::getSettingTextUnderline (  )  [static]

Returns the current value for this setting.

If this setting does not exist in ConfigurationSettings, a verification error will be logged to the message log and potentially a verification error message box will be displayed to the user.

Please see Settings Macros for more details

Returns:
the current value for this setting.

Reimplemented in MeasurementLayer.

Definition at line 982 of file GraphicLayer.h.

static bool GraphicLayer::hasSettingTextUnderline (  )  [static]

Returns true if this setting exists and has a value in ConfigurationSettings.

Please see Settings Macros for more details

Returns:
true if this setting exists, false otherwise.

Reimplemented in MeasurementLayer.

Definition at line 989 of file GraphicLayer.h.

static void GraphicLayer::setSettingTextUnderline ( bool  newValue,
bool  setIfSame = false 
) [static]

Changes the current value of this setting to the new value.

Please see Settings Macros for more details

Parameters:
newValue the new value for this setting.
setIfSame If true, the value will be set into ConfigurationSettings even if the newValue and existing value are the same. This has the side-effect of making the value a per-user setting and stored in the user's configuration file. If false, this value will only be set if the newValue and existing value are different. Therefore the value will only be stored in the user's configuration file if the newValue is unique to the user.

Reimplemented in MeasurementLayer.

Definition at line 1005 of file GraphicLayer.h.

static std::string GraphicLayer::getSettingTextUnderlineKey (  )  [static]

Returns the key for this setting that could be passed to ConfigurationSettings::getSetting() or ConfigurationSettings::setSetting().

Please see Settings Macros for more details

Returns:
the key used for this setting.

Reimplemented in MeasurementLayer.

Definition at line 1013 of file GraphicLayer.h.

static UnitSystem GraphicLayer::getSettingUnitSystem (  )  [static]

Returns the current value for this setting.

If this setting does not exist in ConfigurationSettings, a verification error will be logged to the message log and potentially a verification error message box will be displayed to the user.

Please see Settings Macros for more details

Returns:
the current value for this setting.

Definition at line 1024 of file GraphicLayer.h.

static bool GraphicLayer::hasSettingUnitSystem (  )  [static]

Returns true if this setting exists and has a value in ConfigurationSettings.

Please see Settings Macros for more details

Returns:
true if this setting exists, false otherwise.

Definition at line 1031 of file GraphicLayer.h.

static void GraphicLayer::setSettingUnitSystem ( UnitSystem  newValue,
bool  setIfSame = false 
) [static]

Changes the current value of this setting to the new value.

Please see Settings Macros for more details

Parameters:
newValue the new value for this setting.
setIfSame If true, the value will be set into ConfigurationSettings even if the newValue and existing value are the same. This has the side-effect of making the value a per-user setting and stored in the user's configuration file. If false, this value will only be set if the newValue and existing value are different. Therefore the value will only be stored in the user's configuration file if the newValue is unique to the user.

Definition at line 1047 of file GraphicLayer.h.

static std::string GraphicLayer::getSettingUnitSystemKey (  )  [static]

Returns the key for this setting that could be passed to ConfigurationSettings::getSetting() or ConfigurationSettings::setSetting().

Please see Settings Macros for more details

Returns:
the key used for this setting.

Definition at line 1055 of file GraphicLayer.h.

static const std::string& GraphicLayer::signalObjectsSelected (  )  [static]

Emitted with any<list<GraphicObject*> > when the list of selected objects changes.

Definition at line 1060 of file GraphicLayer.h.

static const std::string& GraphicLayer::signalObjectInsertionCompleted (  )  [static]

Emitted with boost::any<GraphicObject*> when an object completes insertion through GUI manipulation.

The GraphicObject will be the object which was inserted, but may be NULL if the object is invalid or otherwise not included in the layer.

Definition at line 1068 of file GraphicLayer.h.

virtual GraphicObject* GraphicLayer::addObject ( const GraphicObjectType &  objectType  )  [pure virtual]

Adds a new graphic object to the layer.

This method adds a new graphic object to the layer with the given type. The object is selected, displaying selection nodes representing the object's bounding rectangle.

NOTE: A TRAIL_OBJECT should not be added by plug-in code. It is for internal Core use only by the OverviewWindow.

Parameters:
objectType The type of graphic object to add.
Returns:
A pointer to the new graphic object. NULL is returned if an error occurred.
Subject Notifications:
This method will notify Subject::signalModified.
See also:
removeObject()

virtual bool GraphicLayer::removeObject ( GraphicObject *  pObject,
bool  bDelete 
) [pure virtual]

Removes an graphic object from the layer.

Parameters:
pObject The graphic object to remove.
bDelete This flag should be set to TRUE to delete the object. If it is FALSE, the object is not deleted.
Returns:
TRUE if the object was successfully removed, otherwise FALSE.
Subject Notifications:
This method will notify Subject::signalModified.
See also:
addObject()

virtual void GraphicLayer::getObjects ( std::list< GraphicObject * > &  objects  )  const [pure virtual]

Retrieves all graphic objects in the layer.

Parameters:
objects A reference to a list that is filled with pointers to all graphic objects in the layer. Any pointers previously contained in the list are removed.
See also:
getSelectedObjects()

virtual void GraphicLayer::getObjects ( const GraphicObjectType &  objectType,
std::list< GraphicObject * > &  objects 
) const [pure virtual]

Retrieves graphic objects of a given type in the layer.

Parameters:
objectType The type of graphic object to get.
objects A reference to a list that is filled with pointers to all graphic objects of the given type in the layer. Any pointers previously contained in the list are removed.
See also:
getSelectedObjects()

virtual unsigned int GraphicLayer::getNumObjects (  )  const [pure virtual]

Returns the number of graphic objects in the layer.

Returns:
The total number of graphic objects in the layer.

virtual unsigned int GraphicLayer::getNumObjects ( const GraphicObjectType &  objectType  )  const [pure virtual]

Returns the number of graphic objects of a given type in the layer.

Parameters:
objectType The type of object to query for the number of objects contained in the layer.
Returns:
The number of annotation objects of the given type in the layer.

virtual GraphicObject* GraphicLayer::getObjectByName ( const std::string &  name  )  const [pure virtual]

Returns a graphic object with the given name.

If more than one graphic object has the given name, an arbitrary object will be returned.

Parameters:
name The name of the graphic object to retrieve.
Returns:
A graphic object with the specified name or NULL if no such object exists.

virtual bool GraphicLayer::selectObject ( GraphicObject *  pObject  )  [pure virtual]

Selects a graphic object and displays its selection nodes.

This method sets the annotation object as selected and creates selection nodes based on the object's bounding rectangle. Some objects have white square nodes. These are the bounding box handles to resize the object. Some object have yellow diamond nodes which can be used to move object points within the current bounding box.

Parameters:
pObject The graphic object to select. The pointer cannot be NULL.
Returns:
TRUE if the object was successfully selected, otherwise FALSE.
Subject Notifications:
This method will notify signalObjectsSelected.
See also:
selectAllObjects(), deselectObject()

virtual void GraphicLayer::selectAllObjects (  )  [pure virtual]

Selects all graphic objects on the layer.

Subject Notifications:
This method will notify signalObjectsSelected.
See also:
selectObject(), deselectAllObjects()

virtual bool GraphicLayer::isObjectSelected ( GraphicObject *  pObject  )  const [pure virtual]

Queries whether an graphic object is selected.

Parameters:
pObject The graphic object to query for its selection state.
Returns:
TRUE if the given object is selected, otherwise FALSE.
See also:
selectObject(), deselectObject()

virtual void GraphicLayer::getSelectedObjects ( std::list< GraphicObject * > &  selectedObjects  )  const [pure virtual]

Fills a list with the selected graphic objects.

Parameters:
selectedObjects A reference to a list that is filled with pointers to all selected graphic objects. Any pointers previously contained in the list are removed.
See also:
getNumSelectedObjects(), getObjects()

virtual void GraphicLayer::getSelectedObjects ( const GraphicObjectType &  objectType,
std::list< GraphicObject * > &  selectedObjects 
) const [pure virtual]

Fills a list with the selected graphic objects.

Parameters:
objectType The type of object for which to retrieve selected objects contained in the layer.
selectedObjects A reference to a list that is filled with pointers to all selected graphic objects. Any pointers previously contained in the list are removed.
See also:
getNumSelectedObjects(), getObjects()

virtual unsigned int GraphicLayer::getNumSelectedObjects (  )  const [pure virtual]

Returns the number of currently selected graphic objects.

This method is equivalent to calling size() on the list filled by getSelectedObjects().

Returns:
The number of currently selected graphic objects.
See also:
getSelectedObjects()

virtual unsigned int GraphicLayer::getNumSelectedObjects ( const GraphicObjectType &  objectType  )  const [pure virtual]

Returns the number of currently selected graphic objects of a given type.

Parameters:
objectType The type of object to query for the number of selected objects contained in the layer.
Returns:
The number of currently selected annotation objects of the given type.

virtual bool GraphicLayer::deselectObject ( GraphicObject *  pObject  )  [pure virtual]

Deselects a graphic object.

This method deselects a graphic object by effectively hiding its selection nodes.

Parameters:
pObject The graphic object to deselect. The pointer cannot be NULL.
Returns:
TRUE if the item was successfully deselected, otherwise FALSE.
Subject Notifications:
This method will notify signalObjectsSelected
See also:
deselectAllObjects(), selectObject()

virtual void GraphicLayer::deleteSelectedObjects (  )  [pure virtual]

Delete selected objects from the layer.

See also:
selectAllObjects(), selectObject()

virtual void GraphicLayer::clear (  )  [pure virtual]

Clear the layer by deleting all objects in the layer.

virtual void GraphicLayer::deselectAllObjects (  )  [pure virtual]

Deselects all graphic objects on the layer.

Subject Notifications:
This method will notify signalObjectsSelected.
See also:
selectAllObjects(), selectObject()

virtual void GraphicLayer::groupSelection (  )  [pure virtual]

Groups the objects currently selected into a single group.

Subject Notifications:
This method will notify Subject::signalModified.
See also:
ungroupSelection()

virtual void GraphicLayer::ungroupSelection (  )  [pure virtual]

Ungroups the objects in selected groups into individual objects.

The objects will all be selected after the ungroup.

Subject Notifications:
This method will notify Subject::signalModified.
See also:
groupSelection()

virtual void GraphicLayer::clearSelection (  )  [pure virtual]

Unselects all currently selected objects.

Subject Notifications:
This method will notify signalObjectsSelected.
See also:
deselectAllObjects()

virtual void GraphicLayer::popFront (  )  [pure virtual]

Brings the currently selected objects to the front of the layer.

It leaves the order of the selected objects unchanged relative to each other.

Subject Notifications:
This method will notify Subject::signalModified.
See also:
pushBack()

virtual void GraphicLayer::pushBack (  )  [pure virtual]

Sends the currently selected objects to the back of the layer.

It leaves the order of the selected objects unchanged relative to each other.

Subject Notifications:
This method will notify Subject::signalModified.
See also:
popFront()

virtual bool GraphicLayer::getShowLabels (  )  const [pure virtual]

Queries whether graphic object name labels are currently drawn.

Returns:
True if labels are currently drawn, otherwise false.
See also:
setShowLabels()

virtual void GraphicLayer::setShowLabels ( bool  bShowLabels  )  [pure virtual]

Sets whether to draw name labels for each graphic object.

This method specifies whether to draw a label for the graphic object name that is set with the GraphicObject::setName() method. This setting is not serialized with the layer.

Parameters:
bShowLabels Determines whether or not to show the labels.
See also:
getShowLabels()

virtual LocationType GraphicLayer::correctCoordinate ( const LocationType &  coord  )  const [pure virtual]

Correct the coordinate for whatever snapping may be required.

GraphicLayer does not perform any correction.

Parameters:
coord Coordinate to correct.
Returns:
The corrected coordinate.

Implemented in AnnotationLayer, and AoiLayer.

virtual bool GraphicLayer::getLayerLocked (  )  const [pure virtual]

Queries whether the layer is locked or graphic objects can be rotated or moved.

Returns:
True if the layer is locked, otherwise false.
See also:
setLayerLocked()

virtual void GraphicLayer::setLayerLocked ( bool  bLocked  )  [pure virtual]

Sets whether to allow rotation or movement for graphic objects in the layer.

This method specifies whether to allow the annotation objects in the layer to be rotated or moved. This setting is not serialized with the layer.

Parameters:
bLocked Determines whether or not to lock the layer.
Subject Notifications:
This method will notify signalModified().
See also:
getLayerLocked()

virtual void GraphicLayer::setCurrentGraphicObjectType ( GraphicObjectType  type  )  [pure virtual]

Sets the graphic object that will be created when the user adds a new object with the mouse.

This method provides a means for objects to set the created graphic object for only this layer. This value is reset when the user selects a new graphic object on the toolbar.

Parameters:
type The graphic object to create.
See also:
DesktopServices::setAoiSelectionTool(), DesktopServices::setAnnotationObject()

virtual GraphicObjectType GraphicLayer::getCurrentGraphicObjectType (  )  const [pure virtual]

Returns the graphic object that will be created when the user adds a new object with the mouse.

Returns:
The graphic object that will be created when the user adds a new object. This value may be different than the return value of DesktopServices::getAoiSelectionTool() or DesktopServices::getAnnotationObject() if the setCurrentGraphicObjectType() method was called and the user has not selected a new object type on the toolbar.

virtual GraphicObject* GraphicLayer::hit ( LocationType  sceneCoord  )  const [pure virtual]

Tests an input scene coordinate location to see if a graphic object exists at that location.

This method first searches selected objects and then searches all graphic objects in the layer.

Parameters:
sceneCoord The scene coordinate to test for the existence of a graphic object.
Returns:
A pointer to the first (topmost) graphic object found at the input scene coordinate location. NULL is returned if no graphic objects exist at the given location.

Software Development Kit - Opticks 4.9.0 Build 16218