USGS Astrogeology Isis API

This tool is part of the Qisis namespace and allows interactive editing of displayed images.

Definition at line 65 of file EditTool.h.


Public Types
	Point
	point
	HorizLine
	horizontal line
	VertLine
	vertical line
	StartEndLine
	start-end line
	Rectangle
	rectangle
	UserDn
	User Selected DN value.
	Null
	Null DN value.
	Hrs
	High representation saturation DN value.
	Lrs
	Low representation saturation DN value.
	His
	High instrument saturation DN value.
	Lis
	Low instrument satruation DN value.
enum	EditShape { Point, HorizLine, VertLine, StartEndLine, Rectangle }
	Enum for possible shapes. More...
enum	ReplacementValue { UserDn, Null, Hrs, Lrs, His, Lis }
	Enum for DN values. More...
Signals
void	cubeChanged (bool)
	Emitted when cube changed.
void	save ()
	Emitted when cube should be saved.
void	saveAs ()
	Emitted when cube should be saved as another file.
Public Member Functions
	EditTool (QWidget *parent)
	Constructs and EditTool object.
Protected Slots
void	mouseButtonRelease (QPoint p, Qt::MouseButton m)
	This is a slot called when any mouse button is released inside of a viewport.
virtual void	enableRubberBandTool ()
	This method sets up the RubberBandTool depending on which mode is enabled.
void	rubberBandComplete ()
	This method is called any time the RubberBandTool is complete.
Protected Member Functions
QAction *	toolPadAction (ToolPad *pad)
	Adds the EditTool to the tool pad.
QWidget *	createToolBarWidget (QStackedWidget *active)
	Creates the toolbar containing the edit tool widgets.
void	updateTool ()
	This is a virtual function belonging to the Tool class which is called when the user selects a different viewport.
Private Slots
void	selectValType (int index)
	This is a private slot which is called when the user selects a new dn type.
void	changeDn ()
	This is a private slot called when the user hits the enter key after typing a value in the dnLineEdit field.
void	undoEdit ()
	This is a private slot called when the user selects the undo button.
void	undoAll (CubeViewport *vp)
	This method is used to discard any changes made to this viewport.
void	redoEdit ()
	This method is called to redo any edit operations that have been undone.
void	save (CubeViewport *vp)
	This method saves by removing any undo history for the viewport vp and reopening the cube.
void	removeViewport (QObject *vp)
	This is a private slot called to clean up when a viewport is destroyed.
Private Member Functions
QList< QPoint * > *	LineToPoints (const QLine &line)
	Convert rubber band line to points.
void	writeToCube (int iesamp, int issamp, int ieline, int isline, QList< QPoint * > *linePts)
Private Attributes
QComboBox *	p_shapeComboBox
	Shape combobox.
QComboBox *	p_valTypeComboBox
	Value type combobox.
QLineEdit *	p_dnLineEdit
	DN edit line.
QToolButton *	p_undoButton
	Undo button.
QToolButton *	p_redoButton
	Redo button.
QToolButton *	p_saveButton
	Save button.
QToolButton *	p_saveAsButton
	Save as button.
double	p_dn
	DN value.
QMap< CubeViewport , QStack< Isis::Brick > * >	p_undoEdit
	Viewport to brick map for undo.
QMap< CubeViewport , QStack< Isis::Brick > * >	p_redoEdit
	Viewport to brick map for redo.
QMap< CubeViewport *, int >	p_saveMarker
	Marker for last save.

Member Enumeration Documentation

enum Qisis::EditTool::EditShape

Enum for possible shapes.

Enumerator:

Point	point
HorizLine	horizontal line
VertLine	vertical line
StartEndLine	start-end line
Rectangle	rectangle

Definition at line 79 of file EditTool.h.

enum Qisis::EditTool::ReplacementValue

Enum for DN values.

Enumerator:

UserDn	User Selected DN value.
Null	Null DN value.
Hrs	High representation saturation DN value.
Lrs	Low representation saturation DN value.
His	High instrument saturation DN value.
Lis	Low instrument satruation DN value.

Definition at line 91 of file EditTool.h.

Constructor & Destructor Documentation

Qisis::EditTool::EditTool ( QWidget * parent )

Constructs and EditTool object.

Parameters:

parent

Parent widget

Definition at line 42 of file EditTool.cpp.

References Isis::Null, and p_dn.

Member Function Documentation

void Qisis::EditTool::changeDn ( ) [private, slot]

This is a private slot called when the user hits the enter key after typing a value in the dnLineEdit field.

Definition at line 213 of file EditTool.cpp.

References p_dn, and p_dnLineEdit.

Referenced by createToolBarWidget().

QWidget * Qisis::EditTool::createToolBarWidget ( QStackedWidget * active ) [protected]

Creates the toolbar containing the edit tool widgets.

Parameters:

active

input The widget that will contain the edit tool specific widgets

History:: 2007-08-31 Tracie Sucharski - Changed signal on dn line edit from returnPressed to editingFinished.

Returns:: QWidget*

Definition at line 78 of file EditTool.cpp.

References changeDn(), enableRubberBandTool(), p_dnLineEdit, p_redoButton, p_saveAsButton, p_saveButton, p_shapeComboBox, p_undoButton, p_valTypeComboBox, redoEdit(), save(), saveAs(), selectValType(), and undoEdit().

void Qisis::EditTool::cubeChanged ( bool ) [signal]

Emitted when cube changed.

Referenced by redoEdit(), undoEdit(), and writeToCube().

void Qisis::EditTool::enableRubberBandTool ( ) [protected, virtual, slot]

This method sets up the RubberBandTool depending on which mode is enabled.

If a valid RubberBandTool mode is not enabled the RubberBandTool is disabled.

Definition at line 886 of file EditTool.cpp.

References Qisis::RubberBandTool::disable(), Qisis::RubberBandTool::enable(), and p_shapeComboBox.

Referenced by createToolBarWidget().

QList< QPoint * > * Qisis::EditTool::LineToPoints ( const QLine & line ) [private]

Convert rubber band line to points.

This routine takes two points (sx,sy) and (ex,ey) and determines all the points which make up that line segment. This is useful for drawing graphic on a display or image

Author:: Jan 1 1996 Jeff Anderson, Original version

Parameters:

line

input Line to be converted to points

Returns:: QList<QPoint*>* A pointer to a QList of points representing line

Definition at line 803 of file EditTool.cpp.

References ex, x, and y.

Referenced by rubberBandComplete().

void Qisis::EditTool::mouseButtonRelease	(	QPoint	p,
		Qt::MouseButton	m
	)			`[protected, slot]`

This is a slot called when any mouse button is released inside of a viewport.

Parameters:

	p	input The point under the cursor
	m	input Mouse button released (left,middle,right)

History:: 2007-03-02 Tracie Sucharski - Reopen cube read/write Workspace::addCubeViewport was opening cube read/write, changed to open read only so that the cube date was not changed unless EditTool is invoked.

History:: 2007-02-26 Tracie Sucharski - Remove test for off image editing. It is no longer needed since the bug in the Cube class is fixed.

History:: 2008-05-23 Noah Hilt - Removed the rectangle and start/end line functionality from the mouseButtonRelease and moved it to the rubberBandComplete method.

Definition at line 375 of file EditTool.cpp.

References Qisis::CubeViewport::cube(), Qisis::CubeViewport::cubeLines(), Qisis::CubeViewport::cubeSamples(), e, Qisis::CubeViewport::grayBand(), HorizLine, Qisis::CubeViewport::isColor(), Isis::Cube::IsReadOnly(), Isis::Cube::Lines(), p_dn, p_dnLineEdit, p_shapeComboBox, p_valTypeComboBox, Isis::Cube::PixelType(), Point, Isis::Cube::Read(), Isis::Cube::ReOpen(), Isis::Cube::Samples(), Isis::Brick::SetBasePosition(), UserDn, VertLine, Qisis::CubeViewport::viewportToCube(), and writeToCube().

void Qisis::EditTool::redoEdit ( ) [private, slot]

This method is called to redo any edit operations that have been undone.

Definition at line 668 of file EditTool.cpp.

References Qisis::CubeViewport::cube(), cubeChanged(), Qisis::CubeViewport::cubeChanged(), Qisis::CubeViewport::cubeContentsChanged(), Qisis::CubeViewport::grayBand(), Isis::Cube::IsReadOnly(), Isis::Buffer::Line(), Isis::Buffer::LineDimension(), p_redoButton, p_redoEdit, p_saveButton, p_undoButton, p_undoEdit, Isis::Cube::PixelType(), Isis::Cube::Read(), Isis::Buffer::Sample(), Isis::Buffer::SampleDimension(), Isis::Brick::SetBasePosition(), Qisis::CubeViewport::setCaption(), and Isis::Cube::Write().

Referenced by createToolBarWidget().

void Qisis::EditTool::removeViewport ( QObject * vp ) [private, slot]

This is a private slot called to clean up when a viewport is destroyed.

This viewport is removed from the undoEdit hash.

Parameters:

input Viewport to be removed from the undo edit hash

Definition at line 767 of file EditTool.cpp.

References p_redoEdit, and p_undoEdit.

Referenced by updateTool().

void Qisis::EditTool::rubberBandComplete ( ) [protected, slot]

This method is called any time the RubberBandTool is complete.

It checks if the viewport is writable, checks which mode it is in, either line or rectangle, and if RubberBandTool is valid. It then writes the data from the RubberBandTool to the cube.

Definition at line 262 of file EditTool.cpp.

References Qisis::CubeViewport::cube(), Qisis::CubeViewport::cubeLines(), Qisis::CubeViewport::cubeSamples(), e, Qisis::RubberBandTool::getVertices(), Qisis::CubeViewport::isColor(), Isis::Cube::IsReadOnly(), Qisis::RubberBandTool::isValid(), LineToPoints(), p_shapeComboBox, Qisis::RubberBandTool::rectangle(), Rectangle, Isis::Cube::ReOpen(), StartEndLine, Qisis::CubeViewport::viewportToCube(), and writeToCube().