Member Function Documentation

Qt3DAnimation::QAbstractAnimationClip *SceneEntity::animationClip(const QString &name) const

Utility method returning an instance of Qt3DAnimation::QAbstractAnimationClip matching name (or nullptr if not found)

Note: This function can be invoked via the meta-object system and from QML. See Q_INVOKABLE.

Kuesa::AnimationClipCollection *SceneEntity::animationClips() const

Returns instance of collection of Qt3DAnimation::QAbstractAnimationClip assets

Note: Getter function for property animationClips.

Qt3DAnimation::QChannelMapper *SceneEntity::animationMapping(const QString &name)

Utility method returning an instance of Qt3DAnimation::QChannelMapper matching name (or nullptr if not found)

Note: This function can be invoked via the meta-object system and from QML. See Q_INVOKABLE.

Kuesa::AnimationMappingCollection *SceneEntity::animationMappings() const

Returns instance of collection of Qt3DAnimation::QChannelMapper assets

Note: Getter function for property animationMappings.

Qt3DCore::QArmature *SceneEntity::armature(const QString &name) const

Utility method returning an instance of Qt3DCore::QArmature matching name (or nullptr if not found)

Note: This function can be invoked via the meta-object system and from QML. See Q_INVOKABLE.

Kuesa::ArmatureCollection *SceneEntity::armatures() const

Returns instance of collection of Qt3DCore::QArmature assets

Note: Getter function for property armatures.

Qt3DRender::QAbstractTexture *SceneEntity::brdfLut() const

SceneEntity::brdfLut Returns the brdfLut texture stored in the SceneEntity

The brdfLut is used as a lookup texture and is needed for the metallic roughness effect instances. The metallic roughness effect will use the brdfLut texture stored in the SceneEntity if the user doesn't provide another one. This allows to share the same texture instance between all the instances of the metallic roughness effect.

https://learnopengl.com/PBR/IBL/Specular-IBL

Note: This function can be invoked via the meta-object system and from QML. See Q_INVOKABLE.

Note: Getter function for property brdfLut.

Qt3DRender::QCamera *SceneEntity::camera(const QString &name) const

Utility method returning an instance of Qt3DRender::QCamera matching name (or nullptr if not found)

Note: This function can be invoked via the meta-object system and from QML. See Q_INVOKABLE.

Kuesa::CameraCollection *SceneEntity::cameras() const

Returns instance of collection of Qt3DRender::QCamera assets

Note: Getter function for property cameras.

void SceneEntity::clearCollections()

Removes all assets from all the collections.

Note: Assets which are parented with the collection will be deleted.

Note: This function can be invoked via the meta-object system and from QML. See Q_INVOKABLE.

Qt3DRender::QEffect *SceneEntity::effect(const QString &name) const

Utility method returning an instance of Qt3DRender::QEffect matching the name (or nullptr if not found)

Note: This function can be invoked via the meta-object system and from QML. See Q_INVOKABLE.

Qt3DRender::QEffect *SceneEntity::effect(int effectPropertyFlags) const

Utility method returning an instance of Qt3DRender::QEffect matching the flags in effectPropertyFlags (or nullptr if not found)

Note: This function can be invoked via the meta-object system and from QML. See Q_INVOKABLE.

Kuesa::EntityCollection *SceneEntity::entities() const

Returns instance of collection of Qt3DCore::QEntity assets

Note: Getter function for property entities.

Qt3DCore::QEntity *SceneEntity::entity(const QString &name) const

Utility method returning an instance of Qt3DCore::QEntity matching name (or nullptr if not found)

Note: This function can be invoked via the meta-object system and from QML. See Q_INVOKABLE.

Qt3DRender::QLayer *SceneEntity::layer(const QString &name) const

Utility method returning an instance of Qt3DRender::QLayer matching name (or nullptr if not found)

Note: This function can be invoked via the meta-object system and from QML. See Q_INVOKABLE.

Kuesa::LayerCollection *SceneEntity::layers() const

Returns instance of collection of Qt3DRender::QLayer assets

Note: Getter function for property layers.

Kuesa::GLTF2MaterialProperties *SceneEntity::material(const QString &name) const

Utility method returning an instance of the Qt3DRender::GLTF2MaterialProperties subclass matching name (or nullptr if not found)

Note: This function can be invoked via the meta-object system and from QML. See Q_INVOKABLE.

Kuesa::MaterialCollection *SceneEntity::materials() const

Returns instance of collection of Qt3DRender::QMaterial assets

Note: Getter function for property materials.

Qt3DRender::QGeometryRenderer *SceneEntity::mesh(const QString &name) const

Utility method returning an instance of QGeometryRenderer matching name (or nullptr if not found)

Note: This function can be invoked via the meta-object system and from QML. See Q_INVOKABLE.

Kuesa::MeshCollection *SceneEntity::meshes() const

Returns instance of collection of QGeometryRenderer assets

Note: Getter function for property meshes.

Kuesa::ReflectionPlane *SceneEntity::reflectionPlane(const QString &name) const

Utility method returning an instance of Kuesa::ReflectionPlane matching name (or nullptr if not found)

Note: This function can be invoked via the meta-object system and from QML. See Q_INVOKABLE.

Qt3DCore::QAbstractSkeleton *SceneEntity::skeleton(const QString &name) const

Utility method returning an instance of Qt3DCore::QAbstractSkeleton matching name (or nullptr if not found)

Note: This function can be invoked via the meta-object system and from QML. See Q_INVOKABLE.

Kuesa::SkeletonCollection *SceneEntity::skeletons() const

Returns instance of collection of Qt3DCore::QAbstractSkeleton assets

Note: Getter function for property skeletons.

Qt3DRender::QAbstractTexture *SceneEntity::texture(const QString &name) const

Utility method returning an instance of Qt3DRender::QAbstractTexture matching name (or nullptr if not found)

Note: This function can be invoked via the meta-object system and from QML. See Q_INVOKABLE.

Qt3DRender::QAbstractTextureImage *SceneEntity::textureImage(const QString &name)

Utility method returning an instance of Qt3DRender::QAbstractTextureImage matching name (or nullptr if not found)

Note: This function can be invoked via the meta-object system and from QML. See Q_INVOKABLE.

Kuesa::TextureImageCollection *SceneEntity::textureImages() const

Returns instance of collection of Qt3DRender::QAbstractTextureImage assets

Note: Getter function for property textureImages.

Kuesa::TextureCollection *SceneEntity::textures() const

Returns instance of collection of Qt3DRender::QAbstractTexture assets

Note: Getter function for property textures.

Qt3DCore::QTransform *SceneEntity::transform(const QString &name) const

Utility method returning an instance of Qt3DCore::QTransform matching name (or nullptr if not found)

Note: This function can be invoked via the meta-object system and from QML. See Q_INVOKABLE.

This function was introduced in Kuesa 1.2.

Qt3DCore::QNode *SceneEntity::transformForEntity(const QString &name)

SceneEntity::transformForEntity returns the transform component of the specified entity identified by name.

This is a utility method which will look for an entity in the SceneEntity's EntityCollection and return the Qt3DCore::QTransform component if it exists.

Note: This function can be invoked via the meta-object system and from QML. See Q_INVOKABLE.

Kuesa::TransformCollection *SceneEntity::transforms() const

Returns instance of collection of Qt3DCore::QTransform assets

Note: Getter function for property transforms.

This function was introduced in Kuesa 1.2.