Class: ShapeTubeExtrudePlugin
Plugins.ShapeTubeExtrudePlugin
Hierarchy
AViewerPlugin
<""
>↳
ShapeTubeExtrudePlugin
Properties
PluginType
▪ Static
Readonly
PluginType: "ShapeTubeExtrudePlugin"
Defined in
webgi/src/plugins/ShapeTubeExtrudePlugin.ts:25
enabled
• enabled: boolean
= true
Overrides
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
Defined in
webgi/src/core/AViewerPlugin.ts:23
_viewer
• Protected
Optional
_viewer: ViewerApp
Inherited from
Defined in
webgi/src/core/AViewerPlugin.ts:27
Methods
CreateCurve
▸ Static
CreateCurve(type
, params
): EllipseCurve3D
Parameters
Name | Type |
---|---|
type | string |
params | any |
Returns
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
Name | Type |
---|---|
shape | Shape |
shapeSegments | number |
tubularSegments | number |
tubeCurve | Curve <Vector3 > |
shapeScaleX | number |
shapeScaleY | number |
materialSplits | number [] |
horizontalSplits | boolean |
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
Name | Type | Default value |
---|---|---|
geometry | BufferGeometry <NormalBufferAttributes , Event , string > | undefined |
sort | boolean | true |
Returns
any
Defined in
webgi/src/plugins/ShapeTubeExtrudePlugin.ts:165
onDispose
▸ onDispose(viewer
): Promise
<void
>
Parameters
Name | Type |
---|---|
viewer | ViewerApp |
Returns
Promise
<void
>
Inherited from
Defined in
webgi/src/core/AViewerPlugin.ts:36
onRemove
▸ onRemove(viewer
): Promise
<void
>
Parameters
Name | Type |
---|---|
viewer | ViewerApp |
Returns
Promise
<void
>
Inherited from
Defined in
webgi/src/core/AViewerPlugin.ts:40
toJSON
▸ toJSON(meta?
): any
Parameters
Name | Type |
---|---|
meta? | any |
Returns
any
Inherited from
Defined in
webgi/src/core/AViewerPlugin.ts:45
fromJSON
▸ fromJSON(data
, meta?
): null
| ShapeTubeExtrudePlugin
| Promise
<null
| ShapeTubeExtrudePlugin
>
Parameters
Name | Type |
---|---|
data | any |
meta? | any |
Returns
null
| ShapeTubeExtrudePlugin
| Promise
<null
| ShapeTubeExtrudePlugin
>
Inherited from
Defined in
webgi/src/core/AViewerPlugin.ts:52
exportState
▸ exportState(): any
Returns
any
Inherited from
Defined in
webgi/src/core/AViewerPlugin.ts:64
importState
▸ importState(state
): Promise
<void
>
Parameters
Name | Type |
---|---|
state | any |
Returns
Promise
<void
>
Inherited from
Defined in
webgi/src/core/AViewerPlugin.ts:67
storeState
▸ storeState(prefix?
, storage?
, data?
): void
Parameters
Name | Type |
---|---|
prefix? | string |
storage? | Storage |
data? | any |
Returns
void
Inherited from
Defined in
webgi/src/core/AViewerPlugin.ts:74
loadState
▸ loadState(prefix?
, storage?
): Promise
<void
>
Parameters
Name | Type |
---|---|
prefix? | string |
storage? | Storage |
Returns
Promise
<void
>
Inherited from
Defined in
webgi/src/core/AViewerPlugin.ts:84
onAdded
▸ onAdded(viewer
): Promise
<void
>
Parameters
Name | Type |
---|---|
viewer | ViewerApp |
Returns
Promise
<void
>
Overrides
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
Name | Type |
---|---|
object | Mesh <BufferGeometry <NormalBufferAttributes , Event , string >, Material <Event , string > | Material <Event , string >[]> |
curve | Curve <Vector3 > |
shapeSegments | number |
tubularSegments | number |
shapeScale | Vector2 |
materialSplits | number [] |
horizontalSplits | boolean |
Returns
Promise
<void
>
Defined in
webgi/src/plugins/ShapeTubeExtrudePlugin.ts:73
_storeKey
▸ Protected
_storeKey(prefix?
): string
Parameters
Name | Type |
---|---|
prefix? | string |
Returns
string
Inherited from
Defined in
webgi/src/core/AViewerPlugin.ts:60
Constructors
constructor
• new ShapeTubeExtrudePlugin()
Inherited from
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
Name | Type |
---|---|
value | boolean |
Returns
void
Inherited from
AViewerPlugin.dirty