WL

WL : object 

Wonderland Engine API

Kind: global namespace

• WL : object
  • .canvas : HTMLCanvasElement
  • .xrSession : XRSession
  • .onXRSupported : Array.<xrSupportCallback>
  • .onSceneLoaded : Array.<sceneLoadedCallback>
  • .arSupported
  • .vrSupported
  • .scene : Scene
  • .physics : Physics
  • .Type : enum
  • .Collider : enum
  • .Alignment : enum
  • .Justification : enum
  • .TextEffect : enum
  • .InputType : enum
  • .LightType : enum
  • .AnimationState : enum
  • .ForceMode : enum
  • .CollisionEventType : enum
  • .Shape : enum
  • .MeshIndexType : enum
  • .onXRSessionStart : Array.<xrSessionStartCallback>
  • .onXRSessionEnd : Array.<xrSessionEndCallback>
  • .MeshAttribute
    • .Position
    • .Tangent
    • .Normal
    • .TextureCoordinate
    • .Color
    • .JointId
    • .JointWeight
    • .SecondaryJointId
    • .SecondaryJointWeight
  • .textures
    • .load(filename, crossOrigin) ⇒ Promise.<Texture>
  • .registerComponent(name, params, object)
  • .init()
  • .reset()
  • ._initPhysics()
  • .getTempBufferU8(count) ⇒ Uint8Array
  • .getTempBufferU16(count) ⇒ Uint16Array
  • .getTempBufferU32(count) ⇒ Uint32Array
  • .getTempBufferI32(count) ⇒ Int32Array
  • .getTempBufferF32(count) ⇒ Float32Array
  • .isString(value) ⇒
  • ._wrapComponent(type, componentType, componentId) ⇒ CollisionComponent | TextComponent | ViewComponent | MeshComponent | InputComponent | LightComponent | AnimationComponent | PhysXComponent | Component
  • .CustomParameter : object
  • .xrSessionStartCallback : function
  • .xrSessionEndCallback : function
  • .xrSupportCallback : function
  • .sceneLoadedCallback : function
  • .collisionCallback : function

.canvas : HTMLCanvasElement 

Canvas element that Wonderland Engine renders to

Kind: static property of WL

.xrSession : XRSession 

Current WebXR session or null if no session active

Kind: static property of WL

.onXRSupported : Array.<xrSupportCallback> 

List of functions to call once VR/AR support has been determined.

Kind: static property of WL

.onSceneLoaded : Array.<sceneLoadedCallback> 

List of functions to call once the main scene has been loaded

Kind: static property of WL

.arSupported 

Whether AR is supported by the browser

undefined until support could be determined

Kind: static property of WL

.vrSupported 

Whether VR is supported by the browser

undefined until support could be determined

Kind: static property of WL

.scene : Scene 

Current main scene

Kind: static property of WL

.physics : Physics 

Physics, only available when physx is enabled in the runtime

Kind: static property of WL

.Type : enum 

Component parameter type enum

Kind: static enum of WL
Properties

.Collider : enum 

Collider type enum for CollisionComponent

Kind: static enum of WL
Properties

.Alignment : enum 

Alignment type enum for TextComponent

Kind: static enum of WL
Properties

.Justification : enum 

Justification type enum for TextComponent

Kind: static enum of WL
Properties

.TextEffect : enum 

Effect type enum for TextComponent

Kind: static enum of WL
Properties

.InputType : enum 

Input type enum for InputComponent

Kind: static enum of WL
Properties

.LightType : enum 

Light type enum for LightComponent

Kind: static enum of WL
Properties

.AnimationState : enum 

Animation state of AnimationComponent

Kind: static enum of WL
Properties

.ForceMode : enum 

Rigid body force mode for addForce and addTorque.

Kind: static enum of WL
Properties

.CollisionEventType : enum 

Collision callback event type

Kind: static enum of WL
Properties

.Shape : enum 

Rigid body shape.

Kind: static enum of WL
Properties

.MeshIndexType : enum 

Mesh index type

Kind: static enum of WL
Properties

.onXRSessionStart : Array.<xrSessionStartCallback> 

List of functions to call if a WebXR session is started

Kind: static constant of WL

.onXRSessionEnd : Array.<xrSessionEndCallback> 

List of functions to call if a WebXR session ends

Kind: static constant of WL

.MeshAttribute 

Mesh attribute enum

Kind: static constant of WL
Enum{number}:
0.9.0+

• .MeshAttribute
  • .Position
  • .Tangent
  • .Normal
  • .TextureCoordinate
  • .Color
  • .JointId
  • .JointWeight
  • .SecondaryJointId
  • .SecondaryJointWeight

.Position 

Position attribute, 3 floats

Kind: static property of MeshAttribute

.Tangent 

Tangent attribute, 4 floats

Kind: static property of MeshAttribute

.Normal 

Normal attribute, 3 floats

Kind: static property of MeshAttribute

.TextureCoordinate 

Texture coordinate attribute, 2 floats

Kind: static property of MeshAttribute

.Color 

Color attribute, 4 floats, RGBA, range 0 to 1

Kind: static property of MeshAttribute

.JointId 

Joint id attribute, 4 unsigned ints

Kind: static property of MeshAttribute

.JointWeight 

Joint weights attribute, 4 floats

Kind: static property of MeshAttribute

.SecondaryJointId 

Secondary joint id attribute, 4 unsigned ints

Kind: static property of MeshAttribute

.SecondaryJointWeight 

Secondary joint weights attribute, 4 floats

Kind: static property of MeshAttribute

.textures 

Access to the textures managed by Wonderland Engine

Kind: static constant of WL

.load (filename, crossOrigin) ⇒ Promise.<Texture> 

Load an image from URL as Texture

Kind: static method of textures
Returns: Promise.<Texture> - Loaded texture

.registerComponent (name, params, object) 

Register a custom JavaScript component type

Kind: static method of WL

Example

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11

registerComponent('my-new-type', {
 myParam: {type: Type.Float, default: 42.0},
}, {
 init: function() {},
 start: function() {},
 update: function(dt) {},
 onActivate: function() {},
 onDeactivate: function() {},
 // Since 0.9.0:
 onDestroy: function() {},
});

.init () 

Initialize API resources, called by the engine automatically.

Kind: static method of WL

.reset () 

Reset the runtime state, including: - Component cache - Images - Callbacks

Kind: static method of WL

._initPhysics () 

Initialize API resources, called by the engine automatically, if PhysX is enabled.

Kind: static method of WL

.getTempBufferU8 (count) ⇒ Uint8Array 

Returns a uint8 buffer view on temporary WASM memory.

Note: this method might allocate if the requested memory is bigger than the current temporary memory allocated.

Kind: static method of WL
Returns: Uint8Array - A TypedArray over the WASM memory

.getTempBufferU16 (count) ⇒ Uint16Array 

Returns a uint16 buffer view on temporary WASM memory.

Note: this method might allocate if the requested memory is bigger than the current temporary memory allocated.

Kind: static method of WL
Returns: Uint16Array - A TypedArray over the WASM memory

.getTempBufferU32 (count) ⇒ Uint32Array 

Returns a uint32 buffer view on temporary WASM memory.

Note: this method might allocate if the requested memory is bigger than the current temporary memory allocated.

Kind: static method of WL
Returns: Uint32Array - A TypedArray over the WASM memory

.getTempBufferI32 (count) ⇒ Int32Array 

Returns a int32 buffer view on temporary WASM memory.

Note: this method might allocate if the requested memory is bigger than the current temporary memory allocated.

Kind: static method of WL
Returns: Int32Array - A TypedArray over the WASM memory

.getTempBufferF32 (count) ⇒ Float32Array 

Returns a float32 buffer view on temporary WASM memory.

Note: this method might allocate if the requested memory is bigger than the current temporary memory allocated.

Kind: static method of WL
Returns: Float32Array - A TypedArray over the WASM memory

.isString (value) ⇒ 

Check if a given value is a native string or a String instance

Kind: static method of WL
Returns: true if the value has type string literal or String, false otherwise

._wrapComponent (type, componentType, componentId) ⇒ CollisionComponent | TextComponent | ViewComponent | MeshComponent | InputComponent | LightComponent | AnimationComponent | PhysXComponent | Component 

Retrieves a component instance if it exists, or create and cache a new one

Kind: static method of WL
Returns: CollisionComponent | TextComponent | ViewComponent | MeshComponent | InputComponent | LightComponent | AnimationComponent | PhysXComponent | Component - JavaScript instance wrapping the native component

.CustomParameter : object 

Kind: static typedef of WL
Properties

.xrSessionStartCallback : function 

Kind: static typedef of WL

.xrSessionEndCallback : function 

Kind: static typedef of WL

.xrSupportCallback : function 

Kind: static typedef of WL

.sceneLoadedCallback : function 

Kind: static typedef of WL

.collisionCallback : function 

Kind: static typedef of WL