Class CylinderGeometryGenerator

Abstract base class for geometry generators.

Provides the framework for generating parametric geometries with automatic UI configuration and buffer management. Subclasses implement _generateData to define the actual vertex/index data for a specific geometry type.

Hierarchy (View Summary)

AGeometryGenerator<CylinderGeometryGeneratorParams>
- CylinderGeometryGenerator

Index

Constructors

constructor

new CylinderGeometryGenerator(
type?: string,
defaultParams?: Partial<CylinderGeometryGeneratorParams>,
): CylinderGeometryGenerator
Parameters
- type: string = 'cylinder'
- OptionaldefaultParams: Partial<CylinderGeometryGeneratorParams>
Returns CylinderGeometryGenerator
Overrides AGeometryGenerator.constructor
- Defined in src/plugins/geometry/primitives/CylinderGeometryGenerator.ts:18

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

type

type: string

Methods

`Protected`_generateCap

_generateCap(state: any, top: boolean): void
Parameters
- state: any
- top: boolean
Returns void
- Defined in src/plugins/geometry/primitives/CylinderGeometryGenerator.ts:96

`Protected`_generateData

_generateData(
    params: CylinderGeometryGeneratorParams,
): {
    groups: never[];
    groupStart: number;
    halfHeight: number;
    height: number;
    heightSegments: number;
    index: number;
    indexArray: never[];
    indices: never[];
    normals: never[];
    numberOfVertices: number;
    openEnded: boolean;
    radialSegments: number;
    radiusBottom: number;
    radiusTop: number;
    thetaLength: number;
    thetaStart: number;
    uvs: never[];
    vertices: never[];
}
Parameters
- params: CylinderGeometryGeneratorParams
Returns {
    groups: never[];
    groupStart: number;
    halfHeight: number;
    height: number;
    heightSegments: number;
    index: number;
    indexArray: never[];
    indices: never[];
    normals: never[];
    numberOfVertices: number;
    openEnded: boolean;
    radialSegments: number;
    radiusBottom: number;
    radiusTop: number;
    thetaLength: number;
    thetaStart: number;
    uvs: never[];
    vertices: never[];
}
Overrides AGeometryGenerator._generateData
- Defined in src/plugins/geometry/primitives/CylinderGeometryGenerator.ts:162

`Protected`_generateTorso

_generateTorso(state: any): void
Parameters
- state: any
Returns void
- Defined in src/plugins/geometry/primitives/CylinderGeometryGenerator.ts:34

createUiConfig

createUiConfig(geometry: IGeometry): UiObjectConfig<any, string, any>[]
Parameters
- geometry: IGeometry
Returns UiObjectConfig<any, string, any>[]
Inherited from AGeometryGenerator.createUiConfig
- Defined in src/plugins/geometry/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 src/plugins/geometry/AGeometryGenerator.ts:110

setDefaultParams

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

Class CylinderGeometryGenerator

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns CylinderGeometryGenerator

Properties

`Optional`defaultGeometryClass

`Optional`defaultMaterialClass

defaultMeshClass

defaultParams

type

Methods

`Protected`_generateCap

Parameters

Returns void

`Protected`_generateData

Parameters

`Protected`_generateTorso

Parameters

Returns void

createUiConfig

Parameters

Returns UiObjectConfig<any, string, any>[]

generate

Parameters

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

setDefaultParams

Parameters

Returns CylinderGeometryGenerator

Settings

On This Page

Class CylinderGeometryGenerator

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns CylinderGeometryGenerator

Properties

OptionaldefaultGeometryClass

OptionaldefaultMaterialClass

defaultMeshClass

defaultParams

type

Methods

Protected_generateCap

Parameters

Returns void

Protected_generateData

Parameters

Protected_generateTorso

Parameters

Returns void

createUiConfig

Parameters

Returns UiObjectConfig<any, string, any>[]

generate

Parameters

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

setDefaultParams

Parameters

Returns CylinderGeometryGenerator

Settings

On This Page

`Optional`defaultGeometryClass

`Optional`defaultMaterialClass

`Protected`_generateCap

`Protected`_generateData

`Protected`_generateTorso

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