Engine API Reference - v2.6.1
    Preparing search index...

    Class PlaneGeometry

    A procedural plane-shaped geometry.

    The size and tesselation properties of the plane can be controlled via constructor parameters. By default, the function will create a plane centered on the object space origin with a width and length of 1.0 and 5 segments in either axis (50 triangles). The normal vector of the plane is aligned along the positive Y axis.

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

    Hierarchy (View Summary)

    Index

    Constructors

    • Create a new PlaneGeometry instance.

      Parameters

      • Optionalopts: {
            calculateTangents?: boolean;
            halfExtents?: Vec2;
            lengthSegments?: number;
            widthSegments?: number;
        } = {}

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

        • OptionalcalculateTangents?: boolean

          Generate tangent information (defaults to false).

        • OptionalhalfExtents?: Vec2

          The half dimensions of the plane in the X and Z axes (defaults to [0.5, 0.5]).

        • OptionallengthSegments?: number

          The number of divisions along the Z axis of the plane (defaults to 5).

        • OptionalwidthSegments?: number

          The number of divisions along the X axis of the plane (defaults to 5).

      Returns PlaneGeometry

    Properties

    blendIndices: undefined | number[]

    Blend indices.

    blendWeights: undefined | number[]

    Blend weights.

    colors: undefined | number[]

    Colors.

    Methods