GltfModelEntity

Artifact: androidx.xr.scenecore:scenecore

Kotlin |Java

public final class GltfModelEntity extends BaseEntity

java.lang.Object
↳	androidx.xr.scenecore.BaseScenePose
	↳	androidx.xr.scenecore.BaseEntity
		↳	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

Nested types
`public final class GltfModelEntity.AnimationState` Specifies the current animation state of the GltfModelEntity.

Public methods
`final void`	`@MainThread clearMaterialOverride(@NonNull String nodeName, int primitiveIndex)` Clears a previously set material override for a specific primitive of a node within the glTF graph.
`static final @NonNull GltfModelEntity`	`@MainThread create(@NonNull Session session, @NonNull GltfModel model, @NonNull Pose pose)` Public factory function for a `GltfModelEntity`.
`final @NonNull GltfModelEntity.AnimationState`	`getAnimationState()` The current animation state of the GltfModelEntity.
`final void`	`@MainThread setMaterialOverride( @NonNull Material material, @NonNull String nodeName, int primitiveIndex )` Sets a material override for a primitive of a node within the glTF graph.
`final void`	`@MainThread startAnimation(boolean loop)` Starts animating the glTF with the first animation found in the model.
`final void`	`@MainThread startAnimation(boolean loop, @NonNull String animationName)` Starts the animation with the given name.
`final void`	`@MainThread stopAnimation()` Stops the currently active animation.

Inherited methods

From androidx.xr.scenecore.BaseEntity

`void`	`addChild(@NonNull Entity child)` Sets an Entity to be a child of this Entity in the scene graph.
`boolean`	`addComponent(@NonNull Component component)` Adds a Component to this Entity.
`void`	`dispose()` Disposes of any system resources held by this Entity, and transitively calls dispose() on all its children.
`float`	`getAlpha(@NonNull Space relativeTo)` Returns the alpha transparency set for this Entity, relative to given Space.
`@NonNull List<@NonNull Entity>`	`getChildren()` Provides the list of all children of this entity.
`@NonNull List<@NonNull Component>`	`getComponents()` Retrieves all components attached to this Entity.
`@NonNull List<@NonNull T>`	`<T extends Component> getComponentsOfType(@NonNull Class<@NonNull T> type)` Retrieves all Components of the given type `T` and its sub-types attached to this Entity.
`@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`.
`float`	`getScale(@NonNull Space relativeTo)` Returns the scale of this entity, relative to given space.
`boolean`	`isEnabled(boolean includeParents)` Returns the enabled status of this Entity.
`void`	`removeAllComponents()` Remove all components from this Entity.
`void`	`removeComponent(@NonNull Component component)` Removes the given Component from this Entity.
`void`	`setAlpha(float alpha, @NonNull Space relativeTo)` Sets the alpha transparency of the Entity relative to given Space.
`void`	`setContentDescription(@NonNull CharSequence contentDescription)` Alternate text for this Entity to be consumed by Accessibility systems.
`void`	`setEnabled(boolean enabled)` Sets the local enabled state of this Entity.
`void`	`setParent(Entity parent)` 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(float scale, @NonNull Space relativeTo)` Sets the scale of this Entity relative to the given Space.

From androidx.xr.scenecore.Entity

`@FloatRange(from = 0.0, to = 1.0) float`	`getAlpha()` Returns the alpha transparency set for this Entity.
`@NonNull Pose`	`getPose()` Returns the `Pose` for this Entity, relative to its parent.
`@FloatRange(from = 0.0) float`	`getScale()` Returns the local scale of this Entity, not inclusive of the parent's scale.
`void`	`setAlpha(@FloatRange(from = 0.0, to = 1.0) float alpha)` Sets the alpha transparency of the Entity and its children.
`void`	`setPose(@NonNull Pose pose)` Sets the `Pose` for this Entity, relative to its parent.
`void`	`setScale(@FloatRange(from = 0.0) float scale)` Sets the scale of this Entity relative to its parent.

From androidx.xr.scenecore.ScenePose

`abstract @NonNull Pose`	`getActivitySpacePose()` The current `Pose` relative to the activity space root.
`abstract HitTestResult`	`hitTest(@NonNull Vector3 origin, @NonNull Vector3 direction)` Perform a hit test from the specified origin in the specified direction into the Scene.
`abstract 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.
`abstract @NonNull Pose`	`transformPoseTo(@NonNull Pose pose, @NonNull ScenePose destination)` Returns a `Pose` relative to this ScenePose, transformed into a Pose relative to the destination.

Public methods

clearMaterialOverride

Added in 1.0.0-alpha10

@MainThread
public final void clearMaterialOverride(@NonNull String nodeName, int primitiveIndex)

Clears a previously set material override for a specific primitive of a node within the glTF graph.

If no override was previously set for that primitive, this call has no effect.

Parameters
`@NonNull String nodeName`	The name of the node containing the primitive whose material override will be cleared.
`int primitiveIndex`	The zero-based index for the primitive of the specified node, as defined in the glTF graph. Default is the first primitive of that node.

Throws
`kotlin.IllegalArgumentException`	if the provided `Material` is invalid or if no node with the given `nodeName` is found in the model.
`kotlin.IndexOutOfBoundsException`	if the `primitiveIndex` is out of bounds.

create

Added in 1.0.0-alpha10

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

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`.

getAnimationState

Added in 1.0.0-alpha10

public final @NonNull GltfModelEntity.AnimationState getAnimationState()

The current animation state of the GltfModelEntity.

Returns
`@NonNull GltfModelEntity.AnimationState`	The current animation state.

setMaterialOverride

Added in 1.0.0-alpha10

@MainThread
public final void setMaterialOverride(
    @NonNull Material material,
    @NonNull String nodeName,
    int primitiveIndex
)

Sets a material override for a primitive of a node within the glTF graph.

This function searches for the first node in the glTF scene graph with a matching nodeName. The override is then applied to a primitive of that node at the specified primitiveIndex.

Parameters
`@NonNull Material material`	The new `Material` to apply to the primitive.
`@NonNull String nodeName`	The name of the node as defined in the glTF graph, containing the primitive to override.
`int primitiveIndex`	The zero-based index for the primitive of the specified node, as defined in the glTF graph. Default is the first primitive of that node.

Throws
`kotlin.IllegalArgumentException`	if the provided `material` is invalid or if no node with the given `nodeName` is found in the model.
`kotlin.IndexOutOfBoundsException`	if the `primitiveIndex` is out of bounds.

startAnimation

Added in 1.0.0-alpha10

@MainThread
public final void startAnimation(boolean loop)

Starts animating the glTF with the first animation found in the model.

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

Parameters
`boolean loop`	Whether the animation should loop over or stop after animating once. Defaults to true.

Throws
`kotlin.IllegalArgumentException`	if the underlying model doesn't contain any animations.

startAnimation

Added in 1.0.0-alpha10

@MainThread
public final void startAnimation(boolean loop, @NonNull String animationName)

Starts the animation with the given name. Only one animation can be playing at a time.

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

Parameters
`boolean loop`	If true, the animation plays in a loop indefinitely until `stopAnimation` is called. If false, the animation plays once and then stops.
`@NonNull String animationName`	The name of the animation to start.

Throws
`kotlin.IllegalArgumentException`	if the underlying model doesn't contain an animation with the given name.

stopAnimation

Added in 1.0.0-alpha10

@MainThread
public final void stopAnimation()

Stops the currently active animation.

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

GltfModelEntity

Summary

Nested types

Public methods

Inherited methods

Public methods

clearMaterialOverride

create

getAnimationState

setMaterialOverride

startAnimation

startAnimation

stopAnimation