Class ShapeGeometryGenerator

Generates a flat 2D shape geometry from preset shape types. Uses three.js ShapeGeometry internally.

Hierarchy (View Summary)

AGeometryGenerator<ShapeGeometryGeneratorParams>
- ShapeGeometryGenerator

Index

Constructors

Properties

defaultGeometryClass? defaultMaterialClass? defaultMeshClass defaultParams type

Methods

_generateData createUiConfig generate setDefaultParams

Constructors

constructor

new ShapeGeometryGenerator(
type?: string,
defaultParams?: Partial<ShapeGeometryGeneratorParams>,
): ShapeGeometryGenerator
Parameters
- type: string = 'shape'
- OptionaldefaultParams: Partial<ShapeGeometryGeneratorParams>
Returns ShapeGeometryGenerator
Overrides AGeometryGenerator.constructor
- Defined in src/plugins/geometry/primitives/ShapeGeometryGenerator.ts:24

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: ShapeGeometryGeneratorParams = ...

type

type: string

Methods

`Protected`_generateData

_generateData(
    params: ShapeGeometryGeneratorParams,
): {
    indices: number[];
    normals: Float32BufferAttribute;
    uvs: Float32BufferAttribute;
    vertices: Float32BufferAttribute;
}
Parameters
- params: ShapeGeometryGeneratorParams
Returns {
    indices: number[];
    normals: Float32BufferAttribute;
    uvs: Float32BufferAttribute;
    vertices: Float32BufferAttribute;
}
Overrides AGeometryGenerator._generateData
- Defined in src/plugins/geometry/primitives/ShapeGeometryGenerator.ts:40

createUiConfig

createUiConfig(geometry: IGeometry): UiObjectConfig<any, string, any>[]
Parameters
- geometry: IGeometry
Returns UiObjectConfig<any, string, any>[]
Overrides AGeometryGenerator.createUiConfig
- Defined in src/plugins/geometry/primitives/ShapeGeometryGenerator.ts:62

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 src/plugins/geometry/AGeometryGenerator.ts:110

setDefaultParams

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