API reference
Transform
Transform
class Transform(transform: Pose = Pose()) : ComponentBase
A component that represents a transform. The transform is the Pose, aka. a combination of a position and an orientation. The Pose identifies the position and orientation of the entity.
Parameters
JVM
| Name | Summary |
|---|---|
transform | The initial transform, which identifies the position and orientation of the entity. |
Constructors
| Name | Summary |
|---|---|
Transform | constructor(transform: Pose = Pose()) |
Types
| Name | Summary |
|---|---|
Companion | object Companion : ComponentCompanion |
Properties
| Name | Summary |
|---|---|
cachable | open val cachable: Boolean |
entID | var entID: Long |
isDirty | var isDirty: Boolean |
recycled | var recycled: Boolean |
timeStamp | var timeStamp: Long |
transform | var transform: Pose The initial transform, which identifies the position and orientation of the entity. |
Functions
| Name | Summary |
|---|---|
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
| Name | Summary |
|---|---|
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: () -> Transform |
enumClassesMap_ | val enumClassesMap_: Map<Int, Class<out Enum<*>>> |
id | open override val id: <Error class: unknown class> |
keyStringToKeyIntMap_ | val keyStringToKeyIntMap_: Map<String, Int> |
transformData | val transformData: PoseAttributeData |
transformId | val transformId: <Error class: unknown class> |
Functions
| Name | Summary |
|---|---|
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 |
build | fun build(init: TransformBuilder.() -> Unit): Transform |
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?
Virtual reality / Meta Horizon
Support and legal
Virtual reality / Meta Horizon
Support and legal
Virtual reality / Meta Horizon
Support and legal
English (US)
© 2026 Meta