Component:GripPoseReference: Difference between revisions

From Resonite Wiki
→‎Behavior: link to main UI edit mode page
 
(4 intermediate revisions by 2 users not shown)
Line 17: Line 17:
== Behavior ==
== Behavior ==


To create a simple object using GripPoseReference, add the RawDataTool slot to the root of the object containing the mesh. This will automatically add the GripPoseReference slots. To edit the pose, enter UI Edit Mode with the left or right slots selected in Scene Inspector then adjust the object pose with your off hand
GripPoseReference is a component which is placed under [[Tools]] to tell them how they should be positioned when equipped.
 
To create a simple object using GripPoseReference, add the RawDataTool slot to the root of the object containing the mesh. This will automatically add the GripPoseReference slots. To edit the pose, enter [[UI Edit Mode|UI Edit Mode]] with the Left or Right GripPoseReference slot selected in Scene Inspector then adjust the object pose in one hand's grip with your off hand.
 
When the TipReference field is set, equipping the tool will align your tip reference (usually at the tip of your index finger) to the provided slot and ignore the transform of the grip pose. It is recommended to use this for custom tools which are supposed to have similar positioning to most of the default tools such as the [[Dev Tool]].


== Examples ==
== Examples ==

Latest revision as of 05:55, 5 September 2024

Component image 
Grip Pose Reference component as seen in the Scene Inspector


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


Usage

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.
HandSide Chirality
_rootPos Float3
TipReference Slot
ShowVisual Bool
DisableSlider Bool
_activeVisual direct CleanupRef`1<Slot>

Behavior

GripPoseReference is a component which is placed under Tools to tell them how they should be positioned when equipped.

To create a simple object using GripPoseReference, add the RawDataTool slot to the root of the object containing the mesh. This will automatically add the GripPoseReference slots. To edit the pose, enter UI Edit Mode with the Left or Right GripPoseReference slot selected in Scene Inspector then adjust the object pose in one hand's grip with your off hand.

When the TipReference field is set, equipping the tool will align your tip reference (usually at the tip of your index finger) to the provided slot and ignore the transform of the grip pose. It is recommended to use this for custom tools which are supposed to have similar positioning to most of the default tools such as the Dev Tool.

Examples

See Also