Skip to main content

Class: ShapeTubeExtrudePlugin

Plugins.ShapeTubeExtrudePlugin

Hierarchy

Properties

PluginType

Static Readonly PluginType: "ShapeTubeExtrudePlugin"

Defined in

webgi/src/plugins/ShapeTubeExtrudePlugin.ts:15


enabled

enabled: boolean = true

Overrides

AViewerPlugin.enabled

Defined in

webgi/src/plugins/ShapeTubeExtrudePlugin.ts:13


shapeSegments

shapeSegments: number = 32

Defined in

webgi/src/plugins/ShapeTubeExtrudePlugin.ts:25


tubularSegments

tubularSegments: number = 32

Defined in

webgi/src/plugins/ShapeTubeExtrudePlugin.ts:29


shapeScale

shapeScale: Vector2

Defined in

webgi/src/plugins/ShapeTubeExtrudePlugin.ts:33


materialSplits

materialSplits: string = '0.3, 0.6'

Defined in

webgi/src/plugins/ShapeTubeExtrudePlugin.ts:37


horizontalSplits

horizontalSplits: boolean = true

Defined in

webgi/src/plugins/ShapeTubeExtrudePlugin.ts:41


_dirty

Protected _dirty: boolean = false

Inherited from

AViewerPlugin._dirty

Defined in

webgi/src/core/AViewerPlugin.ts:25


_viewer

Protected Optional _viewer: ViewerApp

Inherited from

AViewerPlugin._viewer

Defined in

webgi/src/core/AViewerPlugin.ts:29

Methods

CreateCurve

Static CreateCurve(type, params): EllipseCurve3D

Parameters

NameType
typestring
paramsany

Returns

EllipseCurve3D

Defined in

webgi/src/plugins/ShapeTubeExtrudePlugin.ts:56


ExtrudeShape

Static ExtrudeShape(shape, shapeSegments, tubularSegments, tubeCurve, shapeScaleX, shapeScaleY, materialSplits, horizontalSplits): Mesh<BufferGeometry, Material | Material[]>

Parameters

NameType
shapeShape
shapeSegmentsnumber
tubularSegmentsnumber
tubeCurveCurve<Vector3>
shapeScaleXnumber
shapeScaleYnumber
materialSplitsnumber[]
horizontalSplitsboolean

Returns

Mesh<BufferGeometry, Material | Material[]>

Defined in

webgi/src/plugins/ShapeTubeExtrudePlugin.ts:137


ConvertGeometryToFlatShape

Static ConvertGeometryToFlatShape(geometry, sort?): any

Parameters

NameTypeDefault value
geometryBufferGeometryundefined
sortbooleantrue

Returns

any

Defined in

webgi/src/plugins/ShapeTubeExtrudePlugin.ts:155


onDispose

onDispose(viewer): Promise<void>

Parameters

NameType
viewerViewerApp

Returns

Promise<void>

Inherited from

AViewerPlugin.onDispose

Defined in

webgi/src/core/AViewerPlugin.ts:38


onRemove

onRemove(viewer): Promise<void>

Parameters

NameType
viewerViewerApp

Returns

Promise<void>

Inherited from

AViewerPlugin.onRemove

Defined in

webgi/src/core/AViewerPlugin.ts:42


toJSON

toJSON(meta?): any

Parameters

NameType
meta?any

Returns

any

Inherited from

AViewerPlugin.toJSON

Defined in

webgi/src/core/AViewerPlugin.ts:47


fromJSON

fromJSON(data, meta?): null | ShapeTubeExtrudePlugin | Promise<null | ShapeTubeExtrudePlugin>

Parameters

NameType
dataany
meta?any

Returns

null | ShapeTubeExtrudePlugin | Promise<null | ShapeTubeExtrudePlugin>

Inherited from

AViewerPlugin.fromJSON

Defined in

webgi/src/core/AViewerPlugin.ts:54


addEventListener

addEventListener(type, listener): void

Adds a listener to an event type.

Parameters

NameType
type"" | "serialize" | "deserialize"
listener(event: IEvent<"" | "serialize" | "deserialize">) => void

Returns

void

Inherited from

AViewerPlugin.addEventListener

Defined in

webgi/src/helpers/EventDispatcher.ts:48


hasEventListener

hasEventListener(type, listener): boolean

Checks if listener is added to an event type.

Parameters

NameType
type"" | "serialize" | "deserialize"
listener(event: IEvent<"" | "serialize" | "deserialize">) => void

Returns

boolean

Inherited from

AViewerPlugin.hasEventListener

Defined in

webgi/src/helpers/EventDispatcher.ts:56


removeEventListener

removeEventListener(type, listener): void

Removes a listener from an event type.

Parameters

NameType
type"" | "serialize" | "deserialize"
listener(event: IEvent<"" | "serialize" | "deserialize">) => void

Returns

void

Inherited from

AViewerPlugin.removeEventListener

Defined in

webgi/src/helpers/EventDispatcher.ts:63


dispatchEvent

dispatchEvent(event): void

Fire an event type.

Parameters

NameType
eventIEvent<"" | "serialize" | "deserialize">

Returns

void

Inherited from

AViewerPlugin.dispatchEvent

Defined in

webgi/src/helpers/EventDispatcher.ts:74


onAdded

onAdded(viewer): Promise<void>

Parameters

NameType
viewerViewerApp

Returns

Promise<void>

Overrides

AViewerPlugin.onAdded

Defined in

webgi/src/plugins/ShapeTubeExtrudePlugin.ts:17


extrudeCirceTube

extrudeCirceTube(): Promise<void>

Returns

Promise<void>

Defined in

webgi/src/plugins/ShapeTubeExtrudePlugin.ts:46


extrudeObject

extrudeObject(object, curve, shapeSegments?, tubularSegments?, shapeScale?, materialSplits?, horizontalSplits?): Promise<void>

Parameters

NameType
objectMesh<BufferGeometry, Material | Material[]>
curveCurve<Vector3>
shapeSegmentsnumber
tubularSegmentsnumber
shapeScaleVector2
materialSplitsnumber[]
horizontalSplitsboolean

Returns

Promise<void>

Defined in

webgi/src/plugins/ShapeTubeExtrudePlugin.ts:63

Accessors

dirty

get dirty(): boolean

Returns

boolean

Inherited from

AViewerPlugin.dirty

Defined in

webgi/src/core/AViewerPlugin.ts:18

set dirty(value): void

Parameters

NameType
valueboolean

Returns

void

Inherited from

AViewerPlugin.dirty

Defined in

webgi/src/core/AViewerPlugin.ts:22

Constructors

constructor

new ShapeTubeExtrudePlugin()

Inherited from

AViewerPlugin.constructor

Defined in

webgi/src/helpers/EventDispatcher.ts:39