Isis::FindTool Class Reference

Tool to locate a point on a cube that is projected and/or has a camera model. More...

#include <FindTool.h>

Public Slots
void	activate (bool)
	Activates the tool.
void	setCubeViewport (MdiCubeViewport *cvp)
	Sets the current viewport to the given cvp.
Signals
void	recordPoint (QPoint p)
	Emitted when point should be recorded.
void	clearWarningSignal ()
void	viewportChanged ()
Public Member Functions
	FindTool (QWidget *parent)
	Constructs a FindTool object.
	~FindTool ()
void	addTo (QMenu *menu)
	Adds the find tool to the menu.
void	paintViewport (MdiCubeViewport vp, QPainter painter)
	This method paints the viewport.
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.
Protected Types
typedef QVector < MdiCubeViewport * >	CubeViewportList
	A list of cubeviewports.
Protected Slots
void	mouseButtonRelease (QPoint p, Qt::MouseButton s)
	Handles mouse clickes in the CubeViewport.
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	mouseMove (QPoint p, Qt::MouseButton)
virtual void	mouseLeave ()
virtual void	mouseDoubleClick (QPoint p)
virtual void	mouseButtonPress (QPoint p, Qt::MouseButton s)
virtual void	updateMeasure ()
virtual void	scaleChanged ()
virtual void	stretchRequested (MdiCubeViewport *, int)
void	registerTool (MdiCubeViewport *viewport)
	Registers the tool to the viewport.
Protected Member Functions
QAction *	toolPadAction (ToolPad *toolpad)
	Adds the find tool to the toolpad.
QString	menuName () const
	This method returns the menu name associated with this tool.
QWidget *	createToolBarWidget (QStackedWidget *parent)
	Creates the tool bar for the find tool.
void	updateTool ()
	Overriden method to update this tool - Checks if cube is open and checks if the image has camera and/or projection or none and sets the flags accordingly.
void	createDialog (QWidget *parent)
	Creates the dialog used by this 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.
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.
Protected Attributes
MdiCubeViewport *	p_cvp
	current cubeviewport
Workspace *	p_workspace

Detailed Description

Tool to locate a point on a cube that is projected and/or has a camera model.

This tool is part of the Qisis namespace and allows the user to locate a point on a cube that has been projected and/or has a camera model. It also allows the user to link viewports and sync scales.

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

Member Typedef Documentation

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

A list of cubeviewports.

Constructor & Destructor Documentation

Isis::FindTool::FindTool ( QWidget * parent )

Constructs a FindTool object.

Parameters:

parent

Isis::FindTool::~FindTool ( )

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

Adds the find tool to the 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().

void Isis::FindTool::createDialog ( QWidget * parent ) [protected]

Creates the dialog used by this tool.

Parameters:

parent

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

Creates the tool bar for the find tool.

Parameters:

parent

Returns:: QWidget*

Reimplemented from Isis::Tool.

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

Return the current cubeviewport.

Returns:: CubeViewport*

References Isis::Tool::p_cvp.

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

void 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::StretchTool, and Isis::ZoomTool.

References Isis::RubberBandTool::disable().

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

This method returns the menu name associated with this tool.

Returns:: QString

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 Isis::FindTool::mouseButtonRelease	(	QPoint	p,
		Qt::MouseButton	s
	)			`[protected, virtual, slot]`

Handles mouse clickes in the CubeViewport.

Uses the point where click occurred to calculate line/samp or lat/lon (if there is a camera).

Parameters:

	p
	s

Reimplemented from Isis::Tool.

References Isis::UniversalGroundMap::Line(), Isis::UniversalGroundMap::Sample(), and Isis::UniversalGroundMap::SetUniversalGround().

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]

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

Reimplemented in Isis::AdvancedTrackTool, Isis::MeasureTool, Isis::ScatterPlotTool, and Isis::TrackTool.

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.

void Isis::FindTool::paintViewport	(	MdiCubeViewport *	vp,
		QPainter *	painter
	)			`[virtual]`

This method paints the viewport.

Parameters:

	vp
	painter

History:: 2010-03-24 Sharmila Prasad - Enable FindTool for no camera image only for Image Point (lines and Samples)

History:: 2010-05-06 Eric Hyer - points now calculated here for every repaint. This method is now used for all images, whether they have a cam or not

Reimplemented from Isis::Tool.

void Isis::FindTool::recordPoint ( QPoint p ) [signal]

Emitted when point should be recorded.

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

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.

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

Reimplemented in Isis::EditTool, Isis::HistogramTool, Isis::MeasureTool, Isis::SpatialPlotTool, Isis::SpectralPlotTool, Isis::StretchTool, and Isis::ZoomTool.

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(), Isis::MeasureTool::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::FindTool::toolPadAction ( ToolPad * toolpad ) [protected, virtual]

Adds the find tool to the toolpad.

Parameters:

toolpad

Returns:: QAction*

Reimplemented from Isis::Tool.

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

Reimplemented in Isis::MeasureTool.

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

Overriden method to update this tool - Checks if cube is open and checks if the image has camera and/or projection or none and sets the flags accordingly.

Also checks whether the images are linked.