Class BoxGeometry

constructor

• new BoxGeometry(opts?): BoxGeometry

• Create a new BoxGeometry instance.

  Parameters

  • Optionalopts: {
        calculateTangents: boolean;
        halfExtents: Vec3;
        heightSegments: number;
        lengthSegments: number;
        widthSegments: number;
        yOffset: number;
    } = {}

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

    • calculateTangents: boolean

      Generate tangent information (defaults to false).

    • halfExtents: Vec3

      The half dimensions of the box in each axis (defaults to [0.5, 0.5, 0.5]).

    • heightSegments: number

      The number of divisions along the Y axis of the box (defaults to 1).

    • lengthSegments: number

      The number of divisions along the Z axis of the box (defaults to 1).

    • widthSegments: number

      The number of divisions along the X axis of the box (defaults to 1).

    • yOffset: number

      Move the box vertically by given offset in local space. Pass 0.5 to generate the box with pivot point at the bottom face. Defaults to 0.

  Returns BoxGeometry