Isis::MosaicControlNetTool Class Reference

//TODO: Remove debug printout & comment More...

#include <MosaicControlNetTool.h>

Inherits Isis::MosaicTool.

Public Types
enum	MovementColorSource { NoMovement = 0, NoColor, MeasureCount, ResidualMagnitude }
	This enum defines how to draw the movement arrows (arrows from CP A Priori location to adjusted location). More...

Public Slots
void	activate (bool)
	Activates the tool.

Signals
void	activated (bool)

Public Member Functions
	MosaicControlNetTool (MosaicSceneWidget *)
	MosaicControlNetTool constructor.
	~MosaicControlNetTool ()
void	addToMenu (QMenu *menu)
PvlObject	toPvl () const
void	fromPvl (const PvlObject &obj)
QString	projectPvlObjectName () const
void	setMovementArrowColorSource (MovementColorSource, int, double)
	Define how the movement arrows should be drawn.
MovementColorSource	movementArrowColorSource () const
	Get the current setting for the movement arrows.
int	maxMovementColorMeasureCount () const
	Get the current measure count to become fully colored.
double	maxMovementColorResidualMagnitude () const
	Get the current max.
bool	isActive () const
	Returns the activeness of this toool.
QPixmap	getIcon (QString iconName) const
	returns the path to the icon directory.
virtual void	addTo (QMenu *menu)
virtual void	addTo (ToolPad *toolPad)
virtual void	addTo (QToolBar *toolBar)
virtual QList< QAction * >	getViewActions ()

Static Public Member Functions
static QString	toString (MovementColorSource)
	Convert a MovementColorSource to a string for serialization purposes.
static MovementColorSource	fromMovementColorSourceString (QString)
	Convert a string back to a MovementColorSource (for serialization purposes).

Static Public Attributes
static const int	NUM_MOVEMENT_COLOR_SOURCE_VALUES = 4
	This is the count of possible values of MovementColorSource (useful for loops).

Protected Slots
virtual void	mouseEnter ()
virtual void	mouseMove (QPointF)
virtual void	mouseLeave ()
virtual void	mouseDoubleClick (QPointF)
virtual void	mouseButtonPress (QPointF, Qt::MouseButton s)
virtual void	mouseWheel (QPointF, int delta)
virtual void	rubberBandComplete (QRectF r, Qt::MouseButton s)
void	toolBarDestroyed (QObject *obj)

Protected Member Functions
QAction *	getPrimaryAction ()
	Adds the action to the toolpad.
QWidget *	getToolBarWidget ()
	This method returns a widget that will be put in a tool bar when the tool is activated.
void	mouseButtonRelease (QPointF, Qt::MouseButton s)
MosaicSceneWidget *	getWidget ()

Detailed Description

//TODO: Remove debug printout & comment

Handles Control Net displays

Author

????-??-?? Christopher Austin

Member Enumeration Documentation

enum Isis::MosaicControlNetTool::MovementColorSource

This enum defines how to draw the movement arrows (arrows from CP A Priori location to adjusted location).

These settings include whether the arrows are shown and how to color them.

NOTE: It's important to start at zero. Also, if you add to this enumeration, be sure to update NUM_MOVEMENT_COLOR_SOURCE_VALUES.

Enumerator:

NoMovement	Do not show movement arrows.
NoColor	Show black movement arrows.
MeasureCount	Show movement arrows colored by measure count.
ResidualMagnitude	Show movement arrows colored by residual magnitude.

Constructor & Destructor Documentation

Isis::MosaicControlNetTool::MosaicControlNetTool

(

MosaicSceneWidget *

scene

)

MosaicControlNetTool constructor.

Parameters

parent

References NoMovement.

Isis::MosaicControlNetTool::~MosaicControlNetTool

(

)

Member Function Documentation

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

slotinherited

Activates the tool.

Parameters

on

References Isis::MosaicTool::activated().

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

void Isis::MosaicTool::activated ( bool  _t1 )

signalinherited

Referenced by Isis::MosaicTool::activate(), Isis::MosaicGridTool::getToolBarWidget(), and Isis::MosaicTool::MosaicTool().

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

inlinevirtualinherited

Referenced by Isis::MosaicSceneWidget::addTo(), Isis::MosaicSceneWidget::getControlNetHelp(), and Isis::MosaicSceneWidget::getGridHelp().

void Isis::MosaicTool::addTo ( ToolPad *  toolPad )

virtualinherited

References Isis::MosaicTool::activate(), Isis::ToolPad::addAction(), and Isis::MosaicTool::getPrimaryAction().

void Isis::MosaicTool::addTo ( QToolBar *  toolBar )

virtualinherited

References Isis::MosaicTool::getToolBarWidget(), and Isis::MosaicTool::toolBarDestroyed().

void Isis::MosaicControlNetTool::addToMenu

(

QMenu *

menu

)

MosaicControlNetTool::MovementColorSource Isis::MosaicControlNetTool::fromMovementColorSourceString ( QString  string )

static

Convert a string back to a MovementColorSource (for serialization purposes).

References NoMovement, NUM_MOVEMENT_COLOR_SOURCE_VALUES, and toString().

Referenced by fromPvl().

void Isis::MosaicControlNetTool::fromPvl ( const PvlObject &  obj )

virtual

Reimplemented from Isis::MosaicTool.

References fromMovementColorSourceString(), Isis::PvlObject::hasKeyword(), Isis::toBool(), Isis::toDouble(), and Isis::toInt().

QPixmap Isis::MosaicTool::getIcon ( QString  iconName ) const

inherited

returns the path to the icon directory.

Returns

QString

References Isis::FileName::expanded().

Referenced by Isis::MosaicSelectTool::getPrimaryAction(), Isis::MosaicPanTool::getPrimaryAction(), Isis::MosaicZoomTool::getPrimaryAction(), Isis::MosaicAreaTool::getPrimaryAction(), Isis::MosaicFindTool::getPrimaryAction(), getPrimaryAction(), Isis::MosaicGridTool::getPrimaryAction(), and Isis::MosaicZoomTool::MosaicZoomTool().

QAction * Isis::MosaicControlNetTool::getPrimaryAction ( )

protectedvirtual

Adds the action to the toolpad.

Parameters

toolpad

Returns

QAction*

Implements Isis::MosaicTool.

References Isis::MosaicTool::getIcon().

QWidget * Isis::MosaicControlNetTool::getToolBarWidget ( )

protectedvirtual

This method returns a widget that will be put in a tool bar when the tool is activated.

This method will only be called once so it can new the widget without a problem.

Reimplemented from Isis::MosaicTool.

QList< QAction * > Isis::MosaicTool::getViewActions ( )

virtualinherited

Reimplemented in Isis::MosaicZoomTool.

Referenced by Isis::MosaicSceneWidget::getViewActions().

MosaicSceneWidget* Isis::MosaicTool::getWidget ( )

inlineprotectedinherited

Referenced by Isis::MosaicGridTool::autoGrid(), Isis::MosaicAreaTool::clearBox(), Isis::MosaicGridTool::clearGrid(), Isis::MosaicFindTool::clearPoint(), Isis::MosaicGridTool::domainMaxLon(), Isis::MosaicGridTool::domainMinLon(), Isis::MosaicGridTool::drawGrid(), Isis::MosaicGridTool::fromPvl(), Isis::MosaicGridTool::getToolBarWidget(), Isis::MosaicFindTool::getUserGroundPoint(), Isis::MosaicGridTool::latType(), Isis::MosaicGridTool::lonDomain(), Isis::MosaicGridTool::MosaicGridTool(), Isis::MosaicTrackTool::MosaicTrackTool(), Isis::MosaicAreaTool::mouseButtonRelease(), Isis::MosaicFindTool::mouseButtonRelease(), Isis::MosaicZoomTool::mouseWheel(), Isis::MosaicGridTool::onCubesChanged(), Isis::MosaicZoomTool::rubberBandComplete(), Isis::MosaicGridTool::sceneWidget(), Isis::MosaicGridTool::setLatExtents(), Isis::MosaicGridTool::setLonExtents(), Isis::MosaicTrackTool::updateLabels(), Isis::MosaicZoomTool::updateResolutionBox(), Isis::MosaicSelectTool::updateTool(), Isis::MosaicPanTool::updateTool(), Isis::MosaicZoomTool::updateTool(), Isis::MosaicAreaTool::userChangedBox(), and Isis::MosaicZoomTool::zoomFit().

bool Isis::MosaicTool::isActive ( ) const

inlineinherited

Returns the activeness of this toool.

Returns

bool

Referenced by Isis::MosaicZoomTool::mouseButtonRelease(), Isis::MosaicAreaTool::mouseButtonRelease(), Isis::MosaicFindTool::mouseButtonRelease(), mouseButtonRelease(), Isis::MosaicZoomTool::rubberBandComplete(), Isis::MosaicSelectTool::updateTool(), Isis::MosaicPanTool::updateTool(), Isis::MosaicZoomTool::updateTool(), and Isis::MosaicFindTool::updateTool().

int Isis::MosaicControlNetTool::maxMovementColorMeasureCount

(

)

const

Get the current measure count to become fully colored.

This will return -1 if it's undefined.

Referenced by toPvl().

double Isis::MosaicControlNetTool::maxMovementColorResidualMagnitude

(

)

const

Get the current max.

residual magnitude to become fully colored. This will return Null if it's undefined.

References Isis::IsSpecial(), and Isis::Null.

Referenced by toPvl().

void Isis::MosaicTool::mouseButtonPress ( QPointF  , Qt::MouseButton  s  )

protectedvirtualslotinherited

Referenced by Isis::MosaicTool::MosaicTool().

void Isis::MosaicControlNetTool::mouseButtonRelease ( QPointF  point, Qt::MouseButton  s  )

protectedvirtual

Reimplemented from Isis::MosaicTool.

References Isis::MosaicTool::isActive().

void Isis::MosaicTool::mouseDoubleClick ( QPointF  )

protectedvirtualslotinherited

Referenced by Isis::MosaicTool::MosaicTool().

virtual void Isis::MosaicTool::mouseEnter ( )

inlineprotectedvirtualslotinherited

Referenced by Isis::MosaicTool::MosaicTool().

virtual void Isis::MosaicTool::mouseLeave ( )

inlineprotectedvirtualslotinherited

Referenced by Isis::MosaicTool::MosaicTool().

void Isis::MosaicTool::mouseMove ( QPointF  )

protectedvirtualslotinherited

Referenced by Isis::MosaicTool::MosaicTool().

void Isis::MosaicTool::mouseWheel ( QPointF  , int  delta  )

protectedvirtualslotinherited

Reimplemented in Isis::MosaicZoomTool.

Referenced by Isis::MosaicTool::MosaicTool().

MosaicControlNetTool::MovementColorSource Isis::MosaicControlNetTool::movementArrowColorSource

(

)

const

Get the current setting for the movement arrows.

QString Isis::MosaicControlNetTool::projectPvlObjectName ( ) const

virtual

Reimplemented from Isis::MosaicTool.

Referenced by toPvl().

virtual void Isis::MosaicTool::rubberBandComplete ( QRectF  r, Qt::MouseButton  s  )

inlineprotectedvirtualslotinherited

Reimplemented in Isis::MosaicZoomTool.

Referenced by Isis::MosaicTool::MosaicTool().

void Isis::MosaicControlNetTool::setMovementArrowColorSource	(	MovementColorSource	colorSource,
		int	maxMeasureCount,
		double	maxResidualMagnitude
	)

Define how the movement arrows should be drawn.

This includes if movement arrows should be drawn, what criteria should be used, and how to stretch (where to transition colors) the arrows.

NOTE: This is just a quick implementation and is probably not designed correctly. This is subject to change.

Parameters

colorSource	If and how to draw and color the arrows
maxMeasureCount	The measure count to become fully colored
maxResidualMagnitude	The max residual magnitude to become fully colored

References MeasureCount, NoMovement, ResidualMagnitude, and Isis::ControlNetGraphicsItem::setArrowsVisible().

void Isis::MosaicTool::toolBarDestroyed ( QObject *  obj )

protectedslotinherited

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

PvlObject Isis::MosaicControlNetTool::toPvl ( ) const

virtual

Reimplemented from Isis::MosaicTool.

References maxMovementColorMeasureCount(), maxMovementColorResidualMagnitude(), Isis::Null, projectPvlObjectName(), toString(), and Isis::toString().

QString Isis::MosaicControlNetTool::toString ( MovementColorSource  source )

static

Convert a MovementColorSource to a string for serialization purposes.

References MeasureCount, NoColor, NoMovement, and ResidualMagnitude.

Referenced by fromMovementColorSourceString(), and toPvl().

Member Data Documentation

const int Isis::MosaicControlNetTool::NUM_MOVEMENT_COLOR_SOURCE_VALUES = 4

static

This is the count of possible values of MovementColorSource (useful for loops).

Referenced by fromMovementColorSourceString().

---

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

• src/qisis/objs/MosaicSceneWidget/MosaicControlNetTool.h
• src/qisis/objs/MosaicSceneWidget/MosaicControlNetTool.cpp