Skip to main content

Class: ShapeTubeExtrudePlugin

Plugins.ShapeTubeExtrudePlugin

Hierarchy

Properties

PluginType

Static Readonly PluginType: "ShapeTubeExtrudePlugin"

Defined in

webgi/src/plugins/ShapeTubeExtrudePlugin.ts:25


enabled

enabled: boolean = true

Overrides

AViewerPlugin.enabled

Defined in

webgi/src/plugins/ShapeTubeExtrudePlugin.ts:23


shapeSegments

shapeSegments: number = 32

Defined in

webgi/src/plugins/ShapeTubeExtrudePlugin.ts:35


tubularSegments

tubularSegments: number = 32

Defined in

webgi/src/plugins/ShapeTubeExtrudePlugin.ts:39


shapeScale

shapeScale: Vector2

Defined in

webgi/src/plugins/ShapeTubeExtrudePlugin.ts:43


materialSplits

materialSplits: string = '0.3, 0.6'

Defined in

webgi/src/plugins/ShapeTubeExtrudePlugin.ts:47


horizontalSplits

horizontalSplits: boolean = true

Defined in

webgi/src/plugins/ShapeTubeExtrudePlugin.ts:51


_dirty

Protected _dirty: boolean = false

Inherited from

AViewerPlugin._dirty

Defined in

webgi/src/core/AViewerPlugin.ts:23


_viewer

Protected Optional _viewer: ViewerApp

Inherited from

AViewerPlugin._viewer

Defined in

webgi/src/core/AViewerPlugin.ts:27

Methods

CreateCurve

Static CreateCurve(type, params): EllipseCurve3D

Parameters

NameType
typestring
paramsany

Returns

EllipseCurve3D

Defined in

webgi/src/plugins/ShapeTubeExtrudePlugin.ts:66


ExtrudeShape

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

Parameters

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

Returns

Mesh<BufferGeometry<NormalBufferAttributes, Event, string>, Material<Event, string> | Material<Event, string>[]>

Defined in

webgi/src/plugins/ShapeTubeExtrudePlugin.ts:147


ConvertGeometryToFlatShape

Static ConvertGeometryToFlatShape(geometry, sort?): any

Parameters

NameTypeDefault value
geometryBufferGeometry<NormalBufferAttributes, Event, string>undefined
sortbooleantrue

Returns

any

Defined in

webgi/src/plugins/ShapeTubeExtrudePlugin.ts:165


onDispose

onDispose(viewer): Promise<void>

Parameters

NameType
viewerViewerApp

Returns

Promise<void>

Inherited from

AViewerPlugin.onDispose

Defined in

webgi/src/core/AViewerPlugin.ts:36


onRemove

onRemove(viewer): Promise<void>

Parameters

NameType
viewerViewerApp

Returns

Promise<void>

Inherited from

AViewerPlugin.onRemove

Defined in

webgi/src/core/AViewerPlugin.ts:40


toJSON

toJSON(meta?): any

Parameters

NameType
meta?any

Returns

any

Inherited from

AViewerPlugin.toJSON

Defined in

webgi/src/core/AViewerPlugin.ts:45


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:52


exportState

exportState(): any

Returns

any

Inherited from

AViewerPlugin.exportState

Defined in

webgi/src/core/AViewerPlugin.ts:64


importState

importState(state): Promise<void>

Parameters

NameType
stateany

Returns

Promise<void>

Inherited from

AViewerPlugin.importState

Defined in

webgi/src/core/AViewerPlugin.ts:67


storeState

storeState(prefix?, storage?, data?): void

Parameters

NameType
prefix?string
storage?Storage
data?any

Returns

void

Inherited from

AViewerPlugin.storeState

Defined in

webgi/src/core/AViewerPlugin.ts:74


loadState

loadState(prefix?, storage?): Promise<void>

Parameters

NameType
prefix?string
storage?Storage

Returns

Promise<void>

Inherited from

AViewerPlugin.loadState

Defined in

webgi/src/core/AViewerPlugin.ts:84


onAdded

onAdded(viewer): Promise<void>

Parameters

NameType
viewerViewerApp

Returns

Promise<void>

Overrides

AViewerPlugin.onAdded

Defined in

webgi/src/plugins/ShapeTubeExtrudePlugin.ts:27


extrudeCirceTube

extrudeCirceTube(): Promise<void>

Returns

Promise<void>

Defined in

webgi/src/plugins/ShapeTubeExtrudePlugin.ts:56


extrudeObject

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

Parameters

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

Returns

Promise<void>

Defined in

webgi/src/plugins/ShapeTubeExtrudePlugin.ts:73


_storeKey

Protected _storeKey(prefix?): string

Parameters

NameType
prefix?string

Returns

string

Inherited from

AViewerPlugin._storeKey

Defined in

webgi/src/core/AViewerPlugin.ts:60

Constructors

constructor

new ShapeTubeExtrudePlugin()

Inherited from

AViewerPlugin.constructor

Defined in

webgi/node_modules/ts-browser-helpers/dist/EventDispatcher.d.ts:41

Accessors

dirty

get dirty(): boolean

Returns

boolean

Inherited from

AViewerPlugin.dirty

Defined in

webgi/src/core/AViewerPlugin.ts:16

set dirty(value): void

Parameters

NameType
valueboolean

Returns

void

Inherited from

AViewerPlugin.dirty

Defined in

webgi/src/core/AViewerPlugin.ts:20