Isis 3 Developer Reference
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. More...
 
void onScatterPlotConfigRejected ()
 The user has cancelled creating a scatter plot. More...
 
void showNewScatterPlotConfig ()
 Ask the user to give us information for a new scatter plot. More...
 
void activate (bool)
 Activates the tool. More...
 
virtual void updateTool ()
 Updates 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

 ScatterPlotTool (QWidget *parent)
 ScatterPlotTool constructor. More...
 
void setActionChecked (bool checked)
 Gives the programmer more flexibility on when the action button for this tool is checked or not. More...
 
virtual void paintViewport (MdiCubeViewport *vp, QPainter *painter)
 When a viewport needs repainted this is called. 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...
 
RubberBandToolrubberBandTool ()
 
void setList (ToolList *currentList)
 

Protected Types

typedef QVector
< MdiCubeViewport * > 
CubeViewportList
 A list of cubeviewports. More...
 

Protected Slots

void mouseMove (QPoint p, Qt::MouseButton)
 The user has moved their mouse on the cube viewport. More...
 
void mouseLeave ()
 The user moused out of the viewport. More...
 
void repaintViewports ()
 This is a helper method for asking every viewport to repaint. 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 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...
 

Protected Member Functions

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

Detailed Description

Scatter Plot Tool.

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

Member Typedef Documentation

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

A list of cubeviewports.

Constructor & Destructor Documentation

Isis::ScatterPlotTool::ScatterPlotTool ( QWidget parent)

ScatterPlotTool constructor.

Parameters
parent

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.

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 ( Workspace ws)
virtualinherited

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

void Isis::Tool::addToActive ( QToolBar toolbar)
inherited
virtual void Isis::Tool::addToPermanent ( QToolBar toolbar)
inlinevirtualinherited
void Isis::Tool::clearWarningSignal ( )
signalinherited
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.

References showNewScatterPlotConfig().

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

Return the current cubeviewport.

Returns
CubeViewport*

Referenced by Isis::WindowTool::addConnections(), Isis::TrackTool::addConnections(), Isis::FileTool::discard(), Isis::FileTool::exportView(), Isis::SunShadowTool::mouseButtonPress(), Isis::PanTool::mouseButtonRelease(), Isis::IpceTool::mouseButtonRelease(), 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::HistogramTool::refreshPlot(), Isis::SpatialPlotTool::refreshPlot(), Isis::SpectralPlotTool::refreshPlot(), Isis::WindowTool::removeConnections(), Isis::TrackTool::removeConnections(), Isis::HistogramTool::rubberBandComplete(), Isis::MeasureTool::rubberBandComplete(), Isis::ZoomTool::rubberBandComplete(), Isis::StereoTool::rubberBandComplete(), Isis::EditTool::rubberBandComplete(), Isis::StretchTool::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::WindowTool::updateTool(), Isis::BlinkTool::updateTool(), Isis::SpecialPixelTool::updateTool(), Isis::BandTool::updateTool(), Isis::SunShadowTool::updateTool(), Isis::AbstractPlotTool::updateTool(), Isis::ZoomTool::updateTool(), Isis::FileTool::updateTool(), Isis::EditTool::updateTool(), Isis::FindTool::updateTool(), Isis::StretchTool::updateTool(), and Isis::AbstractPlotTool::viewportsToPlot().

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.

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

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

References Isis::Tool::clearWarningSignal().

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.

References Isis::Tool::clearWarningSignal().

Referenced by Isis::StretchTool::mouseButtonRelease().

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

References Isis::Tool::clearWarningSignal().

virtual void Isis::Tool::mouseEnter ( )
inlineprotectedvirtualslotinherited
void Isis::ScatterPlotTool::mouseLeave ( )
protectedslot

The user moused out of the viewport.

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

References 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

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

void Isis::Tool::mouseMove ( QPoint  p)
protectedvirtualslotinherited
Parameters
p
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
vpThe viewport to potentially be painted on
painterThe painter to use for painting

Reimplemented from Isis::Tool.

References Isis::ScatterPlotWindow::paint().

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

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

void Isis::ScatterPlotTool::repaintViewports ( )
protectedslot

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 ( )
inlineprotectedvirtualslotinherited
virtual void Isis::Tool::scaleChanged ( )
inlineprotectedvirtualslotinherited

Reimplemented in Isis::RubberBandTool.

virtual void Isis::Tool::screenPixelsChanged ( )
inlineprotectedvirtualslotinherited

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

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

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

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
QAction * Isis::ScatterPlotTool::toolPadAction ( ToolPad toolpad)
protectedvirtual

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 ( )
inlineprotectedvirtualslotinherited
Workspace * Isis::Tool::workspace ( )
protectedinherited

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