Class TorusGeometryGenerator

Hierarchy (View Summary)

AGeometryGenerator<TorusGeometryGeneratorParams>
- TorusGeometryGenerator

Index

Constructors

constructor

new TorusGeometryGenerator(
type?: string,
defaultParams?: Partial<TorusGeometryGeneratorParams>,
): TorusGeometryGenerator
Parameters
- type: string = 'torus'
- OptionaldefaultParams: Partial<TorusGeometryGeneratorParams>
Returns TorusGeometryGenerator
Overrides AGeometryGenerator.constructor
- Defined in plugins/geometry-generator/src/primitives/TorusGeometryGenerator.ts:15

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

type

type: string

Methods

`Protected`_generateData

_generateData(
    params: TorusGeometryGeneratorParams,
): {
    indices: number[];
    normals: number[];
    uvs: number[];
    vertices: number[];
}
Parameters
- params: TorusGeometryGeneratorParams
Returns { indices: number[]; normals: number[]; uvs: number[]; vertices: number[] }
Overrides AGeometryGenerator._generateData
- Defined in plugins/geometry-generator/src/primitives/TorusGeometryGenerator.ts:28

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>): TorusGeometryGenerator
Parameters
- params: Partial<Tp>
Returns TorusGeometryGenerator
Inherited from AGeometryGenerator.setDefaultParams
- Defined in plugins/geometry-generator/src/AGeometryGenerator.ts:155

Class TorusGeometryGenerator

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns TorusGeometryGenerator

Properties

`Optional`defaultGeometryClass

`Optional`defaultMaterialClass

defaultMeshClass

defaultParams

type

Methods

`Protected`_generateData

Parameters

Returns { indices: number[]; normals: number[]; uvs: number[]; vertices: number[] }

createUiConfig

Parameters

Returns UiObjectConfig<any, string, any>[]

generate

Parameters

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

setDefaultParams

Parameters

Returns TorusGeometryGenerator

Settings

On This Page

Class TorusGeometryGenerator

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns TorusGeometryGenerator

Properties

OptionaldefaultGeometryClass

OptionaldefaultMaterialClass

defaultMeshClass

defaultParams

type

Methods

Protected_generateData

Parameters

Returns { indices: number[]; normals: number[]; uvs: number[]; vertices: number[] }

createUiConfig

Parameters

Returns UiObjectConfig<any, string, any>[]

generate

Parameters

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

setDefaultParams

Parameters

Returns TorusGeometryGenerator

Settings

On This Page

`Optional`defaultGeometryClass

`Optional`defaultMaterialClass

`Protected`_generateData

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