Isis::Tool Class Reference

Base class for the Qisis tools. More...

#include <Tool.h>

Inherits QObject.

Inherited by Isis::AbstractPlotTool, Isis::AdvancedTrackTool, Isis::BandTool, Isis::BlinkTool, Isis::EditTool, Isis::FeatureNomenclatureTool, Isis::FileTool, Isis::FindTool, Isis::HelpTool, Isis::IpceTool, Isis::MatchTool, Isis::MeasureTool, Isis::PanTool, Isis::QnetNavTool, Isis::QnetTool, Isis::RubberBandTool, Isis::ScatterPlotTool, Isis::SpecialPixelTool, Isis::StatisticsTool, Isis::StretchTool, Isis::SunShadowTool, Isis::TrackTool, Isis::WindowTool, and Isis::ZoomTool.

Public Slots
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
	Tool (QWidget *parent)
	Tool constructor. More...
void	addTo (ViewportMainWindow *mw)
	Adds the tool to the application. More...
void	addTo (ToolPad *toolpad)
	Adds the tool to the toolpad. More...
virtual QString	menuName () const
	Anytime a tool is created, you must give it a name for the menu. More...
virtual void	addTo (QMenu *menu)
virtual void	addToPermanent (QToolBar *toolbar)
void	addToActive (QToolBar *toolbar)
virtual void	addTo (Workspace *ws)
	Adds the given workspace to the cubeviewport list. More...
QString	toolIconDir () const
	returns the path to the icon directory. More...
virtual void	paintViewport (MdiCubeViewport *vp, QPainter *painter)
RubberBandTool *	rubberBandTool ()
void	setList (ToolList *currentList)

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

Protected Slots
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 ()
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
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 QWidget *	createToolBarWidget (QStackedWidget *parent)
	Anytime a tool is created, you must add it to the tool bar. 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 ()

Detailed Description

Base class for the Qisis tools.

Author

????-??-?? Jeff Anderson

Member Typedef Documentation

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

protected

A list of cubeviewports.

Constructor & Destructor Documentation

Isis::Tool::Tool

(

QWidget *

parent

)

Tool constructor.

Parameters

parent

References Isis::FileName::expanded().

Member Function Documentation

void Isis::Tool::activate ( bool  on )

slot

Activates the tool.

Parameters

on

References clearWarningSignal(), and toolActivated().

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

virtual void Isis::Tool::addConnections ( MdiCubeViewport *  cvp )

inlineprotectedvirtual

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

(

ViewportMainWindow *

pViewPortMnWin

)

Adds the tool to the application.

Parameters

pViewPortMnWin

References Isis::ViewportMainWindow::activeToolBar(), addToActive(), addToPermanent(), Isis::ViewportMainWindow::getMenu(), menuName(), Isis::ViewportMainWindow::permanentToolBar(), Isis::ViewportMainWindow::toolPad(), and Isis::ViewportMainWindow::workspace().

Referenced by Isis::WindowTool::addTo(), Isis::SpecialPixelTool::addTo(), Isis::FileTool::addTo(), Isis::EditTool::addTo(), Isis::CubeDnView::CubeDnView(), Isis::ViewportMainWindow::ViewportMainWindow(), and Isis::Workspace::Workspace().

void Isis::Tool::addTo

(

ToolPad *

toolpad

)

Adds the tool to the toolpad.

Parameters

toolpad

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

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

inlinevirtual

Parameters

menu

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

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

virtual

Adds the given workspace to the cubeviewport list.

Parameters

ws

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

References registerTool(), and setCubeViewport().

void Isis::Tool::addToActive

(

QToolBar *

toolbar

)

Parameters

toolbar

References createToolBarWidget(), and Isis::ToolList::toolBarStack().

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

virtual void Isis::Tool::addToPermanent ( QToolBar *  toolbar )

inlinevirtual

Parameters

toolbar

Reimplemented in Isis::AdvancedTrackTool, Isis::FileTool, Isis::HelpTool, Isis::SpecialPixelTool, Isis::BlinkTool, and Isis::WindowTool.

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

void Isis::Tool::clearWarningSignal ( )

signal

Referenced by activate(), mouseButtonPress(), mouseButtonRelease(), and mouseDoubleClick().

virtual QWidget* Isis::Tool::createToolBarWidget ( QStackedWidget *  parent )

inlineprotectedvirtual

Anytime a tool is created, you must add it to the tool bar.

Parameters

parent

Returns

QWidget*

Reimplemented in Isis::StretchTool, Isis::FindTool, Isis::StatisticsTool, Isis::FeatureNomenclatureTool, Isis::EditTool, Isis::ZoomTool, Isis::MeasureTool, Isis::StereoTool, Isis::SpatialPlotTool, Isis::SpectralPlotTool, Isis::AbstractPlotTool, Isis::BandTool, Isis::SunShadowTool, Isis::HistogramTool, Isis::ScatterPlotTool, and Isis::PanTool.

Referenced by addToActive().

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

inlineprotected

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(), Isis::ScatterPlotTool::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(), Isis::ScatterPlotTool::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().

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

protected

Return the list of cubeviewports.

Returns

CubeViewportList*

References Isis::Workspace::cubeViewportList().

Referenced by Isis::FileTool::closeAll(), Isis::MatchTool::createPoint(), Isis::BlinkTool::eventFilter(), Isis::PanTool::mouseButtonRelease(), Isis::RubberBandTool::mouseButtonRelease(), Isis::RubberBandTool::mouseMove(), Isis::ScatterPlotTool::repaintViewports(), Isis::AbstractPlotTool::repaintViewports(), Isis::ZoomTool::rubberBandComplete(), Isis::FeatureNomenclatureTool::setFontColor(), Isis::FeatureNomenclatureTool::setFontSize(), Isis::FeatureNomenclatureTool::setShowApprovedOnly(), Isis::FeatureNomenclatureTool::setVectorType(), Isis::StretchTool::stretchGlobalAllViewports(), Isis::MeasureTool::updateMeasure(), Isis::WindowTool::updateTool(), Isis::BlinkTool::updateTool(), Isis::FindTool::updateTool(), and Isis::AbstractPlotTool::viewportsToPlot().

void Isis::Tool::enableRubberBandTool ( )

protectedvirtual

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

virtual QString Isis::Tool::menuName ( ) const

inlinevirtual

Anytime a tool is created, you must give it a name for the menu.

Returns

QString

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

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

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

protectedvirtualslot

Parameters

p
s

References clearWarningSignal().

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

protectedvirtualslot

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

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

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

protectedvirtualslot

Parameters

p

References clearWarningSignal().

virtual void Isis::Tool::mouseEnter ( )

inlineprotectedvirtualslot

virtual void Isis::Tool::mouseLeave ( )

inlineprotectedvirtualslot

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

protectedvirtualslot

Parameters

p

virtual void Isis::Tool::mouseMove ( QPoint  p, Qt::MouseButton    )

inlineprotectedvirtualslot

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

inlinevirtual

Parameters

vp
painter

Reimplemented in Isis::QnetTool, Isis::MatchTool, Isis::FindTool, Isis::FeatureNomenclatureTool, Isis::RubberBandTool, Isis::StereoTool, Isis::IpceTool, Isis::SunShadowTool, Isis::AbstractPlotTool, and Isis::ScatterPlotTool.

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

protectedslot

Registers the tool to the viewport.

Parameters

viewport

References Isis::MdiCubeViewport::registerTool(), and stretchRequested().

Referenced by addTo().

virtual void Isis::Tool::removeConnections ( MdiCubeViewport *  cvp )

inlineprotectedvirtual

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.

virtual void Isis::Tool::rubberBandComplete ( )

inlineprotectedvirtualslot

RubberBandTool * Isis::Tool::rubberBandTool

(

)

References Isis::ToolList::rubberBandTool().

Referenced by Isis::MeasureTool::createToolBarWidget(), Isis::HistogramTool::enableRubberBandTool(), Isis::SpectralPlotTool::enableRubberBandTool(), Isis::SpatialPlotTool::enableRubberBandTool(), Isis::StereoTool::enableRubberBandTool(), Isis::MeasureTool::enableRubberBandTool(), Isis::ZoomTool::enableRubberBandTool(), Isis::EditTool::enableRubberBandTool(), Isis::StretchTool::enableRubberBandTool(), enableRubberBandTool(), Isis::HistogramTool::refreshPlot(), Isis::SpatialPlotTool::refreshPlot(), Isis::SpectralPlotTool::refreshPlot(), Isis::RubberBandComboBox::RubberBandComboBox(), Isis::HistogramTool::rubberBandComplete(), Isis::MeasureTool::rubberBandComplete(), Isis::SpectralPlotTool::rubberBandComplete(), Isis::SpatialPlotTool::rubberBandComplete(), Isis::ZoomTool::rubberBandComplete(), Isis::StereoTool::rubberBandComplete(), Isis::EditTool::rubberBandComplete(), Isis::StretchTool::rubberBandComplete(), and Isis::RubberBandComboBox::selectionChanged().

virtual void Isis::Tool::scaleChanged ( )

inlineprotectedvirtualslot

Reimplemented in Isis::RubberBandTool.

virtual void Isis::Tool::screenPixelsChanged ( )

inlineprotectedvirtualslot

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

void Isis::Tool::setCubeViewport ( MdiCubeViewport *  cvp )

slot

Sets the current viewport to the given cvp.

Parameters

cvp

References updateTool(), and viewportChanged().

Referenced by addTo(), and Isis::FileTool::closeAll().

void Isis::Tool::setList

(

ToolList *

currentList

)

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

virtual void Isis::Tool::stretchRequested ( MdiCubeViewport *  , int    )

inlineprotectedvirtualslot

Reimplemented in Isis::StretchTool.

Referenced by registerTool().

void Isis::Tool::toolActivated ( )

signal

Referenced by activate(), Isis::FeatureNomenclatureTool::FeatureNomenclatureTool(), Isis::MatchTool::MatchTool(), and Isis::StereoTool::StereoTool().

QString Isis::Tool::toolIconDir ( ) const

inline

returns the path to the icon directory.

Returns

QString

Referenced by Isis::AdvancedTrackTool::AdvancedTrackTool(), Isis::BlinkTool::BlinkTool(), Isis::PanTool::createToolBarWidget(), Isis::BandTool::createToolBarWidget(), Isis::StereoTool::createToolBarWidget(), Isis::ZoomTool::createToolBarWidget(), Isis::EditTool::createToolBarWidget(), Isis::FindTool::createToolBarWidget(), Isis::StretchTool::createToolBarWidget(), Isis::MatchTool::createToolBarWidget(), Isis::FileTool::FileTool(), Isis::FindTool::FindTool(), Isis::HelpTool::HelpTool(), Isis::HistogramTool::HistogramTool(), Isis::PanTool::PanTool(), Isis::SpecialPixelTool::SpecialPixelTool(), Isis::RubberBandComboBox::toolIconDir(), Isis::PanTool::toolPadAction(), Isis::ScatterPlotTool::toolPadAction(), Isis::HistogramTool::toolPadAction(), Isis::BandTool::toolPadAction(), Isis::SunShadowTool::toolPadAction(), Isis::IpceTool::toolPadAction(), Isis::SpectralPlotTool::toolPadAction(), Isis::SpatialPlotTool::toolPadAction(), Isis::MeasureTool::toolPadAction(), Isis::StereoTool::toolPadAction(), Isis::ZoomTool::toolPadAction(), Isis::EditTool::toolPadAction(), Isis::FeatureNomenclatureTool::toolPadAction(), Isis::StatisticsTool::toolPadAction(), Isis::FindTool::toolPadAction(), Isis::StretchTool::toolPadAction(), Isis::MatchTool::toolPadAction(), Isis::QnetTool::toolPadAction(), Isis::WindowTool::WindowTool(), and Isis::ZoomTool::ZoomTool().

virtual QAction* Isis::Tool::toolPadAction ( ToolPad *  toolpad )

inlineprotectedvirtual

Anytime a tool is created, you must setup a tool pad action with it.

Parameters

toolpad

Returns

QAction*

Reimplemented in Isis::QnetTool, Isis::MatchTool, Isis::StretchTool, Isis::FindTool, Isis::StatisticsTool, Isis::FeatureNomenclatureTool, Isis::EditTool, Isis::ZoomTool, Isis::MeasureTool, Isis::StereoTool, Isis::SpatialPlotTool, Isis::SpectralPlotTool, Isis::IpceTool, Isis::SunShadowTool, Isis::BandTool, Isis::HistogramTool, Isis::ScatterPlotTool, and Isis::PanTool.

Referenced by addTo().

virtual void Isis::Tool::updateMeasure ( )

inlineprotectedvirtualslot

void Isis::Tool::updateTool ( )

virtualslot

Updates the tool.

Reimplemented in Isis::StretchTool, Isis::FindTool, Isis::FeatureNomenclatureTool, Isis::EditTool, Isis::FileTool, Isis::ZoomTool, Isis::MeasureTool, Isis::SpatialPlotTool, Isis::SpectralPlotTool, Isis::AbstractPlotTool, Isis::SunShadowTool, Isis::BandTool, Isis::HistogramTool, Isis::SpecialPixelTool, Isis::BlinkTool, and Isis::WindowTool.

Referenced by setCubeViewport().

void Isis::Tool::viewportChanged ( )

signal

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

Workspace * Isis::Tool::workspace ( )

protected

Referenced by Isis::ScatterPlotTool::showNewScatterPlotConfig().

---

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

• src/qisis/objs/Tool/Tool.h
• src/qisis/objs/Tool/moc_Tool.cpp
• src/qisis/objs/Tool/Tool.cpp