class IsdkGrabbable(enabled: Boolean = true, grabState: IsdkGrabState = IsdkGrabState.NotGrabbed, movementType: IsdkGrabMovementType = IsdkGrabMovementType.Direct, responsiveness: Float = 0.15f, billboardOrientation: Vector3 = Vector3(0.0f, 0.0f, 0.0f)) : ComponentBase

IsdkGrabbable provides a grabbable object for ISDK interactions. @param enabled whether the object is grabbable @param grabState the current grab state of the object @param movementType the type of movement allowed for the object @param responsiveness the responsiveness of the object

Constructors

Name	Summary
IsdkGrabbable	constructor(enabled: Boolean = true, grabState: IsdkGrabState = IsdkGrabState.NotGrabbed, movementType: IsdkGrabMovementType = IsdkGrabMovementType.Direct, responsiveness: Float = 0.15f, billboardOrientation: Vector3 = Vector3(0.0f, 0.0f, 0.0f))

Types

Name	Summary
Companion	object Companion : ComponentCompanion

Properties

Name	Summary
billboardOrientation	var billboardOrientation: Vector3 Additional orientation offset of the billboard to be applied after the transform faces towards the user. Field order is Pitch, Yaw, Roll. Units are degrees. This is only used when movementType is IsdkGrabMovementType.Billboard or IsdkGrabMovementType.AxialBillboard
cachable	open override var cachable: <Error class: unknown class>
enabled	var enabled: Boolean whether the object is grabbable
entID	var entID: Long
grabState	var grabState: IsdkGrabState the current grab state of the object
isDirty	var isDirty: Boolean
movementType	var movementType: IsdkGrabMovementType the type of movement allowed for the object
recycled	var recycled: Boolean
responsiveness	var responsiveness: Float the responsiveness of the object: 1 moves instantly, values between 0 to 1 are smooth, 0 is immovable
timeStamp	var timeStamp: Long

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>>
billboardOrientationData	val billboardOrientationData: Vector3AttributeData
billboardOrientationId	val billboardOrientationId: <Error class: unknown class>
createDefaultInstance	open override val createDefaultInstance: () -> IsdkGrabbable
enabledData	val enabledData: BooleanAttributeData
enabledId	val enabledId: <Error class: unknown class>
enumClassesMap_	val enumClassesMap_: Map<Int, Class<out Enum<*>>>
grabStateData	val grabStateData: EnumAttributeData
grabStateId	val grabStateId: <Error class: unknown class>
id	open override val id: <Error class: unknown class>
keyStringToKeyIntMap_	val keyStringToKeyIntMap_: Map<String, Int>
movementTypeData	val movementTypeData: EnumAttributeData
movementTypeId	val movementTypeId: <Error class: unknown class>
responsivenessData	val responsivenessData: FloatAttributeData
responsivenessId	val responsivenessId: <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?