te::qt::widgets::Zoom Class Reference

This is a utility class to geographic zoom operation. More...

#include <Zoom.h>

Inheritance diagram for te::qt::widgets::Zoom:
te::qt::widgets::AbstractTool te::qt::widgets::ZoomClick te::qt::widgets::ZoomKeyboard te::qt::widgets::ZoomWheel

Public Types

enum  ZoomType { In, Out }
 Defines the zoom type. More...
 

Public Member Functions

void applyZoom (const QPointF &point=QPointF(), bool centralize=true)
 Performs the zoom operation on map display, considering the zoom factor, zoom type and the given point. More...
 
virtual bool mouseMoveEvent (QMouseEvent *e)
 This event handler can be reimplemented in a concrete tool class to receive mouse move events for the watched object. More...
 
virtual bool mousePressEvent (QMouseEvent *e)
 This event handler can be reimplemented in a concrete tool class to receive mouse press events for the watched object. More...
 
virtual bool mouseReleaseEvent (QMouseEvent *e)
 This event handler can be reimplemented in a concrete tool class to receive mouse release events for the watched object. More...
 
virtual void setCursor (const QCursor &cursor)
 It sets the tool cursor. More...
 
void setZoomType (const ZoomType &type)
 Sets the zoom operation type. More...
 
Initializer Methods

Methods related to instantiation and destruction.

 Zoom (MapDisplay *display, const double &zoomFactor=2.0, const ZoomType &type=In, QObject *parent=0)
 It constructs a zoom associated with the given map display. More...
 
virtual ~Zoom ()
 Destructor. More...
 
AbstractTool Methods

Methods related with tool behavior.

virtual bool eventFilter (QObject *watched, QEvent *e)
 Filters events if this object has been installed as an event filter for the watched object. More...
 
virtual bool mouseDoubleClickEvent (QMouseEvent *e)
 This event handler can be reimplemented in a concrete tool class to receive mouse double click events for the watched object. More...
 
virtual bool keyPressEvent (QKeyEvent *e)
 This event handler can be reimplemented in a concrete tool class to receive key press events for the watched object. More...
 

Protected Attributes

QCursor m_curCursor
 The current mapdisplay cursor. More...
 
QCursor m_cursor
 The default tool cursor. More...
 
MapDisplaym_display
 The map display associated with the tool. More...
 
double m_zoomFactor
 Factor used to zoom. i.e. A factor value of 2.0 (default) will generate a new extent twice (%) bigger or smaller, depending of ZoomType. More...
 
ZoomType m_zoomType
 Enum that indicates the zoom type. More...
 

Detailed Description

This is a utility class to geographic zoom operation.

Definition at line 49 of file Zoom.h.

Member Enumeration Documentation

◆ ZoomType

Defines the zoom type.

Enumerator
In 

Performs the zoom in operation.

Out 

Performs the zoom out operation.

Definition at line 58 of file Zoom.h.

Constructor & Destructor Documentation

◆ Zoom()

te::qt::widgets::Zoom::Zoom ( MapDisplay display,
const double &  zoomFactor = 2.0,
const ZoomType type = In,
QObject *  parent = 0 
)

It constructs a zoom associated with the given map display.

Parameters
displayThe map display associated with the zoom operation.
Note
The class will NOT take the ownership of the given pointer.

◆ ~Zoom()

virtual te::qt::widgets::Zoom::~Zoom ( )
virtual

Destructor.

Member Function Documentation

◆ applyZoom()

void te::qt::widgets::Zoom::applyZoom ( const QPointF &  point = QPointF(),
bool  centralize = true 
)

Performs the zoom operation on map display, considering the zoom factor, zoom type and the given point.

Parameters
pointA point in world coordinates.
centralizeIf the reference point is given, its possible to choose between centering this reference point or keeping it in the same position that it was.
Note
If the given point is not null, the new extent will be centered on this point. Otherwise, the current center will be kepped.

◆ eventFilter()

virtual bool te::qt::widgets::AbstractTool::eventFilter ( QObject *  watched,
QEvent *  e 
)
virtualinherited

Filters events if this object has been installed as an event filter for the watched object.

Parameters
watchedThe watched object.
eventThe last event sent to watched object.
Note
In your reimplementation of this function, if you want to filter the event out, i.e. stop it being handled further, return true; otherwise return false.
Here, the default implementation looks for QMouseEvents and call the pure virutal methods defined on AbstractTool class, e.g. mousePressEvent().

Reimplemented in te::edit::GeometriesUpdateTool, te::qt::widgets::ZoomKeyboard, and te::qt::widgets::ZoomWheel.

◆ keyPressEvent()

virtual bool te::qt::widgets::AbstractTool::keyPressEvent ( QKeyEvent *  e)
virtualinherited

This event handler can be reimplemented in a concrete tool class to receive key press events for the watched object.

Parameters
eThe key event.
Returns
If you want to filter the event out, i.e. stop it being handled further, return true; otherwise return false.

Reimplemented in te::qt::widgets::Measure.

◆ mouseDoubleClickEvent()

virtual bool te::qt::widgets::AbstractTool::mouseDoubleClickEvent ( QMouseEvent *  e)
virtualinherited

This event handler can be reimplemented in a concrete tool class to receive mouse double click events for the watched object.

Parameters
eThe mouse event.
Returns
If you want to filter the event out, i.e. stop it being handled further, return true; otherwise return false.
Note
The AbstractTool will also receive mouse press and mouse release events in addition to the double click event. It is up to the developer to ensure that the application interprets these events correctly.

Reimplemented in te::edit::VertexTool, te::qt::widgets::Measure, te::edit::SplitPolygonTool, te::edit::CreatePolygonTool, te::edit::CreateLineTool, te::edit::CreatePointTool, te::qt::widgets::PolygonAcquire, te::edit::AggregateAreaTool, te::mnt::ProfileTools, and te::edit::SubtractAreaTool.

◆ mouseMoveEvent()

virtual bool te::qt::widgets::Zoom::mouseMoveEvent ( QMouseEvent *  e)
virtual

This event handler can be reimplemented in a concrete tool class to receive mouse move events for the watched object.

Parameters
eThe mouse event.
Returns
If you want to filter the event out, i.e. stop it being handled further, return true; otherwise return false.

Reimplemented from te::qt::widgets::AbstractTool.

Reimplemented in te::qt::widgets::ZoomClick.

◆ mousePressEvent()

virtual bool te::qt::widgets::Zoom::mousePressEvent ( QMouseEvent *  e)
virtual

This event handler can be reimplemented in a concrete tool class to receive mouse press events for the watched object.

Parameters
eThe mouse event.
Returns
If you want to filter the event out, i.e. stop it being handled further, return true; otherwise return false.

Reimplemented from te::qt::widgets::AbstractTool.

Reimplemented in te::qt::widgets::ZoomClick.

◆ mouseReleaseEvent()

virtual bool te::qt::widgets::Zoom::mouseReleaseEvent ( QMouseEvent *  e)
virtual

This event handler can be reimplemented in a concrete tool class to receive mouse release events for the watched object.

Parameters
eThe mouse event.
Returns
If you want to filter the event out, i.e. stop it being handled further, return true; otherwise return false.

Reimplemented from te::qt::widgets::AbstractTool.

Reimplemented in te::qt::widgets::ZoomClick.

◆ setCursor()

virtual void te::qt::widgets::AbstractTool::setCursor ( const QCursor &  cursor)
virtualinherited

It sets the tool cursor.

Parameters
cursorThe cursor that will be used during the tool operation.

Reimplemented in te::edit::GeometriesUpdateTool.

◆ setZoomType()

void te::qt::widgets::Zoom::setZoomType ( const ZoomType type)

Sets the zoom operation type.

Parameters
typeThe zoom operation type - ZoomIn | ZoomOut;

Member Data Documentation

◆ m_curCursor

QCursor te::qt::widgets::AbstractTool::m_curCursor
protectedinherited

The current mapdisplay cursor.

Definition at line 173 of file AbstractTool.h.

◆ m_cursor

QCursor te::qt::widgets::AbstractTool::m_cursor
protectedinherited

The default tool cursor.

Definition at line 172 of file AbstractTool.h.

◆ m_display

MapDisplay* te::qt::widgets::AbstractTool::m_display
protectedinherited

The map display associated with the tool.

Definition at line 171 of file AbstractTool.h.

◆ m_zoomFactor

double te::qt::widgets::Zoom::m_zoomFactor
protected

Factor used to zoom. i.e. A factor value of 2.0 (default) will generate a new extent twice (%) bigger or smaller, depending of ZoomType.

Definition at line 110 of file Zoom.h.

◆ m_zoomType

ZoomType te::qt::widgets::Zoom::m_zoomType
protected

Enum that indicates the zoom type.

Definition at line 111 of file Zoom.h.


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