GltfModelEntity

Artifact: androidx.xr.scenecore:scenecore

Kotlin |Java

public final class GltfModelEntity extends Entity

java.lang.Object
↳	androidx.xr.scenecore.BaseScenePose
	↳	androidx.xr.scenecore.Entity
		↳	androidx.xr.scenecore.GltfModelEntity

GltfModelEntity is a concrete implementation of Entity that hosts a glTF model.

Note: The size property of this Entity is always reported as {0, 0, 0}, regardless of the actual size of the model.

Summary

Public methods
`static final @NonNull GltfModelEntity`	`@MainThread create( @NonNull Session session, @NonNull GltfModel model, @NonNull Pose pose, Entity parent )` Public factory function for a `GltfModelEntity`.
`final @NonNull List<@NonNull GltfAnimation>`	`@MainThread @RequiresApi(value = 26) @ExperimentalGltfAnimationApi getAnimations()` A list of all `GltfAnimation`s defined in the `GltfModelEntity`.
`final @NonNull List<@NonNull GltfModelNode>`	`@MainThread getNodes()` A list of all `GltfModelNode`s defined in the `GltfModelEntity`.

Inherited methods

From androidx.xr.scenecore.BaseScenePose

`@NonNull Pose`	`getPoseInActivitySpace()` The current `Pose` relative to the activity space root.
`HitTestResult`	`hitTest(@NonNull Vector3 origin, @NonNull Vector3 direction)` Perform a hit test from the specified origin in the specified direction into the Scene.
`HitTestResult`	`hitTest( @NonNull Vector3 origin, @NonNull Vector3 direction, int hitTestFilter )` Creates a hit test from the specified origin in the specified direction into the scene.
`@NonNull Vector3`	`transformDirectionTo( @NonNull Vector3 direction, @NonNull ScenePose destination )` Transforms a direction from this ScenePose's local space to the destination ScenePose's local space.
`@NonNull Pose`	`transformPoseTo(@NonNull Pose pose, @NonNull ScenePose destination)` Returns a `Pose` relative to this ScenePose, transformed into a Pose relative to the destination.
`@NonNull Vector3`	`transformPositionTo( @NonNull Vector3 position, @NonNull ScenePose destination )` Transforms a position from this ScenePose's local space to the destination ScenePose's local space.
`@NonNull Vector3`	`transformVectorTo(@NonNull Vector3 vector, @NonNull ScenePose destination)` Transforms a vector from this ScenePose's local space to the destination ScenePose's local space.

From androidx.xr.scenecore.Entity

`final void`	`addChild(@NonNull Entity child)` Sets an Entity to be a child of this Entity in the scene graph.
`final boolean`	`addComponent(@NonNull Component component)` Adds a Component to this Entity.
`final @FloatRange(from = 0.0, to = 1.0) float`	`getAlpha(@NonNull Space relativeTo)` Returns the alpha transparency set for this Entity, relative to given Space.
`final @NonNull List<@NonNull Entity>`	`getChildren()` Provides the list of all children of this entity.
`final @NonNull List<@NonNull Component>`	`getComponents()` Retrieves all components attached to this Entity.
`final @NonNull List<@NonNull T>`	`<T extends Component> getComponentsOfType(@NonNull Class<@NonNull T> type)` Retrieves all Components of the given type `T` and its subtypes attached to this Entity.
`final @NonNull CharSequence`	`getContentDescription()` Alternate text for this Entity to be consumed by Accessibility systems.
`Entity`	`getParent()` The parent of this Entity, from which this Entity will inherit most of its properties.
`@NonNull Pose`	`getPose(@NonNull Space relativeTo)` Returns the `Pose` for this Entity, relative to the provided `Space`.
`@FloatRange(from = 0.0) float`	`getScale(@NonNull Space relativeTo)` Returns the scale of this entity, relative to given space.
`final boolean`	`isEnabled(boolean includeParents)` Returns the enabled status of this Entity.
`final void`	`removeAllComponents()` Remove all components from this Entity.
`final void`	`removeComponent(@NonNull Component component)` Removes the given Component from this Entity.
`final void`	`setAlpha(@FloatRange(from = 0.0, to = 1.0) float alpha)` Sets the alpha transparency of the Entity relative to the parent Space.
`final void`	`setContentDescription(@NonNull CharSequence value)` Alternate text for this Entity to be consumed by Accessibility systems.
`final void`	`setEnabled(boolean enabled)` Sets the local enabled state of this Entity.
`void`	`setParent(Entity value)` The parent of this Entity, from which this Entity will inherit most of its properties.
`void`	`setPose(@NonNull Pose pose, @NonNull Space relativeTo)` Sets the `Pose` for this Entity.
`void`	`setScale(@FloatRange(from = 0.0) float scale, @NonNull Space relativeTo)` Sets the scale of this Entity relative to the given Space.

Public methods

create

Added in 1.0.0-beta01

@MainThread
public static final @NonNull GltfModelEntity create(
    @NonNull Session session,
    @NonNull GltfModel model,
    @NonNull Pose pose,
    Entity parent
)

Public factory function for a GltfModelEntity.

This method must be called from the main thread. https://developer.android.com/guide/components/processes-and-threads

Parameters
`@NonNull Session session`	`Session` to create the `GltfModel` in.
`@NonNull GltfModel model`	The `GltfModel` this `Entity` is referencing.
`@NonNull Pose pose`	The initial `Pose` of the `Entity`. The default value is `Pose.Identity`.
`Entity parent`	Parent entity. Defaults to `null`. If `null`, the entity is created but not attached to the scene graph, meaning it will be invisible. If a parent entity (e.g., `ActivitySpace` or any other `Entity` already present in the scene) is assigned later, the entity will become visible (provided it is enabled). This allows for `Entity` pre-configuration before making it visible.

getAnimations

Added in 1.0.0-beta01

@MainThread
@RequiresApi(value = 26)
@ExperimentalGltfAnimationApi
public final @NonNull List<@NonNull GltfAnimation> getAnimations()

A list of all GltfAnimations defined in the GltfModelEntity. The list is lazily initialized on the first access.

The returned list corresponds to the array of animations defined in the source glTF file. The order of elements in this list is guaranteed to match the order of animations in the glTF file's animations array.

getNodes

Added in 1.0.0-beta01

@MainThread
public final @NonNull List<@NonNull GltfModelNode> getNodes()

A list of all GltfModelNodes defined in the GltfModelEntity. The list is lazily initialized on the first access.

The returned list corresponds to the flattened array of nodes defined in the source glTF file. The order of elements in this list is guaranteed to match the order of nodes in the glTF file's nodes array.