Isis 3 Programmer Reference
Public Slots | Signals | Public Member Functions | Protected Slots | Protected Member Functions | Private Member Functions | Private Attributes | 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.
 

Signals

void activated (bool)
 

Public Member Functions

 MosaicTool (MosaicSceneWidget *)
 
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 ()
 

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.
 
virtual QWidget * getToolBarWidget ()
 This method returns a widget that will be put in a tool bar when the tool is activated.
 

Private Member Functions

void enableToolBar ()
 Enables entire tool bar.
 
void disableToolBar ()
 Disables entire tool bar.
 

Private Attributes

bool p_active
 Is the tool active?
 
MosaicSceneWidget * p_widget
 
QAction * p_primaryAction
 
QAction * p_toolBarAction
 

Detailed Description

Base class for the MosaicTools.

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

2011-04-14 Steven Lambright Refactored to use the new MosaicSceneWidget

2011-09-27 Steven Lambright - No longer produces errors when given a NULL MosaicSceneWidget.

2011-11-04 Steven Lambright - Added getViewActions().

Definition at line 37 of file MosaicTool.h.

Constructor & Destructor Documentation

◆ MosaicTool()

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

Definition at line 16 of file MosaicTool.cpp.

◆ ~MosaicTool()

Isis::MosaicTool::~MosaicTool ( )

Definition at line 43 of file MosaicTool.cpp.

Member Function Documentation

◆ activate

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

Activates the tool.

Parameters
on

Definition at line 148 of file MosaicTool.cpp.

◆ addTo() [1/3]

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

Definition at line 63 of file MosaicTool.h.

◆ addTo() [2/3]

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

Definition at line 70 of file MosaicTool.cpp.

◆ addTo() [3/3]

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

Definition at line 52 of file MosaicTool.cpp.

◆ disableToolBar()

void Isis::MosaicTool::disableToolBar ( )
private

Disables entire tool bar.

Definition at line 174 of file MosaicTool.cpp.

◆ enableToolBar()

void Isis::MosaicTool::enableToolBar ( )
private

Enables entire tool bar.

Definition at line 185 of file MosaicTool.cpp.

◆ fromPvl()

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

Reimplemented in Isis::MosaicGridTool.

Definition at line 101 of file MosaicTool.cpp.

◆ getIcon()

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

returns the path to the icon directory.

Returns
QString

Definition at line 115 of file MosaicTool.cpp.

References Isis::FileName::expanded().

Referenced by Isis::MosaicAreaTool::getPrimaryAction(), Isis::MosaicControlNetTool::getPrimaryAction(), Isis::MosaicFindTool::getPrimaryAction(), Isis::MosaicGridTool::getPrimaryAction(), Isis::MosaicPanTool::getPrimaryAction(), Isis::MosaicSelectTool::getPrimaryAction(), Isis::MosaicZoomTool::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::MosaicAreaTool, Isis::MosaicControlNetTool, Isis::MosaicFindTool, Isis::MosaicGridTool, Isis::MosaicPanTool, Isis::MosaicSelectTool, Isis::MosaicTrackTool, and Isis::MosaicZoomTool.

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

Definition at line 192 of file MosaicTool.cpp.

◆ getViewActions()

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

Definition at line 84 of file MosaicTool.cpp.

◆ getWidget()

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

Definition at line 96 of file MosaicTool.h.

◆ isActive()

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

Returns the activeness of this toool.

Returns
bool

Definition at line 50 of file MosaicTool.h.

References p_active.

Referenced by Isis::MosaicZoomTool::rubberBandComplete(), Isis::MosaicControlNetTool::updateTool(), Isis::MosaicFindTool::updateTool(), Isis::MosaicSelectTool::updateTool(), and Isis::MosaicZoomTool::updateTool().

◆ mouseButtonPress()

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

Definition at line 130 of file MosaicTool.cpp.

◆ mouseButtonRelease()

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

Definition at line 134 of file MosaicTool.cpp.

◆ mouseDoubleClick()

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

Definition at line 126 of file MosaicTool.cpp.

◆ mouseEnter()

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

Definition at line 81 of file MosaicTool.h.

◆ mouseLeave()

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

Definition at line 83 of file MosaicTool.h.

◆ mouseMove()

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

Definition at line 122 of file MosaicTool.cpp.

◆ mouseWheel()

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

Definition at line 139 of file MosaicTool.cpp.

◆ projectPvlObjectName()

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

Reimplemented in Isis::MosaicGridTool.

Definition at line 110 of file MosaicTool.cpp.

◆ rubberBandComplete()

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

Reimplemented in Isis::MosaicZoomTool.

Definition at line 88 of file MosaicTool.h.

◆ toolBarDestroyed()

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

Definition at line 165 of file MosaicTool.cpp.

◆ toPvl()

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

Reimplemented in Isis::MosaicGridTool.

Definition at line 89 of file MosaicTool.cpp.

◆ updateTool

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

Definition at line 80 of file MosaicTool.h.

Member Data Documentation

◆ p_active

bool Isis::MosaicTool::p_active
private

Is the tool active?

Definition at line 120 of file MosaicTool.h.

Referenced by isActive().

◆ p_primaryAction

QAction* Isis::MosaicTool::p_primaryAction
private

Definition at line 124 of file MosaicTool.h.

◆ p_toolBarAction

QAction* Isis::MosaicTool::p_toolBarAction
private

Definition at line 125 of file MosaicTool.h.

◆ p_widget

MosaicSceneWidget* Isis::MosaicTool::p_widget
private

Definition at line 122 of file MosaicTool.h.

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