Class: ShapeTubeExtrudePlugin

Plugins.ShapeTubeExtrudePlugin

Hierarchy

• AViewerPlugin<"">

  ↳ ShapeTubeExtrudePlugin

Properties

PluginType

▪ Static Readonly PluginType: "ShapeTubeExtrudePlugin"

---

enabled

• enabled: boolean = true

Overrides

AViewerPlugin.enabled

---

shapeSegments

• shapeSegments: number = 32

---

tubularSegments

• tubularSegments: number = 32

---

shapeScale

• shapeScale: Vector2

---

materialSplits

• materialSplits: string = '0.3, 0.6'

---

horizontalSplits

• horizontalSplits: boolean = true

---

_dirty

• Protected _dirty: boolean = false

Inherited from

AViewerPlugin._dirty

---

_viewer

• Protected Optional _viewer: ViewerApp

Inherited from

AViewerPlugin._viewer

Methods

CreateCurve

▸ Static CreateCurve(type, params): EllipseCurve3D

Parameters

Name	Type
type	string
params	any

Returns

EllipseCurve3D

---

ExtrudeShape

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

Parameters

Name	Type
shape	Shape
shapeSegments	number
tubularSegments	number
tubeCurve	Curve<Vector3>
shapeScaleX	number
shapeScaleY	number
materialSplits	number[]
horizontalSplits	boolean

Returns

Mesh<BufferGeometry<NormalBufferAttributes, BufferGeometryEventMap>, Material<MaterialEventMap> | Material<MaterialEventMap>[], Object3DEventMap>

---

ConvertGeometryToFlatShape

▸ Static ConvertGeometryToFlatShape(geometry, sort?): any

Parameters

Name	Type	Default value
geometry	BufferGeometry<NormalBufferAttributes, BufferGeometryEventMap>	undefined
sort	boolean	true

Returns

any

---

onDispose

▸ onDispose(viewer): Promise<void>

Parameters

Name	Type
viewer	ViewerApp

Returns

Promise<void>

Inherited from

AViewerPlugin.onDispose

---

onRemove

▸ onRemove(viewer): Promise<void>

Parameters

Name	Type
viewer	ViewerApp

Returns

Promise<void>

Inherited from

AViewerPlugin.onRemove

---

toJSON

▸ toJSON(meta?): any

Parameters

Name	Type
meta?	any

Returns

any

Inherited from

AViewerPlugin.toJSON

---

fromJSON

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

Parameters

Name	Type
data	any
meta?	any

Returns

null | ShapeTubeExtrudePlugin | Promise<null | ShapeTubeExtrudePlugin>

Inherited from

AViewerPlugin.fromJSON

---

exportState

▸ exportState(): any

Returns

any

Inherited from

AViewerPlugin.exportState

---

importState

▸ importState(state): Promise<void>

Parameters

Name	Type
state	any

Returns

Promise<void>

Inherited from

AViewerPlugin.importState

---

storeState

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

Parameters

Name	Type
prefix?	string
storage?	Storage
data?	any

Returns

void

Inherited from

AViewerPlugin.storeState

---

loadState

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

Parameters

Name	Type
prefix?	string
storage?	Storage

Returns

Promise<void>

Inherited from

AViewerPlugin.loadState

---

onAdded

▸ onAdded(viewer): Promise<void>

Parameters

Name	Type
viewer	ViewerApp

Returns

Promise<void>

Overrides

AViewerPlugin.onAdded

---

extrudeCirceTube

▸ extrudeCirceTube(): Promise<void>

Returns

Promise<void>

---

extrudeObject

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

Parameters

Name	Type
object	Mesh<BufferGeometry<NormalBufferAttributes, BufferGeometryEventMap>, Material<MaterialEventMap> | Material<MaterialEventMap>[], Object3DEventMap>
curve	Curve<Vector3>
shapeSegments	number
tubularSegments	number
shapeScale	Vector2
materialSplits	number[]
horizontalSplits	boolean

Returns

Promise<void>

---

_storeKey

▸ Protected _storeKey(prefix?): string

Parameters

Name	Type
prefix?	string

Returns

string

Inherited from

AViewerPlugin._storeKey

Constructors

constructor

• new ShapeTubeExtrudePlugin()

Inherited from

AViewerPlugin.constructor

Accessors

dirty

• get dirty(): boolean

Returns

boolean

Inherited from

AViewerPlugin.dirty

• set dirty(value): void

Parameters

Name	Type
value	boolean

Returns

void

Inherited from

AViewerPlugin.dirty

---

viewer

• get viewer(): undefined | ViewerApp

Returns

undefined | ViewerApp

Inherited from

AViewerPlugin.viewer