Global - Documentation

Methods

Rotate(v, a) → {Matrix}

Source:

matrix.js, line 256

Parameters:

Name	Type	Description
`v`	Vector
`a`	Number	Angle in radians or use radians(90) to translate degrees

Returns:

Type: Matrix

Scale(v) → {Matrix}

Description:

return scaled matrix

Source:

matrix.js, line 239

Parameters:

Name	Type	Description
`v`	Vector

Returns:

Type: Matrix

Translate(v) → {Matrix}

Description:

return translated matrix

Source:

matrix.js, line 223

Parameters:

Name	Type	Description
`v`	Vector

Returns:

Type: Matrix

boxForShapes()

Description:

this file defines boxes for use in ray collision bounding boxes. This type of box does not draw anything and is never meant to. To draw a box, use a cube! :)

Source:

box.js, line 9

loadBinaryStl(path) → {Mesh}

Description:

Loads a model from binary STL file

Source:

stl.js, line 29

Parameters:

Name	Type	Description
`path`	String

Returns:

Type: Mesh

loadOBJ(path) → {Mesh}

Source:

obj.js, line 11

Parameters:

Name	Type	Description
`path`	String	to obj file "./file.obj"

Returns:

Type: Mesh

loadTextSTL(path) → {Mesh}

Description:

Loads a model from text STL file

Source:

stl.js, line 121

Parameters:

Name	Type	Description
`path`	String

Returns:

Type: Mesh

newDifference(shapes) → {BooleanShape}

Description:

Subtracts following shapes from the first shape in the list

Source:

csg.js, line 25

Parameters:

Name	Type	Description
`shapes`	Shapes \| Primitives

Returns:

Type: BooleanShape

newIntersection(shapes) → {BooleanShape}

Description:

Intersects the first shape with everything after

Source:

csg.js, line 17

Parameters:

Name	Type	Description
`shapes`	Shape \| Primitives

Returns:

Type: BooleanShape

newTransformedOutlineCone(eye, up, v0, v1, radius)

Description:

Draws The outline of a cone from the perspective of camera anwhere you want it as a transformed shape

Source:

cone.js, line 143

Parameters:

Name	Type	Description
`eye`	Vector
`up`	Vector
`v0`	Vector
`v1`	Vector
`radius`	float

Returns:

New transfromed shape with outline cone of said parameters

newTransformedOutlineCylinder(eye, up, v0, v1, radius) → {TransformedShape}

Source:

cylinder.js, line 182

Parameters:

Name	Type	Description
`eye`	Vector
`up`	Vector
`v0`	Vector
`v1`	Vector
`radius`	Number

Returns:

Type: TransformedShape

randomUnitVector()

Source:

vector.js, line 8

Returns:

new Vector with Random x,y, and z normalized between 0-1

saveBinaryStl(mesh)

Description:

exports selected mesh as STL

Source:

stl.js, line 67

Parameters:

Name	Type	Description
`mesh`	Mesh	to be output