#include <qgscameracontroller.h>

Inheritance diagram for QgsCameraController:

Public Types
enum	NavigationMode { TerrainBasedNavigation , WalkNavigation }
	The navigation mode used by the camera. More...

enum	VerticalAxisInversion { Never , WhenDragging , Always }
	Vertical axis inversion options. More...

Public Slots
void	depthBufferCaptured (const QImage &depthImage)
	Sets the depth buffer image used by the camera controller to calculate world position from a pixel's coordinates and depth. More...

void	setCameraNavigationMode (QgsCameraController::NavigationMode navigationMode)
	Sets the navigation mode used by the camera controller. More...

Signals
void	cameraChanged ()
	Emitted when camera has been updated. More...

void	cameraMovementSpeedChanged (double speed)
	Emitted whenever the camera movement speed is changed by the controller. More...

void	cameraRotationCenterChanged (QVector3D position)
	Emitted when the camera rotation center changes. More...

void	navigationModeChanged (QgsCameraController::NavigationMode mode)
	Emitted when the navigation mode is changed using the hotkey ctrl + ~. More...

void	requestDepthBufferCapture ()
	Emitted to ask for the depth buffer image. More...

void	setCursorPosition (QPoint point)
	Emitted when the mouse cursor position should be moved to the specified point on the map viewport. More...

void	viewportChanged ()
	Emitted when viewport rectangle has been updated. More...

Public Member Functions
	QgsCameraController (Qt3DCore::QNode *parent=nullptr)
	Constructs the camera controller with optional parent node that will take ownership. More...

Qt3DRender::QCamera *	camera () const
	Returns camera that is being controlled. More...

double	cameraMovementSpeed () const
	Returns the camera movement speed. More...

QgsCameraController::NavigationMode	cameraNavigationMode () const
	Returns the navigation mode used by the camera controller. More...

QgsCameraPose	cameraPose () const
	Returns camera pose. More...

float	distance () const
	Returns distance of the camera from the point it is looking at. More...

void	frameTriggered (float dt)
	Called internally from 3D scene when a new frame is generated. Updates camera according to keyboard/mouse input. More...

QgsVector3D	lookingAtPoint () const
	Returns the point in the world coordinates towards which the camera is looking. More...

void	moveView (float tx, float ty)
	Move the map by tx and ty. More...

float	pitch () const
	Returns pitch angle in degrees (0 = looking from the top, 90 = looking from the side). More...

void	readXml (const QDomElement &elem)
	Reads camera configuration from the given DOM element. More...

void	resetView (float distance)
	Move camera back to the initial position (looking down towards origin of world's coordinates) More...

void	rotateAroundViewCenter (float deltaYaw)
	Rotate clockwise the view by deltaYaw around the view center (camera moves) More...

void	setCamera (Qt3DRender::QCamera *camera)
	Assigns camera that should be controlled by this class. Called internally from 3D scene. More...

void	setCameraHeadingAngle (float angle)
	Set camera heading to angle (used for rotating the view) More...

void	setCameraMovementSpeed (double movementSpeed)
	Sets the camera movement speed. More...

void	setCameraPose (const QgsCameraPose &camPose)
	Sets camera pose. More...

void	setLookingAtPoint (const QgsVector3D &point, float distance, float pitch, float yaw)
	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. More...

void	setTerrainEntity (QgsTerrainEntity *te)
	Connects to object picker attached to terrain entity. More...

void	setVerticalAxisInversion (QgsCameraController::VerticalAxisInversion inversion)
	Sets the vertical axis inversion behavior. More...

void	setViewFromTop (float worldX, float worldY, float distance, float yaw=0)
	Sets camera to look down towards given point in world coordinate, in given distance from plane with zero elevation. More...

void	setViewport (QRect viewport)
	Sets viewport rectangle. Called internally from 3D canvas. Allows conversion of mouse coordinates. More...

void	tiltUpAroundViewCenter (float deltaPitch)
	Tilt up the view by deltaPitch around the view center (camera moves) More...

QgsCameraController::VerticalAxisInversion	verticalAxisInversion () const
	Returns the vertical axis inversion behavior. More...

QRect	viewport () const
	Returns viewport rectangle. More...

bool	willHandleKeyEvent (QKeyEvent *event)
	Returns `true` if the camera controller will handle the specified key event, preventing it from being instead handled by parents of the 3D window before the controller ever receives it. More...

QDomElement	writeXml (QDomDocument &doc) const
	Writes camera configuration to the given DOM element. More...

float	yaw () const
	Returns yaw angle in degrees. More...

void	zoom (float factor)
	Zoom the map by factor. More...

Properties
Qt3DRender::QCamera *	camera

QRect	viewport

Detailed Description

3

Object that controls camera movement based on user input

Note: Not available in Python bindings

Since: QGIS 3.0

Definition at line 61 of file qgscameracontroller.h.

Member Enumeration Documentation

◆ NavigationMode

enum QgsCameraController::NavigationMode

The navigation mode used by the camera.

Enumerator
TerrainBasedNavigation	The default navigation based on the terrain.
WalkNavigation	Uses WASD keys or arrows to navigate in walking (first person) manner.

Definition at line 69 of file qgscameracontroller.h.

◆ VerticalAxisInversion

enum QgsCameraController::VerticalAxisInversion

Vertical axis inversion options.

Enumerator
Never	Never invert vertical axis movements.
WhenDragging	Invert vertical axis movements when dragging in first person modes.
Always	Always invert vertical axis movements.

Definition at line 77 of file qgscameracontroller.h.

Constructor & Destructor Documentation

◆ QgsCameraController()

QgsCameraController::QgsCameraController ( Qt3DCore::QNode * parent = nullptr )

Constructs the camera controller with optional parent node that will take ownership.

Definition at line 33 of file qgscameracontroller.cpp.

Member Function Documentation

◆ camera()

Qt3DRender::QCamera * QgsCameraController::camera ( ) const

inline

Returns camera that is being controlled.

Definition at line 90 of file qgscameracontroller.h.

◆ cameraChanged

void QgsCameraController::cameraChanged ( )

signal

Emitted when camera has been updated.

◆ cameraMovementSpeed()

double QgsCameraController::cameraMovementSpeed ( ) const

inline

Returns the camera movement speed.

Since: QGIS 3.18

Definition at line 104 of file qgscameracontroller.h.

◆ cameraMovementSpeedChanged

void QgsCameraController::cameraMovementSpeedChanged ( double speed )

signal

Emitted whenever the camera movement speed is changed by the controller.

◆ cameraNavigationMode()

QgsCameraController::NavigationMode QgsCameraController::cameraNavigationMode ( ) const

inline

Returns the navigation mode used by the camera controller.

Since: QGIS 3.18

Definition at line 98 of file qgscameracontroller.h.

◆ cameraPose()

QgsCameraPose QgsCameraController::cameraPose ( ) const

inline

Returns camera pose.

Since: QGIS 3.4

Definition at line 165 of file qgscameracontroller.h.

◆ cameraRotationCenterChanged

void QgsCameraController::cameraRotationCenterChanged ( QVector3D position )

signal

Emitted when the camera rotation center changes.

Since: QGIS 3.24

◆ depthBufferCaptured

void QgsCameraController::depthBufferCaptured ( const QImage & depthImage )

slot

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

Since: QGIS 3.24

Definition at line 1075 of file qgscameracontroller.cpp.

◆ distance()

float QgsCameraController::distance ( ) const

inline

Returns distance of the camera from the point it is looking at.

The value should not be smaller than 10.

Since: QGIS 3.4

Definition at line 172 of file qgscameracontroller.h.

◆ frameTriggered()

void QgsCameraController::frameTriggered ( float dt )

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

Definition at line 159 of file qgscameracontroller.cpp.

◆ lookingAtPoint()

QgsVector3D QgsCameraController::lookingAtPoint ( ) const

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

Definition at line 186 of file qgscameracontroller.cpp.

◆ moveView()

void QgsCameraController::moveView	(	float	tx,
		float	ty
	)

Move the map by tx and ty.

Definition at line 1001 of file qgscameracontroller.cpp.

◆ navigationModeChanged

void QgsCameraController::navigationModeChanged ( QgsCameraController::NavigationMode mode )

signal

Emitted when the navigation mode is changed using the hotkey ctrl + ~.

◆ pitch()

float QgsCameraController::pitch ( ) const

inline

Returns pitch angle in degrees (0 = looking from the top, 90 = looking from the side).

The angle should range from 0 to 180.

Since: QGIS 3.4

Definition at line 179 of file qgscameracontroller.h.

◆ readXml()

void QgsCameraController::readXml ( const QDomElement & elem )

Reads camera configuration from the given DOM element.

Definition at line 226 of file qgscameracontroller.cpp.

◆ requestDepthBufferCapture

void QgsCameraController::requestDepthBufferCapture ( )

signal

Emitted to ask for the depth buffer image.

Since: QGIS 3.24

◆ resetView()

void QgsCameraController::resetView ( float distance )

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

Definition at line 164 of file qgscameracontroller.cpp.

◆ rotateAroundViewCenter()

void QgsCameraController::rotateAroundViewCenter ( float deltaYaw )

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

Definition at line 986 of file qgscameracontroller.cpp.

◆ setCamera()

void QgsCameraController::setCamera ( Qt3DRender::QCamera * camera )

Assigns camera that should be controlled by this class. Called internally from 3D scene.

Definition at line 105 of file qgscameracontroller.cpp.

◆ setCameraHeadingAngle()

void QgsCameraController::setCameraHeadingAngle ( float angle )

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

Definition at line 995 of file qgscameracontroller.cpp.

◆ setCameraMovementSpeed()

void QgsCameraController::setCameraMovementSpeed ( double movementSpeed )

Sets the camera movement speed.

Since: QGIS 3.18

Definition at line 83 of file qgscameracontroller.cpp.

◆ setCameraNavigationMode

void QgsCameraController::setCameraNavigationMode ( QgsCameraController::NavigationMode navigationMode )

slot

Sets the navigation mode used by the camera controller.

Since: QGIS 3.18

Definition at line 73 of file qgscameracontroller.cpp.

◆ setCameraPose()

void QgsCameraController::setCameraPose ( const QgsCameraPose & camPose )

Sets camera pose.

Since: QGIS 3.4

Definition at line 201 of file qgscameracontroller.cpp.

◆ setCursorPosition

void QgsCameraController::setCursorPosition ( QPoint point )

signal

Emitted when the mouse cursor position should be moved to the specified point on the map viewport.

◆ setLookingAtPoint()

void QgsCameraController::setLookingAtPoint	(	const QgsVector3D &	point,
		float	distance,
		float	pitch,
		float	yaw
	)

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.

Since: QGIS 3.4

Definition at line 191 of file qgscameracontroller.cpp.

◆ setTerrainEntity()

void QgsCameraController::setTerrainEntity ( QgsTerrainEntity * te )

Connects to object picker attached to terrain entity.

Called internally from 3D scene. This allows camera controller understand how far from the camera is the terrain under mouse cursor. Also it allows adjustment of camera's view center to a point on terrain.

Definition at line 97 of file qgscameracontroller.cpp.

◆ setVerticalAxisInversion()

void QgsCameraController::setVerticalAxisInversion ( QgsCameraController::VerticalAxisInversion inversion )

Sets the vertical axis inversion behavior.

Since: QGIS 3.18

Definition at line 92 of file qgscameracontroller.cpp.

◆ setViewFromTop()

void QgsCameraController::setViewFromTop	(	float	worldX,
		float	worldY,
		float	distance,
		float	yaw = `0`
	)

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

Definition at line 169 of file qgscameracontroller.cpp.

◆ setViewport()

void QgsCameraController::setViewport ( QRect viewport )

Sets viewport rectangle. Called internally from 3D canvas. Allows conversion of mouse coordinates.

Definition at line 118 of file qgscameracontroller.cpp.

◆ tiltUpAroundViewCenter()

void QgsCameraController::tiltUpAroundViewCenter ( float deltaPitch )

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

Definition at line 977 of file qgscameracontroller.cpp.

◆ verticalAxisInversion()

QgsCameraController::VerticalAxisInversion QgsCameraController::verticalAxisInversion ( ) const

inline

Returns the vertical axis inversion behavior.

Since: QGIS 3.18

Definition at line 116 of file qgscameracontroller.h.

◆ viewport()

QRect QgsCameraController::viewport ( ) const

inline

Returns viewport rectangle.

Definition at line 92 of file qgscameracontroller.h.

◆ viewportChanged

void QgsCameraController::viewportChanged ( )

signal

Emitted when viewport rectangle has been updated.

◆ willHandleKeyEvent()

bool QgsCameraController::willHandleKeyEvent ( QKeyEvent * event )

Returns true if the camera controller will handle the specified key event, preventing it from being instead handled by parents of the 3D window before the controller ever receives it.

Definition at line 1020 of file qgscameracontroller.cpp.

◆ writeXml()

QDomElement QgsCameraController::writeXml ( QDomDocument & doc ) const

Writes camera configuration to the given DOM element.

Definition at line 214 of file qgscameracontroller.cpp.

◆ yaw()

float QgsCameraController::yaw ( ) const

inline

Returns yaw angle in degrees.

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

Since: QGIS 3.4

Definition at line 186 of file qgscameracontroller.h.

◆ zoom()

void QgsCameraController::zoom ( float factor )

Zoom the map by factor.

Definition at line 527 of file qgscameracontroller.cpp.

Property Documentation

◆ camera

Qt3DRender::QCamera * QgsCameraController::camera

readwrite

Definition at line 61 of file qgscameracontroller.h.

◆ viewport

QRect QgsCameraController::viewport

readwrite

Definition at line 61 of file qgscameracontroller.h.

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

/build/qgis-3.28.0+99sid/src/3d/qgscameracontroller.h
/build/qgis-3.28.0+99sid/src/3d/qgscameracontroller.cpp

Public Types

Public Slots

Signals

Public Member Functions

Properties

Detailed Description

Member Enumeration Documentation

◆ NavigationMode

◆ VerticalAxisInversion

Constructor & Destructor Documentation

◆ QgsCameraController()

Member Function Documentation

◆ camera()

◆ cameraChanged

◆ cameraMovementSpeed()

◆ cameraMovementSpeedChanged

◆ cameraNavigationMode()

◆ cameraPose()

◆ cameraRotationCenterChanged

◆ depthBufferCaptured

◆ distance()

◆ frameTriggered()

◆ lookingAtPoint()

◆ moveView()

◆ navigationModeChanged

◆ pitch()

◆ readXml()

◆ requestDepthBufferCapture

◆ resetView()

◆ rotateAroundViewCenter()

◆ setCamera()

◆ setCameraHeadingAngle()

◆ setCameraMovementSpeed()

◆ setCameraNavigationMode

◆ setCameraPose()

◆ setCursorPosition

◆ setLookingAtPoint()

◆ setTerrainEntity()

◆ setVerticalAxisInversion()

◆ setViewFromTop()

◆ setViewport()

◆ tiltUpAroundViewCenter()

◆ verticalAxisInversion()

◆ viewport()

◆ viewportChanged

◆ willHandleKeyEvent()

◆ writeXml()

◆ yaw()

◆ zoom()

Property Documentation

◆ camera

◆ viewport