GcpLayer Class Reference

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

#include <GcpLayer.h>

Inheritance diagram for GcpLayer:

List of all members.

Public Member Functions

virtual void setColor (const ColorType &colorType)=0

virtual ColorType getColor () const =0

virtual void setSymbol (const GcpSymbol &eSymbol)=0

virtual GcpSymbol getSymbol () const =0

virtual void setSymbolSize (int iSize)=0

virtual int getSymbolSize () const =0

Static Public Member Functions

static ColorType getSettingMarkerColor ()

static bool hasSettingMarkerColor ()

static void setSettingMarkerColor (ColorType newValue, bool setIfSame=false)

static std::string getSettingMarkerColorKey ()

static unsigned int getSettingMarkerSize ()

static bool hasSettingMarkerSize ()

static void setSettingMarkerSize (unsigned int newValue, bool setIfSame=false)

static std::string getSettingMarkerSizeKey ()

static GcpSymbol getSettingMarkerSymbol ()

static bool hasSettingMarkerSymbol ()

static void setSettingMarkerSymbol (GcpSymbol newValue, bool setIfSame=false)

static std::string getSettingMarkerSymbolKey ()

static const std::string & signalColorChanged ()

static const std::string & signalSymbolChanged ()

static const std::string & signalSizeChanged ()

Protected Member Functions

virtual ~GcpLayer ()

Detailed Description

Adjusts the properties of a GCP layer.

A GCP layer consists of markers identifying locations in a scene that are used as ground control points. The marker has three properties: color, symbol, and symbol size. The size of the marker represents the number of pixels in diameter that the marker covers. This class provides the means to set the properties for the current GCP layer and also the default properties for new GCP layers.

This subclass of Subject will notify upon the following conditions:

The following methods are called: setColor(), setSymbol(), setSymbolSize().
Everything else documented in Layer.

See also:: Layer

Definition at line 36 of file GcpLayer.h.

Constructor & Destructor Documentation

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

This should be destroyed by calling SpatialDataView::deleteLayer.

Definition at line 246 of file GcpLayer.h.

Member Function Documentation

static ColorType GcpLayer::getSettingMarkerColor ( ) [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 49 of file GcpLayer.h.

static bool GcpLayer::hasSettingMarkerColor ( ) [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 56 of file GcpLayer.h.

static void GcpLayer::setSettingMarkerColor	(	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 72 of file GcpLayer.h.

static std::string GcpLayer::getSettingMarkerColorKey ( ) [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 80 of file GcpLayer.h.

static unsigned int GcpLayer::getSettingMarkerSize ( ) [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 91 of file GcpLayer.h.

static bool GcpLayer::hasSettingMarkerSize ( ) [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 98 of file GcpLayer.h.

static void GcpLayer::setSettingMarkerSize	(	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 114 of file GcpLayer.h.

static std::string GcpLayer::getSettingMarkerSizeKey ( ) [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 122 of file GcpLayer.h.

static GcpSymbol GcpLayer::getSettingMarkerSymbol ( ) [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 133 of file GcpLayer.h.

static bool GcpLayer::hasSettingMarkerSymbol ( ) [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 140 of file GcpLayer.h.

static void GcpLayer::setSettingMarkerSymbol	(	GcpSymbol	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 156 of file GcpLayer.h.

static std::string GcpLayer::getSettingMarkerSymbolKey ( ) [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 164 of file GcpLayer.h.

static const std::string& GcpLayer::signalColorChanged ( ) [static]

Emitted with any<ColorType> when a member element is externally deleted.

Definition at line 169 of file GcpLayer.h.

static const std::string& GcpLayer::signalSymbolChanged ( ) [static]

Emitted with any<SymbolType> when a member element is externally deleted.

Definition at line 173 of file GcpLayer.h.

static const std::string& GcpLayer::signalSizeChanged ( ) [static]

Emitted with any<int> when a member element is externally deleted.

Definition at line 177 of file GcpLayer.h.

virtual void GcpLayer::setColor ( const ColorType & colorType ) [pure virtual]

Sets the marker color for the current GCP layer.

Parameters:

colorType

The new marker color.

Subject Notifications:: This method will notify signalColorChanged with any<ColorType>.

See also:: getColor()

virtual ColorType GcpLayer::getColor ( ) const [pure virtual]

Returns the marker color of the current GCP layer.

Returns:: The current marker color.

See also:: setColor()

virtual void GcpLayer::setSymbol ( const GcpSymbol & eSymbol ) [pure virtual]

Sets the marker symbol for the current GCP layer.

Parameters:

eSymbol

The new marker symbol.

Subject Notifications:: This method will notify signalSymbolChanged with any<SymbolType>.

See also:: getSymbol()

virtual GcpSymbol GcpLayer::getSymbol ( ) const [pure virtual]

Returns the marker symbol of the current GCP layer.

Returns:: The current marker symbol.

See also:: setSymbol()

virtual void GcpLayer::setSymbolSize ( int iSize ) [pure virtual]

Sets the marker symbol size for the current GCP layer.

Parameters:

iSize

The new marker symbol size.

Subject Notifications:: This method will notify signalSizeChanged with any<int>.

See also:: getSymbolSize()

virtual int GcpLayer::getSymbolSize ( ) const [pure virtual]

Returns the marker symbol size of the current GCP layer.

Returns:: The current marker symbol size.

See also:: setSymbolSize()


Public Member Functions
virtual void	setColor (const ColorType &colorType)=0
virtual ColorType	getColor () const =0
virtual void	setSymbol (const GcpSymbol &eSymbol)=0
virtual GcpSymbol	getSymbol () const =0
virtual void	setSymbolSize (int iSize)=0
virtual int	getSymbolSize () const =0
Static Public Member Functions
static ColorType	getSettingMarkerColor ()
static bool	hasSettingMarkerColor ()
static void	setSettingMarkerColor (ColorType newValue, bool setIfSame=false)
static std::string	getSettingMarkerColorKey ()
static unsigned int	getSettingMarkerSize ()
static bool	hasSettingMarkerSize ()
static void	setSettingMarkerSize (unsigned int newValue, bool setIfSame=false)
static std::string	getSettingMarkerSizeKey ()
static GcpSymbol	getSettingMarkerSymbol ()
static bool	hasSettingMarkerSymbol ()
static void	setSettingMarkerSymbol (GcpSymbol newValue, bool setIfSame=false)
static std::string	getSettingMarkerSymbolKey ()
static const std::string &	signalColorChanged ()
static const std::string &	signalSymbolChanged ()
static const std::string &	signalSizeChanged ()
Protected Member Functions
virtual	~GcpLayer ()