USGS

Isis 3.0 Developer's Reference (API)

 Home

Isis::MeasureTool Class Reference

Tool for measuring distances. More...

#include <MeasureTool.h>

Inherits Isis::Tool.

List of all members.

Public Slots

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

 MeasureTool (QWidget *parent)
 MeasureTool constructor.
void addTo (QMenu *menu)
 Adds the measure action to the given menu.
void addTo (ViewportMainWindow *mw)
 Adds the tool to the application.
void addTo (ToolPad *toolpad)
 Adds the tool to the toolpad.
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.
virtual void paintViewport (MdiCubeViewport *vp, QPainter *painter)
 requires the programmer to have this member

Protected Types

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

Protected Slots

virtual void rubberBandComplete ()
 Called when the rubberBanding by the user is finished.
virtual void updateMeasure ()
 Updates the Measure specifications.
virtual void mouseLeave ()
 Mouse leave event.
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 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 scaleChanged ()
virtual void stretchRequested (MdiCubeViewport *, int)
void registerTool (MdiCubeViewport *viewport)
 Registers the tool to the viewport.

Protected Member Functions

QString menuName () const
 Returns the menu name.
QWidget * createToolBarWidget (QStackedWidget *parent)
 Creates the widget (button) that goes on the tool bar.
QAction * toolPadAction (ToolPad *pad)
 Add the measure tool action to the toolpad.
void updateTool ()
 Updates the measure tool.
void removeConnections (MdiCubeViewport *cvp)
 Removes the connection on the given cube viewport.
void enableRubberBandTool ()
 Enables/resets the rubberband tool.
MdiCubeViewport * cubeViewport () const
 Return the current cubeviewport.
CubeViewportList * cubeViewportList () const
 Return the list of cubeviewports.
virtual void addConnections (MdiCubeViewport *cvp)
 Anytime a tool is created, you must add the connections for it.

Protected Attributes

MdiCubeViewport * p_cvp
 current cubeviewport
Workspace * p_workspace

Detailed Description

Tool for measuring distances.

Author:
????-??-?? Unknown

Member Typedef Documentation

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

A list of cubeviewports.

Constructor & Destructor Documentation

Isis::MeasureTool::MeasureTool ( QWidget *  parent  ) 

MeasureTool constructor.

Parameters:
parent 

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

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 Isis::MeasureTool::addTo ( QMenu *  menu  )  [virtual]

Adds the measure action to the given menu.

Parameters:
menu 

Reimplemented from Isis::Tool.

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

void Tool::clearWarningSignal (  )  [signal, inherited]

Referenced by Isis::Tool::activate(), Isis::Tool::mouseButtonPress(), Isis::Tool::mouseButtonRelease(), and Isis::Tool::mouseDoubleClick().

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

Creates the widget (button) that goes on the tool bar.

Parameters:
parent 
Returns:
QWidget*

Reimplemented from Isis::Tool.

References Isis::Tool::toolIconDir().

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

Return the current cubeviewport.

Returns:
CubeViewport*

References Isis::Tool::p_cvp.

Referenced by Isis::WindowTool::addConnections(), Isis::TrackTool::addConnections(), Isis::StretchTool::mouseButtonRelease(), Isis::RubberBandTool::mouseButtonRelease(), Isis::PanTool::mouseButtonRelease(), Isis::TrackTool::mouseMove(), Isis::ScatterPlotTool::mouseMove(), Isis::RubberBandTool::mouseMove(), Isis::RubberBandTool::paintViewport(), Isis::SpectralPlotTool::refreshPlot(), Isis::SpatialPlotTool::refreshPlot(), Isis::WindowTool::removeConnections(), Isis::TrackTool::removeConnections(), Isis::ZoomTool::rubberBandComplete(), Isis::StretchTool::rubberBandComplete(), Isis::ScatterPlotTool::showNewScatterPlotConfig(), Isis::StretchTool::stretchGlobal(), Isis::StretchTool::stretchGlobalAllBands(), Isis::StretchTool::stretchRegional(), Isis::StretchTool::updateAdvStretchDialogforAll(), Isis::StretchTool::updateHistograms(), Isis::ZoomTool::updateTool(), Isis::WindowTool::updateTool(), Isis::StretchTool::updateTool(), Isis::SpecialPixelTool::updateTool(), and Isis::AbstractPlotTool::viewportsToPlot().

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(), rubberBandComplete(), Isis::StretchTool::stretchGlobalAllViewports(), and Isis::WindowTool::updateTool().

void Isis::MeasureTool::enableRubberBandTool (  )  [protected, virtual]

Enables/resets the rubberband tool.

Reimplemented from Isis::Tool.

QString Isis::MeasureTool::menuName (  )  const [inline, protected, virtual]

Returns the menu name.

Reimplemented from Isis::Tool.

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

Mouse leave event.

Reimplemented from Isis::Tool.

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.

virtual void Isis::Tool::paintViewport ( MdiCubeViewport *  vp,
QPainter *  painter 
) [inline, virtual, inherited]

requires the programmer to have this member

Parameters:
vp 
painter 

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

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

void Isis::MeasureTool::removeConnections ( MdiCubeViewport *  cvp  )  [protected, virtual]

Removes the connection on the given cube viewport.

Parameters:
cvp 

Reimplemented from Isis::Tool.

void Isis::MeasureTool::rubberBandComplete (  )  [protected, virtual, slot]

Called when the rubberBanding by the user is finished.

Reimplemented from Isis::Tool.

References Isis::Tool::cubeViewportList(), and Isis::TableMainWindow::table().

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

Sets the current viewport to the given cvp.

Parameters:
cvp 

References Isis::Tool::p_cvp, Isis::Tool::updateTool(), and Isis::Tool::viewportChanged().

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

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

Reimplemented in Isis::StretchTool.

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

QString Isis::Tool::toolIconDir (  )  const [inline, inherited]

returns the path to the icon directory.

Returns:
QString

Referenced by Isis::ZoomTool::createToolBarWidget(), Isis::StretchTool::createToolBarWidget(), Isis::PanTool::createToolBarWidget(), createToolBarWidget(), Isis::HistogramTool::HistogramTool(), Isis::PanTool::PanTool(), Isis::SpatialPlotTool::SpatialPlotTool(), Isis::SpecialPixelTool::SpecialPixelTool(), Isis::SpectralPlotTool::SpectralPlotTool(), Isis::RubberBandComboBox::toolIconDir(), Isis::ZoomTool::toolPadAction(), Isis::StretchTool::toolPadAction(), Isis::StatisticsTool::toolPadAction(), Isis::ScatterPlotTool::toolPadAction(), Isis::PanTool::toolPadAction(), Isis::EditTool::toolPadAction(), Isis::WindowTool::WindowTool(), and Isis::ZoomTool::ZoomTool().

QAction * Isis::MeasureTool::toolPadAction ( ToolPad *  toolpad  )  [protected, virtual]

Add the measure tool action to the toolpad.

Parameters:
toolpad 
Returns:
QAction*

Reimplemented from Isis::Tool.

void Isis::MeasureTool::updateMeasure (  )  [protected, virtual, slot]

Updates the Measure specifications.

Reimplemented from Isis::Tool.

void Isis::MeasureTool::updateTool (  )  [protected, virtual]

Updates the measure tool.

Reimplemented from Isis::Tool.

void Tool::viewportChanged (  )  [signal, inherited]

Referenced by Isis::Tool::setCubeViewport(), Isis::SpatialPlotTool::SpatialPlotTool(), and Isis::SpectralPlotTool::SpectralPlotTool().

Member Data Documentation

MdiCubeViewport* Isis::Tool::p_cvp [protected, inherited]

current cubeviewport

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

Workspace* Isis::Tool::p_workspace [protected, inherited]

Referenced by Isis::Tool::addTo(), Isis::Tool::cubeViewportList(), Isis::ScatterPlotTool::showNewScatterPlotConfig(), and Isis::Tool::Tool().

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