Index · Object → RefCounted → XRTracker → XRFaceTracker

XRFaceTracker

A tracked face.

Class Description

An instance of this object represents a tracked face and its corresponding blend shapes. The blend shapes come from the Unified Expressions standard, and contain extended details and visuals for each blend shape. Additionally the Tracking Standard Comparison page documents the relationship between Unified Expressions and other standards.

As face trackers are turned on they are registered with the XRServer.

Properties

var blend_shapes: PackedFloat32Array = PackedFloat32Array()

The array of face blend shape weights with indices corresponding to the BlendShapeEntry enum.

var type: XRServer.TrackerType = 64
Inherited from XRTracker (3)
var name: StringName = &"Unknown"

Methods

func get_blend_shape(blend_shape: XRFaceTracker.BlendShapeEntry) -> float

Returns the requested face blend shape weight.

func set_blend_shape(blend_shape: XRFaceTracker.BlendShapeEntry, weight: float) -> void

Sets a face blend shape weight.

Inherited from RefCounted (4)
func init_ref() -> bool
func reference() -> bool
func unreference() -> bool
Inherited from Object (62)
func _get(property: StringName) -> Variant
func _get_property_list() -> Dictionary[]
func _init() -> void
func _iter_get(iter: Variant) -> Variant
func _iter_init(iter: Array) -> bool
func _iter_next(iter: Array) -> bool
func _notification(what: int) -> void
func _set(property: StringName, value: Variant) -> bool
func _to_string() -> String
func _validate_property(property: Dictionary) -> void
func add_user_signal(signal: String, arguments: Array = []) -> void
func call(method: StringName) -> Variant
func callv(method: StringName, arg_array: Array) -> Variant
func cancel_free() -> void
func connect(signal: StringName, callable: Callable, flags: int = 0) -> Error
func disconnect(signal: StringName, callable: Callable) -> void
func emit_signal(signal: StringName) -> Error
func free() -> void
func get(property: StringName) -> Variant
func get_class() -> String
func get_incoming_connections() -> Dictionary[]
func get_indexed(property_path: NodePath) -> Variant
func get_meta(name: StringName, default: Variant = null) -> Variant
func get_meta_list() -> StringName[]
func get_method_list() -> Dictionary[]
func get_property_list() -> Dictionary[]
func get_signal_connection_list(signal: StringName) -> Dictionary[]
func get_signal_list() -> Dictionary[]
func has_meta(name: StringName) -> bool
func has_method(method: StringName) -> bool
func has_signal(signal: StringName) -> bool
func is_class(class: StringName) -> bool
func is_connected(signal: StringName, callable: Callable) -> bool
func notification(what: int, reversed: bool = false) -> void
func remove_meta(name: StringName) -> void
func remove_user_signal(signal: StringName) -> void
func set(property: StringName, value: Variant) -> void
func set_block_signals(enable: bool) -> void
func set_deferred(property: StringName, value: Variant) -> void
func set_indexed(property_path: NodePath, value: Variant) -> void
func set_message_translation(enable: bool) -> void
func set_meta(name: StringName, value: Variant) -> void
func set_script(script: Variant) -> void
func set_translation_domain(domain: StringName) -> void
func to_string() -> String
func tr(message: StringName, context: StringName = &"") -> String
func tr_n(message: StringName, plural_message: StringName, n: int, context: StringName = &"") -> String

Signals

Inherited from Object (2)

Enums & Constants

enum BlendShapeEntry
FT_EYE_LOOK_OUT_RIGHT = 0

Right eye looks outwards.

FT_EYE_LOOK_IN_RIGHT = 1

Right eye looks inwards.

FT_EYE_LOOK_UP_RIGHT = 2

Right eye looks upwards.

FT_EYE_LOOK_DOWN_RIGHT = 3

Right eye looks downwards.

FT_EYE_LOOK_OUT_LEFT = 4

Left eye looks outwards.

FT_EYE_LOOK_IN_LEFT = 5

Left eye looks inwards.

FT_EYE_LOOK_UP_LEFT = 6

Left eye looks upwards.

FT_EYE_LOOK_DOWN_LEFT = 7

Left eye looks downwards.

FT_EYE_CLOSED_RIGHT = 8

Closes the right eyelid.

FT_EYE_CLOSED_LEFT = 9

Closes the left eyelid.

FT_EYE_SQUINT_RIGHT = 10

Squeezes the right eye socket muscles.

FT_EYE_SQUINT_LEFT = 11

Squeezes the left eye socket muscles.

FT_EYE_WIDE_RIGHT = 12

Right eyelid widens beyond relaxed.

FT_EYE_WIDE_LEFT = 13

Left eyelid widens beyond relaxed.

FT_EYE_DILATION_RIGHT = 14

Dilates the right eye pupil.

FT_EYE_DILATION_LEFT = 15

Dilates the left eye pupil.

FT_EYE_CONSTRICT_RIGHT = 16

Constricts the right eye pupil.

FT_EYE_CONSTRICT_LEFT = 17

Constricts the left eye pupil.

FT_BROW_PINCH_RIGHT = 18

Right eyebrow pinches in.

FT_BROW_PINCH_LEFT = 19

Left eyebrow pinches in.

FT_BROW_LOWERER_RIGHT = 20

Outer right eyebrow pulls down.

FT_BROW_LOWERER_LEFT = 21

Outer left eyebrow pulls down.

FT_BROW_INNER_UP_RIGHT = 22

Inner right eyebrow pulls up.

FT_BROW_INNER_UP_LEFT = 23

Inner left eyebrow pulls up.

FT_BROW_OUTER_UP_RIGHT = 24

Outer right eyebrow pulls up.

FT_BROW_OUTER_UP_LEFT = 25

Outer left eyebrow pulls up.

FT_NOSE_SNEER_RIGHT = 26

Right side face sneers.

FT_NOSE_SNEER_LEFT = 27

Left side face sneers.

FT_NASAL_DILATION_RIGHT = 28

Right side nose canal dilates.

FT_NASAL_DILATION_LEFT = 29

Left side nose canal dilates.

FT_NASAL_CONSTRICT_RIGHT = 30

Right side nose canal constricts.

FT_NASAL_CONSTRICT_LEFT = 31

Left side nose canal constricts.

FT_CHEEK_SQUINT_RIGHT = 32

Raises the right side cheek.

FT_CHEEK_SQUINT_LEFT = 33

Raises the left side cheek.

FT_CHEEK_PUFF_RIGHT = 34

Puffs the right side cheek.

FT_CHEEK_PUFF_LEFT = 35

Puffs the left side cheek.

FT_CHEEK_SUCK_RIGHT = 36

Sucks in the right side cheek.

FT_CHEEK_SUCK_LEFT = 37

Sucks in the left side cheek.

FT_JAW_OPEN = 38

Opens jawbone.

FT_MOUTH_CLOSED = 39

Closes the mouth.

FT_JAW_RIGHT = 40

Pushes jawbone right.

FT_JAW_LEFT = 41

Pushes jawbone left.

FT_JAW_FORWARD = 42

Pushes jawbone forward.

FT_JAW_BACKWARD = 43

Pushes jawbone backward.

FT_JAW_CLENCH = 44

Flexes jaw muscles.

FT_JAW_MANDIBLE_RAISE = 45

Raises the jawbone.

FT_LIP_SUCK_UPPER_RIGHT = 46

Upper right lip part tucks in the mouth.

FT_LIP_SUCK_UPPER_LEFT = 47

Upper left lip part tucks in the mouth.

FT_LIP_SUCK_LOWER_RIGHT = 48

Lower right lip part tucks in the mouth.

FT_LIP_SUCK_LOWER_LEFT = 49

Lower left lip part tucks in the mouth.

FT_LIP_SUCK_CORNER_RIGHT = 50

Right lip corner folds into the mouth.

FT_LIP_SUCK_CORNER_LEFT = 51

Left lip corner folds into the mouth.

FT_LIP_FUNNEL_UPPER_RIGHT = 52

Upper right lip part pushes into a funnel.

FT_LIP_FUNNEL_UPPER_LEFT = 53

Upper left lip part pushes into a funnel.

FT_LIP_FUNNEL_LOWER_RIGHT = 54

Lower right lip part pushes into a funnel.

FT_LIP_FUNNEL_LOWER_LEFT = 55

Lower left lip part pushes into a funnel.

FT_LIP_PUCKER_UPPER_RIGHT = 56

Upper right lip part pushes outwards.

FT_LIP_PUCKER_UPPER_LEFT = 57

Upper left lip part pushes outwards.

FT_LIP_PUCKER_LOWER_RIGHT = 58

Lower right lip part pushes outwards.

FT_LIP_PUCKER_LOWER_LEFT = 59

Lower left lip part pushes outwards.

FT_MOUTH_UPPER_UP_RIGHT = 60

Upper right part of the lip pulls up.

FT_MOUTH_UPPER_UP_LEFT = 61

Upper left part of the lip pulls up.

FT_MOUTH_LOWER_DOWN_RIGHT = 62

Lower right part of the lip pulls up.

FT_MOUTH_LOWER_DOWN_LEFT = 63

Lower left part of the lip pulls up.

FT_MOUTH_UPPER_DEEPEN_RIGHT = 64

Upper right lip part pushes in the cheek.

FT_MOUTH_UPPER_DEEPEN_LEFT = 65

Upper left lip part pushes in the cheek.

FT_MOUTH_UPPER_RIGHT = 66

Moves upper lip right.

FT_MOUTH_UPPER_LEFT = 67

Moves upper lip left.

FT_MOUTH_LOWER_RIGHT = 68

Moves lower lip right.

FT_MOUTH_LOWER_LEFT = 69

Moves lower lip left.

FT_MOUTH_CORNER_PULL_RIGHT = 70

Right lip corner pulls diagonally up and out.

FT_MOUTH_CORNER_PULL_LEFT = 71

Left lip corner pulls diagonally up and out.

FT_MOUTH_CORNER_SLANT_RIGHT = 72

Right corner lip slants up.

FT_MOUTH_CORNER_SLANT_LEFT = 73

Left corner lip slants up.

FT_MOUTH_FROWN_RIGHT = 74

Right corner lip pulls down.

FT_MOUTH_FROWN_LEFT = 75

Left corner lip pulls down.

FT_MOUTH_STRETCH_RIGHT = 76

Mouth corner lip pulls out and down.

FT_MOUTH_STRETCH_LEFT = 77

Mouth corner lip pulls out and down.

FT_MOUTH_DIMPLE_RIGHT = 78

Right lip corner is pushed backwards.

FT_MOUTH_DIMPLE_LEFT = 79

Left lip corner is pushed backwards.

FT_MOUTH_RAISER_UPPER = 80

Raises and slightly pushes out the upper mouth.

FT_MOUTH_RAISER_LOWER = 81

Raises and slightly pushes out the lower mouth.

FT_MOUTH_PRESS_RIGHT = 82

Right side lips press and flatten together vertically.

FT_MOUTH_PRESS_LEFT = 83

Left side lips press and flatten together vertically.

FT_MOUTH_TIGHTENER_RIGHT = 84

Right side lips squeeze together horizontally.

FT_MOUTH_TIGHTENER_LEFT = 85

Left side lips squeeze together horizontally.

FT_TONGUE_OUT = 86

Tongue visibly sticks out of the mouth.

FT_TONGUE_UP = 87

Tongue points upwards.

FT_TONGUE_DOWN = 88

Tongue points downwards.

FT_TONGUE_RIGHT = 89

Tongue points right.

FT_TONGUE_LEFT = 90

Tongue points left.

FT_TONGUE_ROLL = 91

Sides of the tongue funnel, creating a roll.

FT_TONGUE_BLEND_DOWN = 92

Tongue arches up then down inside the mouth.

FT_TONGUE_CURL_UP = 93

Tongue arches down then up inside the mouth.

FT_TONGUE_SQUISH = 94

Tongue squishes together and thickens.

FT_TONGUE_FLAT = 95

Tongue flattens and thins out.

FT_TONGUE_TWIST_RIGHT = 96

Tongue tip rotates clockwise, with the rest following gradually.

FT_TONGUE_TWIST_LEFT = 97

Tongue tip rotates counter-clockwise, with the rest following gradually.

FT_SOFT_PALATE_CLOSE = 98

Inner mouth throat closes.

FT_THROAT_SWALLOW = 99

The Adam's apple visibly swallows.

FT_NECK_FLEX_RIGHT = 100

Right side neck visibly flexes.

FT_NECK_FLEX_LEFT = 101

Left side neck visibly flexes.

FT_EYE_CLOSED = 102

Closes both eye lids.

FT_EYE_WIDE = 103

Widens both eye lids.

FT_EYE_SQUINT = 104

Squints both eye lids.

FT_EYE_DILATION = 105

Dilates both pupils.

FT_EYE_CONSTRICT = 106

Constricts both pupils.

FT_BROW_DOWN_RIGHT = 107

Pulls the right eyebrow down and in.

FT_BROW_DOWN_LEFT = 108

Pulls the left eyebrow down and in.

FT_BROW_DOWN = 109

Pulls both eyebrows down and in.

FT_BROW_UP_RIGHT = 110

Right brow appears worried.

FT_BROW_UP_LEFT = 111

Left brow appears worried.

FT_BROW_UP = 112

Both brows appear worried.

FT_NOSE_SNEER = 113

Entire face sneers.

FT_NASAL_DILATION = 114

Both nose canals dilate.

FT_NASAL_CONSTRICT = 115

Both nose canals constrict.

FT_CHEEK_PUFF = 116

Puffs both cheeks.

FT_CHEEK_SUCK = 117

Sucks in both cheeks.

FT_CHEEK_SQUINT = 118

Raises both cheeks.

FT_LIP_SUCK_UPPER = 119

Tucks in the upper lips.

FT_LIP_SUCK_LOWER = 120

Tucks in the lower lips.

FT_LIP_SUCK = 121

Tucks in both lips.

FT_LIP_FUNNEL_UPPER = 122

Funnels in the upper lips.

FT_LIP_FUNNEL_LOWER = 123

Funnels in the lower lips.

FT_LIP_FUNNEL = 124

Funnels in both lips.

FT_LIP_PUCKER_UPPER = 125

Upper lip part pushes outwards.

FT_LIP_PUCKER_LOWER = 126

Lower lip part pushes outwards.

FT_LIP_PUCKER = 127

Lips push outwards.

FT_MOUTH_UPPER_UP = 128

Raises the upper lips.

FT_MOUTH_LOWER_DOWN = 129

Lowers the lower lips.

FT_MOUTH_OPEN = 130

Mouth opens, revealing teeth.

FT_MOUTH_RIGHT = 131

Moves mouth right.

FT_MOUTH_LEFT = 132

Moves mouth left.

FT_MOUTH_SMILE_RIGHT = 133

Right side of the mouth smiles.

FT_MOUTH_SMILE_LEFT = 134

Left side of the mouth smiles.

FT_MOUTH_SMILE = 135

Mouth expresses a smile.

FT_MOUTH_SAD_RIGHT = 136

Right side of the mouth expresses sadness.

FT_MOUTH_SAD_LEFT = 137

Left side of the mouth expresses sadness.

FT_MOUTH_SAD = 138

Mouth expresses sadness.

FT_MOUTH_STRETCH = 139

Mouth stretches.

FT_MOUTH_DIMPLE = 140

Lip corners dimple.

FT_MOUTH_TIGHTENER = 141

Mouth tightens.

FT_MOUTH_PRESS = 142

Mouth presses together.

FT_MAX = 143

Represents the size of the BlendShapeEntry enum.