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
<!--T:3-->
== Fields ==
{{Table ComponentFields
|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|'''[[Type:IField`1|IField`1]]<[[Type:Float|Float]]>'''|TypeAdv2=true| A volume source like a [[Component:VolumeMeter|Volume Meter]] that is used to determine facial tracking better.
|SilenceSource|'''[[Type:IField`1|IField`1]]<[[Type:Float|Float]]>'''|TypeAdv3=true| A silence source like the target value of the <code>Silence</code> field on a [[Component:DirectVisemeDriver|Direct Viseme Driver]]
|ExpressionDrivers|{{RootFieldType|SyncList`1|[[#ExpressionDriver|AvatarExpressionDriver.ExpressionDriver]]}}|TypeAdv4=true| A list of Expression Drivers that take facial data and drive a float or blendshape with the data.
}}
- SmileRight
== Sync Delegates ==
{{Table ComponentTriggers
|AutoAssign:[[Type:ButtonEventHandler|ButtonEventHandler]]|[[Type:ButtonEventHandler|ButtonEventHandler]]|true| Assign blendshapes to this component's drivers and create new drivers based on heuristics.
}}
== ExpressionDriver ==
{{Table TypeFields
|Target|{{RootFieldType|FieldDrive`1|[[Type:Float|Float]]}}|TypeAdv0=true| The blendshape or float to drive with this type of expression
|Expression|AvatarExpression| The expression to take from the parent AvatarExpressionDriver and drive <code>Target</code> with it.
|EstimateIfNotTracked|bool| Whether to take a guess to this expression's value if it is not tracked
|Min|float| The minimum value to drive <code>Target</code> to.
|Max|float| The maximum value to drive <code>Target</code> to.
|VolumeSupressionStrength|float| The amount to reduce the effect on <code>Target</code> when the user is speaking.
}}
- SmirkLeft
== Expression ==
The different expressions an [[#ExpressionDriver|ExpressionDriver]] can have when driving any float value (or blendshapes)
- SmirkRight
- Frown
- FrownLeft
- FrownRight
- TongueOut
- TongueLeft
- TongueRight
- TongueDown
- TongueUp
This list is ever constantly expanding, and as such will be incomplete for vast periods of time. Feel free to help us fill this table.
- TongueRoll
{{Table EnumValues
|Smile|| How much the user is smiling on average with mouth open slightly
|SmileLeft|| How much the left lip corner is going up with mouth open slightly
- Grin
|SmileRight|| How much the right lip corner is going up with mouth open slightly
|SmirkLeft|| How much the left lip corner is curling, estimated if not present.
- GrinLeft
|SmirkRight|| How much the right lip corner is curling, estimated if not present.
|Frown|| How much the user is frowning on average.
- GrinRight
|FrownLeft|| How much the left lip corner is going down
|FrownRight|| How much the right lip corner is going down
|MouthDimple|| How much the mouth is squishing inward in a strained frown, estimated if not present.
- Angry
|MouthDimpleLeft|| How much the mouth is squishing inward in a strained frown left side, estimated if not present.
|MouthDimpleRight|| How much the mouth is squishing inward in a strained frown right side, estimated if not present.
|TongueOut|| How much the user is sticking their tongue out
- CheekPuffLeft
|TongueRaise|| How much the user is curling their tongue upwards and out
|TongueExtend|| How much the user is sticking their tongue out 2
- CheekPuffRight
|TongueLeft|| How much the user is putting their tongue out to the left
|TongueRight|| How much the user is putting their tongue out to the right
- CheekPuff
|TongueDown|| How much the user is putting their tongue out and downwards
|TongueUp|| How much the user is putting their tongue out to and upwards
- CheekSuckLeft
|TongueRoll|| How much the user is rolling their tongue like a taco shape.
|TongueHorizontal|| How much the tongue is flattening horizontal
- CheekSuckRight
|TongueVertical|| How much the tongue is squishing vertical
|TongueUpLeft|| How much the user is putting their tongue out to the left and up
- CheekSuck
|TongueUpRight|| How much the user is putting their tongue out to the right and up
|TongueDownLeft|| How much the user is putting their tongue out to the left and down
|TongueDownRight|| How much the user is putting their tongue out to the right and down
- LipRaiseUpperLeft
|SmileClosed|| How much the user is smiling on average, estimated
|SmileClosedLeft|| How much the left lip corner is going up, estimated if not present.
- LipRaiseUpperRight
|SmileClosedRight|| How much the right lip corner is going up, estimated if not present.
|Grin|| How much the user is lifting their upper lip while smiling, estimated if not present.
- LipRaiseLowerLeft
|GrinLeft|| How much the user is lifting their upper lip while smiling left side, estimated if not present.
|GrinRight|| How much the user is lifting their upper lip while smiling right side, estimated if not present.
- LipRaiseLowerRight
|Angry|| How much the user is lifting their lips while frowning, estimated if not present.
|CheekPuffLeft|| How much the user is puffing out their cheeks left side
- LipRaiseUpper
|CheekPuffRight|| How much the user is puffing out their cheeks right side
|CheekPuff|| How much the user is puffing out their cheeks
- LipRaiseLower
|CheekSuckLeft|| How much the user is pulling in their cheeks left side
|CheekSuckRight|| How much the user is pulling in their cheeks right side
|CheekSuck|| How much the user is pulling in their cheeks
- LipMoveLeftUpper
|CheekRaiseLeft||
|CheekRaiseRight||
- LipMoveRightUpper
|CheekRaise||
|LipRaiseUpperLeft|| How much the user is lifting their upper lip left side
- LipMoveLeftLower
|LipRaiseUpperRight|| How much the user is lifting their upper lip right side
|LipRaiseLowerLeft|| How much the user is lifting their lower lip left side
- LipMoveRightLower
|LipRaiseLowerRight|| How much the user is lifting their lower lip right side
|LipRaiseUpper|| How much the user is lifting their upper lip
|LipRaiseLower|| How much the user is lifting their lower lip
- LipTopOverturn
|LipMoveLeftUpper|| How much the user is shifting their upper lip to the left
|LipMoveRightUpper|| How much the user is shifting their upper lip to the right
- LipBottomOverturn
|LipMoveLeftLower|| How much the user is shifting their lower lip to the left
|LipMoveRightLower|| How much the user is shifting their lower lip to the right
|LipMoveHorizontalUpper|| How much the user is shifting their upper lip
- LipOverlayUpper
|LipMoveHorizontalLower|| How much the user is shifting their lower lip
|LipTopLeftOverturn||
- LipUnderlayUpper
|LipTopRightOverturn||
|LipTopOverturn||How much the user is flipping their upper lip upwards like an ape
- LipOverlayLower
|LipBottomLeftOverturn||
|LipBottomRightOverturn||
- LipUnderlayLower
|LipBottomOverturn||How much the user is flipping their lower lip downwards like an ape
|LipOverlayUpper||
|LipOverlayUpperLeft||
- JawLeft
|LipOverlayUpperRight||
|LipUnderlayUpper||How much the user is putting their upper lip under their lower lip
- JawRight
|LipUnderlayUpperLeft||
|LipUnderlayUpperRight||
- JawForward
|LipOverlayLower||
|LipOverlayLowerLeft||
- JawDown
|LipOverlayLowerRight||
|LipUnderlayLower|| How much the user is putting their lower lip under their upper lip
- JawOpen
|LipUnderlayLowerLeft||
|LipUnderlayLowerRight||
|LipStretch||
- Pout
|LipStretchLeft||
<!--T:3-->
|LipStretchRight||
|LipTighten||
== Usage ==
|LipTightenLeft||
{{Table ComponentFields
|LipTightenRight||
|DataSource|IMouthTrackingSourceComponent|
|LipsPress||
|ExpressionDrivers|ExpressionDriver|
|LipsPressLeft||
|LipsPressRight||
|JawLeft|| How much the user is shifting their lower jaw to the left
|JawRight|| How much the user is shifting their lower jaw to the right
|JawHorizontal|| How much the user is shifting their lower jaw horizontally
|JawForward|| How much the user is shifting their lower jaw forward
|JawDown|| How much the user is opening their jaw but keeping their mouth closed
|JawOpen|| How much the user is opening their jaw
|Pout|| How much the user is making a kissy face
|PoutLeft|| How much the user is making a kissy face left side
|PoutRight|| How much the user is making a kissy face right side
|NoseWrinkle||How much the user's face muscles are pushing up under the nose, estimated if not present.
|NoseWrinkleLeft||How much the user's face muscles are pushing up under the nose left side, estimated if not present.
|NoseWrinkleRight||How much the user's face muscles are pushing up under the nose right side, estimated if not present.
|ChinRaise||How much the user is pulling up their chin
|ChinRaiseBottom||How much the user is pulling up their chin bottom side
|ChinRaiseTop||How much the user is pulling up their chin top side
