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
Plays animation for a glTF asset. Also configures different settings for animation.
Parameters
JVM
NameSummary
startTime
World time at which animation started (ms since epoch)
pausedTime
Paused location/time (sec) within animation track
playbackState
Playback state of the animated entity
playbackType
Playback type of the animated entity
track
the animation track of the glTF to play

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 val cachable: Boolean
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
companionUnsafe
open override fun companionUnsafe(): ComponentCompanion?
getComponentDataAttributeType
fun getComponentDataAttributeType(key: Int): AttributePrimitive?
fun getComponentDataAttributeType(keyString: String): AttributePrimitive?
getComponentDataKey
fun getComponentDataKey(key: String): Int?
getComponentDataValue
fun getComponentDataValue(key: Int): Any?
fun getComponentDataValue(keyString: String): Any?
getEnumClass
fun getEnumClass(key: String): Class<out Enum<*>>?
hasComponentData
fun hasComponentData(key: Int): Boolean
fun hasComponentData(keyString: String): Boolean
read
fun read(e: Entity, cachable: Boolean)
recycle
fun recycle()
reset
open fun reset()
setComponentDataValue
fun setComponentDataValue(key: Int, value: Any): Boolean
fun setComponentDataValue(keyString: String, value: Any): Boolean
setPool
fun setPool(pool: ComponentPool<*>, entID: Long)
toString
open override fun toString(): String
typeID
open override fun typeID(): Int
write
fun write(e: 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