Isis::SunShadowTool Class Reference

Tool for measuring shadow heights. More...

#include <SunShadowTool.h>

Inherits Isis::Tool.

Public Slots
void	activate (bool)
	Activates 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
	SunShadowTool (QWidget *parent)
	Construct a sun shadow tool. More...
void	addTo (QMenu *menu)
	Adds the measure action to the given menu. More...
void	paintViewport (MdiCubeViewport *vp, QPainter *painter)
	Paint anything we need to on the viewport. 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 (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...
RubberBandTool *	rubberBandTool ()
void	setList (ToolList *currentList)

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

Protected Slots
virtual void	mouseMove (QPoint p)
	When the mouse moves, if we're tracking then we go ahead and update all of our calculated values for the shadow measurement. More...
virtual void	mouseButtonPress (QPoint p, Qt::MouseButton s)
	When the mouse left button is pressed we start tracking. More...
virtual void	mouseButtonRelease (QPoint p, Qt::MouseButton s)
	When the mouse left button is released we finish tracking. 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, Qt::MouseButton)
virtual void	mouseLeave ()
virtual void	mouseDoubleClick (QPoint p)
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
QWidget *	createToolBarWidget (QStackedWidget *parent)
	Creates the widget (button) that goes on the tool bar. More...
QAction *	toolPadAction (ToolPad *pad)
	Create an action for activating this tool. More...
void	updateTool ()
	This enables/disables this tool's functionality based on the active viewport's compatibility. More...
MdiCubeViewport *	cubeViewport () const
	Return the current cubeviewport. More...
CubeViewportList *	cubeViewportList () 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...
Workspace *	workspace ()

Detailed Description

Tool for measuring shadow heights.

Author

2012-03-12 Steven Lambright

Member Typedef Documentation

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

protectedinherited

A list of cubeviewports.

Constructor & Destructor Documentation

Isis::SunShadowTool::SunShadowTool

(

QWidget *

parent

)

Construct a sun shadow tool.

Parameters

parent

The qt-parent relationship parent.

References Isis::TableMainWindow::addToTable(), Isis::TableMainWindow::setStatusMessage(), Isis::TableMainWindow::setTrackListItems(), and Isis::Tool::viewportChanged().

Member Function Documentation

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

slotinherited

Activates the tool.

Parameters

on

References Isis::Tool::clearWarningSignal(), and Isis::Tool::toolActivated().

Referenced by Isis::Tool::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 )

inlineprotectedvirtualinherited

Anytime a tool is created, you must add the connections for it.

Parameters

cvp

Reimplemented in Isis::TrackTool, and Isis::WindowTool.

void Isis::SunShadowTool::addTo ( QMenu *  menu )

virtual

Adds the measure action to the given menu.

Parameters

menu

Reimplemented from Isis::Tool.

void Isis::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::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 )

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

Parameters

toolbar

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

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

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

inlinevirtualinherited

Parameters

toolbar

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

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

void Isis::Tool::clearWarningSignal ( )

signalinherited

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

QWidget * Isis::SunShadowTool::createToolBarWidget ( QStackedWidget *  parent )

protectedvirtual

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

Parameters

parent

Returns

QWidget*

Reimplemented from Isis::Tool.

References Isis::Distance::Kilometers, and Isis::Distance::Meters.

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(), 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(), mouseMove(), Isis::TrackTool::mouseMove(), Isis::RubberBandTool::mouseMove(), 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(), 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

protectedinherited

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

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

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 Isis::Tool::addTo(), Isis::CubeDnView::CubeDnView(), and Isis::Workspace::Workspace().

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

protectedvirtualslot

When the mouse left button is pressed we start tracking.

Parameters

p	The current mouse position in viewport screen pixel coordinates
s	The mouse button that was pressed.

References Isis::Cube::camera(), Isis::CubeViewport::cube(), Isis::Tool::cubeViewport(), Isis::Angle::Degrees, Isis::Null, Isis::Camera::SetImage(), Isis::Camera::SunAzimuth(), and Isis::CubeViewport::viewportToCube().

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

protectedvirtualslot

When the mouse left button is released we finish tracking.

Parameters

p	The current mouse position in viewport screen pixel coordinates
s	The mouse button that was pressed.

References mouseMove().

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

protectedvirtualslotinherited

Parameters

p

References Isis::Tool::clearWarningSignal().

virtual void Isis::Tool::mouseEnter ( )

inlineprotectedvirtualslotinherited

virtual void Isis::Tool::mouseLeave ( )

inlineprotectedvirtualslotinherited

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

protectedvirtualslot

When the mouse moves, if we're tracking then we go ahead and update all of our calculated values for the shadow measurement.

Parameters

p	The current mouse position in viewport screen pixel coordinates

References Isis::Tool::cubeViewport(), Isis::Angle::Degrees, Isis::Angle::isValid(), Isis::Angle::radians(), Isis::TableMainWindow::table(), and Isis::CubeViewport::viewportToCube().

Referenced by mouseButtonRelease().

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

inlineprotectedvirtualslotinherited

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

virtual

Paint anything we need to on the viewport.

Currently, we draw a line along where the user is measuring a shadow.

Parameters

vp	Viewport to paint
painter	The painter to use for painting

Reimplemented from Isis::Tool.

References Isis::CubeViewport::cubeToViewport(), Isis::Tool::cubeViewport(), and Isis::Null.

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.

virtual void Isis::Tool::rubberBandComplete ( )

inlineprotectedvirtualslotinherited

RubberBandTool * Isis::Tool::rubberBandTool ( )

inherited

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

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

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

inlineprotectedvirtualslotinherited

Reimplemented in Isis::StretchTool.

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

void Isis::Tool::toolActivated ( )

signalinherited

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

QString Isis::Tool::toolIconDir ( ) const

inlineinherited

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

QAction * Isis::SunShadowTool::toolPadAction ( ToolPad *  toolpad )

protectedvirtual

Create an action for activating this tool.

Parameters

toolpad

The tool pad that will contain the given action

Returns

The created action

Reimplemented from Isis::Tool.

References Isis::Tool::toolIconDir().

virtual void Isis::Tool::updateMeasure ( )

inlineprotectedvirtualslotinherited

void Isis::SunShadowTool::updateTool ( )

protectedvirtual

This enables/disables this tool's functionality based on the active viewport's compatibility.

Reimplemented from Isis::Tool.

References Isis::Cube::camera(), Isis::CubeViewport::cube(), and Isis::Tool::cubeViewport().

void Isis::Tool::viewportChanged ( )

signalinherited

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

Workspace * Isis::Tool::workspace ( )

protectedinherited

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

---

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

• src/qisis/objs/SunShadowTool/SunShadowTool.h
• src/qisis/objs/SunShadowTool/SunShadowTool.cpp