Isis::AbstractPlotTool Class Reference

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

#include <AbstractPlotTool.h>

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

Public Slots
void	removeWindow (QObject *)
	When a user closes a window, we want to remove that window from our QComboBox.
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	viewportChanged ()
Public Member Functions
	AbstractPlotTool (QWidget *parent)
	This constructs a plot tool.
virtual	~AbstractPlotTool ()
virtual void	paintViewport (MdiCubeViewport vp, QPainter painter)
	This method paints the polygons of the copied curves onto the cubeviewport.
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 ()
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 ()
QWidget *	createToolBarWidget (QStackedWidget *parent)
	Creates the widgets for the tool bar.
virtual PlotWindow *	createWindow ()=0
virtual void	updateTool ()
	Updates the tool.
QList< MdiCubeViewport * >	viewportsToPlot ()
QList< PlotWindow * >	plotWindows ()
virtual void	detachCurves ()=0
	This will be called when the selected plot window changes.
PlotWindow *	selectedWindow (bool createIfNeeded=true)
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)
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 )

This constructs a plot tool.

The plot tool graphs either DN values across a line, or statistics across a spectrum (bands).

Parameters:

parent

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

Member Function Documentation

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

Activates the tool.

Parameters:

on

References Isis::Tool::clearWarningSignal().

Referenced by Isis::Tool::addTo(), Isis::AdvancedTrackTool::addTo(), Isis::RubberBandTool::disableBanding(), Isis::RubberBandTool::enableBanding(), 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 ( Workspace * ws ) [virtual, inherited]

requires the programmer to have this member

Adds the given workspace to the cubeviewport list.

Parameters:

ws

Reimplemented in Isis::FileTool, 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::FileTool, Isis::FindTool, Isis::HelpTool, Isis::MeasureTool, Isis::PanTool, Isis::SpecialPixelTool, Isis::SpectralPlotTool, Isis::StretchTool, 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().

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

Referenced by Isis::SpectralPlotTool::refreshPlot().

void 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]`

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

Creates the widgets for the tool bar.

Parameters:

parent

Returns:: QWidget*

Reimplemented from Isis::Tool.

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

virtual PlotWindow* Isis::AbstractPlotTool::createWindow ( ) [protected, pure virtual]

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

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::RubberBandTool::mouseButtonRelease(), Isis::PanTool::mouseButtonRelease(), Isis::RubberBandTool::mouseMove(), Isis::ScatterPlotTool::repaintViewports(), Isis::ZoomTool::rubberBandComplete(), Isis::MeasureTool::rubberBandComplete(), Isis::StretchTool::stretchGlobalAllViewports(), and Isis::WindowTool::updateTool().

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

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::StretchTool, and Isis::ZoomTool.

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::AdvancedTrackTool, Isis::BandTool, Isis::BlinkTool, 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, and Isis::RubberBandTool.

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

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::ScatterPlotTool, and Isis::TrackTool.

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

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

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

Parameters:

p

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

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

This method paints the polygons of the copied curves onto the cubeviewport.

Parameters:

	vp
	painter

Reimplemented from Isis::Tool.

References Isis::PlotWindow::paint().

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

Referenced by viewportsToPlot().

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

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

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

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.

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

Reimplemented in Isis::EditTool, Isis::HistogramTool, Isis::MeasureTool, Isis::SpatialPlotTool, Isis::SpectralPlotTool, 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.

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