add info |
|||
| (5 intermediate revisions by 2 users not shown) | |||
| Line 3: | Line 3: | ||
|Name=Grip Pose Reference | |Name=Grip Pose Reference | ||
}} | }} | ||
The '''GripPoseReference''' component is placed under [[Tools]] to tell them how they should be positioned when equipped. | |||
== | == Fields == | ||
{{Table ComponentFields | {{Table ComponentFields | ||
|HandSide|Chirality| | |HandSide|Chirality| The hand side this grip pose should | ||
|_rootPos|Float3| | |_rootPos|Float3| The root position of the tooltip. | ||
|TipReference|Slot| | |TipReference|Slot| the slot for the tool tips tip in question. | ||
|ShowVisual|Bool| | |ShowVisual|Bool| Whether to show the adjustment visual. | ||
|DisableSlider|Bool| | |DisableSlider|Bool| Whether to disable adjusting this grip pose. | ||
|_activeVisual|{{RootFieldType|CleanupRef`1|[[Type:Slot|Slot]]}}|TypeAdv5=true| | |_activeVisual|{{RootFieldType|CleanupRef`1|[[Type:Slot|Slot]]}}|TypeAdv5=true| The current adjustment visual. | ||
}} | }} | ||
== | == Usage == | ||
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. | |||
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 | |||
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]]. | |||
== See Also == | == See Also == | ||
* [[Tools]] | |||
[[Category:Components:Interaction{{#translation:}}|Grip Pose Reference]] | [[Category:Components:Interaction{{#translation:}}|Grip Pose Reference]] | ||
[[Category:Components{{#translation:}}|Grip Pose Reference]] | [[Category:Components{{#translation:}}|Grip Pose Reference]] | ||
Latest revision as of 18:50, 20 January 2025
The GripPoseReference component is placed under Tools to tell them how they should be positioned when equipped.
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. |
HandSide
|
Chirality | The hand side this grip pose should |
_rootPos
|
Float3 | The root position of the tooltip. |
TipReference
|
Slot | the slot for the tool tips tip in question. |
ShowVisual
|
Bool | Whether to show the adjustment visual. |
DisableSlider
|
Bool | Whether to disable adjusting this grip pose. |
_activeVisual
|
direct CleanupRef`1<Slot> | The current adjustment visual. |
Usage
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.