Struct qt_3d_render::QPickingSettings

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

The QPickingSettings class specifies how entity picking is handled.

C++ class: Qt3DRender::QPickingSettings.

C++ documentation:

The QPickingSettings class specifies how entity picking is handled.

The picking settings determine how the entity picking is handled. For more details about entity picking, see QObjectPicker component documentation.

Picking is triggered by mouse events. It will cast a ray through the scene and look for geometry intersecting the ray.

Methods

impl QPickingSettings

pub fn slot_set_pick_method(&self) -> Receiver<(PickMethod,)>

Holds the current pick method.

Returns a built-in Qt slot Qt3DRender::QPickingSettings::setPickMethod that can be passed to qt_core::Signal::connect.

C++ documentation:

Holds the current pick method.

By default, for performance reasons, ray casting will use bounding volume picking. This may however lead to unexpected results if a small object is englobed in the bounding sphere of a large object behind it.

Triangle picking will produce exact results but is computationally more expensive.

Access functions:

PickMethod	pickMethod() const
void	setPickMethod(PickMethod pickMethod)

Notifier signal:

void	pickMethodChanged(QPickingSettings::PickMethod pickMethod)

pub fn slot_set_pick_result_mode(&self) -> Receiver<(PickResultMode,)>

Holds the current pick results mode.

Returns a built-in Qt slot Qt3DRender::QPickingSettings::setPickResultMode that can be passed to qt_core::Signal::connect.

C++ documentation:

Holds the current pick results mode.

By default, pick results will only be produced for the entity closest to the camera.

When setting the pick method to AllPicks, events will be triggered for all the entities with a QObjectPicker along the ray.

If a QObjectPicker is assigned to an entity with multiple children, an event will be triggered for each child entity that intersects the ray.

Access functions:

PickResultMode	pickResultMode() const
void	setPickResultMode(PickResultMode pickResultMode)

Notifier signal:

void	pickResultModeChanged(QPickingSettings::PickResultMode pickResult)

pub fn slot_set_face_orientation_picking_mode(
    &self
) -> Receiver<(FaceOrientationPickingMode,)>

Specifies how face orientation affects triangle picking

Returns a built-in Qt slot Qt3DRender::QPickingSettings::setFaceOrientationPickingMode that can be passed to qt_core::Signal::connect.

C++ documentation:

Specifies how face orientation affects triangle picking

Access functions:

FaceOrientationPickingMode	faceOrientationPickingMode() const
void	setFaceOrientationPickingMode(FaceOrientationPickingMode faceOrientationPickingMode)

Notifier signal:

void	faceOrientationPickingModeChanged(QPickingSettings::FaceOrientationPickingMode faceOrientationPickingMode)

pub fn pick_method_changed(&self) -> Signal<(PickMethod,)>

Holds the current pick method.

Returns a built-in Qt signal Qt3DRender::QPickingSettings::pickMethodChanged that can be passed to qt_core::Signal::connect.

C++ documentation:

Holds the current pick method.

By default, for performance reasons, ray casting will use bounding volume picking. This may however lead to unexpected results if a small object is englobed in the bounding sphere of a large object behind it.

Triangle picking will produce exact results but is computationally more expensive.

Access functions:

PickMethod	pickMethod() const
void	setPickMethod(PickMethod pickMethod)

Notifier signal:

void	pickMethodChanged(QPickingSettings::PickMethod pickMethod)

pub fn pick_result_mode_changed(&self) -> Signal<(PickResultMode,)>

Holds the current pick results mode.

Returns a built-in Qt signal Qt3DRender::QPickingSettings::pickResultModeChanged that can be passed to qt_core::Signal::connect.

C++ documentation:

Holds the current pick results mode.

By default, pick results will only be produced for the entity closest to the camera.

When setting the pick method to AllPicks, events will be triggered for all the entities with a QObjectPicker along the ray.

If a QObjectPicker is assigned to an entity with multiple children, an event will be triggered for each child entity that intersects the ray.

Access functions:

PickResultMode	pickResultMode() const
void	setPickResultMode(PickResultMode pickResultMode)

Notifier signal:

void	pickResultModeChanged(QPickingSettings::PickResultMode pickResult)

pub fn face_orientation_picking_mode_changed(
    &self
) -> Signal<(FaceOrientationPickingMode,)>

Specifies how face orientation affects triangle picking

Returns a built-in Qt signal Qt3DRender::QPickingSettings::faceOrientationPickingModeChanged that can be passed to qt_core::Signal::connect.

C++ documentation:

Specifies how face orientation affects triangle picking

Access functions:

FaceOrientationPickingMode	faceOrientationPickingMode() const
void	setFaceOrientationPickingMode(FaceOrientationPickingMode faceOrientationPickingMode)

Notifier signal:

void	faceOrientationPickingModeChanged(QPickingSettings::FaceOrientationPickingMode faceOrientationPickingMode)

pub unsafe fn face_orientation_picking_mode(&self) -> FaceOrientationPickingMode

Specifies how face orientation affects triangle picking

Calls C++ function: Qt3DRender::QPickingSettings::FaceOrientationPickingMode Qt3DRender::QPickingSettings::faceOrientationPickingMode() const.

C++ documentation:

Specifies how face orientation affects triangle picking

Access functions:

FaceOrientationPickingMode	faceOrientationPickingMode() const
void	setFaceOrientationPickingMode(FaceOrientationPickingMode faceOrientationPickingMode)

Notifier signal:

void	faceOrientationPickingModeChanged(QPickingSettings::FaceOrientationPickingMode faceOrientationPickingMode)

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

Calls C++ function: virtual const QMetaObject* Qt3DRender::QPickingSettings::metaObject() const.

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

Default constructs an instance of QPickingSettings.

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

C++ documentation:

Default constructs an instance of QPickingSettings.

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

The QPickingSettings class specifies how entity picking is handled.

Calls C++ function: [constructor] void Qt3DRender::QPickingSettings::QPickingSettings().

C++ documentation:

The QPickingSettings class specifies how entity picking is handled.

The picking settings determine how the entity picking is handled. For more details about entity picking, see QObjectPicker component documentation.

Picking is triggered by mouse events. It will cast a ray through the scene and look for geometry intersecting the ray.

pub unsafe fn pick_method(&self) -> PickMethod

Holds the current pick method.

Calls C++ function: Qt3DRender::QPickingSettings::PickMethod Qt3DRender::QPickingSettings::pickMethod() const.

C++ documentation:

Holds the current pick method.

By default, for performance reasons, ray casting will use bounding volume picking. This may however lead to unexpected results if a small object is englobed in the bounding sphere of a large object behind it.

Triangle picking will produce exact results but is computationally more expensive.

Access functions:

PickMethod	pickMethod() const
void	setPickMethod(PickMethod pickMethod)

Notifier signal:

void	pickMethodChanged(QPickingSettings::PickMethod pickMethod)

pub unsafe fn pick_result_mode(&self) -> PickResultMode

Holds the current pick results mode.

Calls C++ function: Qt3DRender::QPickingSettings::PickResultMode Qt3DRender::QPickingSettings::pickResultMode() const.

C++ documentation:

Holds the current pick results mode.

By default, pick results will only be produced for the entity closest to the camera.

When setting the pick method to AllPicks, events will be triggered for all the entities with a QObjectPicker along the ray.

If a QObjectPicker is assigned to an entity with multiple children, an event will be triggered for each child entity that intersects the ray.

Access functions:

PickResultMode	pickResultMode() const
void	setPickResultMode(PickResultMode pickResultMode)

Notifier signal:

void	pickResultModeChanged(QPickingSettings::PickResultMode pickResult)

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

Calls C++ function: virtual int Qt3DRender::QPickingSettings::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* Qt3DRender::QPickingSettings::qt_metacast(const char* arg1).

pub unsafe fn set_face_orientation_picking_mode(
    &self,
    face_orientation_picking_mode: FaceOrientationPickingMode
)

Specifies how face orientation affects triangle picking

Calls C++ function: [slot] void Qt3DRender::QPickingSettings::setFaceOrientationPickingMode(Qt3DRender::QPickingSettings::FaceOrientationPickingMode faceOrientationPickingMode).

C++ documentation:

Specifies how face orientation affects triangle picking

Access functions:

FaceOrientationPickingMode	faceOrientationPickingMode() const
void	setFaceOrientationPickingMode(FaceOrientationPickingMode faceOrientationPickingMode)

Notifier signal:

void	faceOrientationPickingModeChanged(QPickingSettings::FaceOrientationPickingMode faceOrientationPickingMode)

pub unsafe fn set_pick_method(&self, pick_method: PickMethod)

Holds the current pick method.

Calls C++ function: [slot] void Qt3DRender::QPickingSettings::setPickMethod(Qt3DRender::QPickingSettings::PickMethod pickMethod).

C++ documentation:

Holds the current pick method.

By default, for performance reasons, ray casting will use bounding volume picking. This may however lead to unexpected results if a small object is englobed in the bounding sphere of a large object behind it.

Triangle picking will produce exact results but is computationally more expensive.

Access functions:

PickMethod	pickMethod() const
void	setPickMethod(PickMethod pickMethod)

Notifier signal:

void	pickMethodChanged(QPickingSettings::PickMethod pickMethod)

pub unsafe fn set_pick_result_mode(&self, pick_result_mode: PickResultMode)

Holds the current pick results mode.

Calls C++ function: [slot] void Qt3DRender::QPickingSettings::setPickResultMode(Qt3DRender::QPickingSettings::PickResultMode pickResultMode).

C++ documentation:

Holds the current pick results mode.

By default, pick results will only be produced for the entity closest to the camera.

When setting the pick method to AllPicks, events will be triggered for all the entities with a QObjectPicker along the ray.

If a QObjectPicker is assigned to an entity with multiple children, an event will be triggered for each child entity that intersects the ray.

Access functions:

PickResultMode	pickResultMode() const
void	setPickResultMode(PickResultMode pickResultMode)

Notifier signal:

void	pickResultModeChanged(QPickingSettings::PickResultMode pickResult)

pub unsafe fn set_world_space_tolerance(&self, world_space_tolerance: c_float)

This is supported on cpp_lib_version="5.11.3" or cpp_lib_version="5.12.2" or cpp_lib_version="5.13.0" or cpp_lib_version="5.14.0" only.

Sets the threshold used for line and point picking to worldSpaceTolerance.

Calls C++ function: void Qt3DRender::QPickingSettings::setWorldSpaceTolerance(float worldSpaceTolerance).

C++ documentation:

Sets the threshold used for line and point picking to worldSpaceTolerance.

Note: Setter function for property worldSpaceTolerance.

See also worldSpaceTolerance().

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 Qt3DRender::QPickingSettings::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 Qt3DRender::QPickingSettings::trUtf8(const char* s, const char* c, int n).

pub unsafe fn world_space_tolerance(&self) -> c_float

This is supported on cpp_lib_version="5.11.3" or cpp_lib_version="5.12.2" or cpp_lib_version="5.13.0" or cpp_lib_version="5.14.0" only.

Holds the threshold, in model space coordinates, used to evaluate line and point picking.

Calls C++ function: float Qt3DRender::QPickingSettings::worldSpaceTolerance() const.

C++ documentation:

Holds the threshold, in model space coordinates, used to evaluate line and point picking.

Access functions:

float	worldSpaceTolerance() const
void	setWorldSpaceTolerance(float worldSpaceTolerance)

Notifier signal:

void	worldSpaceToleranceChanged(float worldSpaceTolerance)

pub unsafe fn world_space_tolerance_changed(
    &self,
    world_space_tolerance: c_float
)

This is supported on cpp_lib_version="5.11.3" or cpp_lib_version="5.12.2" or cpp_lib_version="5.13.0" or cpp_lib_version="5.14.0" only.

Holds the threshold, in model space coordinates, used to evaluate line and point picking.

Calls C++ function: void Qt3DRender::QPickingSettings::worldSpaceToleranceChanged(float worldSpaceTolerance).

C++ documentation:

Holds the threshold, in model space coordinates, used to evaluate line and point picking.

Access functions:

float	worldSpaceTolerance() const
void	setWorldSpaceTolerance(float worldSpaceTolerance)

Notifier signal:

void	worldSpaceToleranceChanged(float worldSpaceTolerance)

Trait Implementations

impl CppDeletable for QPickingSettings

unsafe fn delete(&self)

Calls C++ function: virtual [destructor] void Qt3DRender::QPickingSettings::~QPickingSettings().

impl Deref for QPickingSettings

type Target = QNode

The resulting type after dereferencing.

fn deref(&self) -> &QNode

Calls C++ function: Qt3DCore::QNode* static_cast<Qt3DCore::QNode*>(Qt3DRender::QPickingSettings* ptr).

impl DynamicCast<QPickingSettings> for QNode

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

Calls C++ function: Qt3DRender::QPickingSettings* dynamic_cast<Qt3DRender::QPickingSettings*>(Qt3DCore::QNode* ptr).

impl DynamicCast<QPickingSettings> for QObject

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

Calls C++ function: Qt3DRender::QPickingSettings* dynamic_cast<Qt3DRender::QPickingSettings*>(QObject* ptr).

impl StaticDowncast<QPickingSettings> for QNode

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

Calls C++ function: Qt3DRender::QPickingSettings* static_cast<Qt3DRender::QPickingSettings*>(Qt3DCore::QNode* ptr).

impl StaticDowncast<QPickingSettings> for QObject

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

Calls C++ function: Qt3DRender::QPickingSettings* static_cast<Qt3DRender::QPickingSettings*>(QObject* ptr).

impl StaticUpcast<QNode> for QPickingSettings

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

Calls C++ function: Qt3DCore::QNode* static_cast<Qt3DCore::QNode*>(Qt3DRender::QPickingSettings* ptr).

impl StaticUpcast<QObject> for QPickingSettings

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

Calls C++ function: QObject* static_cast<QObject*>(Qt3DRender::QPickingSettings* ptr).