[−][src]Struct qt_3d_core::QArmature

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

Used to calculate skinning transform matrices and set them on shaders.

C++ class: Qt3DCore::QArmature.

C++ documentation:

Used to calculate skinning transform matrices and set them on shaders.

The Armature component is aggregated by entities to give them the ability to calculate the palette of skinning transform matrices needed to properly render skinned meshes.

Each vertex in a skinned mesh is associated (bound) to up to 4 joints in a skeleton. For each joint affecting a vertex the mesh also provides a weight which determines the level of influence of the corresponding joint. The skinning palette used for performing the transformation of skinned vertices is provided by the Armature and is calculated from the joints contained in the referenced skeleton.

Updating the local transform of a joint results in the skinning matrices being recalculated and the skinned mesh vertices bound to that joint moving accordingly.

Methods

impl QArmature[src]

pub fn slot_set_skeleton(&self) -> Receiver<(*mut QAbstractSkeleton,)>[src]

Holds the skeleton used to calculate the skinning transform matrix palette.

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

C++ documentation:

Holds the skeleton used to calculate the skinning transform matrix palette.

Access functions:

Qt3DCore::QAbstractSkeleton *skeleton() const
void setSkeleton(Qt3DCore::QAbstractSkeleton *skeleton)

Notifier signal:

void skeletonChanged(Qt3DCore::QAbstractSkeleton *skeleton)

This item is available if any(cpp_lib_version="5.11.3", cpp_lib_version="5.12.2", cpp_lib_version="5.13.0").

pub fn skeleton_changed(&self) -> Signal<(*mut QAbstractSkeleton,)>[src]

Holds the skeleton used to calculate the skinning transform matrix palette.

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

C++ documentation:

Holds the skeleton used to calculate the skinning transform matrix palette.

Access functions:

Qt3DCore::QAbstractSkeleton *skeleton() const
void setSkeleton(Qt3DCore::QAbstractSkeleton *skeleton)

Notifier signal:

void skeletonChanged(Qt3DCore::QAbstractSkeleton *skeleton)

This item is available if any(cpp_lib_version="5.11.3", cpp_lib_version="5.12.2", cpp_lib_version="5.13.0").

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

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

This item is available if any(cpp_lib_version="5.11.3", cpp_lib_version="5.12.2", cpp_lib_version="5.13.0").

pub unsafe fn new_1a(parent: impl CastInto<MutPtr<QNode>>) -> CppBox<QArmature>[src]

Constructs a new QArmature with parent.

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

C++ documentation:

Constructs a new QArmature with parent.

This item is available if any(cpp_lib_version="5.11.3", cpp_lib_version="5.12.2", cpp_lib_version="5.13.0").

pub unsafe fn new_0a() -> CppBox<QArmature>[src]

Used to calculate skinning transform matrices and set them on shaders.

Calls C++ function: [constructor] void Qt3DCore::QArmature::QArmature().

C++ documentation:

Used to calculate skinning transform matrices and set them on shaders.

The Armature component is aggregated by entities to give them the ability to calculate the palette of skinning transform matrices needed to properly render skinned meshes.

Each vertex in a skinned mesh is associated (bound) to up to 4 joints in a skeleton. For each joint affecting a vertex the mesh also provides a weight which determines the level of influence of the corresponding joint. The skinning palette used for performing the transformation of skinned vertices is provided by the Armature and is calculated from the joints contained in the referenced skeleton.

Updating the local transform of a joint results in the skinning matrices being recalculated and the skinned mesh vertices bound to that joint moving accordingly.

This item is available if any(cpp_lib_version="5.11.3", cpp_lib_version="5.12.2", cpp_lib_version="5.13.0").

pub unsafe fn qt_metacall(
    &mut self,
    arg1: Call,
    arg2: c_int,
    arg3: impl CastInto<MutPtr<*mut c_void>>
) -> c_int[src]

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

This item is available if any(cpp_lib_version="5.11.3", cpp_lib_version="5.12.2", cpp_lib_version="5.13.0").

pub unsafe fn qt_metacast(
    &mut self,
    arg1: impl CastInto<Ptr<c_char>>
) -> MutPtr<c_void>[src]

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

This item is available if any(cpp_lib_version="5.11.3", cpp_lib_version="5.12.2", cpp_lib_version="5.13.0").

pub unsafe fn set_skeleton(
    &mut self,
    skeleton: impl CastInto<MutPtr<QAbstractSkeleton>>
)[src]

Holds the skeleton used to calculate the skinning transform matrix palette.

Calls C++ function: [slot] void Qt3DCore::QArmature::setSkeleton(Qt3DCore::QAbstractSkeleton* skeleton).

C++ documentation:

Holds the skeleton used to calculate the skinning transform matrix palette.

Access functions:

Qt3DCore::QAbstractSkeleton *skeleton() const
void setSkeleton(Qt3DCore::QAbstractSkeleton *skeleton)

Notifier signal:

void skeletonChanged(Qt3DCore::QAbstractSkeleton *skeleton)

This item is available if any(cpp_lib_version="5.11.3", cpp_lib_version="5.12.2", cpp_lib_version="5.13.0").

pub unsafe fn skeleton(&self) -> MutPtr<QAbstractSkeleton>[src]

Holds the skeleton used to calculate the skinning transform matrix palette.

Calls C++ function: Qt3DCore::QAbstractSkeleton* Qt3DCore::QArmature::skeleton() const.

C++ documentation:

Holds the skeleton used to calculate the skinning transform matrix palette.

Access functions:

Qt3DCore::QAbstractSkeleton *skeleton() const
void setSkeleton(Qt3DCore::QAbstractSkeleton *skeleton)

Notifier signal:

void skeletonChanged(Qt3DCore::QAbstractSkeleton *skeleton)

This item is available if any(cpp_lib_version="5.11.3", cpp_lib_version="5.12.2", cpp_lib_version="5.13.0").

pub unsafe fn static_meta_object() -> Ref<QMetaObject>[src]

Returns a reference to the staticMetaObject field.

This item is available if any(cpp_lib_version="5.11.3", cpp_lib_version="5.12.2", cpp_lib_version="5.13.0").

pub unsafe fn tr(
    s: impl CastInto<Ptr<c_char>>,
    c: impl CastInto<Ptr<c_char>>,
    n: c_int
) -> CppBox<QString>[src]

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

This item is available if any(cpp_lib_version="5.11.3", cpp_lib_version="5.12.2", cpp_lib_version="5.13.0").

pub unsafe fn tr_utf8(
    s: impl CastInto<Ptr<c_char>>,
    c: impl CastInto<Ptr<c_char>>,
    n: c_int
) -> CppBox<QString>[src]

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

This item is available if any(cpp_lib_version="5.11.3", cpp_lib_version="5.12.2", cpp_lib_version="5.13.0").

Methods from Deref<Target = QComponent>

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

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,)>[src]

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,)>[src]

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,)>[src]

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>[src]

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[src]

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>[src]

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

pub unsafe fn qt_metacall(
    &mut self,
    arg1: Call,
    arg2: c_int,
    arg3: impl CastInto<MutPtr<*mut c_void>>
) -> c_int[src]

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

pub unsafe fn qt_metacast(
    &mut self,
    arg1: impl CastInto<Ptr<c_char>>
) -> MutPtr<c_void>[src]

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

pub unsafe fn set_shareable(&mut self, is_shareable: bool)[src]

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)

Trait Implementations

impl CppDeletable for QArmature[src]

unsafe fn delete(&mut self)[src]

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

impl Deref for QArmature[src]

type Target = QComponent

The resulting type after dereferencing.

fn deref(&self) -> &QComponent[src]

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

impl DerefMut for QArmature[src]

fn deref_mut(&mut self) -> &mut QComponent[src]

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

impl DynamicCast<QArmature> for QComponent[src]

unsafe fn dynamic_cast(ptr: Ptr<QComponent>) -> Ptr<QArmature>[src]

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

unsafe fn dynamic_cast_mut(ptr: MutPtr<QComponent>) -> MutPtr<QArmature>[src]

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

impl DynamicCast<QArmature> for QNode[src]

unsafe fn dynamic_cast(ptr: Ptr<QNode>) -> Ptr<QArmature>[src]

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

unsafe fn dynamic_cast_mut(ptr: MutPtr<QNode>) -> MutPtr<QArmature>[src]

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

impl DynamicCast<QArmature> for QObject[src]

unsafe fn dynamic_cast(ptr: Ptr<QObject>) -> Ptr<QArmature>[src]

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

unsafe fn dynamic_cast_mut(ptr: MutPtr<QObject>) -> MutPtr<QArmature>[src]

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

impl StaticDowncast<QArmature> for QComponent[src]

unsafe fn static_downcast(ptr: Ptr<QComponent>) -> Ptr<QArmature>[src]

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

unsafe fn static_downcast_mut(ptr: MutPtr<QComponent>) -> MutPtr<QArmature>[src]

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

impl StaticDowncast<QArmature> for QNode[src]

unsafe fn static_downcast(ptr: Ptr<QNode>) -> Ptr<QArmature>[src]

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

unsafe fn static_downcast_mut(ptr: MutPtr<QNode>) -> MutPtr<QArmature>[src]

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

impl StaticDowncast<QArmature> for QObject[src]

unsafe fn static_downcast(ptr: Ptr<QObject>) -> Ptr<QArmature>[src]

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

unsafe fn static_downcast_mut(ptr: MutPtr<QObject>) -> MutPtr<QArmature>[src]

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

impl StaticUpcast<QComponent> for QArmature[src]

unsafe fn static_upcast(ptr: Ptr<QArmature>) -> Ptr<QComponent>[src]

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

unsafe fn static_upcast_mut(ptr: MutPtr<QArmature>) -> MutPtr<QComponent>[src]

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

impl StaticUpcast<QNode> for QArmature[src]

unsafe fn static_upcast(ptr: Ptr<QArmature>) -> Ptr<QNode>[src]

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

unsafe fn static_upcast_mut(ptr: MutPtr<QArmature>) -> MutPtr<QNode>[src]

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

impl StaticUpcast<QObject> for QArmature[src]

unsafe fn static_upcast(ptr: Ptr<QArmature>) -> Ptr<QObject>[src]

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

unsafe fn static_upcast_mut(ptr: MutPtr<QArmature>) -> MutPtr<QObject>[src]

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

Auto Trait Implementations

Blanket Implementations

impl<T> Any for T where
    T: 'static + ?Sized, [src]

impl<T> Borrow<T> for T where
    T: ?Sized, [src]

impl<T> BorrowMut<T> for T where
    T: ?Sized, [src]

impl<T, U> CastInto<U> for T where
    U: CastFrom<T>, [src]

impl<T> From<T> for T[src]

impl<T, U> Into<U> for T where
    U: From<T>, [src]

impl<T> StaticUpcast<T> for T[src]

impl<T, U> TryFrom<U> for T where
    U: Into<T>, [src]

type Error = Infallible

The type returned in the event of a conversion error.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, [src]

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.