GltfModelEntity


class GltfModelEntity : BaseEntity


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 functions

Int

Returns the current animation state of this glTF entity.

Unit
@MainThread
startAnimation(loop: Boolean, animationName: String?)

Starts the animation with the given name.

Unit

Stops the animation of the glTF entity.

Inherited functions

From androidx.xr.scenecore.ActivityPose
abstract Pose

Returns the activity space pose for this ActivityPose.

abstract Pose
transformPoseTo(pose: Pose, destination: ActivityPose)

Returns a pose relative to this ActivityPose transformed into a pose relative to the destination.

From androidx.xr.scenecore.BaseEntity
open Unit
addChild(child: Entity)

Sets an Entity to be represented in this coordinate space.

open Boolean
addComponent(component: Component)

Adds a Component to this Entity.

open Unit

Disposes of any system resources held by this Entity, and transitively calls dispose() on all its children.

open Float

Returns the global alpha of this entity computed by multiplying the parent's global alpha to this entity's local alpha.

open Float

Returns the alpha transparency set for this Entity.

open List<Component>

Retrieves all components attached to this Entity.

open List<T>

Retrieves all Components of the given type T and its sub-types attached to this Entity.

open Entity?

Returns the parent of this Entity.

open Pose

Returns the pose for this entity, relative to its parent.

open Float

Returns the local scale of this entity, not inclusive of the parent's scale.

open Dimensions

Returns the dimensions (in meters) for this Entity.

open Float

Returns the accumulated scale of this Entity.

open Boolean
isHidden(includeParents: Boolean)

Returns the hidden status of this Entity.

open Unit

Remove all components from this Entity.

open Unit

Removes the given Component from this Entity.

open Unit
setAlpha(alpha: Float)

Sets the alpha transparency of the Entity and its children.

open Unit

Sets alternate text for this entity to be consumed by Accessibility systems.

open Unit
setHidden(hidden: Boolean)

Sets the local hidden state of this Entity.

open Unit
setParent(parent: Entity?)

Sets this Entity to be represented in the parent's coordinate space.

open Unit
setPose(pose: Pose)

Sets the pose for this Entity, relative to its parent.

open Unit
setScale(scale: Float)

Sets the scale of this entity relative to its parent.

open Unit
setSize(dimensions: Dimensions)

Sets the dimensions in pixels for the Entity.

Public functions

getAnimationState

Added in 1.0.0-alpha01
fun getAnimationState(): Int

Returns the current animation state of this glTF entity.

startAnimation

Added in 1.0.0-alpha01
@MainThread
fun startAnimation(loop: Boolean, animationName: String? = null): Unit

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
loop: Boolean

Whether the animation should loop.

animationName: String? = null

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
fun stopAnimation(): Unit

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