Isis 3 Developer Reference
Public Slots | Signals | Public Member Functions | Protected Slots | Protected Member Functions | List of all members
Isis::MosaicTool Class Referenceabstract

Base class for the MosaicTools. More...

#include <MosaicTool.h>

Inheritance diagram for Isis::MosaicTool:
Inheritance graph
Collaboration diagram for Isis::MosaicTool:
Collaboration graph

Public Slots

void activate (bool)
 Activates the tool. More...
 

Signals

void activated (bool)
 

Public Member Functions

 MosaicTool (MosaicSceneWidget *)
 
 ~MosaicTool ()
 
bool isActive () const
 Returns the activeness of this toool. More...
 
QPixmap getIcon (QString iconName) const
 returns the path to the icon directory. More...
 
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 ()
 

Protected Member Functions

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)
 
MosaicSceneWidget * getWidget ()
 
virtual QAction * getPrimaryAction ()=0
 This method returns an action that is used to activate this tool. More...
 
virtual QWidget * getToolBarWidget ()
 This method returns a widget that will be put in a tool bar when the tool is activated. More...
 

Detailed Description

Base class for the MosaicTools.

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

Constructor & Destructor Documentation

◆ MosaicTool()

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

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

◆ ~MosaicTool()

Isis::MosaicTool::~MosaicTool ( )

Member Function Documentation

◆ activate

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

Activates the tool.

Parameters
on

References activated().

Referenced by addTo().

◆ activated

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

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

◆ addTo() [1/3]

virtual void Isis::MosaicTool::addTo ( QMenu *  menu)
inlinevirtual

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

◆ addTo() [2/3]

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

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

◆ addTo() [3/3]

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

References getToolBarWidget(), and toolBarDestroyed().

◆ fromPvl()

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

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

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

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

◆ getIcon()

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

returns the path to the icon directory.

Returns
QString

References Isis::FileName::expanded().

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

◆ getPrimaryAction()

virtual QAction* Isis::MosaicTool::getPrimaryAction ( )
protectedpure 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::MosaicControlNetTool, Isis::MosaicGridTool, Isis::MosaicFindTool, Isis::MosaicAreaTool, Isis::MosaicZoomTool, Isis::MosaicPanTool, and Isis::MosaicSelectTool.

Referenced by addTo().

◆ getToolBarWidget()

QWidget * Isis::MosaicTool::getToolBarWidget ( )
protectedvirtual

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::MosaicControlNetTool, Isis::MosaicGridTool, Isis::MosaicFindTool, Isis::MosaicAreaTool, and Isis::MosaicZoomTool.

Referenced by addTo().

◆ getViewActions()

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

Reimplemented in Isis::MosaicZoomTool.

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

◆ getWidget()

MosaicSceneWidget* Isis::MosaicTool::getWidget ( )
inlineprotected

Referenced by Isis::MosaicGridTool::autoGrid(), Isis::MosaicAreaTool::clearBox(), Isis::MosaicGridTool::clearGrid(), Isis::MosaicFindTool::clearPoint(), Isis::MosaicGridTool::domainMaxLon(), Isis::MosaicGridTool::domainMinLon(), Isis::MosaicGridTool::drawGrid(), Isis::MosaicGridTool::fromPvl(), Isis::MosaicGridTool::getToolBarWidget(), Isis::MosaicFindTool::getUserGroundPoint(), Isis::MosaicGridTool::latType(), Isis::MosaicControlNetTool::loadNetwork(), Isis::MosaicGridTool::lonDomain(), Isis::MosaicControlNetTool::MosaicControlNetTool(), Isis::MosaicGridTool::MosaicGridTool(), Isis::MosaicTrackTool::MosaicTrackTool(), Isis::MosaicAreaTool::mouseButtonRelease(), Isis::MosaicFindTool::mouseButtonRelease(), Isis::MosaicControlNetTool::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::MosaicSelectTool::updateTool(), Isis::MosaicPanTool::updateTool(), Isis::MosaicZoomTool::updateTool(), Isis::MosaicAreaTool::userChangedBox(), and Isis::MosaicZoomTool::zoomFit().

◆ isActive()

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

Returns the activeness of this toool.

Returns
bool

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

◆ mouseButtonPress()

void Isis::MosaicTool::mouseButtonPress ( QPointF  ,
Qt::MouseButton  s 
)
protectedvirtual

Referenced by MosaicTool().

◆ mouseButtonRelease()

void Isis::MosaicTool::mouseButtonRelease ( QPointF  ,
Qt::MouseButton  s 
)
protectedvirtual

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

Referenced by MosaicTool().

◆ mouseDoubleClick()

void Isis::MosaicTool::mouseDoubleClick ( QPointF  )
protectedvirtual

Referenced by MosaicTool().

◆ mouseEnter()

virtual void Isis::MosaicTool::mouseEnter ( )
inlineprotectedvirtual

Referenced by MosaicTool().

◆ mouseLeave()

virtual void Isis::MosaicTool::mouseLeave ( )
inlineprotectedvirtual

Referenced by MosaicTool().

◆ mouseMove()

void Isis::MosaicTool::mouseMove ( QPointF  )
protectedvirtual

Referenced by MosaicTool().

◆ mouseWheel()

void Isis::MosaicTool::mouseWheel ( QPointF  ,
int  delta 
)
protectedvirtual

Reimplemented in Isis::MosaicZoomTool.

Referenced by MosaicTool().

◆ projectPvlObjectName()

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

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

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

◆ rubberBandComplete()

virtual void Isis::MosaicTool::rubberBandComplete ( QRectF  r,
Qt::MouseButton  s 
)
inlineprotectedvirtual

Reimplemented in Isis::MosaicZoomTool.

Referenced by MosaicTool().

◆ toolBarDestroyed()

void Isis::MosaicTool::toolBarDestroyed ( QObject *  obj)
protected

Referenced by addTo().

◆ toPvl()

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

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

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

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

◆ updateTool

virtual void Isis::MosaicTool::updateTool ( )
inlineprotectedvirtualslot

Referenced by MosaicTool().

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