Class TubeShapeGeometryGenerator

Generates a tube geometry with arbitrary shape cross-section along a 3D curve path. Uses the custom TubeShapeGeometry internally, which supports non-circular cross-sections, shape scaling, and multi-material splits.

Hierarchy (View Summary)

AGeometryGenerator<TubeShapeGeometryGeneratorParams>
- TubeShapeGeometryGenerator

Index

Constructors

constructor

new TubeShapeGeometryGenerator(
type?: string,
defaultParams?: Partial<TubeShapeGeometryGeneratorParams>,
): TubeShapeGeometryGenerator
Parameters
- type: string = 'tubeShape'
- OptionaldefaultParams: Partial<TubeShapeGeometryGeneratorParams>
Returns TubeShapeGeometryGenerator
Overrides AGeometryGenerator.constructor
- Defined in src/plugins/geometry/primitives/TubeShapeGeometryGenerator.ts:39

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

type

type: string

Methods

`Protected`_generateData

_generateData(
    params: TubeShapeGeometryGeneratorParams,
): {
    groups?: { count: number; materialIndex?: number; start: number }[];
    indices: number[] | BufferAttribute;
    normals: Float32BufferAttribute;
    uvs: Float32BufferAttribute;
    vertices: Float32BufferAttribute;
}
Parameters
- params: TubeShapeGeometryGeneratorParams
Returns {
    groups?: { count: number; materialIndex?: number; start: number }[];
    indices: number[] | BufferAttribute;
    normals: Float32BufferAttribute;
    uvs: Float32BufferAttribute;
    vertices: Float32BufferAttribute;
}
Overrides AGeometryGenerator._generateData
- Defined in src/plugins/geometry/primitives/TubeShapeGeometryGenerator.ts:62

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/TubeShapeGeometryGenerator.ts:117

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

Class TubeShapeGeometryGenerator

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns TubeShapeGeometryGenerator

Properties

`Optional`defaultGeometryClass

`Optional`defaultMaterialClass

defaultMeshClass

defaultParams

type

Methods

`Protected`_generateData

Parameters

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

createUiConfig

Parameters

Returns UiObjectConfig<any, string, any>[]

generate

Parameters

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

setDefaultParams

Parameters

Returns TubeShapeGeometryGenerator

Settings

On This Page

Class TubeShapeGeometryGenerator

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns TubeShapeGeometryGenerator

Properties

OptionaldefaultGeometryClass

OptionaldefaultMaterialClass

defaultMeshClass

defaultParams

type

Methods

Protected_generateData

Parameters

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

createUiConfig

Parameters

Returns UiObjectConfig<any, string, any>[]

generate

Parameters

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

setDefaultParams

Parameters

Returns TubeShapeGeometryGenerator

Settings

On This Page

`Optional`defaultGeometryClass

`Optional`defaultMaterialClass

`Protected`_generateData

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

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