modeling/extrusions/slice

Represents a 3D geometry consisting of a list of edges.

Source:

modeling/src/operations/extrusions/slice/index.js, line 1

See:

slice for data structure information.

Methods

(static) calculatePlane(slice) → {plane}

Source:

modeling/src/operations/extrusions/slice/calculatePlane.js, line 14

Calculate the plane of the given slice. NOTE: The slice (and all points) are assumed to be planar from the beginning.

Example

let myplane = calculatePlane(slice)

Parameters:

Name	Type	Description
`slice`	slice	the slice

Returns:

the plane of the slice

Type: plane

(static) clone(outopt, slice) → {slice}

Source:

modeling/src/operations/extrusions/slice/clone.js, line 13

Create a deep clone of the given slice.

Parameters:

Name	Type	Attributes	Description
`out`	slice	<optional>	receiving slice
`slice`	slice		slice to clone

Returns:

a new slice

Type: slice

(static) create() → {slice}

Source:

modeling/src/operations/extrusions/slice/create.js, line 13

Creates a new empty slice.

Returns:

a new slice

Type: slice

(static) equals(a, b) → {Boolean}

Source:

modeling/src/operations/extrusions/slice/equals.js, line 10

Determine if the given slices have the same edges.

Parameters:

Name	Type	Description
`a`	slice	the first slice to compare
`b`	slice	the second slice to compare

Returns:

true if the slices are equal

Type: Boolean

(static) fromPoints(points) → {slice}

Source:

modeling/src/operations/extrusions/slice/fromPoints.js, line 20

Create a slice from the given points.

Example

const points = [
  [0,  0],
  [0, 10],
  [0, 10]
]
const slice = fromPoints(points)

Parameters:

Name	Type	Description
`points`	Array	list of points, where each point is either 2D or 3D

Returns:

a new slice

Type: slice

(static) fromSides(sides) → {slice}

Source:

modeling/src/operations/extrusions/slice/fromSides.js, line 16

Create a slice from the given sides (see geom2).

Example

const myshape = circle({radius: 10})
const slice = fromSides(geom2.toSides(myshape))

Parameters:

Name	Type	Description
`sides`	Array	list of sides from geom2

Returns:

a new slice

Type: slice

(static) isA(object) → {Boolean}

Source:

modeling/src/operations/extrusions/slice/isA.js, line 7

Determine if the given object is a slice.

Parameters:

Name	Type	Description
`object`	slice	the object to interrogate

Returns:

true if the object matches a slice

Type: Boolean

(static) reverse(outopt, slice) → {slice}

Source:

modeling/src/operations/extrusions/slice/reverse.js, line 11

Reverse the edges of the given slice.

Parameters:

Name	Type	Attributes	Description
`out`	slice	<optional>	receiving slice
`slice`	slice		slice to reverse

Returns:

reverse of the slice

Type: slice

(static) toEdges(slice) → {Array}

Source:

modeling/src/operations/extrusions/slice/toEdges.js, line 11

Produces an array of edges from the given slice. The returned array should not be modified as the data is shared with the slice.

Example

let sharededges = toEdges(slice)

Parameters:

Name	Type	Description
`slice`	slice	the slice

Returns:

an array of edges, each edge contains an array of two points (3D)

Type: Array

(static) toPolygons(slice) → {Array}

Source:

modeling/src/operations/extrusions/slice/toPolygons.js, line 11

Return a list of polygons which are enclosed by the slice.

Parameters:

Name	Type	Description
`slice`	slice	the slice

Returns:

a list of polygons (3D)

Type: Array

(static) toString(slice) → {String}

Source:

modeling/src/operations/extrusions/slice/toString.js, line 13

Parameters:

Name	Type	Description
`slice`	slice	the slice

Returns:

the string representation

Type: String

(static) transform(matrix, slice) → {slice}

Source:

modeling/src/operations/extrusions/slice/transform.js, line 16

Transform the given slice using the given matrix.

Example

let matrix = mat4.fromTranslation([1, 2, 3])
let newslice = transform(matrix, oldslice)

Parameters:

Name	Type	Description
`matrix`	mat4	transform matrix
`slice`	slice	slice to transform

Returns:

the transformed slice

Type: slice