USGS

Isis 3.0 Developer's Reference (API)

 Home

Isis::TrackTool Class Reference

This tool is part of the Qisis namespace and displays the statusbar of the window. More...

#include <TrackTool.h>

Inherits Isis::Tool.

List of all members.

Public Slots

virtual void mouseMove (QPoint p)
 Updates the labels anytime the mouse moves.
virtual void mouseLeave ()
 Clears the labels if the mouse leaves the application.
void activate (bool)
 Activates the tool.
virtual void updateTool ()
 Updates the tool.
void setCubeViewport (MdiCubeViewport *cvp)
 Sets the current viewport to the given cvp.

Signals

void clearWarningSignal ()
void toolActivated ()
void viewportChanged ()

Public Member Functions

 TrackTool (QStatusBar *parent)
 TrackTool constructor.
void displayWarning (std::string &pStr, const std::string &pExStr)
 Display the Warning icon in case of an exception, sent from the tool where the exception occured.
void resetStatusWarning (void)
 Resets the warning status on the status bar to default.
QStatusBar * getStatusBar (void)
void addTo (ViewportMainWindow *mw)
 Adds the tool to the application.
void addTo (ToolPad *toolpad)
 Adds the tool to the toolpad.
virtual void addTo (QMenu *menu)
 requires the programmer to have this member
virtual void addTo (Workspace *ws)
 requires the programmer to have this member
virtual void addToPermanent (QToolBar *toolbar)
 requires the programmer to have this member
void addToActive (QToolBar *toolbar)
QString toolIconDir () const
 returns the path to the icon directory.
virtual void paintViewport (MdiCubeViewport *vp, QPainter *painter)
 requires the programmer to have this member

Protected Types

typedef QVector
< MdiCubeViewport * > 		CubeViewportList
 A list of cubeviewports.

Protected Slots

virtual void rubberBandComplete ()
virtual void screenPixelsChanged ()
 This is called when actions change which pixels from the cube are displayed.
virtual void mouseEnter ()
virtual void mouseMove (QPoint p, Qt::MouseButton)
virtual void mouseDoubleClick (QPoint p)
virtual void mouseButtonPress (QPoint p, Qt::MouseButton s)
virtual void mouseButtonRelease (QPoint p, Qt::MouseButton s)
 Resets the Warning to Nowarning when a different activity occurs on the application.
virtual void updateMeasure ()
virtual void scaleChanged ()
virtual void stretchRequested (MdiCubeViewport *, int)
void registerTool (MdiCubeViewport *viewport)
 Registers the tool to the viewport.

Protected Member Functions

void addConnections (MdiCubeViewport *cvp)
 Adds the connections to the given viewport.
void removeConnections (MdiCubeViewport *cvp)
 Removes the connections from the given viewport.
MdiCubeViewport * cubeViewport () const
 Return the current cubeviewport.
CubeViewportList * cubeViewportList () const
 Return the list of cubeviewports.
virtual QAction * toolPadAction (ToolPad *toolpad)
 Anytime a tool is created, you must setup a tool pad action with it.
virtual QString menuName () const
 Anytime a tool is created, you must give it a name for the menu.
virtual QWidget * createToolBarWidget (QStackedWidget *parent)
 Anytime a tool is created, you must add it to the tool bar.
virtual void enableRubberBandTool ()
 Anytime a tool is created, you may use the rubber band tool.

Protected Attributes

MdiCubeViewport * p_cvp
 current cubeviewport
Workspace * p_workspace

Detailed Description

This tool is part of the Qisis namespace and displays the statusbar of the window.

The status bar tracks the line, sample, lat ,lon and pixel values. Also displays Warning status for any application activity.

Author:
????-??-?? Unknown

Member Typedef Documentation

typedef QVector< MdiCubeViewport * > Isis::Tool::CubeViewportList [protected, inherited]

A list of cubeviewports.

Constructor & Destructor Documentation

Isis::TrackTool::TrackTool ( QStatusBar *  parent  ) 

TrackTool constructor.

Parameters:
parent 

References Isis::Tool::activate().

Member Function Documentation

void Tool::activate ( bool  on  )  [slot, inherited]

Activates the tool.

Parameters:
on 

References Isis::Tool::clearWarningSignal(), and Isis::Tool::toolActivated().

Referenced by Isis::Tool::addTo(), Isis::AdvancedTrackTool::AdvancedTrackTool(), Isis::RubberBandTool::disableBanding(), Isis::RubberBandTool::enableBanding(), Isis::AdvancedTrackTool::eventFilter(), Isis::FileTool::FileTool(), TrackTool(), and Isis::WindowTool::WindowTool().

void Isis::TrackTool::addConnections ( MdiCubeViewport *  cvp  )  [protected, virtual]

Adds the connections to the given viewport.

Parameters:
cvp 

Reimplemented from Isis::Tool.

References Isis::Tool::cubeViewport().

void Tool::addTo ( Workspace *  ws  )  [virtual, inherited]

requires the programmer to have this member

Adds the given workspace to the cubeviewport list.

Parameters:
ws 

Reimplemented in Isis::EditTool, Isis::FileTool, Isis::SpecialPixelTool, and Isis::WindowTool.

References Isis::Tool::p_workspace, Isis::Tool::registerTool(), and Isis::Tool::setCubeViewport().

virtual void Isis::Tool::addTo ( QMenu *  menu  )  [inline, virtual, inherited]

requires the programmer to have this member

Parameters:
menu 

Reimplemented in Isis::AdvancedTrackTool, Isis::BlinkTool, Isis::FeatureNomenclatureTool, Isis::FileTool, Isis::FindTool, Isis::HelpTool, Isis::MeasureTool, Isis::PanTool, Isis::SpecialPixelTool, Isis::SpectralPlotTool, Isis::StretchTool, Isis::SunShadowTool, Isis::WindowTool, and Isis::ZoomTool.

void Tool::addTo ( ToolPad *  toolpad  )  [inherited]

Adds the tool to the toolpad.

Parameters:
toolpad 

References Isis::Tool::activate(), Isis::ToolPad::addAction(), and Isis::Tool::toolPadAction().

void Tool::addTo ( ViewportMainWindow *  pViewPortMnWin  )  [inherited]

Adds the tool to the application.

Parameters:
pViewPortMnWin 

References Isis::ViewportMainWindow::activeToolBar(), Isis::Tool::addToActive(), Isis::Tool::addToPermanent(), Isis::ViewportMainWindow::getMenu(), Isis::Tool::menuName(), Isis::ViewportMainWindow::permanentToolBar(), Isis::ViewportMainWindow::toolPad(), and Isis::ViewportMainWindow::workspace().

Referenced by Isis::ViewportMainWindow::ViewportMainWindow().

void Tool::addToActive ( QToolBar *  toolbar  )  [inherited]
Parameters:
toolbar 

References Isis::Tool::createToolBarWidget().

Referenced by Isis::Tool::addTo().

virtual void Isis::Tool::addToPermanent ( QToolBar *  toolbar  )  [inline, virtual, inherited]

requires the programmer to have this member

Parameters:
toolbar 

Reimplemented in Isis::AdvancedTrackTool, Isis::BlinkTool, Isis::FileTool, Isis::HelpTool, Isis::SpecialPixelTool, and Isis::WindowTool.

Referenced by Isis::Tool::addTo().

void Isis::Tool::clearWarningSignal (  )  [signal, inherited]

Referenced by Isis::Tool::activate(), Isis::Tool::mouseButtonPress(), Isis::Tool::mouseButtonRelease(), and Isis::Tool::mouseDoubleClick().

virtual QWidget* Isis::Tool::createToolBarWidget ( QStackedWidget *  parent  )  [inline, protected, virtual, inherited]

Anytime a tool is created, you must add it to the tool bar.

Parameters:
parent 
Returns:
QWidget*

Reimplemented in Isis::AbstractPlotTool, Isis::BandTool, Isis::EditTool, Isis::FeatureNomenclatureTool, Isis::FindTool, Isis::HistogramTool, Isis::MatchTool, Isis::MeasureTool, Isis::PanTool, Isis::ScatterPlotTool, Isis::SpatialPlotTool, Isis::SpectralPlotTool, Isis::StatisticsTool, Isis::StereoTool, Isis::StretchTool, Isis::SunShadowTool, and Isis::ZoomTool.

Referenced by Isis::Tool::addToActive().

MdiCubeViewport* Isis::Tool::cubeViewport (  )  const [inline, protected, inherited]

Return the current cubeviewport.

Returns:
CubeViewport*

References Isis::Tool::p_cvp.

Referenced by Isis::WindowTool::addConnections(), addConnections(), Isis::FileTool::discard(), Isis::FileTool::exportView(), Isis::SunShadowTool::mouseButtonPress(), Isis::StretchTool::mouseButtonRelease(), Isis::RubberBandTool::mouseButtonRelease(), Isis::PanTool::mouseButtonRelease(), Isis::MatchTool::mouseButtonRelease(), Isis::FindTool::mouseButtonRelease(), Isis::FeatureNomenclatureTool::mouseButtonRelease(), Isis::EditTool::mouseButtonRelease(), Isis::AdvancedTrackTool::mouseLeave(), mouseMove(), Isis::SunShadowTool::mouseMove(), Isis::ScatterPlotTool::mouseMove(), Isis::RubberBandTool::mouseMove(), Isis::SunShadowTool::paintViewport(), Isis::RubberBandTool::paintViewport(), Isis::FindTool::paintViewport(), Isis::FileTool::print(), Isis::SpectralPlotTool::refreshPlot(), Isis::SpatialPlotTool::refreshPlot(), Isis::HistogramTool::refreshPlot(), Isis::WindowTool::removeConnections(), removeConnections(), Isis::ZoomTool::rubberBandComplete(), Isis::StretchTool::rubberBandComplete(), Isis::StereoTool::rubberBandComplete(), Isis::HistogramTool::rubberBandComplete(), Isis::EditTool::rubberBandComplete(), Isis::FileTool::save(), Isis::FileTool::saveAs(), Isis::FileTool::saveAsCubeByOption(), Isis::FileTool::saveInfo(), Isis::ScatterPlotTool::showNewScatterPlotConfig(), Isis::StretchTool::stretchGlobal(), Isis::StretchTool::stretchGlobalAllBands(), Isis::StretchTool::stretchRegional(), Isis::StretchTool::updateAdvStretchDialogforAll(), Isis::StretchTool::updateHistograms(), Isis::MeasureTool::updateMeasure(), Isis::ZoomTool::updateTool(), Isis::WindowTool::updateTool(), Isis::SunShadowTool::updateTool(), Isis::StretchTool::updateTool(), Isis::SpecialPixelTool::updateTool(), Isis::FindTool::updateTool(), Isis::FileTool::updateTool(), Isis::EditTool::updateTool(), Isis::BlinkTool::updateTool(), Isis::BandTool::updateTool(), Isis::AbstractPlotTool::updateTool(), and Isis::AbstractPlotTool::viewportsToPlot().

Tool::CubeViewportList * Tool::cubeViewportList (  )  const [protected, inherited]

Return the list of cubeviewports.

Returns:
CubeViewportList*

References Isis::Workspace::cubeViewportList(), and Isis::Tool::p_workspace.

Referenced by Isis::FileTool::closeAll(), Isis::MatchTool::createPoint(), Isis::BlinkTool::eventFilter(), Isis::RubberBandTool::mouseButtonRelease(), Isis::PanTool::mouseButtonRelease(), Isis::RubberBandTool::mouseMove(), Isis::ScatterPlotTool::repaintViewports(), Isis::AbstractPlotTool::repaintViewports(), Isis::ZoomTool::rubberBandComplete(), Isis::FeatureNomenclatureTool::setFontColor(), Isis::FeatureNomenclatureTool::setFontSize(), Isis::FeatureNomenclatureTool::setShowApprovedOnly(), Isis::FeatureNomenclatureTool::setVectorType(), Isis::StretchTool::stretchGlobalAllViewports(), Isis::MeasureTool::updateMeasure(), Isis::WindowTool::updateTool(), Isis::FindTool::updateTool(), Isis::BlinkTool::updateTool(), and Isis::AbstractPlotTool::viewportsToPlot().

void Isis::TrackTool::displayWarning ( std::string &  pStr,
const std::string &  pExStr 
)

Display the Warning icon in case of an exception, sent from the tool where the exception occured.

Parameters:
pStr - Topmost Exception Message String
pExStr - Propagated exception message string

References Isis::WarningWidget::viewWarningWidgetIcon().

Referenced by Isis::ViewportMainWindow::displayWarning().

void Tool::enableRubberBandTool (  )  [protected, virtual, inherited]

Anytime a tool is created, you may use the rubber band tool.

Enable the use of the rubberband tool.

Reimplemented in Isis::EditTool, Isis::HistogramTool, Isis::MeasureTool, Isis::RubberBandTool, Isis::SpatialPlotTool, Isis::SpectralPlotTool, Isis::StereoTool, Isis::StretchTool, and Isis::ZoomTool.

References Isis::RubberBandTool::disable().

QStatusBar * Isis::TrackTool::getStatusBar ( void   ) 
virtual QString Isis::Tool::menuName (  )  const [inline, protected, virtual, inherited]

Anytime a tool is created, you must give it a name for the menu.

Returns:
QString

Reimplemented in Isis::AdvancedTrackTool, Isis::BandTool, Isis::BlinkTool, Isis::FeatureNomenclatureTool, Isis::FileTool, Isis::FindTool, Isis::HelpTool, Isis::MeasureTool, Isis::PanTool, Isis::SpecialPixelTool, Isis::StretchTool, Isis::WindowTool, and Isis::ZoomTool.

Referenced by Isis::Tool::addTo().

void Tool::mouseButtonPress ( QPoint  p,
Qt::MouseButton  s 
) [protected, virtual, slot, inherited]
Parameters:
p 
s 

Reimplemented in Isis::PanTool, Isis::RubberBandTool, and Isis::SunShadowTool.

References Isis::Tool::clearWarningSignal().

void Tool::mouseButtonRelease ( QPoint  p,
Qt::MouseButton  s 
) [protected, virtual, slot, inherited]

Resets the Warning to Nowarning when a different activity occurs on the application.

This is called by all the mouseButtonRelease events in all the tools.

Parameters:
p 
s 

Reimplemented in Isis::EditTool, Isis::FeatureNomenclatureTool, Isis::FindTool, Isis::MatchTool, Isis::PanTool, Isis::RubberBandTool, Isis::StatisticsTool, Isis::StretchTool, and Isis::SunShadowTool.

References Isis::Tool::clearWarningSignal().

void Tool::mouseDoubleClick ( QPoint  p  )  [protected, virtual, slot, inherited]
Parameters:
p 

Reimplemented in Isis::RubberBandTool.

References Isis::Tool::clearWarningSignal().

virtual void Isis::Tool::mouseEnter (  )  [inline, protected, virtual, slot, inherited]
void Isis::TrackTool::mouseLeave (  )  [virtual, slot]

Clears the labels if the mouse leaves the application.

Reimplemented from Isis::Tool.

virtual void Isis::Tool::mouseMove ( QPoint  p,
Qt::MouseButton   
) [inline, protected, virtual, slot, inherited]

Reimplemented in Isis::RubberBandTool, and Isis::ScatterPlotTool.

void Isis::TrackTool::mouseMove ( QPoint  p  )  [virtual, slot]

Updates the labels anytime the mouse moves.

Parameters:
p 

Reimplemented from Isis::Tool.

References Isis::Tool::cubeViewport().

virtual void Isis::Tool::paintViewport ( MdiCubeViewport *  vp,
QPainter *  painter 
) [inline, virtual, inherited]

requires the programmer to have this member

Parameters:
vp 
painter 

Reimplemented in Isis::AbstractPlotTool, Isis::FeatureNomenclatureTool, Isis::FindTool, Isis::MatchTool, Isis::RubberBandTool, Isis::ScatterPlotTool, Isis::StereoTool, and Isis::SunShadowTool.

void Tool::registerTool ( MdiCubeViewport *  viewport  )  [protected, slot, inherited]

Registers the tool to the viewport.

Parameters:
viewport 

References Isis::Tool::p_cvp, Isis::MdiCubeViewport::registerTool(), and Isis::Tool::stretchRequested().

Referenced by Isis::Tool::addTo().

void Isis::TrackTool::removeConnections ( MdiCubeViewport *  cvp  )  [protected, virtual]

Removes the connections from the given viewport.

Parameters:
cvp 

Reimplemented from Isis::Tool.

References Isis::Tool::cubeViewport().

void Isis::TrackTool::resetStatusWarning ( void   ) 

Resets the warning status on the status bar to default.

References Isis::WarningWidget::resetWarning().

Referenced by Isis::ViewportMainWindow::resetWarning().

virtual void Isis::Tool::rubberBandComplete (  )  [inline, protected, virtual, slot, inherited]

Reimplemented in Isis::EditTool, Isis::HistogramTool, Isis::MeasureTool, Isis::SpatialPlotTool, Isis::SpectralPlotTool, Isis::StereoTool, Isis::StretchTool, and Isis::ZoomTool.

virtual void Isis::Tool::scaleChanged (  )  [inline, protected, virtual, slot, inherited]

Reimplemented in Isis::RubberBandTool.

virtual void Isis::Tool::screenPixelsChanged (  )  [inline, protected, virtual, slot, inherited]

This is called when actions change which pixels from the cube are displayed.

Reimplemented in Isis::StretchTool.

void Tool::setCubeViewport ( MdiCubeViewport *  cvp  )  [slot, inherited]

Sets the current viewport to the given cvp.

Parameters:
cvp 

References Isis::Tool::p_cvp, Isis::Tool::updateTool(), and Isis::Tool::viewportChanged().

Referenced by Isis::Tool::addTo(), and Isis::FileTool::closeAll().

virtual void Isis::Tool::stretchRequested ( MdiCubeViewport *  ,
int   
) [inline, protected, virtual, slot, inherited]

Reimplemented in Isis::StretchTool.

Referenced by Isis::Tool::registerTool().

void Isis::Tool::toolActivated (  )  [signal, inherited]

Referenced by Isis::Tool::activate(), Isis::FeatureNomenclatureTool::FeatureNomenclatureTool(), Isis::MatchTool::MatchTool(), and Isis::StereoTool::StereoTool().

QString Isis::Tool::toolIconDir (  )  const [inline, inherited]

returns the path to the icon directory.

Returns:
QString

Referenced by Isis::AdvancedTrackTool::AdvancedTrackTool(), Isis::BlinkTool::BlinkTool(), Isis::ZoomTool::createToolBarWidget(), Isis::StretchTool::createToolBarWidget(), Isis::StereoTool::createToolBarWidget(), Isis::PanTool::createToolBarWidget(), Isis::MatchTool::createToolBarWidget(), Isis::FindTool::createToolBarWidget(), Isis::EditTool::createToolBarWidget(), Isis::BandTool::createToolBarWidget(), Isis::FileTool::FileTool(), Isis::FindTool::FindTool(), Isis::HelpTool::HelpTool(), Isis::HistogramTool::HistogramTool(), Isis::PanTool::PanTool(), Isis::SpatialPlotTool::SpatialPlotTool(), Isis::SpecialPixelTool::SpecialPixelTool(), Isis::SpectralPlotTool::SpectralPlotTool(), Isis::RubberBandComboBox::toolIconDir(), Isis::ZoomTool::toolPadAction(), Isis::SunShadowTool::toolPadAction(), Isis::StretchTool::toolPadAction(), Isis::StereoTool::toolPadAction(), Isis::StatisticsTool::toolPadAction(), Isis::ScatterPlotTool::toolPadAction(), Isis::PanTool::toolPadAction(), Isis::MeasureTool::toolPadAction(), Isis::MatchTool::toolPadAction(), Isis::HistogramTool::toolPadAction(), Isis::FindTool::toolPadAction(), Isis::FeatureNomenclatureTool::toolPadAction(), Isis::EditTool::toolPadAction(), Isis::BandTool::toolPadAction(), Isis::WindowTool::WindowTool(), and Isis::ZoomTool::ZoomTool().

virtual QAction* Isis::Tool::toolPadAction ( ToolPad *  toolpad  )  [inline, protected, virtual, inherited]

Anytime a tool is created, you must setup a tool pad action with it.

Parameters:
toolpad 
Returns:
QAction*

Reimplemented in Isis::BandTool, Isis::EditTool, Isis::FeatureNomenclatureTool, Isis::FindTool, Isis::HistogramTool, Isis::MatchTool, Isis::MeasureTool, Isis::PanTool, Isis::ScatterPlotTool, Isis::SpatialPlotTool, Isis::SpectralPlotTool, Isis::StatisticsTool, Isis::StereoTool, Isis::StretchTool, Isis::SunShadowTool, and Isis::ZoomTool.

Referenced by Isis::Tool::addTo().

virtual void Isis::Tool::updateMeasure (  )  [inline, protected, virtual, slot, inherited]

Reimplemented in Isis::MeasureTool.

void Tool::updateTool (  )  [virtual, slot, inherited]

Updates the tool.

Reimplemented in Isis::AbstractPlotTool, Isis::BandTool, Isis::BlinkTool, Isis::EditTool, Isis::FeatureNomenclatureTool, Isis::FileTool, Isis::FindTool, Isis::HistogramTool, Isis::MeasureTool, Isis::SpatialPlotTool, Isis::SpecialPixelTool, Isis::SpectralPlotTool, Isis::StretchTool, Isis::SunShadowTool, Isis::WindowTool, and Isis::ZoomTool.

Referenced by Isis::Tool::setCubeViewport().

void Isis::Tool::viewportChanged (  )  [signal, inherited]

Referenced by Isis::Tool::setCubeViewport(), Isis::SpatialPlotTool::SpatialPlotTool(), Isis::SpectralPlotTool::SpectralPlotTool(), and Isis::SunShadowTool::SunShadowTool().

Member Data Documentation

MdiCubeViewport* Isis::Tool::p_cvp [protected, inherited]

current cubeviewport

Referenced by Isis::Tool::cubeViewport(), Isis::Tool::registerTool(), Isis::MeasureTool::rubberBandComplete(), Isis::Tool::setCubeViewport(), and Isis::Tool::Tool().

Workspace* Isis::Tool::p_workspace [protected, inherited]

Referenced by Isis::Tool::addTo(), Isis::Tool::cubeViewportList(), Isis::ScatterPlotTool::showNewScatterPlotConfig(), and Isis::Tool::Tool().

The documentation for this class was generated from the following files: