USGS

Isis 3.0 Object Programmers' Reference

Home

Isis::ScatterPlotTool Class Reference

Scatter Plot Tool. More...

#include <ScatterPlotTool.h>

Inheritance diagram for Isis::ScatterPlotTool:
Inheritance graph
Collaboration diagram for Isis::ScatterPlotTool:
Collaboration graph

Public Slots

void onScatterPlotConfigAccepted ()
 The user has asked to create a scatter plot.
 
void onScatterPlotConfigRejected ()
 The user has cancelled creating a scatter plot.
 
void showNewScatterPlotConfig ()
 Ask the user to give us information for a new scatter plot.
 
void activate (bool)
 Activates the tool.
 
virtual void updateTool ()
 Updates the tool.
 
void setCubeViewport (MdiCubeViewport *cvp)
 Sets the current viewport to the given cvp.
 

Signals

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

Public Member Functions

 ScatterPlotTool (QWidget *parent)
 ScatterPlotTool constructor.
 
void setActionChecked (bool checked)
 Gives the programmer more flexibility on when the action button for this tool is checked or not.
 
virtual void paintViewport (MdiCubeViewport *vp, QPainter *painter)
 When a viewport needs repainted this is called.
 
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 mouseMove (QPoint p, Qt::MouseButton)
 The user has moved their mouse on the cube viewport.
 
void mouseLeave ()
 The user moused out of the viewport.
 
void repaintViewports ()
 This is a helper method for asking every viewport to repaint.
 
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 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

QWidgetcreateToolBarWidget (QStackedWidget *parent)
 Create the toolbar options widget for this tool's options.
 
QActiontoolPadAction (ToolPad *pad)
 Configure the QAction for this tool.
 
QActiontoolAction ()
 Get the action which activates this tool.
 
MdiCubeViewportcubeViewport () const
 Return the current cubeviewport.
 
CubeViewportListcubeViewportList () const
 Return the list of cubeviewports.
 
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 ()
 

Private Attributes

QPointer< QActionm_action
 The action which activates this tool.
 
QPointer< ScatterPlotConfigDialogm_configDialog
 This is the configuration dialog for a new scatter plot.
 
QScopedPointer< QList
< QPointer< ScatterPlotWindow > > > 
m_plotWindows
 This is a list of all of the plot windows used for painting/alarming.
 

Detailed Description

Scatter Plot Tool.

Author
????-??-?? Stacy Alley
History:
2010-06-26 Eric Hyer - Now uses MdiCubeViewport instead of CubeViewport. Also fixed some include issues.

Definition at line 27 of file ScatterPlotTool.h.

Member Typedef Documentation

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

A list of cubeviewports.

Definition at line 219 of file Tool.h.

Constructor & Destructor Documentation

Isis::ScatterPlotTool::ScatterPlotTool ( QWidget parent)

ScatterPlotTool constructor.

Parameters
parent

Definition at line 18 of file ScatterPlotTool.cpp.

Member Function Documentation

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

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

Adds the tool to the toolpad.

Parameters
toolpad

Definition at line 97 of file Tool.cpp.

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

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 44 of file Tool.cpp.

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

void Isis::Tool::addToActive ( QToolBar toolbar)
inherited
virtual void Isis::Tool::addToPermanent ( QToolBar toolbar)
inlinevirtualinherited
QWidget * Isis::ScatterPlotTool::createToolBarWidget ( QStackedWidget *  parent)
protectedvirtual

Create the toolbar options widget for this tool's options.

Parameters
parentThe stacked widget this will be put into.
Returns
A widget containing detailed options for this tool

Reimplemented from Isis::Tool.

Definition at line 89 of file ScatterPlotTool.cpp.

References showNewScatterPlotConfig().

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::exportView(), Isis::StatisticsTool::getStatistics(), Isis::FindTool::handleRecordClicked(), Isis::EditTool::LineToPoints(), Isis::TrackTool::locateCursor(), Isis::SunShadowTool::mouseButtonPress(), Isis::RubberBandTool::mouseButtonRelease(), Isis::EditTool::mouseButtonRelease(), Isis::FeatureNomenclatureTool::mouseButtonRelease(), Isis::FindTool::mouseButtonRelease(), Isis::StretchTool::mouseButtonRelease(), Isis::MatchTool::mouseButtonRelease(), Isis::QnetTool::mouseButtonRelease(), Isis::AdvancedTrackTool::mouseLeave(), 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(), 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::SunShadowTool::updateTool(), Isis::BandTool::updateTool(), Isis::AbstractPlotTool::updateTool(), Isis::ZoomTool::updateTool(), Isis::FileTool::updateTool(), Isis::EditTool::updateTool(), Isis::FindTool::updateTool(), Isis::StretchTool::updateTool(), Isis::AbstractPlotTool::viewportsToPlot(), Isis::EditTool::writeToCube(), Isis::ZoomTool::zoomBy(), Isis::ZoomTool::zoomFit(), Isis::ZoomTool::zoomFitHeight(), Isis::ZoomTool::zoomFitWidth(), and Isis::ZoomTool::zoomManual().

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

Return the list of cubeviewports.

Returns
CubeViewportList*

Definition at line 389 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::MatchTool::paintAllViewports(), Isis::QnetTool::paintAllViewports(), Isis::FindTool::refresh(), repaintViewports(), Isis::AbstractPlotTool::repaintViewports(), Isis::WindowTool::resizeWindows(), Isis::BlinkTool::reverse(), Isis::ZoomTool::rubberBandComplete(), Isis::MatchTool::serialNumberList(), 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(), Isis::AbstractPlotTool::viewportsToPlot(), Isis::ZoomTool::zoomBy(), Isis::ZoomTool::zoomFit(), Isis::ZoomTool::zoomFitHeight(), Isis::ZoomTool::zoomFitWidth(), and Isis::ZoomTool::zoomManual().

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 338 of file Tool.cpp.

References Isis::RubberBandTool::disable().

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

virtual QString Isis::Tool::menuName ( ) const
inlinevirtualinherited
void Isis::Tool::mouseButtonPress ( QPoint  p,
Qt::MouseButton  s 
)
protectedvirtualslotinherited
Parameters
p
s

Definition at line 366 of file Tool.cpp.

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

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

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 379 of file Tool.cpp.

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

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

Definition at line 357 of file Tool.cpp.

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

void Isis::ScatterPlotTool::mouseLeave ( )
protectedslot

The user moused out of the viewport.

Let the plot windows know this for alarming viewport->plot.

Definition at line 171 of file ScatterPlotTool.cpp.

References m_plotWindows, and Isis::ScatterPlotWindow::setMousePosition().

void Isis::ScatterPlotTool::mouseMove ( QPoint  p,
Qt::MouseButton   
)
protectedslot

The user has moved their mouse on the cube viewport.

We're going to notify the plot windows about this for alarming viewport->plot.

Parameters
pThe mouse location

Definition at line 158 of file ScatterPlotTool.cpp.

References Isis::Tool::cubeViewport(), m_plotWindows, and Isis::ScatterPlotWindow::setMousePosition().

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

Definition at line 351 of file Tool.cpp.

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

void Isis::ScatterPlotTool::onScatterPlotConfigAccepted ( )
slot

The user has asked to create a scatter plot.

If we can, create the scatter plot.

Definition at line 112 of file ScatterPlotTool.cpp.

References m_configDialog, m_plotWindows, and repaintViewports().

Referenced by showNewScatterPlotConfig().

void Isis::ScatterPlotTool::onScatterPlotConfigRejected ( )
slot

The user has cancelled creating a scatter plot.

Delete the configuration dialog.

Definition at line 147 of file ScatterPlotTool.cpp.

References m_configDialog.

Referenced by showNewScatterPlotConfig().

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

When a viewport needs repainted this is called.

We are going to give the plot windows a chance to paint onto the viewport.

Parameters
vpThe viewport to potentially be painted on
painterThe painter to use for painting

Reimplemented from Isis::Tool.

Definition at line 41 of file ScatterPlotTool.cpp.

References m_plotWindows, and Isis::ScatterPlotWindow::paint().

void Isis::Tool::registerTool ( MdiCubeViewport viewport)
protectedslotinherited

Registers the tool to the viewport.

Parameters
viewport

Definition at line 326 of file Tool.cpp.

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

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

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

void Isis::ScatterPlotTool::repaintViewports ( )
protectedslot

This is a helper method for asking every viewport to repaint.

Any time alarming changes this needs to happen.

Definition at line 184 of file ScatterPlotTool.cpp.

References Isis::Tool::cubeViewportList().

Referenced by onScatterPlotConfigAccepted().

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

void Isis::ScatterPlotTool::setActionChecked ( bool  checked)

Gives the programmer more flexibility on when the action button for this tool is checked or not.

Parameters
checked

Definition at line 29 of file ScatterPlotTool.cpp.

References m_action.

void Isis::Tool::setCubeViewport ( MdiCubeViewport cvp)
slotinherited
void Isis::ScatterPlotTool::showNewScatterPlotConfig ( )
slot

Ask the user to give us information for a new scatter plot.

Definition at line 196 of file ScatterPlotTool.cpp.

References Isis::Tool::cubeViewport(), m_configDialog, onScatterPlotConfigAccepted(), and onScatterPlotConfigRejected().

Referenced by createToolBarWidget(), and toolPadAction().

QAction * Isis::ScatterPlotTool::toolAction ( )
protected

Get the action which activates this tool.

Returns
The action which activates this tool

Definition at line 78 of file ScatterPlotTool.cpp.

References m_action.

QAction * Isis::ScatterPlotTool::toolPadAction ( ToolPad toolpad)
protectedvirtual

Configure the QAction for this tool.

Parameters
toolpad
Returns
QAction*

Reimplemented from Isis::Tool.

Definition at line 57 of file ScatterPlotTool.cpp.

References m_action, showNewScatterPlotConfig(), and Isis::Tool::toolIconDir().

Member Data Documentation

QPointer<QAction> Isis::ScatterPlotTool::m_action
private

The action which activates this tool.

Definition at line 54 of file ScatterPlotTool.h.

Referenced by setActionChecked(), toolAction(), and toolPadAction().

QPointer<ScatterPlotConfigDialog> Isis::ScatterPlotTool::m_configDialog
private

This is the configuration dialog for a new scatter plot.

Definition at line 56 of file ScatterPlotTool.h.

Referenced by onScatterPlotConfigAccepted(), onScatterPlotConfigRejected(), and showNewScatterPlotConfig().

QScopedPointer< QList< QPointer<ScatterPlotWindow> > > Isis::ScatterPlotTool::m_plotWindows
private

This is a list of all of the plot windows used for painting/alarming.

Definition at line 58 of file ScatterPlotTool.h.

Referenced by mouseLeave(), mouseMove(), onScatterPlotConfigAccepted(), and paintViewport().


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