Component:FingerPosePreset: Difference between revisions

From Resonite Wiki
Automated: create new component page
 
Automated: update Fields
 
(2 intermediate revisions by one other user not shown)
Line 3: Line 3:
|Name=Finger Pose Preset
|Name=Finger Pose Preset
}}
}}
{{stub}}
The '''FingerPosePreset''' component is itself a [[Type:IFingerPoseSourceComponent|IFingerPoseSourceComponent]] type component that it's finger pose data is determined by the preset selected in <code>PresetPose</code>.


== Usage ==
For more information on finger pose sources, please see [[Finger Posing System]].
 
== Fields ==
{{Table ComponentFields
{{Table ComponentFields
|PresetPose|'''[[#Preset|Preset]]'''|TypeAdv0=true|
|PresetPose|'''[[#Preset|FingerPosePreset.Preset]]'''|TypeAdv0=true| The Finger pose data this component's finger pose data should be.
}}
}}


== Behavior ==
== Preset ==
{{Table EnumValues
|Idle|0| Hand in idle position, open relaxed.
|Fist|1| hand balled into a fist.
|Point|2| hand making a pointing gesture.
}}


== Examples ==
== Usage ==
Select a [[#Preset|Preset]] for <code>PresetPose</code>. This component can now be used as a [[Type:IFingerPoseSourceComponent|IFingerPoseSourceComponent]] in other components that mix or use such data.


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


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

Latest revision as of 06:02, 17 March 2025

Component image 
File:FingerPosePresetComponent.png
Finger Pose Preset component as seen in the Scene Inspector

The FingerPosePreset component is itself a IFingerPoseSourceComponent type component that it's finger pose data is determined by the preset selected in PresetPose.

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.
PresetPose FingerPosePreset.Preset The Finger pose data this component's finger pose data should be.

Preset

Values
Name Value Description
Idle 0 Hand in idle position, open relaxed.
Fist 1 hand balled into a fist.
Point 2 hand making a pointing gesture.

Usage

Select a Preset for PresetPose. This component can now be used as a IFingerPoseSourceComponent in other components that mix or use such data.

See Also