Struct QRayCaster

#[repr(C)]
pub struct QRayCaster { /* private fields */ }

Qt3DRender::QRayCaster is used to perform ray casting tests in 3d world coordinates.

C++ class: Qt3DRender::QRayCaster.

C++ documentation:

Qt3DRender::QRayCaster is used to perform ray casting tests in 3d world coordinates.

The 3d ray is defined by its origin, direction and length. It will be affected by the transformations applied to the entity it belongs to.

Ray casting tests will be performed every frame as long as the component is enabled. The hits property will be updated with the list of intersections.

Implementations

impl QRayCaster

pub fn slot_set_origin(&self) -> Receiver<(*const QVector3D,)>

Available 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 origin of the 3D ray in local coordinates.

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

C++ documentation:

Holds the origin of the 3D ray in local coordinates.

Access functions:

QVector3D	origin() const
void	setOrigin(const QVector3D &origin)

Notifier signal:

void	originChanged(const QVector3D &origin)

pub fn slot_set_direction(&self) -> Receiver<(*const QVector3D,)>

Available 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 direction of the 3D ray. This should be a unit vector.

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

C++ documentation:

Holds the direction of the 3D ray. This should be a unit vector.

Access functions:

QVector3D	direction() const
void	setDirection(const QVector3D &direction)

Notifier signal:

void	directionChanged(const QVector3D &direction)

pub fn slot_set_length(&self) -> Receiver<(c_float,)>

Available 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 length of the ray to length.

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

C++ documentation:

Sets the length of the ray to length.

If the value is less than or equal to zero, the ray is concidered to be infinite.

Note: Setter function for property length.

See also length().

pub fn slot_trigger(&self) -> Receiver<()>

Available 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.

Convenience method to enable the component and trigger tests using the current ray.

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

C++ documentation:

Convenience method to enable the component and trigger tests using the current ray.

pub fn slot_trigger2( &self, ) -> Receiver<(*const QVector3D, *const QVector3D, c_float)>

Available 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.

Convenience method to set the ray details origin, direction, and length, and enable the component to trigger tests.

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

C++ documentation:

Convenience method to set the ray details origin, direction, and length, and enable the component to trigger tests.

pub fn origin_changed(&self) -> Signal<(*const QVector3D,)>

Available 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 origin of the 3D ray in local coordinates.

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

C++ documentation:

Holds the origin of the 3D ray in local coordinates.

Access functions:

QVector3D	origin() const
void	setOrigin(const QVector3D &origin)

Notifier signal:

void	originChanged(const QVector3D &origin)

pub fn direction_changed(&self) -> Signal<(*const QVector3D,)>

Available 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 direction of the 3D ray. This should be a unit vector.

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

C++ documentation:

Holds the direction of the 3D ray. This should be a unit vector.

Access functions:

QVector3D	direction() const
void	setDirection(const QVector3D &direction)

Notifier signal:

void	directionChanged(const QVector3D &direction)

pub fn length_changed(&self) -> Signal<(c_float,)>

Available 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 length of the 3D ray.

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

C++ documentation:

Holds the length of the 3D ray.

Access functions:

float	length() const
void	setLength(float length)

Notifier signal:

void	lengthChanged(float length)

pub unsafe fn direction(&self) -> CppBox<QVector3D>

Available 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 direction of the 3D ray. This should be a unit vector.

Calls C++ function: QVector3D Qt3DRender::QRayCaster::direction() const.

C++ documentation:

Holds the direction of the 3D ray. This should be a unit vector.

Access functions:

QVector3D	direction() const
void	setDirection(const QVector3D &direction)

Notifier signal:

void	directionChanged(const QVector3D &direction)

pub unsafe fn length(&self) -> c_float

Available 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 length of the 3D ray.

Calls C++ function: float Qt3DRender::QRayCaster::length() const.

C++ documentation:

Holds the length of the 3D ray.

Access functions:

float	length() const
void	setLength(float length)

Notifier signal:

void	lengthChanged(float length)

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

Available 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.

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

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

Available 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.

Default constructs an instance of QRayCaster.

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

C++ documentation:

Default constructs an instance of QRayCaster.

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

Available 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.

Qt3DRender::QRayCaster is used to perform ray casting tests in 3d world coordinates.

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

C++ documentation:

Qt3DRender::QRayCaster is used to perform ray casting tests in 3d world coordinates.

The 3d ray is defined by its origin, direction and length. It will be affected by the transformations applied to the entity it belongs to.

Ray casting tests will be performed every frame as long as the component is enabled. The hits property will be updated with the list of intersections.

pub unsafe fn origin(&self) -> CppBox<QVector3D>

Available 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 origin of the 3D ray in local coordinates.

Calls C++ function: QVector3D Qt3DRender::QRayCaster::origin() const.

C++ documentation:

Holds the origin of the 3D ray in local coordinates.

Access functions:

QVector3D	origin() const
void	setOrigin(const QVector3D &origin)

Notifier signal:

void	originChanged(const QVector3D &origin)

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

Available 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.

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

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

Available 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.

Calls C++ function: virtual void* Qt3DRender::QRayCaster::qt_metacast(const char* arg1).

pub unsafe fn set_direction(&self, direction: impl CastInto<Ref<QVector3D>>)

Available 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 direction of the 3D ray. This should be a unit vector.

Calls C++ function: [slot] void Qt3DRender::QRayCaster::setDirection(const QVector3D& direction).

C++ documentation:

Holds the direction of the 3D ray. This should be a unit vector.

Access functions:

QVector3D	direction() const
void	setDirection(const QVector3D &direction)

Notifier signal:

void	directionChanged(const QVector3D &direction)

pub unsafe fn set_length(&self, length: c_float)

Available 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 length of the ray to length.

Calls C++ function: [slot] void Qt3DRender::QRayCaster::setLength(float length).

C++ documentation:

Sets the length of the ray to length.

If the value is less than or equal to zero, the ray is concidered to be infinite.

Note: Setter function for property length.

See also length().

pub unsafe fn set_origin(&self, origin: impl CastInto<Ref<QVector3D>>)

Available 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 origin of the 3D ray in local coordinates.

Calls C++ function: [slot] void Qt3DRender::QRayCaster::setOrigin(const QVector3D& origin).

C++ documentation:

Holds the origin of the 3D ray in local coordinates.

Access functions:

QVector3D	origin() const
void	setOrigin(const QVector3D &origin)

Notifier signal:

void	originChanged(const QVector3D &origin)

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

Available 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.

Returns a reference to the staticMetaObject field.

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

Available 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.

Calls C++ function: static QString Qt3DRender::QRayCaster::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>

Available 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.

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

pub unsafe fn trigger_0a(&self)

Available 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.

Convenience method to enable the component and trigger tests using the current ray.

Calls C++ function: [slot] void Qt3DRender::QRayCaster::trigger().

C++ documentation:

Convenience method to enable the component and trigger tests using the current ray.

pub unsafe fn trigger_3a( &self, origin: impl CastInto<Ref<QVector3D>>, direction: impl CastInto<Ref<QVector3D>>, length: c_float, )

Available 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.

Convenience method to set the ray details origin, direction, and length, and enable the component to trigger tests.

Calls C++ function: [slot] void Qt3DRender::QRayCaster::trigger(const QVector3D& origin, const QVector3D& direction, float length).

C++ documentation:

Convenience method to set the ray details origin, direction, and length, and enable the component to trigger tests.

Methods from Deref<Target = QAbstractRayCaster>

pub fn slot_set_run_mode(&self) -> Receiver<(RunMode,)>

Available 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 run mode controlling how often ray casting tests are performed.

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

C++ documentation:

Holds the run mode controlling how often ray casting tests are performed.

If set to SingleShot (the default), when the component is enabled, a single ray casting test will be performed and the component will automatically disable itself.

If set to Continuous, ray casting tests will be performed at every frame as long as the component is enabled.

Access functions:

Qt3DRender::QAbstractRayCaster::RunMode	runMode() const
void	setRunMode(Qt3DRender::QAbstractRayCaster::RunMode runMode)

Notifier signal:

void	runModeChanged(Qt3DRender::QAbstractRayCaster::RunMode runMode)

pub fn slot_set_filter_mode(&self) -> Receiver<(FilterMode,)>

Available 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 filter mode specifying the entities to select for ray casting tests.

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

C++ documentation:

Holds the filter mode specifying the entities to select for ray casting tests.

The default value is AcceptMatchingLayers.

Access functions:

Qt3DRender::QAbstractRayCaster::FilterMode	filterMode() const
void	setFilterMode(Qt3DRender::QAbstractRayCaster::FilterMode filterMode)

Notifier signal:

void	filterModeChanged(Qt3DRender::QAbstractRayCaster::FilterMode filterMode)

pub fn run_mode_changed(&self) -> Signal<(RunMode,)>

Available 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 run mode controlling how often ray casting tests are performed.

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

C++ documentation:

Holds the run mode controlling how often ray casting tests are performed.

If set to SingleShot (the default), when the component is enabled, a single ray casting test will be performed and the component will automatically disable itself.

If set to Continuous, ray casting tests will be performed at every frame as long as the component is enabled.

Access functions:

Qt3DRender::QAbstractRayCaster::RunMode	runMode() const
void	setRunMode(Qt3DRender::QAbstractRayCaster::RunMode runMode)

Notifier signal:

void	runModeChanged(Qt3DRender::QAbstractRayCaster::RunMode runMode)

pub fn filter_mode_changed(&self) -> Signal<(FilterMode,)>

Available 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 filter mode specifying the entities to select for ray casting tests.

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

C++ documentation:

Holds the filter mode specifying the entities to select for ray casting tests.

The default value is AcceptMatchingLayers.

Access functions:

Qt3DRender::QAbstractRayCaster::FilterMode	filterMode() const
void	setFilterMode(Qt3DRender::QAbstractRayCaster::FilterMode filterMode)

Notifier signal:

void	filterModeChanged(Qt3DRender::QAbstractRayCaster::FilterMode filterMode)

pub fn hits_changed(&self) -> Signal<(*const QVectorOfQRayCasterHit,)>

Available 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 results of last ray casting test as a vector of Qt3DRender::QRayCasterHit instances.

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

C++ documentation:

Holds the results of last ray casting test as a vector of Qt3DRender::QRayCasterHit instances.

Note that even if successive tests return the exact same results (or empty results), a change notification will be emitted at every test.

Access functions:

Qt3DRender::QAbstractRayCaster::Hits

hits() const

Notifier signal:

void	hitsChanged(const Qt3DRender::QAbstractRayCaster::Hits &hits)

pub unsafe fn add_layer(&self, layer: impl CastInto<Ptr<QLayer>>)

Available 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.

Add layer to the current list of layers

Calls C++ function: void Qt3DRender::QAbstractRayCaster::addLayer(Qt3DRender::QLayer* layer).

C++ documentation:

Add layer to the current list of layers

pub unsafe fn filter_mode(&self) -> FilterMode

Available 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 filter mode specifying the entities to select for ray casting tests.

Calls C++ function: Qt3DRender::QAbstractRayCaster::FilterMode Qt3DRender::QAbstractRayCaster::filterMode() const.

C++ documentation:

Holds the filter mode specifying the entities to select for ray casting tests.

The default value is AcceptMatchingLayers.

Access functions:

Qt3DRender::QAbstractRayCaster::FilterMode	filterMode() const
void	setFilterMode(Qt3DRender::QAbstractRayCaster::FilterMode filterMode)

Notifier signal:

void	filterModeChanged(Qt3DRender::QAbstractRayCaster::FilterMode filterMode)

pub unsafe fn hits(&self) -> CppBox<QVectorOfQRayCasterHit>

Available 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 results of last ray casting test as a vector of Qt3DRender::QRayCasterHit instances.

Calls C++ function: QVector<Qt3DRender::QRayCasterHit> Qt3DRender::QAbstractRayCaster::hits() const.

C++ documentation:

Holds the results of last ray casting test as a vector of Qt3DRender::QRayCasterHit instances.

Note that even if successive tests return the exact same results (or empty results), a change notification will be emitted at every test.

Access functions:

Qt3DRender::QAbstractRayCaster::Hits

hits() const

Notifier signal:

void	hitsChanged(const Qt3DRender::QAbstractRayCaster::Hits &hits)

pub unsafe fn layers(&self) -> CppBox<QVectorOfQLayer>

Available 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.

Returns the current list of layers

Calls C++ function: QVector<Qt3DRender::QLayer*> Qt3DRender::QAbstractRayCaster::layers() const.

C++ documentation:

Returns the current list of layers

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

Available 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.

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

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

Available 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.

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

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

Available 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.

Calls C++ function: virtual void* Qt3DRender::QAbstractRayCaster::qt_metacast(const char* arg1).

pub unsafe fn remove_layer(&self, layer: impl CastInto<Ptr<QLayer>>)

Available 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.

Remove layer from the current list of layers

Calls C++ function: void Qt3DRender::QAbstractRayCaster::removeLayer(Qt3DRender::QLayer* layer).

C++ documentation:

Remove layer from the current list of layers

pub unsafe fn run_mode(&self) -> RunMode

Available 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 run mode controlling how often ray casting tests are performed.

Calls C++ function: Qt3DRender::QAbstractRayCaster::RunMode Qt3DRender::QAbstractRayCaster::runMode() const.

C++ documentation:

Holds the run mode controlling how often ray casting tests are performed.

If set to SingleShot (the default), when the component is enabled, a single ray casting test will be performed and the component will automatically disable itself.

If set to Continuous, ray casting tests will be performed at every frame as long as the component is enabled.

Access functions:

Qt3DRender::QAbstractRayCaster::RunMode	runMode() const
void	setRunMode(Qt3DRender::QAbstractRayCaster::RunMode runMode)

Notifier signal:

void	runModeChanged(Qt3DRender::QAbstractRayCaster::RunMode runMode)

pub unsafe fn set_filter_mode(&self, filter_mode: FilterMode)

Available 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 filter mode specifying the entities to select for ray casting tests.

Calls C++ function: [slot] void Qt3DRender::QAbstractRayCaster::setFilterMode(Qt3DRender::QAbstractRayCaster::FilterMode filterMode).

C++ documentation:

Holds the filter mode specifying the entities to select for ray casting tests.

The default value is AcceptMatchingLayers.

Access functions:

Qt3DRender::QAbstractRayCaster::FilterMode	filterMode() const
void	setFilterMode(Qt3DRender::QAbstractRayCaster::FilterMode filterMode)

Notifier signal:

void	filterModeChanged(Qt3DRender::QAbstractRayCaster::FilterMode filterMode)

pub unsafe fn set_run_mode(&self, run_mode: RunMode)

Available 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 run mode controlling how often ray casting tests are performed.

Calls C++ function: [slot] void Qt3DRender::QAbstractRayCaster::setRunMode(Qt3DRender::QAbstractRayCaster::RunMode runMode).

C++ documentation:

Holds the run mode controlling how often ray casting tests are performed.

If set to SingleShot (the default), when the component is enabled, a single ray casting test will be performed and the component will automatically disable itself.

If set to Continuous, ray casting tests will be performed at every frame as long as the component is enabled.

Access functions:

Qt3DRender::QAbstractRayCaster::RunMode	runMode() const
void	setRunMode(Qt3DRender::QAbstractRayCaster::RunMode runMode)

Notifier signal:

void	runModeChanged(Qt3DRender::QAbstractRayCaster::RunMode runMode)

Methods from Deref<Target = QComponent>

pub fn slot_set_shareable(&self) -> Receiver<(bool,)>

Holds the shareable flag of the QComponent. The QComponent can be shared across several entities if true.

Returns a built-in Qt slot Qt3DCore::QComponent::setShareable that can be passed to qt_core::Signal::connect.

C++ documentation:

Holds the shareable flag of the QComponent. The QComponent can be shared across several entities if true.

Access functions:

bool	isShareable() const
void	setShareable(bool isShareable)

Notifier signal:

void	shareableChanged(bool isShareable)

pub fn shareable_changed(&self) -> Signal<(bool,)>

Holds the shareable flag of the QComponent. The QComponent can be shared across several entities if true.

Returns a built-in Qt signal Qt3DCore::QComponent::shareableChanged that can be passed to qt_core::Signal::connect.

C++ documentation:

Holds the shareable flag of the QComponent. The QComponent can be shared across several entities if true.

Access functions:

bool	isShareable() const
void	setShareable(bool isShareable)

Notifier signal:

void	shareableChanged(bool isShareable)

pub fn added_to_entity(&self) -> Signal<(*mut QEntity,)>

Indicates that a reference has been added to entity.

Returns a built-in Qt signal Qt3DCore::QComponent::addedToEntity that can be passed to qt_core::Signal::connect.

C++ documentation:

Indicates that a reference has been added to entity.

pub fn removed_from_entity(&self) -> Signal<(*mut QEntity,)>

Indicates that a reference has been removed from entity.

Returns a built-in Qt signal Qt3DCore::QComponent::removedFromEntity that can be passed to qt_core::Signal::connect.

C++ documentation:

Indicates that a reference has been removed from entity.

pub unsafe fn entities(&self) -> CppBox<QVectorOfQEntity>

Returns a QVector containing all the entities that reference this component.

Calls C++ function: QVector<Qt3DCore::QEntity*> Qt3DCore::QComponent::entities() const.

C++ documentation:

Returns a QVector containing all the entities that reference this component.

pub unsafe fn is_shareable(&self) -> bool

Holds the shareable flag of the QComponent. The QComponent can be shared across several entities if true.

Calls C++ function: bool Qt3DCore::QComponent::isShareable() const.

C++ documentation:

Holds the shareable flag of the QComponent. The QComponent can be shared across several entities if true.

Access functions:

bool	isShareable() const
void	setShareable(bool isShareable)

Notifier signal:

void	shareableChanged(bool isShareable)

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

Calls C++ function: virtual const QMetaObject* Qt3DCore::QComponent::metaObject() const.

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

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

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

Calls C++ function: virtual void* Qt3DCore::QComponent::qt_metacast(const char* arg1).

pub unsafe fn set_shareable(&self, is_shareable: bool)

Holds the shareable flag of the QComponent. The QComponent can be shared across several entities if true.

Calls C++ function: [slot] void Qt3DCore::QComponent::setShareable(bool isShareable).

C++ documentation:

Holds the shareable flag of the QComponent. The QComponent can be shared across several entities if true.

Access functions:

bool	isShareable() const
void	setShareable(bool isShareable)

Notifier signal:

void	shareableChanged(bool isShareable)

Methods from Deref<Target = QNode>

pub fn slot_set_parent(&self) -> Receiver<(*mut QNode,)>

Holds the immediate QNode parent, or null if the node has no parent.

Returns a built-in Qt slot Qt3DCore::QNode::setParent that can be passed to qt_core::Signal::connect.

C++ documentation:

Holds the immediate QNode parent, or null if the node has no parent.

Setting the parent will notify the backend aspects about current QNode instance's parent change.

Note: if parent happens to be null, this will actually notify that the current QNode instance was removed from the scene.

Access functions:

QNode *	parentNode() const
void	setParent(QNode *parent)

Notifier signal:

void	parentChanged(QObject *parent)

pub fn slot_set_enabled(&self) -> Receiver<(bool,)>

Holds the QNode enabled flag. By default a QNode is always enabled.

Returns a built-in Qt slot Qt3DCore::QNode::setEnabled that can be passed to qt_core::Signal::connect.

C++ documentation:

Holds the QNode enabled flag. By default a QNode is always enabled.

Note: the interpretation of what enabled means is aspect-dependent. Even if enabled is set to false, some aspects may still consider the node in some manner. This is documented on a class by class basis.

Access functions:

bool	isEnabled() const
void	setEnabled(bool isEnabled)

Notifier signal:

void	enabledChanged(bool enabled)

pub fn slot_set_default_property_tracking_mode( &self, ) -> Receiver<(PropertyTrackingMode,)>

Holds the default property tracking mode which determines whether a QNode should be listening for property updates. This only applies to properties which haven't been overridden by a call to setPropertyTracking.

Returns a built-in Qt slot Qt3DCore::QNode::setDefaultPropertyTrackingMode that can be passed to qt_core::Signal::connect.

C++ documentation:

Holds the default property tracking mode which determines whether a QNode should be listening for property updates. This only applies to properties which haven’t been overridden by a call to setPropertyTracking.

By default it is set to QNode::TrackFinalValues

Access functions:

PropertyTrackingMode	defaultPropertyTrackingMode() const
void	setDefaultPropertyTrackingMode(PropertyTrackingMode mode)

Notifier signal:

void	defaultPropertyTrackingModeChanged(PropertyTrackingMode mode)

pub fn parent_changed(&self) -> Signal<(*mut QObject,)>

Holds the immediate QNode parent, or null if the node has no parent.

Returns a built-in Qt signal Qt3DCore::QNode::parentChanged that can be passed to qt_core::Signal::connect.

C++ documentation:

Holds the immediate QNode parent, or null if the node has no parent.

Setting the parent will notify the backend aspects about current QNode instance's parent change.

Note: if parent happens to be null, this will actually notify that the current QNode instance was removed from the scene.

Access functions:

QNode *	parentNode() const
void	setParent(QNode *parent)

Notifier signal:

void	parentChanged(QObject *parent)

pub fn enabled_changed(&self) -> Signal<(bool,)>

Holds the QNode enabled flag. By default a QNode is always enabled.

Returns a built-in Qt signal Qt3DCore::QNode::enabledChanged that can be passed to qt_core::Signal::connect.

C++ documentation:

Holds the QNode enabled flag. By default a QNode is always enabled.

Note: the interpretation of what enabled means is aspect-dependent. Even if enabled is set to false, some aspects may still consider the node in some manner. This is documented on a class by class basis.

Access functions:

bool	isEnabled() const
void	setEnabled(bool isEnabled)

Notifier signal:

void	enabledChanged(bool enabled)

pub fn default_property_tracking_mode_changed( &self, ) -> Signal<(PropertyTrackingMode,)>

Holds the default property tracking mode which determines whether a QNode should be listening for property updates. This only applies to properties which haven't been overridden by a call to setPropertyTracking.

Returns a built-in Qt signal Qt3DCore::QNode::defaultPropertyTrackingModeChanged that can be passed to qt_core::Signal::connect.

C++ documentation:

Holds the default property tracking mode which determines whether a QNode should be listening for property updates. This only applies to properties which haven’t been overridden by a call to setPropertyTracking.

By default it is set to QNode::TrackFinalValues

Access functions:

PropertyTrackingMode	defaultPropertyTrackingMode() const
void	setDefaultPropertyTrackingMode(PropertyTrackingMode mode)

Notifier signal:

void	defaultPropertyTrackingModeChanged(PropertyTrackingMode mode)

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

emitted when the node is destroyed.

Returns a built-in Qt signal Qt3DCore::QNode::nodeDestroyed that can be passed to qt_core::Signal::connect.

C++ documentation:

emitted when the node is destroyed.

pub unsafe fn block_notifications(&self, block: bool) -> bool

If block is true, property change notifications sent by this object to aspects are blocked. If block is false, no such blocking will occur.

Calls C++ function: bool Qt3DCore::QNode::blockNotifications(bool block).

C++ documentation:

If block is true, property change notifications sent by this object to aspects are blocked. If block is false, no such blocking will occur.

The return value is the previous value of notificationsBlocked().

Note that the other notification types will be sent even if the notifications for this object have been blocked.

See also notificationsBlocked().

pub unsafe fn child_nodes(&self) -> CppBox<QVectorOfQNode>

Returns a list filled with the QNode children of the current QNode instance.

Calls C++ function: QVector<Qt3DCore::QNode*> Qt3DCore::QNode::childNodes() const.

C++ documentation:

Returns a list filled with the QNode children of the current QNode instance.

pub unsafe fn clear_property_tracking( &self, property_name: impl CastInto<Ref<QString>>, )

Clears the tracking property called propertyName.

Calls C++ function: void Qt3DCore::QNode::clearPropertyTracking(const QString& propertyName).

C++ documentation:

Clears the tracking property called propertyName.

pub unsafe fn clear_property_trackings(&self)

Erases all values that have been saved by the property tracking.

Calls C++ function: void Qt3DCore::QNode::clearPropertyTrackings().

C++ documentation:

Erases all values that have been saved by the property tracking.

pub unsafe fn default_property_tracking_mode(&self) -> PropertyTrackingMode

Holds the default property tracking mode which determines whether a QNode should be listening for property updates. This only applies to properties which haven't been overridden by a call to setPropertyTracking.

Calls C++ function: Qt3DCore::QNode::PropertyTrackingMode Qt3DCore::QNode::defaultPropertyTrackingMode() const.

C++ documentation:

Holds the default property tracking mode which determines whether a QNode should be listening for property updates. This only applies to properties which haven’t been overridden by a call to setPropertyTracking.

By default it is set to QNode::TrackFinalValues

Access functions:

PropertyTrackingMode	defaultPropertyTrackingMode() const
void	setDefaultPropertyTrackingMode(PropertyTrackingMode mode)

Notifier signal:

void	defaultPropertyTrackingModeChanged(PropertyTrackingMode mode)

pub unsafe fn id(&self) -> CppBox<QNodeId>

Returns the id that uniquely identifies the QNode instance.

Calls C++ function: Qt3DCore::QNodeId Qt3DCore::QNode::id() const.

C++ documentation:

Returns the id that uniquely identifies the QNode instance.

pub unsafe fn is_enabled(&self) -> bool

Holds the QNode enabled flag. By default a QNode is always enabled.

Calls C++ function: bool Qt3DCore::QNode::isEnabled() const.

C++ documentation:

Holds the QNode enabled flag. By default a QNode is always enabled.

Note: the interpretation of what enabled means is aspect-dependent. Even if enabled is set to false, some aspects may still consider the node in some manner. This is documented on a class by class basis.

Access functions:

bool	isEnabled() const
void	setEnabled(bool isEnabled)

Notifier signal:

void	enabledChanged(bool enabled)

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

Calls C++ function: virtual const QMetaObject* Qt3DCore::QNode::metaObject() const.

pub unsafe fn notifications_blocked(&self) -> bool

Returns true if aspect notifications are blocked; otherwise returns false. By default, notifications are not blocked.

Calls C++ function: bool Qt3DCore::QNode::notificationsBlocked() const.

C++ documentation:

Returns true if aspect notifications are blocked; otherwise returns false. By default, notifications are not blocked.

See also blockNotifications().

pub unsafe fn parent_node(&self) -> QPtr<QNode>

Holds the immediate QNode parent, or null if the node has no parent.

Calls C++ function: Qt3DCore::QNode* Qt3DCore::QNode::parentNode() const.

C++ documentation:

Holds the immediate QNode parent, or null if the node has no parent.

Setting the parent will notify the backend aspects about current QNode instance's parent change.

Note: if parent happens to be null, this will actually notify that the current QNode instance was removed from the scene.

Access functions:

QNode *	parentNode() const
void	setParent(QNode *parent)

Notifier signal:

void	parentChanged(QObject *parent)

pub unsafe fn property_tracking( &self, property_name: impl CastInto<Ref<QString>>, ) -> PropertyTrackingMode

See also setPropertyTracking().

Calls C++ function: Qt3DCore::QNode::PropertyTrackingMode Qt3DCore::QNode::propertyTracking(const QString& propertyName) const.

C++ documentation:

See also setPropertyTracking().

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

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

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

Calls C++ function: virtual void* Qt3DCore::QNode::qt_metacast(const char* arg1).

pub unsafe fn send_command_3a( &self, name: impl CastInto<Ref<QString>>, data: impl CastInto<Ref<QVariant>>, reply_to: u64, ) -> u64

Available 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.

Sends a command messages to the backend node

Calls C++ function: unsigned long long Qt3DCore::QNode::sendCommand(const QString& name, const QVariant& data = …, unsigned long long replyTo = …).

C++ documentation:

Sends a command messages to the backend node

Creates a QNodeCommand message and dispatches it to the backend node. The command is given and a name and some data which can be used in the backend node to performe various operations. This returns a CommandId which can be used to identify the initial command when receiving a message in reply. If the command message is to be sent in reply to another command, replyTo contains the id of that command.

See also QNodeCommand and QNode::sendReply.

pub unsafe fn send_command_2a( &self, name: impl CastInto<Ref<QString>>, data: impl CastInto<Ref<QVariant>>, ) -> u64

Available 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.

Sends a command messages to the backend node

Calls C++ function: unsigned long long Qt3DCore::QNode::sendCommand(const QString& name, const QVariant& data = …).

C++ documentation:

Sends a command messages to the backend node

Creates a QNodeCommand message and dispatches it to the backend node. The command is given and a name and some data which can be used in the backend node to performe various operations. This returns a CommandId which can be used to identify the initial command when receiving a message in reply. If the command message is to be sent in reply to another command, replyTo contains the id of that command.

See also QNodeCommand and QNode::sendReply.

pub unsafe fn send_command_1a(&self, name: impl CastInto<Ref<QString>>) -> u64

Available 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.

Sends a command messages to the backend node

Calls C++ function: unsigned long long Qt3DCore::QNode::sendCommand(const QString& name).

C++ documentation:

Sends a command messages to the backend node

Creates a QNodeCommand message and dispatches it to the backend node. The command is given and a name and some data which can be used in the backend node to performe various operations. This returns a CommandId which can be used to identify the initial command when receiving a message in reply. If the command message is to be sent in reply to another command, replyTo contains the id of that command.

See also QNodeCommand and QNode::sendReply.

pub unsafe fn set_default_property_tracking_mode( &self, mode: PropertyTrackingMode, )

Holds the default property tracking mode which determines whether a QNode should be listening for property updates. This only applies to properties which haven't been overridden by a call to setPropertyTracking.

Calls C++ function: [slot] void Qt3DCore::QNode::setDefaultPropertyTrackingMode(Qt3DCore::QNode::PropertyTrackingMode mode).

C++ documentation:

Holds the default property tracking mode which determines whether a QNode should be listening for property updates. This only applies to properties which haven’t been overridden by a call to setPropertyTracking.

By default it is set to QNode::TrackFinalValues

Access functions:

PropertyTrackingMode	defaultPropertyTrackingMode() const
void	setDefaultPropertyTrackingMode(PropertyTrackingMode mode)

Notifier signal:

void	defaultPropertyTrackingModeChanged(PropertyTrackingMode mode)

pub unsafe fn set_enabled(&self, is_enabled: bool)

Holds the QNode enabled flag. By default a QNode is always enabled.

Calls C++ function: [slot] void Qt3DCore::QNode::setEnabled(bool isEnabled).

C++ documentation:

Holds the QNode enabled flag. By default a QNode is always enabled.

Note: the interpretation of what enabled means is aspect-dependent. Even if enabled is set to false, some aspects may still consider the node in some manner. This is documented on a class by class basis.

Access functions:

bool	isEnabled() const
void	setEnabled(bool isEnabled)

Notifier signal:

void	enabledChanged(bool enabled)

pub unsafe fn set_parent(&self, parent: impl CastInto<Ptr<QNode>>)

Holds the immediate QNode parent, or null if the node has no parent.

Calls C++ function: [slot] void Qt3DCore::QNode::setParent(Qt3DCore::QNode* parent).

C++ documentation:

Holds the immediate QNode parent, or null if the node has no parent.

Setting the parent will notify the backend aspects about current QNode instance's parent change.

Note: if parent happens to be null, this will actually notify that the current QNode instance was removed from the scene.

Access functions:

QNode *	parentNode() const
void	setParent(QNode *parent)

Notifier signal:

void	parentChanged(QObject *parent)

pub unsafe fn set_property_tracking( &self, property_name: impl CastInto<Ref<QString>>, track_mode: PropertyTrackingMode, )

See also propertyTracking().

Calls C++ function: void Qt3DCore::QNode::setPropertyTracking(const QString& propertyName, Qt3DCore::QNode::PropertyTrackingMode trackMode).

C++ documentation:

See also propertyTracking().

Methods from Deref<Target = QObject>

pub unsafe fn find_child<T>( &self, name: &str, ) -> Result<QPtr<T>, FindChildError>

where QObject: DynamicCast<T>, T: StaticUpcast<QObject>,

Finds a child of self with the specified object name and casts it to type T.

The search is performed recursively. If there is more than one child matching the search, the most direct ancestor is returned. If there are several direct ancestors, it is undefined which one will be returned.

Returns an error if there is no child object with object name name or the found object cannot be cast to T.

pub fn destroyed(&self) -> Signal<(*mut QObject,)>

This signal is emitted immediately before the object obj is destroyed, and can not be blocked.

Returns a built-in Qt signal QObject::destroyed that can be passed to qt_core::Signal::connect.

C++ documentation:

This signal is emitted immediately before the object obj is destroyed, and can not be blocked.

All the objects's children are destroyed immediately after this signal is emitted.

See also deleteLater() and QPointer.

pub fn object_name_changed(&self) -> Signal<(*const QString,)>

This signal is emitted after the object's name has been changed. The new object name is passed as objectName.

Returns a built-in Qt signal QObject::objectNameChanged that can be passed to qt_core::Signal::connect.

C++ documentation:

This signal is emitted after the object’s name has been changed. The new object name is passed as objectName.

Note: This is a private signal. It can be used in signal connections but cannot be emitted by the user.

Note: Notifier signal for property objectName.

See also QObject::objectName.

pub fn slot_delete_later(&self) -> Receiver<()>

Schedules this object for deletion.

Returns a built-in Qt slot QObject::deleteLater that can be passed to qt_core::Signal::connect.

C++ documentation:

Schedules this object for deletion.

The object will be deleted when control returns to the event loop. If the event loop is not running when this function is called (e.g. deleteLater() is called on an object before QCoreApplication::exec()), the object will be deleted once the event loop is started. If deleteLater() is called after the main event loop has stopped, the object will not be deleted. Since Qt 4.8, if deleteLater() is called on an object that lives in a thread with no running event loop, the object will be destroyed when the thread finishes.

Note that entering and leaving a new event loop (e.g., by opening a modal dialog) will not perform the deferred deletion; for the object to be deleted, the control must return to the event loop from which deleteLater() was called.

Note: It is safe to call this function more than once; when the first deferred deletion event is delivered, any pending events for the object are removed from the event queue.

See also destroyed() and QPointer.

pub unsafe fn block_signals(&self, b: bool) -> bool

If block is true, signals emitted by this object are blocked (i.e., emitting a signal will not invoke anything connected to it). If block is false, no such blocking will occur.

Calls C++ function: bool QObject::blockSignals(bool b).

C++ documentation:

If block is true, signals emitted by this object are blocked (i.e., emitting a signal will not invoke anything connected to it). If block is false, no such blocking will occur.

The return value is the previous value of signalsBlocked().

Note that the destroyed() signal will be emitted even if the signals for this object have been blocked.

Signals emitted while being blocked are not buffered.

See also signalsBlocked() and QSignalBlocker.

pub unsafe fn children(&self) -> Ref<QListOfQObject>

Returns a list of child objects. The QObjectList class is defined in the <QObject> header file as the following:

Calls C++ function: const QList<QObject*>& QObject::children() const.

C++ documentation:

Returns a list of child objects. The QObjectList class is defined in the <QObject> header file as the following:

  typedef QList<QObject*> QObjectList;

The first child added is the first object in the list and the last child added is the last object in the list, i.e. new children are appended at the end.

Note that the list order changes when QWidget children are raised or lowered. A widget that is raised becomes the last object in the list, and a widget that is lowered becomes the first object in the list.

See also findChild(), findChildren(), parent(), and setParent().

pub unsafe fn delete_later(&self)

Schedules this object for deletion.

Calls C++ function: [slot] void QObject::deleteLater().

C++ documentation:

Schedules this object for deletion.

The object will be deleted when control returns to the event loop. If the event loop is not running when this function is called (e.g. deleteLater() is called on an object before QCoreApplication::exec()), the object will be deleted once the event loop is started. If deleteLater() is called after the main event loop has stopped, the object will not be deleted. Since Qt 4.8, if deleteLater() is called on an object that lives in a thread with no running event loop, the object will be destroyed when the thread finishes.

Note that entering and leaving a new event loop (e.g., by opening a modal dialog) will not perform the deferred deletion; for the object to be deleted, the control must return to the event loop from which deleteLater() was called.

Note: It is safe to call this function more than once; when the first deferred deletion event is delivered, any pending events for the object are removed from the event queue.

See also destroyed() and QPointer.

pub unsafe fn disconnect_char_q_object_char( &self, signal: *const i8, receiver: impl CastInto<Ptr<QObject>>, member: *const i8, ) -> bool

This function overloads disconnect().

Calls C++ function: bool QObject::disconnect(const char* signal = …, const QObject* receiver = …, const char* member = …) const.

C++ documentation:

This function overloads disconnect().

Disconnects signal from method of receiver.

A signal-slot connection is removed when either of the objects involved are destroyed.

Note: This function is thread-safe.

pub unsafe fn disconnect_q_object_char( &self, receiver: impl CastInto<Ptr<QObject>>, member: *const i8, ) -> bool

This function overloads disconnect().

Calls C++ function: bool QObject::disconnect(const QObject* receiver, const char* member = …) const.

C++ documentation:

This function overloads disconnect().

Disconnects all signals in this object from receiver's method.

A signal-slot connection is removed when either of the objects involved are destroyed.

pub unsafe fn disconnect_char_q_object( &self, signal: *const i8, receiver: impl CastInto<Ptr<QObject>>, ) -> bool

This function overloads disconnect().

Calls C++ function: bool QObject::disconnect(const char* signal = …, const QObject* receiver = …) const.

C++ documentation:

This function overloads disconnect().

Disconnects signal from method of receiver.

A signal-slot connection is removed when either of the objects involved are destroyed.

Note: This function is thread-safe.

pub unsafe fn disconnect_char(&self, signal: *const i8) -> bool

This function overloads disconnect().

Calls C++ function: bool QObject::disconnect(const char* signal = …) const.

C++ documentation:

This function overloads disconnect().

Disconnects signal from method of receiver.

A signal-slot connection is removed when either of the objects involved are destroyed.

Note: This function is thread-safe.

pub unsafe fn disconnect(&self) -> bool

This function overloads disconnect().

Calls C++ function: bool QObject::disconnect() const.

C++ documentation:

This function overloads disconnect().

Disconnects signal from method of receiver.

A signal-slot connection is removed when either of the objects involved are destroyed.

Note: This function is thread-safe.

pub unsafe fn disconnect_q_object( &self, receiver: impl CastInto<Ptr<QObject>>, ) -> bool

This function overloads disconnect().

Calls C++ function: bool QObject::disconnect(const QObject* receiver) const.

C++ documentation:

This function overloads disconnect().

Disconnects all signals in this object from receiver's method.

A signal-slot connection is removed when either of the objects involved are destroyed.

pub unsafe fn dump_object_info_mut(&self)

Dumps information about signal connections, etc. for this object to the debug output.

Calls C++ function: void QObject::dumpObjectInfo().

C++ documentation:

Dumps information about signal connections, etc. for this object to the debug output.

Note: before Qt 5.9, this function was not const.

See also dumpObjectTree().

pub unsafe fn dump_object_info(&self)

Dumps information about signal connections, etc. for this object to the debug output.

Calls C++ function: void QObject::dumpObjectInfo() const.

C++ documentation:

Dumps information about signal connections, etc. for this object to the debug output.

Note: before Qt 5.9, this function was not const.

See also dumpObjectTree().

pub unsafe fn dump_object_tree_mut(&self)

Dumps a tree of children to the debug output.

Calls C++ function: void QObject::dumpObjectTree().

C++ documentation:

Dumps a tree of children to the debug output.

Note: before Qt 5.9, this function was not const.

See also dumpObjectInfo().

pub unsafe fn dump_object_tree(&self)

Dumps a tree of children to the debug output.

Calls C++ function: void QObject::dumpObjectTree() const.

C++ documentation:

Dumps a tree of children to the debug output.

Note: before Qt 5.9, this function was not const.

See also dumpObjectInfo().

pub unsafe fn dynamic_property_names(&self) -> CppBox<QListOfQByteArray>

Returns the names of all properties that were dynamically added to the object using setProperty().

Calls C++ function: QList<QByteArray> QObject::dynamicPropertyNames() const.

C++ documentation:

Returns the names of all properties that were dynamically added to the object using setProperty().

This function was introduced in Qt 4.2.

pub unsafe fn eq(&self, p: impl CastInto<Ref<QPointerOfQObject>>) -> bool

Returns true if c1 and c2 are the same Unicode character; otherwise returns false.

Calls C++ function: bool operator==(QObject* o, const QPointer<QObject>& p).

Warning: no exact match found in C++ documentation. Below is the C++ documentation for bool operator==(QChar c1, QChar c2):

Returns true if c1 and c2 are the same Unicode character; otherwise returns false.

pub unsafe fn event(&self, event: impl CastInto<Ptr<QEvent>>) -> bool

This virtual function receives events to an object and should return true if the event e was recognized and processed.

Calls C++ function: virtual bool QObject::event(QEvent* event).

C++ documentation:

This virtual function receives events to an object and should return true if the event e was recognized and processed.

The event() function can be reimplemented to customize the behavior of an object.

Make sure you call the parent event class implementation for all the events you did not handle.

Example:

class MyClass : public QWidget
{
      Q_OBJECT
public:
      MyClass(QWidget *parent = 0);
      ~MyClass();
      bool event(QEvent* ev)
      {
          if (ev->type() == QEvent::PolishRequest) {
              // overwrite handling of PolishRequest if any
              doThings();
              return true;
          } else  if (ev->type() == QEvent::Show) {
              // complement handling of Show if any
              doThings2();
              QWidget::event(ev);
              return true;
          }
          // Make sure the rest of events are handled
          return QWidget::event(ev);
      }
};

See also installEventFilter(), timerEvent(), QCoreApplication::sendEvent(), and QCoreApplication::postEvent().

pub unsafe fn event_filter( &self, watched: impl CastInto<Ptr<QObject>>, event: impl CastInto<Ptr<QEvent>>, ) -> bool

Filters events if this object has been installed as an event filter for the watched object.

Calls C++ function: virtual bool QObject::eventFilter(QObject* watched, QEvent* event).

C++ documentation:

Filters events if this object has been installed as an event filter for the watched object.

In your reimplementation of this function, if you want to filter the event out, i.e. stop it being handled further, return true; otherwise return false.

Example:

class MainWindow : public QMainWindow
{
public:
      MainWindow();
protected:
      bool eventFilter(QObject obj, QEvent ev);
private:
      QTextEdit *textEdit;
};
MainWindow::MainWindow()
{
      textEdit = new QTextEdit;
      setCentralWidget(textEdit);
      textEdit->installEventFilter(this);
}
bool MainWindow::eventFilter(QObject obj, QEvent event)
{
      if (obj == textEdit) {
          if (event->type() == QEvent::KeyPress) {
              QKeyEvent keyEvent = static_cast<QKeyEvent>(event);
              qDebug() << “Ate key press” << keyEvent->key();
              return true;
          } else {
              return false;
          }
      } else {
          // pass the event on to the parent class
          return QMainWindow::eventFilter(obj, event);
      }
}

Notice in the example above that unhandled events are passed to the base class's eventFilter() function, since the base class might have reimplemented eventFilter() for its own internal purposes.

Warning: If you delete the receiver object in this function, be sure to return true. Otherwise, Qt will forward the event to the deleted object and the program might crash.

See also installEventFilter().

pub unsafe fn find_child_q_object_2a( &self, a_name: impl CastInto<Ref<QString>>, options: QFlags<FindChildOption>, ) -> QPtr<QObject>

Returns the child of this object that can be cast into type T and that is called name, or 0 if there is no such object. Omitting the name argument causes all object names to be matched. The search is performed recursively, unless options specifies the option FindDirectChildrenOnly.

Calls C++ function: QObject* QObject::findChild<QObject*>(const QString& aName = …, QFlags<Qt::FindChildOption> options = …) const.

C++ documentation:

Returns the child of this object that can be cast into type T and that is called name, or 0 if there is no such object. Omitting the name argument causes all object names to be matched. The search is performed recursively, unless options specifies the option FindDirectChildrenOnly.

If there is more than one child matching the search, the most direct ancestor is returned. If there are several direct ancestors, it is undefined which one will be returned. In that case, findChildren() should be used.

This example returns a child QPushButton of parentWidget named "button1", even if the button isn't a direct child of the parent:

QPushButton button = parentWidget->findChild<QPushButton >(“button1”);

This example returns a QListWidget child of parentWidget:

QListWidget list = parentWidget->findChild<QListWidget >();

This example returns a child QPushButton of parentWidget (its direct parent) named "button1":

QPushButton button = parentWidget->findChild<QPushButton >(“button1”, Qt::FindDirectChildrenOnly);

This example returns a QListWidget child of parentWidget, its direct parent:

QListWidget list = parentWidget->findChild<QListWidget >(QString(), Qt::FindDirectChildrenOnly);

See also findChildren().

pub unsafe fn find_child_q_object_1a( &self, a_name: impl CastInto<Ref<QString>>, ) -> QPtr<QObject>

Returns the child of this object that can be cast into type T and that is called name, or 0 if there is no such object. Omitting the name argument causes all object names to be matched. The search is performed recursively, unless options specifies the option FindDirectChildrenOnly.

Calls C++ function: QObject* QObject::findChild<QObject*>(const QString& aName = …) const.

C++ documentation:

Returns the child of this object that can be cast into type T and that is called name, or 0 if there is no such object. Omitting the name argument causes all object names to be matched. The search is performed recursively, unless options specifies the option FindDirectChildrenOnly.

If there is more than one child matching the search, the most direct ancestor is returned. If there are several direct ancestors, it is undefined which one will be returned. In that case, findChildren() should be used.

This example returns a child QPushButton of parentWidget named "button1", even if the button isn't a direct child of the parent:

QPushButton button = parentWidget->findChild<QPushButton >(“button1”);

This example returns a QListWidget child of parentWidget:

QListWidget list = parentWidget->findChild<QListWidget >();

This example returns a child QPushButton of parentWidget (its direct parent) named "button1":

QPushButton button = parentWidget->findChild<QPushButton >(“button1”, Qt::FindDirectChildrenOnly);

This example returns a QListWidget child of parentWidget, its direct parent:

QListWidget list = parentWidget->findChild<QListWidget >(QString(), Qt::FindDirectChildrenOnly);

See also findChildren().

pub unsafe fn find_child_q_object_0a(&self) -> QPtr<QObject>

Returns the child of this object that can be cast into type T and that is called name, or 0 if there is no such object. Omitting the name argument causes all object names to be matched. The search is performed recursively, unless options specifies the option FindDirectChildrenOnly.

Calls C++ function: QObject* QObject::findChild<QObject*>() const.

C++ documentation:

Returns the child of this object that can be cast into type T and that is called name, or 0 if there is no such object. Omitting the name argument causes all object names to be matched. The search is performed recursively, unless options specifies the option FindDirectChildrenOnly.

If there is more than one child matching the search, the most direct ancestor is returned. If there are several direct ancestors, it is undefined which one will be returned. In that case, findChildren() should be used.

This example returns a child QPushButton of parentWidget named "button1", even if the button isn't a direct child of the parent:

QPushButton button = parentWidget->findChild<QPushButton >(“button1”);

This example returns a QListWidget child of parentWidget:

QListWidget list = parentWidget->findChild<QListWidget >();

This example returns a child QPushButton of parentWidget (its direct parent) named "button1":

QPushButton button = parentWidget->findChild<QPushButton >(“button1”, Qt::FindDirectChildrenOnly);

This example returns a QListWidget child of parentWidget, its direct parent:

QListWidget list = parentWidget->findChild<QListWidget >(QString(), Qt::FindDirectChildrenOnly);

See also findChildren().

pub unsafe fn find_children_q_object_q_string_q_flags_find_child_option( &self, a_name: impl CastInto<Ref<QString>>, options: QFlags<FindChildOption>, ) -> CppBox<QListOfQObject>

Returns all children of this object with the given name that can be cast to type T, or an empty list if there are no such objects. Omitting the name argument causes all object names to be matched. The search is performed recursively, unless options specifies the option FindDirectChildrenOnly.

Calls C++ function: QList<QObject*> QObject::findChildren<QObject*>(const QString& aName = …, QFlags<Qt::FindChildOption> options = …) const.

C++ documentation:

Returns all children of this object with the given name that can be cast to type T, or an empty list if there are no such objects. Omitting the name argument causes all object names to be matched. The search is performed recursively, unless options specifies the option FindDirectChildrenOnly.

The following example shows how to find a list of child QWidgets of the specified parentWidget named widgetname:

QList<QWidget > widgets = parentWidget.findChildren<QWidget >(“widgetname”);

This example returns all QPushButtons that are children of parentWidget:

QList<QPushButton > allPButtons = parentWidget.findChildren<QPushButton >();

This example returns all QPushButtons that are immediate children of parentWidget:

QList<QPushButton > childButtons = parentWidget.findChildren<QPushButton >(QString(), Qt::FindDirectChildrenOnly);

See also findChild().

pub unsafe fn find_children_q_object_q_reg_exp_q_flags_find_child_option( &self, re: impl CastInto<Ref<QRegExp>>, options: QFlags<FindChildOption>, ) -> CppBox<QListOfQObject>

This function overloads findChildren().

Calls C++ function: QList<QObject*> QObject::findChildren<QObject*>(const QRegExp& re, QFlags<Qt::FindChildOption> options = …) const.

C++ documentation:

This function overloads findChildren().

Returns the children of this object that can be cast to type T and that have names matching the regular expression regExp, or an empty list if there are no such objects. The search is performed recursively, unless options specifies the option FindDirectChildrenOnly.

pub unsafe fn find_children_q_object_q_regular_expression_q_flags_find_child_option( &self, re: impl CastInto<Ref<QRegularExpression>>, options: QFlags<FindChildOption>, ) -> CppBox<QListOfQObject>

This function overloads findChildren().

Calls C++ function: QList<QObject*> QObject::findChildren<QObject*>(const QRegularExpression& re, QFlags<Qt::FindChildOption> options = …) const.

C++ documentation:

This function overloads findChildren().

Returns the children of this object that can be cast to type T and that have names matching the regular expression re, or an empty list if there are no such objects. The search is performed recursively, unless options specifies the option FindDirectChildrenOnly.

This function was introduced in Qt 5.0.

pub unsafe fn find_children_q_object_q_string( &self, a_name: impl CastInto<Ref<QString>>, ) -> CppBox<QListOfQObject>

Returns all children of this object with the given name that can be cast to type T, or an empty list if there are no such objects. Omitting the name argument causes all object names to be matched. The search is performed recursively, unless options specifies the option FindDirectChildrenOnly.

Calls C++ function: QList<QObject*> QObject::findChildren<QObject*>(const QString& aName = …) const.

C++ documentation:

Returns all children of this object with the given name that can be cast to type T, or an empty list if there are no such objects. Omitting the name argument causes all object names to be matched. The search is performed recursively, unless options specifies the option FindDirectChildrenOnly.

The following example shows how to find a list of child QWidgets of the specified parentWidget named widgetname:

QList<QWidget > widgets = parentWidget.findChildren<QWidget >(“widgetname”);

This example returns all QPushButtons that are children of parentWidget:

QList<QPushButton > allPButtons = parentWidget.findChildren<QPushButton >();

This example returns all QPushButtons that are immediate children of parentWidget:

QList<QPushButton > childButtons = parentWidget.findChildren<QPushButton >(QString(), Qt::FindDirectChildrenOnly);

See also findChild().

pub unsafe fn find_children_q_object(&self) -> CppBox<QListOfQObject>

Returns all children of this object with the given name that can be cast to type T, or an empty list if there are no such objects. Omitting the name argument causes all object names to be matched. The search is performed recursively, unless options specifies the option FindDirectChildrenOnly.

Calls C++ function: QList<QObject*> QObject::findChildren<QObject*>() const.

C++ documentation:

Returns all children of this object with the given name that can be cast to type T, or an empty list if there are no such objects. Omitting the name argument causes all object names to be matched. The search is performed recursively, unless options specifies the option FindDirectChildrenOnly.

The following example shows how to find a list of child QWidgets of the specified parentWidget named widgetname:

QList<QWidget > widgets = parentWidget.findChildren<QWidget >(“widgetname”);

This example returns all QPushButtons that are children of parentWidget:

QList<QPushButton > allPButtons = parentWidget.findChildren<QPushButton >();

This example returns all QPushButtons that are immediate children of parentWidget:

QList<QPushButton > childButtons = parentWidget.findChildren<QPushButton >(QString(), Qt::FindDirectChildrenOnly);

See also findChild().

pub unsafe fn find_children_q_object_q_reg_exp( &self, re: impl CastInto<Ref<QRegExp>>, ) -> CppBox<QListOfQObject>

This function overloads findChildren().

Calls C++ function: QList<QObject*> QObject::findChildren<QObject*>(const QRegExp& re) const.

C++ documentation:

This function overloads findChildren().

Returns the children of this object that can be cast to type T and that have names matching the regular expression regExp, or an empty list if there are no such objects. The search is performed recursively, unless options specifies the option FindDirectChildrenOnly.

pub unsafe fn find_children_q_object_q_regular_expression( &self, re: impl CastInto<Ref<QRegularExpression>>, ) -> CppBox<QListOfQObject>

This function overloads findChildren().

Calls C++ function: QList<QObject*> QObject::findChildren<QObject*>(const QRegularExpression& re) const.

C++ documentation:

This function overloads findChildren().

Returns the children of this object that can be cast to type T and that have names matching the regular expression re, or an empty list if there are no such objects. The search is performed recursively, unless options specifies the option FindDirectChildrenOnly.

This function was introduced in Qt 5.0.

pub unsafe fn inherits(&self, classname: *const i8) -> bool

Returns true if this object is an instance of a class that inherits className or a QObject subclass that inherits className; otherwise returns false.

Calls C++ function: bool QObject::inherits(const char* classname) const.

C++ documentation:

Returns true if this object is an instance of a class that inherits className or a QObject subclass that inherits className; otherwise returns false.

A class is considered to inherit itself.

Example:

QTimer *timer = new QTimer;         // QTimer inherits QObject
timer->inherits(“QTimer”);          // returns true
timer->inherits(“QObject”);         // returns true
timer->inherits(“QAbstractButton”); // returns false
// QVBoxLayout inherits QObject and QLayoutItem
QVBoxLayout *layout = new QVBoxLayout;
layout->inherits(“QObject”);        // returns true
layout->inherits(“QLayoutItem”);    // returns true (even though QLayoutItem is not a QObject)

If you need to determine whether an object is an instance of a particular class for the purpose of casting it, consider using qobject_cast<Type *>(object) instead.

See also metaObject() and qobject_cast().

pub unsafe fn install_event_filter( &self, filter_obj: impl CastInto<Ptr<QObject>>, )

Installs an event filter filterObj on this object. For example:

Calls C++ function: void QObject::installEventFilter(QObject* filterObj).

C++ documentation:

Installs an event filter filterObj on this object. For example:

  monitoredObj->installEventFilter(filterObj);

An event filter is an object that receives all events that are sent to this object. The filter can either stop the event or forward it to this object. The event filter filterObj receives events via its eventFilter() function. The eventFilter() function must return true if the event should be filtered, (i.e. stopped); otherwise it must return false.

If multiple event filters are installed on a single object, the filter that was installed last is activated first.

Here's a KeyPressEater class that eats the key presses of its monitored objects:

class KeyPressEater : public QObject
{
      Q_OBJECT
      ...
protected:
      bool eventFilter(QObject obj, QEvent event);
};
bool KeyPressEater::eventFilter(QObject obj, QEvent event)
{
      if (event->type() == QEvent::KeyPress) {
          QKeyEvent keyEvent = static_cast<QKeyEvent >(event);
          qDebug(“Ate key press %d”, keyEvent->key());
          return true;
      } else {
          // standard event processing
          return QObject::eventFilter(obj, event);
      }
}

And here's how to install it on two widgets:

KeyPressEater keyPressEater = new KeyPressEater(this);
QPushButton pushButton = new QPushButton(this);
QListView *listView = new QListView(this);
pushButton->installEventFilter(keyPressEater);
listView->installEventFilter(keyPressEater);

The QShortcut class, for example, uses this technique to intercept shortcut key presses.

Warning: If you delete the receiver object in your eventFilter() function, be sure to return true. If you return false, Qt sends the event to the deleted object and the program will crash.

Note that the filtering object must be in the same thread as this object. If filterObj is in a different thread, this function does nothing. If either filterObj or this object are moved to a different thread after calling this function, the event filter will not be called until both objects have the same thread affinity again (it is not removed).

See also removeEventFilter(), eventFilter(), and event().

pub unsafe fn is_widget_type(&self) -> bool

Returns true if the object is a widget; otherwise returns false.

Calls C++ function: bool QObject::isWidgetType() const.

C++ documentation:

Returns true if the object is a widget; otherwise returns false.

Calling this function is equivalent to calling inherits("QWidget"), except that it is much faster.

pub unsafe fn is_window_type(&self) -> bool

Returns true if the object is a window; otherwise returns false.

Calls C++ function: bool QObject::isWindowType() const.

C++ documentation:

Returns true if the object is a window; otherwise returns false.

Calling this function is equivalent to calling inherits("QWindow"), except that it is much faster.

pub unsafe fn kill_timer(&self, id: i32)

Kills the timer with timer identifier, id.

Calls C++ function: void QObject::killTimer(int id).

C++ documentation:

Kills the timer with timer identifier, id.

The timer identifier is returned by startTimer() when a timer event is started.

See also timerEvent() and startTimer().

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

Returns a pointer to the meta-object of this object.

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

C++ documentation:

Returns a pointer to the meta-object of this object.

A meta-object contains information about a class that inherits QObject, e.g. class name, superclass name, properties, signals and slots. Every QObject subclass that contains the Q_OBJECT macro will have a meta-object.

The meta-object information is required by the signal/slot connection mechanism and the property system. The inherits() function also makes use of the meta-object.

If you have no pointer to an actual object instance but still want to access the meta-object of a class, you can use staticMetaObject.

Example:

QObject *obj = new QPushButton;
obj->metaObject()->className();             // returns “QPushButton”
QPushButton::staticMetaObject.className();  // returns “QPushButton”

See also staticMetaObject.

pub unsafe fn move_to_thread(&self, thread: impl CastInto<Ptr<QThread>>)

Changes the thread affinity for this object and its children. The object cannot be moved if it has a parent. Event processing will continue in the targetThread.

Calls C++ function: void QObject::moveToThread(QThread* thread).

C++ documentation:

Changes the thread affinity for this object and its children. The object cannot be moved if it has a parent. Event processing will continue in the targetThread.

To move an object to the main thread, use QApplication::instance() to retrieve a pointer to the current application, and then use QApplication::thread() to retrieve the thread in which the application lives. For example:

myObject->moveToThread(QApplication::instance()->thread());

If targetThread is zero, all event processing for this object and its children stops.

Note that all active timers for the object will be reset. The timers are first stopped in the current thread and restarted (with the same interval) in the targetThread. As a result, constantly moving an object between threads can postpone timer events indefinitely.

A QEvent::ThreadChange event is sent to this object just before the thread affinity is changed. You can handle this event to perform any special processing. Note that any new events that are posted to this object will be handled in the targetThread.

Warning: This function is not thread-safe; the current thread must be same as the current thread affinity. In other words, this function can only "push" an object from the current thread to another thread, it cannot "pull" an object from any arbitrary thread to the current thread.

See also thread().

pub unsafe fn object_name(&self) -> CppBox<QString>

This property holds the name of this object

Calls C++ function: QString QObject::objectName() const.

C++ documentation:

This property holds the name of this object

You can find an object by name (and type) using findChild(). You can find a set of objects with findChildren().

qDebug(“MyClass::setPrecision(): (%s) invalid precision %f”,
         qPrintable(objectName()), newPrecision);

By default, this property contains an empty string.

Access functions:

QString	objectName() const
void	setObjectName(const QString &name)

Notifier signal:

void

objectNameChanged(const QString &objectName)

[see note below]

Note: This is a private signal. It can be used in signal connections but cannot be emitted by the user.

See also metaObject() and QMetaObject::className().

pub unsafe fn parent(&self) -> QPtr<QObject>

Returns a pointer to the parent object.

Calls C++ function: QObject* QObject::parent() const.

C++ documentation:

Returns a pointer to the parent object.

See also setParent() and children().

pub unsafe fn property(&self, name: *const i8) -> CppBox<QVariant>

Returns the value of the object's name property.

Calls C++ function: QVariant QObject::property(const char* name) const.

C++ documentation:

Returns the value of the object’s name property.

If no such property exists, the returned variant is invalid.

Information about all available properties is provided through the metaObject() and dynamicPropertyNames().

See also setProperty(), QVariant::isValid(), metaObject(), and dynamicPropertyNames().

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

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

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

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

pub unsafe fn remove_event_filter(&self, obj: impl CastInto<Ptr<QObject>>)

Removes an event filter object obj from this object. The request is ignored if such an event filter has not been installed.

Calls C++ function: void QObject::removeEventFilter(QObject* obj).

C++ documentation:

Removes an event filter object obj from this object. The request is ignored if such an event filter has not been installed.

All event filters for this object are automatically removed when this object is destroyed.

It is always safe to remove an event filter, even during event filter activation (i.e. from the eventFilter() function).

See also installEventFilter(), eventFilter(), and event().

pub unsafe fn set_object_name(&self, name: impl CastInto<Ref<QString>>)

This property holds the name of this object

Calls C++ function: void QObject::setObjectName(const QString& name).

C++ documentation:

This property holds the name of this object

You can find an object by name (and type) using findChild(). You can find a set of objects with findChildren().

qDebug(“MyClass::setPrecision(): (%s) invalid precision %f”,
         qPrintable(objectName()), newPrecision);

By default, this property contains an empty string.

Access functions:

QString	objectName() const
void	setObjectName(const QString &name)

Notifier signal:

void

objectNameChanged(const QString &objectName)

[see note below]

Note: This is a private signal. It can be used in signal connections but cannot be emitted by the user.

See also metaObject() and QMetaObject::className().

pub unsafe fn set_parent(&self, parent: impl CastInto<Ptr<QObject>>)

Makes the object a child of parent.

Calls C++ function: void QObject::setParent(QObject* parent).

C++ documentation:

Makes the object a child of parent.

See also parent() and children().

pub unsafe fn set_property( &self, name: *const i8, value: impl CastInto<Ref<QVariant>>, ) -> bool

Sets the value of the object's name property to value.

Calls C++ function: bool QObject::setProperty(const char* name, const QVariant& value).

C++ documentation:

Sets the value of the object’s name property to value.

If the property is defined in the class using Q_PROPERTY then true is returned on success and false otherwise. If the property is not defined using Q_PROPERTY, and therefore not listed in the meta-object, it is added as a dynamic property and false is returned.

Information about all available properties is provided through the metaObject() and dynamicPropertyNames().

Dynamic properties can be queried again using property() and can be removed by setting the property value to an invalid QVariant. Changing the value of a dynamic property causes a QDynamicPropertyChangeEvent to be sent to the object.

Note: Dynamic properties starting with "_q_" are reserved for internal purposes.

See also property(), metaObject(), dynamicPropertyNames(), and QMetaProperty::write().

pub unsafe fn signals_blocked(&self) -> bool

Returns true if signals are blocked; otherwise returns false.

Calls C++ function: bool QObject::signalsBlocked() const.

C++ documentation:

Returns true if signals are blocked; otherwise returns false.

Signals are not blocked by default.

See also blockSignals() and QSignalBlocker.

pub unsafe fn start_timer_2a(&self, interval: i32, timer_type: TimerType) -> i32

Starts a timer and returns a timer identifier, or returns zero if it could not start a timer.

Calls C++ function: int QObject::startTimer(int interval, Qt::TimerType timerType = …).

C++ documentation:

Starts a timer and returns a timer identifier, or returns zero if it could not start a timer.

A timer event will occur every interval milliseconds until killTimer() is called. If interval is 0, then the timer event occurs once every time there are no more window system events to process.

The virtual timerEvent() function is called with the QTimerEvent event parameter class when a timer event occurs. Reimplement this function to get timer events.

If multiple timers are running, the QTimerEvent::timerId() can be used to find out which timer was activated.

Example:

class MyObject : public QObject
{
      Q_OBJECT
public:
      MyObject(QObject *parent = 0);
protected:
      void timerEvent(QTimerEvent *event);
};
MyObject::MyObject(QObject *parent)
      : QObject(parent)
{
      startTimer(50);     // 50-millisecond timer
      startTimer(1000);   // 1-second timer
      startTimer(60000);  // 1-minute timer
      using namespace std::chrono;
      startTimer(milliseconds(50));
      startTimer(seconds(1));
      startTimer(minutes(1));
      // since C++14 we can use std::chrono::duration literals, e.g.:
      startTimer(100ms);
      startTimer(5s);
      startTimer(2min);
      startTimer(1h);
}
void MyObject::timerEvent(QTimerEvent *event)
{
      qDebug() << “Timer ID:” << event->timerId();
}

Note that QTimer's accuracy depends on the underlying operating system and hardware. The timerType argument allows you to customize the accuracy of the timer. See Qt::TimerType for information on the different timer types. Most platforms support an accuracy of 20 milliseconds; some provide more. If Qt is unable to deliver the requested number of timer events, it will silently discard some.

The QTimer class provides a high-level programming interface with single-shot timers and timer signals instead of events. There is also a QBasicTimer class that is more lightweight than QTimer and less clumsy than using timer IDs directly.

See also timerEvent(), killTimer(), and QTimer::singleShot().

pub unsafe fn start_timer_1a(&self, interval: i32) -> i32

Starts a timer and returns a timer identifier, or returns zero if it could not start a timer.

Calls C++ function: int QObject::startTimer(int interval).

C++ documentation:

Starts a timer and returns a timer identifier, or returns zero if it could not start a timer.

A timer event will occur every interval milliseconds until killTimer() is called. If interval is 0, then the timer event occurs once every time there are no more window system events to process.

The virtual timerEvent() function is called with the QTimerEvent event parameter class when a timer event occurs. Reimplement this function to get timer events.

If multiple timers are running, the QTimerEvent::timerId() can be used to find out which timer was activated.

Example:

class MyObject : public QObject
{
      Q_OBJECT
public:
      MyObject(QObject *parent = 0);
protected:
      void timerEvent(QTimerEvent *event);
};
MyObject::MyObject(QObject *parent)
      : QObject(parent)
{
      startTimer(50);     // 50-millisecond timer
      startTimer(1000);   // 1-second timer
      startTimer(60000);  // 1-minute timer
      using namespace std::chrono;
      startTimer(milliseconds(50));
      startTimer(seconds(1));
      startTimer(minutes(1));
      // since C++14 we can use std::chrono::duration literals, e.g.:
      startTimer(100ms);
      startTimer(5s);
      startTimer(2min);
      startTimer(1h);
}
void MyObject::timerEvent(QTimerEvent *event)
{
      qDebug() << “Timer ID:” << event->timerId();
}

Note that QTimer's accuracy depends on the underlying operating system and hardware. The timerType argument allows you to customize the accuracy of the timer. See Qt::TimerType for information on the different timer types. Most platforms support an accuracy of 20 milliseconds; some provide more. If Qt is unable to deliver the requested number of timer events, it will silently discard some.

The QTimer class provides a high-level programming interface with single-shot timers and timer signals instead of events. There is also a QBasicTimer class that is more lightweight than QTimer and less clumsy than using timer IDs directly.

See also timerEvent(), killTimer(), and QTimer::singleShot().

pub unsafe fn thread(&self) -> QPtr<QThread>

Returns the thread in which the object lives.

Calls C++ function: QThread* QObject::thread() const.

C++ documentation:

Returns the thread in which the object lives.

See also moveToThread().

Trait Implementations

impl CppDeletable for QRayCaster

Available 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.

unsafe fn delete(&self)

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

impl Deref for QRayCaster

Available 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.

fn deref(&self) -> &QAbstractRayCaster

Calls C++ function: Qt3DRender::QAbstractRayCaster* static_cast<Qt3DRender::QAbstractRayCaster*>(Qt3DRender::QRayCaster* ptr).

type Target = QAbstractRayCaster

The resulting type after dereferencing.

impl DynamicCast<QRayCaster> for QAbstractRayCaster

Available 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.

unsafe fn dynamic_cast(ptr: Ptr<QAbstractRayCaster>) -> Ptr<QRayCaster>

Calls C++ function: Qt3DRender::QRayCaster* dynamic_cast<Qt3DRender::QRayCaster*>(Qt3DRender::QAbstractRayCaster* ptr).

impl DynamicCast<QRayCaster> for QComponent

Available 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.

unsafe fn dynamic_cast(ptr: Ptr<QComponent>) -> Ptr<QRayCaster>

Calls C++ function: Qt3DRender::QRayCaster* dynamic_cast<Qt3DRender::QRayCaster*>(Qt3DCore::QComponent* ptr).

impl DynamicCast<QRayCaster> for QNode

Available 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.

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

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

impl DynamicCast<QRayCaster> for QObject

Available 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.

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

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

impl StaticDowncast<QRayCaster> for QAbstractRayCaster

Available 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.

unsafe fn static_downcast(ptr: Ptr<QAbstractRayCaster>) -> Ptr<QRayCaster>

Calls C++ function: Qt3DRender::QRayCaster* static_cast<Qt3DRender::QRayCaster*>(Qt3DRender::QAbstractRayCaster* ptr).

impl StaticDowncast<QRayCaster> for QComponent

Available 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.

unsafe fn static_downcast(ptr: Ptr<QComponent>) -> Ptr<QRayCaster>

Calls C++ function: Qt3DRender::QRayCaster* static_cast<Qt3DRender::QRayCaster*>(Qt3DCore::QComponent* ptr).

impl StaticDowncast<QRayCaster> for QNode

Available 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.

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

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

impl StaticDowncast<QRayCaster> for QObject

Available 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.

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

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

impl StaticUpcast<QAbstractRayCaster> for QRayCaster

Available 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.

unsafe fn static_upcast(ptr: Ptr<QRayCaster>) -> Ptr<QAbstractRayCaster>

Calls C++ function: Qt3DRender::QAbstractRayCaster* static_cast<Qt3DRender::QAbstractRayCaster*>(Qt3DRender::QRayCaster* ptr).

impl StaticUpcast<QComponent> for QRayCaster

Available 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.

unsafe fn static_upcast(ptr: Ptr<QRayCaster>) -> Ptr<QComponent>

Calls C++ function: Qt3DCore::QComponent* static_cast<Qt3DCore::QComponent*>(Qt3DRender::QRayCaster* ptr).

impl StaticUpcast<QNode> for QRayCaster

Available 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.

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

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

impl StaticUpcast<QObject> for QRayCaster

Available 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.

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

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