Isis 3 Programmer Reference
Isis::MosaicAreaTool Class Reference

This displays a box with a given distance from a point. More...

#include <MosaicAreaTool.h>

Inheritance diagram for Isis::MosaicAreaTool:
Inheritance graph
Collaboration diagram for Isis::MosaicAreaTool:
Collaboration graph

Public Slots

void userChangedBox ()
 
void clearBox ()
 
void activate (bool)
 Activates the tool.
 

Signals

void activated (bool)
 

Public Member Functions

 MosaicAreaTool (MosaicSceneWidget *)
 MosaicAreaTool constructor.
 
void addToMenu (QMenu *menu)
 Adds the pan action to the given menu.
 
PvlObject toPvl () const
 
void fromPvl (const PvlObject &obj)
 
QString projectPvlObjectName () const
 
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 ()
 

Protected Slots

virtual void updateTool ()
 

Protected Member Functions

QActiongetPrimaryAction ()
 Adds the action to the toolpad.
 
QWidgetgetToolBarWidget ()
 This method returns a widget that will be put in a tool bar when the tool is activated.
 
QWidgetcreateToolBarWidget ()
 Creates the widget to add to the tool bar.
 
void mouseButtonRelease (QPointF, Qt::MouseButton)
 
virtual void mouseEnter ()
 
virtual void mouseMove (QPointF)
 
virtual void mouseLeave ()
 
virtual void mouseDoubleClick (QPointF)
 
virtual void mouseButtonPress (QPointF, Qt::MouseButton s)
 
virtual void mouseWheel (QPointF, int delta)
 
virtual void rubberBandComplete (QRectF r, Qt::MouseButton s)
 
void toolBarDestroyed (QObject *obj)
 
MosaicSceneWidgetgetWidget ()
 

Private Member Functions

QRectF calcLatLonRange (QPointF centerLatLon, Distance size)
 Given a distance and a center lat,lon this will return the bounding lat,lon rect.
 
void enableToolBar ()
 Enables entire tool bar.
 
void disableToolBar ()
 Disables entire tool bar.
 

Private Attributes

QActionm_drawBox
 
QLineEdit * m_lonLineEdit
 Input for longitude.
 
QLineEdit * m_latLineEdit
 Input for latitude.
 
QLineEdit * m_areaLineEdit
 Input for latitude.
 
QGraphicsPolygonItem * m_box
 
QActionm_action
 
bool p_active
 Is the tool active?
 
MosaicSceneWidgetp_widget
 
QActionp_primaryAction
 
QActionp_toolBarAction
 

Detailed Description

This displays a box with a given distance from a point.

Author
????-??-?? Steven Lambright
History

2011-09-27 Steven Lambright - Improved user documentation

2012-04-16 Jeannie Backer - Added forward declaration for PvlObject. Added #include for PvlKeyword and PvlObject classes in implementation file.

2016-05-18 Ian Humphrey - Explicity made bounding lines cosmetic so that they always appear as 1 pixel wide on screen (Qt4 to Qt5).

Definition at line 28 of file MosaicAreaTool.h.

Constructor & Destructor Documentation

◆ MosaicAreaTool()

Isis::MosaicAreaTool::MosaicAreaTool ( MosaicSceneWidget * scene)

MosaicAreaTool constructor.

Parameters
parent

Definition at line 35 of file MosaicAreaTool.cpp.

References m_areaLineEdit, m_latLineEdit, and m_lonLineEdit.

Member Function Documentation

◆ activate

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

Activates the tool.

Parameters
on

Definition at line 148 of file MosaicTool.cpp.

◆ addTo() [1/3]

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

Definition at line 63 of file MosaicTool.h.

◆ addTo() [2/3]

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

Definition at line 70 of file MosaicTool.cpp.

◆ addTo() [3/3]

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

Definition at line 52 of file MosaicTool.cpp.

◆ addToMenu()

void Isis::MosaicAreaTool::addToMenu ( QMenu * menu)

Adds the pan action to the given menu.

Parameters
menu

Definition at line 287 of file MosaicAreaTool.cpp.

◆ calcLatLonRange()

QRectF Isis::MosaicAreaTool::calcLatLonRange ( QPointF centerLatLon,
Distance size )
private

Given a distance and a center lat,lon this will return the bounding lat,lon rect.

The distance is the distance across the entire rectangle (i.e. width and height).

Definition at line 387 of file MosaicAreaTool.cpp.

References calcLatLonRange(), Isis::Angle::Degrees, Isis::Distance::Meters, and Isis::Angle::Radians.

Referenced by calcLatLonRange().

◆ clearBox

void Isis::MosaicAreaTool::clearBox ( )
slot

Definition at line 370 of file MosaicAreaTool.cpp.

◆ createToolBarWidget()

QWidget * Isis::MosaicAreaTool::createToolBarWidget ( )
protected

Creates the widget to add to the tool bar.

Parameters
parent
Returns
QWidget*

Definition at line 337 of file MosaicAreaTool.cpp.

◆ disableToolBar()

void Isis::MosaicTool::disableToolBar ( )
privateinherited

Disables entire tool bar.

Definition at line 174 of file MosaicTool.cpp.

◆ enableToolBar()

void Isis::MosaicTool::enableToolBar ( )
privateinherited

Enables entire tool bar.

Definition at line 185 of file MosaicTool.cpp.

◆ fromPvl()

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

Reimplemented from Isis::MosaicTool.

Definition at line 306 of file MosaicAreaTool.cpp.

◆ getIcon()

◆ getPrimaryAction()

QAction * Isis::MosaicAreaTool::getPrimaryAction ( )
protectedvirtual

Adds the action to the toolpad.

Parameters
toolpad
Returns
QAction*

Implements Isis::MosaicTool.

Definition at line 220 of file MosaicAreaTool.cpp.

References Isis::MosaicTool::getIcon().

◆ getToolBarWidget()

QWidget * Isis::MosaicAreaTool::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 from Isis::MosaicTool.

Definition at line 238 of file MosaicAreaTool.cpp.

References m_areaLineEdit, m_latLineEdit, and m_lonLineEdit.

◆ getViewActions()

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

Definition at line 84 of file MosaicTool.cpp.

◆ getWidget()

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

Definition at line 96 of file MosaicTool.h.

◆ isActive()

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

◆ mouseButtonPress()

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

Definition at line 130 of file MosaicTool.cpp.

◆ mouseButtonRelease()

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

Reimplemented from Isis::MosaicTool.

Definition at line 343 of file MosaicAreaTool.cpp.

◆ mouseDoubleClick()

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

Definition at line 126 of file MosaicTool.cpp.

◆ mouseEnter()

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

Definition at line 81 of file MosaicTool.h.

◆ mouseLeave()

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

Definition at line 83 of file MosaicTool.h.

◆ mouseMove()

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

Definition at line 122 of file MosaicTool.cpp.

◆ mouseWheel()

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

Definition at line 139 of file MosaicTool.cpp.

◆ projectPvlObjectName()

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

Reimplemented from Isis::MosaicTool.

Definition at line 324 of file MosaicAreaTool.cpp.

◆ rubberBandComplete()

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

Reimplemented in Isis::MosaicZoomTool.

Definition at line 88 of file MosaicTool.h.

◆ toolBarDestroyed()

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

Definition at line 165 of file MosaicTool.cpp.

◆ toPvl()

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

Reimplemented from Isis::MosaicTool.

Definition at line 292 of file MosaicAreaTool.cpp.

◆ updateTool

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

Definition at line 80 of file MosaicTool.h.

◆ userChangedBox

void Isis::MosaicAreaTool::userChangedBox ( )
slot

Definition at line 52 of file MosaicAreaTool.cpp.

Member Data Documentation

◆ m_action

QAction* Isis::MosaicAreaTool::m_action
private

Definition at line 57 of file MosaicAreaTool.h.

◆ m_areaLineEdit

QLineEdit* Isis::MosaicAreaTool::m_areaLineEdit
private

Input for latitude.

Definition at line 55 of file MosaicAreaTool.h.

Referenced by getToolBarWidget(), and MosaicAreaTool().

◆ m_box

QGraphicsPolygonItem* Isis::MosaicAreaTool::m_box
private

Definition at line 56 of file MosaicAreaTool.h.

◆ m_drawBox

QAction* Isis::MosaicAreaTool::m_drawBox
private

Definition at line 52 of file MosaicAreaTool.h.

◆ m_latLineEdit

QLineEdit* Isis::MosaicAreaTool::m_latLineEdit
private

Input for latitude.

Definition at line 54 of file MosaicAreaTool.h.

Referenced by getToolBarWidget(), and MosaicAreaTool().

◆ m_lonLineEdit

QLineEdit* Isis::MosaicAreaTool::m_lonLineEdit
private

Input for longitude.

Definition at line 53 of file MosaicAreaTool.h.

Referenced by getToolBarWidget(), and MosaicAreaTool().

◆ p_active

bool Isis::MosaicTool::p_active
privateinherited

Is the tool active?

Definition at line 120 of file MosaicTool.h.

Referenced by Isis::MosaicTool::isActive().

◆ p_primaryAction

QAction* Isis::MosaicTool::p_primaryAction
privateinherited

Definition at line 124 of file MosaicTool.h.

◆ p_toolBarAction

QAction* Isis::MosaicTool::p_toolBarAction
privateinherited

Definition at line 125 of file MosaicTool.h.

◆ p_widget

MosaicSceneWidget* Isis::MosaicTool::p_widget
privateinherited

Definition at line 122 of file MosaicTool.h.


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