Class CapsuleGeometry

A procedural capsule-shaped geometry.

The size, shape and tesselation properties of the capsule can be controlled via constructor parameters. By default, the function will create a capsule standing vertically centered on the XZ-plane with a radius of 0.3, a height of 1.0, 1 height segment and 20 cap segments.

Note that the capsule is created with UVs in the range of 0 to 1.

Hierarchy

  • ConeBaseGeometry
    • CapsuleGeometry

Constructors

constructor

Properties

blendIndices blendWeights colors

Methods

calculateNormals calculateTangents

Constructors

constructor

  • new CapsuleGeometry(opts?): CapsuleGeometry

  • Create a new CapsuleGeometry instance.

    Parameters

    • Optional opts: {
          calculateTangents: boolean;
          height: number;
          heightSegments: number;
          radius: number;
          sides: number;
      } = {}

      An object that specifies optional inputs for the function as follows:

      • calculateTangents: boolean

        Generate tangent information (defaults to false).

      • height: number

        The length of the body of the capsule from tip to tip (defaults to 1.0).

      • heightSegments: number

        The number of divisions along the tubular length of the capsule (defaults to 1).

      • radius: number

        The radius of the tube forming the body of the capsule (defaults to 0.3).

      • sides: number

        The number of divisions around the tubular body of the capsule (defaults to 20).

    Returns CapsuleGeometry

Properties

blendIndices

blendIndices: number[]

Blend indices.

blendWeights

blendWeights: number[]

Blend weights.

colors

colors: number[]

Colors.

Methods

calculateNormals

  • calculateNormals(): void

  • Generates normal information from the positions and triangle indices.

    Returns void

calculateTangents

  • calculateTangents(): void

  • Generates tangent information from the positions, normals, texture coordinates and triangle indices.

    Returns void

Settings

Member Visibility

Theme

On This Page

constructorblendIndicesblendWeightscolorscalculateNormalscalculateTangents