Qgs3DMapTool Class Reference

3 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.
virtual bool	allowsCameraControls () const
	Whether the default mouse controls to zoom/pan/rotate camera can stay enabled while the tool is active.
Qgs3DMapCanvas *	canvas ()
	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
Qgs3DMapCanvas *	mCanvas = 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 21 of file qgs3dmaptool.cpp.

Member Function Documentation

activate()

void Qgs3DMapTool::activate ( )

virtual

Called when set as currently active map tool.

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

cursor()

QCursor Qgs3DMapTool::cursor ( ) const

virtual

Mouse cursor to be used when the tool is active.

Definition at line 55 of file qgs3dmaptool.cpp.

deactivate()

void Qgs3DMapTool::deactivate ( )

virtual

Called when map tool is being deactivated.

Definition at line 51 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 42 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 37 of file qgs3dmaptool.cpp.

mousePressEvent()

void Qgs3DMapTool::mousePressEvent ( QMouseEvent *  event )

virtual

Reimplement to handle mouse event forwarded by the parent Qgs3DMapCanvas.

Definition at line 27 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 32 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:

• /build/qgis-3.41.0+git20241122+3440c17df1d+99sid/src/3d/qgs3dmaptool.h
• /build/qgis-3.41.0+git20241122+3440c17df1d+99sid/src/3d/qgs3dmaptool.cpp