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

#include <AbstractPlotTool.h>

Inheritance diagram for Isis::AbstractPlotTool:

Collaboration diagram for Isis::AbstractPlotTool:

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 Member Functions
void	addViewportConnections ()
	Makes all the connections for the tool. More...

void	removeViewportConnections ()
	Removes all the connections from the tool. More...

void	enableToolBar ()
	Enables entire tool bar. More...

void	disableToolBar ()
	Disables entire tool bar. More...

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

MdiCubeViewport *	m_cvp
	current cubeviewport More...

Workspace *	m_workspace

bool	m_active
	Is the tool acitve? More...

QWidget *	m_toolBarWidget
	The tool bar on which this tool resides. More...

QAction *	m_toolPadAction
	The tool pad on which this tool resides. More...

QString	m_toolIconDir
	The pathway to the icon directory. More...

ToolList *	m_toolList

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.

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

Definition at line 43 of file AbstractPlotTool.h.

Member Typedef Documentation

◆ CubeViewportList

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

protectedinherited

A list of cubeviewports.

Definition at line 205 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 34 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 54 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::WindowTool, and Isis::TrackTool.

Definition at line 239 of file Tool.h.

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

◆ addTo() [1/4]

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

inlinevirtualinherited

Parameters

menu

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

Definition at line 91 of file Tool.h.

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

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

◆ addTo() [4/4]

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

virtualinherited

Adds the given workspace to the cubeviewport list.

Parameters

ws

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

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

Definition at line 97 of file Tool.h.

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

◆ addViewportConnections()

void Isis::Tool::addViewportConnections ( )

privateinherited

Makes all the connections for the tool.

Definition at line 187 of file Tool.cpp.

References Isis::Tool::addConnections(), Isis::Tool::enableRubberBandTool(), Isis::Tool::m_cvp, Isis::Tool::m_toolPadAction, Isis::Tool::mouseButtonPress(), Isis::Tool::mouseButtonRelease(), Isis::Tool::mouseDoubleClick(), Isis::Tool::mouseMove(), and Isis::Tool::screenPixelsChanged().

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

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

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

Definition at line 233 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

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.

Definition at line 103 of file AbstractPlotTool.cpp.

References m_selectWindowCombo.

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

Referenced by addWindow().

◆ cubeViewport()

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

inlineprotectedinherited

Return the current cubeviewport.

Returns: CubeViewport*

Definition at line 197 of file Tool.h.

References Isis::Tool::m_cvp.

◆ 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::ControlNetTool::paintAllViewports(), Isis::MatchTool::paintAllViewports(), Isis::StereoTool::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::BlinkTool::updateTool(), Isis::FindTool::updateTool(), Isis::WindowTool::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::SpectralPlotTool, Isis::SpatialPlotTool, and Isis::HistogramTool.

Referenced by selectedWindowChanged().

◆ disableToolBar()

void Isis::Tool::disableToolBar ( )

privateinherited

Disables entire tool bar.

Definition at line 285 of file Tool.cpp.

References Isis::Tool::m_toolBarWidget.

Referenced by Isis::Tool::activate(), and Isis::Tool::addToActive().

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

Definition at line 339 of file Tool.cpp.

References Isis::RubberBandTool::disable().

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

◆ enableToolBar()

void Isis::Tool::enableToolBar ( )

privateinherited

Enables entire tool bar.

Definition at line 297 of file Tool.cpp.

References Isis::Tool::cubeViewport(), Isis::Tool::m_toolBarWidget, and Isis::Tool::updateTool().

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

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

Definition at line 83 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

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

Reimplemented from Isis::Tool.

Reimplemented in Isis::StereoTool.

Definition at line 81 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 155 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::WindowTool, Isis::TrackTool, and Isis::MeasureTool.

Definition at line 247 of file Tool.h.

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

◆ removeViewportConnections()

void Isis::Tool::removeViewportConnections ( )

privateinherited

Removes all the connections from the tool.

Definition at line 238 of file Tool.cpp.

References Isis::Tool::m_cvp, Isis::Tool::mouseButtonPress(), Isis::Tool::mouseButtonRelease(), Isis::Tool::mouseDoubleClick(), Isis::Tool::mouseMove(), Isis::Tool::removeConnections(), and Isis::Tool::screenPixelsChanged().

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

◆ 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

window The plot window that is to be removed

Definition at line 203 of file AbstractPlotTool.cpp.

References m_selectWindowCombo, and 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.

Definition at line 362 of file AbstractPlotTool.cpp.

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

pc	The plot curve which needs to repaint

Definition at line 284 of file AbstractPlotTool.cpp.

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

◆ screenPixelsChanged

virtual void Isis::Tool::screenPixelsChanged ( )

inlineprotectedvirtualslotinherited

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

Definition at line 148 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

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.

Returns: The user-selected active plot window

Definition at line 256 of file AbstractPlotTool.cpp.

References addWindow(), and m_selectWindowCombo.

Referenced by Isis::HistogramTool::refreshPlot(), Isis::SpatialPlotTool::refreshPlot(), Isis::SpectralPlotTool::refreshPlot(), Isis::HistogramTool::rubberBandComplete(), Isis::SpatialPlotTool::rubberBandComplete(), Isis::SpectralPlotTool::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 178 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 350 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 113 of file Tool.h.

References Isis::Tool::m_toolIconDir.

◆ 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::ZoomTool, Isis::StatisticsTool, Isis::FindTool, Isis::SunShadowTool, Isis::StretchTool, Isis::StereoTool, Isis::SpectralPlotTool, Isis::SpatialPlotTool, Isis::ScatterPlotTool, Isis::QnetTool, Isis::PanTool, Isis::MeasureTool, Isis::MatchTool, Isis::HistogramTool, Isis::FeatureNomenclatureTool, Isis::EditTool, Isis::ControlNetTool, and Isis::BandTool.

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

Definition at line 118 of file AbstractPlotTool.cpp.

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

Referenced by Isis::HistogramTool::updateTool(), Isis::SpatialPlotTool::updateTool(), and Isis::SpectralPlotTool::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 133 of file AbstractPlotTool.cpp.

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

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

Member Data Documentation

◆ m_active

bool Isis::Tool::m_active

privateinherited

Is the tool acitve?

Definition at line 264 of file Tool.h.

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

◆ m_cvp

MdiCubeViewport* Isis::Tool::m_cvp

privateinherited

current cubeviewport

Definition at line 261 of file Tool.h.

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

◆ 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 98 of file AbstractPlotTool.h.

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

◆ m_toolBarWidget

QWidget* Isis::Tool::m_toolBarWidget

privateinherited

The tool bar on which this tool resides.

Definition at line 265 of file Tool.h.

Referenced by Isis::Tool::addToActive(), Isis::Tool::disableToolBar(), Isis::Tool::enableToolBar(), and Isis::Tool::Tool().

◆ m_toolIconDir

QString Isis::Tool::m_toolIconDir

privateinherited

The pathway to the icon directory.

Definition at line 267 of file Tool.h.

Referenced by Isis::Tool::Tool(), and Isis::Tool::toolIconDir().

◆ m_toolPadAction

QAction* Isis::Tool::m_toolPadAction

privateinherited

The tool pad on which this tool resides.

Definition at line 266 of file Tool.h.

Referenced by Isis::Tool::activate(), Isis::Tool::addTo(), Isis::Tool::addViewportConnections(), and Isis::Tool::Tool().

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

src/qisis/objs/AbstractPlotTool/AbstractPlotTool.h
src/qisis/objs/AbstractPlotTool/AbstractPlotTool.cpp

Public Slots

Signals

Public Member Functions

Protected Types

Protected Slots

Protected Member Functions

Static Protected Member Functions

Private Slots

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ CubeViewportList

Constructor & Destructor Documentation

◆ AbstractPlotTool()

◆ ~AbstractPlotTool()

Member Function Documentation

◆ activate

◆ addConnections()

◆ addTo() [1/4]

◆ addTo() [2/4]

◆ addTo() [3/4]

◆ addTo() [4/4]

◆ addToActive()

◆ addToPermanent()

◆ addViewportConnections()

◆ addWindow()

◆ createCurve()

◆ createToolBarWidget()

◆ createWindow()

◆ cubeViewport()

◆ cubeViewportList()

◆ detachCurves()

◆ disableToolBar()

◆ enableRubberBandTool()

◆ enableToolBar()

◆ menuName()

◆ mouseButtonPress()

◆ mouseButtonRelease()

◆ mouseDoubleClick()

◆ mouseMove

◆ paintViewport()

◆ plotWindows()

◆ registerTool()

◆ removeConnections()

◆ removeViewportConnections()

◆ removeWindow

◆ repaintViewports [1/2]

◆ repaintViewports [2/2]

◆ screenPixelsChanged

◆ selectedWindow()

◆ selectedWindowChanged

◆ setCubeViewport

◆ showPlotWindow

◆ toolIconDir()

◆ toolPadAction()

◆ updateTool()

◆ viewportsToPlot()

Member Data Documentation

◆ m_active

◆ m_cvp

◆ m_selectWindowCombo

◆ m_toolBarWidget

◆ m_toolIconDir

◆ m_toolPadAction