View Class Reference

A means to display data. More...

#include <View.h>

Inheritance diagram for View:

Inheritance graph

List of all members.

Public Member Functions

virtual void setName (const std::string &viewName)=0
virtual ViewType getViewType () const =0
virtual QWidget * getWidget () const =0
virtual void setBackgroundColor (const ColorType &backgroundColor)=0
virtual ColorType getBackgroundColor () const =0
virtual void setClassification (const Classification *pClassification)=0
virtual Classification * getClassification ()=0
virtual const Classification * getClassification () const =0
virtual PositionType getClassificationPosition () const =0
virtual void setClassificationPosition (PositionType position)=0
virtual std::string getClassificationText () const =0
virtual void enableClassification (bool enable)=0
virtual void setDataOrigin (const DataOrigin &dataOrigin)=0
virtual DataOrigin getDataOrigin () const =0
virtual bool addMouseMode (MouseMode *pMouseMode)=0
virtual bool setMouseMode (MouseMode *pMouseMode)=0
virtual bool setMouseMode (const std::string &modeName)=0
virtual bool containsMouseMode (MouseMode *pMouseMode) const =0
virtual MouseMode * getMouseMode (const std::string &modeName) const =0
virtual MouseMode * getCurrentMouseMode () const =0
virtual void getMouseModes (std::vector< MouseMode * > &modes) const =0
virtual AnimationController * getAnimationController () const =0
virtual void setAnimationController (AnimationController *pPlayer)=0
virtual unsigned int getNumMouseModes () const =0
virtual void getExtents (double &dMinX, double &dMinY, double &dMaxX, double &dMaxY) const =0
virtual void getVisibleCorners (LocationType &lowerLeft, LocationType &upperLeft, LocationType &upperRight, LocationType &lowerRight) const =0
virtual LocationType getVisibleCenter () const =0
virtual void zoomExtents ()=0
virtual void zoomToBox (const LocationType &lowerLeft, const LocationType &upperRight)=0
virtual void panTo (const LocationType &worldCoord)=0
virtual void panToCenter ()=0
virtual void panBy (double dDeltaX, double dDeltaY)=0
virtual bool enableInset (bool bEnable)=0
virtual bool isInsetEnabled () const =0
virtual void setInsetPoint (const LocationType &worldCoord)=0
virtual bool enableCrossHair (bool bEnable)=0
virtual bool isCrossHairEnabled () const =0
virtual void setCrossHairColor (const ColorType &color)=0
virtual ColorType getCrossHairColor () const =0
virtual void setCrossHairBlended (bool blended)=0
virtual bool isCrossHairBlended () const =0
virtual void setCrossHairSize (int size)=0
virtual int getCrossHairSize () const =0
virtual void setCrossHairWidth (unsigned int width)=0
virtual unsigned int getCrossHairWidth () const =0
virtual void refresh ()=0
virtual bool getCurrentImage (QImage &image)=0
virtual SubImageIterator * getSubImageIterator (const QSize &totalSize, const QSize &subImageSize)=0
virtual bool linkView (View *pView, LinkType type)=0
virtual void getLinkedViews (std::vector< std::pair< View *, LinkType > > &linkedViews) const =0
virtual LinkType getViewLinkType (View *pView) const =0
virtual bool unlinkView (View *pView)=0
virtual View * copy () const =0
virtual bool copy (View *pView) const =0
virtual bool removeMouseMode (const MouseMode *pMouseMode)=0
virtual void enableMouseMode (const MouseMode *pMouseMode, bool bEnable)=0
virtual bool isMouseModeEnabled (const MouseMode *pMouseMode) const =0
virtual void translateWorldToScreen (double dWorldX, double dWorldY, double &dScreenX, double &dScreenY, bool *pVisible=NULL) const =0
virtual void translateScreenToWorld (double dScreenX, double dScreenY, double &dWorldX, double &dWorldY) const =0
virtual double getPixelSize (const LocationType &lowerLeft, const LocationType &upperRight) const =0
virtual bool isUndoBlocked () const =0
virtual bool inUndoGroup () const =0
virtual void addUndoAction (UndoAction *pAction)=0
virtual void clearUndo ()=0

Static Public Member Functions

static ColorType getSettingBackgroundColor ()
static bool hasSettingBackgroundColor ()
static void setSettingBackgroundColor (ColorType newValue, bool setIfSame=false)
static std::string getSettingBackgroundColorKey ()
static DataOrigin getSettingDataOrigin ()
static bool hasSettingDataOrigin ()
static void setSettingDataOrigin (DataOrigin newValue, bool setIfSame=false)
static std::string getSettingDataOriginKey ()
static bool getSettingInsetShowCoordinates ()
static bool hasSettingInsetShowCoordinates ()
static void setSettingInsetShowCoordinates (bool newValue, bool setIfSame=false)
static std::string getSettingInsetShowCoordinatesKey ()
static unsigned int getSettingInsetSize ()
static bool hasSettingInsetSize ()
static void setSettingInsetSize (unsigned int newValue, bool setIfSame=false)
static std::string getSettingInsetSizeKey ()
static unsigned int getSettingInsetZoom ()
static bool hasSettingInsetZoom ()
static void setSettingInsetZoom (unsigned int newValue, bool setIfSame=false)
static std::string getSettingInsetZoomKey ()
static InsetZoomMode getSettingInsetZoomMode ()
static bool hasSettingInsetZoomMode ()
static void setSettingInsetZoomMode (InsetZoomMode newValue, bool setIfSame=false)
static std::string getSettingInsetZoomModeKey ()
static int getSettingMousePanSensitivity ()
static bool hasSettingMousePanSensitivity ()
static void setSettingMousePanSensitivity (int newValue, bool setIfSame=false)
static std::string getSettingMousePanSensitivityKey ()
static unsigned int getSettingPixelValueMinimumFontSize ()
static bool hasSettingPixelValueMinimumFontSize ()
static void setSettingPixelValueMinimumFontSize (unsigned int newValue, bool setIfSame=false)
static std::string getSettingPixelValueMinimumFontSizeKey ()
static unsigned int getSettingPixelValueMaximumFontSize ()
static bool hasSettingPixelValueMaximumFontSize ()
static void setSettingPixelValueMaximumFontSize (unsigned int newValue, bool setIfSame=false)
static std::string getSettingPixelValueMaximumFontSizeKey ()
static bool getSettingDisplayCrosshair ()
static bool hasSettingDisplayCrosshair ()
static void setSettingDisplayCrosshair (bool newValue, bool setIfSame=false)
static std::string getSettingDisplayCrosshairKey ()
static ColorType getSettingCrosshairColor ()
static bool hasSettingCrosshairColor ()
static void setSettingCrosshairColor (ColorType newValue, bool setIfSame=false)
static std::string getSettingCrosshairColorKey ()
static bool getSettingCrosshairBlend ()
static bool hasSettingCrosshairBlend ()
static void setSettingCrosshairBlend (bool newValue, bool setIfSame=false)
static std::string getSettingCrosshairBlendKey ()
static int getSettingCrosshairSize ()
static bool hasSettingCrosshairSize ()
static void setSettingCrosshairSize (int newValue, bool setIfSame=false)
static std::string getSettingCrosshairSizeKey ()
static unsigned int getSettingCrosshairWidth ()
static bool hasSettingCrosshairWidth ()
static void setSettingCrosshairWidth (unsigned int newValue, bool setIfSame=false)
static std::string getSettingCrosshairWidthKey ()
static bool getSettingUseViewResolution ()
static bool hasSettingUseViewResolution ()
static void setSettingUseViewResolution (bool newValue, bool setIfSame=false)
static std::string getSettingUseViewResolutionKey ()
static bool getSettingAspectRatioLock ()
static bool hasSettingAspectRatioLock ()
static void setSettingAspectRatioLock (bool newValue, bool setIfSame=false)
static std::string getSettingAspectRatioLockKey ()
static unsigned int getSettingOutputWidth ()
static bool hasSettingOutputWidth ()
static void setSettingOutputWidth (unsigned int newValue, bool setIfSame=false)
static std::string getSettingOutputWidthKey ()
static unsigned int getSettingOutputHeight ()
static bool hasSettingOutputHeight ()
static void setSettingOutputHeight (unsigned int newValue, bool setIfSame=false)
static std::string getSettingOutputHeightKey ()
static LinkType getSettingLinkType ()
static bool hasSettingLinkType ()
static void setSettingLinkType (LinkType newValue, bool setIfSame=false)
static std::string getSettingLinkTypeKey ()
static const std::string & signalSelectionBoxChanged ()
static const std::string & signalRenamed ()
static const std::string & signalClassificationChanged ()
static const std::string & signalClassificationTextChanged ()
static const std::string & signalClassificationFontChanged ()
static const std::string & signalClassificationColorChanged ()
static const std::string & signalBackgroundColorChanged ()
static const std::string & signalOriginChanged ()
static const std::string & signalMouseModeChanged ()
static const std::string & signalMousePanEnabled ()
static const std::string & signalExtentsChanged ()
static const std::string & signalAboutToShowContextMenu ()

Protected Member Functions

virtual ~View ()
virtual void blockUndo ()=0
virtual void unblockUndo ()=0
virtual void startUndoGroup (const std::string &text)=0
virtual void endUndoGroup ()=0

Classes

class  SubImageIterator
 This class accesses portions of a view image. More...

Detailed Description

A means to display data.

This class is a base class containing common functionality to display data to the user. A view is actually a widget has a name and a type, and classification. Zooming and panning functionality is provided, along with capability to link other views to this view and to set other display features.

When the user right-clicks in the view, a context menu is invoked allowing the user to change the display characteristics of the view.

This subclass of Subject will notify upon the following conditions:

See also:
Window

Definition at line 51 of file View.h.

Constructor & Destructor Documentation

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

This should be destroyed by calling DesktopServices::deleteView.

Definition at line 1888 of file View.h.

Member Function Documentation

static ColorType View::getSettingBackgroundColor (  )  [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 64 of file View.h.

static bool View::hasSettingBackgroundColor (  )  [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 71 of file View.h.

static void View::setSettingBackgroundColor ( 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 87 of file View.h.

static std::string View::getSettingBackgroundColorKey (  )  [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 95 of file View.h.

static DataOrigin View::getSettingDataOrigin (  )  [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 106 of file View.h.

static bool View::hasSettingDataOrigin (  )  [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 113 of file View.h.

static void View::setSettingDataOrigin ( DataOrigin  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 129 of file View.h.

static std::string View::getSettingDataOriginKey (  )  [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 137 of file View.h.

static bool View::getSettingInsetShowCoordinates (  )  [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 148 of file View.h.

static bool View::hasSettingInsetShowCoordinates (  )  [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 155 of file View.h.

static void View::setSettingInsetShowCoordinates ( 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 171 of file View.h.

static std::string View::getSettingInsetShowCoordinatesKey (  )  [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 179 of file View.h.

static unsigned int View::getSettingInsetSize (  )  [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 190 of file View.h.

static bool View::hasSettingInsetSize (  )  [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 197 of file View.h.

static void View::setSettingInsetSize ( 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 213 of file View.h.

static std::string View::getSettingInsetSizeKey (  )  [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 221 of file View.h.

static unsigned int View::getSettingInsetZoom (  )  [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 232 of file View.h.

static bool View::hasSettingInsetZoom (  )  [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 239 of file View.h.

static void View::setSettingInsetZoom ( 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 255 of file View.h.

static std::string View::getSettingInsetZoomKey (  )  [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 263 of file View.h.

static InsetZoomMode View::getSettingInsetZoomMode (  )  [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 274 of file View.h.

static bool View::hasSettingInsetZoomMode (  )  [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 281 of file View.h.

static void View::setSettingInsetZoomMode ( InsetZoomMode  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 297 of file View.h.

static std::string View::getSettingInsetZoomModeKey (  )  [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 305 of file View.h.

static int View::getSettingMousePanSensitivity (  )  [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 316 of file View.h.

static bool View::hasSettingMousePanSensitivity (  )  [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 323 of file View.h.

static void View::setSettingMousePanSensitivity ( 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 339 of file View.h.

static std::string View::getSettingMousePanSensitivityKey (  )  [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 347 of file View.h.

static unsigned int View::getSettingPixelValueMinimumFontSize (  )  [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 358 of file View.h.

static bool View::hasSettingPixelValueMinimumFontSize (  )  [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 365 of file View.h.

static void View::setSettingPixelValueMinimumFontSize ( 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 381 of file View.h.

static std::string View::getSettingPixelValueMinimumFontSizeKey (  )  [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 389 of file View.h.

static unsigned int View::getSettingPixelValueMaximumFontSize (  )  [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 400 of file View.h.

static bool View::hasSettingPixelValueMaximumFontSize (  )  [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 407 of file View.h.

static void View::setSettingPixelValueMaximumFontSize ( 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 423 of file View.h.

static std::string View::getSettingPixelValueMaximumFontSizeKey (  )  [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 431 of file View.h.

static bool View::getSettingDisplayCrosshair (  )  [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 442 of file View.h.

static bool View::hasSettingDisplayCrosshair (  )  [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 449 of file View.h.

static void View::setSettingDisplayCrosshair ( 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 465 of file View.h.

static std::string View::getSettingDisplayCrosshairKey (  )  [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 473 of file View.h.

static ColorType View::getSettingCrosshairColor (  )  [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 484 of file View.h.

static bool View::hasSettingCrosshairColor (  )  [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 491 of file View.h.

static void View::setSettingCrosshairColor ( 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 507 of file View.h.

static std::string View::getSettingCrosshairColorKey (  )  [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 515 of file View.h.

static bool View::getSettingCrosshairBlend (  )  [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 526 of file View.h.

static bool View::hasSettingCrosshairBlend (  )  [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 533 of file View.h.

static void View::setSettingCrosshairBlend ( 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 549 of file View.h.

static std::string View::getSettingCrosshairBlendKey (  )  [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 557 of file View.h.

static int View::getSettingCrosshairSize (  )  [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 568 of file View.h.

static bool View::hasSettingCrosshairSize (  )  [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 575 of file View.h.

static void View::setSettingCrosshairSize ( 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 591 of file View.h.

static std::string View::getSettingCrosshairSizeKey (  )  [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 599 of file View.h.

static unsigned int View::getSettingCrosshairWidth (  )  [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 610 of file View.h.

static bool View::hasSettingCrosshairWidth (  )  [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 617 of file View.h.

static void View::setSettingCrosshairWidth ( 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 633 of file View.h.

static std::string View::getSettingCrosshairWidthKey (  )  [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 641 of file View.h.

static bool View::getSettingUseViewResolution (  )  [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 652 of file View.h.

static bool View::hasSettingUseViewResolution (  )  [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 659 of file View.h.

static void View::setSettingUseViewResolution ( 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 675 of file View.h.

static std::string View::getSettingUseViewResolutionKey (  )  [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 683 of file View.h.

static bool View::getSettingAspectRatioLock (  )  [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 694 of file View.h.

static bool View::hasSettingAspectRatioLock (  )  [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 701 of file View.h.

static void View::setSettingAspectRatioLock ( 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 717 of file View.h.

static std::string View::getSettingAspectRatioLockKey (  )  [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 725 of file View.h.

static unsigned int View::getSettingOutputWidth (  )  [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 736 of file View.h.

static bool View::hasSettingOutputWidth (  )  [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 743 of file View.h.

static void View::setSettingOutputWidth ( 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 759 of file View.h.

static std::string View::getSettingOutputWidthKey (  )  [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 767 of file View.h.

static unsigned int View::getSettingOutputHeight (  )  [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 778 of file View.h.

static bool View::hasSettingOutputHeight (  )  [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 785 of file View.h.

static void View::setSettingOutputHeight ( 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 801 of file View.h.

static std::string View::getSettingOutputHeightKey (  )  [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 809 of file View.h.

static LinkType View::getSettingLinkType (  )  [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 820 of file View.h.

static bool View::hasSettingLinkType (  )  [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 827 of file View.h.

static void View::setSettingLinkType ( LinkType  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 843 of file View.h.

static std::string View::getSettingLinkTypeKey (  )  [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 851 of file View.h.

static const std::string& View::signalSelectionBoxChanged (  )  [static]

Emitted with any<vector<LocationType> > when the selection box is changed.

Definition at line 931 of file View.h.

static const std::string& View::signalRenamed (  )  [static]

Emitted when the view name changes with boost::any<std::string> containing the new name.

Definition at line 937 of file View.h.

static const std::string& View::signalClassificationChanged (  )  [static]

Emitted with boost::any<const Classification*> when the classification changes.

See also:
signalClassificationTextChanged(), setClassification()

Definition at line 945 of file View.h.

static const std::string& View::signalClassificationTextChanged (  )  [static]

Emitted when the displayed classification text changes as a result of a classification change with boost::any<std::string> containing the new classification text.

This signal will not always be emitted when the signalClassificationChanged() signal is emitted as a result of a classification change, if the modified classification parameters do not appear in the displayed text.

See also:
signalClassificationChanged(), setClassification()

Definition at line 959 of file View.h.

static const std::string& View::signalClassificationFontChanged (  )  [static]

Emitted with any<QFont> when the classification font is changed.

Definition at line 964 of file View.h.

static const std::string& View::signalClassificationColorChanged (  )  [static]

Emitted with any<ColorType> when the classification color is changed.

Definition at line 969 of file View.h.

static const std::string& View::signalBackgroundColorChanged (  )  [static]

Emitted with any<ColorType> when the background color is changed.

Definition at line 974 of file View.h.

static const std::string& View::signalOriginChanged (  )  [static]

Emitted with any<DataOrigin> when the origin is changed.

Definition at line 979 of file View.h.

static const std::string& View::signalMouseModeChanged (  )  [static]

Emitted with any<const MouseMode*> when the mouse mode is changed.

Definition at line 984 of file View.h.

static const std::string& View::signalMousePanEnabled (  )  [static]

Emitted with boost::any<bool> when mouse pan is enabled or disabled by the user.

Definition at line 990 of file View.h.

static const std::string& View::signalExtentsChanged (  )  [static]

Emitted with any<boost::tuple<double,double,double,double> > when the view extents are changed.

The values in the tuple are minX, minY, maxX and maxY respectively.

Definition at line 997 of file View.h.

static const std::string& View::signalAboutToShowContextMenu (  )  [static]

Emitted with boost::any<ContextMenu*> when the user right-clicks to invoke a context menu.

This signal provides a means by which an object can be notified when a context menu is invoked by the user clicking inside a view. To receive notification for when a context menu is invoked when the user clicks on any session item, attach to the DesktopServices::signalAboutToShowContextMenu() signal instead.

This signal is emitted after getContextMenuActions() is called and after the DesktopServices::signalAboutToShowContextMenu() signal is emitted, but before the context menu is shown to give attached objects a chance to add or modify the context menu that will be displayed to the user.

The ContextMenu pointer value is guaranteed to be non-NULL. The session items vector in the context menu contains the view.

See also:
Context menu calling sequence

Definition at line 1020 of file View.h.

virtual void View::setName ( const std::string &  viewName  )  [pure virtual]

Sets the view name.

Parameters:
viewName The new name for the view. Cannot be empty.
Subject Notifications:
This method will notify signalRenamed() with any<std::string>.

virtual ViewType View::getViewType (  )  const [pure virtual]

Returns the view type.

Returns:
The view type.
See also:
ViewType

virtual QWidget* View::getWidget (  )  const [pure virtual]

Returns the widget that displays the view.

This method returns the Qt widget that displays the view. This can be used to add the view to a custom dialog or widget if it is not already contained in a ViewWindow.

Returns:
A pointer to the widget that displays the view. NULL is returned if the widget cannot be accessed.

virtual void View::setBackgroundColor ( const ColorType &  backgroundColor  )  [pure virtual]

Sets the background color of the view.

This method does not call refresh() so that multiple calls to modify view settings can be made without refreshing the view after each modification.

Parameters:
backgroundColor The new background color. Must be a valid color.
See also:
ColorType
Subject Notifications:
This method will notify signalBackgroundColorChanged() with any<ColorType>.

virtual ColorType View::getBackgroundColor (  )  const [pure virtual]

Returns the background color of the view.

Returns:
The current background color.

virtual void View::setClassification ( const Classification *  pClassification  )  [pure virtual]

Sets the classification of the view.

This method does not call refresh() so that multiple calls to modify view settings can be made without refreshing the view after each modification.

Parameters:
pClassification The classification for the view. A deep copy is performed so it is the responsibility of the calling object to delete the given Classification object when necessary. This method does nothing if NULL is passed in.
Subject Notifications:
This method will notify signalClassificationChanged() with boost::any<const Classification*> if the classification changes. This method will also notify signalClassificationTextChanged() with boost::any<std::string> containing the new classification that that will be displayed only if the text generated by the given classification has changed from the previously displayed classification text.

virtual Classification* View::getClassification (  )  [pure virtual]

Returns a pointer to the view's classification object.

The classification object documents how the data in the view is to be handled and/or restricted.

Returns:
A pointer to the view's classification object.
See also:
Classification

virtual const Classification* View::getClassification (  )  const [pure virtual]

Returns read-only access to the view's classification object.

The classification object documents how the data in the view is to be handled and/or restricted.

Returns:
A const pointer to the view's classification object. The classification represented by the returned pointer should not be modified. To modify the values, call the non-const version of getClassification() instead.
See also:
Classification

virtual PositionType View::getClassificationPosition (  )  const [pure virtual]

Returns the position for the classification markings.

Returns:
An enum that designates the positions for the top and bottom classification markings.
See also:
PositionType

virtual void View::setClassificationPosition ( PositionType  position  )  [pure virtual]

Sets the position of the classification markings in the view.

Parameters:
position An enum that designates the positions for the top and bottom classification markings.
See also:
PositionType
Subject Notifications:
This method will notify Subject::signalModified() with boost::any<PositionType>.

virtual std::string View::getClassificationText (  )  const [pure virtual]

Retrieves a text string containing the classification markings.

Returns:
A string containing the complete classification text.

virtual void View::enableClassification ( bool  enable  )  [pure virtual]

Enables/disables display of classification markings.

Parameters:
enable If true (the default), classification markings are displayed on the view. If false, classification markings are not displayed.

virtual void View::setDataOrigin ( const DataOrigin &  dataOrigin  )  [pure virtual]

Sets the data origin location in the view.

This method does not call refresh() so that multiple calls to modify view settings can be made without refreshing the view after each modification.

Parameters:
dataOrigin The new origin location of the world coordinate system.
Subject Notifications:
This method will notify signalOriginChanged() with any<DataOrigin>.

virtual DataOrigin View::getDataOrigin (  )  const [pure virtual]

Returns the data origin location.

Returns:
The current origin of the world coordinate system.

virtual bool View::addMouseMode ( MouseMode *  pMouseMode  )  [pure virtual]

Registers a new mouse mode.

Parameters:
pMouseMode The mouse mode to register with the view. Cannot be NULL. The mouse mode name must be unique for all mouse modes registered with the view.
Returns:
TRUE if the mouse mode was successfully registered the view, otherwise FALSE. FALSE is returned if the mouse mode cannot be registered, i.e. it has the same name as an existing mouse mode.

virtual bool View::setMouseMode ( MouseMode *  pMouseMode  )  [pure virtual]

Sets the current mouse mode.

Parameters:
pMouseMode The new mouse mode.
Returns:
TRUE if the mouse mode was successfully set for the view, otherwise FALSE. FALSE is returned if the view does not support the mouse mode.
Subject Notifications:
This method will notify signalMouseModeChanged() with any<const MouseMode*>.
See also:
MouseMode

virtual bool View::setMouseMode ( const std::string &  modeName  )  [pure virtual]

Sets the current mouse mode.

This method serves as a convenience function to set the mouse mode. It sets the mouse mode based on the mode name.

Parameters:
modeName The name for the mouse mode to set for the view. Cannot be empty.
Returns:
TRUE if the mouse mode was successfully set for the view, otherwise FALSE. FALSE is returned if the view does not contain a mouse mode with the given name.
Subject Notifications:
This method will notify signalMouseModeChanged() with any<const MouseMode*>.

virtual bool View::containsMouseMode ( MouseMode *  pMouseMode  )  const [pure virtual]

Queries whether a given mouse mode is registered with the view.

Parameters:
pMouseMode The mouse mode to query.
Returns:
TRUE if the mouse mode is registered for the view, otherwise FALSE. FALSE is returned if the view does not support the mouse mode.
See also:
MouseMode

virtual MouseMode* View::getMouseMode ( const std::string &  modeName  )  const [pure virtual]

Returns the mouse mode with a given name.

Parameters:
modeName The name for the mouse mode to get. Cannot be empty.
Returns:
A pointer to the mouse mode with the given name. NULL is returned if the view does not contain a mouse mode with the given name.

virtual MouseMode* View::getCurrentMouseMode (  )  const [pure virtual]

Returns the current mouse mode.

Returns:
A pointer to the current mouse mode. NULL is returned if the view does not contain any mouse modes, or if no mode is considered current.

virtual void View::getMouseModes ( std::vector< MouseMode * > &  modes  )  const [pure virtual]

Retrieves all mouse modes registered with the view.

Parameters:
modes Populated with pointers to the registered mouse modes.

virtual AnimationController* View::getAnimationController (  )  const [pure virtual]

Retrieves the animation controller associated with the view.

Returns:
A pointer to the associated AnimationController or NULL if there is no associated AnimationController
See also:
setAnimationController()

virtual void View::setAnimationController ( AnimationController *  pPlayer  )  [pure virtual]

Associates an animation controller with the view.

Parameters:
pPlayer The AnimationController to associate with the view.
See also:
getAnimationController()

virtual unsigned int View::getNumMouseModes (  )  const [pure virtual]

Returns the number of registered mouse mode.

Returns:
The number of mouse modes currently available in the view.

virtual void View::getExtents ( double &  dMinX,
double &  dMinY,
double &  dMaxX,
double &  dMaxY 
) const [pure virtual]

Retrieves the data extents in world coordinates.

Parameters:
dMinX The minimum data value in the X dimension.
dMinY The minimum data value in the Y dimension.
dMaxX The maximum data value in the X dimension.
dMaxY The maximum data value in the Y dimension.

virtual void View::getVisibleCorners ( LocationType &  lowerLeft,
LocationType &  upperLeft,
LocationType &  upperRight,
LocationType &  lowerRight 
) const [pure virtual]

Retrieves the corner coordinates of the visible view area.

Parameters:
lowerLeft A LocationType that is populated with the lower left coordinate.
upperLeft A LocationType that is populated with the upper left coordinate.
upperRight A LocationType that is populated with the upper right coordinate.
lowerRight A LocationType that is populated with the lower right coordinate.
See also:
getVisibleCenter()

virtual LocationType View::getVisibleCenter (  )  const [pure virtual]

Returns the coordinate at the current visible center of the view.

Returns:
The current center coordinate.

virtual void View::zoomExtents (  )  [pure virtual]

Zooms the image to the data extents.

This method zooms the view out so that the entire extents of the data are displayed.

This method does not call refresh() so that multiple calls to modify view settings can be made without refreshing the view after each modification.

See also:
zoomToBox()

virtual void View::zoomToBox ( const LocationType &  lowerLeft,
const LocationType &  upperRight 
) [pure virtual]

Zooms the image to a defined rectangular area.

This method does not call refresh() so that multiple calls to modify view settings can be made without refreshing the view after each modification.

Parameters:
lowerLeft The lower left location of the view in world coordinates.
upperRight The upper right location of the view in world coordinates.
See also:
zoomExtents()

virtual void View::panTo ( const LocationType &  worldCoord  )  [pure virtual]

Centers the image on a given point.

This method does not call refresh() so that multiple calls to modify view settings can be made without refreshing the view after each modification.

Parameters:
worldCoord The point to pan to the center of the view in world coordinates.
See also:
panToCenter(), panBy()

virtual void View::panToCenter (  )  [pure virtual]

Centers the image in the view.

This method does not call refresh() so that multiple calls to modify view settings can be made without refreshing the view after each modification.

See also:
panTo(), panBy()

virtual void View::panBy ( double  dDeltaX,
double  dDeltaY 
) [pure virtual]

Moves the image by a given distance.

This method does not call refresh() so that multiple calls to modify view settings can be made without refreshing the view after each modification.

Parameters:
dDeltaX The X distance from which to pan the view from its current location in world coordinates.
dDeltaY The Y distance from which to pan the view from its current location in world coordinates.
See also:
panTo()

virtual bool View::enableInset ( bool  bEnable  )  [pure virtual]

Toggles the display of a dynamic inset window.

This methods toggles the display of a dynamic inset window, which appears on top of the view. The window displays a portion of the view at a different zoom and level than the view. The default size and zoom level of the inset window are specified in the Options.

Parameters:
bEnable Set this value to TRUE to display the inset window or to FALSE to hide the inset window.
Returns:
TRUE if the inset window was successfully enabled or disabled, or FALSE if the inset window is not supported by the view.
See also:
setInsetPoint()

virtual bool View::isInsetEnabled (  )  const [pure virtual]

Queries whether the dynamic inset window is enabled.

Returns:
TRUE if the inset window is enabled, whereby it is drawn on top of the view, or FALSE if the inset window is disabled.

virtual void View::setInsetPoint ( const LocationType &  worldCoord  )  [pure virtual]

Sets the center of the dynamic inset window.

Parameters:
worldCoord The new inset center point in world coordinates.

virtual bool View::enableCrossHair ( bool  bEnable  )  [pure virtual]

Toggles the display of the view crosshair.

This methods toggles the display of a crosshair marker in the center of the view.

Parameters:
bEnable Set this value to true to display the crosshair in the view or to false to hide the crosshair.
Returns:
Returns true if the crosshair was successfully enabled or disabled, or false if the crosshair is not supported by the view.

virtual bool View::isCrossHairEnabled (  )  const [pure virtual]

Queries whether the view crosshair is enabled.

Returns:
Returns true if the crosshair is currently enabled, whereby it is drawn in the center of the view, or false if the crosshair is currently disabled.

virtual void View::setCrossHairColor ( const ColorType &  color  )  [pure virtual]

Sets the crosshair color in the view.

This method does not call refresh() so that multiple calls to modify view settings can be made without refreshing the view after each modification.

Calling this method still sets the crosshair color, even if isCrossHairEnabled() returns false.

Parameters:
color The new crosshair color. This method does nothing if an invalid color is passed in.
See also:
ColorType::isValid()

virtual ColorType View::getCrossHairColor (  )  const [pure virtual]

Returns the crosshair color.

Returns:
The current crosshair color.

virtual void View::setCrossHairBlended ( bool  blended  )  [pure virtual]

Sets the crosshair color to be blended with the view color.

Enabling the blended state combines the crosshair color with the color in the view just behind the crosshair to provide enough contrast for the crosshair to always be visible.

This method does not call refresh() so that multiple calls to modify view settings can be made without refreshing the view after each modification.

Calling this method still sets the crosshair blended state, even if isCrossHairEnabled() returns false.

Parameters:
blended Set this value to true to enable blending the crosshair color with the color in the view just behind the crosshair. Set this value to false to display the crosshair as a solid color, regardless of the view color.
See also:
setCrossHairColor()

virtual bool View::isCrossHairBlended (  )  const [pure virtual]

Returns the blended state when drawing the crosshair.

Returns:
Returns true if the crosshair color will be blended with the view color when drawn. Returns false if the crosshair is drawn as a solid color regardless of the view color.
See also:
setCrossHairBlended()

virtual void View::setCrossHairSize ( int  size  )  [pure virtual]

Sets the overall width and height of the crosshair in the view in screen pixels.

This method does not call refresh() so that multiple calls to modify view settings can be made without refreshing the view after each modification.

Calling this method still sets the crosshair size, even if isCrossHairEnabled() returns false.

Parameters:
size The crosshair width and height in screen pixels. This method does nothing if a value less than one is passed in.

virtual int View::getCrossHairSize (  )  const [pure virtual]

Returns the crosshair size.

Returns:
The current crosshair size.

virtual void View::setCrossHairWidth ( unsigned int  width  )  [pure virtual]

Sets the line width of the crosshair in the view.

This method does not call refresh() so that multiple calls to modify view settings can be made without refreshing the view after each modification.

Calling this method still sets the crosshair line width, even if isCrossHairEnabled() returns false.

Parameters:
width The crosshair line width in screen pixels. This method does nothing if a value of zero is passed in.

virtual unsigned int View::getCrossHairWidth (  )  const [pure virtual]

Returns the crosshair line width.

Returns:
The current crosshair line width in screen pixels.

virtual void View::refresh (  )  [pure virtual]

Redraws the current contents of the view.

virtual bool View::getCurrentImage ( QImage &  image  )  [pure virtual]

Retrieves an image of the current view state.

This method retrieves the data for the current image as displayed in the view. This is similar to taking a screen snapshot of the view.

Parameters:
image A Qt image reference that is populated with the current view image. If a null image is passed in, the size of the image will be equal to the size of the view in screen pixels. Otherwise, the view will be scaled to the image size when generating the image data. If a size is specified, the QImage should use QImage::Format_ARGB32. If the format is different, the QImage will be converted to QImage::Format_ARGB32.
Returns:
Returns true if a valid image was successfully retrieved, otherwise returns false.

virtual SubImageIterator* View::getSubImageIterator ( const QSize &  totalSize,
const QSize &  subImageSize 
) [pure virtual]

Retrieves an iterator over sub-images of the current view state.

This method is similar to getCurrentImage(QImage&) except it obtains an iterator which accesses sub-sections of the view. This is used for "pan and scan" image generation. The caller takes ownership of the SubImageIterator and MUST delete the SubImageIterator when it is no longer needed. When a SubImageIterator exists for a view, another can not be created and no other view operations should be performed.

Parameters:
totalSize This is the size of the entire image. If all the generated sub-images are stitched together, they will make an image this size.
subImageSize This is the size of each sub-image.
Returns:
A SubImageIterator over the view. The iterator will immediatly return false to SubImageIterator::hasNext() calls if an error occurs. If a SubImageIterator already exists for this View, that iterator will be returned.

virtual bool View::linkView ( View *  pView,
LinkType  type 
) [pure virtual]

Links a view with this view.

This method establishes a link between this view and another view. Linked views are linked depending on the link type specified.

Parameters:
pView The view to link with this view. Cannot be NULL.
type The type of link to create. Specifying NO_LINK is equivilent to calling unlinkView().
Returns:
TRUE if the view was successfully linked with this view, otherwise FALSE.

virtual void View::getLinkedViews ( std::vector< std::pair< View *, LinkType > > &  linkedViews  )  const [pure virtual]

Retrieves views linked with this view.

Parameters:
linkedViews A reference to a vector that is populated with pointers to views linked with this view and the associated link type. If no views are linked, the vector is emptied.

virtual LinkType View::getViewLinkType ( View *  pView  )  const [pure virtual]

Queries what kind of link a view has with this view.

Parameters:
pView The view to query for linkage with this view.
Returns:
The type of link that exists. NO_LINK indicated that there is no linking relationship.

virtual bool View::unlinkView ( View *  pView  )  [pure virtual]

Breaks the link between this view and a given view.

Parameters:
pView The view to unlink with this view. Cannot be NULL.
Returns:
TRUE if the view was successfully unlinked with this view, otherwise FALSE.

virtual View* View::copy (  )  const [pure virtual]

Creates a new view with the same settings and properties as this view.

This is designed to copy an existing view into a product view object. This method will not create a new window.

Returns:
A pointer to the new view. NULL is returned if an error occurs.

virtual bool View::copy ( View *  pView  )  const [pure virtual]

Copies view settings and properties to an existing view.

This performs a shallow copy into an existing view. The common use case is to create a new window/view and copy the settings of an existing view. This creates a duplicate but independent view into the same data.

Parameters:
pView The target view.
Returns:
True if successful, false if there was an error.

virtual bool View::removeMouseMode ( const MouseMode *  pMouseMode  )  [pure virtual]

Removes an existing mouse mode.

This method removes the given mouse mode from the view regardless of whether the mode is enabled or disabled. The mouse mode is not deleted.

Parameters:
pMouseMode The mouse mode to remove from the view.
Returns:
True if the mouse mode was successfully removed from the view. False is returned if the mouse mode is not contained in this view.
See also:
isMouseModeEnabled()

virtual void View::enableMouseMode ( const MouseMode *  pMouseMode,
bool  bEnable 
) [pure virtual]

Enables or disables a mouse mode.

This method enables or disabled the given mouse mode from the view. A disabled mouse mode cannot be made current with the setMouseMode() method.

Parameters:
pMouseMode The mouse mode to enable or disable. This method does nothing if the view does not contain the given mouse mode.
bEnable Set this parameter to true to enable the mouse mode or to false to disable the mouse mode.
See also:
setMouseMode(), isMouseModeEnabled()

virtual bool View::isMouseModeEnabled ( const MouseMode *  pMouseMode  )  const [pure virtual]

Queries whether a mouse mode is currently enabled or disabled.

This method removes the given mouse mode from the view regardless of whether the mode is enabled or disabled. The mouse mode is not deleted.

Parameters:
pMouseMode The mouse mode to query whether it is enabled or disabled.
Returns:
True if the mouse mode is currently enabled or false if the mode is disabled. False is also returned if the mouse mode is not contained in this view.
See also:
enableMouseMode()

virtual void View::translateWorldToScreen ( double  dWorldX,
double  dWorldY,
double &  dScreenX,
double &  dScreenY,
bool *  pVisible = NULL 
) const [pure virtual]

Retrieves a screen coordinate for a given world coordinate.

This method converts a world coordinate into a screen coordinate. The world coordinate is the linear coordinate system used internally to draw the data, which is typically the same coodinate system as the data itself. The screen coordinate is the location relative to the view widget with the origin being in the lower left corner.

Parameters:
dWorldX The x-position of the world coordinate. The value does not need to be within the view extents.
dWorldY The y-position of the world coordinate. The value does not need to be within the view extents.
dScreenX Populated with the screen x-coordinate of the given world coordinate. A negative value indicates that the world coordinate is not currently displayed in the view widget.
dScreenY Populated with the screen y-coordinate of the given world coordinate. A negative value indicates that the world coordinate is not currently displayed in the view widget.
pVisible If this value is non-NULL, the pointer is populated with a value indicating whether the given world coordinate is visible with the current view widget.
See also:
translateScreenToWorld(), getPixelSize()

virtual void View::translateScreenToWorld ( double  dScreenX,
double  dScreenY,
double &  dWorldX,
double &  dWorldY 
) const [pure virtual]

Retrieves a world coordinate for a given screen coordinate.

This method converts an OpenGL screen coordinate into a world coordinate. The OpenGL screen coordinate is the location relative to the view widget with the origin being in the lower left corner. To determine the correct dScreenY value, the mouse event y-coordinate must be subtracted from the view height,e.g., dScreenY = pViewWidget.height() - pMouseEvent.pos().y().

The world coordinate is the linear coordinate system used internally to draw the data, which is typically the same coodinate system as the data itself.

Parameters:
dScreenX The x-position of the screen coordinate. The value does not need to be within the view extents.
dScreenY The y-position of the screen coordinate. The value does not need to be within the view extents.
dWorldX Populated with the world x-coordinate of the given screen coordinate.
dWorldY Populated with the world y-coordinate of the given screen coordinate.
See also:
translateWorldToScreen(), getPixelSize()

virtual double View::getPixelSize ( const LocationType &  lowerLeft,
const LocationType &  upperRight 
) const [pure virtual]

Returns the number of screen pixels that cover a given range of world pixels.

Warning:
This method assumes that the scene pixel aspect ratio is one, and therefore should not be called on an orthographic view. For orthographic views, call OrthographicView::getPixelSize() instead. When calling this method on a perspective view, if PerspectiveView::getPixelAspect() returns a value other than one, the return value should be multiplied by the pixel aspect to get the correct pixel size for the x-dimension, as shown in the code sample below: 
  double pixelSize = pPerspectiveView->getPixelSize(llCorner, urCorner);
  double pixelSizeX = pixelSize * pPerspectiveView->getPixelAspect();
  double pixelSizeY = pixelSize;
Parameters:
lowerLeft The world coordinate closest to the origin.
upperRight The world coordinate furthest from the origin.
Returns:
The number of screen pixels covering the given range of world coordinates.
See also:
translateWorldToScreen(), translateScreenToWorld()

virtual bool View::isUndoBlocked (  )  const [pure virtual]

Queries whether undo actions are able to be added to the view's undo stack.

Returns:
Returns true if undo actions cannot be added to the undo stack, or false if undo actions are added to the stack.
See also:
UndoLock, addUndoAction()

virtual bool View::inUndoGroup (  )  const [pure virtual]

Queries whether undo actions are currently added to an undo group.

Returns:
Returns true if undo actions are added to an undo group, or false if undo actions are added directly to the stack.
See also:
UndoGroup, addUndoAction()

virtual void View::addUndoAction ( UndoAction *  pAction  )  [pure virtual]

Adds an action to the undo stack.

This method add the given action to the undo stack. If startUndoGroup() has been called without a corresponding call to endUndoGroup() the action is added to the group.

This method only needs to be called from a plug-in if adding custom undo actions defined in the plug-in.

Warning:
If a plug-in defines its own UndoAction subclass, the plug-in must remain loaded until the view is deleted to ensure the action can be properly deleted.
Parameters:
pAction The action to add to the undo stack. The view assumes ownership of the action and will delete it when necessary. If isUndoBlocked() returns true, this method deletes the given action immediately.

virtual void View::clearUndo (  )  [pure virtual]

Clears the undo stack.

This method removes all undo actions from the undo stack regardless of whether adding undo actions is blocked. If inUndoGroup() returns true, any actions existing in the group are destroyed.

virtual void View::blockUndo (  )  [protected, pure virtual]

Prevents undo actions from being added to the view's undo stack.

Warning:
This method exists for implementation purposes and cannot be used directly. Instead, use the UndoLock object to prevent undo actions from being added to the view.
See also:
UndoLock, isUndoBlocked()

virtual void View::unblockUndo (  )  [protected, pure virtual]

Allows undo actions to be added to the view's undo stack.

Warning:
This method exists for implementation purposes and cannot be used directly. Instead, use the UndoLock object to prevent undo actions from being added to the view.
See also:
UndoLock, isUndoBlocked()

virtual void View::startUndoGroup ( const std::string &  text  )  [protected, pure virtual]

Instructs the undo stack to add all future undo actions to a group.

Warning:
This method exists for implementation purposes and cannot be used directly. Instead, use the UndoGroup object to group future undo actions into a single undoable operation.
Parameters:
text The name for the undo action group that will appear to the user.
See also:
UndoGroup, inUndoGroup(), addUndoAction()

virtual void View::endUndoGroup (  )  [protected, pure virtual]

Returns the undo stack to normal operations when adding undo actions.

Warning:
This method exists for implementation purposes and cannot be used directly. Instead, use the UndoGroup object to group future undo actions into a single undoable operation.
See also:
UndoGroup, inUndoGroup(), addUndoAction()

Software Development Kit - Opticks 4.9.0 Build 16218