Isis 3 Programmer Reference
Isis::BlinkTool Class Reference

#include <BlinkTool.h>

Inheritance diagram for Isis::BlinkTool:
Inheritance graph
Collaboration diagram for Isis::BlinkTool:
Collaboration graph

Public Slots

void activate (bool)
 Activates the tool. More...
 
void setCubeViewport (MdiCubeViewport *cvp)
 Sets the current viewport to the given cvp. More...
 

Signals

void clearWarningSignal ()
 
void toolActivated ()
 
void viewportChanged ()
 

Public Member Functions

 BlinkTool (QWidget *parent)
 Blink Tool Constructor. More...
 
void addTo (QMenu *menu)
 Adds this action to the given menu. More...
 
void addToPermanent (QToolBar *perm)
 Adds this action to the permanent tool bar. More...
 
void writeSettings ()
 Writes the current settings of this window so the next time this tool is used, certain user prefs. More...
 
void readSettings ()
 Reads the settings saved from the last time this tool was used. More...
 
QString menuName () const
 Returns the menu name. More...
 
void addTo (ViewportMainWindow *mw)
 Adds the tool to the application. More...
 
void addTo (ToolPad *toolpad)
 Adds the tool to the toolpad. More...
 
virtual void addTo (Workspace *ws)
 Adds the given workspace to the cubeviewport list. More...
 
void addToActive (QToolBar *toolbar)
 
QString toolIconDir () const
 returns the path to the icon directory. More...
 
virtual void paintViewport (MdiCubeViewport *vp, QPainter *painter)
 
RubberBandToolrubberBandTool ()
 
void setList (ToolList *currentList)
 

Protected Types

typedef QVector< MdiCubeViewport *> CubeViewportList
 A list of cubeviewports. More...
 

Protected Slots

virtual void rubberBandComplete ()
 
virtual void screenPixelsChanged ()
 This is called when actions change which pixels from the cube are displayed. More...
 
virtual void mouseEnter ()
 
virtual void mouseMove (QPoint p)
 
virtual void mouseMove (QPoint p, Qt::MouseButton)
 
virtual void mouseLeave ()
 

Protected Member Functions

void updateTool ()
 Updates the blink tool. More...
 
bool eventFilter (QObject *o, QEvent *e)
 Catches the events happening so we can make this tool do what we want. More...
 
virtual void mouseDoubleClick (QPoint p)
 
virtual void mouseButtonPress (QPoint p, Qt::MouseButton s)
 
virtual void mouseButtonRelease (QPoint p, Qt::MouseButton s)
 Resets the Warning to Nowarning when a different activity occurs on the application. More...
 
virtual void updateMeasure ()
 
virtual void scaleChanged ()
 
virtual void stretchRequested (MdiCubeViewport *, int)
 
void registerTool (MdiCubeViewport *viewport)
 Registers the tool to the viewport. More...
 
MdiCubeViewportcubeViewport () const
 Return the current cubeviewport. More...
 
CubeViewportListcubeViewportList () const
 Return the list of cubeviewports. More...
 
virtual QActiontoolPadAction (ToolPad *toolpad)
 Anytime a tool is created, you must setup a tool pad action with it. More...
 
virtual QWidgetcreateToolBarWidget (QStackedWidget *parent)
 Anytime a tool is created, you must add it to the tool bar. More...
 
virtual void addConnections (MdiCubeViewport *cvp)
 Anytime a tool is created, you must add the connections for it. More...
 
virtual void removeConnections (MdiCubeViewport *cvp)
 Anytime a tool is created, you must be able to remove it's connections. More...
 
virtual void enableRubberBandTool ()
 Anytime a tool is created, you may use the rubber band tool. More...
 
Workspaceworkspace ()
 

Private Slots

void toggleLink (QListWidgetItem *item)
 Links/unlinks viewports. More...
 
void reverse ()
 Reverses the order of the blinking. More...
 
void stop ()
 Stops the blinking. More...
 
void start ()
 Starts the blinking. More...
 
void advance ()
 Manual blinking. More...
 
void timeout ()
 The blink tool's timer. More...
 
void updateWindow ()
 Repaints the blink tool window. More...
 

Private Attributes

QActionp_action
 The action associated with this tool. More...
 
QWidgetp_blinkWindow
 The blink tool widget. More...
 
QListWidget * p_listWidget
 The list widget with the blink tool. More...
 
QDoubleSpinBox * p_timeBox
 Time selection box. More...
 
bool p_timerOn
 Is the timer on? More...
 
QDialogp_dialog
 Dialog widget. More...
 
QSplitter * p_splitter
 

Detailed Description

Author
????-??-?? Unknown
History:
2010-06-26 Eric Hyer - Now uses MdiCubeViewport instead of CubeViewport. Fixed misuse of includes.

Definition at line 26 of file BlinkTool.h.

Member Typedef Documentation

◆ CubeViewportList

typedef QVector< MdiCubeViewport * > Isis::Tool::CubeViewportList
protectedinherited

A list of cubeviewports.

Definition at line 219 of file Tool.h.

Constructor & Destructor Documentation

◆ BlinkTool()

Isis::BlinkTool::BlinkTool ( QWidget parent)

Member Function Documentation

◆ activate

◆ addConnections()

virtual void Isis::Tool::addConnections ( MdiCubeViewport cvp)
inlineprotectedvirtualinherited

Anytime a tool is created, you must add the connections for it.

Parameters
cvp

Reimplemented in Isis::TrackTool, and Isis::WindowTool.

Definition at line 253 of file Tool.h.

Referenced by Isis::Tool::addViewportConnections().

◆ addTo() [1/4]

void Isis::BlinkTool::addTo ( QMenu menu)
virtual

Adds this action to the given menu.

Parameters
menu

Reimplemented from Isis::Tool.

Definition at line 157 of file BlinkTool.cpp.

References p_action.

◆ addTo() [2/4]

◆ addTo() [3/4]

void Isis::Tool::addTo ( ToolPad toolpad)
inherited

Adds the tool to the toolpad.

Parameters
toolpad

Definition at line 98 of file Tool.cpp.

References Isis::Tool::activate(), Isis::ToolPad::addAction(), Isis::Tool::m_toolPadAction, and Isis::Tool::toolPadAction().

◆ addTo() [4/4]

void Isis::Tool::addTo ( Workspace ws)
virtualinherited

Adds the given workspace to the cubeviewport list.

Parameters
ws

Reimplemented in Isis::EditTool, Isis::FileTool, Isis::SpecialPixelTool, and Isis::WindowTool.

Definition at line 45 of file Tool.cpp.

References Isis::Tool::registerTool(), and Isis::Tool::setCubeViewport().

◆ addToActive()

void Isis::Tool::addToActive ( QToolBar toolbar)
inherited

◆ addToPermanent()

void Isis::BlinkTool::addToPermanent ( QToolBar perm)
virtual

Adds this action to the permanent tool bar.

Parameters
perm

Reimplemented from Isis::Tool.

Definition at line 168 of file BlinkTool.cpp.

References p_action.

◆ advance

void Isis::BlinkTool::advance ( )
privateslot

Manual blinking.

Definition at line 273 of file BlinkTool.cpp.

References Isis::Tool::cubeViewportList(), Isis::MdiCubeViewport::isLinked(), p_listWidget, and p_timerOn.

Referenced by BlinkTool(), and timeout().

◆ createToolBarWidget()

virtual QWidget* Isis::Tool::createToolBarWidget ( QStackedWidget *  parent)
inlineprotectedvirtualinherited

◆ cubeViewport()

MdiCubeViewport* Isis::Tool::cubeViewport ( ) const
inlineprotectedinherited

Return the current cubeviewport.

Returns
CubeViewport*

Definition at line 211 of file Tool.h.

References Isis::Tool::m_cvp.

Referenced by Isis::WindowTool::addConnections(), Isis::TrackTool::addConnections(), Isis::StretchTool::advancedStretchChanged(), Isis::FindTool::centerLinkedViewports(), Isis::StretchTool::changeStretch(), Isis::BandTool::changeView(), Isis::BandTool::copyLinkedViewports(), Isis::FileTool::discard(), Isis::Tool::enableToolBar(), Isis::FileTool::exportToList(), Isis::FileTool::exportView(), Isis::StatisticsTool::getStatistics(), Isis::FindTool::handleRecordClicked(), Isis::EditTool::LineToPoints(), Isis::TrackTool::locateCursor(), Isis::SunShadowTool::mouseButtonPress(), Isis::ControlNetTool::mouseButtonRelease(), Isis::RubberBandTool::mouseButtonRelease(), Isis::EditTool::mouseButtonRelease(), Isis::FeatureNomenclatureTool::mouseButtonRelease(), Isis::FindTool::mouseButtonRelease(), Isis::StretchTool::mouseButtonRelease(), Isis::MatchTool::mouseButtonRelease(), Isis::QnetTool::mouseButtonRelease(), Isis::AdvancedTrackTool::mouseLeave(), Isis::ScatterPlotTool::mouseMove(), Isis::SunShadowTool::mouseMove(), Isis::TrackTool::mouseMove(), Isis::RubberBandTool::mouseMove(), Isis::SunShadowTool::paintViewport(), Isis::RubberBandTool::paintViewport(), Isis::FindTool::paintViewport(), Isis::FileTool::print(), Isis::SunShadowTool::recalculateShadowHeight(), Isis::EditTool::redoEdit(), Isis::FindTool::refresh(), Isis::HistogramTool::refreshPlot(), Isis::SpatialPlotTool::refreshPlot(), Isis::SpectralPlotTool::refreshPlot(), Isis::WindowTool::removeConnections(), Isis::TrackTool::removeConnections(), Isis::RubberBandTool::repaint(), Isis::WindowTool::resizeWindows(), Isis::HistogramTool::rubberBandComplete(), Isis::MeasureTool::rubberBandComplete(), Isis::ZoomTool::rubberBandComplete(), Isis::EditTool::rubberBandComplete(), Isis::StretchTool::rubberBandComplete(), Isis::FileTool::save(), Isis::FileTool::saveAs(), Isis::FileTool::saveAsCubeByOption(), Isis::FileTool::saveAsReducedCube(), Isis::FileTool::saveInfo(), Isis::BandTool::setBandBin(), Isis::BandTool::setList(), Isis::StretchTool::setStretchAcrossBands(), Isis::StretchTool::setStretchAllViewports(), Isis::StretchTool::showAdvancedDialog(), Isis::ScatterPlotTool::showNewScatterPlotConfig(), Isis::StretchTool::stretchChanged(), Isis::StretchTool::stretchGlobal(), Isis::StretchTool::stretchGlobalAllBands(), Isis::StretchTool::stretchRegional(), Isis::EditTool::undoEdit(), Isis::StretchTool::updateAdvStretchDialogforAll(), Isis::StretchTool::updateHistograms(), Isis::TrackTool::updateLabels(), Isis::MeasureTool::updateMeasure(), Isis::AdvancedTrackTool::updateRow(), Isis::WindowTool::updateTool(), updateTool(), Isis::SpecialPixelTool::updateTool(), Isis::BandTool::updateTool(), Isis::SunShadowTool::updateTool(), Isis::AbstractPlotTool::updateTool(), Isis::ZoomTool::updateTool(), Isis::FileTool::updateTool(), Isis::EditTool::updateTool(), Isis::FindTool::updateTool(), Isis::StretchTool::updateTool(), Isis::AbstractPlotTool::viewportsToPlot(), Isis::EditTool::writeToCube(), Isis::ZoomTool::zoomBy(), Isis::ZoomTool::zoomFit(), Isis::ZoomTool::zoomFitHeight(), Isis::ZoomTool::zoomFitWidth(), and Isis::ZoomTool::zoomManual().

◆ cubeViewportList()

Tool::CubeViewportList * Isis::Tool::cubeViewportList ( ) const
protectedinherited

Return the list of cubeviewports.

Returns
CubeViewportList*

Definition at line 390 of file Tool.cpp.

References Isis::Workspace::cubeViewportList().

Referenced by advance(), Isis::SpecialPixelTool::apply(), Isis::FindTool::centerLinkedViewports(), Isis::WindowTool::changeCursor(), Isis::FileTool::closeAll(), Isis::BandTool::copyAllViewports(), Isis::BandTool::copyLinkedViewports(), Isis::MatchTool::createPoint(), eventFilter(), Isis::FeatureNomenclatureTool::featuresIdentified(), Isis::FeatureNomenclatureTool::findMissingNomenclature(), Isis::FeatureNomenclatureTool::findNomenclatureStateChanged(), Isis::FindTool::handleLinkClicked(), Isis::WindowTool::linkWindows(), Isis::RubberBandTool::mouseButtonRelease(), Isis::RubberBandTool::mouseMove(), Isis::QnetTool::openGround(), Isis::StereoTool::paintAllViewports(), Isis::ControlNetTool::paintAllViewports(), Isis::MatchTool::paintAllViewports(), Isis::QnetTool::paintAllViewports(), Isis::FindTool::refresh(), Isis::ScatterPlotTool::repaintViewports(), Isis::AbstractPlotTool::repaintViewports(), Isis::WindowTool::resizeWindows(), reverse(), Isis::ZoomTool::rubberBandComplete(), Isis::MatchTool::serialNumberList(), Isis::ControlNetTool::setControlNet(), Isis::FeatureNomenclatureTool::setFontColor(), Isis::FeatureNomenclatureTool::setFontSize(), Isis::FeatureNomenclatureTool::setShowApprovedOnly(), Isis::StretchTool::setStretchAllViewports(), Isis::FeatureNomenclatureTool::setVectorType(), Isis::StretchTool::stretchGlobalAllViewports(), toggleLink(), Isis::WindowTool::unlinkWindows(), Isis::MeasureTool::updateMeasure(), Isis::AdvancedTrackTool::updateRow(), Isis::WindowTool::updateTool(), updateTool(), Isis::FindTool::updateTool(), Isis::AbstractPlotTool::viewportsToPlot(), Isis::ZoomTool::zoomBy(), Isis::ZoomTool::zoomFit(), Isis::ZoomTool::zoomFitHeight(), Isis::ZoomTool::zoomFitWidth(), and Isis::ZoomTool::zoomManual().

◆ enableRubberBandTool()

void Isis::Tool::enableRubberBandTool ( )
protectedvirtualinherited

Anytime a tool is created, you may use the rubber band tool.

Enable the use of the rubberband tool.

Reimplemented in Isis::RubberBandTool, Isis::ZoomTool, Isis::MeasureTool, Isis::StereoTool, Isis::SpatialPlotTool, Isis::SpectralPlotTool, and Isis::HistogramTool.

Definition at line 339 of file Tool.cpp.

References Isis::RubberBandTool::disable().

Referenced by Isis::Tool::addViewportConnections().

◆ eventFilter()

bool Isis::BlinkTool::eventFilter ( QObject o,
QEvent *  e 
)
protected

Catches the events happening so we can make this tool do what we want.

Parameters
o
e
Returns
bool

Definition at line 357 of file BlinkTool.cpp.

References Isis::Tool::cubeViewportList(), p_blinkWindow, p_listWidget, Isis::CubeViewport::pixmap(), and writeSettings().

◆ menuName()

QString Isis::BlinkTool::menuName ( ) const
inlinevirtual

Returns the menu name.

Returns
QString

Reimplemented from Isis::Tool.

Definition at line 42 of file BlinkTool.h.

◆ mouseButtonPress()

void Isis::Tool::mouseButtonPress ( QPoint  p,
Qt::MouseButton  s 
)
protectedvirtualinherited
Parameters
p
s

Definition at line 367 of file Tool.cpp.

Referenced by Isis::Tool::addViewportConnections(), and Isis::Tool::removeViewportConnections().

◆ mouseButtonRelease()

void Isis::Tool::mouseButtonRelease ( QPoint  p,
Qt::MouseButton  s 
)
protectedvirtualinherited

Resets the Warning to Nowarning when a different activity occurs on the application.

This is called by all the mouseButtonRelease events in all the tools.

Parameters
p
s

Reimplemented in Isis::FeatureNomenclatureTool.

Definition at line 380 of file Tool.cpp.

Referenced by Isis::Tool::addViewportConnections(), Isis::StretchTool::mouseButtonRelease(), and Isis::Tool::removeViewportConnections().

◆ mouseDoubleClick()

void Isis::Tool::mouseDoubleClick ( QPoint  p)
protectedvirtualinherited
Parameters
p

Definition at line 358 of file Tool.cpp.

Referenced by Isis::Tool::addViewportConnections(), and Isis::Tool::removeViewportConnections().

◆ mouseMove

void Isis::Tool::mouseMove ( QPoint  p)
protectedvirtualslotinherited
Parameters
p

Definition at line 352 of file Tool.cpp.

Referenced by Isis::Tool::addViewportConnections(), and Isis::Tool::removeViewportConnections().

◆ paintViewport()

virtual void Isis::Tool::paintViewport ( MdiCubeViewport vp,
QPainter *  painter 
)
inlinevirtualinherited

◆ readSettings()

void Isis::BlinkTool::readSettings ( )

Reads the settings saved from the last time this tool was used.

Definition at line 331 of file BlinkTool.cpp.

References p_dialog, and p_timeBox.

Referenced by BlinkTool().

◆ registerTool()

void Isis::Tool::registerTool ( MdiCubeViewport viewport)
protectedinherited

Registers the tool to the viewport.

Parameters
viewport

Definition at line 327 of file Tool.cpp.

References Isis::Tool::m_cvp, and Isis::MdiCubeViewport::registerTool().

Referenced by Isis::Tool::addTo().

◆ removeConnections()

virtual void Isis::Tool::removeConnections ( MdiCubeViewport cvp)
inlineprotectedvirtualinherited

Anytime a tool is created, you must be able to remove it's connections.

Parameters
cvp

Reimplemented in Isis::MeasureTool, Isis::TrackTool, and Isis::WindowTool.

Definition at line 261 of file Tool.h.

Referenced by Isis::Tool::removeViewportConnections().

◆ reverse

void Isis::BlinkTool::reverse ( )
privateslot

Reverses the order of the blinking.

Definition at line 232 of file BlinkTool.cpp.

References Isis::Tool::cubeViewportList(), Isis::MdiCubeViewport::isLinked(), p_listWidget, and p_timerOn.

Referenced by BlinkTool().

◆ screenPixelsChanged

virtual void Isis::Tool::screenPixelsChanged ( )
inlineprotectedvirtualslotinherited

This is called when actions change which pixels from the cube are displayed.

Definition at line 162 of file Tool.h.

Referenced by Isis::Tool::addViewportConnections(), Isis::Tool::removeViewportConnections(), and Isis::FeatureNomenclatureTool::viewportDone().

◆ setCubeViewport

void Isis::Tool::setCubeViewport ( MdiCubeViewport cvp)
slotinherited

◆ start

void Isis::BlinkTool::start ( )
privateslot

Starts the blinking.

Definition at line 262 of file BlinkTool.cpp.

References p_timeBox, p_timerOn, and timeout().

Referenced by BlinkTool(), and timeout().

◆ stop

void Isis::BlinkTool::stop ( )
privateslot

Stops the blinking.

Definition at line 253 of file BlinkTool.cpp.

References p_timerOn.

Referenced by BlinkTool().

◆ timeout

void Isis::BlinkTool::timeout ( )
privateslot

The blink tool's timer.

Definition at line 294 of file BlinkTool.cpp.

References advance(), p_timerOn, and start().

Referenced by start().

◆ toggleLink

void Isis::BlinkTool::toggleLink ( QListWidgetItem *  item)
privateslot

Links/unlinks viewports.

Parameters
item

Definition at line 217 of file BlinkTool.cpp.

References Isis::Tool::cubeViewportList(), Isis::MdiCubeViewport::isLinked(), p_listWidget, and Isis::MdiCubeViewport::setLinked().

Referenced by BlinkTool().

◆ toolIconDir()

QString Isis::Tool::toolIconDir ( ) const
inlineinherited

◆ toolPadAction()

virtual QAction* Isis::Tool::toolPadAction ( ToolPad toolpad)
inlineprotectedvirtualinherited

◆ updateTool()

void Isis::BlinkTool::updateTool ( )
protectedvirtual

◆ updateWindow

void Isis::BlinkTool::updateWindow ( )
privateslot

Repaints the blink tool window.

Definition at line 306 of file BlinkTool.cpp.

References p_blinkWindow.

Referenced by BlinkTool().

◆ writeSettings()

void Isis::BlinkTool::writeSettings ( )

Writes the current settings of this window so the next time this tool is used, certain user prefs.

are remembered.

Definition at line 316 of file BlinkTool.cpp.

References p_dialog, and p_timeBox.

Referenced by eventFilter().

Member Data Documentation

◆ p_action

QAction* Isis::BlinkTool::p_action
private

The action associated with this tool.

Definition at line 60 of file BlinkTool.h.

Referenced by addTo(), addToPermanent(), BlinkTool(), and updateTool().

◆ p_blinkWindow

QWidget* Isis::BlinkTool::p_blinkWindow
private

The blink tool widget.

Definition at line 61 of file BlinkTool.h.

Referenced by BlinkTool(), eventFilter(), and updateWindow().

◆ p_dialog

QDialog* Isis::BlinkTool::p_dialog
private

Dialog widget.

Definition at line 65 of file BlinkTool.h.

Referenced by BlinkTool(), readSettings(), and writeSettings().

◆ p_listWidget

QListWidget* Isis::BlinkTool::p_listWidget
private

The list widget with the blink tool.

Definition at line 62 of file BlinkTool.h.

Referenced by advance(), BlinkTool(), eventFilter(), reverse(), toggleLink(), and updateTool().

◆ p_timeBox

QDoubleSpinBox* Isis::BlinkTool::p_timeBox
private

Time selection box.

Definition at line 63 of file BlinkTool.h.

Referenced by BlinkTool(), readSettings(), start(), and writeSettings().

◆ p_timerOn

bool Isis::BlinkTool::p_timerOn
private

Is the timer on?

Definition at line 64 of file BlinkTool.h.

Referenced by advance(), BlinkTool(), reverse(), start(), stop(), and timeout().


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