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

  • Create a new CapsuleGeometry instance.

    Parameters

    • Optionalopts: {
          calculateTangents?: boolean;
          height?: number;
          heightSegments?: number;
          radius?: number;
          sides?: number;
      } = {}

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

      • OptionalcalculateTangents?: boolean

        Generate tangent information (defaults to false).

      • Optionalheight?: number

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

      • OptionalheightSegments?: number

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

      • Optionalradius?: number

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

      • Optionalsides?: number

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

    Returns CapsuleGeometry

Properties

blendIndices: number[]

Blend indices.

blendWeights: number[]

Blend weights.

colors: number[]

Colors.

Methods