Component:AvatarExpressionDriver: Difference between revisions

From Resonite Wiki
Update AvatarExpressionDriver to include missing fields
→‎Usage: update bad info I wrote
 
(4 intermediate revisions by 3 users not shown)
Line 2: Line 2:
<translate>
<translate>
<!--T:1-->
<!--T:1-->
{{stub}}
{{Infobox Component
{{Infobox Component
|Image=AvatarExpressionDriverComponent.png
|Image=AvatarExpressionDriverComponent.png
Line 8: Line 7:
}}
}}


<!--T:2-->
Allows the assignment of the IMouthTrackingSourceComponent to blendshapes.
== Intoduction ==
Allows the asignment of the IMouthTrackingSourceComponent to blendshapes.
Following Drivers can be assigned by adding these to the ExpressionDrivers(list) and assigning these to target Blend shapes
 
- Smile
 
- SmileLeft
 
- SmileRight
 
 
- SmirkLeft
 
- SmirkRight
 
 
- Frown
 
- FrownLeft
 
- FrownRight
 
 
- TongueOut
 
- TongueLeft
 
- TongueRight
 
- TongueDown
 
- TongueUp
 
- TongueRoll
 
 
- Grin
 
- GrinLeft
 
- GrinRight
 
 
- Angry
 
 
- CheekPuffLeft
 
- CheekPuffRight
 
- CheekPuff
 
- CheekSuckLeft
 
- CheekSuckRight
 
- CheekSuck




- LipRaiseUpperLeft
- LipRaiseUpperRight
- LipRaiseLowerLeft
- LipRaiseLowerRight
- LipRaiseUpper
- LipRaiseLower
- LipMoveLeftUpper
- LipMoveRightUpper
- LipMoveLeftLower
- LipMoveRightLower
- LipTopOverturn
- LipBottomOverturn
- LipOverlayUpper
- LipUnderlayUpper
- LipOverlayLower
- LipUnderlayLower
- JawLeft
- JawRight
- JawForward
- JawDown
- JawOpen
- Pout
<!--T:3-->
<!--T:3-->
== Usage ==
== Usage ==
{{Table ComponentFields
{{Table ComponentFields
|DataSource|IMouthTrackingSourceComponent|  
|DataSource|IMouthTrackingSourceComponent| The component that is providing raw mouth tracking data from a physical or virtual device on a machine.
|StrengthMultiplier|Float|Determines strength of expressions
|StrengthMultiplier|Float|Determines strength of expressions
|VolumeSource|IField`1|  
|VolumeSource|'''[[Type:IField`1|IField`1]]&lt;[[Type:Float|Float]]&gt;'''|TypeAdv2=true| A volume source like a [[Component:VolumeMeter|Volume Meter]] that is used to determine facial tracking better.
|SilenceSource|IField`1|  
|SilenceSource|'''[[Type:IField`1|IField`1]]&lt;[[Type:Float|Float]]&gt;'''|TypeAdv3=true| A silence source like the target value of the <code>Silence</code> field on a [[Component:DirectVisemeDriver|Direct Viseme Driver]]
|ExpressionDrivers|List|  
|ExpressionDrivers|{{RootFieldType|SyncList`1|[[#ExpressionDriver|ExpressionDriver]]}}|TypeAdv4=true| A list of Expression Drivers that take facial data and drive a float or blendshape with the data.
|Target|FieldDrive`1|  
}}
|Expression|AvatarExpression|  
 
|Min|Float|  
== ExpressionDriver ==
|Max|Float|  
{{stub}}
|VolumeSupressionStrength|Float|  
 
== Expression ==
The different expressions an [[#ExpressionDriver|ExpressionDriver]] can have when driving any float value (or blendshapes)
 
{{Table EnumValues
|Smile||
|SmileLeft||
|SmileRight||
|SmirkLeft||
|SmirkRight||
|Frown||
|FrownLeft||
|FrownRight||
|TongueOut||
|TongueRaise||
|TongueExtend||
|TongueLeft||
|TongueRight||
|TongueDown||
|TongueUp||
|TongueRoll||
|TongueHorizontal||
|TongueVertical||
|TongueUpLeft||
|TongueUpRight||
|TongueDownLeft||
|TongueDownRight||
|SmileClosed||
|SmileClosedLeft||
|SmileClosedRight||
|Grin||
|GrinLeft||
|GrinRight||
|Angry||
|CheekPuffLeft||
|CheekPuffRight||
|CheekPuff||
|CheekSuckLeft||
|CheekSuckRight||
|CheekSuck||
|LipRaiseUpperLeft||
|LipRaiseUpperRight||
|LipRaiseLowerLeft||
|LipRaiseLowerRight||
|LipRaiseUpper||
|LipRaiseLower||
|LipMoveLeftUpper||
|LipMoveRightUpper||
|LipMoveLeftLower||
|LipMoveRightLower||
|LipMoveHorizontalUpper||
|LipMoveHorizontalLower||
|LipTopOverturn||
|LipBottomOverturn||
|LipOverlayUpper||
|LipUnderlayUpper||
|LipOverlayLower||
|LipUnderlayLower||
|JawLeft||
|JawRight||
|JawHorizontal||
|JawForward||
|JawDown||
|JawOpen||
|Pout||
}}
}}


Line 141: Line 98:
== Related Components ==
== Related Components ==
</translate>
</translate>
[[Category:Components{{#translation:}}|AvatarExpressionDriver (Component){{#translation:}}]]
[[Category:Components{{#translation:}}|Avatar Expression Driver]]
[[Category:ComponentStubs]]
[[Category:ComponentStubs]]
[[Category:Components:Users:Common Avatar System:Face{{#translation:}}|AvatarExpressionDriver (Component){{#translation:}}]]
[[Category:Components With Nested Types{{#translation:}}|Avatar Expression Driver]]
[[Category:Components:Users:Common Avatar System:Face{{#translation:}}|Avatar Expression Driver]]

Latest revision as of 16:35, 15 October 2024

Component image 
AvatarExpressionDriver component as seen in the Scene Inspector


Allows the assignment of the IMouthTrackingSourceComponent to blendshapes.


Usage

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.
DataSource IMouthTrackingSourceComponent The component that is providing raw mouth tracking data from a physical or virtual device on a machine.
StrengthMultiplier Float Determines strength of expressions
VolumeSource IField`1<Float> A volume source like a Volume Meter that is used to determine facial tracking better.
SilenceSource IField`1<Float> A silence source like the target value of the Silence field on a Direct Viseme Driver
ExpressionDrivers list of ExpressionDriver A list of Expression Drivers that take facial data and drive a float or blendshape with the data.

ExpressionDriver

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


Expression

The different expressions an ExpressionDriver can have when driving any float value (or blendshapes)

Values
Name Value Description
Smile
SmileLeft
SmileRight
SmirkLeft
SmirkRight
Frown
FrownLeft
FrownRight
TongueOut
TongueRaise
TongueExtend
TongueLeft
TongueRight
TongueDown
TongueUp
TongueRoll
TongueHorizontal
TongueVertical
TongueUpLeft
TongueUpRight
TongueDownLeft
TongueDownRight
SmileClosed
SmileClosedLeft
SmileClosedRight
Grin
GrinLeft
GrinRight
Angry
CheekPuffLeft
CheekPuffRight
CheekPuff
CheekSuckLeft
CheekSuckRight
CheekSuck
LipRaiseUpperLeft
LipRaiseUpperRight
LipRaiseLowerLeft
LipRaiseLowerRight
LipRaiseUpper
LipRaiseLower
LipMoveLeftUpper
LipMoveRightUpper
LipMoveLeftLower
LipMoveRightLower
LipMoveHorizontalUpper
LipMoveHorizontalLower
LipTopOverturn
LipBottomOverturn
LipOverlayUpper
LipUnderlayUpper
LipOverlayLower
LipUnderlayLower
JawLeft
JawRight
JawHorizontal
JawForward
JawDown
JawOpen
Pout


Behavior

Examples

Related Components