Class AGeometryGenerator<Tp, Tt>`Abstract`

Type Parameters

Tp extends object = any
Tt extends string = string

Hierarchy (View Summary)

AGeometryGenerator

Implements

GeometryGenerator<Tp>

Index

Constructors

constructor

new AGeometryGenerator<Tp extends object = any, Tt extends string = string>(
type: Tt,
): AGeometryGenerator<Tp, Tt>
Type Parameters
- Tp extends object = any
- Tt extends string = string
Parameters
- type: Tt
Returns AGeometryGenerator<Tp, Tt>
- Defined in plugins/geometry-generator/src/AGeometryGenerator.ts:81

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>[],
    >,
> = ...

`Abstract`defaultParams

defaultParams: Tp

type

type: Tt

Methods

`Protected` `Abstract`_generateData

_generateData(
    params: Tp,
): {
    groups?: { count: number; materialIndex?: number; start: number }[];
    indices?: BufferAttribute | number[];
    normals?: BufferAttribute | number[];
    positions?: number[];
    uvs?: BufferAttribute | number[];
    vertices: BufferAttribute | number[];
}
Parameters
- params: Tp
Returns {
    groups?: { count: number; materialIndex?: number; start: number }[];
    indices?: BufferAttribute | number[];
    normals?: BufferAttribute | number[];
    positions?: number[];
    uvs?: BufferAttribute | number[];
    vertices: BufferAttribute | number[];
}
- Defined in plugins/geometry-generator/src/AGeometryGenerator.ts:100

createUiConfig

createUiConfig(geometry: IGeometry): UiObjectConfig<any, string, any>[]
Parameters
- geometry: IGeometry
Returns UiObjectConfig<any, string, any>[]
Implementation of GeometryGenerator.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>
Implementation of GeometryGenerator.generate
- Defined in plugins/geometry-generator/src/AGeometryGenerator.ts:109

setDefaultParams

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

Class AGeometryGenerator<Tp, Tt>`Abstract`

Type Parameters

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Parameters

Returns AGeometryGenerator<Tp, Tt>

Properties

`Optional`defaultGeometryClass

`Optional`defaultMaterialClass

defaultMeshClass

`Abstract`defaultParams

type

Methods

`Protected` `Abstract`_generateData

Parameters

Returns {
    groups?: { count: number; materialIndex?: number; start: number }[];
    indices?: BufferAttribute | number[];
    normals?: BufferAttribute | number[];
    positions?: number[];
    uvs?: BufferAttribute | number[];
    vertices: BufferAttribute | number[];
}

createUiConfig

Parameters

Returns UiObjectConfig<any, string, any>[]

generate

Parameters

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

setDefaultParams

Parameters

Returns AGeometryGenerator<Tp, Tt>

Settings

On This Page

Class AGeometryGenerator<Tp, Tt>Abstract

Type Parameters

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Parameters

Returns AGeometryGenerator<Tp, Tt>

Properties

OptionaldefaultGeometryClass

OptionaldefaultMaterialClass

defaultMeshClass

AbstractdefaultParams

type

Methods

Protected Abstract_generateData

Parameters

Returns { groups?: { count: number; materialIndex?: number; start: number }[]; indices?: BufferAttribute | number[]; normals?: BufferAttribute | number[]; positions?: number[]; uvs?: BufferAttribute | number[]; vertices: BufferAttribute | number[];}

createUiConfig

Parameters

Returns UiObjectConfig<any, string, any>[]

generate

Parameters

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

setDefaultParams

Parameters

Returns AGeometryGenerator<Tp, Tt>

Settings

On This Page

Class AGeometryGenerator<Tp, Tt>`Abstract`

`Optional`defaultGeometryClass

`Optional`defaultMaterialClass

`Abstract`defaultParams

`Protected` `Abstract`_generateData

Returns {
groups?: { count: number; materialIndex?: number; start: number }[];
indices?: BufferAttribute | number[];
normals?: BufferAttribute | number[];
positions?: number[];
uvs?: BufferAttribute | number[];
vertices: BufferAttribute | number[];
}

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