Class BoxGeometryGenerator

Hierarchy (View Summary)

AGeometryGenerator<BoxGeometryGeneratorParams>
- BoxGeometryGenerator

Index

Constructors

constructor

new BoxGeometryGenerator(type: string): BoxGeometryGenerator
Parameters
- type: string
Returns BoxGeometryGenerator
Inherited from AGeometryGenerator.constructor
- Defined in plugins/geometry-generator/src/AGeometryGenerator.ts:66

Properties

defaultParams

defaultParams: {
    depth: number;
    depthSegments: number;
    height: number;
    heightSegments: number;
    width: number;
    widthSegments: number;
} = ...

type

type: string

Methods

`Protected`_buildPlane

_buildPlane(
    state: any,
    u: "x" | "y" | "z",
    v: "x" | "y" | "z",
    w: "x" | "y" | "z",
    udir: number,
    vdir: number,
    width: number,
    height: number,
    depth: number,
    gridX: number,
    gridY: number,
    materialIndex: number,
): void
Parameters
- state: any
- u: "x" | "y" | "z"
- v: "x" | "y" | "z"
- w: "x" | "y" | "z"
- udir: number
- vdir: number
- width: number
- height: number
- depth: number
- gridX: number
- gridY: number
- materialIndex: number
Returns void
- Defined in plugins/geometry-generator/src/primitives/BoxGeometryGenerator.ts:27

`Protected`_generateData

_generateData(
    params: BoxGeometryGeneratorParams,
): {
    groups: never[];
    groupStart: number;
    indices: never[];
    normals: never[];
    numberOfVertices: number;
    uvs: never[];
    vertices: never[];
}
Parameters
- params: BoxGeometryGeneratorParams
Returns {
    groups: never[];
    groupStart: number;
    indices: never[];
    normals: never[];
    numberOfVertices: number;
    uvs: never[];
    vertices: never[];
}
Overrides AGeometryGenerator._generateData
- Defined in plugins/geometry-generator/src/primitives/BoxGeometryGenerator.ts:94

createUiConfig

createUiConfig(geometry: IGeometry): UiObjectConfig[]
Parameters
- geometry: IGeometry
Returns UiObjectConfig[]
Inherited from AGeometryGenerator.createUiConfig
- Defined in plugins/geometry-generator/src/AGeometryGenerator.ts:71

generate

generate(
g?: IGeometry,
parameters?: Partial<BoxGeometryGeneratorParams>,
): IGeometry | BufferGeometry2
Parameters
- Optionalg: IGeometry
- parameters: Partial<BoxGeometryGeneratorParams> = {}
Returns IGeometry | BufferGeometry2
Inherited from AGeometryGenerator.generate
- Defined in plugins/geometry-generator/src/AGeometryGenerator.ts:84

Class BoxGeometryGenerator

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns BoxGeometryGenerator

Properties

defaultParams

type

Methods

`Protected`_buildPlane

Parameters

Returns void

`Protected`_generateData

Parameters

Returns {
    groups: never[];
    groupStart: number;
    indices: never[];
    normals: never[];
    numberOfVertices: number;
    uvs: never[];
    vertices: never[];
}

createUiConfig

Parameters

Returns UiObjectConfig[]

generate

Parameters

Returns IGeometry | BufferGeometry2

Settings

On This Page

Class BoxGeometryGenerator

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns BoxGeometryGenerator

Properties

defaultParams

type

Methods

Protected_buildPlane

Parameters

Returns void

Protected_generateData

Parameters

Returns { groups: never[]; groupStart: number; indices: never[]; normals: never[]; numberOfVertices: number; uvs: never[]; vertices: never[];}

createUiConfig

Parameters

Returns UiObjectConfig[]

generate

Parameters

Returns IGeometry | BufferGeometry2

Settings

On This Page

`Protected`_buildPlane

`Protected`_generateData

Returns {
groups: never[];
groupStart: number;
indices: never[];
normals: never[];
numberOfVertices: number;
uvs: never[];
vertices: never[];
}