USGS

Isis 3.0 Object Programmers' Reference

 Home

Isis::PanTool Class Reference

#include <PanTool.h>

Inheritance diagram for Isis::PanTool:
Inheritance graph
[legend]
Collaboration diagram for Isis::PanTool:
Collaboration graph
[legend]

List of all members.

Public Slots

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

 PanTool (QWidget *parent)
void addTo (QMenu *)
 requires the programmer to have this member
void addTo (ViewportMainWindow *mw)
 Adds the tool to the application.
void addTo (ToolPad *toolpad)
 Adds the tool to the toolpad.
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

void mouseButtonPress (QPoint p, Qt::MouseButton s)
void mouseMove (QPoint p)
void mouseButtonRelease (QPoint p, Qt::MouseButton s)
 Resets the Warning to Nowarning when a different activity occurs on the application.
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 mouseLeave ()
virtual void mouseDoubleClick (QPoint p)
virtual void updateMeasure ()
virtual void scaleChanged ()
virtual void stretchRequested (MdiCubeViewport *, int)
void registerTool (MdiCubeViewport *viewport)
 Registers the tool to the viewport.

Protected Member Functions

QString menuName () const
 Anytime a tool is created, you must give it a name for the menu.
QAction * toolPadAction (ToolPad *pad)
 Anytime a tool is created, you must setup a tool pad action with it.
QWidget * createToolBarWidget (QStackedWidget *parent)
 Anytime a tool is created, you must add it to the tool bar.
MdiCubeViewport * cubeViewport () const
 Return the current cubeviewport.
CubeViewportList * cubeViewportList () const
 Return the list of cubeviewports.
virtual void addConnections (MdiCubeViewport *cvp)
 Anytime a tool is created, you must add the connections for it.
virtual void removeConnections (MdiCubeViewport *cvp)
 Anytime a tool is created, you must be able to remove it's connections.
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

Private Slots

void panRight ()
void panLeft ()
void panUp ()
void panDown ()
void setCustom ()
void updateLineEdit ()
void writeSettings ()
void readSettings ()

Private Member Functions

void pan (int x, int y)
int panRate (bool horz)

Private Attributes

QAction * p_panRight
QAction * p_panLeft
QAction * p_panUp
QAction * p_panDown
QComboBox * p_panRateBox
QLineEdit * p_lineEdit
bool p_dragPan
QPoint p_lastPoint

Detailed Description

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

For internal use only.

History:
2010-06-26 Eric Hyer - Now uses MdiCubeViewport
  • Fixed multiple include problems

Definition at line 18 of file PanTool.h.

Member Typedef Documentation

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

A list of cubeviewports.

Definition at line 207 of file Tool.h.

Member Function Documentation

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

Activates the tool.

Parameters:
on 

Definition at line 110 of file Tool.cpp.

References Isis::Tool::addViewportConnections(), Isis::Tool::disableToolBar(), Isis::Tool::enableToolBar(), Isis::Tool::p_active, Isis::Tool::p_toolPadAction, and Isis::Tool::removeViewportConnections().

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

virtual void Isis::Tool::addConnections ( MdiCubeViewport *  cvp  )  [inline, protected, virtual, inherited]

Anytime a tool is created, you must add the connections for it.

Parameters:
cvp 

Reimplemented in Isis::TrackTool, and Isis::WindowTool.

Definition at line 258 of file Tool.h.

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

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.

Definition at line 41 of file Tool.cpp.

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

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

Adds the tool to the toolpad.

Parameters:
toolpad 

Definition at line 77 of file Tool.cpp.

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

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

Adds the tool to the application.

Parameters:
pViewPortMnWin 

Definition at line 57 of file Tool.cpp.

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 Isis::PanTool::addTo ( QMenu *  menu  )  [virtual]

requires the programmer to have this member

Parameters:
menu 

Reimplemented from Isis::Tool.

Definition at line 58 of file PanTool.cpp.

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

Definition at line 91 of file Tool.cpp.

References Isis::Tool::createToolBarWidget(), Isis::Tool::disableToolBar(), Isis::Tool::p_activeToolBarStack, and Isis::Tool::p_toolBarWidget.

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.

Definition at line 103 of file Tool.h.

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

QWidget * Isis::PanTool::createToolBarWidget ( QStackedWidget *  parent  )  [protected, virtual]

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

Parameters:
parent 
Returns:
QWidget*

Reimplemented from Isis::Tool.

Definition at line 65 of file PanTool.cpp.

References Isis::Tool::toolIconDir().

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

Return the current cubeviewport.

Returns:
CubeViewport*

Definition at line 205 of file Tool.h.

References Isis::Tool::p_cvp.

Referenced by Isis::WindowTool::addConnections(), Isis::TrackTool::addConnections(), Isis::StretchTool::advancedStretchChanged(), Isis::FindTool::centerLinkedViewports(), Isis::StretchTool::changeStretch(), Isis::BandTool::changeView(), Isis::BandTool::copyLinkedViewports(), Isis::FileTool::discard(), Isis::Tool::enableToolBar(), Isis::FileTool::exportView(), Isis::StatisticsTool::getStatistics(), Isis::FindTool::handleRecordClicked(), Isis::EditTool::LineToPoints(), Isis::TrackTool::locateCursor(), Isis::SunShadowTool::mouseButtonPress(), Isis::StretchTool::mouseButtonRelease(), Isis::RubberBandTool::mouseButtonRelease(), mouseButtonRelease(), Isis::MatchTool::mouseButtonRelease(), Isis::FindTool::mouseButtonRelease(), Isis::FeatureNomenclatureTool::mouseButtonRelease(), Isis::EditTool::mouseButtonRelease(), Isis::AdvancedTrackTool::mouseLeave(), Isis::TrackTool::mouseMove(), Isis::SunShadowTool::mouseMove(), Isis::ScatterPlotTool::mouseMove(), Isis::RubberBandTool::mouseMove(), Isis::SunShadowTool::paintViewport(), Isis::RubberBandTool::paintViewport(), Isis::FindTool::paintViewport(), Isis::FileTool::print(), Isis::SunShadowTool::recalculateShadowHeight(), Isis::EditTool::redoEdit(), Isis::FindTool::refresh(), Isis::SpectralPlotTool::refreshPlot(), Isis::SpatialPlotTool::refreshPlot(), Isis::HistogramTool::refreshPlot(), Isis::WindowTool::removeConnections(), Isis::TrackTool::removeConnections(), Isis::WindowTool::resizeWindows(), Isis::ZoomTool::rubberBandComplete(), Isis::StretchTool::rubberBandComplete(), Isis::HistogramTool::rubberBandComplete(), Isis::EditTool::rubberBandComplete(), Isis::FileTool::save(), Isis::FileTool::saveAs(), Isis::FileTool::saveAsCubeByOption(), Isis::FileTool::saveAsReducedCube(), Isis::FileTool::saveInfo(), Isis::StretchTool::setStretchAcrossBands(), Isis::StretchTool::setStretchAllViewports(), Isis::StretchTool::showAdvancedDialog(), Isis::ScatterPlotTool::showNewScatterPlotConfig(), Isis::StretchTool::stretchChanged(), Isis::StretchTool::stretchGlobal(), Isis::StretchTool::stretchGlobalAllBands(), Isis::StretchTool::stretchRegional(), Isis::EditTool::undoEdit(), Isis::StretchTool::updateAdvStretchDialogforAll(), Isis::StretchTool::updateHistograms(), Isis::TrackTool::updateLabels(), Isis::MeasureTool::updateMeasure(), Isis::AdvancedTrackTool::updateRow(), 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(), Isis::AbstractPlotTool::viewportsToPlot(), Isis::EditTool::writeToCube(), Isis::ZoomTool::zoomBy(), Isis::ZoomTool::zoomFit(), Isis::ZoomTool::zoomFitHeight(), Isis::ZoomTool::zoomFitWidth(), and Isis::ZoomTool::zoomManual().

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

Return the list of cubeviewports.

Returns:
CubeViewportList*

Definition at line 357 of file Tool.cpp.

References Isis::Workspace::cubeViewportList().

Referenced by Isis::BlinkTool::advance(), Isis::SpecialPixelTool::apply(), Isis::FindTool::centerLinkedViewports(), Isis::WindowTool::changeCursor(), Isis::FileTool::closeAll(), Isis::BandTool::copyAllViewports(), Isis::BandTool::copyLinkedViewports(), Isis::MatchTool::createPoint(), Isis::BlinkTool::eventFilter(), Isis::FeatureNomenclatureTool::featuresIdentified(), Isis::FeatureNomenclatureTool::findMissingNomenclature(), Isis::FeatureNomenclatureTool::findNomenclatureStateChanged(), Isis::FindTool::handleLinkClicked(), Isis::WindowTool::linkWindows(), Isis::RubberBandTool::mouseButtonRelease(), mouseButtonRelease(), Isis::RubberBandTool::mouseMove(), Isis::StereoTool::paintAllViewports(), Isis::MatchTool::paintAllViewports(), Isis::FindTool::refresh(), Isis::ScatterPlotTool::repaintViewports(), Isis::AbstractPlotTool::repaintViewports(), Isis::WindowTool::resizeWindows(), Isis::BlinkTool::reverse(), Isis::ZoomTool::rubberBandComplete(), Isis::MatchTool::serialNumberList(), Isis::FeatureNomenclatureTool::setFontColor(), Isis::FeatureNomenclatureTool::setFontSize(), Isis::FeatureNomenclatureTool::setShowApprovedOnly(), Isis::StretchTool::setStretchAllViewports(), Isis::FeatureNomenclatureTool::setVectorType(), Isis::StretchTool::stretchGlobalAllViewports(), Isis::BlinkTool::toggleLink(), Isis::WindowTool::unlinkWindows(), Isis::MeasureTool::updateMeasure(), Isis::AdvancedTrackTool::updateRow(), Isis::WindowTool::updateTool(), Isis::FindTool::updateTool(), Isis::BlinkTool::updateTool(), Isis::AbstractPlotTool::viewportsToPlot(), Isis::ZoomTool::zoomBy(), Isis::ZoomTool::zoomFit(), Isis::ZoomTool::zoomFitHeight(), Isis::ZoomTool::zoomFitWidth(), and Isis::ZoomTool::zoomManual().

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.

Definition at line 311 of file Tool.cpp.

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

QString Isis::PanTool::menuName (  )  const [inline, protected, virtual]

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

Returns:
QString

Reimplemented from Isis::Tool.

Definition at line 26 of file PanTool.h.

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

Reimplemented from Isis::Tool.

Definition at line 207 of file PanTool.cpp.

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

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 from Isis::Tool.

Definition at line 222 of file PanTool.cpp.

References Isis::CubeViewport::center(), Isis::Tool::cubeViewport(), Isis::Tool::cubeViewportList(), Isis::MdiCubeViewport::isLinked(), and Isis::CubeViewport::viewportToCube().

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

Reimplemented in Isis::RubberBandTool.

Definition at line 325 of file Tool.cpp.

Referenced by Isis::Tool::addViewportConnections(), and Isis::Tool::removeViewportConnections().

void Isis::PanTool::mouseMove ( QPoint  p  )  [protected, virtual, slot]
Parameters:
p 

Reimplemented from Isis::Tool.

Definition at line 214 of file PanTool.cpp.

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.

Definition at line 132 of file Tool.h.

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

Registers the tool to the viewport.

Parameters:
viewport 

Definition at line 299 of file Tool.cpp.

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

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

virtual void Isis::Tool::removeConnections ( MdiCubeViewport *  cvp  )  [inline, protected, virtual, inherited]

Anytime a tool is created, you must be able to remove it's connections.

Parameters:
cvp 

Reimplemented in Isis::MeasureTool, Isis::TrackTool, and Isis::WindowTool.

Definition at line 266 of file Tool.h.

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

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.

Definition at line 156 of file Tool.h.

Referenced by Isis::Tool::addViewportConnections(), Isis::Tool::removeViewportConnections(), and Isis::FeatureNomenclatureTool::viewportDone().

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

Sets the current viewport to the given cvp.

Parameters:
cvp 

Definition at line 139 of file Tool.cpp.

References Isis::Tool::addViewportConnections(), Isis::Tool::enableToolBar(), Isis::Tool::p_active, Isis::Tool::p_cvp, Isis::Tool::removeViewportConnections(), and Isis::Tool::updateTool().

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

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

returns the path to the icon directory.

Returns:
QString

Definition at line 121 of file Tool.h.

References Isis::Tool::p_toolIconDir.

Referenced by Isis::AdvancedTrackTool::AdvancedTrackTool(), Isis::BlinkTool::BlinkTool(), Isis::StereoTool::createMenus(), Isis::ZoomTool::createToolBarWidget(), Isis::StretchTool::createToolBarWidget(), Isis::StereoTool::createToolBarWidget(), createToolBarWidget(), Isis::MatchTool::createToolBarWidget(), Isis::FindTool::createToolBarWidget(), Isis::EditTool::createToolBarWidget(), Isis::BandTool::createToolBarWidget(), Isis::FileTool::FileTool(), Isis::FindTool::FindTool(), Isis::HistogramTool::HistogramTool(), 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(), 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().

QAction * Isis::PanTool::toolPadAction ( ToolPad *  toolpad  )  [protected, virtual]

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

Parameters:
toolpad 
Returns:
QAction*

Reimplemented from Isis::Tool.

Definition at line 46 of file PanTool.cpp.

References Isis::Tool::toolIconDir().

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.

Definition at line 290 of file Tool.cpp.

Referenced by Isis::Tool::enableToolBar(), and Isis::Tool::setCubeViewport().

Member Data Documentation

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

current cubeviewport

Definition at line 272 of file Tool.h.

Referenced by Isis::Tool::addViewportConnections(), Isis::Tool::cubeViewport(), Isis::Tool::registerTool(), Isis::Tool::removeViewportConnections(), Isis::RubberBandTool::repaint(), Isis::MeasureTool::rubberBandComplete(), Isis::Tool::setCubeViewport(), and Isis::Tool::Tool().

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