Struct qt_3d_core::QAbstractSkeleton

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

A skeleton contains the joints for a skinned mesh.

C++ class: Qt3DCore::QAbstractSkeleton.

C++ documentation:

A skeleton contains the joints for a skinned mesh.

Do not use this class directly. You should use QSkeletonLoader if loading skeleton data from a file (most likely) or QSkeleton if creating the skeleton and skinned mesh data yourself (mainly for people creating editors or tooling).

Methods

impl QAbstractSkeleton

pub fn joint_count_changed(&self) -> Signal<(c_int,)>

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 number of joints contained in the skeleton

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

C++ documentation:

Holds the number of joints contained in the skeleton

Access functions:

int	jointCount() const

Notifier signal:

void	jointCountChanged(int jointCount)

pub unsafe fn joint_count(&self) -> c_int

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 number of joints contained in the skeleton

Calls C++ function: int Qt3DCore::QAbstractSkeleton::jointCount() const.

C++ documentation:

Holds the number of joints contained in the skeleton

Access functions:

int	jointCount() const

Notifier signal:

void	jointCountChanged(int jointCount)

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

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.

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

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

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.

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

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

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.

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

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

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.

Returns a reference to the staticMetaObject field.

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

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.

Calls C++ function: static QString Qt3DCore::QAbstractSkeleton::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>

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.

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

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: c_int,
    arg3: *mut *mut c_void
) -> c_int

Calls C++ function: virtual int Qt3DCore::QNode::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* 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: c_ulonglong
) -> c_ulonglong

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.

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

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.

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

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.

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

Trait Implementations

impl CppDeletable for QAbstractSkeleton

unsafe fn delete(&self)

Calls C++ function: virtual [destructor] void Qt3DCore::QAbstractSkeleton::~QAbstractSkeleton().

impl Deref for QAbstractSkeleton

type Target = QNode

The resulting type after dereferencing.

fn deref(&self) -> &QNode

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

impl DynamicCast<QAbstractSkeleton> for QNode

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

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

impl DynamicCast<QAbstractSkeleton> for QObject

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

Calls C++ function: Qt3DCore::QAbstractSkeleton* dynamic_cast<Qt3DCore::QAbstractSkeleton*>(QObject* ptr).

impl DynamicCast<QSkeleton> for QAbstractSkeleton

unsafe fn dynamic_cast(ptr: Ptr<QAbstractSkeleton>) -> Ptr<QSkeleton>

Calls C++ function: Qt3DCore::QSkeleton* dynamic_cast<Qt3DCore::QSkeleton*>(Qt3DCore::QAbstractSkeleton* ptr).

impl DynamicCast<QSkeletonLoader> for QAbstractSkeleton

unsafe fn dynamic_cast(ptr: Ptr<QAbstractSkeleton>) -> Ptr<QSkeletonLoader>

Calls C++ function: Qt3DCore::QSkeletonLoader* dynamic_cast<Qt3DCore::QSkeletonLoader*>(Qt3DCore::QAbstractSkeleton* ptr).

impl StaticDowncast<QAbstractSkeleton> for QNode

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

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

impl StaticDowncast<QAbstractSkeleton> for QObject

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

Calls C++ function: Qt3DCore::QAbstractSkeleton* static_cast<Qt3DCore::QAbstractSkeleton*>(QObject* ptr).

impl StaticDowncast<QSkeleton> for QAbstractSkeleton

unsafe fn static_downcast(ptr: Ptr<QAbstractSkeleton>) -> Ptr<QSkeleton>

Calls C++ function: Qt3DCore::QSkeleton* static_cast<Qt3DCore::QSkeleton*>(Qt3DCore::QAbstractSkeleton* ptr).

impl StaticDowncast<QSkeletonLoader> for QAbstractSkeleton

unsafe fn static_downcast(ptr: Ptr<QAbstractSkeleton>) -> Ptr<QSkeletonLoader>

Calls C++ function: Qt3DCore::QSkeletonLoader* static_cast<Qt3DCore::QSkeletonLoader*>(Qt3DCore::QAbstractSkeleton* ptr).

impl StaticUpcast<QAbstractSkeleton> for QSkeleton

unsafe fn static_upcast(ptr: Ptr<QSkeleton>) -> Ptr<QAbstractSkeleton>

Calls C++ function: Qt3DCore::QAbstractSkeleton* static_cast<Qt3DCore::QAbstractSkeleton*>(Qt3DCore::QSkeleton* ptr).

impl StaticUpcast<QAbstractSkeleton> for QSkeletonLoader

unsafe fn static_upcast(ptr: Ptr<QSkeletonLoader>) -> Ptr<QAbstractSkeleton>

Calls C++ function: Qt3DCore::QAbstractSkeleton* static_cast<Qt3DCore::QAbstractSkeleton*>(Qt3DCore::QSkeletonLoader* ptr).

impl StaticUpcast<QNode> for QAbstractSkeleton

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

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

impl StaticUpcast<QObject> for QAbstractSkeleton

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

Calls C++ function: QObject* static_cast<QObject*>(Qt3DCore::QAbstractSkeleton* ptr).