USGS

Isis 3.0 Developer's Reference (API)

 Home

Isis::MosaicTool Class Reference

Base class for the MosaicTools. More...

#include <MosaicTool.h>

Inherits QObject.

Inherited by Isis::MosaicAreaTool, Isis::MosaicControlNetTool, Isis::MosaicFindTool, Isis::MosaicGridTool, Isis::MosaicPanTool, Isis::MosaicSelectTool, Isis::MosaicTrackTool, and Isis::MosaicZoomTool.

List of all members.

Public Slots

void activate (bool)
 Activates the tool.

Signals

void activated (bool)

Public Member Functions

 MosaicTool (MosaicSceneWidget *)
 ~MosaicTool ()
bool isActive () const
 Returns the activeness of this toool.
QPixmap getIcon (QString iconName) const
 returns the path to the icon directory.
virtual void addTo (QMenu *menu)
virtual void addTo (ToolPad *toolPad)
virtual void addTo (QToolBar *toolBar)
virtual QList< QAction * > getViewActions ()
virtual PvlObject toPvl () const
virtual void fromPvl (const PvlObject &obj)
virtual QString projectPvlObjectName () const

Protected Slots

virtual void updateTool ()
virtual void mouseEnter ()
virtual void mouseMove (QPointF)
virtual void mouseLeave ()
virtual void mouseDoubleClick (QPointF)
virtual void mouseButtonPress (QPointF, Qt::MouseButton s)
virtual void mouseButtonRelease (QPointF, Qt::MouseButton s)
virtual void mouseWheel (QPointF, int delta)
virtual void rubberBandComplete (QRectF r, Qt::MouseButton s)
void toolBarDestroyed (QObject *obj)

Protected Member Functions

MosaicSceneWidget * getWidget ()
virtual QAction * getPrimaryAction ()=0
 This method returns an action that is used to activate this tool.
virtual QWidget * getToolBarWidget ()
 This method returns a widget that will be put in a tool bar when the tool is activated.

Detailed Description

Base class for the MosaicTools.

Author:
????-??-?? Stacy Alley

Constructor & Destructor Documentation

Isis::MosaicTool::MosaicTool ( MosaicSceneWidget *  scene  ) 

References activated(), mouseButtonPress(), mouseButtonRelease(), mouseDoubleClick(), mouseEnter(), mouseLeave(), mouseMove(), mouseWheel(), rubberBandComplete(), and updateTool().

Isis::MosaicTool::~MosaicTool (  ) 

Member Function Documentation

void Isis::MosaicTool::activate ( bool  on  )  [slot]

Activates the tool.

Parameters:
on 

References activated().

Referenced by addTo().

void Isis::MosaicTool::activated ( bool   )  [signal]

Referenced by activate(), Isis::MosaicGridTool::getToolBarWidget(), and MosaicTool().

void Isis::MosaicTool::addTo ( QToolBar *  toolBar  )  [virtual]

References getToolBarWidget(), and toolBarDestroyed().

void Isis::MosaicTool::addTo ( ToolPad *  toolPad  )  [virtual]

References activate(), Isis::ToolPad::addAction(), and getPrimaryAction().

virtual void Isis::MosaicTool::addTo ( QMenu *  menu  )  [inline, virtual]

Referenced by Isis::MosaicSceneWidget::addTo(), Isis::MosaicSceneWidget::getControlNetHelp(), and Isis::MosaicSceneWidget::getGridHelp().

void Isis::MosaicTool::fromPvl ( const PvlObject &  obj  )  [virtual]

Reimplemented in Isis::MosaicAreaTool, Isis::MosaicControlNetTool, Isis::MosaicFindTool, and Isis::MosaicGridTool.

References _FILEINFO_, Isis::IException::Programmer, and projectPvlObjectName().

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

QPixmap Isis::MosaicTool::getIcon ( QString  iconName  )  const

returns the path to the icon directory.

Returns:
QString

Referenced by Isis::MosaicZoomTool::getPrimaryAction(), Isis::MosaicSelectTool::getPrimaryAction(), Isis::MosaicPanTool::getPrimaryAction(), Isis::MosaicGridTool::getPrimaryAction(), Isis::MosaicFindTool::getPrimaryAction(), Isis::MosaicControlNetTool::getPrimaryAction(), Isis::MosaicAreaTool::getPrimaryAction(), and Isis::MosaicZoomTool::MosaicZoomTool().

virtual QAction* Isis::MosaicTool::getPrimaryAction (  )  [protected, pure virtual]

This method returns an action that is used to activate this tool.

This method will only be called once so it can new the action without a problem.

Implemented in Isis::MosaicAreaTool, Isis::MosaicControlNetTool, Isis::MosaicFindTool, Isis::MosaicGridTool, Isis::MosaicPanTool, Isis::MosaicSelectTool, and Isis::MosaicZoomTool.

Referenced by addTo().

QWidget * Isis::MosaicTool::getToolBarWidget (  )  [protected, virtual]

This method returns a widget that will be put in a tool bar when the tool is activated.

This method will only be called once so it can new the widget without a problem.

Reimplemented in Isis::MosaicAreaTool, Isis::MosaicControlNetTool, Isis::MosaicFindTool, Isis::MosaicGridTool, and Isis::MosaicZoomTool.

Referenced by addTo().

QList< QAction * > Isis::MosaicTool::getViewActions (  )  [virtual]

Reimplemented in Isis::MosaicZoomTool.

Referenced by Isis::MosaicSceneWidget::getViewActions().

MosaicSceneWidget* Isis::MosaicTool::getWidget (  )  [inline, protected]

Referenced by Isis::MosaicGridTool::autoGrid(), Isis::MosaicAreaTool::clearBox(), Isis::MosaicGridTool::clearGrid(), Isis::MosaicFindTool::clearPoint(), Isis::MosaicGridTool::drawGrid(), Isis::MosaicGridTool::fromPvl(), Isis::MosaicGridTool::getToolBarWidget(), Isis::MosaicFindTool::getUserGroundPoint(), Isis::MosaicGridTool::latType(), Isis::MosaicGridTool::lonDomain(), Isis::MosaicGridTool::MosaicGridTool(), Isis::MosaicTrackTool::MosaicTrackTool(), Isis::MosaicFindTool::mouseButtonRelease(), Isis::MosaicAreaTool::mouseButtonRelease(), Isis::MosaicZoomTool::mouseWheel(), Isis::MosaicGridTool::onCubesChanged(), Isis::MosaicZoomTool::rubberBandComplete(), Isis::MosaicGridTool::sceneWidget(), Isis::MosaicGridTool::setLatExtents(), Isis::MosaicGridTool::setLonExtents(), Isis::MosaicTrackTool::updateLabels(), Isis::MosaicZoomTool::updateResolutionBox(), Isis::MosaicZoomTool::updateTool(), Isis::MosaicSelectTool::updateTool(), Isis::MosaicPanTool::updateTool(), Isis::MosaicAreaTool::userChangedBox(), and Isis::MosaicZoomTool::zoomFit().

bool Isis::MosaicTool::isActive (  )  const [inline]

Returns the activeness of this toool.

Returns:
bool

Referenced by Isis::MosaicZoomTool::mouseButtonRelease(), Isis::MosaicFindTool::mouseButtonRelease(), Isis::MosaicAreaTool::mouseButtonRelease(), Isis::MosaicZoomTool::rubberBandComplete(), Isis::MosaicZoomTool::updateTool(), Isis::MosaicSelectTool::updateTool(), Isis::MosaicPanTool::updateTool(), and Isis::MosaicFindTool::updateTool().

void Isis::MosaicTool::mouseButtonPress ( QPointF  ,
Qt::MouseButton  s 
) [protected, virtual, slot]

Referenced by MosaicTool().

void Isis::MosaicTool::mouseButtonRelease ( QPointF  ,
Qt::MouseButton  s 
) [protected, virtual, slot]

Reimplemented in Isis::MosaicAreaTool, Isis::MosaicFindTool, and Isis::MosaicZoomTool.

Referenced by MosaicTool().

void Isis::MosaicTool::mouseDoubleClick ( QPointF   )  [protected, virtual, slot]

Referenced by MosaicTool().

virtual void Isis::MosaicTool::mouseEnter (  )  [inline, protected, virtual, slot]

Referenced by MosaicTool().

virtual void Isis::MosaicTool::mouseLeave (  )  [inline, protected, virtual, slot]

Reimplemented in Isis::MosaicTrackTool.

Referenced by MosaicTool().

void Isis::MosaicTool::mouseMove ( QPointF   )  [protected, virtual, slot]

Reimplemented in Isis::MosaicTrackTool.

Referenced by MosaicTool().

void Isis::MosaicTool::mouseWheel ( QPointF  ,
int  delta 
) [protected, virtual, slot]

Reimplemented in Isis::MosaicZoomTool.

Referenced by MosaicTool().

QString Isis::MosaicTool::projectPvlObjectName (  )  const [virtual]

Reimplemented in Isis::MosaicAreaTool, Isis::MosaicControlNetTool, Isis::MosaicFindTool, and Isis::MosaicGridTool.

Referenced by fromPvl(), Isis::MosaicSceneWidget::fromPvl(), toPvl(), and Isis::MosaicSceneWidget::toPvl().

virtual void Isis::MosaicTool::rubberBandComplete ( QRectF  r,
Qt::MouseButton  s 
) [inline, protected, virtual, slot]

Reimplemented in Isis::MosaicZoomTool.

Referenced by MosaicTool().

void Isis::MosaicTool::toolBarDestroyed ( QObject *  obj  )  [protected, slot]

Referenced by addTo().

PvlObject Isis::MosaicTool::toPvl (  )  const [virtual]

Reimplemented in Isis::MosaicAreaTool, Isis::MosaicControlNetTool, Isis::MosaicFindTool, and Isis::MosaicGridTool.

References _FILEINFO_, Isis::IException::Programmer, and projectPvlObjectName().

Referenced by Isis::MosaicSceneWidget::toPvl().

virtual void Isis::MosaicTool::updateTool (  )  [inline, protected, virtual, slot]

Reimplemented in Isis::MosaicFindTool, Isis::MosaicPanTool, Isis::MosaicSelectTool, and Isis::MosaicZoomTool.

Referenced by MosaicTool().

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