Isis Developer Reference
|
Display nomenclature on MDI Cube Viewports. More...
#include <FeatureNomenclatureTool.h>
Public Types | |
enum | VectorType { None , Arrows4 , Arrows8 , Box } |
Enumeration of extent vector typess. More... | |
Public Slots | |
void | activate (bool) |
Activates the tool. | |
void | setCubeViewport (MdiCubeViewport *cvp) |
Sets the current viewport to the given cvp. | |
Signals | |
void | clearWarningSignal () |
void | toolActivated () |
void | viewportChanged () |
Public Member Functions | |
FeatureNomenclatureTool (QWidget *parent) | |
This instantiates a FeatureNomenclatureTool. | |
~FeatureNomenclatureTool () | |
Cleans up memory allocated by this tool. | |
void | addTo (QMenu *menu) |
Add the 'Show Nomenclature' option to the options menu. | |
void | paintViewport (MdiCubeViewport *vp, QPainter *painter) |
Paint features on the given viewport. | |
bool | defaultEnabled () const |
Is this tool enabled by default? (i.e. | |
QColor | fontColor () const |
What is the font color to use? | |
int | fontSize () const |
Retrieve the font size of the features in this tool. | |
bool | showApprovedOnly () const |
Show approved features only? | |
VectorType | vectorType () const |
Draw vectors to the extents of features? | |
void | setDefaultEnabled (bool defaultEnabled) |
Set whether this tool is enabled by default. | |
void | setFontColor (QColor color) |
Set the color to use for drawing on the viewport. | |
void | setFontSize (int newFontSize) |
Set the font point size to use for drawing text on the viewport. | |
void | setShowApprovedOnly (bool approvedOnly) |
Set whether to show approved features and exclude unapproved features. | |
void | setVectorType (VectorType show) |
Set whether to draw vectors from the feature center to the feature extents on the viewport. | |
QString | menuName () const |
This is the name of the menu that should be passed into "addTo()". | |
void | addTo (ViewportMainWindow *mw) |
Adds the tool to the application. | |
void | addTo (ToolPad *toolpad) |
Adds the tool to the toolpad. | |
virtual void | addTo (Workspace *ws) |
Adds the given workspace to the cubeviewport list. | |
virtual void | addToPermanent (QToolBar *toolbar) |
void | addToActive (QToolBar *toolbar) |
QString | toolIconDir () const |
returns the path to the icon directory. | |
RubberBandTool * | rubberBandTool () |
void | setList (ToolList *currentList) |
Protected Types | |
typedef QVector< MdiCubeViewport * > | CubeViewportList |
A list of cubeviewports. | |
Protected Slots | |
virtual void | rubberBandComplete () |
virtual void | screenPixelsChanged () |
This is called when actions change which pixels from the cube are displayed. | |
virtual void | mouseEnter () |
virtual void | mouseMove (QPoint p) |
virtual void | mouseMove (QPoint p, Qt::MouseButton) |
virtual void | mouseLeave () |
Protected Member Functions | |
QWidget * | createToolBarWidget (QStackedWidget *parent) |
Creates the widget that goes on the tool bar when this tool is active. | |
QAction * | toolPadAction (ToolPad *pad) |
Add this tool's action to the toolpad. | |
void | mouseButtonRelease (QPoint p, Qt::MouseButton s) |
This handles a mouse release on one of the cube viewports when this tool is active. | |
void | updateTool () |
Updates the state of the current tool. | |
virtual void | mouseDoubleClick (QPoint p) |
virtual void | mouseButtonPress (QPoint p, Qt::MouseButton s) |
virtual void | updateMeasure () |
virtual void | scaleChanged () |
virtual void | stretchRequested (MdiCubeViewport *, int) |
void | registerTool (MdiCubeViewport *viewport) |
Registers the tool to the viewport. | |
MdiCubeViewport * | cubeViewport () const |
Return the current cubeviewport. | |
CubeViewportList * | cubeViewportList () const |
Return the list of cubeviewports. | |
virtual void | addConnections (MdiCubeViewport *cvp) |
Anytime a tool is created, you must add the connections for it. | |
virtual void | removeConnections (MdiCubeViewport *cvp) |
Anytime a tool is created, you must be able to remove it's connections. | |
virtual void | enableRubberBandTool () |
Anytime a tool is created, you may use the rubber band tool. | |
Workspace * | workspace () |
Display nomenclature on MDI Cube Viewports.
This tool is designed to paint named features onto the viewports' displays. The nomenclature and it's positioning comes from the FeatureNomenclature class. Options such as auto-enabling from program start, showing vectors, font configurations, showing detailed feature information and linking back to the nomenclature website are built-in.
|
protectedinherited |
A list of cubeviewports.
Enumeration of extent vector typess.
Isis::FeatureNomenclatureTool::FeatureNomenclatureTool | ( | QWidget * | parent | ) |
This instantiates a FeatureNomenclatureTool.
This will read this tool's saved settings and potentially automatically enable itself.
parent |
References None, and Isis::Tool::toolActivated().
Isis::FeatureNomenclatureTool::~FeatureNomenclatureTool | ( | ) |
Cleans up memory allocated by this tool.
|
slotinherited |
Activates the tool.
on |
References Isis::Tool::clearWarningSignal(), and Isis::Tool::toolActivated().
Referenced by Isis::Tool::addTo(), Isis::AdvancedTrackTool::AdvancedTrackTool(), Isis::RubberBandTool::disable(), Isis::RubberBandTool::enable(), Isis::AdvancedTrackTool::eventFilter(), Isis::FileTool::FileTool(), Isis::RubberBandTool::RubberBandTool(), Isis::TrackTool::TrackTool(), and Isis::WindowTool::WindowTool().
|
inlineprotectedvirtualinherited |
Anytime a tool is created, you must add the connections for it.
cvp |
Reimplemented in Isis::TrackTool, and Isis::WindowTool.
|
virtual |
Add the 'Show Nomenclature' option to the options menu.
menu | Menu to add 'Show Nomenclature' to. |
Reimplemented from Isis::Tool.
|
inherited |
Adds the tool to the toolpad.
toolpad |
References Isis::Tool::activate(), and Isis::Tool::toolPadAction().
|
inherited |
Adds the tool to the application.
pViewPortMnWin |
References Isis::Tool::addTo(), Isis::Tool::addToActive(), Isis::Tool::addToPermanent(), and Isis::Tool::menuName().
Referenced by Isis::Tool::addTo(), Isis::EditTool::addTo(), Isis::FileTool::addTo(), Isis::SpecialPixelTool::addTo(), Isis::WindowTool::addTo(), Isis::ViewportMainWindow::ViewportMainWindow(), and Isis::Workspace::Workspace().
|
virtualinherited |
Adds the given workspace to the cubeviewport list.
ws |
Reimplemented in Isis::EditTool, Isis::FileTool, Isis::SpecialPixelTool, and Isis::WindowTool.
References Isis::Tool::registerTool(), and Isis::Tool::setCubeViewport().
|
inherited |
toolbar |
References Isis::Tool::createToolBarWidget(), and Isis::ToolList::toolBarStack().
Referenced by Isis::Tool::addTo().
|
inlinevirtualinherited |
toolbar |
Reimplemented in Isis::AdvancedTrackTool, Isis::BlinkTool, Isis::FileTool, Isis::HelpTool, Isis::SpecialPixelTool, and Isis::WindowTool.
Referenced by Isis::Tool::addTo().
|
signalinherited |
|
protectedvirtual |
Creates the widget that goes on the tool bar when this tool is active.
parent |
Reimplemented from Isis::Tool.
|
inlineprotectedinherited |
Return the current cubeviewport.
Referenced by Isis::TrackTool::addConnections(), Isis::WindowTool::addConnections(), Isis::StretchTool::deleteFromCube(), Isis::FileTool::discard(), Isis::FileTool::exportToList(), Isis::FileTool::exportView(), Isis::StretchTool::loadStretchFromCube(), Isis::SunShadowTool::mouseButtonPress(), Isis::EditTool::mouseButtonRelease(), Isis::ControlNetTool::mouseButtonRelease(), mouseButtonRelease(), Isis::FindTool::mouseButtonRelease(), Isis::MatchTool::mouseButtonRelease(), Isis::PanTool::mouseButtonRelease(), Isis::QnetTool::mouseButtonRelease(), Isis::RubberBandTool::mouseButtonRelease(), Isis::StretchTool::mouseButtonRelease(), Isis::AdvancedTrackTool::mouseLeave(), Isis::SunShadowTool::mouseMove(), Isis::TrackTool::mouseMove(), Isis::RubberBandTool::mouseMove(), Isis::ScatterPlotTool::mouseMove(), Isis::LatLonGridTool::paintViewport(), Isis::FindTool::paintViewport(), Isis::RubberBandTool::paintViewport(), Isis::SunShadowTool::paintViewport(), Isis::FileTool::print(), Isis::HistogramTool::refreshPlot(), Isis::SpatialPlotTool::refreshPlot(), Isis::SpectralPlotTool::refreshPlot(), Isis::TrackTool::removeConnections(), Isis::WindowTool::removeConnections(), Isis::EditTool::rubberBandComplete(), Isis::HistogramTool::rubberBandComplete(), Isis::MeasureTool::rubberBandComplete(), Isis::StereoTool::rubberBandComplete(), Isis::StretchTool::rubberBandComplete(), Isis::ZoomTool::rubberBandComplete(), Isis::FileTool::save(), Isis::FileTool::saveAs(), Isis::FileTool::saveAsCubeByOption(), Isis::FileTool::saveInfo(), Isis::StretchTool::saveStretchToCube(), Isis::ScatterPlotTool::showNewScatterPlotConfig(), Isis::StretchTool::stretchGlobal(), Isis::StretchTool::stretchGlobalAllBands(), Isis::StretchTool::stretchRegional(), Isis::StretchTool::updateAdvStretchDialogforAll(), Isis::StretchTool::updateHistograms(), Isis::MeasureTool::updateMeasure(), Isis::AbstractPlotTool::updateTool(), Isis::BandTool::updateTool(), Isis::BlinkTool::updateTool(), Isis::EditTool::updateTool(), Isis::FileTool::updateTool(), Isis::FindTool::updateTool(), Isis::LatLonGridTool::updateTool(), Isis::SpecialPixelTool::updateTool(), Isis::StretchTool::updateTool(), Isis::SunShadowTool::updateTool(), Isis::WindowTool::updateTool(), Isis::ZoomTool::updateTool(), and Isis::AbstractPlotTool::viewportsToPlot().
|
protectedinherited |
Return the list of cubeviewports.
References Isis::Workspace::cubeViewportList().
Referenced by Isis::FileTool::closeAll(), Isis::MatchTool::createPoint(), Isis::BlinkTool::eventFilter(), Isis::PanTool::mouseButtonRelease(), Isis::RubberBandTool::mouseButtonRelease(), Isis::RubberBandTool::mouseMove(), Isis::AbstractPlotTool::repaintViewports(), Isis::ScatterPlotTool::repaintViewports(), Isis::AbstractPlotTool::repaintViewports(), Isis::ZoomTool::rubberBandComplete(), Isis::ControlNetTool::setControlNet(), setFontColor(), setFontSize(), setShowApprovedOnly(), setVectorType(), Isis::StretchTool::stretchGlobalAllViewports(), Isis::MeasureTool::updateMeasure(), Isis::BlinkTool::updateTool(), Isis::FindTool::updateTool(), Isis::WindowTool::updateTool(), and Isis::AbstractPlotTool::viewportsToPlot().
bool Isis::FeatureNomenclatureTool::defaultEnabled | ( | ) | const |
Is this tool enabled by default? (i.e.
on program start)
Referenced by Isis::NomenclatureToolConfigDialog::readSettings(), and setDefaultEnabled().
|
protectedvirtualinherited |
Anytime a tool is created, you may use the rubber band tool.
Enable the use of the rubberband tool.
Reimplemented in Isis::HistogramTool, Isis::MeasureTool, Isis::RubberBandTool, Isis::SpatialPlotTool, Isis::SpectralPlotTool, Isis::StereoTool, and Isis::ZoomTool.
References Isis::RubberBandTool::disable(), and Isis::Tool::rubberBandTool().
QColor Isis::FeatureNomenclatureTool::fontColor | ( | ) | const |
What is the font color to use?
Referenced by Isis::NomenclatureToolConfigDialog::readSettings().
int Isis::FeatureNomenclatureTool::fontSize | ( | ) | const |
Retrieve the font size of the features in this tool.
Referenced by Isis::NomenclatureToolConfigDialog::readSettings().
|
virtual |
This is the name of the menu that should be passed into "addTo()".
Reimplemented from Isis::Tool.
|
protectedvirtualinherited |
p | |
s |
References Isis::Tool::clearWarningSignal().
|
protectedvirtual |
This handles a mouse release on one of the cube viewports when this tool is active.
The responsibilities are forwarde to ViewportFeatureDisplay::handleMouseClicked().
p | The point in the viewport where the mouse was released |
s | The mouse buttons that were released |
Reimplemented from Isis::Tool.
References Isis::Tool::cubeViewport().
|
protectedvirtualinherited |
p |
References Isis::Tool::clearWarningSignal().
|
inlineprotectedvirtualslotinherited |
|
inlineprotectedvirtualslotinherited |
|
protectedvirtualslotinherited |
p |
|
inlineprotectedvirtualslotinherited |
|
virtual |
Paint features on the given viewport.
vp | The viewport that needs painted |
painter | The painter to use for painting |
Reimplemented from Isis::Tool.
References None.
|
protectedinherited |
Registers the tool to the viewport.
viewport |
References Isis::MdiCubeViewport::registerTool(), and Isis::Tool::stretchRequested().
Referenced by Isis::Tool::addTo().
|
inlineprotectedvirtualinherited |
Anytime a tool is created, you must be able to remove it's connections.
cvp |
Reimplemented in Isis::MeasureTool, Isis::TrackTool, and Isis::WindowTool.
|
inlineprotectedvirtualslotinherited |
|
inherited |
References Isis::ToolList::rubberBandTool().
Referenced by Isis::MeasureTool::createToolBarWidget(), Isis::EditTool::enableRubberBandTool(), Isis::HistogramTool::enableRubberBandTool(), Isis::MeasureTool::enableRubberBandTool(), Isis::SpatialPlotTool::enableRubberBandTool(), Isis::SpectralPlotTool::enableRubberBandTool(), Isis::StereoTool::enableRubberBandTool(), Isis::StretchTool::enableRubberBandTool(), Isis::Tool::enableRubberBandTool(), Isis::ZoomTool::enableRubberBandTool(), Isis::HistogramTool::refreshPlot(), Isis::SpatialPlotTool::refreshPlot(), Isis::SpectralPlotTool::refreshPlot(), Isis::RubberBandComboBox::RubberBandComboBox(), Isis::EditTool::rubberBandComplete(), Isis::HistogramTool::rubberBandComplete(), Isis::MeasureTool::rubberBandComplete(), Isis::SpatialPlotTool::rubberBandComplete(), Isis::SpectralPlotTool::rubberBandComplete(), Isis::StereoTool::rubberBandComplete(), Isis::StretchTool::rubberBandComplete(), Isis::ZoomTool::rubberBandComplete(), and Isis::RubberBandComboBox::selectionChanged().
|
inlineprotectedvirtualinherited |
Reimplemented in Isis::RubberBandTool.
|
inlineprotectedvirtualslotinherited |
This is called when actions change which pixels from the cube are displayed.
|
slotinherited |
Sets the current viewport to the given cvp.
cvp |
References Isis::Tool::updateTool(), and Isis::Tool::viewportChanged().
Referenced by Isis::Tool::addTo(), and Isis::FileTool::closeAll().
void Isis::FeatureNomenclatureTool::setDefaultEnabled | ( | bool | defaultEnabled | ) |
Set whether this tool is enabled by default.
defaultEnabled | True to enable by default |
References defaultEnabled().
Referenced by Isis::NomenclatureToolConfigDialog::applySettings().
void Isis::FeatureNomenclatureTool::setFontColor | ( | QColor | color | ) |
Set the color to use for drawing on the viewport.
This takes effect immediately.
color | The color to use for drawing |
References Isis::Tool::cubeViewportList().
Referenced by Isis::NomenclatureToolConfigDialog::applySettings().
void Isis::FeatureNomenclatureTool::setFontSize | ( | int | newFontSize | ) |
Set the font point size to use for drawing text on the viewport.
This takes effect immediately.
newFontSize | The font point size to use for rendering text |
References Isis::Tool::cubeViewportList().
Referenced by Isis::NomenclatureToolConfigDialog::applySettings().
|
inherited |
void Isis::FeatureNomenclatureTool::setShowApprovedOnly | ( | bool | approvedOnly | ) |
Set whether to show approved features and exclude unapproved features.
approvedOnly | True to show only appproved features |
References Isis::Tool::cubeViewportList().
Referenced by Isis::NomenclatureToolConfigDialog::applySettings().
void Isis::FeatureNomenclatureTool::setVectorType | ( | VectorType | show | ) |
Set whether to draw vectors from the feature center to the feature extents on the viewport.
This takes effect immediately.
show | True to show the vectors |
References Isis::Tool::cubeViewportList().
Referenced by Isis::NomenclatureToolConfigDialog::applySettings().
bool Isis::FeatureNomenclatureTool::showApprovedOnly | ( | ) | const |
Show approved features only?
Referenced by Isis::NomenclatureToolConfigDialog::readSettings().
|
inlineprotectedvirtualinherited |
Reimplemented in Isis::StretchTool.
Referenced by Isis::Tool::registerTool().
|
signalinherited |
|
inlineinherited |
returns the path to the icon directory.
Referenced by Isis::AdvancedTrackTool::AdvancedTrackTool(), Isis::BlinkTool::BlinkTool(), Isis::BandTool::createToolBarWidget(), Isis::EditTool::createToolBarWidget(), Isis::FindTool::createToolBarWidget(), Isis::MatchTool::createToolBarWidget(), Isis::PanTool::createToolBarWidget(), Isis::StereoTool::createToolBarWidget(), Isis::StretchTool::createToolBarWidget(), Isis::ZoomTool::createToolBarWidget(), Isis::FileTool::FileTool(), Isis::FindTool::FindTool(), Isis::HelpTool::HelpTool(), Isis::HistogramTool::HistogramTool(), Isis::PanTool::PanTool(), Isis::SpecialPixelTool::SpecialPixelTool(), Isis::RubberBandComboBox::toolIconDir(), Isis::BandTool::toolPadAction(), Isis::ControlNetTool::toolPadAction(), Isis::EditTool::toolPadAction(), toolPadAction(), Isis::HistogramTool::toolPadAction(), Isis::LatLonGridTool::toolPadAction(), Isis::MatchTool::toolPadAction(), Isis::MeasureTool::toolPadAction(), Isis::PanTool::toolPadAction(), Isis::QnetTool::toolPadAction(), Isis::ScatterPlotTool::toolPadAction(), Isis::SpatialPlotTool::toolPadAction(), Isis::SpectralPlotTool::toolPadAction(), Isis::StereoTool::toolPadAction(), Isis::StretchTool::toolPadAction(), Isis::SunShadowTool::toolPadAction(), Isis::FindTool::toolPadAction(), Isis::StatisticsTool::toolPadAction(), Isis::ZoomTool::toolPadAction(), Isis::WindowTool::WindowTool(), and Isis::ZoomTool::ZoomTool().
Add this tool's action to the toolpad.
This defines the name and hotkey of this tool.
toolpad |
Reimplemented from Isis::Tool.
References Isis::Tool::toolIconDir().
|
inlineprotectedvirtualinherited |
|
protectedvirtual |
Updates the state of the current tool.
This will find any missing nomenclature if appropriate.
Reimplemented from Isis::Tool.
FeatureNomenclatureTool::VectorType Isis::FeatureNomenclatureTool::vectorType | ( | ) | const |
Draw vectors to the extents of features?
Referenced by Isis::NomenclatureToolConfigDialog::readSettings().
|
signalinherited |
|
protectedinherited |