Component:FingerReferencePoseSource

From Resonite Wiki
Revision as of 23:24, 18 January 2025 by 989onan (talk | contribs) (add info)
Component image 
File:FingerReferencePoseSourceComponent.png
Finger Reference Pose Source component as seen in the Scene Inspector

The FingerReferencePoseSource component is used to read and generate Pose data from the user or its already created bone hiearchy Template. The Slots used in the Bones list need to not be null. Every time the Pose data is read from this component as a Finger Pose Source, the current positions and rotations of the slots in Bones are used. This component in itself is a IFingerPoseSourceComponent.

For more information on finger pose sources, please see Finger Posing System.


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.
Bones direct SyncRefDictionary`2<BodyNode, Slot> A list of bones mapped to Fingers to use as the Finger pose source data for this component. The Fingers need to be in the default hand structure.

Sync Delegates

Triggers
Method Name Method type and Arguments. Is the method hidden? Description
AssignFromBipedRig() Delegate<IButton: button, ButtonEventData: data> X CaptureReference()
Delegate<IButton: button, ButtonEventData: eventData, IFingerPoseSource field> Captures the data from the specified IFingerPoseSource and sets this component's data with it.

X Delegate<IButton: button, ButtonEventData: data>
Captures the data from the Left hand of the user that pressed the button and sets this component's data with it.

CaptureMyRightHand() X Captures the data from the right hand of the user that pressed the button and sets this component's data with it.
GenerateDebugVisual() Delegate<IButton: button, ButtonEventData: eventData> X ClearDebugVisual()
Delegate<IButton: button, ButtonEventData: eventData> Clears the debug visuals of the hand. (WARNING: visuals may be Referenced by Bones

X Delegate<IButton: button, ButtonEventData: eventData>
Generates C# code for making a static Pose. Possibly was added by Frooxius as a way to make code for the poses like fist and point in the defaults quickly.

' X

Usage

Attach to a slot and use either the generate visuals button or assign from biped rig to make a reference armature. Then, it can either be set from the current hand pose of the user (useful for Index Controller users) or can be adjusted manually. The component can then be used as a IFingerPoseSourceComponent.

Examples

Finger pose reference Frooxius video

See Also