Options
All
  • Public
  • Public/Protected
  • All
Menu

Mixed Reality Extension SDK

Index

Enumerations

Classes

Interfaces

Type aliases

Variables

Functions

Object literals

Type aliases

ActionHandler

ActionHandler: function

The action handler function type.

Type declaration

    • (user: User): void
    • Parameters

      Returns void

ActionState

ActionState: "started" | "stopped"

AdapterOptions

AdapterOptions: object

Adapter options

Type declaration

AnimationState

AnimationState: object

Describes an animation state.

Type declaration

AttachPoint

AttachPoint: "none" | "camera" | "head" | "neck" | "hips" | "center-eye" | "spine-top" | "spine-middle" | "spine-bottom" | "left-eye" | "left-upper-leg" | "left-lower-leg" | "left-foot" | "left-toes" | "left-shoulder" | "left-upper-arm" | "left-lower-arm" | "left-hand" | "left-thumb" | "left-index" | "left-middle" | "left-ring" | "left-pinky" | "right-eye" | "right-upper-leg" | "right-lower-leg" | "right-foot" | "right-toes" | "right-shoulder" | "right-upper-arm" | "right-lower-arm" | "right-hand" | "right-thumb" | "right-index" | "right-middle" | "right-ring" | "right-pinky"

The complete set of attach points.

BehaviorType

BehaviorType: "none" | "target" | "button"

These are the behavior types available to set on an actor.

ColliderGeometry

All collider parameter types.

ColliderType

ColliderType: "auto" | "box" | "sphere" | "capsule"

The type of the collider.

CollisionEventState

CollisionEventState: "enter" | "exit"

The collision state for the collsion event.

CollisionEventType

CollisionEventType: "collision-enter" | "collision-exit"

The collision events that can be raised on a collider.

CollisionHandler

CollisionHandler: function

The collision handler to be called when a collision event occurs.

param

The collision data associated with the collision.

Type declaration

CreateAnimationOptions

CreateAnimationOptions: object

Parameters to the actor.createAnimation call.

Type declaration

CreateColliderType

CreateColliderType: ColliderType | "none"

LightType

LightType: "spot" | "point"

MultipeerAdapterOptions

MultipeerAdapterOptions: AdapterOptions & object

Multi-peer adapter options

SetAnimationStateOptions

SetAnimationStateOptions: object

Parameters to the actor.setAnimationState call.

Type declaration

SetAudioStateOptions

SetAudioStateOptions: object

Parameters to the Actor.startSound call.

Type declaration

SetMediaStateOptions

Parameters to the MediaInstance.setState call.

SetVideoStateOptions

SetVideoStateOptions: object

Parameters to the Actor.startVideoStream call.

Type declaration

SubscriptionType

SubscriptionType: "transform" | "rigidbody" | "collider"

A type representing the different parts of an Actor that can be subscribed to. When subscribed, the Actor will receive updates when corresponding changes occur on the host.

TraceSeverity

TraceSeverity: "debug" | "info" | "warning" | "error"

Defines different log severity levels.

TriggerEventType

TriggerEventType: "trigger-enter" | "trigger-exit"

The trigger events that can be raised on a collider.

TriggerHandler

TriggerHandler: function

The trigger handler to be called whan an actor has entered or exited a trigger volume.

param

The other actor that has entered the trigger volume.

Type declaration

    • (otherActor: Actor): void
    • Parameters

      Returns void

WebSocketAdapterOptions

WebSocketAdapterOptions: AdapterOptions

WebSocket Adapter options.

Variables

Const DegreesToRadians

DegreesToRadians: number = Math.PI / 180.0

Constant used to convert an angle value in degrees to radians

Const Epsilon

Epsilon: 0.001 = 0.001

Constant used to define the minimal number value in Babylon.js

ignorenaming

Const RadiansToDegrees

RadiansToDegrees: number = 180.0 / Math.PI

Constant used to convert an anglevalue radians to degrees

Const ToGammaSpace

ToGammaSpace: number = 1 / 2.2

Constant used to convert a value to gamma space

ignorenaming

Const ToLinearSpace

ToLinearSpace: 2.2 = 2.2

Constant used to convert a value to linear space

ignorenaming

Const ZeroGuid

ZeroGuid: "00000000-0000-0000-0000-000000000000" = "00000000-0000-0000-0000-000000000000"

Const log

log: Log = new Log()

Functions

safeAccessPath

  • safeAccessPath(obj: any, ...path: any[]): any

Object literals

Const AnimationEaseCurves

AnimationEaseCurves: object

Predefined ease curves from https://easings.net/. Curve shapes can be previewed there. Create your own at http://cubic-bezier.com. Note: Curves that end with "Back" include some overshoot.

EaseInBack

EaseInBack: number[] = [0.6, -0.28, 0.735, 0.045]

EaseInCircular

EaseInCircular: number[] = [0.6, 0.04, 0.98, 0.335]

EaseInCubic

EaseInCubic: number[] = [0.55, 0.055, 0.675, 0.19]

EaseInExponential

EaseInExponential: number[] = [0.95, 0.05, 0.795, 0.035]

EaseInOutBack

EaseInOutBack: number[] = [0.68, -0.55, 0.265, 1.55]

EaseInOutCircular

EaseInOutCircular: number[] = [0.785, 0.135, 0.15, 0.86]

EaseInOutCubic

EaseInOutCubic: number[] = [0.645, 0.045, 0.355, 1]

EaseInOutExponential

EaseInOutExponential: number[] = [1, 0, 0, 1]

EaseInOutQuadratic

EaseInOutQuadratic: number[] = [0.455, 0.03, 0.515, 0.955]

EaseInOutQuartic

EaseInOutQuartic: number[] = [0.77, 0, 0.175, 1]

EaseInOutQuintic

EaseInOutQuintic: number[] = [0.86, 0, 0.07, 1]

EaseInOutSine

EaseInOutSine: number[] = [0.445, 0.05, 0.55, 0.95]

EaseInQuadratic

EaseInQuadratic: number[] = [0.55, 0.085, 0.68, 0.53]

EaseInQuartic

EaseInQuartic: number[] = [0.895, 0.03, 0.685, 0.22]

EaseInQuintic

EaseInQuintic: number[] = [0.755, 0.05, 0.855, 0.06]

EaseInSine

EaseInSine: number[] = [0.47, 0, 0.745, 0.715]

EaseOutBack

EaseOutBack: number[] = [0.175, 0.885, 0.32, 1.275]

EaseOutCircular

EaseOutCircular: number[] = [0.075, 0.82, 0.165, 1]

EaseOutCubic

EaseOutCubic: number[] = [0.215, 0.61, 0.355, 1]

EaseOutExponential

EaseOutExponential: number[] = [0.19, 1, 0.22, 1]

EaseOutQuadratic

EaseOutQuadratic: number[] = [0.25, 0.46, 0.45, 0.94]

EaseOutQuartic

EaseOutQuartic: number[] = [0.165, 0.84, 0.44, 1]

EaseOutQuintic

EaseOutQuintic: number[] = [0.23, 1, 0.32, 1]

EaseOutSine

EaseOutSine: number[] = [0.39, 0.575, 0.565, 1]

Linear

Linear: number[] = [0, 0, 1, 1]