SpatialDataWindow Class Reference

A window containing a spatial data view. More...

#include <SpatialDataWindow.h>

Inheritance diagram for SpatialDataWindow:

List of all members.

Public Member Functions

virtual SpatialDataView * getSpatialDataView () const =0

virtual void exportSubset ()=0

virtual void showOverviewWindow (bool bShow)=0

virtual bool isOverviewWindowShown () const =0

Static Public Member Functions

static ColorType getSettingOverviewTrailColor ()

static bool hasSettingOverviewTrailColor ()

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

static std::string getSettingOverviewTrailColorKey ()

static unsigned int getSettingOverviewTrailThreshold ()

static bool hasSettingOverviewTrailThreshold ()

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

static std::string getSettingOverviewTrailThresholdKey ()

Protected Member Functions

virtual ~SpatialDataWindow ()

Detailed Description

A window containing a spatial data view.

The spatial data window is a type of workspace window that contains a spatial data view. The class is provided for convenience when creating and using product views. The window also provides a means to export a subset of the raster data in the view.

This subclass of Subject will notify upon the following conditions:

Everything documented in WorkspaceWindow.

See also:: WorkspaceWindow, SpatialDataView

Examples:: Tutorial/Tutorial5.cpp.

Definition at line 33 of file SpatialDataWindow.h.

Constructor & Destructor Documentation

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

This should be destroyed by calling DesktopServices::deleteWindow.

Definition at line 165 of file SpatialDataWindow.h.

Member Function Documentation

static ColorType SpatialDataWindow::getSettingOverviewTrailColor ( ) [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 46 of file SpatialDataWindow.h.

static bool SpatialDataWindow::hasSettingOverviewTrailColor ( ) [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 53 of file SpatialDataWindow.h.

static void SpatialDataWindow::setSettingOverviewTrailColor	(	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 69 of file SpatialDataWindow.h.

static std::string SpatialDataWindow::getSettingOverviewTrailColorKey ( ) [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 77 of file SpatialDataWindow.h.

static unsigned int SpatialDataWindow::getSettingOverviewTrailThreshold ( ) [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 88 of file SpatialDataWindow.h.

static bool SpatialDataWindow::hasSettingOverviewTrailThreshold ( ) [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 95 of file SpatialDataWindow.h.

static void SpatialDataWindow::setSettingOverviewTrailThreshold	(	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 111 of file SpatialDataWindow.h.

static std::string SpatialDataWindow::getSettingOverviewTrailThresholdKey ( ) [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 119 of file SpatialDataWindow.h.

virtual SpatialDataView* SpatialDataWindow::getSpatialDataView ( ) const [pure virtual]

Returns the spatial data view contained in the window.

Returns:: A pointer to the spatial data view displayed in the window.

See also:: SpatialDataView

Examples:: Tutorial/Tutorial5.cpp.

virtual void SpatialDataWindow::exportSubset ( ) [pure virtual]

Allows the user to export a subset of the raster element.

This method invokes a dialog in which the user can graphically select a subset area of the raster element in the view to export to either another spatial data window or to a file.

virtual void SpatialDataWindow::showOverviewWindow ( bool bShow ) [pure virtual]

Toggles the display of the overview window.

The overview window contains a small thumbnail view of the view in this window. A selection box in the overview illustrates the displayed area of this window. The display in this window can be panned and zoomed by clicking a dragging the selection box in the overview.

Parameters:

bShow

Set this value to TRUE to show the overview window or to FALSE to hide the overview window.

virtual bool SpatialDataWindow::isOverviewWindowShown ( ) const [pure virtual]

Queries whether the overview window is displayed.

Returns:: TRUE if the overview window is displayed or FALSE if the overview window is hidden.


Public Member Functions
virtual SpatialDataView *	getSpatialDataView () const =0
virtual void	exportSubset ()=0
virtual void	showOverviewWindow (bool bShow)=0
virtual bool	isOverviewWindowShown () const =0
Static Public Member Functions
static ColorType	getSettingOverviewTrailColor ()
static bool	hasSettingOverviewTrailColor ()
static void	setSettingOverviewTrailColor (ColorType newValue, bool setIfSame=false)
static std::string	getSettingOverviewTrailColorKey ()
static unsigned int	getSettingOverviewTrailThreshold ()
static bool	hasSettingOverviewTrailThreshold ()
static void	setSettingOverviewTrailThreshold (unsigned int newValue, bool setIfSame=false)
static std::string	getSettingOverviewTrailThresholdKey ()
Protected Member Functions
virtual	~SpatialDataWindow ()