Class: PlaneGeometry

PlaneGeometry

The PlaneGeometry allows you to draw a 2d plane

new PlaneGeometry (…options)

Name Type Description
options PlaneGeometryOptions

Options to be applied to plane geometry

Extends

Members

height number

The height of plane

verticesX number

The number of vertices on x-axis

verticesY number

The number of vertices on y-axis

width number

The width of plane

Methods

build (options) void

Refreshes plane coordinates

Name Type Description
options PlaneGeometryOptions

Options to be applied to plane geometry

Inherited Properties

From class MeshGeometry

indices Uint32Array inherited

The indices of the mesh.

positions Float32Array inherited

The positions of the mesh.

uvs Float32Array inherited

The UVs of the mesh.

From class Geometry

attributes Record<string, Attribute> readonly inherited

A record of the attributes of the geometry.

bounds Bounds inherited

Returns the bounds of the geometry.

buffers Buffer[] readonly inherited

The buffers that the attributes use

indexBuffer Buffer readonly inherited

The index buffer of the geometry

instanceCount number inherited

the instance count of the geometry to draw

Default Value:
  • 1

topology Topology inherited

The topology of the geometry.

uid number readonly inherited

The unique id of the geometry.

Inherited Methods

From class Geometry

destroy (destroyBuffers) void inherited

destroys the geometry.

Name Type Default Description
destroyBuffers boolean false

destroy the buffers associated with this geometry

getAttribute (id) Attribute inherited

Returns the requested attribute.

Name Type Description
id string

The name of the attribute required

Returns:
Type Description
Attribute
  • The attribute requested.

getBuffer (id) Buffer inherited

Returns the requested buffer.

Name Type Description
id string

The name of the buffer required.

Returns:
Type Description
Buffer
  • The buffer requested.

getIndex () Buffer inherited

Returns the index buffer

Returns:
Type Description
Buffer
  • The index buffer.

getSize () number inherited

Used to figure out how many vertices there are in this geometry

Returns:
Type Description
number the number of vertices in the geometry