Class Wall3D

Index

Properties

Methods

[dispose] contains free new_bezier new_catmull_rom new_cone new_convex_polyhedron new_cylinder new_dodecahedron new_hexahedron new_icosahedron new_octahedron new_plane new_sphere new_tetrahedron new_torus new_trefoil newCustom

Properties

`Readonly`id

id: number

Returns the unique identifier of the wall.

Methods

[dispose]

"[dispose]"(): void
Returns void
- Defined in voronoid.d.ts:360

contains

contains(x: number, y: number, z: number): boolean
Checks if a point is contained within the wall.
Parameters
- x: number
- y: number
- z: number
Returns boolean
- Defined in voronoid.d.ts:414

free

free(): void
Returns void
- Defined in voronoid.d.ts:359

`Static`new_bezier

new_bezier(
    points: Float64Array,
    radius: number,
    resolution: number,
    closed: boolean,
    id: number,
): Wall3D
Creates a wall defined by a cubic Bezier curve tube.
Parameters
- points: Float64Array
- radius: number
- resolution: number
- closed: boolean
- id: number
Returns Wall3D
- Defined in voronoid.d.ts:364

`Static`new_catmull_rom

new_catmull_rom(
    points: Float64Array,
    radius: number,
    resolution: number,
    closed: boolean,
    id: number,
): Wall3D
Creates a wall defined by a Catmull-Rom spline tube.
Parameters
- points: Float64Array
- radius: number
- resolution: number
- closed: boolean
- id: number
Returns Wall3D
- Defined in voronoid.d.ts:394

`Static`new_cone

new_cone(
    tx: number,
    ty: number,
    tz: number,
    ax: number,
    ay: number,
    az: number,
    angle: number,
    id: number,
): Wall3D
Creates a conical wall.
Parameters
- tx: number
- ty: number
- tz: number
- ax: number
- ay: number
- az: number
- angle: number
- id: number
Returns Wall3D
- Defined in voronoid.d.ts:418

`Static`new_convex_polyhedron

new_convex_polyhedron(
    points: Float64Array,
    normals: Float64Array,
    id: number,
): Wall3D
Creates a convex polyhedron wall from a list of points and normals.
Parameters
- points: Float64Array
- normals: Float64Array
- id: number
Returns Wall3D
- Defined in voronoid.d.ts:410

`Static`new_cylinder

new_cylinder(
    cx: number,
    cy: number,
    cz: number,
    ax: number,
    ay: number,
    az: number,
    radius: number,
    id: number,
): Wall3D
Creates a cylindrical wall.
Parameters
- cx: number
- cy: number
- cz: number
- ax: number
- ay: number
- az: number
- radius: number
- id: number
Returns Wall3D
- Defined in voronoid.d.ts:382

`Static`new_dodecahedron

new_dodecahedron(
    cx: number,
    cy: number,
    cz: number,
    radius: number,
    id: number,
): Wall3D
Creates a dodecahedron wall.
Parameters
- cx: number
- cy: number
- cz: number
- radius: number
- id: number
Returns Wall3D
- Defined in voronoid.d.ts:406

`Static`new_hexahedron

new_hexahedron(
    cx: number,
    cy: number,
    cz: number,
    radius: number,
    id: number,
): Wall3D
Creates a hexahedron (cube) wall.
Parameters
- cx: number
- cy: number
- cz: number
- radius: number
- id: number
Returns Wall3D
- Defined in voronoid.d.ts:386

`Static`new_icosahedron

new_icosahedron(
    cx: number,
    cy: number,
    cz: number,
    radius: number,
    id: number,
): Wall3D
Creates an icosahedron wall.
Parameters
- cx: number
- cy: number
- cz: number
- radius: number
- id: number
Returns Wall3D
- Defined in voronoid.d.ts:398

`Static`new_octahedron

new_octahedron(
    cx: number,
    cy: number,
    cz: number,
    radius: number,
    id: number,
): Wall3D
Creates an octahedron wall.
Parameters
- cx: number
- cy: number
- cz: number
- radius: number
- id: number
Returns Wall3D
- Defined in voronoid.d.ts:390

`Static`new_plane

new_plane(
    px: number,
    py: number,
    pz: number,
    nx: number,
    ny: number,
    nz: number,
    id: number,
): Wall3D
Creates a plane wall defined by a point and a normal vector.
Parameters
- px: number
- py: number
- pz: number
- nx: number
- ny: number
- nz: number
- id: number
Returns Wall3D
- Defined in voronoid.d.ts:422

`Static`new_sphere

new_sphere(
    cx: number,
    cy: number,
    cz: number,
    radius: number,
    id: number,
): Wall3D
Creates a spherical wall.
Parameters
- cx: number
- cy: number
- cz: number
- radius: number
- id: number
Returns Wall3D
- Defined in voronoid.d.ts:374

`Static`new_tetrahedron

new_tetrahedron(
    cx: number,
    cy: number,
    cz: number,
    radius: number,
    id: number,
): Wall3D
Creates a tetrahedron wall.
Parameters
- cx: number
- cy: number
- cz: number
- radius: number
- id: number
Returns Wall3D
- Defined in voronoid.d.ts:402

`Static`new_torus

new_torus(
    cx: number,
    cy: number,
    cz: number,
    ax: number,
    ay: number,
    az: number,
    major: number,
    minor: number,
    id: number,
): Wall3D
Creates a torus wall.
Parameters
- cx: number
- cy: number
- cz: number
- ax: number
- ay: number
- az: number
- major: number
- minor: number
- id: number
Returns Wall3D
- Defined in voronoid.d.ts:426

`Static`new_trefoil

new_trefoil(
    cx: number,
    cy: number,
    cz: number,
    scale: number,
    tube_radius: number,
    resolution: number,
    id: number,
): Wall3D
Creates a trefoil knot wall.
Parameters
- cx: number
- cy: number
- cz: number
- scale: number
- tube_radius: number
- resolution: number
- id: number
Returns Wall3D
- Defined in voronoid.d.ts:378

`Static`newCustom

newCustom(val: any, id: number): Wall3D
Creates a custom wall from a JavaScript object.

The object must implement the contains(point) and cut(generator, callback) methods.
Parameters
- val: any
- id: number
Returns Wall3D
- Defined in voronoid.d.ts:370