GltfModel

Artifact: androidx.xr.scenecore:scenecore

Kotlin |Java

public final class GltfModel implements AutoCloseable

GltfModel represents a glTF resource in SceneCore. These can be used as part of the SpatialEnvironment or to display 3D models with GltfModelEntity.

Summary

Public methods
`void`	`@MainThread close()` Closes the given `GltfModel`.
`static final @NonNull GltfModel`	`@MainThread create(@NonNull Session session, @NonNull Path path)` Public factory for a GltfModel, where the glTF is asynchronously loaded from a `Path` relative to the application's `assets/` folder.
`static final @NonNull GltfModel`	`@MainThread create(@NonNull Session session, @NonNull Uri uri)` Public factory for a GltfModel, where the glTF is asynchronously loaded from a `Uri`.
`boolean`	`equals(Object other)`
`int`	`hashCode()`

Public methods

close

Added in 1.0.0-beta01

@MainThread
public void close()

Closes the given GltfModel.

The GltfModel can be explicitly closed at any time or garbage collected. When either happens, its resources are freed. If close() is not explicitly invoked by the client, the GltfModel will be automatically closed when the GltfModel is garbage collected.

Throws
`IllegalStateException`	if the resource has already been closed.

create

@MainThread
public static final @NonNull GltfModel create(@NonNull Session session, @NonNull Path path)

Public factory for a GltfModel, where the glTF is asynchronously loaded from a Path relative to the application's assets/ folder.

Currently, only binary glTF (.glb) files are supported.

Parameters
`@NonNull Session session`	The `Session` to use for loading the model.
`@NonNull Path path`	The Path of the binary glTF (.glb) model to be loaded, relative to the application's `assets/` folder.

Returns
`@NonNull GltfModel`	a `GltfModel` upon completion.

Throws
`IllegalArgumentException`	if `Path.isAbsolute` is true, as this method requires a relative path.

create

@MainThread
public static final @NonNull GltfModel create(@NonNull Session session, @NonNull Uri uri)

Public factory for a GltfModel, where the glTF is asynchronously loaded from a Uri.

Currently, only binary glTF (.glb) files are supported.

Parameters
`@NonNull Session session`	The `Session` to use for loading the model.
`@NonNull Uri uri`	The Uri for a binary glTF (.glb) model to be loaded.

Returns
`@NonNull GltfModel`	a `GltfModel` upon completion.

equals

public boolean equals(Object other)

hashCode

public int hashCode()