Class default

The Matter.Common module contains utility functions that are common to all modules.

Hierarchy

default

Index

Constructors

constructor

new default(): default
Returns default

Properties

`Static` _baseDelta

_baseDelta: number = ...

`Static` `Protected` _decomp

_decomp: null = null

`Static` `Protected` _nextId

_nextId: number = 0

`Static` `Protected` _nowStartTime

_nowStartTime: number = +new Date()

`Static` `Protected` _seed

_seed: number = 0

`Static` `Protected` _warnedOnce

_warnedOnce: Record<string, boolean> = {}

`Static` logLevel

logLevel: LogLevel = LogLevel.Debug

The console logging level to use, where each level includes all levels above and excludes the levels below. The default level is 'debug' which shows all console messages.

Methods

`Static` `Protected` _seededRandom

_seededRandom(): number
Returns number
- Defined in src/core/Common.ts:87

`Static` `Protected` _topologicalSort

_topologicalSort<T>(node, visited, temp, graph, result): void
Type Parameters
- T extends ObjectLike<any[]>
Parameters
- node: keyof T
- visited: Record<keyof T, boolean>
- temp: Record<keyof T, boolean>
- graph: T
- result: (keyof T)[]
Returns void
- Defined in src/core/Common.ts:463

`Static` chain

chain(...params): Function
Takes n functions as arguments and returns a new function that calls them in order. The arguments applied when calling the new function will also be applied to every function passed. The value of this refers to the last value returned in the chain that was not undefined. Therefore if a passed function does not return a value, the previously returned value is maintained. After all passed functions have been called the new function returns the last returned value (if any). If any of the passed functions are a chain, then the chain will be flattened.
Parameters
- Rest ...params: Function[]
  
  The functions to chain.
Returns Function
A new function that calls the passed functions in order.
- Defined in src/core/Common.ts:500

`Static` chainPathAfter

chainPathAfter<T>(base, path, func): T[keyof T]
Chains a function to excute after the original function on the given path relative to base. See also docs for Common.chain.
Type Parameters
- T extends Record<string, any>
Parameters
- base: T
  
  The base object
- path: string
  
  The path relative to base
- func: Function
  
  The function to chain after the original
Returns T[keyof T]
The chained function that replaced the original
- Defined in src/core/Common.ts:564

`Static` chainPathBefore

chainPathBefore<T>(base, path, func): Function
Chains a function to excute before the original function on the given path relative to base. See also docs for Common.chain.
Type Parameters
- T extends ObjectLike<any>
Parameters
- base: T
  
  The base object
- path: string
  
  The path relative to base
- func: Function
  
  The function to chain before the original
Returns Function
The chained function that replaced the original
- Defined in src/core/Common.ts:540

`Static` choose

choose<T>(choices): T
Randomly chooses a value from a list with equal probability. The function uses a seeded random generator.
Type Parameters
- T
Parameters
- choices: T[]
Returns T
A random choice object from the array
- Defined in src/core/Common.ts:158

`Static` clamp

clamp(value, min, max): number
Returns the given value clamped between a minimum and maximum value.
Parameters
- value: number
- min: number
- max: number
Returns number
The value clamped between min and max inclusive
- Defined in src/core/Common.ts:116

`Static` clone

clone<T>(obj, deep?): T
Creates a new clone of the object, if deep is true references will also be cloned.
Type Parameters
- T extends ObjectLike<any>
Parameters
- obj: T
- Optional deep: boolean
Returns T
obj cloned
- Defined in src/core/Common.ts:358

`Static` colorToNumber

colorToNumber(colorString): number
Parameters
- colorString: string
Returns number
- Defined in src/core/Common.ts:93

`Static` deprecated

deprecated<T>(obj, prop, warning): void
Shows a deprecated console warning when the function on the given object is called. The target function will be replaced with a new function that first shows the warning and then calls the original function.
Type Parameters
- T extends ObjectLike<Function>
Parameters
- obj: T
  
  The object or module
- prop: keyof T
- warning: string
  
  The one-time message to show if the function is called
Returns void
- Defined in src/core/Common.ts:385

`Static` extend

extend<T, E>(obj, deep?, ...params): T & E
Extends the object in the first argument using the object in the second argument.
Type Parameters
- T extends ObjectLike<any>
- E extends ObjectLike<any>
Parameters
- obj: T
- Optional deep: boolean | E
- Rest ...params: E[]
Returns T & E
obj extended
- Defined in src/core/Common.ts:289
extend<T>(obj, deep?, ...params): T
Type Parameters
- T extends ObjectLike<any>
Parameters
- obj: DeepPartial<T>
- Optional deep: boolean | T
- Rest ...params: T[]
Returns T
- Defined in src/core/Common.ts:294
extend<T>(obj, deep?, ...params): T
Type Parameters
- T extends ObjectLike<any>
Parameters
- obj: T
- Optional deep: boolean | DeepPartial<T>
- Rest ...params: DeepPartial<T>[]
Returns T
- Defined in src/core/Common.ts:299

`Static` get

get<T>(obj, path, begin?, end?): T
Gets a value from base relative to the path string.
Type Parameters
- T extends ObjectLike<any>
Parameters
- obj: T
  
  The base object
- path: string
  
  The path relative to base, e.g. 'Foo.Bar.baz'
- Optional begin: number
  
  Path slice begin
- Optional end: number
  
  Path slice end
Returns T
The object at the given path
- Defined in src/core/Common.ts:249

`Static` getDecomp

getDecomp(): any
Returns the poly-decomp library module provided through Common.setDecomp, otherwise returns the global decomp if set.

Returns any
The poly-decomp library module if provided.
- Defined in src/core/Common.ts:594

`Static` info

info(...params): void
Shows a console.info message only if the current Common.logLevel allows it. The message will be prefixed with 'matter-ts' to make it easily identifiable.
Parameters
- Rest ...params: string[]
  
  The objects to log.
Returns void
- Defined in src/core/Common.ts:400

`Static` isArray

isArray<T>(obj): obj is T[]
Returns true if the object is an array.
Type Parameters
- T
Parameters
- obj: T | T[]
Returns obj is T[]
True if the object is an array, otherwise false

Method
isArray
- Defined in src/core/Common.ts:169

`Static` isElement

isElement(obj): obj is HTMLElement
Returns true if the object is a HTMLElement, otherwise false.
Parameters
- obj: any
Returns obj is HTMLElement
True if the object is a HTMLElement, otherwise false

Method
isElement
- Defined in src/core/Common.ts:190

`Static` isObject

isObject(value): value is ObjectLike<any>
Returns true if the object is an Object.
Parameters
- value: unknown
Returns value is ObjectLike<any>
True if the object is an Object, otherwise false

Method
isObject
- Defined in src/core/Common.ts:179

`Static` keys

keys<T>(obj): (keyof T)[]
Returns the list of keys for the given object.
Type Parameters
- T extends ObjectLike<any>
Parameters
- obj: T
Returns (keyof T)[]
keys

Method
keys
- Defined in src/core/Common.ts:204

`Static` log

log(...params): void
Shows a console.log message only if the current Common.logLevel allows it. The message will be prefixed with 'matter-ts' to make it easily identifiable.
Parameters
- Rest ...params: string[]
  
  The objects to log.
Returns void
- Defined in src/core/Common.ts:367

`Static` nextId

nextId(): number
Returns number
- Defined in src/core/Common.ts:58

`Static` now

now(): number
Returns the current timestamp since the time origin (e.g. from page load). The result is in milliseconds and will use high-resolution timing if available.

Returns number
the current timestamp in milliseconds

Method
now
- Defined in src/core/Common.ts:68

`Static` random

random(min?, max?): number
Parameters
- min: number = 0
- max: number = 1
Returns number
- Defined in src/core/Common.ts:83

`Static` set

set<T>(obj, path, val, begin?, end?): T
Sets a value on base relative to the given path string.
Type Parameters
- T
Parameters
- obj: ObjectLike<T>
  
  The base object
- path: string
  
  The path relative to base, e.g. 'Foo.Bar.baz'
- val: T
  
  The value to set
- Optional begin: number
  
  Path slice begin
- Optional end: number
  
  Path slice end
Returns T
Pass through val for chaining
- Defined in src/core/Common.ts:271

`Static` setDecomp

setDecomp(decomp): void
Provide the poly-decomp library module to enable concave vertex decomposition support when using Bodies.fromVertices e.g. Common.setDecomp(require('poly-decomp')).
Parameters
- decomp: any
  
  The poly-decomp library module.
Returns void
- Defined in src/core/Common.ts:584

`Static` shuffle

shuffle<T>(array): T[]
Shuffles the given array in-place. The function uses a seeded random generator.
Type Parameters
- T
Parameters
- array: T[]
Returns T[]
array shuffled randomly
- Defined in src/core/Common.ts:142

`Static` sign

sign(value): 1 | -1
Returns the sign of the given value.
Parameters
- value: number
Returns 1 | -1
-1 if negative, +1 if 0 or positive

Method
sign
- Defined in src/core/Common.ts:132

`Static` topologicalSort

topologicalSort<T>(graph): (keyof T)[]
Takes a directed graph and returns the partially ordered set of vertices in topological order. Circular dependencies are allowed.
Type Parameters
- T extends ObjectLike<any[]>
Parameters
- graph: T
Returns (keyof T)[]
Partially ordered set of vertices in topological order.
- Defined in src/core/Common.ts:443

`Static` values

values<T>(obj): T[]
Returns the list of values for the given object.
Type Parameters
- T
Parameters
- obj: ObjectLike<T>
Returns T[]
Array of the objects property values

Method
values
- Defined in src/core/Common.ts:223

`Static` warn

warn(...params): void
Shows a console.warn message only if the current Common.logLevel allows it. The message will be prefixed with 'matter-js' to make it easily identifiable.
Parameters
- Rest ...params: string[]
  
  The objects to log.
Returns void
- Defined in src/core/Common.ts:414

`Static` warnOnce

warnOnce(...params): void
Uses Common.warn to log the given message one time only.
Parameters
- Rest ...params: string[]
  
  The objects to log.
Returns void
- Defined in src/core/Common.ts:428

Class default

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Returns default

Properties

Static _baseDelta

Static Protected _decomp

Static Protected _nextId

Static Protected _nowStartTime

Static Protected _seed

Static Protected _warnedOnce

Static logLevel

Methods

Static Protected _seededRandom

Returns number

Static Protected _topologicalSort

Type Parameters

T extends ObjectLike<any[]>

Parameters

node: keyof T

visited: Record<keyof T, boolean>

temp: Record<keyof T, boolean>

graph: T

result: (keyof T)[]

Returns void

Static chain

Parameters

Rest ...params: Function[]

Returns Function

Static chainPathAfter

Type Parameters

T extends Record<string, any>

Parameters

base: T

path: string

func: Function

Returns T[keyof T]

Static chainPathBefore

Type Parameters

T extends ObjectLike<any>

Parameters

base: T

path: string

func: Function

Returns Function

Static choose

Type Parameters

T

Parameters

choices: T[]

Returns T

Static clamp

Parameters

value: number

min: number

max: number

Returns number

Static clone

Type Parameters

T extends ObjectLike<any>

Parameters

obj: T

Optional deep: boolean

Returns T

Static colorToNumber

Parameters

colorString: string

Returns number

Static deprecated

Type Parameters

T extends ObjectLike<Function>

Parameters

obj: T

prop: keyof T

warning: string

`Static` _baseDelta

`Static` `Protected` _decomp

`Static` `Protected` _nextId

`Static` `Protected` _nowStartTime

`Static` `Protected` _seed

`Static` `Protected` _warnedOnce

`Static` logLevel

`Static` `Protected` _seededRandom

`Static` `Protected` _topologicalSort

`Static` chain

`Rest` ...params: Function[]

`Static` chainPathAfter

`Static` chainPathBefore

`Static` choose

`Static` clamp

`Static` clone

`Optional` deep: boolean

`Static` colorToNumber

`Static` deprecated

`Static` extend

`Optional` deep: boolean | E

`Rest` ...params: E[]

`Optional` deep: boolean | T

`Rest` ...params: T[]

`Optional` deep: boolean | DeepPartial<T>

`Rest` ...params: DeepPartial<T>[]

`Static` get

`Optional` begin: number

`Optional` end: number

`Static` getDecomp

`Static` info

`Rest` ...params: string[]

`Static` isArray

`Static` isElement

`Static` isObject

`Static` keys

`Static` log

`Rest` ...params: string[]

`Static` nextId

`Static` now