USGS

Isis 3.0 Developer's Reference (API)

Home

Isis::ScatterPlotTool Class Reference

Scatter Plot Tool. More...

#include <ScatterPlotTool.h>

Inherits Isis::Tool.

List of all members.

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

Detailed Description

Scatter Plot Tool.

Author:
????-??-?? Stacy Alley

Member Typedef Documentation

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

A list of cubeviewports.


Constructor & Destructor Documentation

Isis::ScatterPlotTool::ScatterPlotTool ( QWidget parent  ) 

ScatterPlotTool constructor.

Parameters:
parent 

Member Function Documentation

void Isis::Tool::activate ( bool  on  )  [slot, inherited]
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 Isis::Tool::addTo ( Workspace ws  )  [virtual, inherited]

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

virtual void Isis::Tool::addTo ( QMenu *  menu  )  [inline, virtual, inherited]
void Isis::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 Isis::Tool::addTo ( ViewportMainWindow pViewPortMnWin  )  [inherited]
void Isis::Tool::addToActive ( QToolBar toolbar  )  [inherited]
virtual void Isis::Tool::addToPermanent ( QToolBar toolbar  )  [inline, virtual, inherited]
void Isis::Tool::clearWarningSignal (  )  [signal, inherited]
QWidget * Isis::ScatterPlotTool::createToolBarWidget ( QStackedWidget *  parent  )  [protected, virtual]

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

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

Reimplemented from Isis::Tool.

References showNewScatterPlotConfig().

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

Return the current cubeviewport.

Returns:
CubeViewport*

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

Tool::CubeViewportList * Isis::Tool::cubeViewportList (  )  const [protected, inherited]
void Isis::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::StereoTool, Isis::StretchTool, and Isis::ZoomTool.

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

virtual QString Isis::Tool::menuName (  )  const [inline, virtual, inherited]
void Isis::Tool::mouseButtonPress ( QPoint  p,
Qt::MouseButton  s 
) [protected, virtual, slot, inherited]
Parameters:
p 
s 

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

References Isis::Tool::clearWarningSignal().

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

References Isis::Tool::clearWarningSignal().

void Isis::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]
void Isis::ScatterPlotTool::mouseLeave (  )  [protected, virtual, slot]

The user moused out of the viewport.

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

Reimplemented from Isis::Tool.

References Isis::ScatterPlotWindow::setMousePosition().

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

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:
p The mouse location

Reimplemented from Isis::Tool.

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

void Isis::ScatterPlotTool::onScatterPlotConfigAccepted (  )  [slot]

The user has asked to create a scatter plot.

If we can, create the scatter plot.

References repaintViewports().

Referenced by showNewScatterPlotConfig().

void Isis::ScatterPlotTool::onScatterPlotConfigRejected (  )  [slot]

The user has cancelled creating a scatter plot.

Delete the configuration dialog.

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:
vp The viewport to potentially be painted on
painter The painter to use for painting

Reimplemented from Isis::Tool.

References Isis::ScatterPlotWindow::paint().

void Isis::Tool::registerTool ( MdiCubeViewport viewport  )  [protected, slot, inherited]

Registers the tool to the viewport.

Parameters:
viewport 

References 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::ScatterPlotTool::repaintViewports (  )  [protected, slot]

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

Any time alarming changes this needs to happen.

References Isis::Tool::cubeViewportList().

Referenced by onScatterPlotConfigAccepted().

virtual void Isis::Tool::rubberBandComplete (  )  [inline, protected, virtual, slot, inherited]
RubberBandTool * Isis::Tool::rubberBandTool (  )  [inherited]
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.

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 
void Isis::Tool::setCubeViewport ( MdiCubeViewport cvp  )  [slot, inherited]

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

void Isis::Tool::setList ( ToolList currentList  )  [inherited]

Referenced by Isis::ToolList::append().

void Isis::ScatterPlotTool::showNewScatterPlotConfig (  )  [slot]

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

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

Referenced by createToolBarWidget(), and toolPadAction().

virtual void Isis::Tool::stretchRequested ( MdiCubeViewport ,
int   
) [inline, protected, virtual, slot, inherited]

Reimplemented in Isis::StretchTool.

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

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

Get the action which activates this tool.

Returns:
The action which activates this tool
void Isis::Tool::toolActivated (  )  [signal, inherited]
QString Isis::Tool::toolIconDir (  )  const [inline, inherited]
QAction * Isis::ScatterPlotTool::toolPadAction ( ToolPad toolpad  )  [protected, virtual]

Configure the QAction for this tool.

Parameters:
toolpad 
Returns:
QAction*

Reimplemented from Isis::Tool.

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

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

Reimplemented in Isis::MeasureTool.

void Isis::Tool::updateTool (  )  [virtual, slot, inherited]
void Isis::Tool::viewportChanged (  )  [signal, inherited]
Workspace * Isis::Tool::workspace (  )  [protected, inherited]

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