Component:DynamicVisemeDriver: 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=Dynamic Viseme Driver
|Name=Dynamic Viseme Driver
}}
}}
{{stub}}
The '''DynamicVisemeDriver''' component allows using a viseme analyser to drive Float values. It allows for combinations of visemes with weights to drive a Float, and said Float may be a shapekey.


== Usage ==
== Fields ==
{{Table ComponentFields
{{Table ComponentFields
|Source|'''[[Component:VisemeAnalyzer|VisemeAnalyzer]]'''|TypeAdv0=true|
|Source|'''[[Component:VisemeAnalyzer|VisemeAnalyzer]]'''|TypeAdv0=true| The analyzer making viseme data.
|MouthTrackingSource|IMouthTrackingSourceComponent|
|MouthTrackingSource|IMouthTrackingSourceComponent| The source of mouth tracking to influence viseme data.
|VoiceMouthSupressWeight|Float|
|VoiceMouthSupressWeight|Float| How much audio supresses the effect of the <code>MouthTrackingSource</code> data.
|Drivers|{{RootFieldType|SyncList`1|[[#TargetDriver|TargetDriver]]}}|TypeAdv3=true|
|Drivers|{{RootFieldType|SyncList`1|[[#TargetDriver|DynamicVisemeDriver.TargetDriver]]}}|TypeAdv3=true| A list of drivers that use the <code>Source</code> and <code>MouthTrackingSource</code> data to drive their targets.
}}
 
== Target Driver ==
{{Table TypeFields
|Target|{{RootFieldType|FieldDrive`1|[[Type:Float|Float]]}}|TypeAdv0=true| The float value to drive. May be a shapekey.
|Sources|{{RootFieldType|SyncList`1|[[#VisemeSource|VisemeSource]]}}|TypeAdv1=true| A list of sources to use to drive <code>Target</code>
}}
 
== VisemeSource ==
{{Table TypeFields
|Viseme|Viseme| The viseme to get Float data from.
|Influence|Float| How much <code>Viseme</code> should affect <code>Target</code>. All instances of this value do not have to add up to 1. The final set of values are normalized with the rest.
}}
}}


== Behavior ==
== Usage ==
{{stub}}


== Examples ==
== Examples ==
Line 22: Line 35:
[[Category:Components{{#translation:}}|Dynamic Viseme Driver]]
[[Category:Components{{#translation:}}|Dynamic Viseme Driver]]
[[Category:Components With Nested Types{{#translation:}}|Dynamic Viseme Driver]]
[[Category:Components With Nested Types{{#translation:}}|Dynamic Viseme Driver]]
[[Category:ComponentStubs]]

Latest revision as of 06:01, 17 March 2025

Component image 
Dynamic Viseme Driver component as seen in the Scene Inspector

The DynamicVisemeDriver component allows using a viseme analyser to drive Float values. It allows for combinations of visemes with weights to drive a Float, and said Float may be a shapekey.

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 VisemeAnalyzer The analyzer making viseme data.
MouthTrackingSource IMouthTrackingSourceComponent The source of mouth tracking to influence viseme data.
VoiceMouthSupressWeight Float How much audio supresses the effect of the MouthTrackingSource data.
Drivers list of DynamicVisemeDriver.TargetDriver A list of drivers that use the Source and MouthTrackingSource data to drive their targets.

Target Driver

Fields
Name Type Description
Target field drive of Float The float value to drive. May be a shapekey.
Sources list of VisemeSource A list of sources to use to drive Target

VisemeSource

Fields
Name Type Description
Viseme Viseme The viseme to get Float data from.
Influence Float How much Viseme should affect Target. All instances of this value do not have to add up to 1. The final set of values are normalized with the rest.

Usage

This article or section is a Stub. You can help the Resonite Wiki by expanding it.

Examples

See Also