Isis 3 Programmer Reference
Public Slots | Signals | Public Member Functions | Protected Types | Protected Slots | Protected Member Functions | Static Protected Member Functions | Private Slots | Private Attributes | List of all members
Isis::AbstractPlotTool Class Referenceabstract

Parent class for plotting tools which provides common functionality. More...

#include <AbstractPlotTool.h>

Inheritance diagram for Isis::AbstractPlotTool:
Inheritance graph
Collaboration diagram for Isis::AbstractPlotTool:
Collaboration graph

Public Slots

void removeWindow (QObject *)
 When a user closes a window, we want to remove that window from our combo box for selecting the active window. More...
 
void repaintViewports (CubePlotCurve *)
 This method causes the viewports corresponding with the given CubePlotCurve to be repainted with all of the area's of interest associated with the CubePlotCurve's PlotWindow. More...
 
void showPlotWindow ()
 displays the plot window More...
 
void activate (bool)
 Activates the tool. More...
 
void setCubeViewport (MdiCubeViewport *cvp)
 Sets the current viewport to the given cvp. More...
 

Signals

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

Public Member Functions

 AbstractPlotTool (QWidget *parent)
 When you construct a plot tool, this initializes the common functionality between plot tools. More...
 
virtual ~AbstractPlotTool ()
 Clean up the abstract plot tool. More...
 
virtual void paintViewport (MdiCubeViewport *vp, QPainter *painter)
 This method allows each plot window to paint any information it wants onto the cube viewports. More...
 
void addTo (ViewportMainWindow *mw)
 Adds the tool to the application. More...
 
void addTo (ToolPad *toolpad)
 Adds the tool to the toolpad. More...
 
virtual void addTo (QMenu *menu)
 
virtual void addTo (Workspace *ws)
 Adds the given workspace to the cubeviewport list. More...
 
virtual QString menuName () const
 Anytime a tool is created, you must give it a name for the menu. More...
 
virtual void addToPermanent (QToolBar *toolbar)
 
void addToActive (QToolBar *toolbar)
 
QString toolIconDir () const
 returns the path to the icon directory. More...
 
RubberBandTool * rubberBandTool ()
 
void setList (ToolList *currentList)
 

Protected Types

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

Protected Slots

void repaintViewports ()
 This method causes all of the viewports to be repainted. More...
 
virtual void rubberBandComplete ()
 
virtual void screenPixelsChanged ()
 This is called when actions change which pixels from the cube are displayed. More...
 
virtual void mouseEnter ()
 
virtual void mouseMove (QPoint p)
 
virtual void mouseMove (QPoint p, Qt::MouseButton)
 
virtual void mouseLeave ()
 

Protected Member Functions

PlotWindow * addWindow ()
 This creates and initializes everything about a plot window. More...
 
QWidget * createToolBarWidget (QStackedWidget *parent)
 This provides the standard plot tool options, such as selecting an active plot window. More...
 
virtual PlotWindow * createWindow ()=0
 This needs to be implemented by children to instantiate a plot window of the appropriate child class of PlotWindow. More...
 
virtual void updateTool ()
 This forwards all update calls to the plot windows. More...
 
QList< MdiCubeViewport * > viewportsToPlot ()
 Get a list of linked viewports that should be plotting when a new plot is requested. More...
 
QList< PlotWindow * > plotWindows ()
 Get a list of all of the instantiated plot windows. More...
 
virtual void detachCurves ()=0
 This will be called when the selected plot window changes. More...
 
PlotWindow * selectedWindow (bool createIfNeeded=true)
 Get the 'active' plot window (the window selected by the user to contain new curves). More...
 
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. More...
 
virtual void updateMeasure ()
 
virtual void scaleChanged ()
 
virtual void stretchRequested (MdiCubeViewport *, int)
 
void registerTool (MdiCubeViewport *viewport)
 Registers the tool to the viewport. More...
 
MdiCubeViewport * cubeViewport () const
 Return the current cubeviewport. More...
 
CubeViewportList * cubeViewportList () const
 Return the list of cubeviewports. More...
 
virtual QAction * toolPadAction (ToolPad *toolpad)
 Anytime a tool is created, you must setup a tool pad action with it. More...
 
virtual void addConnections (MdiCubeViewport *cvp)
 Anytime a tool is created, you must add the connections for it. More...
 
virtual void removeConnections (MdiCubeViewport *cvp)
 Anytime a tool is created, you must be able to remove it's connections. More...
 
virtual void enableRubberBandTool ()
 Anytime a tool is created, you may use the rubber band tool. More...
 
Workspace * workspace ()
 

Static Protected Member Functions

static CubePlotCurve * createCurve (QString name, QPen pen, PlotCurve::Units xUnits, PlotCurve::Units yUnits)
 This is a helper method for children. More...
 

Private Slots

void selectedWindowChanged ()
 This method is called when the window where new curves are placed is changed by the user. More...
 

Private Attributes

QPointer< QComboBox > m_selectWindowCombo
 This allows the user to select the active plot window. More...
 

Detailed Description

Parent class for plotting tools which provides common functionality.

This qview tool is designed to be inherited from by tools which create plots. This class provides common functionality such as opening new plot windows.

Author
2012-01-18 Steven Lambright and Tracie Sucharski
History:

2012-01-20 Steven Lambright - Documentation improved.

2012-03-14 Tracie Sucharski - Update for change to the CubePlotCurve::sourceCube(), which now returns a QStringList instead of QString.

Definition at line 35 of file AbstractPlotTool.h.

Member Typedef Documentation

◆ CubeViewportList

typedef QVector< MdiCubeViewport * > Isis::Tool::CubeViewportList
protectedinherited

A list of cubeviewports.

Definition at line 219 of file Tool.h.

Constructor & Destructor Documentation

◆ AbstractPlotTool()

Isis::AbstractPlotTool::AbstractPlotTool ( QWidget *  parent)

When you construct a plot tool, this initializes the common functionality between plot tools.

For example, the select window combo box that appears when you call createToolBarWidget().

Parameters
parent

Definition at line 26 of file AbstractPlotTool.cpp.

References m_selectWindowCombo, and selectedWindowChanged().

◆ ~AbstractPlotTool()

Isis::AbstractPlotTool::~AbstractPlotTool ( )
virtual

Clean up the abstract plot tool.

This will destroy all of the plot windows.

Definition at line 46 of file AbstractPlotTool.cpp.

References m_selectWindowCombo, and selectedWindowChanged().

Member Function Documentation

◆ activate

void Isis::Tool::activate ( bool  on)
slotinherited

Activates the tool.

Parameters
on

Definition at line 131 of file Tool.cpp.

References Isis::Tool::addViewportConnections(), Isis::Tool::disableToolBar(), Isis::Tool::enableToolBar(), Isis::Tool::m_active, Isis::Tool::m_toolPadAction, and Isis::Tool::removeViewportConnections().

Referenced by Isis::Tool::addTo(), Isis::AdvancedTrackTool::AdvancedTrackTool(), Isis::RubberBandTool::disable(), Isis::RubberBandTool::enable(), Isis::AdvancedTrackTool::eventFilter(), Isis::FileTool::FileTool(), Isis::RubberBandTool::RubberBandTool(), Isis::TrackTool::TrackTool(), Isis::WindowTool::WindowTool(), and Isis::Workspace::Workspace().

◆ addConnections()

virtual void Isis::Tool::addConnections ( MdiCubeViewport *  cvp)
inlineprotectedvirtualinherited

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

Parameters
cvp

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

Definition at line 253 of file Tool.h.

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

◆ addTo() [1/4]

void Isis::Tool::addTo ( ViewportMainWindow *  pViewPortMnWin)
inherited

Adds the tool to the application.

Parameters
pViewPortMnWin

Definition at line 78 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::WindowTool::addTo(), Isis::SpecialPixelTool::addTo(), Isis::FileTool::addTo(), Isis::EditTool::addTo(), Isis::ViewportMainWindow::ViewportMainWindow(), and Isis::Workspace::Workspace().

◆ addTo() [2/4]

void Isis::Tool::addTo ( ToolPad *  toolpad)
inherited

Adds the tool to the toolpad.

Parameters
toolpad

Definition at line 98 of file Tool.cpp.

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

◆ addTo() [3/4]

virtual void Isis::Tool::addTo ( QMenu *  menu)
inlinevirtualinherited
Parameters
menu

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

Definition at line 105 of file Tool.h.

◆ addTo() [4/4]

void Isis::Tool::addTo ( Workspace *  ws)
virtualinherited

Adds the given workspace to the cubeviewport list.

Parameters
ws

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

Definition at line 45 of file Tool.cpp.

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

◆ addToActive()

void Isis::Tool::addToActive ( QToolBar *  toolbar)
inherited
Parameters
toolbar

Definition at line 112 of file Tool.cpp.

References Isis::Tool::createToolBarWidget(), Isis::Tool::disableToolBar(), and Isis::Tool::m_toolBarWidget.

Referenced by Isis::Tool::addTo(), and Isis::Workspace::Workspace().

◆ addToPermanent()

virtual void Isis::Tool::addToPermanent ( QToolBar *  toolbar)
inlinevirtualinherited
Parameters
toolbar

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

Definition at line 111 of file Tool.h.

Referenced by Isis::Tool::addTo(), and Isis::Workspace::Workspace().

◆ addWindow()

PlotWindow * Isis::AbstractPlotTool::addWindow ( )
protected

This creates and initializes everything about a plot window.

This updates the window's title to be unique, adds it to the active plot window combo box, listens for the window to be removed and selects it in the active plot window combo box. Call this if you need a new plot window.

Returns
The newly initialized plot window

Definition at line 295 of file AbstractPlotTool.cpp.

References createWindow(), m_selectWindowCombo, removeWindow(), and repaintViewports().

Referenced by Isis::SpatialPlotTool::refreshPlot(), Isis::SpectralPlotTool::refreshPlot(), selectedWindow(), and selectedWindowChanged().

◆ createCurve()

CubePlotCurve * Isis::AbstractPlotTool::createCurve ( QString  name,
QPen  pen,
PlotCurve::Units  xUnits,
PlotCurve::Units  yUnits 
)
staticprotected

This is a helper method for children.

Given a title, a color, and units a new CubePlotCurve is created.

Parameters
nameThe title of the curve to be created
penThe color & thickness of the curve
xUnitsThe units of the x-axis associated with this curve. This must match the plot window's x axis.
yUnitsThe units of the y-axis associated with this curve. This must match the plot window's y axis.
Returns
createCurve The requested plot curve

Definition at line 225 of file AbstractPlotTool.cpp.

References Isis::PlotCurve::setColor(), and Isis::PlotCurve::setPen().

Referenced by Isis::HistogramTool::validatePlotCurves(), Isis::SpatialPlotTool::validatePlotCurves(), and Isis::SpectralPlotTool::validatePlotCurves().

◆ createToolBarWidget()

QWidget * Isis::AbstractPlotTool::createToolBarWidget ( QStackedWidget *  parent)
protectedvirtual

This provides the standard plot tool options, such as selecting an active plot window.

Parameters
parentThe stacked widget which will contain ours as one of the widgets it can show.
Returns
QWidget* The widget we want the stacked widget to show when this is the active tool.

Reimplemented from Isis::Tool.

Reimplemented in Isis::StereoTool, Isis::SpatialPlotTool, Isis::SpectralPlotTool, and Isis::HistogramTool.

Definition at line 95 of file AbstractPlotTool.cpp.

References m_selectWindowCombo.

Referenced by Isis::HistogramTool::createToolBarWidget(), Isis::SpectralPlotTool::createToolBarWidget(), Isis::SpatialPlotTool::createToolBarWidget(), and Isis::StereoTool::createToolBarWidget().

◆ createWindow()

virtual PlotWindow* Isis::AbstractPlotTool::createWindow ( )
protectedpure virtual

This needs to be implemented by children to instantiate a plot window of the appropriate child class of PlotWindow.

You should set the window title, but the rest of the initialization will be handled by addWindow().

Returns
A newly instantiated, but not fully initialized, plot window.

Implemented in Isis::StereoTool, Isis::SpatialPlotTool, Isis::SpectralPlotTool, and Isis::HistogramTool.

Referenced by addWindow().

◆ cubeViewport()

MdiCubeViewport* Isis::Tool::cubeViewport ( ) const
inlineprotectedinherited

Return the current cubeviewport.

Returns
CubeViewport*

Definition at line 211 of file Tool.h.

References Isis::Tool::m_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::exportToList(), Isis::FileTool::exportView(), Isis::StatisticsTool::getStatistics(), Isis::FindTool::handleRecordClicked(), Isis::EditTool::LineToPoints(), Isis::TrackTool::locateCursor(), Isis::SunShadowTool::mouseButtonPress(), Isis::ControlNetTool::mouseButtonRelease(), Isis::RubberBandTool::mouseButtonRelease(), Isis::EditTool::mouseButtonRelease(), Isis::FeatureNomenclatureTool::mouseButtonRelease(), Isis::FindTool::mouseButtonRelease(), Isis::StretchTool::mouseButtonRelease(), Isis::MatchTool::mouseButtonRelease(), Isis::QnetTool::mouseButtonRelease(), Isis::AdvancedTrackTool::mouseLeave(), Isis::ScatterPlotTool::mouseMove(), Isis::SunShadowTool::mouseMove(), Isis::TrackTool::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::HistogramTool::refreshPlot(), Isis::SpatialPlotTool::refreshPlot(), Isis::SpectralPlotTool::refreshPlot(), Isis::WindowTool::removeConnections(), Isis::TrackTool::removeConnections(), Isis::RubberBandTool::repaint(), Isis::WindowTool::resizeWindows(), Isis::HistogramTool::rubberBandComplete(), Isis::MeasureTool::rubberBandComplete(), Isis::ZoomTool::rubberBandComplete(), Isis::EditTool::rubberBandComplete(), Isis::StretchTool::rubberBandComplete(), Isis::FileTool::save(), Isis::FileTool::saveAs(), Isis::FileTool::saveAsCubeByOption(), Isis::FileTool::saveAsReducedCube(), Isis::FileTool::saveInfo(), Isis::BandTool::setBandBin(), Isis::BandTool::setList(), 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::WindowTool::updateTool(), Isis::BlinkTool::updateTool(), Isis::SpecialPixelTool::updateTool(), Isis::BandTool::updateTool(), Isis::SunShadowTool::updateTool(), updateTool(), Isis::ZoomTool::updateTool(), Isis::FileTool::updateTool(), Isis::EditTool::updateTool(), Isis::FindTool::updateTool(), Isis::StretchTool::updateTool(), viewportsToPlot(), Isis::EditTool::writeToCube(), Isis::ZoomTool::zoomBy(), Isis::ZoomTool::zoomFit(), Isis::ZoomTool::zoomFitHeight(), Isis::ZoomTool::zoomFitWidth(), and Isis::ZoomTool::zoomManual().

◆ cubeViewportList()

Tool::CubeViewportList * Isis::Tool::cubeViewportList ( ) const
protectedinherited

Return the list of cubeviewports.

Returns
CubeViewportList*

Definition at line 390 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(), Isis::RubberBandTool::mouseMove(), Isis::QnetTool::openGround(), Isis::StereoTool::paintAllViewports(), Isis::ControlNetTool::paintAllViewports(), Isis::MatchTool::paintAllViewports(), Isis::QnetTool::paintAllViewports(), Isis::FindTool::refresh(), Isis::ScatterPlotTool::repaintViewports(), repaintViewports(), Isis::WindowTool::resizeWindows(), Isis::BlinkTool::reverse(), Isis::ZoomTool::rubberBandComplete(), Isis::MatchTool::serialNumberList(), Isis::ControlNetTool::setControlNet(), 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::BlinkTool::updateTool(), Isis::FindTool::updateTool(), viewportsToPlot(), Isis::ZoomTool::zoomBy(), Isis::ZoomTool::zoomFit(), Isis::ZoomTool::zoomFitHeight(), Isis::ZoomTool::zoomFitWidth(), and Isis::ZoomTool::zoomManual().

◆ detachCurves()

virtual void Isis::AbstractPlotTool::detachCurves ( )
protectedpure virtual

This will be called when the selected plot window changes.

The existing curves need to be detached (forgotten, but not deleted). The curves are being detached between the previously selected window and the tool.

Implemented in Isis::StereoTool, Isis::SpatialPlotTool, Isis::SpectralPlotTool, and Isis::HistogramTool.

Referenced by selectedWindowChanged().

◆ enableRubberBandTool()

void Isis::Tool::enableRubberBandTool ( )
protectedvirtualinherited

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

Enable the use of the rubberband tool.

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

Definition at line 339 of file Tool.cpp.

References Isis::RubberBandTool::disable().

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

◆ menuName()

virtual QString Isis::Tool::menuName ( ) const
inlinevirtualinherited

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

Returns
QString

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

Definition at line 97 of file Tool.h.

Referenced by Isis::Tool::addTo(), and Isis::Workspace::Workspace().

◆ mouseButtonPress()

void Isis::Tool::mouseButtonPress ( QPoint  p,
Qt::MouseButton  s 
)
protectedvirtualinherited
Parameters
p
s

Definition at line 367 of file Tool.cpp.

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

◆ mouseButtonRelease()

void Isis::Tool::mouseButtonRelease ( QPoint  p,
Qt::MouseButton  s 
)
protectedvirtualinherited

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::FeatureNomenclatureTool.

Definition at line 380 of file Tool.cpp.

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

◆ mouseDoubleClick()

void Isis::Tool::mouseDoubleClick ( QPoint  p)
protectedvirtualinherited
Parameters
p

Definition at line 358 of file Tool.cpp.

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

◆ mouseMove

void Isis::Tool::mouseMove ( QPoint  p)
protectedvirtualslotinherited
Parameters
p

Definition at line 352 of file Tool.cpp.

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

◆ paintViewport()

void Isis::AbstractPlotTool::paintViewport ( MdiCubeViewport *  vp,
QPainter *  painter 
)
virtual

This method allows each plot window to paint any information it wants onto the cube viewports.

For example, spatial plots can paint the originating selection in the color of the curve.

Parameters
vpThe viewport to paint onto
painterThe painter to use for painting

Reimplemented from Isis::Tool.

Reimplemented in Isis::StereoTool.

Definition at line 73 of file AbstractPlotTool.cpp.

References m_selectWindowCombo, and Isis::PlotWindow::paint().

Referenced by Isis::StereoTool::paintViewport().

◆ plotWindows()

QList< PlotWindow * > Isis::AbstractPlotTool::plotWindows ( )
protected

Get a list of all of the instantiated plot windows.

Returns
All of the plot windows associated with this tool

Definition at line 147 of file AbstractPlotTool.cpp.

References m_selectWindowCombo.

Referenced by updateTool().

◆ registerTool()

void Isis::Tool::registerTool ( MdiCubeViewport *  viewport)
protectedinherited

Registers the tool to the viewport.

Parameters
viewport

Definition at line 327 of file Tool.cpp.

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

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

◆ removeConnections()

virtual void Isis::Tool::removeConnections ( MdiCubeViewport *  cvp)
inlineprotectedvirtualinherited

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 261 of file Tool.h.

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

◆ removeWindow

void Isis::AbstractPlotTool::removeWindow ( QObject *  window)
slot

When a user closes a window, we want to remove that window from our combo box for selecting the active window.

We also repaint all of the cube viewports so that the destroyed window leaves no visible artifacts.

Parameters
windowThe plot window that is to be removed

Definition at line 195 of file AbstractPlotTool.cpp.

References m_selectWindowCombo, and repaintViewports().

Referenced by addWindow().

◆ repaintViewports [1/2]

void Isis::AbstractPlotTool::repaintViewports ( CubePlotCurve *  pc)
slot

This method causes the viewports corresponding with the given CubePlotCurve to be repainted with all of the area's of interest associated with the CubePlotCurve's PlotWindow.

Parameters
pcThe plot curve which needs to repaint

Definition at line 276 of file AbstractPlotTool.cpp.

References Isis::CubeViewport::cube(), Isis::Tool::cubeViewportList(), Isis::Cube::fileName(), and Isis::CubePlotCurve::sourceCube().

◆ repaintViewports [2/2]

void Isis::AbstractPlotTool::repaintViewports ( )
protectedslot

This method causes all of the viewports to be repainted.

This is useful because it removes visible artifacts from deleted plot windows/curves.

Definition at line 354 of file AbstractPlotTool.cpp.

References Isis::Tool::cubeViewportList().

Referenced by addWindow(), and removeWindow().

◆ screenPixelsChanged

virtual void Isis::Tool::screenPixelsChanged ( )
inlineprotectedvirtualslotinherited

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

Definition at line 162 of file Tool.h.

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

◆ selectedWindow()

PlotWindow * Isis::AbstractPlotTool::selectedWindow ( bool  createIfNeeded = true)
protected

Get the 'active' plot window (the window selected by the user to contain new curves).

This may return NULL if and only if createIfNeeded is false. Windows are created by child classes.

Parameters
createIfNeededIf this is true, and no window is selected in the active window combo box, then a window will be created and selected before this method returns.
Returns
The user-selected active plot window

Definition at line 248 of file AbstractPlotTool.cpp.

References addWindow(), and m_selectWindowCombo.

Referenced by Isis::HistogramTool::refreshPlot(), Isis::SpatialPlotTool::refreshPlot(), Isis::SpectralPlotTool::refreshPlot(), Isis::HistogramTool::rubberBandComplete(), Isis::SpectralPlotTool::rubberBandComplete(), Isis::SpatialPlotTool::rubberBandComplete(), selectedWindowChanged(), showPlotWindow(), Isis::HistogramTool::validatePlotCurves(), Isis::SpatialPlotTool::validatePlotCurves(), and Isis::SpectralPlotTool::validatePlotCurves().

◆ selectedWindowChanged

void Isis::AbstractPlotTool::selectedWindowChanged ( )
privateslot

This method is called when the window where new curves are placed is changed by the user.

If the current selection has no window associated with it, then one is created. Otherwise, the selected window is explicitly shown and any curves associated with an old window should be forgotten (but not deleted, see detachCurves()).

Definition at line 170 of file AbstractPlotTool.cpp.

References addWindow(), detachCurves(), m_selectWindowCombo, selectedWindow(), and Isis::PlotWindow::showWindow().

Referenced by AbstractPlotTool(), and ~AbstractPlotTool().

◆ setCubeViewport

void Isis::Tool::setCubeViewport ( MdiCubeViewport *  cvp)
slotinherited

Sets the current viewport to the given cvp.

Parameters
cvp

Definition at line 160 of file Tool.cpp.

References Isis::Tool::addViewportConnections(), Isis::Tool::enableToolBar(), Isis::Tool::m_active, Isis::Tool::m_cvp, Isis::Tool::removeViewportConnections(), and Isis::Tool::updateTool().

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

◆ showPlotWindow

void Isis::AbstractPlotTool::showPlotWindow ( )
slot

displays the plot window

Definition at line 342 of file AbstractPlotTool.cpp.

References selectedWindow(), and Isis::PlotWindow::showWindow().

◆ toolIconDir()

QString Isis::Tool::toolIconDir ( ) const
inlineinherited

returns the path to the icon directory.

Returns
QString

Definition at line 127 of file Tool.h.

References Isis::Tool::m_toolIconDir.

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

◆ toolPadAction()

virtual QAction* Isis::Tool::toolPadAction ( ToolPad *  toolpad)
inlineprotectedvirtualinherited

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

Parameters
toolpad
Returns
QAction*

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

Definition at line 231 of file Tool.h.

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

◆ updateTool()

void Isis::AbstractPlotTool::updateTool ( )
protectedvirtual

This forwards all update calls to the plot windows.

Reimplemented from Isis::Tool.

Reimplemented in Isis::SpatialPlotTool, Isis::SpectralPlotTool, and Isis::HistogramTool.

Definition at line 110 of file AbstractPlotTool.cpp.

References Isis::Tool::cubeViewport(), plotWindows(), and Isis::PlotWindow::update().

Referenced by Isis::HistogramTool::updateTool(), Isis::SpectralPlotTool::updateTool(), and Isis::SpatialPlotTool::updateTool().

◆ viewportsToPlot()

QList< MdiCubeViewport * > Isis::AbstractPlotTool::viewportsToPlot ( )
protected

Get a list of linked viewports that should be plotting when a new plot is requested.

This is a utility for child classes. For example, a spatial plot will make a curve for each viewport.

Returns
A list of viewports containing the active one and any that are linked to the active viewport.

Definition at line 125 of file AbstractPlotTool.cpp.

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

Referenced by Isis::SpatialPlotTool::refreshPlot(), Isis::SpectralPlotTool::refreshPlot(), Isis::SpectralPlotTool::updateTool(), Isis::SpatialPlotTool::updateTool(), Isis::SpatialPlotTool::validatePlotCurves(), and Isis::SpectralPlotTool::validatePlotCurves().

Member Data Documentation

◆ m_selectWindowCombo

QPointer<QComboBox> Isis::AbstractPlotTool::m_selectWindowCombo
private

This allows the user to select the active plot window.

New curves will be drawn into this window. The items in the combo box store pointers to the windows themselves so we do not need an explicit list of plot windows.

Definition at line 90 of file AbstractPlotTool.h.

Referenced by AbstractPlotTool(), addWindow(), createToolBarWidget(), paintViewport(), plotWindows(), removeWindow(), selectedWindow(), selectedWindowChanged(), and ~AbstractPlotTool().

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