Isis Developer Reference
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.
 
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.
 
void showPlotWindow ()
 displays the plot window
 
void activate (bool)
 Activates the tool.
 
void setCubeViewport (MdiCubeViewport *cvp)
 Sets the current viewport to the given cvp.
 

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.
 
virtual ~AbstractPlotTool ()
 Clean up the abstract plot tool.
 
virtual void paintViewport (MdiCubeViewport *vp, QPainter *painter)
 This method allows each plot window to paint any information it wants onto the cube viewports.
 
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)
 
virtual void addTo (Workspace *ws)
 Adds the given workspace to the cubeviewport list.
 
virtual QString menuName () const
 Anytime a tool is created, you must give it a name for the menu.
 
virtual void addToPermanent (QToolBar *toolbar)
 
void addToActive (QToolBar *toolbar)
 
QString toolIconDir () const
 returns the path to the icon directory.
 
RubberBandToolrubberBandTool ()
 
void setList (ToolList *currentList)
 

Protected Types

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

Protected Slots

void repaintViewports ()
 This method causes all of the viewports to be repainted.
 
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)
 
virtual void mouseMove (QPoint p, Qt::MouseButton)
 
virtual void mouseLeave ()
 

Protected Member Functions

PlotWindowaddWindow ()
 This creates and initializes everything about a plot window.
 
QWidgetcreateToolBarWidget (QStackedWidget *parent)
 This provides the standard plot tool options, such as selecting an active plot window.
 
virtual PlotWindowcreateWindow ()=0
 This needs to be implemented by children to instantiate a plot window of the appropriate child class of PlotWindow.
 
virtual void updateTool ()
 This forwards all update calls to the plot windows.
 
QList< MdiCubeViewport * > viewportsToPlot ()
 Get a list of linked viewports that should be plotting when a new plot is requested.
 
QList< PlotWindow * > plotWindows ()
 Get a list of all of the instantiated plot windows.
 
virtual void detachCurves ()=0
 This will be called when the selected plot window changes.
 
PlotWindowselectedWindow (bool createIfNeeded=true)
 Get the 'active' plot window (the window selected by the user to contain new curves).
 
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.
 
MdiCubeViewportcubeViewport () const
 Return the current cubeviewport.
 
CubeViewportListcubeViewportList () const
 Return the list of cubeviewports.
 
virtual QActiontoolPadAction (ToolPad *toolpad)
 Anytime a tool is created, you must setup a tool pad action with it.
 
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.
 
Workspaceworkspace ()
 

Static Protected Member Functions

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

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

Member Typedef Documentation

◆ CubeViewportList

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

A list of cubeviewports.

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

◆ ~AbstractPlotTool()

Isis::AbstractPlotTool::~AbstractPlotTool ( )
virtual

Clean up the abstract plot tool.

This will destroy all of the plot windows.

Member Function Documentation

◆ activate

◆ 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.

◆ addTo() [1/4]

◆ addTo() [2/4]

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

Adds the tool to the toolpad.

Parameters
toolpad

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

◆ addTo() [3/4]

◆ 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.

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

◆ addToActive()

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

References Isis::Tool::createToolBarWidget(), and Isis::ToolList::toolBarStack().

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

◆ addToPermanent()

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

◆ 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

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

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

◆ clearWarningSignal

void Isis::Tool::clearWarningSignal ( )
signalinherited

◆ 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

◆ 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::HistogramTool, Isis::SpatialPlotTool, Isis::SpectralPlotTool, and Isis::StereoTool.

Referenced by Isis::HistogramTool::createToolBarWidget(), Isis::SpatialPlotTool::createToolBarWidget(), Isis::SpectralPlotTool::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::HistogramTool, Isis::SpatialPlotTool, Isis::SpectralPlotTool, and Isis::StereoTool.

Referenced by addWindow().

◆ cubeViewport()

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

Return the current cubeviewport.

Returns
CubeViewport*

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

◆ cubeViewportList()

◆ 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::HistogramTool, Isis::SpatialPlotTool, Isis::SpectralPlotTool, and Isis::StereoTool.

◆ 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::HistogramTool, Isis::MeasureTool, Isis::RubberBandTool, Isis::SpatialPlotTool, Isis::SpectralPlotTool, Isis::StereoTool, and Isis::ZoomTool.

References Isis::RubberBandTool::disable(), and Isis::Tool::rubberBandTool().

◆ menuName()

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

◆ mouseButtonPress()

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

References Isis::Tool::clearWarningSignal().

◆ 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.

References Isis::Tool::clearWarningSignal().

Referenced by Isis::StretchTool::mouseButtonRelease().

◆ mouseDoubleClick()

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

References Isis::Tool::clearWarningSignal().

◆ mouseEnter

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

◆ mouseLeave

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

◆ mouseMove [1/2]

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

◆ mouseMove [2/2]

virtual void Isis::Tool::mouseMove ( QPoint p,
Qt::MouseButton  )
inlineprotectedvirtualslotinherited

◆ 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.

References 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

Referenced by updateTool().

◆ registerTool()

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

Registers the tool to the viewport.

Parameters
viewport

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

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.

◆ 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

References repaintViewports().

Referenced by addWindow().

◆ repaintViewports [1/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.

References Isis::Tool::cubeViewportList().

Referenced by addWindow(), and removeWindow().

◆ repaintViewports [2/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

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

◆ rubberBandComplete

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

◆ rubberBandTool()

◆ scaleChanged()

virtual void Isis::Tool::scaleChanged ( )
inlineprotectedvirtualinherited

Reimplemented in Isis::RubberBandTool.

◆ screenPixelsChanged

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

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

◆ 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

References addWindow().

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

◆ setCubeViewport

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

Sets the current viewport to the given cvp.

Parameters
cvp

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

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

◆ setList()

void Isis::Tool::setList ( ToolList * currentList)
inherited

◆ showPlotWindow

void Isis::AbstractPlotTool::showPlotWindow ( )
slot

displays the plot window

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

◆ stretchRequested()

virtual void Isis::Tool::stretchRequested ( MdiCubeViewport * ,
int  )
inlineprotectedvirtualinherited

Reimplemented in Isis::StretchTool.

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

◆ toolActivated

◆ toolIconDir()

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

◆ toolPadAction()

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

◆ updateMeasure()

virtual void Isis::Tool::updateMeasure ( )
inlineprotectedvirtualinherited

◆ updateTool()

void Isis::AbstractPlotTool::updateTool ( )
protectedvirtual

This forwards all update calls to the plot windows.

Reimplemented from Isis::Tool.

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

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

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

◆ viewportChanged

◆ 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.

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

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

◆ workspace()


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