An official website of the United States government
Here’s how you know
Official websites use .gov
A
.gov website belongs to an official government
organization in the United States.
Secure .gov websites use HTTPS
A
lock
( ) or https:// means you’ve safely connected to
the .gov website. Share sensitive information only on official,
secure websites.
Isis Developer Reference
|
This is the GUI communication mechanism for shape objects. More...
#include <ShapeDisplayProperties.h>
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 shape. | |
void | setShowLabel (bool) |
Change the visibility of the display name associated with this shape. | |
void | setSelected (bool) |
Change the selected state associated with this shape. | |
Signals | |
void | propertyChanged (ShapeDisplayProperties *) |
void | supportAdded (Property) |
void | propertyChanged (DisplayProperties *) |
void | supportAdded (int) |
Public Member Functions | |
ShapeDisplayProperties (QString displayName, QObject *parent=NULL) | |
ShapeDisplayProperties constructor. | |
virtual | ~ShapeDisplayProperties () |
The destructor. | |
void | addSupport (Property prop) |
Call this with every property you support, otherwise they will not communicate properly between widgets. | |
bool | supports (Property prop) |
Support for this may come later. | |
QVariant | getValue (Property prop) const |
Get a property's associated data. | |
void | save (QXmlStreamWriter &stream, const Project *project, FileName newProjectRoot) const |
Saves this object to an XML file. | |
void | fromPvl (const PvlObject &pvl) |
PvlObject | toPvl () const |
Convert to Pvl for project files. | |
void | addSupport (int property) |
Call this with every property you support, otherwise they will not communicate properly between widgets. | |
bool | supports (int property) |
Support may come later, please make sure you are connected to the supportAdded signal. | |
QVariant | getValue (int property) const |
Get a property's associated data. | |
void | setDisplayName (QString displayName) |
Sets display name. | |
QString | displayName () const |
Returns the display name. | |
Static Public Member Functions | |
static QColor | randomColor () |
Creates and returns a random color for the initial color of the footprint polygon. | |
Protected Member Functions | |
void | setValue (int prop, QVariant value) |
This is the generic mutator for properties. | |
This is the GUI communication mechanism for shape objects.
This class is the connector between various GUI interfaces for shape 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 shape in widgetA, widgetB and widgetC now have a chance to also select the same shape. 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 shape 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.
This is a list of properties and actions that are possible.
Isis::ShapeDisplayProperties::ShapeDisplayProperties | ( | QString | displayName, |
QObject * | parent = NULL ) |
ShapeDisplayProperties constructor.
This sets default values and constructs the object *.
displayName | The filename (fully expanded) of the object. |
parent | Qt parent object (this is destroyed when parent is destroyed) |
References Color, Isis::DisplayProperties::displayName(), Isis::DisplayProperties::DisplayProperties(), None, randomColor(), setSelected(), and setShowLabel().
Referenced by propertyChanged(), and supportAdded().
|
virtual |
The destructor.
|
inherited |
Call this with every property you support, otherwise they will not communicate properly between widgets.
prop | The property you are adding support for |
References supportAdded(), and supports().
Referenced by Isis::ImageTreeWidgetItem::ImageTreeWidgetItem(), and Isis::MosaicSceneItem::MosaicSceneItem().
void Isis::ShapeDisplayProperties::addSupport | ( | Property | prop | ) |
Call this with every property you support, otherwise they will not communicate properly between widgets.
prop | The property you are adding support for |
References supportAdded(), and supports().
|
inherited |
Returns the display name.
Referenced by Isis::Directory::addCnetEditorView(), Isis::ControlDisplayProperties::ControlDisplayProperties(), DisplayProperties(), Isis::GuiCameraDisplayProperties::GuiCameraDisplayProperties(), Isis::ImageDisplayProperties::ImageDisplayProperties(), Isis::ImageTreeWidgetItem::ImageTreeWidgetItem(), Isis::Image::initFootprint(), Isis::Shape::initFootprint(), Isis::JigsawSetupDialog::JigsawSetupDialog(), Isis::GuiCamera::operator==(), Isis::ControlDisplayProperties::save(), save(), Isis::GuiCameraDisplayProperties::save(), Isis::ShapeDisplayProperties::save(), Isis::TargetBodyDisplayProperties::save(), setDisplayName(), Isis::ExportControlNetWorkOrder::setupExecution(), Isis::ShapeDisplayProperties::ShapeDisplayProperties(), Isis::TargetBodyDisplayProperties::TargetBodyDisplayProperties(), and toPvl().
|
inherited |
References setDisplayName().
Referenced by Isis::Image::fromPvl(), and Isis::Shape::fromPvl().
|
inherited |
Get a property's associated data.
prop | The property |
Referenced by Isis::ImageListActionWorkOrder::qualifyString(), and Isis::ImageTreeWidgetItem::update().
QVariant Isis::ShapeDisplayProperties::getValue | ( | Property | prop | ) | const |
Get a property's associated data.
prop | The property |
|
signalinherited |
References DisplayProperties().
Referenced by setValue().
|
signal |
References ShapeDisplayProperties().
|
static |
Creates and returns a random color for the initial color of the footprint polygon.
Referenced by ShapeDisplayProperties().
void Isis::ShapeDisplayProperties::save | ( | QXmlStreamWriter & | stream, |
const Project * | project, | ||
FileName | newProjectRoot ) const |
Saves this object to an XML file.
stream | The XML stream writer write to. |
project | The project this object is attached to (not used). |
newProjectRoot | FileName of the project? (not used). |
References Isis::DisplayProperties::displayName().
|
slot |
Change the color associated with this shape.
newColor | The new color associated with this shape. |
References Color.
|
inherited |
Sets display name.
displayName | Display name of the object. |
References displayName().
Referenced by fromPvl().
|
slot |
Change the selected state associated with this shape.
The | new state associated with this shape. |
References Selected.
Referenced by ShapeDisplayProperties().
|
slot |
Change the visibility of the display name associated with this shape.
newValue | The visibiliy of the display name for this shape. |
References ShowLabel.
Referenced by ShapeDisplayProperties().
|
protectedinherited |
This is the generic mutator for properties.
Given a value, this will change it and emit propertyChanged if its different and supported.
References propertyChanged(), and 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().
|
signalinherited |
References DisplayProperties().
Referenced by addSupport().
|
signal |
References ShapeDisplayProperties().
Referenced by addSupport().
|
inherited |
Support may come later, please make sure you are connected to the supportAdded signal.
Referenced by addSupport(), Isis::ImageList::allSupport(), setValue(), and Isis::ImageTreeWidgetItem::update().
bool Isis::ShapeDisplayProperties::supports | ( | Property | prop | ) |
Support for this may come later.
Please make sure you are connected to the supportAdded signal.
Referenced by addSupport().
|
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 displayName().
Referenced by Isis::Image::toPvl(), and Isis::Shape::toPvl().