GltfModelEntity

Artifact: androidx.xr.scenecore:scenecore

View Source

Added in 1.0.0-alpha01

---

Kotlin |Java

public final class GltfModelEntity extends BaseEntity

java.lang.Object
↳	androidx.xr.scenecore.BaseActivityPose
	↳	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 static class GltfModelEntity.AnimationState

Public methods
final int	getAnimationState() Returns the current animation state of this glTF entity.
final void	@MainThread startAnimation(boolean loop, String animationName) Starts the animation with the given name.
final void	@MainThread stopAnimation() Stops the animation of the glTF entity.

Inherited methods
From androidx.xr.scenecore.ActivityPose abstract @NonNull Pose getActivitySpacePose() Returns the activity space pose for this ActivityPose. abstract @NonNull Pose transformPoseTo(@NonNull Pose pose, @NonNull ActivityPose destination) Returns a pose relative to this ActivityPose transformed into a pose relative to the destination.
From androidx.xr.scenecore.BaseEntity void addChild(@NonNull Entity child) Sets an Entity to be represented in this coordinate space. 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 getActivitySpaceAlpha() Returns the global alpha of this entity computed by multiplying the parent's global alpha to this entity's local alpha. float getAlpha() Returns the alpha transparency set for 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. Entity getParent() Returns the parent of this Entity. @NonNull Pose getPose() Returns the pose for this entity, relative to its parent. float getScale() Returns the local scale of this entity, not inclusive of the parent's scale. @NonNull Dimensions getSize() Returns the dimensions (in meters) for this Entity. float getWorldSpaceScale() Returns the accumulated scale of this Entity. boolean isHidden(boolean includeParents) Returns the hidden 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) Sets the alpha transparency of the Entity and its children. void setContentDescription(@NonNull String text) Sets alternate text for this entity to be consumed by Accessibility systems. void setHidden(boolean hidden) Sets the local hidden state of this Entity. void setParent(Entity parent) Sets this Entity to be represented in the parent's coordinate space. void setPose(@NonNull Pose pose) Sets the pose for this Entity, relative to its parent. void setScale(float scale) Sets the scale of this entity relative to its parent. void setSize(@NonNull Dimensions dimensions) Sets the dimensions in pixels for the Entity.

Public methods

getAnimationState

Added in 1.0.0-alpha01

public final int getAnimationState()

Returns the current animation state of this glTF entity.

startAnimation

Added in 1.0.0-alpha01

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

Starts the animation with the given name.

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.
String animationName	The name of the animation to start. If null, the first animation found in the glTF will be played.

stopAnimation

Added in 1.0.0-alpha01

@MainThread
public final void stopAnimation()

Stops the animation of the glTF entity.

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