Component:FingerPoseModifier: Difference between revisions

From Resonite Wiki
fix formatting
add info
Line 3: Line 3:
|Name=Finger Pose Modifier
|Name=Finger Pose Modifier
}}
}}
{{stub}}
The '''FingerPoseModifier''' component takes a <code>Source</code> and makes a copy of the finger pose data from it. It then modifies the copied data before making it the finger pose data of this component. This component in itself is a [[Type:IFingerPoseSourceComponent|IFingerPoseSourceComponent]].
 
For more information on finger pose sources, please see [[Finger Posing System]].


== Fields ==
== Fields ==
{{Table ComponentFields
{{Table ComponentFields
|Source|IFingerPoseSourceComponent|
|Source|IFingerPoseSourceComponent| The component to take finger pose data from and make a copy to modify and make this component's finger pose data.
|LeftOffsets|{{RootFieldType|(nested)|[[#FingerOffsets|FingerOffsets]]}}|TypeAdv1=true|
|LeftOffsets|{{RootFieldType|(nested)|[[#FingerOffsets|FingerOffsets]]}}|TypeAdv1=true| How to modify the left finger pose data before making it this component's finger pose data.
|RightOffsets|{{RootFieldType|(nested)|[[#FingerOffsets|FingerOffsets]]}}|TypeAdv2=true|
|RightOffsets|{{RootFieldType|(nested)|[[#FingerOffsets|FingerOffsets]]}}|TypeAdv2=true| How to modify the right finger pose data before making it this component's finger pose data.
}}
}}


== FingerOffsets ==
== FingerOffsets ==
{{Table TypeFields
{{Table TypeFields
|ThumbCurlOffset|Float| How much curl to add to the thumb.
|IndexCurlOffset|Float| How much curl to add to the index finger.
|MiddleCurlOffset|Float| How much curl to add to the middle finger.
|RingCurlOffset|Float| How much curl to add to the ring finger.
|PinkyCurlOffset|Float| How much curl to add to the pinky finger.
|ThumbSplayOffset|Float| How much splaying to add to the thumb.
|IndexSplayOffset|Float| How much splaying to add to the index finger.
|MiddleSplayOffset|Float| How much splaying to add to the middle finger.
|RingSplayOffset|Float| How much splaying to add to the ring finger.
|PinkySplayOffset|Float| How much splaying to add to the pinky finger.
}}  
}}  


== Usage ==
== Usage ==
Provide the component with data from another [[Type:IFingerPoseSourceComponent|IFingerPoseSourceComponent]] to add extra offsets onto. This component can be used as a [[Type:IFingerPoseSourceComponent|IFingerPoseSourceComponent]] for other components.


== Examples ==
== Examples ==
[https://youtu.be/PG4qnZluan4 Frooxius devlog video on this component]


== See Also ==
== See Also ==
* [[Finger Posing System]]


[[Category:Components:Users:Common Avatar System:Fingers{{#translation:}}|Finger Pose Modifier]]
[[Category:Components:Users:Common Avatar System:Fingers{{#translation:}}|Finger Pose Modifier]]
[[Category:Components{{#translation:}}|Finger Pose Modifier]]
[[Category:Components{{#translation:}}|Finger Pose Modifier]]
[[Category:Components With Nested Types{{#translation:}}|Finger Pose Modifier]]
[[Category:Components With Nested Types{{#translation:}}|Finger Pose Modifier]]
[[Category:ComponentStubs]]

Revision as of 03:28, 19 January 2025

Component image 
File:FingerPoseModifierComponent.png
Finger Pose Modifier component as seen in the Scene Inspector

The FingerPoseModifier component takes a Source and makes a copy of the finger pose data from it. It then modifies the copied data before making it the finger pose data of this component. 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.
Source IFingerPoseSourceComponent The component to take finger pose data from and make a copy to modify and make this component's finger pose data.
LeftOffsets direct FingerOffsets How to modify the left finger pose data before making it this component's finger pose data.
RightOffsets direct FingerOffsets How to modify the right finger pose data before making it this component's finger pose data.

FingerOffsets

Fields
Name Type Description
ThumbCurlOffset Float How much curl to add to the thumb.
IndexCurlOffset Float How much curl to add to the index finger.
MiddleCurlOffset Float How much curl to add to the middle finger.
RingCurlOffset Float How much curl to add to the ring finger.
PinkyCurlOffset Float How much curl to add to the pinky finger.
ThumbSplayOffset Float How much splaying to add to the thumb.
IndexSplayOffset Float How much splaying to add to the index finger.
MiddleSplayOffset Float How much splaying to add to the middle finger.
RingSplayOffset Float How much splaying to add to the ring finger.
PinkySplayOffset Float How much splaying to add to the pinky finger.

Usage

Provide the component with data from another IFingerPoseSourceComponent to add extra offsets onto. This component can be used as a IFingerPoseSourceComponent for other components.

Examples

Frooxius devlog video on this component

See Also