Type Definitions

CircleJSON

json object to configure Circle of https://www.npmjs.com/package/detect-collisions

Type:
  • object
Properties
NameTypeDescription
typestring

to identify this is a Circle must be equal to "Circle"

centerObject

center of the circle

radiusnumber

radius of the circle

CommandCallback(data) → {boolean}

Parameters:
NameTypeDescription
dataobject

command data

Returns:

if true the command is removed from context.commands

Type: 
boolean

ContextListener(params)

Parameters:
NameTypeDescription
params*

params pass when event is dispatched

Object3DCondition(object) → {boolean}

Parameters:
NameTypeDescription
objectObject3D

object3d to test

Returns:
  • true object3d match condition
Type: 
boolean

PolygonJSON

json object to configure Polygon of https://www.npmjs.com/package/detect-collisions

Type:
  • object
Properties
NameTypeDescription
typestring

to identify this is a Polygon must be equal to "Polygon"

pointsArray.<{x, y}>

points of the polygon

ScriptParams

Type:
  • object
Properties
NameTypeDescription
idstring

id of the script

prioritynumber

influence order in which scripts are executed

TraverseCallback(object3D)

Parameters:
NameTypeDescription
object3DObject3D

the object3D traversed