PySide6.Qt3DExtras.Qt3DExtras.QOrbitCameraController

class QOrbitCameraController

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

Details

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.

Synopsis

Properties

• inversePanᅟ - Holds whether panning is inverted

• inverseTiltᅟ - Holds whether tilting is inverted

• inverseXTranslateᅟ - Holds whether the horizontal translation is inverted

• inverseYTranslateᅟ - Holds whether the vertical translation is inverted

• upVectorᅟ - Holds the up vector for the camera’s orbital rotation

• zoomInLimitᅟ

• zoomTranslateViewCenterᅟ - Holds whether the view center is translated during zoom operations

Methods

• def __init__()

• def inversePan()

• def inverseTilt()

• def inverseXTranslate()

• def inverseYTranslate()

• def upVector()

• def zoomInLimit()

• def zoomTranslateViewCenter()

Slots

• def setInversePan()

• def setInverseTilt()

• def setInverseXTranslate()

• def setInverseYTranslate()

• def setUpVector()

• def setZoomInLimit()

• def setZoomTranslateViewCenter()

Signals

• def inversePanChanged()

• def inverseTiltChanged()

• def inverseXTranslateChanged()

• def inverseYTranslateChanged()

• def upVectorChanged()

• def zoomInLimitChanged()

• def zoomTranslateViewCenterChanged()

Note

This documentation may contain snippets that were automatically translated from C++ to Python. We always welcome contributions to the snippet translation. If you see an issue with the translation, you can also let us know by creating a ticket on https:/bugreports.qt.io/projects/PYSIDE

Note

Properties can be used directly when from __feature__ import true_property is used or via accessor functions otherwise.

property inversePanᅟ: bool

This property Holds whether panning is inverted..

When enabled, horizontal pan movements rotate the camera around the view center in the opposite direction.

Access functions:

• inversePan()

• setInversePan()

• Signal inversePanChanged()

property inverseTiltᅟ: bool

This property Holds whether tilting is inverted..

When enabled, vertical tilt movements rotate the camera around the view center in the opposite direction.

Access functions:

• inverseTilt()

• setInverseTilt()

• Signal inverseTiltChanged()

property inverseXTranslateᅟ: bool

This property Holds whether the horizontal translation is inverted..

When enabled, horizontal mouse movements and input translate the camera in the opposite direction.

Access functions:

• inverseXTranslate()

• setInverseXTranslate()

• Signal inverseXTranslateChanged()

property inverseYTranslateᅟ: bool

This property Holds whether the vertical translation is inverted..

When enabled, vertical mouse movements and input translate the camera in the opposite direction.

Access functions:

• inverseYTranslate()

• setInverseYTranslate()

• Signal inverseYTranslateChanged()

property upVectorᅟ: QVector3D

This property Holds the up vector for the camera’s orbital rotation..

The up vector defines the vertical axis around which the camera orbits. The default value is (0.0, 1.0, 0.0).

Access functions:

• upVector()

• setUpVector()

• Signal upVectorChanged()

property 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:

• zoomInLimit()

• setZoomInLimit()

• Signal zoomInLimitChanged()

property zoomTranslateViewCenterᅟ: bool

This property Holds whether the view center is translated during zoom operations..

When enabled, zooming translates the view center. When disabled, only the camera position changes during zoom operations. The default value is true.

Access functions:

• zoomTranslateViewCenter()

• setZoomTranslateViewCenter()

• Signal zoomTranslateViewCenterChanged()

__init__([parent=None])

Parameters:

parent – QNode

inversePan()

Return type:

bool

See also

setInversePan()

Getter of property inversePanᅟ .

inversePanChanged(isInverse)

Parameters:

isInverse – bool

Notification signal of property inversePanᅟ .

inverseTilt()

Return type:

bool

See also

setInverseTilt()

Getter of property inverseTiltᅟ .

inverseTiltChanged(isInverse)

Parameters:

isInverse – bool

Notification signal of property inverseTiltᅟ .

inverseXTranslate()

Return type:

bool

See also

setInverseXTranslate()

Getter of property inverseXTranslateᅟ .

inverseXTranslateChanged(isInverse)

Parameters:

isInverse – bool

Notification signal of property inverseXTranslateᅟ .

inverseYTranslate()

Return type:

bool

See also

setInverseYTranslate()

Getter of property inverseYTranslateᅟ .

inverseYTranslateChanged(isInverse)

Parameters:

isInverse – bool

Notification signal of property inverseYTranslateᅟ .

setInversePan(isInverse)

Parameters:

isInverse – bool

See also

inversePan()

Setter of property inversePanᅟ .

setInverseTilt(isInverse)

Parameters:

isInverse – bool

See also

inverseTilt()

Setter of property inverseTiltᅟ .

setInverseXTranslate(isInverse)

Parameters:

isInverse – bool

See also

inverseXTranslate()

Setter of property inverseXTranslateᅟ .

setInverseYTranslate(isInverse)

Parameters:

isInverse – bool

See also

inverseYTranslate()

Setter of property inverseYTranslateᅟ .

setUpVector(upVector)

Parameters:

upVector – QVector3D

See also

upVector()

Setter of property upVectorᅟ .

setZoomInLimit(zoomInLimit)

Parameters:

zoomInLimit – float

See also

zoomInLimit()

Setter of property zoomInLimitᅟ .

setZoomTranslateViewCenter(isTranslate)

Parameters:

isTranslate – bool

See also

zoomTranslateViewCenter()

Setter of property zoomTranslateViewCenterᅟ .

upVector()

Return type:

QVector3D

See also

setUpVector()

Getter of property upVectorᅟ .

upVectorChanged(upVector)

Parameters:

upVector – QVector3D

Notification signal of property upVectorᅟ .

zoomInLimit()

Return type:

float

See also

setZoomInLimit()

Getter of property zoomInLimitᅟ .

zoomInLimitChanged()

Notification signal of property zoomInLimitᅟ .

zoomTranslateViewCenter()

Return type:

bool

See also

setZoomTranslateViewCenter()

Getter of property zoomTranslateViewCenterᅟ .

zoomTranslateViewCenterChanged(isTranslate)

Parameters:

isTranslate – bool

Notification signal of property zoomTranslateViewCenterᅟ .