The GUI communication mechanism for target body objects. More...

#include <GuiCameraDisplayProperties.h>

Inheritance diagram for Isis::GuiCameraDisplayProperties:

Collaboration diagram for Isis::GuiCameraDisplayProperties:

Public Types
enum	Property { None = 0, Color = 1, Selected = 2, ShowLabel = 16 }
	This is a list of properties and actions that are possible. More...

Public Slots
void	setColor (QColor newColor)
	Change the color associated with this target. More...

void	setShowLabel (bool)
	Change the visibility of the display name associated with this target. More...

void	setSelected (bool)
	Change the selected state associated with this target. More...

Signals
void	propertyChanged (GuiCameraDisplayProperties *)

void	supportAdded (Property)

void	propertyChanged (DisplayProperties *)

void	supportAdded (int)

Public Member Functions
	GuiCameraDisplayProperties (QString displayName, QObject *parent=NULL)
	GuiCameraDisplayProperties constructor. More...

	GuiCameraDisplayProperties (XmlStackedHandlerReader xmlReader, QObject parent=NULL)
	GuiCameraDisplayProperties constructor. More...

virtual	~GuiCameraDisplayProperties ()
	destructor More...

void	addSupport (Property prop)
	Convert to Pvl for project files. More...

bool	supports (Property prop)
	Support may come later, please make sure you are connected to the supportAdded signal. More...

QVariant	getValue (Property prop) const
	Get a property's associated data. More...

void	save (QXmlStreamWriter &stream, const Project *project, FileName newProjectRoot) const
	Write the Gui Camera Display Properties out to an XML file. More...

void	fromPvl (const PvlObject &pvl)

PvlObject	toPvl () const
	Convert to Pvl for project files. More...

void	addSupport (int property)
	Call this with every property you support, otherwise they will not communicate properly between widgets. More...

bool	supports (int property)
	Support may come later, please make sure you are connected to the supportAdded signal. More...

QVariant	getValue (int property) const
	Get a property's associated data. More...

void	setDisplayName (QString displayName)
	Sets display name. More...

QString	displayName () const
	Returns the display name. More...

Static Public Member Functions
static QColor	randomColor ()
	Creates and returns a random color for the intial color of the footprint polygon. More...

Protected Member Functions
void	setValue (int prop, QVariant value)
	This is the generic mutator for properties. More...

Detailed Description

The GUI communication mechanism for target body objects.

This class is the connector between various GUI interfaces for target body objects. We use this to communicate shared properties that various widgets need to know/should react to in a generic way.

This is how this class is supposed to "connect" widgets:

widgetA widgetB widgetC | | | ---—DisplayProperties ----—

When a user selects a target in widgetA, widgetB and widgetC now have a chance to also select the same target. This applies to all shared properties. Some of the properties are actions - such as ?????. This also allows a widget with no ??? (such as a list) to have an option to ???? (if any of the widgets support it*) and have that option work. There is no state associated with ????? - it's an action connected to a signal.

The proper way to detect a target going away is to connect to the destroyed signal (from the parent QObject). Once that is emitted you cannot call any methods on this object.

Author: 2015-05-27 Ken Edmundson

Member Enumeration Documentation

◆ Property

enum Isis::GuiCameraDisplayProperties::Property

This is a list of properties and actions that are possible.

Enumerator
None	Null display property for bit-flag purposes.
Color	The color of the control net, default randomized (QColor)
Selected	The selection state of this control net (bool)
ShowLabel	True if the control net should show its display name (bool)

Constructor & Destructor Documentation

◆ GuiCameraDisplayProperties() [1/2]

Isis::GuiCameraDisplayProperties::GuiCameraDisplayProperties	(	QString	displayName,
		QObject *	parent = `NULL`
	)

GuiCameraDisplayProperties constructor.

This sets default values and constructs the object pointer.

Parameters

displayName	The filename (fully expanded) of the object.
parent	Qt parent object (this is destroyed when parent is destroyed)

References None, randomColor(), setSelected(), and setShowLabel().

◆ GuiCameraDisplayProperties() [2/2]

Isis::GuiCameraDisplayProperties::GuiCameraDisplayProperties	(	XmlStackedHandlerReader *	xmlReader,
		QObject *	parent = `NULL`
	)

GuiCameraDisplayProperties constructor.

Parameters

xmlReader	XML reader class for loading the Gui Camera Display Properties
parent

References None, and Isis::XmlStackedHandlerReader::pushContentHandler().

◆ ~GuiCameraDisplayProperties()

Isis::GuiCameraDisplayProperties::~GuiCameraDisplayProperties ( )

virtual

destructor

Member Function Documentation

◆ addSupport() [1/2]

void Isis::DisplayProperties::addSupport ( int property )

inherited

Call this with every property you support, otherwise they will not communicate properly between widgets.

Parameters

prop	The property you are adding support for

References Isis::DisplayProperties::supportAdded(), and Isis::DisplayProperties::supports().

Referenced by Isis::ImageTreeWidgetItem::ImageTreeWidgetItem(), and Isis::MosaicSceneItem::MosaicSceneItem().

◆ addSupport() [2/2]

void Isis::GuiCameraDisplayProperties::addSupport ( Property prop )

Convert to Pvl for project files.

This stores all of the data associated with all of the properties (but not what is supported). This also s tores the target filename. Call this with every property you support, otherwise they will not communicate properly between widgets.

Parameters

prop	The property you are adding support for

References supportAdded(), and supports().

◆ displayName()

QString Isis::DisplayProperties::displayName ( ) const

inherited

Returns the display name.

Referenced by Isis::Directory::addCnetEditorView(), Isis::MosaicSceneItem::contextMenuEvent(), Isis::DisplayProperties::DisplayProperties(), Isis::ImageTreeWidgetItem::ImageTreeWidgetItem(), Isis::Shape::initFootprint(), Isis::Image::initFootprint(), Isis::MosaicSceneItem::MosaicSceneItem(), Isis::GuiCamera::operator==(), Isis::MosaicSceneItem::reproject(), Isis::DisplayProperties::save(), Isis::ControlDisplayProperties::save(), Isis::ShapeDisplayProperties::save(), save(), Isis::TargetBodyDisplayProperties::save(), Isis::SensorInfoWidget::SensorInfoWidget(), Isis::DisplayProperties::setDisplayName(), Isis::ExportControlNetWorkOrder::setupExecution(), Isis::TargetInfoWidget::TargetInfoWidget(), and Isis::DisplayProperties::toPvl().

◆ fromPvl()

void Isis::DisplayProperties::fromPvl ( const PvlObject & pvl )

inherited

References Isis::DisplayProperties::setDisplayName().

Referenced by Isis::Shape::fromPvl(), and Isis::Image::fromPvl().

◆ getValue() [1/2]

QVariant Isis::DisplayProperties::getValue ( int property ) const

inherited

Get a property's associated data.

Parameters

prop	The property

Referenced by Isis::MosaicSceneItem::color(), Isis::MosaicSceneItem::cubeDisplayChanged(), Isis::MosaicSceneItem::paint(), Isis::ImageListActionWorkOrder::qualifyString(), Isis::MosaicSceneItem::reproject(), Isis::ImageTreeWidgetItem::update(), and Isis::MosaicSceneItem::updateSelection().

◆ getValue() [2/2]

QVariant Isis::GuiCameraDisplayProperties::getValue ( Property prop ) const

Get a property's associated data.

Parameters

prop	The property

Returns: QVariant Returns the value of the property.

◆ propertyChanged [1/2]

void Isis::DisplayProperties::propertyChanged ( DisplayProperties * )

signalinherited

Referenced by Isis::DisplayProperties::setValue().

◆ propertyChanged [2/2]

void Isis::GuiCameraDisplayProperties::propertyChanged ( GuiCameraDisplayProperties * )

signal

◆ randomColor()

QColor Isis::GuiCameraDisplayProperties::randomColor ( )

static

Creates and returns a random color for the intial color of the footprint polygon.

Returns: QColor Returns a random color.

Referenced by GuiCameraDisplayProperties().

◆ save()

void Isis::GuiCameraDisplayProperties::save	(	QXmlStreamWriter &	stream,
		const Project *	project,
		FileName	newProjectRoot
	)		const

Write the Gui Camera Display Properties out to an XML file.

Parameters

stream	The output data stream.
project	Not used in this function.
newProjectRoot	Not used in this function.

References Isis::DisplayProperties::displayName(), and Isis::ReadWrite.

◆ setColor

void Isis::GuiCameraDisplayProperties::setColor ( QColor newColor )

slot

Change the color associated with this target.

Parameters

newColor is the color to associate with this target.

◆ setDisplayName()

void Isis::DisplayProperties::setDisplayName ( QString displayName )

inherited

Sets display name.

Parameters

displayName Display name of the object.

References Isis::DisplayProperties::displayName().

Referenced by Isis::DisplayProperties::fromPvl().

◆ setSelected

void Isis::GuiCameraDisplayProperties::setSelected ( bool newValue )

slot

Change the selected state associated with this target.

Parameters

newValue is the new state associated with this target.

References Selected.

Referenced by GuiCameraDisplayProperties().

◆ setShowLabel

void Isis::GuiCameraDisplayProperties::setShowLabel ( bool newValue )

slot

Change the visibility of the display name associated with this target.

Parameters

newValue Shows/hides the display name of the associated target.

References ShowLabel.

Referenced by GuiCameraDisplayProperties().

◆ setValue()

void Isis::DisplayProperties::setValue	(	int	property,
		QVariant	value
	)

protectedinherited

This is the generic mutator for properties.

Given a value, this will change it and emit propertyChanged if its different and supported.

References Isis::DisplayProperties::propertyChanged(), and Isis::DisplayProperties::supports().

Referenced by Isis::ImageDisplayProperties::ImageDisplayProperties(), Isis::ImageDisplayProperties::setColor(), Isis::ImageDisplayProperties::setSelected(), Isis::ImageDisplayProperties::setShowDNs(), Isis::ImageDisplayProperties::setShowFill(), Isis::ImageDisplayProperties::setShowLabel(), and Isis::ImageDisplayProperties::setShowOutline().

◆ supportAdded [1/2]

void Isis::DisplayProperties::supportAdded ( int )

signalinherited

Referenced by Isis::DisplayProperties::addSupport().

◆ supportAdded [2/2]

void Isis::GuiCameraDisplayProperties::supportAdded ( Property )

signal

Referenced by addSupport().

◆ supports() [1/2]

bool Isis::DisplayProperties::supports ( int property )

inherited

Support may come later, please make sure you are connected to the supportAdded signal.

Returns: True if the property has support, false otherwise

Referenced by Isis::DisplayProperties::addSupport(), Isis::ImageList::allSupport(), Isis::DisplayProperties::setValue(), and Isis::ImageTreeWidgetItem::update().

◆ supports() [2/2]

bool Isis::GuiCameraDisplayProperties::supports ( Property prop )

Support may come later, please make sure you are connected to the supportAdded signal.

Returns: bool Returns true if the property has support, false otherwise.

Referenced by addSupport().

◆ toPvl()

PvlObject Isis::DisplayProperties::toPvl ( ) const

inherited

Convert to Pvl for project files.

This stores all of the data associated with all of the properties (but not what is supported). This also stores the cube filename.

References Isis::DisplayProperties::displayName(), and Isis::ReadWrite.

Referenced by Isis::Shape::toPvl(), and Isis::Image::toPvl().

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

/usgs/pkgs/isis3.9.0_docs/ISIS3/isis/src/qisis/objs/GuiCameraDisplayProperties/GuiCameraDisplayProperties.h
/usgs/pkgs/isis3.9.0_docs/ISIS3/isis/src/qisis/objs/GuiCameraDisplayProperties/GuiCameraDisplayProperties.cpp

Public Types

Public Slots

Signals

Public Member Functions

Static Public Member Functions

Protected Member Functions

Detailed Description

Member Enumeration Documentation

◆ Property

Constructor & Destructor Documentation

◆ GuiCameraDisplayProperties() [1/2]

◆ GuiCameraDisplayProperties() [2/2]

◆ ~GuiCameraDisplayProperties()

Member Function Documentation

◆ addSupport() [1/2]

◆ addSupport() [2/2]

◆ displayName()

◆ fromPvl()

◆ getValue() [1/2]

◆ getValue() [2/2]

◆ propertyChanged [1/2]

◆ propertyChanged [2/2]

◆ randomColor()

◆ save()

◆ setColor

◆ setDisplayName()

◆ setSelected

◆ setShowLabel

◆ setValue()

◆ supportAdded [1/2]

◆ supportAdded [2/2]

◆ supports() [1/2]

◆ supports() [2/2]

◆ toPvl()