Isis::FeatureNomenclatureTool::FeatureDisplayPosition Class Reference

A named feature's position in a viewport. More...

Collaboration diagram for Isis::FeatureNomenclatureTool::FeatureDisplayPosition:

Public Member Functions
	FeatureDisplayPosition ()
	Instantiate a blank feature display position.
	FeatureDisplayPosition (QRect textRect, QRect fullDisplayRect, QList< QPoint > edgePoints)
	Instantiate a feature display position with the given data.
	FeatureDisplayPosition (const FeatureDisplayPosition &other)
	Copy a feature display position.
	~FeatureDisplayPosition ()
	Free the allocated memory.
QRect	textArea () const
	Get the screen pixel rect in viewport screen coordinates that ought to be filled with the textual name.
QRect	displayArea () const
	Get the screen pixel rect in viewport screen coordinates that encapsulates the entire feature.
QList< QPoint >	edgePoints () const
	Get the edge screen pixel points in viewport screen coordinates that circle the feature.
void	swap (FeatureDisplayPosition &other)
	Swap member data with another instance of this class.
FeatureDisplayPosition &	operator= (const FeatureDisplayPosition &rhs)
	Assign the state of rhs to this.This is exception-safe.

Private Attributes
QRect *	m_textRect
	The viewport screen pixel rect which the text will consume.
QRect *	m_fullDisplayRect
	The viewport screen pixel rect which the entire display will use.
QList< QPoint > *	m_edgePoints
	The viewport screen pixel points which the edges are at.

Detailed Description

A named feature's position in a viewport.

This class encapsulates the screen x,y boxes, extents, and edge points of a named feature in a viewport.

Author

2012-03-22 Steven Lambright and Jai Rideout

Definition at line 236 of file FeatureNomenclatureTool.h.

Constructor & Destructor Documentation

FeatureDisplayPosition() [1/3]

Isis::FeatureNomenclatureTool::FeatureDisplayPosition::FeatureDisplayPosition

(

)

Instantiate a blank feature display position.

Definition at line 1285 of file FeatureNomenclatureTool.cpp.

References m_edgePoints, m_fullDisplayRect, and m_textRect.

Referenced by FeatureDisplayPosition(), operator=(), and swap().

FeatureDisplayPosition() [2/3]

Isis::FeatureNomenclatureTool::FeatureDisplayPosition::FeatureDisplayPosition	(	QRect	textRect,
		QRect	fullDisplayRect,
		QList< QPoint >	edgePoints )

Instantiate a feature display position with the given data.

Parameters

textRect	The screen pixel rect in viewport screen coordinates that ought to be filled with the textual name.
fullDisplayRect	The screen pixel rect in viewport screen coordinates that encapsulates the entire feature.
edgePoints	The edge screen pixel points in viewport screen coordinates that circle the feature.

Definition at line 1306 of file FeatureNomenclatureTool.cpp.

References edgePoints(), m_edgePoints, m_fullDisplayRect, and m_textRect.

FeatureDisplayPosition() [3/3]

Isis::FeatureNomenclatureTool::FeatureDisplayPosition::FeatureDisplayPosition

(

const FeatureDisplayPosition &

other

)

Copy a feature display position.

Parameters

other

The position to copy

Definition at line 1322 of file FeatureNomenclatureTool.cpp.

References FeatureDisplayPosition(), m_edgePoints, m_fullDisplayRect, and m_textRect.

~FeatureDisplayPosition()

Isis::FeatureNomenclatureTool::FeatureDisplayPosition::~FeatureDisplayPosition

(

)

Free the allocated memory.

Definition at line 1337 of file FeatureNomenclatureTool.cpp.

References m_edgePoints, m_fullDisplayRect, and m_textRect.

Member Function Documentation

displayArea()

QRect Isis::FeatureNomenclatureTool::FeatureDisplayPosition::displayArea

(

)

const

Get the screen pixel rect in viewport screen coordinates that encapsulates the entire feature.

Returns

Screen pixel rect in viewport screen coordinates

Definition at line 1366 of file FeatureNomenclatureTool.cpp.

References m_fullDisplayRect.

Referenced by Isis::FeatureNomenclatureTool::ViewportFeatureDisplay::paint().

edgePoints()

QList< QPoint > Isis::FeatureNomenclatureTool::FeatureDisplayPosition::edgePoints

(

)

const

Get the edge screen pixel points in viewport screen coordinates that circle the feature.

Returns

Screen pixel edge points in viewport screen coordinates

Definition at line 1377 of file FeatureNomenclatureTool.cpp.

References m_edgePoints.

Referenced by FeatureDisplayPosition(), and Isis::FeatureNomenclatureTool::ViewportFeatureDisplay::paint().

operator=()

FeatureNomenclatureTool::FeatureDisplayPosition & Isis::FeatureNomenclatureTool::FeatureDisplayPosition::operator=

(

const FeatureDisplayPosition &

rhs

)

Assign the state of rhs to this.This is exception-safe.

Parameters

rhs	The position on the right hand side of the '=' operator

Returns

*this

Definition at line 1405 of file FeatureNomenclatureTool.cpp.

References FeatureDisplayPosition(), and swap().

swap()

void Isis::FeatureNomenclatureTool::FeatureDisplayPosition::swap

(

FeatureDisplayPosition &

other

)

Swap member data with another instance of this class.

This trades the state of this with other and will never throw an exception.

Parameters

other

The instance to trade state with

Definition at line 1389 of file FeatureNomenclatureTool.cpp.

References FeatureDisplayPosition(), m_edgePoints, m_fullDisplayRect, and m_textRect.

Referenced by operator=().

textArea()

QRect Isis::FeatureNomenclatureTool::FeatureDisplayPosition::textArea

(

)

const

Get the screen pixel rect in viewport screen coordinates that ought to be filled with the textual name.

Returns

Screen pixel rect in viewport screen coordinates

Definition at line 1355 of file FeatureNomenclatureTool.cpp.

References m_textRect.

Referenced by Isis::FeatureNomenclatureTool::ViewportFeatureDisplay::paint().

Member Data Documentation

m_edgePoints

QList<QPoint>* Isis::FeatureNomenclatureTool::FeatureDisplayPosition::m_edgePoints

private

The viewport screen pixel points which the edges are at.

Definition at line 258 of file FeatureNomenclatureTool.h.

Referenced by edgePoints(), FeatureDisplayPosition(), FeatureDisplayPosition(), FeatureDisplayPosition(), swap(), and ~FeatureDisplayPosition().

m_fullDisplayRect

QRect* Isis::FeatureNomenclatureTool::FeatureDisplayPosition::m_fullDisplayRect

private

The viewport screen pixel rect which the entire display will use.

Definition at line 256 of file FeatureNomenclatureTool.h.

Referenced by displayArea(), FeatureDisplayPosition(), FeatureDisplayPosition(), FeatureDisplayPosition(), swap(), and ~FeatureDisplayPosition().

m_textRect

QRect* Isis::FeatureNomenclatureTool::FeatureDisplayPosition::m_textRect

private

The viewport screen pixel rect which the text will consume.

Definition at line 254 of file FeatureNomenclatureTool.h.

Referenced by FeatureDisplayPosition(), FeatureDisplayPosition(), FeatureDisplayPosition(), swap(), textArea(), and ~FeatureDisplayPosition().

---

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

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