QGIS API Documentation 3.99.0-Master (2fe06baccd8)
Loading...
Searching...
No Matches
Qgs3DMapTool Class Reference

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

#include <qgs3dmaptool.h>

Inheritance diagram for Qgs3DMapTool:

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.
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 keyReleaseEvent (QKeyEvent *event)
 Reimplement to handle key release 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.
virtual void mouseWheelEvent (QWheelEvent *event)
 Reimplement to handle mouse wheel event forwarded by the parent Qgs3DMapCanvas.

Protected Attributes

Qgs3DMapCanvasmCanvas = nullptr

Detailed Description

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

Since
QGIS 4.0 (since QGIS 3.36 in QGIS_3D library, since QGIS 3.4 in QGIS_APP library)

Definition at line 34 of file qgs3dmaptool.h.

Constructor & Destructor Documentation

◆ Qgs3DMapTool()

Qgs3DMapTool::Qgs3DMapTool ( Qgs3DMapCanvas * canvas)

Base constructor for a Qgs3DMapTool for the specified canvas.

Definition at line 22 of file qgs3dmaptool.cpp.

Member Function Documentation

◆ activate()

void Qgs3DMapTool::activate ( )
virtual

Called when set as currently active map tool.

Definition at line 58 of file qgs3dmaptool.cpp.

◆ canvas()

Qgs3DMapCanvas * Qgs3DMapTool::canvas ( )

Returns the parent Qgs3DMapCanvas.

Definition at line 75 of file qgs3dmaptool.cpp.

◆ cursor()

QCursor Qgs3DMapTool::cursor ( ) const
virtual

Mouse cursor to be used when the tool is active.

Definition at line 66 of file qgs3dmaptool.cpp.

◆ deactivate()

void Qgs3DMapTool::deactivate ( )
virtual

Called when map tool is being deactivated.

Definition at line 62 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 43 of file qgs3dmaptool.cpp.

◆ keyReleaseEvent()

void Qgs3DMapTool::keyReleaseEvent ( QKeyEvent * event)
virtual

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

Definition at line 48 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 38 of file qgs3dmaptool.cpp.

◆ mousePressEvent()

void Qgs3DMapTool::mousePressEvent ( QMouseEvent * event)
virtual

Reimplement to handle mouse event forwarded by the parent Qgs3DMapCanvas.

Definition at line 28 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 33 of file qgs3dmaptool.cpp.

◆ mouseWheelEvent()

void Qgs3DMapTool::mouseWheelEvent ( QWheelEvent * event)
virtual

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

Definition at line 53 of file qgs3dmaptool.cpp.

Member Data Documentation

◆ mCanvas

Qgs3DMapCanvas* Qgs3DMapTool::mCanvas = nullptr
protected

Definition at line 72 of file qgs3dmaptool.h.


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