Class PlaneGeometry

Used to create an indexed plane geometry based on the number of segments along the X and Y axis.

This is how it will look for a 3x2 quad. Indexing will take care of drawing the right vertices in the right order.

 3---2---1---0
 |  /|  /|  /|
 |/  |/  |/  |
 7---6---5---4
 |  /|  /|  /|
 |/  |/  |/  |
 11--10--9---8

Example

const planeGeometry = new PlaneGeometry()

Hierarchy (view full)

IndexedGeometry
- PlaneGeometry

Constructors

constructor

new PlaneGeometry(parameters?): PlaneGeometry
PlaneGeometry constructor
Parameters
- parameters: PlaneGeometryParams = {}
  parameters used to create our PlaneGeometry
Returns PlaneGeometry
Overrides IndexedGeometry.constructor
- Defined in src/core/geometries/PlaneGeometry.ts:54

Properties

verticesCount

verticesCount: number

Number of vertices defined by this geometry

verticesOrder

verticesOrder: GPUFrontFace

Vertices order to be drawn by the render pipeline

topology

topology: GPUPrimitiveTopology

Topology to use with this Geometry, i.e. whether to draw triangles or points

instancesCount

instancesCount: number

Number of instances of this geometry to draw

vertexBuffers

vertexBuffers: VertexBuffer[]

Array of vertex buffers to use with this geometry

options

options: GeometryOptions

Options used to create this geometry

type

type: string

The type of the geometry

uuid

uuid: string

The universal unique id of the geometry

boundingBox

boundingBox: Box3

The bounding box of the geometry, i.e. two Vec3 defining the min and max positions to wrap this geometry in a cube

wgslStructFragment

wgslStructFragment: string

A string to append to our shaders code describing the WGSL structure representing this geometry attributes

layoutCacheKey

layoutCacheKey: string

A string representing the vertexBuffers layout, used for pipelines caching

consumers

consumers: Set<string>

A Set to store this Geometry consumers (Mesh uuid)

ready

ready: boolean

Whether this geometry is ready to be drawn, i.e. it has been computed and all its vertex buffers have been created

indexBuffer

indexBuffer: IndexBuffer

Object containing our index buffer format & length, array and GPUBuffer

definition

definition: {
    id: number;
    width: number;
    height: number;
    count: number;
}

Defines our PlaneGeometry definition based on the provided parameters

Type declaration

id: number
unique id based on width and height segments, used to get PlaneGeometry from cache
width: number
number of segments along the X axis
height: number
number of segments along the Y axis
count: number
total number of segments

Accessors

shouldCompute

get shouldCompute(): boolean
Get whether this Geometry is ready to compute, i.e. if its first vertex buffer array has not been created yet

Returns boolean
Inherited from IndexedGeometry.shouldCompute
- Defined in src/core/geometries/Geometry.ts:323

useUint16IndexArray

get useUint16IndexArray(): boolean
If we have less than 65.536 vertices, we should use a Uin16Array to hold our index buffer values

Returns boolean
Inherited from IndexedGeometry.useUint16IndexArray
- Defined in src/core/geometries/IndexedGeometry.ts:119

Methods

addVertexBuffer

addVertexBuffer(parameters?): VertexBuffer
Add a vertex buffer to our Geometry, set its attributes and return it
Parameters
- parameters: VertexBufferParams = {}
  vertex buffer parameters
Returns VertexBuffer
- newly created vertex buffer
Inherited from IndexedGeometry.addVertexBuffer
- Defined in src/core/geometries/Geometry.ts:191

getVertexBufferByName

getVertexBufferByName(name?): VertexBuffer
Get a vertex buffer by name
Parameters
- name: string = ''
  our vertex buffer name
Returns VertexBuffer
- found vertex buffer or null if not found
Inherited from IndexedGeometry.getVertexBufferByName
- Defined in src/core/geometries/Geometry.ts:232

setAttribute

setAttribute(parameters): void
Set a vertex buffer attribute
Parameters
- parameters: VertexBufferAttributeParams
  attributes parameters
Returns void
Inherited from IndexedGeometry.setAttribute
- Defined in src/core/geometries/Geometry.ts:240

getAttributeByName

getAttributeByName(name): VertexBufferAttribute
Get an attribute by name
Parameters
- name: string
  name of the attribute to find
Returns VertexBufferAttribute
- found attribute or null if not found
Inherited from IndexedGeometry.getAttributeByName
- Defined in src/core/geometries/Geometry.ts:332

computeGeometry

computeGeometry(): void
Compute a Geometry, which means iterate through all vertex buffers and create the attributes array that will be sent as buffers. Also compute the Geometry bounding box.

Returns void
Inherited from IndexedGeometry.computeGeometry
- Defined in src/core/geometries/Geometry.ts:345

setWGSLFragment

setWGSLFragment(): void
Set the WGSL code snippet that will be appended to the vertex shader.

Returns void
Inherited from IndexedGeometry.setWGSLFragment
- Defined in src/core/geometries/Geometry.ts:417

uploadBuffer

uploadBuffer(renderer, buffer): void
Upload a GeometryBuffer to the GPU.
Parameters
- renderer: Renderer
  Renderer used to upload the buffer.
- buffer: GeometryBuffer
  GeometryBuffer holding a Buffer and a typed array to upload.
Returns void
Inherited from IndexedGeometry.uploadBuffer
- Defined in src/core/geometries/Geometry.ts:480

render

render(pass): void
Set our vertex buffers then draw the geometry
Parameters
- pass: GPURenderPassEncoder
  current render pass
Returns void
Inherited from IndexedGeometry.render
- Defined in src/core/geometries/Geometry.ts:516

loseContext

loseContext(): void
Reset all the vertex buffers and index buffer when the device is lost

Returns void
Inherited from IndexedGeometry.loseContext
- Defined in src/core/geometries/IndexedGeometry.ts:89

restoreContext

restoreContext(renderer): void
Restore the IndexedGeometry buffers on context restoration
Parameters
- renderer: Renderer
  The Renderer used to recreate the buffers
Returns void
Inherited from IndexedGeometry.restoreContext
- Defined in src/core/geometries/IndexedGeometry.ts:101

setIndexBuffer

setIndexBuffer(parameters): void
Set our indexBuffer
Parameters
- parameters: IndexedGeometryIndexBufferOptions
  parameters used to create our index buffer
Returns void
Inherited from IndexedGeometry.setIndexBuffer
- Defined in src/core/geometries/IndexedGeometry.ts:127

createBuffers

createBuffers(parameters): void
Create the Geometry vertex buffers and index buffer.
Parameters
- parameters: {
  renderer: Renderer;
  label?: string;
  }
  parameters used to create the vertex buffers.
  - renderer: Renderer
    Renderer used to create the vertex buffers.
  - Optional label?: string
    label to use for the vertex buffers.
Returns void
Inherited from IndexedGeometry.createBuffers
- Defined in src/core/geometries/IndexedGeometry.ts:153

setGeometryBuffers

setGeometryBuffers(pass): void
First, set our render pass geometry vertex buffers Then, set our render pass geometry index buffer
Parameters
- pass: GPURenderPassEncoder
  current render pass
Returns void
Inherited from IndexedGeometry.setGeometryBuffers
- Defined in src/core/geometries/IndexedGeometry.ts:178

drawGeometry

drawGeometry(pass): void
Override the parentMesh draw method to draw indexed geometry
Parameters
- pass: GPURenderPassEncoder
  current render pass
Returns void
Inherited from IndexedGeometry.drawGeometry
- Defined in src/core/geometries/IndexedGeometry.ts:193

destroy

destroy(renderer?): void
Destroy our indexed geometry vertex buffers and index buffer.
Parameters
- renderer: Renderer = null
  current Renderer, in case we want to remove the buffer from the cache.
Returns void
Inherited from IndexedGeometry.destroy
- Defined in src/core/geometries/IndexedGeometry.ts:201

setIndexArray

setIndexArray(): void
Set our PlaneGeometry index array

Returns void
- Defined in src/core/geometries/PlaneGeometry.ts:90

getIndexedVerticesAndUVs

getIndexedVerticesAndUVs(verticesCount): Record<string, VertexBufferAttributeParams>
Compute the UV and position arrays based on our plane widthSegments and heightSegments values and return the corresponding attributes
Parameters
- verticesCount: number
  number of vertices of our PlaneGeometry
Returns Record<string, VertexBufferAttributeParams>
- our position and uv attributes
- Defined in src/core/geometries/PlaneGeometry.ts:120

Class PlaneGeometry

Example

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

parameters: PlaneGeometryParams = {}

Returns PlaneGeometry

Properties

verticesCount

verticesOrder

topology

instancesCount

vertexBuffers

options

type

uuid

boundingBox

wgslStructFragment

layoutCacheKey

consumers

ready

indexBuffer

definition

Type declaration

id: number

width: number

height: number

count: number

Accessors

shouldCompute

Returns boolean

useUint16IndexArray

Returns boolean

Methods

addVertexBuffer

Parameters

parameters: VertexBufferParams = {}

Returns VertexBuffer

getVertexBufferByName

Parameters

name: string = ''

Returns VertexBuffer

setAttribute

Parameters

parameters: VertexBufferAttributeParams

Returns void

getAttributeByName

Parameters

name: string

Returns VertexBufferAttribute

computeGeometry

Returns void

setWGSLFragment

Returns void

uploadBuffer

Parameters

renderer: Renderer

buffer: GeometryBuffer

Returns void

render

Parameters

pass: GPURenderPassEncoder

Returns void

loseContext

Returns void

restoreContext

Parameters

renderer: Renderer

Returns void

setIndexBuffer

Parameters

parameters: IndexedGeometryIndexBufferOptions

Returns void

createBuffers

parameters: {
renderer: Renderer;
label?: string;
}

`Optional` label?: string