class Grabbable(enabled: Boolean = true, type: GrabbableType = GrabbableType.FACE, isGrabbed: Boolean = false, minHeight: Float = -Float.MAX_VALUE, maxHeight: Float = Float.MAX_VALUE) : ComponentBase

Grabbable is a component that allows an object to be grabbed by a controller. It requires the Entity to have a com.meta.spatial.runtime.SceneObject attached.

Constructors

Name	Summary
Grabbable	constructor(enabled: Boolean = true, type: GrabbableType = GrabbableType.FACE, isGrabbed: Boolean = false, minHeight: Float = -Float.MAX_VALUE, maxHeight: Float = Float.MAX_VALUE)

Types

Name	Summary
Companion	object Companion : ComponentCompanion

Properties

Name	Summary
cachable	open override var cachable: <Error class: unknown class>
enabled	var enabled: Boolean Defines whether the object can be grabbed or not.
entID	var entID: Long
isDirty	var isDirty: Boolean
isGrabbed	var isGrabbed: Boolean Whether the object is currently grabbed or not
maxHeight	var maxHeight: Float the maximum height an object can be held when grabbed
minHeight	var minHeight: Float the minimum height an object can be held when grabbed
recycled	var recycled: Boolean
timeStamp	var timeStamp: Long
type	var type: GrabbableType The type of behavior an object has when grabbed (faces user, pivots on y axis, etc.)

Functions

Name	Summary
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

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: () -> Grabbable
enabledData	val enabledData: BooleanAttributeData
enabledId	val enabledId: <Error class: unknown class>
enumClassesMap_	val enumClassesMap_: Map<Int, Class<out Enum<*>>>
id	open override val id: <Error class: unknown class>
isGrabbedData	val isGrabbedData: BooleanAttributeData
isGrabbedId	val isGrabbedId: <Error class: unknown class>
keyStringToKeyIntMap_	val keyStringToKeyIntMap_: Map<String, Int>
maxHeightData	val maxHeightData: FloatAttributeData
maxHeightId	val maxHeightId: <Error class: unknown class>
minHeightData	val minHeightData: FloatAttributeData
minHeightId	val minHeightId: <Error class: unknown class>
typeData	val typeData: EnumAttributeData
typeId	val typeId: <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
dependents	open fun dependents(): IntArray
enumClassesMap	open override fun enumClassesMap(): Map<Int, Class<out Enum<*>>>
keyStringToKeyIntMap	open override fun keyStringToKeyIntMap(keyString: String): Int?