Class: QgsCameraController

Class Hierarchy

Base classes

QObject

class qgis._3d.QgsCameraController

Bases: QObject

signal cameraChanged

pyqtSignal(*types, name: str = …, revision: int = …, arguments: Sequence = …) -> PYQT_SIGNAL

types is normally a sequence of individual types. Each type is either a type object or a string that is the name of a C++ type. Alternatively each type could itself be a sequence of types each describing a different overloaded signal. name is the optional C++ name of the signal. If it is not specified then the name of the class attribute that is bound to the signal is used. revision is the optional revision of the signal that is exported to QML. If it is not specified then 0 is used. arguments is the optional sequence of the names of the signal’s arguments.

cameraMovementSpeed(self) → float

Returns the camera movement speed

Added in version 3.18.

Return type:

float

signal cameraMovementSpeedChanged

pyqtSignal(*types, name: str = …, revision: int = …, arguments: Sequence = …) -> PYQT_SIGNAL

types is normally a sequence of individual types. Each type is either a type object or a string that is the name of a C++ type. Alternatively each type could itself be a sequence of types each describing a different overloaded signal. name is the optional C++ name of the signal. If it is not specified then the name of the class attribute that is bound to the signal is used. revision is the optional revision of the signal that is exported to QML. If it is not specified then 0 is used. arguments is the optional sequence of the names of the signal’s arguments.

cameraNavigationMode(self) → Qgis.NavigationMode

Returns the navigation mode used by the camera controller.

Added in version 3.18.

Return type:

Qgis.NavigationMode

cameraPose(self) → QgsCameraPose

Returns camera pose

Added in version 3.4.

Return type:

QgsCameraPose

signal cameraRotationCenterChanged

pyqtSignal(*types, name: str = …, revision: int = …, arguments: Sequence = …) -> PYQT_SIGNAL

types is normally a sequence of individual types. Each type is either a type object or a string that is the name of a C++ type. Alternatively each type could itself be a sequence of types each describing a different overloaded signal. name is the optional C++ name of the signal. If it is not specified then the name of the class attribute that is bound to the signal is used. revision is the optional revision of the signal that is exported to QML. If it is not specified then 0 is used. arguments is the optional sequence of the names of the signal’s arguments.

depthBufferCaptured(self, depthImage: QImage)

Sets the depth buffer image used by the camera controller to calculate world position from a pixel’s coordinates and depth

Added in version 3.24.

Parameters:

depthImage (QImage)

distance(self) → float

Returns distance of the camera from the point it is looking at. The value should not be smaller than 10.

Added in version 3.4.

Return type:

float

frameTriggered(self, dt: float)

Called internally from 3D scene when a new frame is generated. Updates camera according to keyboard/mouse input

Parameters:

dt (float)

globeMoveCenterPoint(self, latDiff: float, lonDiff: float)

Orbits camera around the globe by the specified amount given as the difference in latitude/longitude angles (in degrees)

Note

the final latitude gets clamped to 0-90 degrees, while the longitude does not get clamped

Added in version 3.44.

Parameters:

• latDiff (float)

• lonDiff (float)

globeUpdateHeadingAngle(self, angleDiff: float)

Updates heading angle by the specified amount given as the angular difference in degrees

Added in version 3.44.

Parameters:

angleDiff (float)

globeUpdatePitchAngle(self, angleDiff: float)

Updates pitch angle by the specified amount given as the angular difference in degrees

Added in version 3.44.

Parameters:

angleDiff (float)

globeZoom(self, factor: float)

Moves camera closer or further away from the globe. Use factor greater than one to zoom in, or less than one to zoom out.

Added in version 3.44.

Parameters:

factor (float)

hasInputHandlersEnabled(self) → bool

Returns whether the camera controller responds to mouse and keyboard events

Added in version 3.44.

Return type:

bool

keyboardEventFilter(self, event: QKeyEvent | None) → bool

If the event is relevant, handles the event and returns True, otherwise False.

Added in version 3.44.

Parameters:

event (Optional[QKeyEvent])

Return type:

bool

lookingAtMapPoint(self) → QgsVector3D

Returns the point in the map coordinates towards which the camera is looking

Added in version 3.44.

Return type:

QgsVector3D

lookingAtPoint(self) → QgsVector3D

Returns the point in the world coordinates towards which the camera is looking

Return type:

QgsVector3D

moveView(self, tx: float, ty: float)

Move the map by tx and ty

Parameters:

• tx (float)

• ty (float)

signal navigationModeChanged

pyqtSignal(*types, name: str = …, revision: int = …, arguments: Sequence = …) -> PYQT_SIGNAL

types is normally a sequence of individual types. Each type is either a type object or a string that is the name of a C++ type. Alternatively each type could itself be a sequence of types each describing a different overloaded signal. name is the optional C++ name of the signal. If it is not specified then the name of the class attribute that is bound to the signal is used. revision is the optional revision of the signal that is exported to QML. If it is not specified then 0 is used. arguments is the optional sequence of the names of the signal’s arguments.

origin(self) → QgsVector3D

Returns the origin of the scene in map coordinates

Added in version 3.44.

Return type:

QgsVector3D

pitch(self) → float

Returns pitch angle in degrees (0 = looking from the top, 90 = looking from the side). The angle should range from 0 to 180.

Added in version 3.4.

Return type:

float

readXml(self, elem: QDomElement, savedOrigin: QgsVector3D)

Reads camera configuration from the given DOM element

Parameters:

• elem (QDomElement)

• savedOrigin (QgsVector3D)

signal requestDepthBufferCapture

pyqtSignal(*types, name: str = …, revision: int = …, arguments: Sequence = …) -> PYQT_SIGNAL

types is normally a sequence of individual types. Each type is either a type object or a string that is the name of a C++ type. Alternatively each type could itself be a sequence of types each describing a different overloaded signal. name is the optional C++ name of the signal. If it is not specified then the name of the class attribute that is bound to the signal is used. revision is the optional revision of the signal that is exported to QML. If it is not specified then 0 is used. arguments is the optional sequence of the names of the signal’s arguments.

resetGlobe(self, distance: float, lat: float = 0, lon: float = 0)

Resets view of the globe to look at a particular location given as latitude and longitude (in degrees) and distance from that point on ellipsoid

Added in version 3.44.

Parameters:

• distance (float)

• lat (float = 0)

• lon (float = 0)

resetView(self, distance: float)

Move camera back to the initial position (looking down towards origin of world’s coordinates)

Parameters:

distance (float)

rotateAroundViewCenter(self, deltaYaw: float)

Rotate clockwise the view by deltaYaw around the view center (camera moves)

Parameters:

deltaYaw (float)

rotateCamera(self, diffPitch: float, diffYaw: float)

Rotates the camera on itself.

Parameters:

• diffPitch (float) – the pitch difference

• diffYaw (float) – the yaw difference

Added in version 3.30.

rotateCameraAroundPivot(self, newPitch: float, newHeading: float, pivotPoint: QVector3D)

Rotates the camera around the pivot point (in world coordinates) to the given new pitch and heading angle.

Added in version 3.42.

Parameters:

• newPitch (float)

• newHeading (float)

• pivotPoint (QVector3D)

rotateCameraToBottom(self)

Added in version 3.44.

rotateCameraToEast(self)

Added in version 3.44.

rotateCameraToHome(self)

Added in version 3.44.

rotateCameraToNorth(self)

Added in version 3.44.

rotateCameraToSouth(self)

Added in version 3.44.

rotateCameraToTop(self)

Added in version 3.44.

rotateCameraToWest(self)

Added in version 3.44.

setCameraHeadingAngle(self, angle: float)

Set camera heading to angle (used for rotating the view)

Parameters:

angle (float)

setCameraMovementSpeed(self, movementSpeed: float)

Sets the camera movement speed

Added in version 3.18.

Parameters:

movementSpeed (float)

setCameraNavigationMode(self, navigationMode: Qgis.NavigationMode)

Sets the navigation mode used by the camera controller.

Added in version 3.18.

Parameters:

navigationMode (Qgis.NavigationMode)

setCameraPose(self, camPose: QgsCameraPose, force: bool = False)

Sets camera pose

Added in version 3.4.

Parameters:

• camPose (QgsCameraPose)

• force (bool = False)

signal setCursorPosition

pyqtSignal(*types, name: str = …, revision: int = …, arguments: Sequence = …) -> PYQT_SIGNAL

types is normally a sequence of individual types. Each type is either a type object or a string that is the name of a C++ type. Alternatively each type could itself be a sequence of types each describing a different overloaded signal. name is the optional C++ name of the signal. If it is not specified then the name of the class attribute that is bound to the signal is used. revision is the optional revision of the signal that is exported to QML. If it is not specified then 0 is used. arguments is the optional sequence of the names of the signal’s arguments.

setInputHandlersEnabled(self, enable: bool)

Sets whether the camera controller responds to mouse and keyboard events

Added in version 3.42.

Parameters:

enable (bool)

setLookingAtMapPoint(self, point: QgsVector3D, distance: float, pitch: float, yaw: float)

Sets camera configuration like setLookingAtPoint(), but the point is given in map coordinates

Added in version 3.44.

Parameters:

• point (QgsVector3D)

• distance (float)

• pitch (float)

• yaw (float)

setLookingAtPoint(self, point: QgsVector3D, distance: float, pitch: float, yaw: float)

Sets the complete camera configuration: the point towards it is looking (in 3D world coordinates), the distance of the camera from the point, pitch angle in degrees (0 = looking from the top, 90 = looking from the side) and yaw angle in degrees.

Added in version 3.4.

Parameters:

• point (QgsVector3D)

• distance (float)

• pitch (float)

• yaw (float)

setOrigin(self, origin: QgsVector3D)

Reacts to the shift of origin of the scene, updating camera pose and any other member variables so that the origin stays at the same position relative to other entities.

Added in version 3.42.

Parameters:

origin (QgsVector3D)

setVerticalAxisInversion(self, inversion: Qgis.VerticalAxisInversion)

Sets the vertical axis inversion behavior.

Added in version 3.18.

Parameters:

inversion (Qgis.VerticalAxisInversion)

setViewFromTop(self, worldX: float, worldY: float, distance: float, yaw: float = 0)

Sets camera to look down towards given point in world coordinate, in given distance from plane with zero elevation

Parameters:

• worldX (float)

• worldY (float)

• distance (float)

• yaw (float = 0)

tiltUpAroundViewCenter(self, deltaPitch: float)

Tilt up the view by deltaPitch around the view center (camera moves)

Parameters:

deltaPitch (float)

verticalAxisInversion(self) → Qgis.VerticalAxisInversion

Returns the vertical axis inversion behavior.

Added in version 3.18.

Return type:

Qgis.VerticalAxisInversion

walkView(self, tx: float, ty: float, tz: float)

Walks into the map by tx, ty, and tz

Added in version 3.30.

Parameters:

• tx (float)

• ty (float)

• tz (float)

writeXml(self, doc: QDomDocument) → QDomElement

Writes camera configuration to the given DOM element

Parameters:

doc (QDomDocument)

Return type:

QDomElement

yaw(self) → float

Returns yaw angle in degrees. Yaw value of zero means the camera is pointing towards north. The angle should range from 0 to 360.

Added in version 3.4.

Return type:

float

zoom(self, factor: float)

Zoom the map by factor

Parameters:

factor (float)

zoomCameraAroundPivot(self, oldCameraPosition: QVector3D, zoomFactor: float, pivotPoint: QVector3D)

Zooms camera by given zoom factor (>1 one means zoom in) while keeping the pivot point (given in world coordinates) at the same screen coordinates after the zoom.

Added in version 3.42.

Deprecated since version 3.44.4: Use version with oldDistanceFromCenterPoint argument instead.

zoomCameraAroundPivot(self, oldCameraPosition: QVector3D, oldDistanceFromCenterPoint: float, zoomFactor: float, pivotPoint: QVector3D) Zooms camera by given zoom factor (>1 one means zoom in) while keeping the pivot point (given in world coordinates) at the same screen coordinates after the zoom.

Added in version 3.44.4.

Parameters:

• oldCameraPosition (QVector3D)

• zoomFactor (float)

• pivotPoint (QVector3D)