Struct qt_3d_extras::QOrbitCameraController

#[repr(C)]pub struct QOrbitCameraController { /* fields omitted */ }

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

C++ class: Qt3DExtras::QOrbitCameraController.

C++ documentation:

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.

Methods

impl QOrbitCameraController

pub fn camera_changed(&self) -> Signal<()>

Holds the currently controlled camera.

Returns a built-in Qt signal Qt3DExtras::QOrbitCameraController::cameraChanged that can be passed to qt_core::Signal::connect.

C++ documentation:

Holds the currently controlled camera.

Access functions:

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

Notifier signal:

void	cameraChanged()

pub fn linear_speed_changed(&self) -> Signal<()>

Holds the current linear speed of the camera controller. Linear speed determines the movement speed of the camera.

Returns a built-in Qt signal Qt3DExtras::QOrbitCameraController::linearSpeedChanged that can be passed to qt_core::Signal::connect.

C++ documentation:

Holds the current linear speed of the camera controller. Linear speed determines the movement speed of the camera.

Access functions:

float	linearSpeed() const
void	setLinearSpeed(float linearSpeed)

Notifier signal:

void	linearSpeedChanged()

pub fn look_speed_changed(&self) -> Signal<()>

Holds the current look speed of the camera controller. The look speed determines the turn rate of the camera pan and tilt.

Returns a built-in Qt signal Qt3DExtras::QOrbitCameraController::lookSpeedChanged that can be passed to qt_core::Signal::connect.

C++ documentation:

Holds the current look speed of the camera controller. The look speed determines the turn rate of the camera pan and tilt.

Access functions:

float	lookSpeed() const
void	setLookSpeed(float lookSpeed)

Notifier signal:

void	lookSpeedChanged()

pub fn zoom_in_limit_changed(&self) -> Signal<()>

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

Returns a built-in Qt signal Qt3DExtras::QOrbitCameraController::zoomInLimitChanged that can be passed to qt_core::Signal::connect.

C++ documentation:

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()

pub unsafe fn camera(&self) -> QPtr<QCamera>

Holds the currently controlled camera.

Calls C++ function: Qt3DRender::QCamera* Qt3DExtras::QOrbitCameraController::camera() const.

C++ documentation:

Holds the currently controlled camera.

Access functions:

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

Notifier signal:

void	cameraChanged()

pub unsafe fn linear_speed(&self) -> c_float

Holds the current linear speed of the camera controller. Linear speed determines the movement speed of the camera.

Calls C++ function: float Qt3DExtras::QOrbitCameraController::linearSpeed() const.

C++ documentation:

Holds the current linear speed of the camera controller. Linear speed determines the movement speed of the camera.

Access functions:

float	linearSpeed() const
void	setLinearSpeed(float linearSpeed)

Notifier signal:

void	linearSpeedChanged()

pub unsafe fn look_speed(&self) -> c_float

Holds the current look speed of the camera controller. The look speed determines the turn rate of the camera pan and tilt.

Calls C++ function: float Qt3DExtras::QOrbitCameraController::lookSpeed() const.

C++ documentation:

Holds the current look speed of the camera controller. The look speed determines the turn rate of the camera pan and tilt.

Access functions:

float	lookSpeed() const
void	setLookSpeed(float lookSpeed)

Notifier signal:

void	lookSpeedChanged()

pub unsafe fn meta_object(&self) -> Ptr<QMetaObject>

Calls C++ function: virtual const QMetaObject* Qt3DExtras::QOrbitCameraController::metaObject() const.

pub unsafe fn new_1a(
    parent: impl CastInto<Ptr<QNode>>
) -> QBox<QOrbitCameraController>

Default constructs an instance of QOrbitCameraController.

Calls C++ function: [constructor] void Qt3DExtras::QOrbitCameraController::QOrbitCameraController(Qt3DCore::QNode* parent = …).

C++ documentation:

Default constructs an instance of QOrbitCameraController.

pub unsafe fn new_0a() -> QBox<QOrbitCameraController>

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

Calls C++ function: [constructor] void Qt3DExtras::QOrbitCameraController::QOrbitCameraController().

C++ documentation:

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.

pub unsafe fn qt_metacall(
    &self,
    arg1: Call,
    arg2: c_int,
    arg3: *mut *mut c_void
) -> c_int

Calls C++ function: virtual int Qt3DExtras::QOrbitCameraController::qt_metacall(QMetaObject::Call arg1, int arg2, void** arg3).

pub unsafe fn qt_metacast(&self, arg1: *const c_char) -> *mut c_void

Calls C++ function: virtual void* Qt3DExtras::QOrbitCameraController::qt_metacast(const char* arg1).

pub unsafe fn set_camera(&self, camera: impl CastInto<Ptr<QCamera>>)

Holds the currently controlled camera.

Calls C++ function: void Qt3DExtras::QOrbitCameraController::setCamera(Qt3DRender::QCamera* camera).

C++ documentation:

Holds the currently controlled camera.

Access functions:

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

Notifier signal:

void	cameraChanged()

pub unsafe fn set_linear_speed(&self, linear_speed: c_float)

Holds the current linear speed of the camera controller. Linear speed determines the movement speed of the camera.

Calls C++ function: void Qt3DExtras::QOrbitCameraController::setLinearSpeed(float linearSpeed).

C++ documentation:

Holds the current linear speed of the camera controller. Linear speed determines the movement speed of the camera.

Access functions:

float	linearSpeed() const
void	setLinearSpeed(float linearSpeed)

Notifier signal:

void	linearSpeedChanged()

pub unsafe fn set_look_speed(&self, look_speed: c_float)

Holds the current look speed of the camera controller. The look speed determines the turn rate of the camera pan and tilt.

Calls C++ function: void Qt3DExtras::QOrbitCameraController::setLookSpeed(float lookSpeed).

C++ documentation:

Holds the current look speed of the camera controller. The look speed determines the turn rate of the camera pan and tilt.

Access functions:

float	lookSpeed() const
void	setLookSpeed(float lookSpeed)

Notifier signal:

void	lookSpeedChanged()

pub unsafe fn set_zoom_in_limit(&self, zoom_in_limit: c_float)

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

Calls C++ function: void Qt3DExtras::QOrbitCameraController::setZoomInLimit(float zoomInLimit).

C++ documentation:

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()

pub unsafe fn static_meta_object() -> Ref<QMetaObject>

Returns a reference to the staticMetaObject field.

pub unsafe fn tr(
    s: *const c_char,
    c: *const c_char,
    n: c_int
) -> CppBox<QString>

Calls C++ function: static QString Qt3DExtras::QOrbitCameraController::tr(const char* s, const char* c, int n).

pub unsafe fn tr_utf8(
    s: *const c_char,
    c: *const c_char,
    n: c_int
) -> CppBox<QString>

Calls C++ function: static QString Qt3DExtras::QOrbitCameraController::trUtf8(const char* s, const char* c, int n).

pub unsafe fn zoom_in_limit(&self) -> c_float

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

Calls C++ function: float Qt3DExtras::QOrbitCameraController::zoomInLimit() const.

C++ documentation:

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()

Trait Implementations

impl CppDeletable for QOrbitCameraController

unsafe fn delete(&self)

Destroys the instance of QOrbitCameraController.

Calls C++ function: virtual [destructor] void Qt3DExtras::QOrbitCameraController::~QOrbitCameraController().

C++ documentation:

Destroys the instance of QOrbitCameraController.

impl Deref for QOrbitCameraController

type Target = QEntity

The resulting type after dereferencing.

fn deref(&self) -> &QEntity

Calls C++ function: Qt3DCore::QEntity* static_cast<Qt3DCore::QEntity*>(Qt3DExtras::QOrbitCameraController* ptr).

impl DynamicCast<QOrbitCameraController> for QEntity

unsafe fn dynamic_cast(ptr: Ptr<QEntity>) -> Ptr<QOrbitCameraController>

Calls C++ function: Qt3DExtras::QOrbitCameraController* dynamic_cast<Qt3DExtras::QOrbitCameraController*>(Qt3DCore::QEntity* ptr).

impl DynamicCast<QOrbitCameraController> for QNode

unsafe fn dynamic_cast(ptr: Ptr<QNode>) -> Ptr<QOrbitCameraController>

Calls C++ function: Qt3DExtras::QOrbitCameraController* dynamic_cast<Qt3DExtras::QOrbitCameraController*>(Qt3DCore::QNode* ptr).

impl DynamicCast<QOrbitCameraController> for QObject

unsafe fn dynamic_cast(ptr: Ptr<QObject>) -> Ptr<QOrbitCameraController>

Calls C++ function: Qt3DExtras::QOrbitCameraController* dynamic_cast<Qt3DExtras::QOrbitCameraController*>(QObject* ptr).

impl DynamicCast<QOrbitCameraController> for QAbstractCameraController

unsafe fn dynamic_cast(
    ptr: Ptr<QAbstractCameraController>
) -> Ptr<QOrbitCameraController>

Calls C++ function: Qt3DExtras::QOrbitCameraController* dynamic_cast<Qt3DExtras::QOrbitCameraController*>(Qt3DExtras::QAbstractCameraController* ptr).

impl StaticDowncast<QOrbitCameraController> for QEntity

unsafe fn static_downcast(ptr: Ptr<QEntity>) -> Ptr<QOrbitCameraController>

Calls C++ function: Qt3DExtras::QOrbitCameraController* static_cast<Qt3DExtras::QOrbitCameraController*>(Qt3DCore::QEntity* ptr).

impl StaticDowncast<QOrbitCameraController> for QNode

unsafe fn static_downcast(ptr: Ptr<QNode>) -> Ptr<QOrbitCameraController>

Calls C++ function: Qt3DExtras::QOrbitCameraController* static_cast<Qt3DExtras::QOrbitCameraController*>(Qt3DCore::QNode* ptr).

impl StaticDowncast<QOrbitCameraController> for QObject

unsafe fn static_downcast(ptr: Ptr<QObject>) -> Ptr<QOrbitCameraController>

Calls C++ function: Qt3DExtras::QOrbitCameraController* static_cast<Qt3DExtras::QOrbitCameraController*>(QObject* ptr).

impl StaticDowncast<QOrbitCameraController> for QAbstractCameraController

unsafe fn static_downcast(
    ptr: Ptr<QAbstractCameraController>
) -> Ptr<QOrbitCameraController>

Calls C++ function: Qt3DExtras::QOrbitCameraController* static_cast<Qt3DExtras::QOrbitCameraController*>(Qt3DExtras::QAbstractCameraController* ptr).

impl StaticUpcast<QAbstractCameraController> for QOrbitCameraController

unsafe fn static_upcast(
    ptr: Ptr<QOrbitCameraController>
) -> Ptr<QAbstractCameraController>

Calls C++ function: Qt3DExtras::QAbstractCameraController* static_cast<Qt3DExtras::QAbstractCameraController*>(Qt3DExtras::QOrbitCameraController* ptr).

impl StaticUpcast<QEntity> for QOrbitCameraController

unsafe fn static_upcast(ptr: Ptr<QOrbitCameraController>) -> Ptr<QEntity>

Calls C++ function: Qt3DCore::QEntity* static_cast<Qt3DCore::QEntity*>(Qt3DExtras::QOrbitCameraController* ptr).

impl StaticUpcast<QNode> for QOrbitCameraController

unsafe fn static_upcast(ptr: Ptr<QOrbitCameraController>) -> Ptr<QNode>

Calls C++ function: Qt3DCore::QNode* static_cast<Qt3DCore::QNode*>(Qt3DExtras::QOrbitCameraController* ptr).

impl StaticUpcast<QObject> for QOrbitCameraController

unsafe fn static_upcast(ptr: Ptr<QOrbitCameraController>) -> Ptr<QObject>

Calls C++ function: QObject* static_cast<QObject*>(Qt3DExtras::QOrbitCameraController* ptr).