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 val cachable: Boolean
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
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: () -> 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