Class reference

XRFaceTracker

Inherits XRTracker

Experimental.

A tracked face.

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

Methods

float get_blend_shape(int blend_shape) const

Returns the requested face blend shape weight.

void set_blend_shape(int blend_shape, float weight)

Sets a face blend shape weight.

Constants

FT_EYE_LOOK_OUT_RIGHT = 0

Enum: BlendShapeEntry

Right eye looks outwards.

FT_EYE_LOOK_IN_RIGHT = 1

Enum: BlendShapeEntry

Right eye looks inwards.

FT_EYE_LOOK_UP_RIGHT = 2

Enum: BlendShapeEntry

Right eye looks upwards.

FT_EYE_LOOK_DOWN_RIGHT = 3

Enum: BlendShapeEntry

Right eye looks downwards.

FT_EYE_LOOK_OUT_LEFT = 4

Enum: BlendShapeEntry

Left eye looks outwards.

FT_EYE_LOOK_IN_LEFT = 5

Enum: BlendShapeEntry

Left eye looks inwards.

FT_EYE_LOOK_UP_LEFT = 6

Enum: BlendShapeEntry

Left eye looks upwards.

FT_EYE_LOOK_DOWN_LEFT = 7

Enum: BlendShapeEntry

Left eye looks downwards.

FT_EYE_CLOSED_RIGHT = 8

Enum: BlendShapeEntry

Closes the right eyelid.

FT_EYE_CLOSED_LEFT = 9

Enum: BlendShapeEntry

Closes the left eyelid.

FT_EYE_SQUINT_RIGHT = 10

Enum: BlendShapeEntry

Squeezes the right eye socket muscles.

FT_EYE_SQUINT_LEFT = 11

Enum: BlendShapeEntry

Squeezes the left eye socket muscles.

FT_EYE_WIDE_RIGHT = 12

Enum: BlendShapeEntry

Right eyelid widens beyond relaxed.

FT_EYE_WIDE_LEFT = 13

Enum: BlendShapeEntry

Left eyelid widens beyond relaxed.

FT_EYE_DILATION_RIGHT = 14

Enum: BlendShapeEntry

Dilates the right eye pupil.

FT_EYE_DILATION_LEFT = 15

Enum: BlendShapeEntry

Dilates the left eye pupil.

FT_EYE_CONSTRICT_RIGHT = 16

Enum: BlendShapeEntry

Constricts the right eye pupil.

FT_EYE_CONSTRICT_LEFT = 17

Enum: BlendShapeEntry

Constricts the left eye pupil.

FT_BROW_PINCH_RIGHT = 18

Enum: BlendShapeEntry

Right eyebrow pinches in.

FT_BROW_PINCH_LEFT = 19

Enum: BlendShapeEntry

Left eyebrow pinches in.

FT_BROW_LOWERER_RIGHT = 20

Enum: BlendShapeEntry

Outer right eyebrow pulls down.

FT_BROW_LOWERER_LEFT = 21

Enum: BlendShapeEntry

Outer left eyebrow pulls down.

FT_BROW_INNER_UP_RIGHT = 22

Enum: BlendShapeEntry

Inner right eyebrow pulls up.

FT_BROW_INNER_UP_LEFT = 23

Enum: BlendShapeEntry

Inner left eyebrow pulls up.

FT_BROW_OUTER_UP_RIGHT = 24

Enum: BlendShapeEntry

Outer right eyebrow pulls up.

FT_BROW_OUTER_UP_LEFT = 25

Enum: BlendShapeEntry

Outer left eyebrow pulls up.

FT_NOSE_SNEER_RIGHT = 26

Enum: BlendShapeEntry

Right side face sneers.

FT_NOSE_SNEER_LEFT = 27

Enum: BlendShapeEntry

Left side face sneers.

FT_NASAL_DILATION_RIGHT = 28

Enum: BlendShapeEntry

Right side nose canal dilates.

FT_NASAL_DILATION_LEFT = 29

Enum: BlendShapeEntry

Left side nose canal dilates.

FT_NASAL_CONSTRICT_RIGHT = 30

Enum: BlendShapeEntry

Right side nose canal constricts.

FT_NASAL_CONSTRICT_LEFT = 31

Enum: BlendShapeEntry

Left side nose canal constricts.

FT_CHEEK_SQUINT_RIGHT = 32

Enum: BlendShapeEntry

Raises the right side cheek.

FT_CHEEK_SQUINT_LEFT = 33

Enum: BlendShapeEntry

Raises the left side cheek.

FT_CHEEK_PUFF_RIGHT = 34

Enum: BlendShapeEntry

Puffs the right side cheek.

FT_CHEEK_PUFF_LEFT = 35

Enum: BlendShapeEntry

Puffs the left side cheek.

FT_CHEEK_SUCK_RIGHT = 36

Enum: BlendShapeEntry

Sucks in the right side cheek.

FT_CHEEK_SUCK_LEFT = 37

Enum: BlendShapeEntry

Sucks in the left side cheek.

FT_JAW_OPEN = 38

Enum: BlendShapeEntry

Opens jawbone.

FT_MOUTH_CLOSED = 39

Enum: BlendShapeEntry

Closes the mouth.

FT_JAW_RIGHT = 40

Enum: BlendShapeEntry

Pushes jawbone right.

FT_JAW_LEFT = 41

Enum: BlendShapeEntry

Pushes jawbone left.

FT_JAW_FORWARD = 42

Enum: BlendShapeEntry

Pushes jawbone forward.

FT_JAW_BACKWARD = 43

Enum: BlendShapeEntry

Pushes jawbone backward.

FT_JAW_CLENCH = 44

Enum: BlendShapeEntry

Flexes jaw muscles.

FT_JAW_MANDIBLE_RAISE = 45

Enum: BlendShapeEntry

Raises the jawbone.

FT_LIP_SUCK_UPPER_RIGHT = 46

Enum: BlendShapeEntry

Upper right lip part tucks in the mouth.

FT_LIP_SUCK_UPPER_LEFT = 47

Enum: BlendShapeEntry

Upper left lip part tucks in the mouth.

FT_LIP_SUCK_LOWER_RIGHT = 48

Enum: BlendShapeEntry

Lower right lip part tucks in the mouth.

FT_LIP_SUCK_LOWER_LEFT = 49

Enum: BlendShapeEntry

Lower left lip part tucks in the mouth.

FT_LIP_SUCK_CORNER_RIGHT = 50

Enum: BlendShapeEntry

Right lip corner folds into the mouth.

FT_LIP_SUCK_CORNER_LEFT = 51

Enum: BlendShapeEntry

Left lip corner folds into the mouth.

FT_LIP_FUNNEL_UPPER_RIGHT = 52

Enum: BlendShapeEntry

Upper right lip part pushes into a funnel.

FT_LIP_FUNNEL_UPPER_LEFT = 53

Enum: BlendShapeEntry

Upper left lip part pushes into a funnel.

FT_LIP_FUNNEL_LOWER_RIGHT = 54

Enum: BlendShapeEntry

Lower right lip part pushes into a funnel.

FT_LIP_FUNNEL_LOWER_LEFT = 55

Enum: BlendShapeEntry

Lower left lip part pushes into a funnel.

FT_LIP_PUCKER_UPPER_RIGHT = 56

Enum: BlendShapeEntry

Upper right lip part pushes outwards.

FT_LIP_PUCKER_UPPER_LEFT = 57

Enum: BlendShapeEntry

Upper left lip part pushes outwards.

FT_LIP_PUCKER_LOWER_RIGHT = 58

Enum: BlendShapeEntry

Lower right lip part pushes outwards.

FT_LIP_PUCKER_LOWER_LEFT = 59

Enum: BlendShapeEntry

Lower left lip part pushes outwards.

FT_MOUTH_UPPER_UP_RIGHT = 60

Enum: BlendShapeEntry

Upper right part of the lip pulls up.

FT_MOUTH_UPPER_UP_LEFT = 61

Enum: BlendShapeEntry

Upper left part of the lip pulls up.

FT_MOUTH_LOWER_DOWN_RIGHT = 62

Enum: BlendShapeEntry

Lower right part of the lip pulls up.

FT_MOUTH_LOWER_DOWN_LEFT = 63

Enum: BlendShapeEntry

Lower left part of the lip pulls up.

FT_MOUTH_UPPER_DEEPEN_RIGHT = 64

Enum: BlendShapeEntry

Upper right lip part pushes in the cheek.

FT_MOUTH_UPPER_DEEPEN_LEFT = 65

Enum: BlendShapeEntry

Upper left lip part pushes in the cheek.

FT_MOUTH_UPPER_RIGHT = 66

Enum: BlendShapeEntry

Moves upper lip right.

FT_MOUTH_UPPER_LEFT = 67

Enum: BlendShapeEntry

Moves upper lip left.

FT_MOUTH_LOWER_RIGHT = 68

Enum: BlendShapeEntry

Moves lower lip right.

FT_MOUTH_LOWER_LEFT = 69

Enum: BlendShapeEntry

Moves lower lip left.

FT_MOUTH_CORNER_PULL_RIGHT = 70

Enum: BlendShapeEntry

Right lip corner pulls diagonally up and out.

FT_MOUTH_CORNER_PULL_LEFT = 71

Enum: BlendShapeEntry

Left lip corner pulls diagonally up and out.

FT_MOUTH_CORNER_SLANT_RIGHT = 72

Enum: BlendShapeEntry

Right corner lip slants up.

FT_MOUTH_CORNER_SLANT_LEFT = 73

Enum: BlendShapeEntry

Left corner lip slants up.

FT_MOUTH_FROWN_RIGHT = 74

Enum: BlendShapeEntry

Right corner lip pulls down.

FT_MOUTH_FROWN_LEFT = 75

Enum: BlendShapeEntry

Left corner lip pulls down.

FT_MOUTH_STRETCH_RIGHT = 76

Enum: BlendShapeEntry

Mouth corner lip pulls out and down.

FT_MOUTH_STRETCH_LEFT = 77

Enum: BlendShapeEntry

Mouth corner lip pulls out and down.

FT_MOUTH_DIMPLE_RIGHT = 78

Enum: BlendShapeEntry

Right lip corner is pushed backwards.

FT_MOUTH_DIMPLE_LEFT = 79

Enum: BlendShapeEntry

Left lip corner is pushed backwards.

FT_MOUTH_RAISER_UPPER = 80

Enum: BlendShapeEntry

Raises and slightly pushes out the upper mouth.

FT_MOUTH_RAISER_LOWER = 81

Enum: BlendShapeEntry

Raises and slightly pushes out the lower mouth.

FT_MOUTH_PRESS_RIGHT = 82

Enum: BlendShapeEntry

Right side lips press and flatten together vertically.

FT_MOUTH_PRESS_LEFT = 83

Enum: BlendShapeEntry

Left side lips press and flatten together vertically.

FT_MOUTH_TIGHTENER_RIGHT = 84

Enum: BlendShapeEntry

Right side lips squeeze together horizontally.

FT_MOUTH_TIGHTENER_LEFT = 85

Enum: BlendShapeEntry

Left side lips squeeze together horizontally.

FT_TONGUE_OUT = 86

Enum: BlendShapeEntry

Tongue visibly sticks out of the mouth.

FT_TONGUE_UP = 87

Enum: BlendShapeEntry

Tongue points upwards.

FT_TONGUE_DOWN = 88

Enum: BlendShapeEntry

Tongue points downwards.

FT_TONGUE_RIGHT = 89

Enum: BlendShapeEntry

Tongue points right.

FT_TONGUE_LEFT = 90

Enum: BlendShapeEntry

Tongue points left.

FT_TONGUE_ROLL = 91

Enum: BlendShapeEntry

Sides of the tongue funnel, creating a roll.

FT_TONGUE_BLEND_DOWN = 92

Enum: BlendShapeEntry

Tongue arches up then down inside the mouth.

FT_TONGUE_CURL_UP = 93

Enum: BlendShapeEntry

Tongue arches down then up inside the mouth.

FT_TONGUE_SQUISH = 94

Enum: BlendShapeEntry

Tongue squishes together and thickens.

FT_TONGUE_FLAT = 95

Enum: BlendShapeEntry

Tongue flattens and thins out.

FT_TONGUE_TWIST_RIGHT = 96

Enum: BlendShapeEntry

Tongue tip rotates clockwise, with the rest following gradually.

FT_TONGUE_TWIST_LEFT = 97

Enum: BlendShapeEntry

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

FT_SOFT_PALATE_CLOSE = 98

Enum: BlendShapeEntry

Inner mouth throat closes.

FT_THROAT_SWALLOW = 99

Enum: BlendShapeEntry

The Adam's apple visibly swallows.

FT_NECK_FLEX_RIGHT = 100

Enum: BlendShapeEntry

Right side neck visibly flexes.

FT_NECK_FLEX_LEFT = 101

Enum: BlendShapeEntry

Left side neck visibly flexes.

FT_EYE_CLOSED = 102

Enum: BlendShapeEntry

Closes both eye lids.

FT_EYE_WIDE = 103

Enum: BlendShapeEntry

Widens both eye lids.

FT_EYE_SQUINT = 104

Enum: BlendShapeEntry

Squints both eye lids.

FT_EYE_DILATION = 105

Enum: BlendShapeEntry

Dilates both pupils.

FT_EYE_CONSTRICT = 106

Enum: BlendShapeEntry

Constricts both pupils.

FT_BROW_DOWN_RIGHT = 107

Enum: BlendShapeEntry

Pulls the right eyebrow down and in.

FT_BROW_DOWN_LEFT = 108

Enum: BlendShapeEntry

Pulls the left eyebrow down and in.

FT_BROW_DOWN = 109

Enum: BlendShapeEntry

Pulls both eyebrows down and in.

FT_BROW_UP_RIGHT = 110

Enum: BlendShapeEntry

Right brow appears worried.

FT_BROW_UP_LEFT = 111

Enum: BlendShapeEntry

Left brow appears worried.

FT_BROW_UP = 112

Enum: BlendShapeEntry

Both brows appear worried.

FT_NOSE_SNEER = 113

Enum: BlendShapeEntry

Entire face sneers.

FT_NASAL_DILATION = 114

Enum: BlendShapeEntry

Both nose canals dilate.

FT_NASAL_CONSTRICT = 115

Enum: BlendShapeEntry

Both nose canals constrict.

FT_CHEEK_PUFF = 116

Enum: BlendShapeEntry

Puffs both cheeks.

FT_CHEEK_SUCK = 117

Enum: BlendShapeEntry

Sucks in both cheeks.

FT_CHEEK_SQUINT = 118

Enum: BlendShapeEntry

Raises both cheeks.

FT_LIP_SUCK_UPPER = 119

Enum: BlendShapeEntry

Tucks in the upper lips.

FT_LIP_SUCK_LOWER = 120

Enum: BlendShapeEntry

Tucks in the lower lips.

FT_LIP_SUCK = 121

Enum: BlendShapeEntry

Tucks in both lips.

FT_LIP_FUNNEL_UPPER = 122

Enum: BlendShapeEntry

Funnels in the upper lips.

FT_LIP_FUNNEL_LOWER = 123

Enum: BlendShapeEntry

Funnels in the lower lips.

FT_LIP_FUNNEL = 124

Enum: BlendShapeEntry

Funnels in both lips.

FT_LIP_PUCKER_UPPER = 125

Enum: BlendShapeEntry

Upper lip part pushes outwards.

FT_LIP_PUCKER_LOWER = 126

Enum: BlendShapeEntry

Lower lip part pushes outwards.

FT_LIP_PUCKER = 127

Enum: BlendShapeEntry

Lips push outwards.

FT_MOUTH_UPPER_UP = 128

Enum: BlendShapeEntry

Raises the upper lips.

FT_MOUTH_LOWER_DOWN = 129

Enum: BlendShapeEntry

Lowers the lower lips.

FT_MOUTH_OPEN = 130

Enum: BlendShapeEntry

Mouth opens, revealing teeth.

FT_MOUTH_RIGHT = 131

Enum: BlendShapeEntry

Moves mouth right.

FT_MOUTH_LEFT = 132

Enum: BlendShapeEntry

Moves mouth left.

FT_MOUTH_SMILE_RIGHT = 133

Enum: BlendShapeEntry

Right side of the mouth smiles.

FT_MOUTH_SMILE_LEFT = 134

Enum: BlendShapeEntry

Left side of the mouth smiles.

FT_MOUTH_SMILE = 135

Enum: BlendShapeEntry

Mouth expresses a smile.

FT_MOUTH_SAD_RIGHT = 136

Enum: BlendShapeEntry

Right side of the mouth expresses sadness.

FT_MOUTH_SAD_LEFT = 137

Enum: BlendShapeEntry

Left side of the mouth expresses sadness.

FT_MOUTH_SAD = 138

Enum: BlendShapeEntry

Mouth expresses sadness.

FT_MOUTH_STRETCH = 139

Enum: BlendShapeEntry

Mouth stretches.

FT_MOUTH_DIMPLE = 140

Enum: BlendShapeEntry

Lip corners dimple.

FT_MOUTH_TIGHTENER = 141

Enum: BlendShapeEntry

Mouth tightens.

FT_MOUTH_PRESS = 142

Enum: BlendShapeEntry

Mouth presses together.

FT_MAX = 143

Enum: BlendShapeEntry

Represents the size of the BlendShapeEntry enum.

Tutorials

Source revision 4f5b14abade2
Connection interrupted. Reload×

Rejoining the server...

Rejoin failed... trying again in seconds.

Failed to rejoin.
Please retry or reload the page.

The session has been paused by the server.

Failed to resume the session.
Please retry or reload the page.