QGIS API Documentation 3.39.0-Master (67e056379ed)
Loading...
Searching...
No Matches
Public Member Functions | Protected Attributes | List of all members
Qgs3DMapTool Class Reference

3 More...

#include <qgs3dmaptool.h>

Inheritance diagram for Qgs3DMapTool:
Inheritance graph
[legend]

Public Member Functions

 Qgs3DMapTool (Qgs3DMapCanvas *canvas)
 Base constructor for a Qgs3DMapTool for the specified canvas.
 
virtual void activate ()
 Called when set as currently active map tool.
 
virtual bool allowsCameraControls () const
 Whether the default mouse controls to zoom/pan/rotate camera can stay enabled while the tool is active.
 
Qgs3DMapCanvascanvas ()
 Returns the parent Qgs3DMapCanvas.
 
virtual QCursor cursor () const
 Mouse cursor to be used when the tool is active.
 
virtual void deactivate ()
 Called when map tool is being deactivated.
 
virtual void keyPressEvent (QKeyEvent *event)
 Reimplement to handle key press event forwarded by the parent Qgs3DMapCanvas.
 
virtual void mouseMoveEvent (QMouseEvent *event)
 Reimplement to handle mouse move event forwarded by the parent Qgs3DMapCanvas.
 
virtual void mousePressEvent (QMouseEvent *event)
 Reimplement to handle mouse event forwarded by the parent Qgs3DMapCanvas.
 
virtual void mouseReleaseEvent (QMouseEvent *event)
 Reimplement to handle mouse release event forwarded by the parent Qgs3DMapCanvas.
 

Protected Attributes

Qgs3DMapCanvasmCanvas = nullptr
 

Detailed Description

3

Base class for map tools operating on 3D map canvas.

Note
Not available in Python bindings
Since
QGIS 3.36 (since QGIS 3.4 in QGIS_APP library)

Definition at line 36 of file qgs3dmaptool.h.

Constructor & Destructor Documentation

◆ Qgs3DMapTool()

Qgs3DMapTool::Qgs3DMapTool ( Qgs3DMapCanvas canvas)

Base constructor for a Qgs3DMapTool for the specified canvas.

Definition at line 20 of file qgs3dmaptool.cpp.

Member Function Documentation

◆ activate()

void Qgs3DMapTool::activate ( )
virtual

Called when set as currently active map tool.

Definition at line 46 of file qgs3dmaptool.cpp.

◆ allowsCameraControls()

virtual bool Qgs3DMapTool::allowsCameraControls ( ) const
inlinevirtual

Whether the default mouse controls to zoom/pan/rotate camera can stay enabled while the tool is active.

This may be useful for some basic tools using just mouse clicks (e.g. identify, measure), but it could be creating conflicts when used with more advanced tools. Default implementation returns true.

Definition at line 68 of file qgs3dmaptool.h.

◆ canvas()

Qgs3DMapCanvas * Qgs3DMapTool::canvas ( )

Returns the parent Qgs3DMapCanvas.

Definition at line 64 of file qgs3dmaptool.cpp.

◆ cursor()

QCursor Qgs3DMapTool::cursor ( ) const
virtual

Mouse cursor to be used when the tool is active.

Definition at line 54 of file qgs3dmaptool.cpp.

◆ deactivate()

void Qgs3DMapTool::deactivate ( )
virtual

Called when map tool is being deactivated.

Definition at line 50 of file qgs3dmaptool.cpp.

◆ keyPressEvent()

void Qgs3DMapTool::keyPressEvent ( QKeyEvent *  event)
virtual

Reimplement to handle key press event forwarded by the parent Qgs3DMapCanvas.

Definition at line 41 of file qgs3dmaptool.cpp.

◆ mouseMoveEvent()

void Qgs3DMapTool::mouseMoveEvent ( QMouseEvent *  event)
virtual

Reimplement to handle mouse move event forwarded by the parent Qgs3DMapCanvas.

Definition at line 36 of file qgs3dmaptool.cpp.

◆ mousePressEvent()

void Qgs3DMapTool::mousePressEvent ( QMouseEvent *  event)
virtual

Reimplement to handle mouse event forwarded by the parent Qgs3DMapCanvas.

Definition at line 26 of file qgs3dmaptool.cpp.

◆ mouseReleaseEvent()

void Qgs3DMapTool::mouseReleaseEvent ( QMouseEvent *  event)
virtual

Reimplement to handle mouse release event forwarded by the parent Qgs3DMapCanvas.

Definition at line 31 of file qgs3dmaptool.cpp.

Member Data Documentation

◆ mCanvas

Qgs3DMapCanvas* Qgs3DMapTool::mCanvas = nullptr
protected

Definition at line 78 of file qgs3dmaptool.h.


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