gltfio/io.github.erkko68.filament.gltfio/FilamentAsset

FilamentAsset

class FilamentAsset(nativeHandle: NativePointer)

FilamentAsset owns a loaded glTF 2.0 asset and all its Filament objects.

A FilamentAsset represents a complete glTF scene with a hierarchy of entities, each having a Transform component. Some entities also have Renderable, Light, Camera, or animation components.

Assets own strong references to VertexBuffer, IndexBuffer, Texture objects, and optionally an Animator for skeletal animations. External resource loading (textures, buffer data) is handled separately via ResourceLoader.

Note: Only the default glTF scene is loaded; other glTF scenes are ignored.

See also

FilamentInstance

Constructors

constructor(nativeHandle: NativePointer)

Properties

areFilamentComponentsDetached

val areFilamentComponentsDetached: Boolean

assetInstanceCount

val assetInstanceCount: Int

Returns the number of instances created from this asset (>= 1 unless detached).

val assetInstances: List<FilamentInstance>

Returns every FilamentInstance created from this asset.

val boundingBox: Aabb

Gets the bounding box computed from the min/max values in the glTF accessors.

val cameraEntities: IntArray

Gets the entities representing cameras. All of these have a Camera component.

cameraEntityCount

val cameraEntityCount: Int

val engine: Engine

Returns the Engine associated with the AssetLoader that created this asset.

val entities: IntArray

Gets the list of entities, one per glTF node. All have a Transform component; some also have a Renderable and/or Light component.

val entityCount: Int

Gets the number of entities returned by entities.

val instance: FilamentInstance

Convenience accessor for the first instance (assetInstances[0]).

val lightEntities: IntArray

Gets the entities representing lights. All of these have a Light component.

lightEntityCount

val lightEntityCount: Int

val nativeObject: NativePointer

The native object, for interop with code calling the Fila* C API directly. Read-only: this wrapper owns it.

renderableEntities

val renderableEntities: IntArray

Gets the entities that have Renderable components.

renderableEntityCount

val renderableEntityCount: Int

resourceUriCount

val resourceUriCount: Int

val resourceUris: List<String>

Gets the URIs of all externally-referenced buffers/textures (to feed ResourceLoader).

val root: Entity

Gets the transform root of the asset, an extra entity with no matching glTF node.

val sceneCount: Int

Gets the number of glTF scenes in the asset.

val wireframe: Entity

Lazily creates a single LINES renderable that draws the transformed bounding-box hierarchy.

Functions

addEntitiesToScene

fun addEntitiesToScene(targetScene: Scene, entities: IntArray, sceneFilter: Int)

Adds the entities that belong to one of the glTF scenes in sceneFilter (a bit mask of scene indices) to targetScene.

detachFilamentComponents

fun detachFilamentComponents()

Releases ownership of the Filament components (renderables, lights, …) so they outlive AssetLoader.destroyAsset; the client destroys them.

getEntitiesByName

fun getEntitiesByName(name: String, entities: IntArray): Int

Gets up to entities.size entities whose name label matches name exactly into entities.

getEntitiesByPrefix

fun getEntitiesByPrefix(prefix: String, entities: IntArray): Int

Gets up to entities.size entities whose name label starts with prefix into entities.

fun getExtras(entity: Entity): String?

Gets the glTF extras string for the given node entity (or for the asset itself), if any.

getFirstEntityByName

fun getFirstEntityByName(name: String): Entity

Returns the first entity with the given name, or 0 if none exists.

getMorphTargetCountAt

fun getMorphTargetCountAt(entity: Entity): Int

Gets the number of morph targets declared on the given entity.

getMorphTargetNameAt

fun getMorphTargetNameAt(entity: Entity, targetIndex: Int): String?

Gets the name of morph target targetIndex declared on the given entity.

fun getName(entity: Entity): String?

Gets the name label for the given entity, or null if it has none.

fun getSceneName(sceneIndex: Int): String?

Gets the name of glTF scene sceneIndex, or null if it has none.

fun popRenderable(): Entity

Pops a ready renderable off the async-load queue, or returns 0 if none is ready.

fun popRenderables(entities: IntArray): Int

Pops up to entities.size ready renderables off the async-load queue into entities.

releaseSourceData

fun releaseSourceData()

Reclaims CPU-side memory for URI strings, binding lists, and raw animation data.