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

IsdkGrabConstraints

IsdkGrabConstraints

class IsdkGrabConstraints(lockFlagsValue: Int = 0, scaleMinMax: Vector2 = Vector2(-Float.MAX_VALUE, Float.MAX_VALUE), verticalMinMax: Vector2 = Vector2(-Float.MAX_VALUE, Float.MAX_VALUE), depthMinMax: Vector2 = Vector2(-Float.MAX_VALUE, Float.MAX_VALUE), lateralMinMax: Vector2 = Vector2(-Float.MAX_VALUE, Float.MAX_VALUE), maxGrabbers: Int = 1) : ComponentBase
IsdkGrabConstraints specifies constraints for grab interactions. Must be paired with an IsdkGrabInteractable component. @param lockFlags flags controlling transformations are locked during grabbing @param scaleMinMax the minimum and maximum scale values for the object @param verticalMinMax the minimum and maximum vertical values for the object @param depthMinMax the minimum and maximum depth values for the object @param lateralMinMax the minimum and maximum lateral values for the object @param maxGrabbers the maximum number of grabbers allowed for the object

Constructors

NameSummary
IsdkGrabConstraints
constructor(lockFlagsValue: Int = 0, scaleMinMax: Vector2 = Vector2(-Float.MAX_VALUE, Float.MAX_VALUE), verticalMinMax: Vector2 = Vector2(-Float.MAX_VALUE, Float.MAX_VALUE), depthMinMax: Vector2 = Vector2(-Float.MAX_VALUE, Float.MAX_VALUE), lateralMinMax: Vector2 = Vector2(-Float.MAX_VALUE, Float.MAX_VALUE), maxGrabbers: Int = 1)

Types

NameSummary
Companion
object Companion : ComponentCompanion
class LockFlags(val value: Int)

Properties

NameSummary
cachable
open override var cachable: <Error class: unknown class>
depthMinMax
var depthMinMax: Vector2

the minimum and maximum depth values for the object
entID
var entID: Long
isDirty
var isDirty: Boolean
lateralMinMax
var lateralMinMax: Vector2

the minimum and maximum lateral values for the object
lockFlags
lockFlagsValue
var lockFlagsValue: Int

flags controlling transformations are locked during grabbing
maxGrabbers
var maxGrabbers: Int

the maximum number of grabbers allowed for the object
recycled
var recycled: Boolean
scaleMinMax
var scaleMinMax: Vector2

the minimum and maximum scale values for the object
timeStamp
var timeStamp: Long
verticalMinMax
var verticalMinMax: Vector2

the minimum and maximum vertical values for the object

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: () -> IsdkGrabConstraints
depthMinMaxData
val depthMinMaxData: Vector2AttributeData
depthMinMaxId
val depthMinMaxId: <Error class: unknown class>
enumClassesMap_
val enumClassesMap_: Map<Int, Class<out Enum<*>>>
id
open override val id: <Error class: unknown class>
keyStringToKeyIntMap_
val keyStringToKeyIntMap_: Map<String, Int>
lateralMinMaxData
val lateralMinMaxData: Vector2AttributeData
lateralMinMaxId
val lateralMinMaxId: <Error class: unknown class>
lockFlagsValueData
val lockFlagsValueData: IntAttributeData
lockFlagsValueId
val lockFlagsValueId: <Error class: unknown class>
maxGrabbersData
val maxGrabbersData: IntAttributeData
maxGrabbersId
val maxGrabbersId: <Error class: unknown class>
scaleMinMaxData
val scaleMinMaxData: Vector2AttributeData
scaleMinMaxId
val scaleMinMaxId: <Error class: unknown class>
verticalMinMaxData
val verticalMinMaxData: Vector2AttributeData
verticalMinMaxId
val verticalMinMaxId: <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