te::edit::CreatePolygonTool Class Reference

This class implements a concrete tool to create polygons. More...

#include <CreatePolygonTool.h>

Inheritance diagram for te::edit::CreatePolygonTool:
te::edit::GeometriesUpdateTool te::qt::widgets::AbstractTool

Signals

void geometriesEdited ()
 
void geometriesStarted ()
 
void toolDeleted ()
 

Public Member Functions

void disableMouseEvent (QMouseEvent::Type mEvent)
 
std::string getLayerId ()
 
bool isInUse () const
 
void setInUse (const bool &status)
 
void setLayer (te::map::AbstractLayer *layer)
 
Initializer Methods

Methods related to instantiation and destruction.

 CreatePolygonTool (te::qt::widgets::MapDisplay *display, const te::map::AbstractLayerPtr &layer, const QCursor &cursor, bool showVertexes=true, QObject *parent=0)
 It constructs a create polygon tool associated with the given map display. More...
 
 ~CreatePolygonTool ()
 Destructor. More...
 
Initializer Methods

Methods related to instantiation and destruction.

virtual void init ()
 

Protected Attributes

Featurem_feature
 
bool m_isInUse
 
te::map::AbstractLayerm_layer
 
QMouseEvent::Type m_mEvent
 

Private Member Functions

bool eventFilter (QObject *watched, QEvent *e)
 Filters events if this object has been installed as an event filter for the watched object. More...
 

AbstractTool Methods

Methods related with tool behavior.

std::vector< te::gm::Coord2Dm_coords
 The coord list managed by this tool. More...
 
te::gm::Coord2D m_lastPos
 The last position captured on mouse move event. More...
 
bool m_continuousMode
 A flag that indicates if the tool is working in 'continuous mode'. i.e. the coordinates will be acquired from each mouseMove. More...
 
bool m_isFinished
 A flag that indicates if the operations was finished. More...
 
bool m_showVertexes
 A flag that indicates whether the tool will display the vertices. More...
 
UndoStackManagerm_stack
 
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...
 
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...
 
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...
 
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...
 
void resetVisualizationTool ()
 
void draw (bool closeGeometry)
 
void drawPolygon ()
 
void drawLine ()
 
void clear ()
 
te::gm::GeometrybuildPolygon ()
 
te::gm::GeometrybuildLine ()
 
void storeUndoCommand ()
 
bool editingFinished ()
 
void storeFeature ()
 
void onExtentChanged ()
 
void onCommandFeedback ()
 

AbstractTool Methods

Methods related with tool behavior.

MapDisplay * m_display
 The map display associated with the tool. More...
 
QCursor m_cursor
 The default tool cursor. More...
 
QCursor m_curCursor
 The current mapdisplay cursor. 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...
 
virtual void setCursor (const QCursor &cursor)
 It sets the tool cursor. More...
 

Detailed Description

This class implements a concrete tool to create polygons.

Definition at line 64 of file CreatePolygonTool.h.

Constructor & Destructor Documentation

◆ CreatePolygonTool()

te::edit::CreatePolygonTool::CreatePolygonTool ( te::qt::widgets::MapDisplay display,
const te::map::AbstractLayerPtr layer,
const QCursor &  cursor,
bool  showVertexes = true,
QObject *  parent = 0 
)

It constructs a create polygon tool associated with the given map display.

Parameters
displayThe map display associated with the tool.
parentThe tool's parent.
Note
The tool will NOT take the ownership of the given pointers.

◆ ~CreatePolygonTool()

te::edit::CreatePolygonTool::~CreatePolygonTool ( )

Destructor.

Member Function Documentation

◆ buildLine()

te::gm::Geometry* te::edit::CreatePolygonTool::buildLine ( )
private

◆ buildPolygon()

te::gm::Geometry* te::edit::CreatePolygonTool::buildPolygon ( )
private

◆ clear()

void te::edit::CreatePolygonTool::clear ( )
private

◆ disableMouseEvent()

void te::edit::GeometriesUpdateTool::disableMouseEvent ( QMouseEvent::Type  mEvent)
inherited

◆ draw()

void te::edit::CreatePolygonTool::draw ( bool  closeGeometry)
private

◆ drawLine()

void te::edit::CreatePolygonTool::drawLine ( )
private

◆ drawPolygon()

void te::edit::CreatePolygonTool::drawPolygon ( )
private

◆ editingFinished()

bool te::edit::CreatePolygonTool::editingFinished ( )
private

◆ eventFilter()

bool te::edit::GeometriesUpdateTool::eventFilter ( QObject *  watched,
QEvent *  e 
)
privatevirtualinherited

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 from te::qt::widgets::AbstractTool.

◆ geometriesEdited

void te::edit::GeometriesUpdateTool::geometriesEdited ( )
signalinherited

◆ geometriesStarted

void te::edit::GeometriesUpdateTool::geometriesStarted ( )
signalinherited

◆ getLayerId()

std::string te::edit::GeometriesUpdateTool::getLayerId ( )
inherited

◆ init()

virtual void te::qt::widgets::AbstractTool::init ( )
virtualinherited

◆ isInUse()

bool te::edit::GeometriesUpdateTool::isInUse ( ) const
inherited

◆ 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, te::qt::widgets::CoordTracking, and te::edit::MoveGeometryTool.

◆ mouseDoubleClickEvent()

bool te::edit::CreatePolygonTool::mouseDoubleClickEvent ( QMouseEvent *  e)
virtual

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 from te::qt::widgets::AbstractTool.

◆ mouseMoveEvent()

bool te::edit::CreatePolygonTool::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.

◆ mousePressEvent()

bool te::edit::CreatePolygonTool::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.

◆ mouseReleaseEvent()

bool te::edit::CreatePolygonTool::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.

◆ onCommandFeedback

void te::edit::CreatePolygonTool::onCommandFeedback ( )
privateslot

◆ onExtentChanged

void te::edit::CreatePolygonTool::onExtentChanged ( )
privateslot

◆ resetVisualizationTool()

void te::edit::CreatePolygonTool::resetVisualizationTool ( )
virtual

Reimplemented from te::edit::GeometriesUpdateTool.

◆ 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.

◆ setInUse()

void te::edit::GeometriesUpdateTool::setInUse ( const bool &  status)
inherited

◆ setLayer()

void te::edit::GeometriesUpdateTool::setLayer ( te::map::AbstractLayer layer)
inherited

◆ storeFeature()

void te::edit::CreatePolygonTool::storeFeature ( )
private

◆ storeUndoCommand()

void te::edit::CreatePolygonTool::storeUndoCommand ( )
private

◆ toolDeleted

void te::edit::GeometriesUpdateTool::toolDeleted ( )
signalinherited

Member Data Documentation

◆ m_continuousMode

bool te::edit::CreatePolygonTool::m_continuousMode
protected

A flag that indicates if the tool is working in 'continuous mode'. i.e. the coordinates will be acquired from each mouseMove.

Definition at line 138 of file CreatePolygonTool.h.

◆ m_coords

std::vector<te::gm::Coord2D> te::edit::CreatePolygonTool::m_coords
protected

The coord list managed by this tool.

Definition at line 136 of file CreatePolygonTool.h.

◆ m_curCursor

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

The current mapdisplay cursor.

Definition at line 175 of file AbstractTool.h.

◆ m_cursor

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

The default tool cursor.

Definition at line 174 of file AbstractTool.h.

◆ m_display

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

The map display associated with the tool.

Definition at line 173 of file AbstractTool.h.

◆ m_feature

Feature* te::edit::GeometriesUpdateTool::m_feature
protectedinherited

Definition at line 100 of file GeometriesUpdateTool.h.

◆ m_isFinished

bool te::edit::CreatePolygonTool::m_isFinished
protected

A flag that indicates if the operations was finished.

Definition at line 139 of file CreatePolygonTool.h.

◆ m_isInUse

bool te::edit::GeometriesUpdateTool::m_isInUse
protectedinherited

Definition at line 97 of file GeometriesUpdateTool.h.

◆ m_lastPos

te::gm::Coord2D te::edit::CreatePolygonTool::m_lastPos
protected

The last position captured on mouse move event.

Definition at line 137 of file CreatePolygonTool.h.

◆ m_layer

te::map::AbstractLayer* te::edit::GeometriesUpdateTool::m_layer
protectedinherited

Definition at line 101 of file GeometriesUpdateTool.h.

◆ m_mEvent

QMouseEvent::Type te::edit::GeometriesUpdateTool::m_mEvent
protectedinherited

Definition at line 98 of file GeometriesUpdateTool.h.

◆ m_showVertexes

bool te::edit::CreatePolygonTool::m_showVertexes
protected

A flag that indicates whether the tool will display the vertices.

Definition at line 140 of file CreatePolygonTool.h.

◆ m_stack

UndoStackManager& te::edit::CreatePolygonTool::m_stack
protected

Definition at line 141 of file CreatePolygonTool.h.


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