Class: Qgs3DMapTool

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

Added in version 4.0.

Class Hierarchy

Base classes

QObject

Methods

canvas

Returns the parent Qgs3DMapCanvas

Virtual Methods

In PyQGIS, only methods marked as virtual can be safely overridden in a Python subclass of Qgs3DMapTool. See the FAQ for more details.

activate	Called when set as currently active map tool
cursor	Mouse cursor to be used when the tool is active
deactivate	Called when map tool is being deactivated
keyPressEvent	Reimplement to handle key press event forwarded by the parent Qgs3DMapCanvas
keyReleaseEvent	Reimplement to handle key release event forwarded by the parent Qgs3DMapCanvas
mouseMoveEvent	Reimplement to handle mouse move event forwarded by the parent Qgs3DMapCanvas
mousePressEvent	Reimplement to handle mouse event forwarded by the parent Qgs3DMapCanvas
mouseReleaseEvent	Reimplement to handle mouse release event forwarded by the parent Qgs3DMapCanvas
mouseWheelEvent	Reimplement to handle mouse wheel event forwarded by the parent Qgs3DMapCanvas

class qgis._3d.Qgs3DMapTool

Bases: QObject

__init__(canvas: Qgs3DMapCanvas | None)

Base constructor for a Qgs3DMapTool for the specified canvas

Parameters:

canvas (Optional[Qgs3DMapCanvas])

virtual activate(self)

Called when set as currently active map tool

canvas(self) → Qgs3DMapCanvas | None

Returns the parent Qgs3DMapCanvas

Return type:

Optional[Qgs3DMapCanvas]

virtual cursor(self) → QCursor

Mouse cursor to be used when the tool is active

Return type:

QCursor

virtual deactivate(self)

Called when map tool is being deactivated

virtual keyPressEvent(self, event: QKeyEvent | None)

Reimplement to handle key press event forwarded by the parent Qgs3DMapCanvas

Parameters:

event (Optional[QKeyEvent])

virtual keyReleaseEvent(self, event: QKeyEvent | None)

Reimplement to handle key release event forwarded by the parent Qgs3DMapCanvas

Parameters:

event (Optional[QKeyEvent])

virtual mouseMoveEvent(self, event: QMouseEvent | None)

Reimplement to handle mouse move event forwarded by the parent Qgs3DMapCanvas

Parameters:

event (Optional[QMouseEvent])

virtual mousePressEvent(self, event: QMouseEvent | None)

Reimplement to handle mouse event forwarded by the parent Qgs3DMapCanvas

Parameters:

event (Optional[QMouseEvent])

virtual mouseReleaseEvent(self, event: QMouseEvent | None)

Reimplement to handle mouse release event forwarded by the parent Qgs3DMapCanvas

Parameters:

event (Optional[QMouseEvent])

virtual mouseWheelEvent(self, event: QWheelEvent | None)

Reimplement to handle mouse wheel event forwarded by the parent Qgs3DMapCanvas

Parameters:

event (Optional[QWheelEvent])