Class Gear

Procedural Gear Geometry based on isosceles trapezoidal teeth.

See

Please refer to REFERENCES.md#gear-zahnrad for the underlying tooth calculation formulas.

Hierarchy (View Summary)

ExtrudeGeometry
- Gear

Constructors

constructor

new Gear(options?: GearOptions): Gear
Parameters
- options: GearOptions = {}
Returns Gear
Overrides ExtrudeGeometry.constructor
- Defined in geometry/Gear.ts:35

Properties

`Protected`_cachedBoundingVolume

_cachedBoundingVolume: BoundingVolume | undefined = undefined

Cached bounding volume to prevent re-allocation

`Protected`_indices

_indices:
    | Uint16Array<ArrayBufferLike>
    | Uint32Array<ArrayBufferLike>
    | undefined = undefined

The indices of the geometry for indexed rendering.

`Protected`_isLineGeometry

_isLineGeometry: boolean = false

Whether the geometry is purely line-based.

`Protected`_normals

_normals: Float32Array = ...

The normals of the geometry (nx, ny, nz).

`Protected`_tangents

_tangents: Float32Array = ...

The tangents of the geometry (tx, ty, tz).

`Protected`_uvs

_uvs: Float32Array = ...

The UV coordinates of the geometry (u, v).

`Protected`_vertices

_vertices: Float32Array = ...

The vertices of the geometry (x, y, z).

`Protected`_wireframeIndices

_wireframeIndices:
    | Uint16Array<ArrayBufferLike>
    | Uint32Array<ArrayBufferLike>
    | undefined = undefined

The indices for wireframe rendering.

`Readonly`depth

depth: number

`Readonly`holeRadius

holeRadius: number

`Readonly`innerRadius

innerRadius: number

`Readonly`innerShape

innerShape: Vector2D[] | undefined

`Readonly`shape

shape: Vector2D[]

`Readonly`teeth

teeth: number

`Readonly`toothHeight

toothHeight: number

`Readonly`vRatio

vRatio: number

Methods

`Protected`_createIndexArray

_createIndexArray(
indexCount: number,
): Uint16Array<ArrayBufferLike> | Uint32Array<ArrayBufferLike>
Helper method to create an appropriately sized index array. Automatically chooses between 16-bit and 32-bit indices based on vertex count.
Parameters
- indexCount: number
  The number of indices needed.
Returns Uint16Array<ArrayBufferLike> | Uint32Array<ArrayBufferLike>
A Uint16Array or Uint32Array.
Inherited from ExtrudeGeometry._createIndexArray
- Defined in geometry/AbstractGeometry.ts:227

applyMatrix4

applyMatrix4(matrix: Matrix4): this
Applies a Matrix4 transformation to all geometry vertices in-place.
Parameters
- matrix: Matrix4
  The transformation matrix.
Returns this
this
Inherited from ExtrudeGeometry.applyMatrix4
- Defined in geometry/AbstractGeometry.ts:315

computeNormals

computeNormals(): void
Computes the normals of the geometry using the current vertices and indices. Averages normals for shared vertices.

Returns void
Inherited from ExtrudeGeometry.computeNormals
- Defined in geometry/AbstractGeometry.ts:239

computeTangents

computeTangents(): void
Computes the tangents of the geometry based on normals and UVs. Required for normal mapping.

Returns void
Inherited from ExtrudeGeometry.computeTangents
- Defined in geometry/AbstractGeometry.ts:83

computeWireframeIndices

computeWireframeIndices(): void
Computes the wireframe indices (line-segments) from the current triangle topology.

Returns void
Inherited from ExtrudeGeometry.computeWireframeIndices
- Defined in geometry/AbstractGeometry.ts:185

`Protected`generateGeometryData

generateGeometryData(): void
Generates the raw geometry data. Must be implemented by subclasses.

Returns void
Inherited from ExtrudeGeometry.generateGeometryData
- Defined in geometry/ExtrudeGeometry.ts:35

getBoundingVolume

getBoundingVolume(): BoundingVolume
Returns a bounding volume that encapsulates this geometry.

Returns BoundingVolume
The bounding volume.
Inherited from ExtrudeGeometry.getBoundingVolume
- Defined in geometry/AbstractGeometry.ts:72

getGeometryData

getGeometryData(): GeometryDataInterface
Returns the raw geometry data ready for GPU upload.

Returns GeometryDataInterface
The geometry data interface.
Inherited from ExtrudeGeometry.getGeometryData
- Defined in geometry/AbstractGeometry.ts:38

rotateX

rotateX(a: number): this
Rotates the geometry vertices around the X-axis in-place.
Parameters
- a: number
  The rotation angle in radians.
Returns this
this
Inherited from ExtrudeGeometry.rotateX
- Defined in geometry/AbstractGeometry.ts:346

rotateY

rotateY(a: number): this
Rotates the geometry vertices around the Y-axis in-place.
Parameters
- a: number
  The rotation angle in radians.
Returns this
this
Inherited from ExtrudeGeometry.rotateY
- Defined in geometry/AbstractGeometry.ts:357

rotateZ

rotateZ(a: number): this
Rotates the geometry vertices around the Z-axis in-place.
Parameters
- a: number
  The rotation angle in radians.
Returns this
this
Inherited from ExtrudeGeometry.rotateZ
- Defined in geometry/AbstractGeometry.ts:368

scale

scale(f: number): this
Scales the geometry vertices in-place.
Parameters
- f: number
  The scale factor.
Returns this
this
Inherited from ExtrudeGeometry.scale
- Defined in geometry/AbstractGeometry.ts:335

Class Gear

See

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns Gear

Properties

Protected_cachedBoundingVolume

Protected_indices

Protected_isLineGeometry

Protected_normals

Protected_tangents

Protected_uvs

Protected_vertices

Protected_wireframeIndices

Readonlydepth

ReadonlyholeRadius

ReadonlyinnerRadius

ReadonlyinnerShape

Readonlyshape

Readonlyteeth

ReadonlytoothHeight

ReadonlyvRatio

Methods

Protected_createIndexArray

Parameters

Returns Uint16Array<ArrayBufferLike> | Uint32Array<ArrayBufferLike>

applyMatrix4

Parameters

Returns this

computeNormals

Returns void

computeTangents

Returns void

computeWireframeIndices

Returns void

ProtectedgenerateGeometryData

Returns void

getBoundingVolume

Returns BoundingVolume

getGeometryData

Returns GeometryDataInterface

rotateX

Parameters

Returns this

rotateY

Parameters

Returns this

rotateZ

Parameters

Returns this

scale

Parameters

Returns this

Settings

On This Page

`Protected`_cachedBoundingVolume

`Protected`_indices

`Protected`_isLineGeometry

`Protected`_normals

`Protected`_tangents

`Protected`_uvs

`Protected`_vertices

`Protected`_wireframeIndices

`Readonly`depth

`Readonly`holeRadius

`Readonly`innerRadius

`Readonly`innerShape

`Readonly`shape

`Readonly`teeth

`Readonly`toothHeight

`Readonly`vRatio

`Protected`_createIndexArray

`Protected`generateGeometryData