Members
(constant) AnimationTypes :Class
Enum for animation state classes.
Type:
- Class
(constant) AxisMap :Class
Enum for axis directions.
Type:
- Class
Properties:
| Name | Type | Description |
|---|---|---|
PositiveX |
Class | |
NegativeX |
Class | |
PositiveY |
Class | |
NegativeY |
Class | |
PositiveZ |
Class | |
NegativeZ |
Class |
(constant) Back :EasingObject
Back Easing
Type:
(constant) Bounce :EasingObject
Bounce Easing
Type:
(constant) Circular :EasingObject
Circular Easing
Type:
(constant) Cubic :EasingObject
Cubic Easing
Type:
(constant) DefaultGestureWords
(constant) DefaultLayerBlendMode :string
The default blending mode AnimationLayer.
Type:
- string
(constant) DefaultVisemeMap
Default mapping of Polly viseme names to animation options objects.
Properties:
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
sil |
Object |
<optional> |
{name: 'sil'} | |
p |
Object |
<optional> |
{name: 'p', overrideWeight: 0.9} | |
t |
Object |
<optional> |
{name: 't', blendTime: 0.2} | |
S |
Object |
<optional> |
{name: 'S'} | |
T |
Object |
<optional> |
{name: 'T'} | |
f |
Object |
<optional> |
{name: 'f', overrideWeight: 0.75} | |
k |
Object |
<optional> |
{name: 'k'} | |
i |
Object |
<optional> |
{name: 'i'} | |
r |
Object |
<optional> |
{name: 'r'} | |
s |
Object |
<optional> |
{name: 's', blendTime: 0.25} | |
u |
Object |
<optional> |
{name: 'u'} | |
@ |
Object |
<optional> |
{name: '@'} | |
a |
Object |
<optional> |
{name: 'a'} | |
e |
Object |
<optional> |
{name: 'e', blendTime: 0.2} | |
E |
Object |
<optional> |
{name: 'E'} | |
o |
Object |
<optional> |
{name: 'o'} | |
O |
Object |
<optional> |
{name: 'O'} |
(constant) Elastic :EasingObject
Elastic Easing
Type:
(constant) env :string
Indicates the type of host build.
Type:
- string
(constant) Exponential :EasingObject
Exponential Easing
Type:
(constant) LayerBlendModes :string
Enum for types of AnimationLayer blending.
Type:
- string
(constant) Linear :EasingObject
Linear Easing
Type:
(constant) Quadratic :EasingObject
Quadratic Easing
Type:
(constant) Quartic :EasingObject
Quartic Easing
Type:
(constant) Quintic :EasingObject
Quintic Easing
Type:
(constant) Sinusoidal :EasingObject
Sinusoidal Easing
Type:
Methods
validateBlendMode(blendMode) → {string|DefaultLayerBlendMode}
Checks if a given blendMode is present in the values of LayerBlendModes.
If it is, return the original value, otherwise return DefaultLayerBlendMode.
Parameters:
| Name | Type | Description |
|---|---|---|
blendMode |
string | The name of the type of blending. |
Returns:
- Type
- string | DefaultLayerBlendMode
Type Definitions
EasingObject
Object containing easing functions
Type:
- Object
Properties:
| Name | Type | Description |
|---|---|---|
In |
function | Easing 'In' function. Should use the signature (k:number):number. |
Out |
function | Easing 'Out' function. Should use the signature (k:number):number. |
InOut |
function | Easing 'InOut' function. Should use the signature (k:number):number. |
SumerianAnimationsConfig
Type:
- Object
Properties:
| Name | Type | Description |
|---|---|---|
animStandIdleUrl |
string | |
animLipSyncUrl |
string | |
animGestureUrl |
string | |
animEmoteUrl |
string | |
animFaceIdleUrl |
string | |
animBlinkUrl |
string | |
animPointOfInterestUrl |
string |
SumerianCharacterConfig
Type:
- Object
Properties:
| Name | Type | Description |
|---|---|---|
modelUrl |
string | The path to the .gltf file |
gestureConfigUrl |
string | |
pointOfInterestConfigUrl |
string | |
animUrls |
SumerianAnimationsConfig |
SumerianHostLoadedAssets
Type:
- Object
Properties:
| Name | Type | Description |
|---|---|---|
characterMesh |
Mesh | The loaded character mesh |
animClips |
SumerianLoadedAnimations | The loaded animations |
bindPoseOffset |
AnimationGroup | |
gestureConfig |
Object | see "3d-assets/animations/adult_female/gesture.json" for reference |
poiConfig |
Object | see "3d-assets/animations/adult_female/poi.json" for reference |
SumerianLoadedAnimation
Type:
- Object
Properties:
| Name | Type | Description |
|---|---|---|
clipGroupId |
string | |
clips |
Array.<AnimationGroup> |
SumerianLoadedAnimations
Type:
- Object
Properties:
| Name | Type | Description |
|---|---|---|
idleClips |
Array.<AnimationGroup> | |
lipSyncClips |
Array.<AnimationGroup> | |
gestureClips |
Array.<AnimationGroup> | |
emoteClips |
Array.<AnimationGroup> | |
faceClips |
Array.<AnimationGroup> | |
blinkClips |
Array.<AnimationGroup> | |
poiClips |
Array.<AnimationGroup> |
SumerianPollyConfig
Type:
- Object
Properties:
| Name | Type | Attributes | Description |
|---|---|---|---|
pollyClient |
AWS.Polly |
<optional> |
The reference to the Polly service client to use. |
pollyPresigner |
AWS.Polly.presigner |
<optional> |
The reference to the Polly presigner to use. |
pollyVoice |
string | The Polly voice to use. See |
|
pollyEngine |
string | The Polly engine you would like to |