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

#include <AbstractPlotTool.h>

Inherited by Isis::HistogramTool, Isis::SpatialPlotTool, Isis::SpectralPlotTool, and Isis::StereoTool.

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)
	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.
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 ()
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
PlotWindow *	addWindow ()
	This creates and initializes everything about a plot window.
QWidget *	createToolBarWidget (QStackedWidget *parent)
	This provides the standard plot tool options, such as selecting an active plot window.
virtual PlotWindow *	createWindow ()=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.
PlotWindow *	selectedWindow (bool createIfNeeded=true)
	Get the 'active' plot window (the window selected by the user to contain new curves).
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 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.
Static Protected Member Functions
static CubePlotCurve *	createCurve (QString name, QPen pen, PlotCurve::Units xUnits, PlotCurve::Units yUnits)
	This is a helper method for children.
Protected Attributes
MdiCubeViewport *	p_cvp
	current cubeviewport
Workspace *	p_workspace

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

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

A list of cubeviewports.

Constructor & Destructor Documentation

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

Isis::AbstractPlotTool::~AbstractPlotTool ( ) [virtual]

Clean up the abstract plot tool.

This will destroy all of the plot windows.

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(), 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.

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::addTo ( ToolPad * toolpad ) [inherited]

Adds the tool to the toolpad.

Parameters:

toolpad

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

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

requires the programmer to have this member

Parameters:

menu

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

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().

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::FileTool, Isis::HelpTool, Isis::SpecialPixelTool, Isis::BlinkTool, and Isis::WindowTool.

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

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().

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

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

CubePlotCurve * Isis::AbstractPlotTool::createCurve	(	QString	name,
		QPen	pen,
		PlotCurve::Units	xUnits,
		PlotCurve::Units	yUnits
	)		`[static, protected]`

This is a helper method for children.

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

Parameters:

name	The title of the curve to be created
pen	The color & thickness of the curve
xUnits	The units of the x-axis associated with this curve. This must match the plot window's x axis.
yUnits	The units of the y-axis associated with this curve. This must match the plot window's y axis.

Returns:: createCurve The requested plot curve

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

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

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

Parameters:

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

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

virtual PlotWindow* Isis::AbstractPlotTool::createWindow ( ) [protected, pure 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::SpectralPlotTool, Isis::SpatialPlotTool, and Isis::HistogramTool.

Referenced by addWindow().

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

Return the current cubeviewport.

Returns:: CubeViewport*

References Isis::Tool::p_cvp.

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::PanTool::mouseButtonRelease(), Isis::RubberBandTool::mouseButtonRelease(), Isis::RubberBandTool::mouseMove(), Isis::ScatterPlotTool::repaintViewports(), 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::BlinkTool::updateTool(), Isis::FindTool::updateTool(), and viewportsToPlot().

virtual void Isis::AbstractPlotTool::detachCurves ( ) [protected, pure 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::SpectralPlotTool, Isis::SpatialPlotTool, and Isis::HistogramTool.

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

References Isis::RubberBandTool::disable().

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::StretchTool, Isis::FindTool, Isis::FeatureNomenclatureTool, Isis::FileTool, Isis::AdvancedTrackTool, Isis::ZoomTool, Isis::MeasureTool, Isis::HelpTool, Isis::SpecialPixelTool, Isis::BandTool, Isis::BlinkTool, Isis::WindowTool, and Isis::PanTool.

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

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

Parameters:

p
s

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

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::MatchTool, Isis::StretchTool, Isis::FindTool, Isis::StatisticsTool, Isis::FeatureNomenclatureTool, Isis::EditTool, Isis::RubberBandTool, Isis::SunShadowTool, and Isis::PanTool.

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]

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

Reimplemented in Isis::AdvancedTrackTool, Isis::MeasureTool, Isis::TrackTool, and Isis::ScatterPlotTool.

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

Parameters:

p

Reimplemented in Isis::AdvancedTrackTool, Isis::TrackTool, Isis::SunShadowTool, and Isis::PanTool.

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

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

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:

vp	The viewport to paint onto
painter	The painter to use for painting

Reimplemented from Isis::Tool.

Reimplemented in Isis::StereoTool.

References Isis::PlotWindow::paint().

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().

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().

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.

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:

window The plot window that is to be removed

References repaintViewports().

Referenced by addWindow().

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:

pc	The plot curve which needs to repaint

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

void Isis::AbstractPlotTool::repaintViewports ( ) [protected, slot]

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().

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

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

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.

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:

createIfNeeded If 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.