Component:InteractionHandler: Difference between revisions

Revision as of 06:02, 17 March 2025

This article or section is a Stub. You can help the Resonite Wiki by expanding it.

Component image

Interaction Handler component as seen in the Scene Inspector

Fields

Fields
Name	Type	Description
`persistent`	Bool	Determines whether or not this item will be saved to the server.
`UpdateOrder`	Int	Controls the order in which this component is updated.
`Enabled`	Bool	Controls whether or not this component is enabled. Some components stop their functionality when this field is disabled, but some don't.
`Side`	Chirality	Specifies Left or Right Hand
`LocomotionController`	direct RelayRef`1<LocomotionController>
`GrabSmoothing`	Float
`_streamDriver`	InteractionHandlerStreamDriver
`_undoItem`	ContextMenuItem
`_redoItem`	ContextMenuItem
`ContextMenu`	ContextMenu
`EquippingEnabled`	Bool
`MenuEnabled`	Bool
`UserScalingEnabled`	Bool
`VisualEnabled`	Bool
`PointingGrab`	Bool
`PointingTouch`	Bool
`_toolRoot`	Slot
`_laserSlot`	Slot
`_laserPosition`	field drive of Float3
`_laserRotation`	field drive of FloatQ
`_interactionLaser`	InteractionLaser
`_laserEnabled`	Bool
`_handGrabType`	InteractionHandler.HandGrabType
`_grabToggle`	Bool
`_holderPos`	field drive of Float3
`_holderRot`	field drive of FloatQ
`_laserRotationType`	InteractionHandler.LaserRotationType
`_holderAxisOffset`	Float
`_holderRotationOffset`	FloatQ
`_holderRotationReference`	Nullable`1<FloatQ>
`_originalTwistOffset`	Float
`_userspaceToggleIndicator`	RingMesh
`ToolHolder`	Slot
`ShowInteractionHints`	Bool
`_grabberSphereActive`	field drive of Bool
`_grabIgnoreRoot`	Slot
`_grabber`	Grabber
`_currentGrabType`	InteractionHandler.GrabType
`ActiveToolLink`	direct LinkTargetRef`1<ITool>
`_activeToolGripPoseReference`	GripPoseReference
`_toolLocked`	Bool
`_grabMaterial`	FresnelMaterial
`_itemShelfSlot`	Slot
`_itemShelf`	ItemShelf

Sync Delegates

Triggers
Method Name	Method type and Arguments.	Is the method hidden?
`DequipButtonEventHandler`	ButtonEventHandler	✓
`EquipGrabbedButtonEventHandler`	ButtonEventHandler	✓
`OpenLocomotionMenuButtonEventHandler`	ButtonEventHandler	✓
`OpenGrabbingMenuButtonEventHandler`	ButtonEventHandler	✓
`OpenHandGrabMenuButtonEventHandler`	ButtonEventHandler	✓
SetLocomotionButtonEventHandler`1<ILocomotionModule>	ButtonEventHandler`1<ILocomotionModule>	✓
SetGrabTypeButtonEventHandler`1<InteractionHandler.HandGrabType>	ButtonEventHandler`1<InteractionHandler.HandGrabType>	✓
`DestroyGrabbedButtonEventHandler`	ButtonEventHandler	✓
`DuplicateGrabbedButtonEventHandler`	ButtonEventHandler	✓
`SaveGrabbedButtonEventHandler`	ButtonEventHandler	✓
`UndoButtonEventHandler`	ButtonEventHandler	✓
`RedoButtonEventHandler`	ButtonEventHandler	✓
`ResetUserScaleButtonEventHandler`	ButtonEventHandler	✓
`OnStraightenButtonEventHandler`	ButtonEventHandler	✓
`OnRotateUpButtonEventHandler`	ButtonEventHandler	✓
`OnRotateRightButtonEventHandler`	ButtonEventHandler	✓
`OnRotateForwardButtonEventHandler`	ButtonEventHandler	✓
`OnRotateUnconstrainedButtonEventHandler`	ButtonEventHandler	✓

Usage

Examples

Related Components

@@ Line 30: / Line 30: @@
 |_interactionLaser|'''[[Component:InteractionLaser|InteractionLaser]]'''|TypeAdv17=true|
 |_laserEnabled|Bool|
-|_handGrabType|'''[[#HandGrabType|HandGrabType]]'''|TypeAdv19=true|
+|_handGrabType|'''[[#HandGrabType|InteractionHandler.HandGrabType]]'''|TypeAdv19=true|
-|_holderPos|{{RootFieldType|FieldDrive`1|[[Type:Float3|Float3]]}}|TypeAdv20=true|
+|_grabToggle|Bool|
-|_holderRot|{{RootFieldType|FieldDrive`1|[[Type:FloatQ|FloatQ]]}}|TypeAdv21=true|
+|_holderPos|{{RootFieldType|FieldDrive`1|[[Type:Float3|Float3]]}}|TypeAdv21=true|
-|_laserRotationType|'''[[#LaserRotationType|LaserRotationType]]'''|TypeAdv22=true|
+|_holderRot|{{RootFieldType|FieldDrive`1|[[Type:FloatQ|FloatQ]]}}|TypeAdv22=true|
+|_laserRotationType|'''[[#LaserRotationType|InteractionHandler.LaserRotationType]]'''|TypeAdv23=true|
 |_holderAxisOffset|Float|
 |_holderRotationOffset|FloatQ|
-|_holderRotationReference|'''[[Type:Nullable`1|Nullable`1]]&lt;[[Type:FloatQ|FloatQ]]&gt;'''|TypeAdv25=true|
+|_holderRotationReference|'''[[Type:Nullable`1|Nullable`1]]&lt;[[Type:FloatQ|FloatQ]]&gt;'''|TypeAdv26=true|
 |_originalTwistOffset|Float|
-|_userspaceToggleIndicator|'''[[Component:RingMesh|RingMesh]]'''|TypeAdv27=true|
+|_userspaceToggleIndicator|'''[[Component:RingMesh|RingMesh]]'''|TypeAdv28=true|
-|_settingSyncs|{{RootFieldType|SyncRefList`1|[[Type:SettingSync|SettingSync]]}}|TypeAdv28=true|
 |ToolHolder|Slot|
 |ShowInteractionHints|Bool|
@@ Line 45: / Line 45: @@
 |_grabIgnoreRoot|Slot|
 |_grabber|'''[[Component:Grabber|Grabber]]'''|TypeAdv33=true|
-|_currentGrabType|'''[[#GrabType|GrabType]]'''|TypeAdv34=true|
+|_currentGrabType|'''[[#GrabType|InteractionHandler.GrabType]]'''|TypeAdv34=true|
 |ActiveToolLink|{{RootFieldType|LinkTargetRef`1|[[Type:ITool|ITool]]}}|TypeAdv35=true|
 |_activeToolGripPoseReference|'''[[Component:GripPoseReference|GripPoseReference]]'''|TypeAdv36=true|
@@ Line 52: / Line 52: @@
 |_itemShelfSlot|Slot|
 |_itemShelf|'''[[Component:ItemShelf|ItemShelf]]'''|TypeAdv40=true|
+}}
+== Sync Delegates ==
+{{Table ComponentTriggers
+|Dequip[[Type:ButtonEventHandler|ButtonEventHandler]]|[[Type:ButtonEventHandler|ButtonEventHandler]]|true|
+|EquipGrabbed[[Type:ButtonEventHandler|ButtonEventHandler]]|[[Type:ButtonEventHandler|ButtonEventHandler]]|true|
+|OpenLocomotionMenu[[Type:ButtonEventHandler|ButtonEventHandler]]|[[Type:ButtonEventHandler|ButtonEventHandler]]|true|
+|OpenGrabbingMenu[[Type:ButtonEventHandler|ButtonEventHandler]]|[[Type:ButtonEventHandler|ButtonEventHandler]]|true|
+|OpenHandGrabMenu[[Type:ButtonEventHandler|ButtonEventHandler]]|[[Type:ButtonEventHandler|ButtonEventHandler]]|true|
+|SetLocomotion[[Type:ButtonEventHandler`1|ButtonEventHandler`1]]&lt;[[Type:ILocomotionModule|ILocomotionModule]]&gt;|[[Type:ButtonEventHandler`1|ButtonEventHandler`1]]&lt;[[Type:ILocomotionModule|ILocomotionModule]]&gt;|true|
+|SetGrabType[[Type:ButtonEventHandler`1|ButtonEventHandler`1]]&lt;[[Component:InteractionHandler#HandGrabType|InteractionHandler.HandGrabType]]&gt;|[[Type:ButtonEventHandler`1|ButtonEventHandler`1]]&lt;[[Component:InteractionHandler#HandGrabType|InteractionHandler.HandGrabType]]&gt;|true|
+|DestroyGrabbed[[Type:ButtonEventHandler|ButtonEventHandler]]|[[Type:ButtonEventHandler|ButtonEventHandler]]|true|
+|DuplicateGrabbed[[Type:ButtonEventHandler|ButtonEventHandler]]|[[Type:ButtonEventHandler|ButtonEventHandler]]|true|
+|SaveGrabbed[[Type:ButtonEventHandler|ButtonEventHandler]]|[[Type:ButtonEventHandler|ButtonEventHandler]]|true|
+|Undo[[Type:ButtonEventHandler|ButtonEventHandler]]|[[Type:ButtonEventHandler|ButtonEventHandler]]|true|
+|Redo[[Type:ButtonEventHandler|ButtonEventHandler]]|[[Type:ButtonEventHandler|ButtonEventHandler]]|true|
+|ResetUserScale[[Type:ButtonEventHandler|ButtonEventHandler]]|[[Type:ButtonEventHandler|ButtonEventHandler]]|true|
+|OnStraighten[[Type:ButtonEventHandler|ButtonEventHandler]]|[[Type:ButtonEventHandler|ButtonEventHandler]]|true|
+|OnRotateUp[[Type:ButtonEventHandler|ButtonEventHandler]]|[[Type:ButtonEventHandler|ButtonEventHandler]]|true|
+|OnRotateRight[[Type:ButtonEventHandler|ButtonEventHandler]]|[[Type:ButtonEventHandler|ButtonEventHandler]]|true|
+|OnRotateForward[[Type:ButtonEventHandler|ButtonEventHandler]]|[[Type:ButtonEventHandler|ButtonEventHandler]]|true|
+|OnRotateUnconstrained[[Type:ButtonEventHandler|ButtonEventHandler]]|[[Type:ButtonEventHandler|ButtonEventHandler]]|true|
 }}