class_xrfacetracker.rst 38 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291
  1. :github_url: hide
  2. .. DO NOT EDIT THIS FILE!!!
  3. .. Generated automatically from Godot engine sources.
  4. .. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py.
  5. .. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/XRFaceTracker.xml.
  6. .. _class_XRFaceTracker:
  7. XRFaceTracker
  8. =============
  9. **Experimental:** This class may be changed or removed in future versions.
  10. **Inherits:** :ref:`XRTracker<class_XRTracker>` **<** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`
  11. A tracked face.
  12. .. rst-class:: classref-introduction-group
  13. Description
  14. -----------
  15. An instance of this object represents a tracked face and its corresponding blend shapes. The blend shapes come from the `Unified Expressions <https://docs.vrcft.io/docs/tutorial-avatars/tutorial-avatars-extras/unified-blendshapes>`__ standard, and contain extended details and visuals for each blend shape. Additionally the `Tracking Standard Comparison <https://docs.vrcft.io/docs/tutorial-avatars/tutorial-avatars-extras/compatibility/overview>`__ page documents the relationship between Unified Expressions and other standards.
  16. As face trackers are turned on they are registered with the :ref:`XRServer<class_XRServer>`.
  17. .. rst-class:: classref-introduction-group
  18. Tutorials
  19. ---------
  20. - :doc:`XR documentation index <../tutorials/xr/index>`
  21. .. rst-class:: classref-reftable-group
  22. Properties
  23. ----------
  24. .. table::
  25. :widths: auto
  26. +-----------------------------------------------------+----------------------------------------------------------------+--------------------------------------------------------------------+
  27. | :ref:`PackedFloat32Array<class_PackedFloat32Array>` | :ref:`blend_shapes<class_XRFaceTracker_property_blend_shapes>` | ``PackedFloat32Array()`` |
  28. +-----------------------------------------------------+----------------------------------------------------------------+--------------------------------------------------------------------+
  29. | :ref:`TrackerType<enum_XRServer_TrackerType>` | type | ``64`` (overrides :ref:`XRTracker<class_XRTracker_property_type>`) |
  30. +-----------------------------------------------------+----------------------------------------------------------------+--------------------------------------------------------------------+
  31. .. rst-class:: classref-reftable-group
  32. Methods
  33. -------
  34. .. table::
  35. :widths: auto
  36. +---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  37. | :ref:`float<class_float>` | :ref:`get_blend_shape<class_XRFaceTracker_method_get_blend_shape>`\ (\ blend_shape\: :ref:`BlendShapeEntry<enum_XRFaceTracker_BlendShapeEntry>`\ ) |const| |
  38. +---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  39. | |void| | :ref:`set_blend_shape<class_XRFaceTracker_method_set_blend_shape>`\ (\ blend_shape\: :ref:`BlendShapeEntry<enum_XRFaceTracker_BlendShapeEntry>`, weight\: :ref:`float<class_float>`\ ) |
  40. +---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  41. .. rst-class:: classref-section-separator
  42. ----
  43. .. rst-class:: classref-descriptions-group
  44. Enumerations
  45. ------------
  46. .. _enum_XRFaceTracker_BlendShapeEntry:
  47. .. rst-class:: classref-enumeration
  48. enum **BlendShapeEntry**: :ref:`🔗<enum_XRFaceTracker_BlendShapeEntry>`
  49. .. _class_XRFaceTracker_constant_FT_EYE_LOOK_OUT_RIGHT:
  50. .. rst-class:: classref-enumeration-constant
  51. :ref:`BlendShapeEntry<enum_XRFaceTracker_BlendShapeEntry>` **FT_EYE_LOOK_OUT_RIGHT** = ``0``
  52. Right eye looks outwards.
  53. .. _class_XRFaceTracker_constant_FT_EYE_LOOK_IN_RIGHT:
  54. .. rst-class:: classref-enumeration-constant
  55. :ref:`BlendShapeEntry<enum_XRFaceTracker_BlendShapeEntry>` **FT_EYE_LOOK_IN_RIGHT** = ``1``
  56. Right eye looks inwards.
  57. .. _class_XRFaceTracker_constant_FT_EYE_LOOK_UP_RIGHT:
  58. .. rst-class:: classref-enumeration-constant
  59. :ref:`BlendShapeEntry<enum_XRFaceTracker_BlendShapeEntry>` **FT_EYE_LOOK_UP_RIGHT** = ``2``
  60. Right eye looks upwards.
  61. .. _class_XRFaceTracker_constant_FT_EYE_LOOK_DOWN_RIGHT:
  62. .. rst-class:: classref-enumeration-constant
  63. :ref:`BlendShapeEntry<enum_XRFaceTracker_BlendShapeEntry>` **FT_EYE_LOOK_DOWN_RIGHT** = ``3``
  64. Right eye looks downwards.
  65. .. _class_XRFaceTracker_constant_FT_EYE_LOOK_OUT_LEFT:
  66. .. rst-class:: classref-enumeration-constant
  67. :ref:`BlendShapeEntry<enum_XRFaceTracker_BlendShapeEntry>` **FT_EYE_LOOK_OUT_LEFT** = ``4``
  68. Left eye looks outwards.
  69. .. _class_XRFaceTracker_constant_FT_EYE_LOOK_IN_LEFT:
  70. .. rst-class:: classref-enumeration-constant
  71. :ref:`BlendShapeEntry<enum_XRFaceTracker_BlendShapeEntry>` **FT_EYE_LOOK_IN_LEFT** = ``5``
  72. Left eye looks inwards.
  73. .. _class_XRFaceTracker_constant_FT_EYE_LOOK_UP_LEFT:
  74. .. rst-class:: classref-enumeration-constant
  75. :ref:`BlendShapeEntry<enum_XRFaceTracker_BlendShapeEntry>` **FT_EYE_LOOK_UP_LEFT** = ``6``
  76. Left eye looks upwards.
  77. .. _class_XRFaceTracker_constant_FT_EYE_LOOK_DOWN_LEFT:
  78. .. rst-class:: classref-enumeration-constant
  79. :ref:`BlendShapeEntry<enum_XRFaceTracker_BlendShapeEntry>` **FT_EYE_LOOK_DOWN_LEFT** = ``7``
  80. Left eye looks downwards.
  81. .. _class_XRFaceTracker_constant_FT_EYE_CLOSED_RIGHT:
  82. .. rst-class:: classref-enumeration-constant
  83. :ref:`BlendShapeEntry<enum_XRFaceTracker_BlendShapeEntry>` **FT_EYE_CLOSED_RIGHT** = ``8``
  84. Closes the right eyelid.
  85. .. _class_XRFaceTracker_constant_FT_EYE_CLOSED_LEFT:
  86. .. rst-class:: classref-enumeration-constant
  87. :ref:`BlendShapeEntry<enum_XRFaceTracker_BlendShapeEntry>` **FT_EYE_CLOSED_LEFT** = ``9``
  88. Closes the left eyelid.
  89. .. _class_XRFaceTracker_constant_FT_EYE_SQUINT_RIGHT:
  90. .. rst-class:: classref-enumeration-constant
  91. :ref:`BlendShapeEntry<enum_XRFaceTracker_BlendShapeEntry>` **FT_EYE_SQUINT_RIGHT** = ``10``
  92. Squeezes the right eye socket muscles.
  93. .. _class_XRFaceTracker_constant_FT_EYE_SQUINT_LEFT:
  94. .. rst-class:: classref-enumeration-constant
  95. :ref:`BlendShapeEntry<enum_XRFaceTracker_BlendShapeEntry>` **FT_EYE_SQUINT_LEFT** = ``11``
  96. Squeezes the left eye socket muscles.
  97. .. _class_XRFaceTracker_constant_FT_EYE_WIDE_RIGHT:
  98. .. rst-class:: classref-enumeration-constant
  99. :ref:`BlendShapeEntry<enum_XRFaceTracker_BlendShapeEntry>` **FT_EYE_WIDE_RIGHT** = ``12``
  100. Right eyelid widens beyond relaxed.
  101. .. _class_XRFaceTracker_constant_FT_EYE_WIDE_LEFT:
  102. .. rst-class:: classref-enumeration-constant
  103. :ref:`BlendShapeEntry<enum_XRFaceTracker_BlendShapeEntry>` **FT_EYE_WIDE_LEFT** = ``13``
  104. Left eyelid widens beyond relaxed.
  105. .. _class_XRFaceTracker_constant_FT_EYE_DILATION_RIGHT:
  106. .. rst-class:: classref-enumeration-constant
  107. :ref:`BlendShapeEntry<enum_XRFaceTracker_BlendShapeEntry>` **FT_EYE_DILATION_RIGHT** = ``14``
  108. Dilates the right eye pupil.
  109. .. _class_XRFaceTracker_constant_FT_EYE_DILATION_LEFT:
  110. .. rst-class:: classref-enumeration-constant
  111. :ref:`BlendShapeEntry<enum_XRFaceTracker_BlendShapeEntry>` **FT_EYE_DILATION_LEFT** = ``15``
  112. Dilates the left eye pupil.
  113. .. _class_XRFaceTracker_constant_FT_EYE_CONSTRICT_RIGHT:
  114. .. rst-class:: classref-enumeration-constant
  115. :ref:`BlendShapeEntry<enum_XRFaceTracker_BlendShapeEntry>` **FT_EYE_CONSTRICT_RIGHT** = ``16``
  116. Constricts the right eye pupil.
  117. .. _class_XRFaceTracker_constant_FT_EYE_CONSTRICT_LEFT:
  118. .. rst-class:: classref-enumeration-constant
  119. :ref:`BlendShapeEntry<enum_XRFaceTracker_BlendShapeEntry>` **FT_EYE_CONSTRICT_LEFT** = ``17``
  120. Constricts the left eye pupil.
  121. .. _class_XRFaceTracker_constant_FT_BROW_PINCH_RIGHT:
  122. .. rst-class:: classref-enumeration-constant
  123. :ref:`BlendShapeEntry<enum_XRFaceTracker_BlendShapeEntry>` **FT_BROW_PINCH_RIGHT** = ``18``
  124. Right eyebrow pinches in.
  125. .. _class_XRFaceTracker_constant_FT_BROW_PINCH_LEFT:
  126. .. rst-class:: classref-enumeration-constant
  127. :ref:`BlendShapeEntry<enum_XRFaceTracker_BlendShapeEntry>` **FT_BROW_PINCH_LEFT** = ``19``
  128. Left eyebrow pinches in.
  129. .. _class_XRFaceTracker_constant_FT_BROW_LOWERER_RIGHT:
  130. .. rst-class:: classref-enumeration-constant
  131. :ref:`BlendShapeEntry<enum_XRFaceTracker_BlendShapeEntry>` **FT_BROW_LOWERER_RIGHT** = ``20``
  132. Outer right eyebrow pulls down.
  133. .. _class_XRFaceTracker_constant_FT_BROW_LOWERER_LEFT:
  134. .. rst-class:: classref-enumeration-constant
  135. :ref:`BlendShapeEntry<enum_XRFaceTracker_BlendShapeEntry>` **FT_BROW_LOWERER_LEFT** = ``21``
  136. Outer left eyebrow pulls down.
  137. .. _class_XRFaceTracker_constant_FT_BROW_INNER_UP_RIGHT:
  138. .. rst-class:: classref-enumeration-constant
  139. :ref:`BlendShapeEntry<enum_XRFaceTracker_BlendShapeEntry>` **FT_BROW_INNER_UP_RIGHT** = ``22``
  140. Inner right eyebrow pulls up.
  141. .. _class_XRFaceTracker_constant_FT_BROW_INNER_UP_LEFT:
  142. .. rst-class:: classref-enumeration-constant
  143. :ref:`BlendShapeEntry<enum_XRFaceTracker_BlendShapeEntry>` **FT_BROW_INNER_UP_LEFT** = ``23``
  144. Inner left eyebrow pulls up.
  145. .. _class_XRFaceTracker_constant_FT_BROW_OUTER_UP_RIGHT:
  146. .. rst-class:: classref-enumeration-constant
  147. :ref:`BlendShapeEntry<enum_XRFaceTracker_BlendShapeEntry>` **FT_BROW_OUTER_UP_RIGHT** = ``24``
  148. Outer right eyebrow pulls up.
  149. .. _class_XRFaceTracker_constant_FT_BROW_OUTER_UP_LEFT:
  150. .. rst-class:: classref-enumeration-constant
  151. :ref:`BlendShapeEntry<enum_XRFaceTracker_BlendShapeEntry>` **FT_BROW_OUTER_UP_LEFT** = ``25``
  152. Outer left eyebrow pulls up.
  153. .. _class_XRFaceTracker_constant_FT_NOSE_SNEER_RIGHT:
  154. .. rst-class:: classref-enumeration-constant
  155. :ref:`BlendShapeEntry<enum_XRFaceTracker_BlendShapeEntry>` **FT_NOSE_SNEER_RIGHT** = ``26``
  156. Right side face sneers.
  157. .. _class_XRFaceTracker_constant_FT_NOSE_SNEER_LEFT:
  158. .. rst-class:: classref-enumeration-constant
  159. :ref:`BlendShapeEntry<enum_XRFaceTracker_BlendShapeEntry>` **FT_NOSE_SNEER_LEFT** = ``27``
  160. Left side face sneers.
  161. .. _class_XRFaceTracker_constant_FT_NASAL_DILATION_RIGHT:
  162. .. rst-class:: classref-enumeration-constant
  163. :ref:`BlendShapeEntry<enum_XRFaceTracker_BlendShapeEntry>` **FT_NASAL_DILATION_RIGHT** = ``28``
  164. Right side nose canal dilates.
  165. .. _class_XRFaceTracker_constant_FT_NASAL_DILATION_LEFT:
  166. .. rst-class:: classref-enumeration-constant
  167. :ref:`BlendShapeEntry<enum_XRFaceTracker_BlendShapeEntry>` **FT_NASAL_DILATION_LEFT** = ``29``
  168. Left side nose canal dilates.
  169. .. _class_XRFaceTracker_constant_FT_NASAL_CONSTRICT_RIGHT:
  170. .. rst-class:: classref-enumeration-constant
  171. :ref:`BlendShapeEntry<enum_XRFaceTracker_BlendShapeEntry>` **FT_NASAL_CONSTRICT_RIGHT** = ``30``
  172. Right side nose canal constricts.
  173. .. _class_XRFaceTracker_constant_FT_NASAL_CONSTRICT_LEFT:
  174. .. rst-class:: classref-enumeration-constant
  175. :ref:`BlendShapeEntry<enum_XRFaceTracker_BlendShapeEntry>` **FT_NASAL_CONSTRICT_LEFT** = ``31``
  176. Left side nose canal constricts.
  177. .. _class_XRFaceTracker_constant_FT_CHEEK_SQUINT_RIGHT:
  178. .. rst-class:: classref-enumeration-constant
  179. :ref:`BlendShapeEntry<enum_XRFaceTracker_BlendShapeEntry>` **FT_CHEEK_SQUINT_RIGHT** = ``32``
  180. Raises the right side cheek.
  181. .. _class_XRFaceTracker_constant_FT_CHEEK_SQUINT_LEFT:
  182. .. rst-class:: classref-enumeration-constant
  183. :ref:`BlendShapeEntry<enum_XRFaceTracker_BlendShapeEntry>` **FT_CHEEK_SQUINT_LEFT** = ``33``
  184. Raises the left side cheek.
  185. .. _class_XRFaceTracker_constant_FT_CHEEK_PUFF_RIGHT:
  186. .. rst-class:: classref-enumeration-constant
  187. :ref:`BlendShapeEntry<enum_XRFaceTracker_BlendShapeEntry>` **FT_CHEEK_PUFF_RIGHT** = ``34``
  188. Puffs the right side cheek.
  189. .. _class_XRFaceTracker_constant_FT_CHEEK_PUFF_LEFT:
  190. .. rst-class:: classref-enumeration-constant
  191. :ref:`BlendShapeEntry<enum_XRFaceTracker_BlendShapeEntry>` **FT_CHEEK_PUFF_LEFT** = ``35``
  192. Puffs the left side cheek.
  193. .. _class_XRFaceTracker_constant_FT_CHEEK_SUCK_RIGHT:
  194. .. rst-class:: classref-enumeration-constant
  195. :ref:`BlendShapeEntry<enum_XRFaceTracker_BlendShapeEntry>` **FT_CHEEK_SUCK_RIGHT** = ``36``
  196. Sucks in the right side cheek.
  197. .. _class_XRFaceTracker_constant_FT_CHEEK_SUCK_LEFT:
  198. .. rst-class:: classref-enumeration-constant
  199. :ref:`BlendShapeEntry<enum_XRFaceTracker_BlendShapeEntry>` **FT_CHEEK_SUCK_LEFT** = ``37``
  200. Sucks in the left side cheek.
  201. .. _class_XRFaceTracker_constant_FT_JAW_OPEN:
  202. .. rst-class:: classref-enumeration-constant
  203. :ref:`BlendShapeEntry<enum_XRFaceTracker_BlendShapeEntry>` **FT_JAW_OPEN** = ``38``
  204. Opens jawbone.
  205. .. _class_XRFaceTracker_constant_FT_MOUTH_CLOSED:
  206. .. rst-class:: classref-enumeration-constant
  207. :ref:`BlendShapeEntry<enum_XRFaceTracker_BlendShapeEntry>` **FT_MOUTH_CLOSED** = ``39``
  208. Closes the mouth.
  209. .. _class_XRFaceTracker_constant_FT_JAW_RIGHT:
  210. .. rst-class:: classref-enumeration-constant
  211. :ref:`BlendShapeEntry<enum_XRFaceTracker_BlendShapeEntry>` **FT_JAW_RIGHT** = ``40``
  212. Pushes jawbone right.
  213. .. _class_XRFaceTracker_constant_FT_JAW_LEFT:
  214. .. rst-class:: classref-enumeration-constant
  215. :ref:`BlendShapeEntry<enum_XRFaceTracker_BlendShapeEntry>` **FT_JAW_LEFT** = ``41``
  216. Pushes jawbone left.
  217. .. _class_XRFaceTracker_constant_FT_JAW_FORWARD:
  218. .. rst-class:: classref-enumeration-constant
  219. :ref:`BlendShapeEntry<enum_XRFaceTracker_BlendShapeEntry>` **FT_JAW_FORWARD** = ``42``
  220. Pushes jawbone forward.
  221. .. _class_XRFaceTracker_constant_FT_JAW_BACKWARD:
  222. .. rst-class:: classref-enumeration-constant
  223. :ref:`BlendShapeEntry<enum_XRFaceTracker_BlendShapeEntry>` **FT_JAW_BACKWARD** = ``43``
  224. Pushes jawbone backward.
  225. .. _class_XRFaceTracker_constant_FT_JAW_CLENCH:
  226. .. rst-class:: classref-enumeration-constant
  227. :ref:`BlendShapeEntry<enum_XRFaceTracker_BlendShapeEntry>` **FT_JAW_CLENCH** = ``44``
  228. Flexes jaw muscles.
  229. .. _class_XRFaceTracker_constant_FT_JAW_MANDIBLE_RAISE:
  230. .. rst-class:: classref-enumeration-constant
  231. :ref:`BlendShapeEntry<enum_XRFaceTracker_BlendShapeEntry>` **FT_JAW_MANDIBLE_RAISE** = ``45``
  232. Raises the jawbone.
  233. .. _class_XRFaceTracker_constant_FT_LIP_SUCK_UPPER_RIGHT:
  234. .. rst-class:: classref-enumeration-constant
  235. :ref:`BlendShapeEntry<enum_XRFaceTracker_BlendShapeEntry>` **FT_LIP_SUCK_UPPER_RIGHT** = ``46``
  236. Upper right lip part tucks in the mouth.
  237. .. _class_XRFaceTracker_constant_FT_LIP_SUCK_UPPER_LEFT:
  238. .. rst-class:: classref-enumeration-constant
  239. :ref:`BlendShapeEntry<enum_XRFaceTracker_BlendShapeEntry>` **FT_LIP_SUCK_UPPER_LEFT** = ``47``
  240. Upper left lip part tucks in the mouth.
  241. .. _class_XRFaceTracker_constant_FT_LIP_SUCK_LOWER_RIGHT:
  242. .. rst-class:: classref-enumeration-constant
  243. :ref:`BlendShapeEntry<enum_XRFaceTracker_BlendShapeEntry>` **FT_LIP_SUCK_LOWER_RIGHT** = ``48``
  244. Lower right lip part tucks in the mouth.
  245. .. _class_XRFaceTracker_constant_FT_LIP_SUCK_LOWER_LEFT:
  246. .. rst-class:: classref-enumeration-constant
  247. :ref:`BlendShapeEntry<enum_XRFaceTracker_BlendShapeEntry>` **FT_LIP_SUCK_LOWER_LEFT** = ``49``
  248. Lower left lip part tucks in the mouth.
  249. .. _class_XRFaceTracker_constant_FT_LIP_SUCK_CORNER_RIGHT:
  250. .. rst-class:: classref-enumeration-constant
  251. :ref:`BlendShapeEntry<enum_XRFaceTracker_BlendShapeEntry>` **FT_LIP_SUCK_CORNER_RIGHT** = ``50``
  252. Right lip corner folds into the mouth.
  253. .. _class_XRFaceTracker_constant_FT_LIP_SUCK_CORNER_LEFT:
  254. .. rst-class:: classref-enumeration-constant
  255. :ref:`BlendShapeEntry<enum_XRFaceTracker_BlendShapeEntry>` **FT_LIP_SUCK_CORNER_LEFT** = ``51``
  256. Left lip corner folds into the mouth.
  257. .. _class_XRFaceTracker_constant_FT_LIP_FUNNEL_UPPER_RIGHT:
  258. .. rst-class:: classref-enumeration-constant
  259. :ref:`BlendShapeEntry<enum_XRFaceTracker_BlendShapeEntry>` **FT_LIP_FUNNEL_UPPER_RIGHT** = ``52``
  260. Upper right lip part pushes into a funnel.
  261. .. _class_XRFaceTracker_constant_FT_LIP_FUNNEL_UPPER_LEFT:
  262. .. rst-class:: classref-enumeration-constant
  263. :ref:`BlendShapeEntry<enum_XRFaceTracker_BlendShapeEntry>` **FT_LIP_FUNNEL_UPPER_LEFT** = ``53``
  264. Upper left lip part pushes into a funnel.
  265. .. _class_XRFaceTracker_constant_FT_LIP_FUNNEL_LOWER_RIGHT:
  266. .. rst-class:: classref-enumeration-constant
  267. :ref:`BlendShapeEntry<enum_XRFaceTracker_BlendShapeEntry>` **FT_LIP_FUNNEL_LOWER_RIGHT** = ``54``
  268. Lower right lip part pushes into a funnel.
  269. .. _class_XRFaceTracker_constant_FT_LIP_FUNNEL_LOWER_LEFT:
  270. .. rst-class:: classref-enumeration-constant
  271. :ref:`BlendShapeEntry<enum_XRFaceTracker_BlendShapeEntry>` **FT_LIP_FUNNEL_LOWER_LEFT** = ``55``
  272. Lower left lip part pushes into a funnel.
  273. .. _class_XRFaceTracker_constant_FT_LIP_PUCKER_UPPER_RIGHT:
  274. .. rst-class:: classref-enumeration-constant
  275. :ref:`BlendShapeEntry<enum_XRFaceTracker_BlendShapeEntry>` **FT_LIP_PUCKER_UPPER_RIGHT** = ``56``
  276. Upper right lip part pushes outwards.
  277. .. _class_XRFaceTracker_constant_FT_LIP_PUCKER_UPPER_LEFT:
  278. .. rst-class:: classref-enumeration-constant
  279. :ref:`BlendShapeEntry<enum_XRFaceTracker_BlendShapeEntry>` **FT_LIP_PUCKER_UPPER_LEFT** = ``57``
  280. Upper left lip part pushes outwards.
  281. .. _class_XRFaceTracker_constant_FT_LIP_PUCKER_LOWER_RIGHT:
  282. .. rst-class:: classref-enumeration-constant
  283. :ref:`BlendShapeEntry<enum_XRFaceTracker_BlendShapeEntry>` **FT_LIP_PUCKER_LOWER_RIGHT** = ``58``
  284. Lower right lip part pushes outwards.
  285. .. _class_XRFaceTracker_constant_FT_LIP_PUCKER_LOWER_LEFT:
  286. .. rst-class:: classref-enumeration-constant
  287. :ref:`BlendShapeEntry<enum_XRFaceTracker_BlendShapeEntry>` **FT_LIP_PUCKER_LOWER_LEFT** = ``59``
  288. Lower left lip part pushes outwards.
  289. .. _class_XRFaceTracker_constant_FT_MOUTH_UPPER_UP_RIGHT:
  290. .. rst-class:: classref-enumeration-constant
  291. :ref:`BlendShapeEntry<enum_XRFaceTracker_BlendShapeEntry>` **FT_MOUTH_UPPER_UP_RIGHT** = ``60``
  292. Upper right part of the lip pulls up.
  293. .. _class_XRFaceTracker_constant_FT_MOUTH_UPPER_UP_LEFT:
  294. .. rst-class:: classref-enumeration-constant
  295. :ref:`BlendShapeEntry<enum_XRFaceTracker_BlendShapeEntry>` **FT_MOUTH_UPPER_UP_LEFT** = ``61``
  296. Upper left part of the lip pulls up.
  297. .. _class_XRFaceTracker_constant_FT_MOUTH_LOWER_DOWN_RIGHT:
  298. .. rst-class:: classref-enumeration-constant
  299. :ref:`BlendShapeEntry<enum_XRFaceTracker_BlendShapeEntry>` **FT_MOUTH_LOWER_DOWN_RIGHT** = ``62``
  300. Lower right part of the lip pulls up.
  301. .. _class_XRFaceTracker_constant_FT_MOUTH_LOWER_DOWN_LEFT:
  302. .. rst-class:: classref-enumeration-constant
  303. :ref:`BlendShapeEntry<enum_XRFaceTracker_BlendShapeEntry>` **FT_MOUTH_LOWER_DOWN_LEFT** = ``63``
  304. Lower left part of the lip pulls up.
  305. .. _class_XRFaceTracker_constant_FT_MOUTH_UPPER_DEEPEN_RIGHT:
  306. .. rst-class:: classref-enumeration-constant
  307. :ref:`BlendShapeEntry<enum_XRFaceTracker_BlendShapeEntry>` **FT_MOUTH_UPPER_DEEPEN_RIGHT** = ``64``
  308. Upper right lip part pushes in the cheek.
  309. .. _class_XRFaceTracker_constant_FT_MOUTH_UPPER_DEEPEN_LEFT:
  310. .. rst-class:: classref-enumeration-constant
  311. :ref:`BlendShapeEntry<enum_XRFaceTracker_BlendShapeEntry>` **FT_MOUTH_UPPER_DEEPEN_LEFT** = ``65``
  312. Upper left lip part pushes in the cheek.
  313. .. _class_XRFaceTracker_constant_FT_MOUTH_UPPER_RIGHT:
  314. .. rst-class:: classref-enumeration-constant
  315. :ref:`BlendShapeEntry<enum_XRFaceTracker_BlendShapeEntry>` **FT_MOUTH_UPPER_RIGHT** = ``66``
  316. Moves upper lip right.
  317. .. _class_XRFaceTracker_constant_FT_MOUTH_UPPER_LEFT:
  318. .. rst-class:: classref-enumeration-constant
  319. :ref:`BlendShapeEntry<enum_XRFaceTracker_BlendShapeEntry>` **FT_MOUTH_UPPER_LEFT** = ``67``
  320. Moves upper lip left.
  321. .. _class_XRFaceTracker_constant_FT_MOUTH_LOWER_RIGHT:
  322. .. rst-class:: classref-enumeration-constant
  323. :ref:`BlendShapeEntry<enum_XRFaceTracker_BlendShapeEntry>` **FT_MOUTH_LOWER_RIGHT** = ``68``
  324. Moves lower lip right.
  325. .. _class_XRFaceTracker_constant_FT_MOUTH_LOWER_LEFT:
  326. .. rst-class:: classref-enumeration-constant
  327. :ref:`BlendShapeEntry<enum_XRFaceTracker_BlendShapeEntry>` **FT_MOUTH_LOWER_LEFT** = ``69``
  328. Moves lower lip left.
  329. .. _class_XRFaceTracker_constant_FT_MOUTH_CORNER_PULL_RIGHT:
  330. .. rst-class:: classref-enumeration-constant
  331. :ref:`BlendShapeEntry<enum_XRFaceTracker_BlendShapeEntry>` **FT_MOUTH_CORNER_PULL_RIGHT** = ``70``
  332. Right lip corner pulls diagonally up and out.
  333. .. _class_XRFaceTracker_constant_FT_MOUTH_CORNER_PULL_LEFT:
  334. .. rst-class:: classref-enumeration-constant
  335. :ref:`BlendShapeEntry<enum_XRFaceTracker_BlendShapeEntry>` **FT_MOUTH_CORNER_PULL_LEFT** = ``71``
  336. Left lip corner pulls diagonally up and out.
  337. .. _class_XRFaceTracker_constant_FT_MOUTH_CORNER_SLANT_RIGHT:
  338. .. rst-class:: classref-enumeration-constant
  339. :ref:`BlendShapeEntry<enum_XRFaceTracker_BlendShapeEntry>` **FT_MOUTH_CORNER_SLANT_RIGHT** = ``72``
  340. Right corner lip slants up.
  341. .. _class_XRFaceTracker_constant_FT_MOUTH_CORNER_SLANT_LEFT:
  342. .. rst-class:: classref-enumeration-constant
  343. :ref:`BlendShapeEntry<enum_XRFaceTracker_BlendShapeEntry>` **FT_MOUTH_CORNER_SLANT_LEFT** = ``73``
  344. Left corner lip slants up.
  345. .. _class_XRFaceTracker_constant_FT_MOUTH_FROWN_RIGHT:
  346. .. rst-class:: classref-enumeration-constant
  347. :ref:`BlendShapeEntry<enum_XRFaceTracker_BlendShapeEntry>` **FT_MOUTH_FROWN_RIGHT** = ``74``
  348. Right corner lip pulls down.
  349. .. _class_XRFaceTracker_constant_FT_MOUTH_FROWN_LEFT:
  350. .. rst-class:: classref-enumeration-constant
  351. :ref:`BlendShapeEntry<enum_XRFaceTracker_BlendShapeEntry>` **FT_MOUTH_FROWN_LEFT** = ``75``
  352. Left corner lip pulls down.
  353. .. _class_XRFaceTracker_constant_FT_MOUTH_STRETCH_RIGHT:
  354. .. rst-class:: classref-enumeration-constant
  355. :ref:`BlendShapeEntry<enum_XRFaceTracker_BlendShapeEntry>` **FT_MOUTH_STRETCH_RIGHT** = ``76``
  356. Mouth corner lip pulls out and down.
  357. .. _class_XRFaceTracker_constant_FT_MOUTH_STRETCH_LEFT:
  358. .. rst-class:: classref-enumeration-constant
  359. :ref:`BlendShapeEntry<enum_XRFaceTracker_BlendShapeEntry>` **FT_MOUTH_STRETCH_LEFT** = ``77``
  360. Mouth corner lip pulls out and down.
  361. .. _class_XRFaceTracker_constant_FT_MOUTH_DIMPLE_RIGHT:
  362. .. rst-class:: classref-enumeration-constant
  363. :ref:`BlendShapeEntry<enum_XRFaceTracker_BlendShapeEntry>` **FT_MOUTH_DIMPLE_RIGHT** = ``78``
  364. Right lip corner is pushed backwards.
  365. .. _class_XRFaceTracker_constant_FT_MOUTH_DIMPLE_LEFT:
  366. .. rst-class:: classref-enumeration-constant
  367. :ref:`BlendShapeEntry<enum_XRFaceTracker_BlendShapeEntry>` **FT_MOUTH_DIMPLE_LEFT** = ``79``
  368. Left lip corner is pushed backwards.
  369. .. _class_XRFaceTracker_constant_FT_MOUTH_RAISER_UPPER:
  370. .. rst-class:: classref-enumeration-constant
  371. :ref:`BlendShapeEntry<enum_XRFaceTracker_BlendShapeEntry>` **FT_MOUTH_RAISER_UPPER** = ``80``
  372. Raises and slightly pushes out the upper mouth.
  373. .. _class_XRFaceTracker_constant_FT_MOUTH_RAISER_LOWER:
  374. .. rst-class:: classref-enumeration-constant
  375. :ref:`BlendShapeEntry<enum_XRFaceTracker_BlendShapeEntry>` **FT_MOUTH_RAISER_LOWER** = ``81``
  376. Raises and slightly pushes out the lower mouth.
  377. .. _class_XRFaceTracker_constant_FT_MOUTH_PRESS_RIGHT:
  378. .. rst-class:: classref-enumeration-constant
  379. :ref:`BlendShapeEntry<enum_XRFaceTracker_BlendShapeEntry>` **FT_MOUTH_PRESS_RIGHT** = ``82``
  380. Right side lips press and flatten together vertically.
  381. .. _class_XRFaceTracker_constant_FT_MOUTH_PRESS_LEFT:
  382. .. rst-class:: classref-enumeration-constant
  383. :ref:`BlendShapeEntry<enum_XRFaceTracker_BlendShapeEntry>` **FT_MOUTH_PRESS_LEFT** = ``83``
  384. Left side lips press and flatten together vertically.
  385. .. _class_XRFaceTracker_constant_FT_MOUTH_TIGHTENER_RIGHT:
  386. .. rst-class:: classref-enumeration-constant
  387. :ref:`BlendShapeEntry<enum_XRFaceTracker_BlendShapeEntry>` **FT_MOUTH_TIGHTENER_RIGHT** = ``84``
  388. Right side lips squeeze together horizontally.
  389. .. _class_XRFaceTracker_constant_FT_MOUTH_TIGHTENER_LEFT:
  390. .. rst-class:: classref-enumeration-constant
  391. :ref:`BlendShapeEntry<enum_XRFaceTracker_BlendShapeEntry>` **FT_MOUTH_TIGHTENER_LEFT** = ``85``
  392. Left side lips squeeze together horizontally.
  393. .. _class_XRFaceTracker_constant_FT_TONGUE_OUT:
  394. .. rst-class:: classref-enumeration-constant
  395. :ref:`BlendShapeEntry<enum_XRFaceTracker_BlendShapeEntry>` **FT_TONGUE_OUT** = ``86``
  396. Tongue visibly sticks out of the mouth.
  397. .. _class_XRFaceTracker_constant_FT_TONGUE_UP:
  398. .. rst-class:: classref-enumeration-constant
  399. :ref:`BlendShapeEntry<enum_XRFaceTracker_BlendShapeEntry>` **FT_TONGUE_UP** = ``87``
  400. Tongue points upwards.
  401. .. _class_XRFaceTracker_constant_FT_TONGUE_DOWN:
  402. .. rst-class:: classref-enumeration-constant
  403. :ref:`BlendShapeEntry<enum_XRFaceTracker_BlendShapeEntry>` **FT_TONGUE_DOWN** = ``88``
  404. Tongue points downwards.
  405. .. _class_XRFaceTracker_constant_FT_TONGUE_RIGHT:
  406. .. rst-class:: classref-enumeration-constant
  407. :ref:`BlendShapeEntry<enum_XRFaceTracker_BlendShapeEntry>` **FT_TONGUE_RIGHT** = ``89``
  408. Tongue points right.
  409. .. _class_XRFaceTracker_constant_FT_TONGUE_LEFT:
  410. .. rst-class:: classref-enumeration-constant
  411. :ref:`BlendShapeEntry<enum_XRFaceTracker_BlendShapeEntry>` **FT_TONGUE_LEFT** = ``90``
  412. Tongue points left.
  413. .. _class_XRFaceTracker_constant_FT_TONGUE_ROLL:
  414. .. rst-class:: classref-enumeration-constant
  415. :ref:`BlendShapeEntry<enum_XRFaceTracker_BlendShapeEntry>` **FT_TONGUE_ROLL** = ``91``
  416. Sides of the tongue funnel, creating a roll.
  417. .. _class_XRFaceTracker_constant_FT_TONGUE_BLEND_DOWN:
  418. .. rst-class:: classref-enumeration-constant
  419. :ref:`BlendShapeEntry<enum_XRFaceTracker_BlendShapeEntry>` **FT_TONGUE_BLEND_DOWN** = ``92``
  420. Tongue arches up then down inside the mouth.
  421. .. _class_XRFaceTracker_constant_FT_TONGUE_CURL_UP:
  422. .. rst-class:: classref-enumeration-constant
  423. :ref:`BlendShapeEntry<enum_XRFaceTracker_BlendShapeEntry>` **FT_TONGUE_CURL_UP** = ``93``
  424. Tongue arches down then up inside the mouth.
  425. .. _class_XRFaceTracker_constant_FT_TONGUE_SQUISH:
  426. .. rst-class:: classref-enumeration-constant
  427. :ref:`BlendShapeEntry<enum_XRFaceTracker_BlendShapeEntry>` **FT_TONGUE_SQUISH** = ``94``
  428. Tongue squishes together and thickens.
  429. .. _class_XRFaceTracker_constant_FT_TONGUE_FLAT:
  430. .. rst-class:: classref-enumeration-constant
  431. :ref:`BlendShapeEntry<enum_XRFaceTracker_BlendShapeEntry>` **FT_TONGUE_FLAT** = ``95``
  432. Tongue flattens and thins out.
  433. .. _class_XRFaceTracker_constant_FT_TONGUE_TWIST_RIGHT:
  434. .. rst-class:: classref-enumeration-constant
  435. :ref:`BlendShapeEntry<enum_XRFaceTracker_BlendShapeEntry>` **FT_TONGUE_TWIST_RIGHT** = ``96``
  436. Tongue tip rotates clockwise, with the rest following gradually.
  437. .. _class_XRFaceTracker_constant_FT_TONGUE_TWIST_LEFT:
  438. .. rst-class:: classref-enumeration-constant
  439. :ref:`BlendShapeEntry<enum_XRFaceTracker_BlendShapeEntry>` **FT_TONGUE_TWIST_LEFT** = ``97``
  440. Tongue tip rotates counter-clockwise, with the rest following gradually.
  441. .. _class_XRFaceTracker_constant_FT_SOFT_PALATE_CLOSE:
  442. .. rst-class:: classref-enumeration-constant
  443. :ref:`BlendShapeEntry<enum_XRFaceTracker_BlendShapeEntry>` **FT_SOFT_PALATE_CLOSE** = ``98``
  444. Inner mouth throat closes.
  445. .. _class_XRFaceTracker_constant_FT_THROAT_SWALLOW:
  446. .. rst-class:: classref-enumeration-constant
  447. :ref:`BlendShapeEntry<enum_XRFaceTracker_BlendShapeEntry>` **FT_THROAT_SWALLOW** = ``99``
  448. The Adam's apple visibly swallows.
  449. .. _class_XRFaceTracker_constant_FT_NECK_FLEX_RIGHT:
  450. .. rst-class:: classref-enumeration-constant
  451. :ref:`BlendShapeEntry<enum_XRFaceTracker_BlendShapeEntry>` **FT_NECK_FLEX_RIGHT** = ``100``
  452. Right side neck visibly flexes.
  453. .. _class_XRFaceTracker_constant_FT_NECK_FLEX_LEFT:
  454. .. rst-class:: classref-enumeration-constant
  455. :ref:`BlendShapeEntry<enum_XRFaceTracker_BlendShapeEntry>` **FT_NECK_FLEX_LEFT** = ``101``
  456. Left side neck visibly flexes.
  457. .. _class_XRFaceTracker_constant_FT_EYE_CLOSED:
  458. .. rst-class:: classref-enumeration-constant
  459. :ref:`BlendShapeEntry<enum_XRFaceTracker_BlendShapeEntry>` **FT_EYE_CLOSED** = ``102``
  460. Closes both eye lids.
  461. .. _class_XRFaceTracker_constant_FT_EYE_WIDE:
  462. .. rst-class:: classref-enumeration-constant
  463. :ref:`BlendShapeEntry<enum_XRFaceTracker_BlendShapeEntry>` **FT_EYE_WIDE** = ``103``
  464. Widens both eye lids.
  465. .. _class_XRFaceTracker_constant_FT_EYE_SQUINT:
  466. .. rst-class:: classref-enumeration-constant
  467. :ref:`BlendShapeEntry<enum_XRFaceTracker_BlendShapeEntry>` **FT_EYE_SQUINT** = ``104``
  468. Squints both eye lids.
  469. .. _class_XRFaceTracker_constant_FT_EYE_DILATION:
  470. .. rst-class:: classref-enumeration-constant
  471. :ref:`BlendShapeEntry<enum_XRFaceTracker_BlendShapeEntry>` **FT_EYE_DILATION** = ``105``
  472. Dilates both pupils.
  473. .. _class_XRFaceTracker_constant_FT_EYE_CONSTRICT:
  474. .. rst-class:: classref-enumeration-constant
  475. :ref:`BlendShapeEntry<enum_XRFaceTracker_BlendShapeEntry>` **FT_EYE_CONSTRICT** = ``106``
  476. Constricts both pupils.
  477. .. _class_XRFaceTracker_constant_FT_BROW_DOWN_RIGHT:
  478. .. rst-class:: classref-enumeration-constant
  479. :ref:`BlendShapeEntry<enum_XRFaceTracker_BlendShapeEntry>` **FT_BROW_DOWN_RIGHT** = ``107``
  480. Pulls the right eyebrow down and in.
  481. .. _class_XRFaceTracker_constant_FT_BROW_DOWN_LEFT:
  482. .. rst-class:: classref-enumeration-constant
  483. :ref:`BlendShapeEntry<enum_XRFaceTracker_BlendShapeEntry>` **FT_BROW_DOWN_LEFT** = ``108``
  484. Pulls the left eyebrow down and in.
  485. .. _class_XRFaceTracker_constant_FT_BROW_DOWN:
  486. .. rst-class:: classref-enumeration-constant
  487. :ref:`BlendShapeEntry<enum_XRFaceTracker_BlendShapeEntry>` **FT_BROW_DOWN** = ``109``
  488. Pulls both eyebrows down and in.
  489. .. _class_XRFaceTracker_constant_FT_BROW_UP_RIGHT:
  490. .. rst-class:: classref-enumeration-constant
  491. :ref:`BlendShapeEntry<enum_XRFaceTracker_BlendShapeEntry>` **FT_BROW_UP_RIGHT** = ``110``
  492. Right brow appears worried.
  493. .. _class_XRFaceTracker_constant_FT_BROW_UP_LEFT:
  494. .. rst-class:: classref-enumeration-constant
  495. :ref:`BlendShapeEntry<enum_XRFaceTracker_BlendShapeEntry>` **FT_BROW_UP_LEFT** = ``111``
  496. Left brow appears worried.
  497. .. _class_XRFaceTracker_constant_FT_BROW_UP:
  498. .. rst-class:: classref-enumeration-constant
  499. :ref:`BlendShapeEntry<enum_XRFaceTracker_BlendShapeEntry>` **FT_BROW_UP** = ``112``
  500. Both brows appear worried.
  501. .. _class_XRFaceTracker_constant_FT_NOSE_SNEER:
  502. .. rst-class:: classref-enumeration-constant
  503. :ref:`BlendShapeEntry<enum_XRFaceTracker_BlendShapeEntry>` **FT_NOSE_SNEER** = ``113``
  504. Entire face sneers.
  505. .. _class_XRFaceTracker_constant_FT_NASAL_DILATION:
  506. .. rst-class:: classref-enumeration-constant
  507. :ref:`BlendShapeEntry<enum_XRFaceTracker_BlendShapeEntry>` **FT_NASAL_DILATION** = ``114``
  508. Both nose canals dilate.
  509. .. _class_XRFaceTracker_constant_FT_NASAL_CONSTRICT:
  510. .. rst-class:: classref-enumeration-constant
  511. :ref:`BlendShapeEntry<enum_XRFaceTracker_BlendShapeEntry>` **FT_NASAL_CONSTRICT** = ``115``
  512. Both nose canals constrict.
  513. .. _class_XRFaceTracker_constant_FT_CHEEK_PUFF:
  514. .. rst-class:: classref-enumeration-constant
  515. :ref:`BlendShapeEntry<enum_XRFaceTracker_BlendShapeEntry>` **FT_CHEEK_PUFF** = ``116``
  516. Puffs both cheeks.
  517. .. _class_XRFaceTracker_constant_FT_CHEEK_SUCK:
  518. .. rst-class:: classref-enumeration-constant
  519. :ref:`BlendShapeEntry<enum_XRFaceTracker_BlendShapeEntry>` **FT_CHEEK_SUCK** = ``117``
  520. Sucks in both cheeks.
  521. .. _class_XRFaceTracker_constant_FT_CHEEK_SQUINT:
  522. .. rst-class:: classref-enumeration-constant
  523. :ref:`BlendShapeEntry<enum_XRFaceTracker_BlendShapeEntry>` **FT_CHEEK_SQUINT** = ``118``
  524. Raises both cheeks.
  525. .. _class_XRFaceTracker_constant_FT_LIP_SUCK_UPPER:
  526. .. rst-class:: classref-enumeration-constant
  527. :ref:`BlendShapeEntry<enum_XRFaceTracker_BlendShapeEntry>` **FT_LIP_SUCK_UPPER** = ``119``
  528. Tucks in the upper lips.
  529. .. _class_XRFaceTracker_constant_FT_LIP_SUCK_LOWER:
  530. .. rst-class:: classref-enumeration-constant
  531. :ref:`BlendShapeEntry<enum_XRFaceTracker_BlendShapeEntry>` **FT_LIP_SUCK_LOWER** = ``120``
  532. Tucks in the lower lips.
  533. .. _class_XRFaceTracker_constant_FT_LIP_SUCK:
  534. .. rst-class:: classref-enumeration-constant
  535. :ref:`BlendShapeEntry<enum_XRFaceTracker_BlendShapeEntry>` **FT_LIP_SUCK** = ``121``
  536. Tucks in both lips.
  537. .. _class_XRFaceTracker_constant_FT_LIP_FUNNEL_UPPER:
  538. .. rst-class:: classref-enumeration-constant
  539. :ref:`BlendShapeEntry<enum_XRFaceTracker_BlendShapeEntry>` **FT_LIP_FUNNEL_UPPER** = ``122``
  540. Funnels in the upper lips.
  541. .. _class_XRFaceTracker_constant_FT_LIP_FUNNEL_LOWER:
  542. .. rst-class:: classref-enumeration-constant
  543. :ref:`BlendShapeEntry<enum_XRFaceTracker_BlendShapeEntry>` **FT_LIP_FUNNEL_LOWER** = ``123``
  544. Funnels in the lower lips.
  545. .. _class_XRFaceTracker_constant_FT_LIP_FUNNEL:
  546. .. rst-class:: classref-enumeration-constant
  547. :ref:`BlendShapeEntry<enum_XRFaceTracker_BlendShapeEntry>` **FT_LIP_FUNNEL** = ``124``
  548. Funnels in both lips.
  549. .. _class_XRFaceTracker_constant_FT_LIP_PUCKER_UPPER:
  550. .. rst-class:: classref-enumeration-constant
  551. :ref:`BlendShapeEntry<enum_XRFaceTracker_BlendShapeEntry>` **FT_LIP_PUCKER_UPPER** = ``125``
  552. Upper lip part pushes outwards.
  553. .. _class_XRFaceTracker_constant_FT_LIP_PUCKER_LOWER:
  554. .. rst-class:: classref-enumeration-constant
  555. :ref:`BlendShapeEntry<enum_XRFaceTracker_BlendShapeEntry>` **FT_LIP_PUCKER_LOWER** = ``126``
  556. Lower lip part pushes outwards.
  557. .. _class_XRFaceTracker_constant_FT_LIP_PUCKER:
  558. .. rst-class:: classref-enumeration-constant
  559. :ref:`BlendShapeEntry<enum_XRFaceTracker_BlendShapeEntry>` **FT_LIP_PUCKER** = ``127``
  560. Lips push outwards.
  561. .. _class_XRFaceTracker_constant_FT_MOUTH_UPPER_UP:
  562. .. rst-class:: classref-enumeration-constant
  563. :ref:`BlendShapeEntry<enum_XRFaceTracker_BlendShapeEntry>` **FT_MOUTH_UPPER_UP** = ``128``
  564. Raises the upper lips.
  565. .. _class_XRFaceTracker_constant_FT_MOUTH_LOWER_DOWN:
  566. .. rst-class:: classref-enumeration-constant
  567. :ref:`BlendShapeEntry<enum_XRFaceTracker_BlendShapeEntry>` **FT_MOUTH_LOWER_DOWN** = ``129``
  568. Lowers the lower lips.
  569. .. _class_XRFaceTracker_constant_FT_MOUTH_OPEN:
  570. .. rst-class:: classref-enumeration-constant
  571. :ref:`BlendShapeEntry<enum_XRFaceTracker_BlendShapeEntry>` **FT_MOUTH_OPEN** = ``130``
  572. Mouth opens, revealing teeth.
  573. .. _class_XRFaceTracker_constant_FT_MOUTH_RIGHT:
  574. .. rst-class:: classref-enumeration-constant
  575. :ref:`BlendShapeEntry<enum_XRFaceTracker_BlendShapeEntry>` **FT_MOUTH_RIGHT** = ``131``
  576. Moves mouth right.
  577. .. _class_XRFaceTracker_constant_FT_MOUTH_LEFT:
  578. .. rst-class:: classref-enumeration-constant
  579. :ref:`BlendShapeEntry<enum_XRFaceTracker_BlendShapeEntry>` **FT_MOUTH_LEFT** = ``132``
  580. Moves mouth left.
  581. .. _class_XRFaceTracker_constant_FT_MOUTH_SMILE_RIGHT:
  582. .. rst-class:: classref-enumeration-constant
  583. :ref:`BlendShapeEntry<enum_XRFaceTracker_BlendShapeEntry>` **FT_MOUTH_SMILE_RIGHT** = ``133``
  584. Right side of the mouth smiles.
  585. .. _class_XRFaceTracker_constant_FT_MOUTH_SMILE_LEFT:
  586. .. rst-class:: classref-enumeration-constant
  587. :ref:`BlendShapeEntry<enum_XRFaceTracker_BlendShapeEntry>` **FT_MOUTH_SMILE_LEFT** = ``134``
  588. Left side of the mouth smiles.
  589. .. _class_XRFaceTracker_constant_FT_MOUTH_SMILE:
  590. .. rst-class:: classref-enumeration-constant
  591. :ref:`BlendShapeEntry<enum_XRFaceTracker_BlendShapeEntry>` **FT_MOUTH_SMILE** = ``135``
  592. Mouth expresses a smile.
  593. .. _class_XRFaceTracker_constant_FT_MOUTH_SAD_RIGHT:
  594. .. rst-class:: classref-enumeration-constant
  595. :ref:`BlendShapeEntry<enum_XRFaceTracker_BlendShapeEntry>` **FT_MOUTH_SAD_RIGHT** = ``136``
  596. Right side of the mouth expresses sadness.
  597. .. _class_XRFaceTracker_constant_FT_MOUTH_SAD_LEFT:
  598. .. rst-class:: classref-enumeration-constant
  599. :ref:`BlendShapeEntry<enum_XRFaceTracker_BlendShapeEntry>` **FT_MOUTH_SAD_LEFT** = ``137``
  600. Left side of the mouth expresses sadness.
  601. .. _class_XRFaceTracker_constant_FT_MOUTH_SAD:
  602. .. rst-class:: classref-enumeration-constant
  603. :ref:`BlendShapeEntry<enum_XRFaceTracker_BlendShapeEntry>` **FT_MOUTH_SAD** = ``138``
  604. Mouth expresses sadness.
  605. .. _class_XRFaceTracker_constant_FT_MOUTH_STRETCH:
  606. .. rst-class:: classref-enumeration-constant
  607. :ref:`BlendShapeEntry<enum_XRFaceTracker_BlendShapeEntry>` **FT_MOUTH_STRETCH** = ``139``
  608. Mouth stretches.
  609. .. _class_XRFaceTracker_constant_FT_MOUTH_DIMPLE:
  610. .. rst-class:: classref-enumeration-constant
  611. :ref:`BlendShapeEntry<enum_XRFaceTracker_BlendShapeEntry>` **FT_MOUTH_DIMPLE** = ``140``
  612. Lip corners dimple.
  613. .. _class_XRFaceTracker_constant_FT_MOUTH_TIGHTENER:
  614. .. rst-class:: classref-enumeration-constant
  615. :ref:`BlendShapeEntry<enum_XRFaceTracker_BlendShapeEntry>` **FT_MOUTH_TIGHTENER** = ``141``
  616. Mouth tightens.
  617. .. _class_XRFaceTracker_constant_FT_MOUTH_PRESS:
  618. .. rst-class:: classref-enumeration-constant
  619. :ref:`BlendShapeEntry<enum_XRFaceTracker_BlendShapeEntry>` **FT_MOUTH_PRESS** = ``142``
  620. Mouth presses together.
  621. .. _class_XRFaceTracker_constant_FT_MAX:
  622. .. rst-class:: classref-enumeration-constant
  623. :ref:`BlendShapeEntry<enum_XRFaceTracker_BlendShapeEntry>` **FT_MAX** = ``143``
  624. Represents the size of the :ref:`BlendShapeEntry<enum_XRFaceTracker_BlendShapeEntry>` enum.
  625. .. rst-class:: classref-section-separator
  626. ----
  627. .. rst-class:: classref-descriptions-group
  628. Property Descriptions
  629. ---------------------
  630. .. _class_XRFaceTracker_property_blend_shapes:
  631. .. rst-class:: classref-property
  632. :ref:`PackedFloat32Array<class_PackedFloat32Array>` **blend_shapes** = ``PackedFloat32Array()`` :ref:`🔗<class_XRFaceTracker_property_blend_shapes>`
  633. .. rst-class:: classref-property-setget
  634. - |void| **set_blend_shapes**\ (\ value\: :ref:`PackedFloat32Array<class_PackedFloat32Array>`\ )
  635. - :ref:`PackedFloat32Array<class_PackedFloat32Array>` **get_blend_shapes**\ (\ )
  636. The array of face blend shape weights with indices corresponding to the :ref:`BlendShapeEntry<enum_XRFaceTracker_BlendShapeEntry>` enum.
  637. **Note:** The returned array is *copied* and any changes to it will not update the original property value. See :ref:`PackedFloat32Array<class_PackedFloat32Array>` for more details.
  638. .. rst-class:: classref-section-separator
  639. ----
  640. .. rst-class:: classref-descriptions-group
  641. Method Descriptions
  642. -------------------
  643. .. _class_XRFaceTracker_method_get_blend_shape:
  644. .. rst-class:: classref-method
  645. :ref:`float<class_float>` **get_blend_shape**\ (\ blend_shape\: :ref:`BlendShapeEntry<enum_XRFaceTracker_BlendShapeEntry>`\ ) |const| :ref:`🔗<class_XRFaceTracker_method_get_blend_shape>`
  646. Returns the requested face blend shape weight.
  647. .. rst-class:: classref-item-separator
  648. ----
  649. .. _class_XRFaceTracker_method_set_blend_shape:
  650. .. rst-class:: classref-method
  651. |void| **set_blend_shape**\ (\ blend_shape\: :ref:`BlendShapeEntry<enum_XRFaceTracker_BlendShapeEntry>`, weight\: :ref:`float<class_float>`\ ) :ref:`🔗<class_XRFaceTracker_method_set_blend_shape>`
  652. Sets a face blend shape weight.
  653. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  654. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  655. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
  656. .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
  657. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
  658. .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`
  659. .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)`
  660. .. |void| replace:: :abbr:`void (No return value.)`