Class PyramidMesh

A procedural pyramid.

Hierarchy

BasePrismoidPyramidMesh
- PyramidMesh
  - ConeMesh

Index

Constructors

constructor

new PyramidMesh(engine: WonderlandEngine, polyline: vec2[], options?: PrismPyramidOptions): PyramidMesh
Make a new pyramid.
Parameters
- engine: WonderlandEngine
  
  The Wonderland Engine instance to use this mesh for
- polyline: vec2[]
  
  Polyline used for the pyramid's base.
- Optional options: PrismPyramidOptions
  
  Optional arguments for the pyramid generation.
Returns PyramidMesh
Overrides BasePrismoidPyramidMesh.constructor
- Defined in client/PyramidMesh.ts:21

Properties

autoDispose

autoDispose: boolean = false

If this flag is set, then dispose will be called after a CSG operation is done. It's recommended to call mark instead of setting this manually, since the method is chainable.

`Protected` premadeMergeMap

premadeMergeMap: null | MergeMap = null

A merge map that defines how to create a manifold from the submeshes.

`Protected` submeshes

submeshes: Submesh[] = []

The list of submeshes to assign to this group.

Accessors

mergeMap

get mergeMap(): MergeMap
Get the merge map of this MeshGroup. If the MeshGroup has no merge map yet, then a merge map will be automatically generated and cached. Note that this process can throw.

Returns MergeMap
Inherited from BasePrismoidPyramidMesh.mergeMap
- Defined in client/MeshGroup.ts:172

submeshCount

get submeshCount(): number
Get the number of submeshes inside this MeshGroup.

Returns number
Inherited from BasePrismoidPyramidMesh.submeshCount
- Defined in client/MeshGroup.ts:193

Methods

dispose

dispose(): void
Destroy the Wonderland Engine meshes stored in this object. Note that if the submeshes are reused elsewhere, then this will destroy those too.

Returns void
Inherited from BasePrismoidPyramidMesh.dispose
- Defined in client/MeshGroup.ts:233

encode

encode(materials: Material[], transferables: Transferable[]): EncodedMeshGroup
Encode into a format that is passable to the Manifold worker, along with a numeric mapping for materials.
Parameters
- materials: Material[]
- transferables: Transferable[]
Returns EncodedMeshGroup
Inherited from BasePrismoidPyramidMesh.encode
- Defined in client/MeshGroup.ts:340

getSubmesh

getSubmesh(submeshIdx: number): Submesh
Get the submeshes at a specific submesh index.

Returns
A pair containing a WL.Mesh instance and a WL.Material instance.
Parameters
- submeshIdx: number
  
  The index of the wanted submesh.
Returns Submesh
Inherited from BasePrismoidPyramidMesh.getSubmesh
- Defined in client/MeshGroup.ts:203

getSubmeshes

getSubmeshes(): Submesh[]
Get the submeshes inside this MeshGroup.

Returns
A list of submeshes, where each submesh is a pair containing a WL.Mesh instance and a WL.Material instance.

Returns Submesh[]
Inherited from BasePrismoidPyramidMesh.getSubmeshes
- Defined in client/MeshGroup.ts:218

mark

mark(): PyramidMesh
Sets autoDispose to true (marks as auto-disposable). Chainable method.

Returns PyramidMesh
Inherited from BasePrismoidPyramidMesh.mark
- Defined in client/MeshGroup.ts:246

rotate

rotate(rotation: quat): PyramidMesh
Rotate all submeshes and the manifold by a given quaternion. Chainable method.
Parameters
- rotation: quat
Returns PyramidMesh
Inherited from BasePrismoidPyramidMesh.rotate
- Defined in client/MeshGroup.ts:328

scale

scale(factor: vec3): PyramidMesh
Scale all submeshes and the manifold by a given per-axis factor. Chainable method.
Parameters
- factor: vec3
Returns PyramidMesh
Inherited from BasePrismoidPyramidMesh.scale
- Defined in client/MeshGroup.ts:310

transform

transform(matrix: mat4, normalMatrix?: mat3): PyramidMesh
Transform all submeshes and the manifold by a given matrix and normal matrix. Chainable method.
Parameters
- matrix: mat4
- Optional normalMatrix: mat3
Returns PyramidMesh
Inherited from BasePrismoidPyramidMesh.transform
- Defined in client/MeshGroup.ts:255

translate

translate(translation: vec3): PyramidMesh
Translate all submeshes and the manifold by a given translation vector. Chainable method.
Parameters
- translation: vec3
Returns PyramidMesh
Inherited from BasePrismoidPyramidMesh.translate
- Defined in client/MeshGroup.ts:301

uniformScale

uniformScale(factor: number): PyramidMesh
Scale all submeshes and the manifold by a single factor. Chainable method.
Parameters
- factor: number
Returns PyramidMesh
Inherited from BasePrismoidPyramidMesh.uniformScale
- Defined in client/MeshGroup.ts:319

`Static` fromEncodedMeshGroup

fromEncodedMeshGroup(engine: WonderlandEngine, encodedMeshGroup: EncodedMeshGroup, materials: Material[]): MeshGroup
Create a new MeshGroup from an EncodedMeshGroup.
Parameters
- engine: WonderlandEngine
- encodedMeshGroup: EncodedMeshGroup
- materials: Material[]
Returns MeshGroup
Inherited from BasePrismoidPyramidMesh.fromEncodedMeshGroup
- Defined in client/MeshGroup.ts:82

`Static` fromWLEMesh

fromWLEMesh(mesh: Mesh, material?: null | Material): MeshGroup
Create a new MeshGroup from a WL.Mesh.

WARNING: The submeshes array and the manifold mesh will have their ownership tranferred to this object. If you modify them later, they will be modified here as well, possibly corrupting the mesh. To avoid issues with this, do a deep clone of the inputs
Parameters
- mesh: Mesh
  
  A WL.Mesh instance.
- material: null | Material = null
  
  A WL.Material instance. Null by default.
Returns MeshGroup
Inherited from BasePrismoidPyramidMesh.fromWLEMesh
- Defined in client/MeshGroup.ts:77

`Static` makeEmpty

makeEmpty(): MeshGroup
Create a new empty MeshGroup. Useless on its own, only ever appears as a fallback for CSG operations with no result.

Returns MeshGroup
Inherited from BasePrismoidPyramidMesh.makeEmpty
- Defined in client/MeshGroup.ts:160

Class PyramidMesh

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

engine: WonderlandEngine

polyline: vec2[]

Optional options: PrismPyramidOptions

Returns PyramidMesh

Properties

autoDispose

Protected premadeMergeMap

Protected submeshes

Accessors

mergeMap

Returns MergeMap

submeshCount

Returns number

Methods

dispose

Returns void

encode

Parameters

materials: Material[]

transferables: Transferable[]

Returns EncodedMeshGroup

getSubmesh

Returns

Parameters

submeshIdx: number

Returns Submesh

getSubmeshes

Returns

Returns Submesh[]

mark

Returns PyramidMesh

rotate

Parameters

rotation: quat

Returns PyramidMesh

scale

Parameters

factor: vec3

Returns PyramidMesh

transform

Parameters

matrix: mat4

Optional normalMatrix: mat3

Returns PyramidMesh

translate

Parameters

translation: vec3

Returns PyramidMesh

uniformScale

Parameters

factor: number

Returns PyramidMesh

Static fromEncodedMeshGroup

Parameters

engine: WonderlandEngine

encodedMeshGroup: EncodedMeshGroup

materials: Material[]

Returns MeshGroup

Static fromWLEMesh

Parameters

mesh: Mesh

material: null | Material = null

Returns MeshGroup

Static makeEmpty

Returns MeshGroup

Settings

Member Visibility

Theme

`Optional` options: PrismPyramidOptions

`Protected` premadeMergeMap

`Protected` submeshes

`Optional` normalMatrix: mat3

`Static` fromEncodedMeshGroup

`Static` fromWLEMesh

`Static` makeEmpty