JxrPlatformAdapter.GltfEntity

Artifact: androidx.xr.scenecore:scenecore

Kotlin |Java

interface JxrPlatformAdapter.GltfEntity : JxrPlatformAdapter.Entity

Interface for a SceneCore [GltfEntity].

Summary

Public functions
`Int`	`getAnimationState()` Returns the current animation state of the glTF entity.
`Unit`	`startAnimation(loop: Boolean, animationName: String?)` Starts the animation with the given name.
`Unit`	`stopAnimation()` Stops the animation of the glTF entity.

Inherited functions

From androidx.xr.scenecore.JxrPlatformAdapter.ActivityPose

`Pose`	`getActivitySpacePose()` Returns the pose for this entity, relative to the activity space root.
`Vector3`	`getActivitySpaceScale()` Returns the scale of this WorldPose relative to the activity space.
`Vector3`	`getWorldSpaceScale()` Returns the scale of this ActivityPose.
`Pose`	`transformPoseTo(pose: Pose, destination: JxrPlatformAdapter.ActivityPose)` Returns a pose relative to this entity transformed into a pose relative to the destination.

From androidx.xr.scenecore.JxrPlatformAdapter.Entity

`Unit`	`addChild(child: JxrPlatformAdapter.Entity)` Add given Entity as child.
`Unit`	`addChildren(children: (Mutable)List<JxrPlatformAdapter.Entity!>)`
`Boolean`	`addComponent(component: JxrPlatformAdapter.Component)` Add these components to entity.
`Unit`	`addInputEventListener( executor: Executor, listener: JxrPlatformAdapter.InputEventListener )` Adds the listener to the set of active input listeners, for input events targeted to this entity or its child entities.
`Unit`	`dispose()` Dispose any system resources held by this entity, and transitively calls dispose() on all the children.
`Float`	`getActivitySpaceAlpha()` Returns the total alpha transparency level for this Entity.
`Float`	`getAlpha()` Returns the set alpha transparency level for this Entity.
`(Mutable)List<JxrPlatformAdapter.Entity!>`	`getChildren()`
`JxrPlatformAdapter.Entity?`	`getParent()`
`Pose`	`getPose()` Returns the pose for this entity, relative to its parent.
`Vector3`	`getScale()` Returns the scale of this entity, relative to its parent.
`Boolean`	`isHidden(includeParents: Boolean)` Returns the hidden status of this Entity.
`Unit`	`removeAllComponents()` Remove all components from this entity.
`Unit`	`removeComponent(component: JxrPlatformAdapter.Component)` Remove the given component from the entity.
`Unit`	`removeInputEventListener( listener: JxrPlatformAdapter.InputEventListener )` Removes the given listener from the set of active input listeners.
`Unit`	`setAlpha(alpha: Float)` Sets the alpha transparency for the given Entity.
`Unit`	`setContentDescription(text: String)`
`Unit`	`setHidden(hidden: Boolean)` Sets the local hidden state of this Entity.
`Unit`	`setParent(parent: JxrPlatformAdapter.Entity?)`
`Unit`	`setPose(pose: Pose)` Updates the pose (position and rotation) of the Entity relative to its parent.
`Unit`	`setScale(scale: Vector3)` Sets the scale of this entity relative to its parent.
`Unit`	`setSize(dimensions: JxrPlatformAdapter.Dimensions)` Sets the size for the given Entity.

Public functions

getAnimationState

Added in 1.0.0-alpha01

fun getAnimationState(): Int

Returns the current animation state of the glTF entity.

startAnimation

Added in 1.0.0-alpha01

fun startAnimation(loop: Boolean, animationName: String?): Unit

Starts the animation with the given name.

Parameters
`loop: Boolean`	Whether the animation should loop.
`animationName: String?`	The name of the animation to start. If null is supplied, will play the first animation found in the glTF.

stopAnimation

Added in 1.0.0-alpha01

fun stopAnimation(): Unit

Stops the animation of the glTF entity.