API reference
API reference
Select your platform
No SDKs available
No versions available

Animated

Animated

class Animated(startTime: Long = -1L, pausedTime: Float = 0.0f, playbackState: PlaybackState = PlaybackState.PLAYING, playbackType: PlaybackType = PlaybackType.LOOP, track: Int = 0) : ComponentBase
The animated component is used to play animations for a glTF asset. It also configures different settings for animation playback. It allows the selection of different playback types, states, and different animation tracks if applicable.

Constructors

NameSummary
Animated
constructor(startTime: Long = -1L, pausedTime: Float = 0.0f, playbackState: PlaybackState = PlaybackState.PLAYING, playbackType: PlaybackType = PlaybackType.LOOP, track: Int = 0)

Types

NameSummary
Companion
object Companion : ComponentCompanion

Properties

NameSummary
cachable
open override var cachable: <Error class: unknown class>
entID
var entID: Long
isDirty
var isDirty: Boolean
pausedTime
var pausedTime: Float

Paused location/time (sec) within animation track
playbackState
var playbackState: PlaybackState

State of the animation (playing or paused)
playbackType
var playbackType: PlaybackType

The type of animation playback to be used
recycled
var recycled: Boolean
startTime
var startTime: Long

World time at which animation started (ms since epoch)
timeStamp
var timeStamp: Long
track
var track: Int

which animation track of the glTF to play

Functions

NameSummary
companion
open override fun companion(): ComponentCompanion

Gets the companion object for this component.
getComponentDataAttributeType
fun getComponentDataAttributeType(key: Int): AttributePrimitive?

Gets the attribute type for the specified key.



fun getComponentDataAttributeType(keyString: String): AttributePrimitive?

Gets the attribute type for the specified string key.
getComponentDataKey
fun getComponentDataKey(key: String): Int?

Gets the integer key associated with the specified string key.
getComponentDataValue
fun getComponentDataValue(key: Int): Any?

Gets the value for the specified key.



fun getComponentDataValue(keyString: String): Any?

Gets the value for the specified string key.
getEnumClass
fun getEnumClass(key: String): Class<out Enum<*>>?

Gets the enum class associated with the specified string key.
hasComponentData
fun hasComponentData(key: Int): Boolean

Checks if this component has data for the specified key.



fun hasComponentData(keyString: String): Boolean

Checks if this component has data for the specified string key.
read
fun read(e: Entity, cachable: Boolean)

Reads component data from the specified entity.
recycle
fun recycle()

Recycles this component by returning it to its pool.
reset
open fun reset()

Resets the component to its default state.
setComponentDataValue
fun setComponentDataValue(key: Int, value: Any): Boolean

Sets the value for the specified key.



fun setComponentDataValue(keyString: String, value: Any): Boolean

Sets the value for the specified string key.
setPool
fun setPool(pool: ComponentPool<*>, entID: Long)

Sets the component pool and entity ID for this component.
toString
open override fun toString(): String
typeID
open override fun typeID(): Int

Returns the unique type ID of this component.
write
fun write(e: Entity)

Writes this component’s data to the specified entity.

Companion

object Companion : ComponentCompanion

Properties

NameSummary
attributeKeys_
val attributeKeys_: IntArray
attributeTypeCounts_
val attributeTypeCounts_: IntArray
attributeTypes_
val attributeTypes_: IntArray
attrMetaData_
val attrMetaData_: Map<Int, <Error class: unknown class><RegisteredAttributeType, String>>
createDefaultInstance
open override val createDefaultInstance: () -> Animated
enumClassesMap_
val enumClassesMap_: Map<Int, Class<out Enum<*>>>
id
open override val id: <Error class: unknown class>
keyStringToKeyIntMap_
val keyStringToKeyIntMap_: Map<String, Int>
pausedTimeData
val pausedTimeData: FloatAttributeData
pausedTimeId
val pausedTimeId: <Error class: unknown class>
playbackStateData
val playbackStateData: EnumAttributeData
playbackStateId
val playbackStateId: <Error class: unknown class>
playbackTypeData
val playbackTypeData: EnumAttributeData
playbackTypeId
val playbackTypeId: <Error class: unknown class>
startTimeData
val startTimeData: LongAttributeData
startTimeId
val startTimeId: <Error class: unknown class>
trackData
val trackData: IntAttributeData
trackId
val trackId: <Error class: unknown class>

Functions

NameSummary
attributeKeys
open override fun attributeKeys(): IntArray
attributeMetaData
open override fun attributeMetaData(): Map<Int, <Error class: unknown class><RegisteredAttributeType, String>>
attributeTypeCountAvailable
open override fun attributeTypeCountAvailable(): Boolean
attributeTypeCounts
open override fun attributeTypeCounts(): IntArray
attributeTypes
open override fun attributeTypes(): IntArray
dependents
open fun dependents(): IntArray
enumClassesMap
open override fun enumClassesMap(): Map<Int, Class<out Enum<*>>>
keyStringToKeyIntMap
open override fun keyStringToKeyIntMap(keyString: String): Int?
Did you find this page helpful?
Thumbs up icon
Thumbs down icon