Repository

References

Mobilizing/core

summary
public

The generic componment class.

public

ComponentProxy is a proxy that converts (like a kind of casting) scripts into Mobilizing Components.

public
public

A runner is used to instanciate a Mobilizing.js user's script inside a specific context. It is requiered to use a Runner to initiate a context and to attech a script to it.

Mobilizing/core/context

summary
public

A class to instanciate a Mobilizing Context with prebuild elements.

public

A class to instanciate a Mobilizing Context with mutliple script support.

Mobilizing/core/util

summary
public

Device class gives easy access to some device information such as the operating system and browser used

public

EventEmitter is a helper class to handle event emission

public

A loader class that manage the loading of datas from url.

public

Copyright (c) 2011, Daniel Guerrero All rights reserved.

public
public

F error()

public

F info()

public

F log()

public

F warn()

public

F getElementPosition(el: Element): Object

Get an element's position within the document taking into account the scroll positions

public

F clamp(value: Number, min: Number, max: Number): *

Clamp a value between a minimum and a maximum

public

F degToRad(val: float): *

Converts degrees to radians

public

F dist(x1: float, y1: float, x2: float, y2: float): *

Calculates the distance between two 2D points

public

F intersectionPoint(line1: Array, line2: Array): {"x": *, "y": *}

Intersection Point between 2 points

public

F lerp(value: float, dest: float, amount: float): *

Lerps a value to the destination value with the given amount

public

F map(value: float, low1: float, high1: float, low2: float, high2: float): *

Maps a number between 2 sets of float values

public

F pointIsInside(x: Number, y: Number, points: Vector2 Array): *

Finds if a point is inside an array of vertices

public

F radToDeg(val: float): *

Converts radians to degrees

public

F randomFromTo(from: float, to: float): *

Generates a random number between 2 float values

public

F cloneObject(object: *): *

public

F encode64(inputStr: *): *

Method to convert a string to Base64.

public

F getFileExtension(url: *): *

public

Extract the MimeType from the URL string of image files.

public

F getUrlParameter(sParam: *): String

function to get the parameters of the url

public

F isObject(item: any): boolean

Simple object check.

public

F noop(): null

A function that return null as a value

public

F stringToArrayBuffer(str: DOMString): ArrayBuffer

Converts a DOMString to an ArrayBuffer (raw data binary).

public

F throttle(fn: Function, threshhold: Number, scope: Object): Function

Returns a throttled version of a function The returned function will only call the original function at most once per the specified threshhold

public

F uuid(len: Integer, radix: Integer): String

Generate a random uuid

Mobilizing/input

summary
public

C GPS

public

Some GPS coordinates convertion tools to use maps in Mobilizing.js

public
public

C Keyboard(params: Object)

Simple mapping from HTLM keyboard events toward Mobilizing.js.

public
public

Give simple access to mouse events

public

Uses built-in compass and/or gyroscope to produce orientation Data.

public

Pointer is an abstraction that enables various input devices to send the same kind of events.

public

Touch give an interface to access the multitouch events of the device.

public

UserMedia class give access to navigator.mediaDevices.getUserMedia with various simplification of access

Mobilizing/misc

summary
public

The Animation class provides a simple way to tween object properties

public

Component to monitor battery status changes

public

V Raleway: {"regular": string, "italic": string, "bold": string, "boldItalic": string}

Mobilizing/net

summary
public

Ajax is a helper class used to simplify the use of the XMLHttpRequest API

public

PubSub is a publish-subscribe messaging system based on socket.io It allows simple socket communication between different clients An runing instance of MobilizingServer is required to make this work

public

Storage is a client for the Storage server It allows remote persistant storage A runing instance of the Storage server is required to make this work

Mobilizing/renderer/2D/Dom

summary
public

RendererDOM is a Three js based renderer.

Mobilizing/renderer/3D

summary
public

Mobilizing/renderer/3D/three/physics

summary
public

Mobilizing/renderer/3D/three/scene

summary
public

Camera class.

public

Light will enable object to be seen in space.

public

A material will give color and some effect to the surface of the 3D object.

public

Simple wrapper around Three Scene.

public

Mobilizing/renderer/3D/three/shape

summary
public

A Mesh is the aggregation of a geomtery, made of vertices (Vector3 Array), texture coordinates (or uv, Vector2 Array), vertexColor (Color Array) and various methods to create and modify 3D objects that have a material (see {{#crossLink "Material"}}{{/crossLink}}) and a transform (see {{#crossLink "Transform"}}{{/crossLink}}).

Mobilizing/renderer/3D/three/shape/2D

summary
public

C Arc

public
public
public

Mobilizing/renderer/3D/three/shape/3D/composite

summary
public

EdgesMesh class creates a hiddenline fashioned Mesh from any other Mesh.

public

OutlineMesh class creates a hiddenline fashioned Mesh from any other Mesh.

public

3D Text is created from a typeface represented in JSON, please use facetype.js to generate a JSON from a font file.

public

3D Text is created from a standard font file compatible with opentype.js.

Mobilizing/renderer/3D/three/shape/3D/parser

summary
public
public

C OBJ

OBJ class gives easy access to some calculations specific to OBJs.

public

C XYZ

XYZ file parser

Mobilizing/renderer/3D/three/shape/3D/primitive

summary
public

C Box

public
public
public
public
public
public

A node is an empty 3D object.

public
public
public
public
public
public

Mobilizing/renderer/3D/three/texture

summary
public
public
public

Texture are bitmap pictures loaded in the graphic card memory so they can be mapped on a geometry surface.

public

Mobilizing/renderer/3D/three/types

summary
public

Represents a RGB color to be used in materials applied on Meshes.

public

This class extends the one from Three.js, API available here : https://threejs.org/docs/index.html#api/en/math/Euler

public
public

This class extends the one from Three.js, API available here : https://threejs.org/docs/index.html#api/en/math/Matrix3

public

This class extends the one from Three.js, API available here : https://threejs.org/docs/index.html#api/en/math/Matrix4

public

Represents a Quaternion, a way to describe a spatial rotation that is less susceptible to gimbal lock.

public

C Ray

A ray that emits from an origin in a certain direction.

public
public

Represents a 2 dimensionnal Euclidean Vector, to be used as 2D positions, 2D directions or 2D Euler angles (rotation).

public

Represents a 3 dimensionnal Euclidean Vector, to be used as positions, directions or Euler angles (rotation).

Mobilizing/renderer/3D/three/ui

summary
public
public
public
public
public

Mobilizing/renderer/audio

summary
public
public
public
public

Renderer is a Web Audio API based renderer for playing sound.

public

Source Class.

Mobilizing/serial

summary
public

Mobilizing/text

summary
public

To be able to use both bitmap rendered font and 3D vector rendering, we use openType.js (https://nodebox.github.io/opentype.js/ big thanks to Frederik!) to load any web compilant font and the use it in other classes.

public
public

StyledLetter is a class that helps to represents a letter with its style for later drawing.

public

StyledTextElement is a simple class to organise text elements extacted from HTML text.

public
public

Mobilizing/time

summary
public

The Time class provides methods to control time related operations.

public

A timer is a time manager that gives the possibily to schedule a function every <i>n</i> ms.