Class BoxGeometryGenerator

Hierarchy (View Summary)

AGeometryGenerator<BoxGeometryGeneratorParams>
- BoxGeometryGenerator

Index

Constructors

constructor

new BoxGeometryGenerator(
type?: string,
defaultParams?: Partial<BoxGeometryGeneratorParams>,
): BoxGeometryGenerator
Parameters
- type: string = 'box'
- OptionaldefaultParams: Partial<BoxGeometryGeneratorParams>
Returns BoxGeometryGenerator
Overrides AGeometryGenerator.constructor
- Defined in plugins/geometry-generator/src/primitives/BoxGeometryGenerator.ts:16

Properties

`Optional`defaultGeometryClass

defaultGeometryClass?: () => Class<
IGeometry<NormalBufferAttributes, BufferGeometryEventMap>,
> = ...

`Optional`defaultMaterialClass

defaultMaterialClass?: () => Class<IMaterial<IMaterialEventMap>> = ...

defaultMeshClass

defaultMeshClass: () => Class<
    IObject3D<
        IObject3DEventMap,
        undefined
        | IGeometry<NormalBufferAttributes, BufferGeometryEventMap>,
        undefined | IMaterial<IMaterialEventMap> | IMaterial<IMaterialEventMap>[],
    >,
> = ...

defaultParams

defaultParams: BoxGeometryGeneratorParams = ...

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:32

`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:99

createUiConfig

createUiConfig(geometry: IGeometry): UiObjectConfig<any, string, any>[]
Parameters
- geometry: IGeometry
Returns UiObjectConfig<any, string, any>[]
Inherited from AGeometryGenerator.createUiConfig
- Defined in plugins/geometry-generator/src/AGeometryGenerator.ts:90

generate

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

setDefaultParams

setDefaultParams(params: Partial<Tp>): BoxGeometryGenerator
Parameters
- params: Partial<Tp>
Returns BoxGeometryGenerator
Inherited from AGeometryGenerator.setDefaultParams
- Defined in plugins/geometry-generator/src/AGeometryGenerator.ts:155

Class BoxGeometryGenerator

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns BoxGeometryGenerator

Properties

`Optional`defaultGeometryClass

`Optional`defaultMaterialClass

defaultMeshClass

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<any, string, any>[]

generate

Parameters

Returns
| IGeometry<NormalBufferAttributes, BufferGeometryEventMap>
| BufferGeometry2<NormalBufferAttributes, BufferGeometryEventMap>

setDefaultParams

Parameters

Returns BoxGeometryGenerator

Settings

On This Page

Class BoxGeometryGenerator

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns BoxGeometryGenerator

Properties

OptionaldefaultGeometryClass

OptionaldefaultMaterialClass

defaultMeshClass

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<any, string, any>[]

generate

Parameters

Returns | IGeometry<NormalBufferAttributes, BufferGeometryEventMap> | BufferGeometry2<NormalBufferAttributes, BufferGeometryEventMap>

setDefaultParams

Parameters

Returns BoxGeometryGenerator

Settings

On This Page

`Optional`defaultGeometryClass

`Optional`defaultMaterialClass

`Protected`_buildPlane

`Protected`_generateData

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

Returns
| IGeometry<NormalBufferAttributes, BufferGeometryEventMap>
| BufferGeometry2<NormalBufferAttributes, BufferGeometryEventMap>