Class: Qgs3DMapTool

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

Added in version 4.0.

Class Hierarchy

Inheritance diagram of qgis._3d.Qgs3DMapTool

Base classes

QObject
class qgis._3d.Qgs3DMapTool[source]

Bases: QObject

__init__(canvas: Qgs3DMapCanvas | None)

Base constructor for a Qgs3DMapTool for the specified canvas

Parameters:

canvas (Optional[Qgs3DMapCanvas])

virtual activate(self)[source]

Called when set as currently active map tool

canvas(self) → Qgs3DMapCanvas | None[source]

Returns the parent Qgs3DMapCanvas

Return type:

Optional[Qgs3DMapCanvas]

virtual cursor(self) → QCursor[source]

Mouse cursor to be used when the tool is active

Return type:

QCursor

virtual deactivate(self)[source]

Called when map tool is being deactivated

virtual keyPressEvent(self, event: QKeyEvent | None)[source]

Reimplement to handle key press event forwarded by the parent Qgs3DMapCanvas

Parameters:

event (Optional[QKeyEvent])

virtual keyReleaseEvent(self, event: QKeyEvent | None)[source]

Reimplement to handle key release event forwarded by the parent Qgs3DMapCanvas

Parameters:

event (Optional[QKeyEvent])

virtual mouseMoveEvent(self, event: QMouseEvent | None)[source]

Reimplement to handle mouse move event forwarded by the parent Qgs3DMapCanvas

Parameters:

event (Optional[QMouseEvent])

virtual mousePressEvent(self, event: QMouseEvent | None)[source]

Reimplement to handle mouse event forwarded by the parent Qgs3DMapCanvas

Parameters:

event (Optional[QMouseEvent])

virtual mouseReleaseEvent(self, event: QMouseEvent | None)[source]

Reimplement to handle mouse release event forwarded by the parent Qgs3DMapCanvas

Parameters:

event (Optional[QMouseEvent])

virtual mouseWheelEvent(self, event: QWheelEvent | None)[source]

Reimplement to handle mouse wheel event forwarded by the parent Qgs3DMapCanvas

Parameters:

event (Optional[QWheelEvent])