Component:InteractionHandler

Component image 

File:InteractionHandlerComponent.png

Interaction Handler component as seen in the Scene Inspector

The Interaction Handler component is used to control and handle the user interactions like grabbing, tooltips, and all general controls for the user regarding their hands.

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>	The locomotion controller the user is using
GrabSmoothing	Float	How much to smooth grabbing interactions
_streamDriver	InteractionHandlerStreamDriver	The stream providing info from the user regarding interaction using hands.
_undoItem	ContextMenuItem	The context menu item used to undo actions for this user.
_redoItem	ContextMenuItem	The context menu item used to redo actions for this user.
ContextMenu	ContextMenu	The context menu for the user.
EquippingEnabled	Bool	Whether the user can equip stuff.
MenuEnabled	Bool	Whether the user can use their menu.
UserScalingEnabled	Bool	Whether the user can scale themselves.
VisualEnabled	Bool	Whether the user's visual is enabled.
PointingGrab	Bool	Whether the user is grabbing with this hand via the pointer. (remote grabbing)
PointingTouch	Bool	Whether the user is physical grabbing with this hand.
_toolRoot	Slot	The root of the tool equipped to this hand currently.
_laserSlot	Slot	The laser object slot of this hand.
_laserPosition	field drive of Float3	The laser position of this hand.
_laserRotation	field drive of FloatQ	The laser rotation of this hand.
_interactionLaser	InteractionLaser	The interaction laser component of this hand.
_laserEnabled	Bool	Whether the user's laser is enabled for this hand.
_handGrabType	InteractionHandler.HandGrabType	The hand grab type being used for this hand.
_grabToggle	Bool	Whether the user's grabbing is enabled for this hand.
_holderPos	field drive of Float3	The holder position field for this hand.
_holderRot	field drive of FloatQ	The holder rotation field for this hand.
_laserRotationType	InteractionHandler.LaserRotationType	The rotation type for this hand's laser.
_holderAxisOffset	Float	The holder axis offset for this hand.
_holderRotationOffset	FloatQ	The holder rotation offset for this hand. used for laser rotation.
_holderRotationReference	Nullable`1<FloatQ>	the reference value for the holder rotation for this hand. used for laser rotation.
_originalTwistOffset	Float	the original twist value for this holder. used for laser rotation.
_userspaceToggleIndicator	RingMesh	The
ToolHolder	Slot	The slot that holds tooltips for this hand.
ShowInteractionHints	Bool	Whether to show tooltip interaction hints for this hand for the user.
_grabberSphereActive	field drive of Bool	The field to drive with whether the grab sphere visual should be visible.
_grabIgnoreRoot	Slot	The slot which to ignore grabbable objects for this hand.
_grabber	Grabber	The grabber component for this hand to handle grabbing objects.
_currentGrabType	InteractionHandler.GrabType	The current grab type selected for this hand.
ActiveToolLink	direct LinkTargetRef`1<ITool>	The link that references to the active tool for this hand. Points to the _equipLink on the equipped tool for this hand.
_activeToolGripPoseReference	GripPoseReference	The grip pose reference to use for positioning the active tool for the user in this hand.
_toolLocked	Bool	Whether the tool is equipped and locked into place.
_grabMaterial	FresnelMaterial	The material used for the grab sphere visual for this hand.
_itemShelfSlot	Slot	The slot for the current item shelf on the user.
_itemShelf	ItemShelf	The component for the current item shelf on the user.

Sync Delegates

Triggers

Method Name	Method type and Arguments.	Is the method hidden?	Description
Dequip:ButtonEventHandler	ButtonEventHandler	✓	The button handler for dequipping a tool on this hand.
EquipGrabbed:ButtonEventHandler	ButtonEventHandler	✓	The handler for equipping a grabbed tool on this hand.
OpenLocomotionMenu:ButtonEventHandler	ButtonEventHandler	✓	The handler for opening the locomotion on this hand via the menu.
OpenGrabbingMenu:ButtonEventHandler	ButtonEventHandler	✓	The handler for opening the grabbing options on this hand via the menu.
OpenHandGrabMenu:ButtonEventHandler	ButtonEventHandler	✓	The handler for opening the hand grabbing options on this hand via the menu.
SetLocomotion:ButtonEventHandler`1<ILocomotionModule>	ButtonEventHandler`1<ILocomotionModule>	✓	The handler for setting the active locomotion on this hand via the menu.
SetGrabType:ButtonEventHandler`1<InteractionHandler.HandGrabType>	ButtonEventHandler`1<InteractionHandler.HandGrabType>	✓	The handler for setting the hand grab type on this hand via the menu.
DestroyGrabbed:ButtonEventHandler	ButtonEventHandler	✓	The handler for destroying the grabbed objects on this hand via the menu.
DuplicateGrabbed:ButtonEventHandler	ButtonEventHandler	✓	The handler for duplicating the grabbed objects on this hand via the menu.
SaveGrabbed:ButtonEventHandler	ButtonEventHandler	✓	The handler for saving the grabbed objects on this hand via the menu.
Undo:ButtonEventHandler	ButtonEventHandler	✓	The handler for redoing an action via the menu on this hand.
Redo:ButtonEventHandler	ButtonEventHandler	✓	The handler for undoing an action via the menu on this hand.
ResetUserScale:ButtonEventHandler	ButtonEventHandler	✓	The handler for resetting the user's scale via the menu on this hand.
OnStraighten:ButtonEventHandler	ButtonEventHandler	✓	The handler for straightening the grabbed object to the closest vertical axis on this hand.
OnRotateUp:ButtonEventHandler	ButtonEventHandler	✓	The handler for rotating the grabbed object to the up direction on this hand,
OnRotateRight:ButtonEventHandler	ButtonEventHandler	✓	The handler for rotating the grabbed object to the right direction on this hand,
OnRotateForward:ButtonEventHandler	ButtonEventHandler	✓	The handler for rotating the grabbed object to the forward direction on this hand,
OnRotateUnconstrained:ButtonEventHandler	ButtonEventHandler	✓	The handler for rotating the grabbed object on this hand,

HandGrabType

used when InteractionHandler.GrabType is set to "Hand"

Values

Name	Value	Description
Palm	0	Grab via grab sphere influence.
Precision	1	Grab via whatever grabbable intercects the center point of the grab sphere.
Auto	2	Automatically decide whether to use "Palm" or "Precision".
Off	3	Hand grabbing is disabled.

LaserRotationType

Values

Name	Value	Description
AxisX	0	Rotate the grabbed item along the X axis.
AxisY	1	Rotate the grabbed item along the Y axis.
AxisZ	2	Rotate the grabbed item along the Z axis.
Unconstrained	3	Rotate the grabbed item along any axis. even all 3 at once.

GrabType

Values

Name	Value	Description
None	0	No grabbing allowed.
Hand	1	Grab via hand only.
Laser	2	Grab via laser only.
Touch	3	Grab via touch only.

Usage

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

Examples

Found on the right and left controller objects which are slots under the user's root slot.