QOrbitCameraController Class | Qt 3D 5.12.11

- Qt 5.12
- Qt 3D
- C++ Classes
- QOrbitCameraController
- Qt 5.12.11 Reference Documentation

# QOrbitCameraController Class

(Qt3DExtras::QOrbitCameraController)

The QOrbitCameraController class allows controlling the scene camera along orbital path. More...

Header: | #include <QOrbitCameraController>
qmake: | QT += 3dextras
Since: | Qt 5.7
Inherits: | Qt3DExtras::QAbstractCameraController

- List of all members, including inherited members
- Obsolete members

## Properties

- zoomInLimit : float

- 5 properties inherited from Qt3DExtras::QAbstractCameraController
- 3 properties inherited from Qt3DCore::QNode
- 1 property inherited from QObject

## Public Functions

| QOrbitCameraController(Qt3DCore::QNode *parent = nullptr)
virtual | ~QOrbitCameraController()
void | setZoomInLimit(float zoomInLimit)
float | zoomInLimit() const

- 10 public functions inherited from Qt3DExtras::QAbstractCameraController
- 4 public functions inherited from Qt3DCore::QEntity
- 13 public functions inherited from Qt3DCore::QNode
- 31 public functions inherited from QObject

## Signals

void | zoomInLimitChanged()

- 5 signals inherited from Qt3DExtras::QAbstractCameraController
- 4 signals inherited from Qt3DCore::QNode
- 2 signals inherited from QObject

## Static Public Members

const QMetaObject | staticMetaObject

- 9 static public members inherited from QObject

### Additional Inherited Members

- 3 public slots inherited from Qt3DCore::QNode
- 1 public slot inherited from QObject
- 2 protected functions inherited from Qt3DExtras::QAbstractCameraController
- 2 protected functions inherited from Qt3DCore::QNode
- 9 protected functions inherited from QObject

## Detailed Description

The QOrbitCameraController class allows controlling the scene camera along orbital path.

The controls are:

Input | Action
--- | ---
Left mouse button | While the left mouse button is pressed, mouse movement along x-axis moves the camera left and right and movement along y-axis moves it up and down.
Right mouse button | While the right mouse button is pressed, mouse movement along x-axis pans the camera around the camera view center and movement along y-axis tilts it around the camera view center.
Both left and right mouse button | While both the left and the right mouse button are pressed, mouse movement along y-axis zooms the camera in and out without changing the view center.
Mouse scroll wheel | Zooms the camera in and out without changing the view center.
Arrow keys | Move the camera vertically and horizontally relative to camera viewport.
Page up and page down keys | Move the camera forwards and backwards.
Shift key | Changes the behavior of the up and down arrow keys to zoom the camera in and out without changing the view center. The other movement keys are disabled.
Alt key | Changes the behovior of the arrow keys to pan and tilt the camera around the view center. Disables the page up and page down keys.
Escape | Moves the camera so that entire scene is visible in the camera viewport.

## Property Documentation

### zoomInLimit : float

Holds the current zoom-in limit. The zoom-in limit determines how close to the view center the camera can be zoomed.

Access functions:

float | zoomInLimit() const
void | setZoomInLimit(float zoomInLimit)

Notifier signal:

void | zoomInLimitChanged()

## Member Function Documentation

### QOrbitCameraController::QOrbitCameraController(Qt3DCore::QNode *parent = nullptr)

Default constructs an instance of QOrbitCameraController.

### `[virtual]` QOrbitCameraController::~QOrbitCameraController()

Destroys the instance of QOrbitCameraController. The destructor is virtual.