RuntimeLoader QML Type

Imports a 3D asset at runtime. More...

• List of all members, including inherited members

Properties

• bounds : Bounds
• errorString : string
• instancing : Instancing
• source : url
• status : enumeration

Methods

• Object3D query(string arg) (since 6.12)
• List<Object3D> queryAll(QueryFilter filter) (since 6.12)

Detailed Description

The RuntimeLoader type provides a way to load a 3D asset directly from source at runtime, without converting it to QtQuick3D's internal format first.

RuntimeLoader supports .obj and glTF version 2.0 files in both in text (.gltf) and binary (.glb) formats.

Property Documentation

bounds : Bounds [read-only]

This property describes the extents of the bounding volume around the imported model.

errorString : string [read-only]

This property holds a human-readable string indicating the status of the latest load operation.

instancing : Instancing

If this property is set, the imported model will not be rendered normally. Instead, a number of instances will be rendered, as defined by the instance table.

See the Instanced Rendering overview documentation for more information.

source : url

This property holds the location of the source file containing the 3D asset. Changing this property will unload the current asset and attempt to load an asset from the given URL.

The success or failure of the load operation is indicated by status.

status : enumeration [read-only]

This property holds the status of the latest load operation.

Method Documentation

[since 6.12] Object3D query(string arg)

Returns the object with the given name, or null if no object with that name exists.

The arg parameter is the name of the object to query or a query string. For example, to query the object named "PaintMaterialX", use the following code:

var object = runtimeLoader.query("PaintMaterial")

The above code works as expected assuming the objects are sensibly named in the source asset file. However, if there are multiple objects with the same name, the query will return the first object found matching the given name. To query a specific object, and avoid ambiguity, use the full object path.

var object = runtimeLoader.query("/House2/Wall001/Mirror/Material")

This method was introduced in Qt 6.12.

[since 6.12] List<Object3D> queryAll(QueryFilter filter)

Returns a list of all objects matching the given filter.

The filter parameter specifies the type of objects to query for. For example, to query for all materials, use the following code:

var materials = runtimeLoader.queryAll(RuntimeLoader.Materials)

The above code returns a list of all materials in the source asset file.

This method was introduced in Qt 6.12.