QSceneLoader

PyQt5.Qt3DRender.QSceneLoader

Inherits from QComponent.

Description

Provides the facility to load an existing Scene.

Given a 3D source file, the QSceneLoader will try to parse it and build a tree of QEntity objects with proper QGeometryRenderer, QTransform and QMaterial components.

The loader will try to determine the best material to be used based on the properties of the model file. If you wish to use a custom material, you will have to traverse the tree and replace the default associated materials with yours.

As the name implies, QSceneLoader loads a complete scene subtree. If you wish to load a single piece of geometry, you should rather use the QMesh instead.

QSceneLoader internally relies on the use of plugins to support a wide variety of 3D file formats. Here is a list of formats that are supported by Qt3D.

Note: this component shouldn’t be shared among several QEntity instances. Undefined behavior will result.

See also

QMesh, QGeometryRenderer.

Enums

ComponentType

This enum specifies a component type.

Member	Value	Description
CameraLensComponent	5	QCameraLens component
GeometryRendererComponent	1	QGeometryRenderer component
LightComponent	4	QAbstractLight component
MaterialComponent	3	QMaterial component
TransformComponent	2	QTransform component
UnknownComponent	0	Unknown component type

---

Status

This enum identifies the state of loading

Member	Value	Description
Error	3	The QSceneLoader encountered an error while loading the scene file.
Loading	1	The QSceneLoader is currently loading the scene file.
None	0	The QSceneLoader hasn’t been used yet.
Ready	2	The QSceneLoader successfully loaded the scene file.

Methods

__init__(parent: QNode = None)

The constructor creates an instance with the specified parent.

---

component(str, ComponentType) → QComponent

Returns a component matching componentType of a loaded entity with an objectName matching the entityName. If the entity has multiple matching components, the first match in the component list of the entity is returned. If there is no match, a null pointer is returned.

---

entity(str) → QEntity

Returns a loaded entity with an objectName matching the entityName parameter. If multiple entities have the same name, it is undefined which one of them is returned, but it will always be the same one.

---

entityNames() → List[str]

Returns a list of the objectNames of the loaded entities.

---

sceneChangeEvent(QSceneChange)

TODO

---

setSource(QUrl)

See also

source().

---

source() → QUrl

See also

setSource().

---

status() → Status

TODO

Signals

sourceChanged(QUrl)

TODO

---

statusChanged(Status)

TODO