Component:FingerReferencePoseSource

CollapseComponent 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 Collapse

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 Collapse

Method Name	Method type and Arguments.	Is the method hidden?	Description
AssignFromBipedRig:ButtonEventHandler	ButtonEventHandler	✓	Finds a biped rig Component above this component and uses the found Finger bones to fill Bones.
CaptureReference:ButtonEventHandler`1<ReferenceField`1<IFingerPoseSourceComponent>>	ButtonEventHandler`1<ReferenceField`1<IFingerPoseSourceComponent>>	✓	Captures the data from the specified IFingerPoseSource and sets this component's data with it.
CaptureMyLeftHand:ButtonEventHandler	ButtonEventHandler	✓	Captures the data from the Left hand of the user that pressed the button and sets this component's data with it.
CaptureMyRightHand:ButtonEventHandler	ButtonEventHandler	✓	Captures the data from the right hand of the user that pressed the button and sets this component's data with it.
GenerateDebugVisual:ButtonEventHandler	ButtonEventHandler	✓	Generates a Debug visual and Assigns its bones to any item in Bones that are missing slots and adds any finger segments that are missing entries in Bones
ClearDebugVisual:ButtonEventHandler	ButtonEventHandler	✓	Clears the debug visuals of the hand. (WARNING: visuals may be Referenced by Bones
GenerateStaticFingerPoseCode:ButtonEventHandler	ButtonEventHandler	✓	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.

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

• Finger Posing System