Class ShapeTubeExtrudePlugin

ShapeTubeExtrudePlugin

Provides interactive extrusion of flat geometry along a curve path. Takes a selected planar mesh, auto-detects its flat axis, extracts a 2D Shape from the vertices, then extrudes it along a curve using the TubeShape geometry generator.

Features:

Extrude any flat geometry along a circle curve
Auto-detect planar axis (X, Y, or Z) and extract 2D shape
Configurable shape/tube segments, shape scale, and material splits
Multi-material support via configurable split positions

This could also be used as a sample plugin to create custom interactive geometry plugins.

Hierarchy (View Summary)

AViewerPluginSync
- ShapeTubeExtrudePlugin

Constructors

constructor

new ShapeTubeExtrudePlugin(): ShapeTubeExtrudePlugin
Creates THREE.EventDispatcher | EventDispatcher object.

Returns ShapeTubeExtrudePlugin
Inherited from AViewerPluginSync.constructor
- Defined in node_modules/@types/three/src/core/EventDispatcher.d.ts:55

Properties

`Protected`_dirty

_dirty: boolean = false

dependencies

dependencies: (typeof PickingPlugin | typeof GeometryGeneratorPlugin)[] = ...

enabled

enabled: boolean = true

horizontalSplits

horizontalSplits: boolean = true

isViewerPluginSync

isViewerPluginSync: true = ...

materialSplits

materialSplits: string = '0.3, 0.6'

shapeScaleX

shapeScaleX: number = 1

shapeScaleY

shapeScaleY: number = 1

shapeSegments

shapeSegments: number = 32

toJSON

toJSON: any = undefined

tubularSegments

tubularSegments: number = 32

`Optional`uiConfig

uiConfig?: UiObjectConfig<any, string, any> = undefined

`Static` `Optional` `Readonly`OldPluginType

OldPluginType?: string

`Static` `Readonly`PluginType

PluginType: "ShapeTubeExtrudePlugin" = 'ShapeTubeExtrudePlugin'

Accessors

dirty

get dirty(): boolean
Returns boolean
Inherited from AViewerPluginSync.dirty
- Defined in src/viewer/AViewerPlugin.ts:113
set dirty(value: boolean): void
Parameters
- value: boolean
Returns void
Inherited from AViewerPluginSync.dirty
- Defined in src/viewer/AViewerPlugin.ts:117

Methods

`Protected`_onViewerEvent

_onViewerEvent(e: IViewerEvent): IViewerEvent
Parameters
- e: IViewerEvent
Returns IViewerEvent
Inherited from AViewerPluginSync._onViewerEvent
- Defined in src/viewer/AViewerPlugin.ts:69

`Protected`_storeKey

_storeKey(prefix?: string): string
Parameters
- Optionalprefix: string
Returns string
Inherited from AViewerPluginSync._storeKey
- Defined in src/viewer/AViewerPlugin.ts:55

disable

disable(key: any, setDirty?: boolean): void
Parameters
- key: any
- setDirty: boolean = true
Returns void
Inherited from AViewerPluginSync.disable
- Defined in src/viewer/AViewerPlugin.ts:76

dispose

dispose(): void
Returns void
Inherited from AViewerPluginSync.dispose
- Defined in src/viewer/AViewerPlugin.ts:35

enable

enable(key: any, setDirty?: boolean): void
Parameters
- key: any
- setDirty: boolean = true
Returns void
Inherited from AViewerPluginSync.enable
- Defined in src/viewer/AViewerPlugin.ts:81

exportState

exportState(): ISerializedConfig | Record<string, never>
Returns ISerializedConfig | Record<string, never>
Inherited from AViewerPluginSync.exportState
- Defined in src/viewer/AViewerPlugin.ts:60

extrudeCircleTube

extrudeCircleTube(): Promise<void>
Returns Promise<void>
- Defined in src/plugins/geometry/ShapeTubeExtrudePlugin.ts:59

extrudeObject

extrudeObject(
    object: Mesh,
    curve: any,
    shapeSegments?: number,
    tubularSegments?: number,
    shapeScaleX?: number,
    shapeScaleY?: number,
    materialSplits?: string,
    horizontalSplits?: boolean,
): void
Extrude a mesh's geometry along a curve path. The mesh must be a flat/planar geometry (aligned to one axis).
Parameters
- object: Mesh
- curve: any
- shapeSegments: number = ...
- tubularSegments: number = ...
- shapeScaleX: number = ...
- shapeScaleY: number = ...
- materialSplits: string = ...
- horizontalSplits: boolean = ...
Returns void
- Defined in src/plugins/geometry/ShapeTubeExtrudePlugin.ts:73

fromJSON

fromJSON(
data: ISerializedConfig,
meta?: SerializationMetaType,
): null | ShapeTubeExtrudePlugin | Promise<null | ShapeTubeExtrudePlugin>
Parameters
- data: ISerializedConfig
- Optionalmeta: SerializationMetaType
Returns null | ShapeTubeExtrudePlugin | Promise<null | ShapeTubeExtrudePlugin>
Inherited from AViewerPluginSync.fromJSON
- Defined in src/viewer/AViewerPlugin.ts:47

importState

importState(state: any): Promise<void>
Parameters
- state: any
Returns Promise<void>
Inherited from AViewerPluginSync.importState
- Defined in src/viewer/AViewerPlugin.ts:63

isDisabled

isDisabled(): boolean
Returns boolean
Inherited from AViewerPluginSync.isDisabled
- Defined in src/viewer/AViewerPlugin.ts:86

onAdded

onAdded(viewer: ThreeViewer): void
Parameters
- viewer: ThreeViewer
Returns void
Inherited from AViewerPluginSync.onAdded
- Defined in src/viewer/AViewerPlugin.ts:148

onRemove

onRemove(viewer: ThreeViewer): void
Parameters
- viewer: ThreeViewer
Returns void
Inherited from AViewerPluginSync.onRemove
- Defined in src/viewer/AViewerPlugin.ts:152

`Optional`setDirty

setDirty(...args: any[]): any
Parameters
- ...args: any[]
Returns any
Inherited from AViewerPluginSync.setDirty
- Defined in src/viewer/AViewerPlugin.ts:90

`Static`ConvertGeometryToFlatShape

ConvertGeometryToFlatShape(geometry: BufferGeometry, sort?: boolean): Shape
Convert a planar 3D geometry to a 2D Shape by auto-detecting the flat axis. The geometry must be aligned to one of the principal axes (X, Y, or Z bounding box extent near zero).
Parameters
- geometry: BufferGeometry
  The geometry to convert (must be planar/flat)
- sort: boolean = true
  Whether to sort points starting from the leftmost point
Returns Shape
A 2D Shape suitable for extrusion

Throws
If geometry has no position attribute, is too large (>500 vertices), or is not axis-aligned planar
- Defined in src/plugins/geometry/ShapeTubeExtrudePlugin.ts:192

`Static`ExtrudeShape

ExtrudeShape(
    viewer: ThreeViewer,
    shape: Shape,
    curve: any,
    shapeSegments?: number,
    tubularSegments?: number,
    shapeScaleX?: number,
    shapeScaleY?: number,
    materialSplits?: string,
    horizontalSplits?: boolean,
):
    | undefined
    | IMesh<
        IObject3DEventMap,
        IGeometry<NormalBufferAttributes, BufferGeometryEventMap>,
        IMaterial<IMaterialEventMap> | IMaterial<IMaterialEventMap>[],
    >
Programmatic helper to extrude a shape along a curve.
Parameters
- viewer: ThreeViewer
- shape: Shape
- curve: any
- shapeSegments: number = 32
- tubularSegments: number = 64
- shapeScaleX: number = 1
- shapeScaleY: number = 1
- materialSplits: string = ''
- horizontalSplits: boolean = true
Returns
    | undefined
    | IMesh<
        IObject3DEventMap,
        IGeometry<NormalBufferAttributes, BufferGeometryEventMap>,
        IMaterial<IMaterialEventMap> | IMaterial<IMaterialEventMap>[],
    >
- Defined in src/plugins/geometry/ShapeTubeExtrudePlugin.ts:155

Class ShapeTubeExtrudePlugin

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns ShapeTubeExtrudePlugin

Properties

Protected_dirty

Protected Optional_viewer

Protected_viewerListeners

constructor

dependencies

enabled

horizontalSplits

isViewerPluginSync

materialSplits

shapeScaleX

shapeScaleY

shapeSegments

toJSON

tubularSegments

OptionaluiConfig

Static Optional ReadonlyOldPluginType

Static ReadonlyPluginType

Accessors

dirty

Returns boolean

Parameters

Returns void

Methods

Protected_onViewerEvent

Parameters

Returns IViewerEvent

Protected_storeKey

Parameters

Returns string

disable

Parameters

Returns void

dispose

Returns void

enable

Parameters

Returns void

exportState

Returns ISerializedConfig | Record<string, never>

extrudeCircleTube

Returns Promise<void>

extrudeObject

Parameters

Returns void

fromJSON

Parameters

Returns null | ShapeTubeExtrudePlugin | Promise<null | ShapeTubeExtrudePlugin>

importState

Parameters

Returns Promise<void>

isDisabled

Returns boolean

onAdded

Parameters

Returns void

onRemove

Parameters

Returns void

OptionalsetDirty

Parameters

Returns any

StaticConvertGeometryToFlatShape

Parameters

Returns Shape

Throws

StaticExtrudeShape

Parameters

Returns | undefined | IMesh< IObject3DEventMap, IGeometry<NormalBufferAttributes, BufferGeometryEventMap>, IMaterial<IMaterialEventMap> | IMaterial<IMaterialEventMap>[], >

Settings

`Protected`_dirty

`Protected` `Optional`_viewer

`Protected`_viewerListeners

`Optional`uiConfig

`Static` `Optional` `Readonly`OldPluginType

`Static` `Readonly`PluginType

`Protected`_onViewerEvent

`Protected`_storeKey

`Optional`setDirty

`Static`ConvertGeometryToFlatShape

`Static`ExtrudeShape

Returns
| undefined
| IMesh<
IObject3DEventMap,
IGeometry<NormalBufferAttributes, BufferGeometryEventMap>,
IMaterial<IMaterialEventMap> | IMaterial<IMaterialEventMap>[],
>