Class BasicSVGRendererPlugin

SVG rendering of 3d objects using SVGRenderer from three/addons

Hierarchy

AViewerPluginSync
- BasicSVGRendererPlugin

Index

Constructors

constructor

new BasicSVGRendererPlugin(
enabled?: boolean,
autoAddToContainer?: boolean,
): BasicSVGRendererPlugin
Parameters
- enabled: boolean = true
- autoAddToContainer: boolean = true
  automatically add the svg to the viewer container and style it same as the viewer is position is absolute
Returns BasicSVGRendererPlugin
Overrides AViewerPluginSync.constructor
- Defined in plugins/svg-renderer/src/BasicSVGRendererPlugin.ts:29

Properties

`Protected`_dirty

_dirty: boolean = false

`Protected` `Optional`_lastStyles

_lastStyles?: string = undefined

`Protected` `Optional`_viewer

_viewer?: ThreeViewer

`Protected`_viewerListeners

_viewerListeners: { postRender: (_: IViewerEvent) => void } = ...

`Readonly`autoAddToContainer

autoAddToContainer: boolean = true

automatically add the svg to the viewer container and style it same as the viewer is position is absolute

autoRender

autoRender: boolean = true

constructor

constructor: typeof AViewerPluginSync & typeof AViewerPlugin

enabled

enabled: boolean = true

`Readonly`renderer

renderer: BasicSVGRenderer = ...

`Optional`uiConfig

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

`Static` `Optional` `Readonly`OldPluginType

OldPluginType?: string

`Static` `Readonly`PluginType

PluginType: "BasicSVGRendererPlugin" = 'BasicSVGRendererPlugin'

Accessors

dirty

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

svgNode

get svgNode(): SVGElement
Returns SVGElement
- Defined in plugins/svg-renderer/src/BasicSVGRendererPlugin.ts:100

Methods

`Protected`_onResize

_onResize(): void
Returns void
- Defined in plugins/svg-renderer/src/BasicSVGRendererPlugin.ts:108

`Protected`_onViewerEvent

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

`Protected`_refreshParams

_refreshParams(): void
Returns void
- Defined in plugins/svg-renderer/src/BasicSVGRendererPlugin.ts:104

`Protected`_storeKey

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

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

dispose

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

download

download(): void
Returns void
- Defined in plugins/svg-renderer/src/BasicSVGRendererPlugin.ts:88

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

exportState

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

fromJSON

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

importState

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

isDisabled

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

onAdded

onAdded(viewer: ThreeViewer): void
Parameters
- viewer: ThreeViewer
Returns void
Overrides AViewerPluginSync.onAdded
- Defined in plugins/svg-renderer/src/BasicSVGRendererPlugin.ts:38

onRemove

onRemove(viewer: ThreeViewer): void
Parameters
- viewer: ThreeViewer
Returns void
Overrides AViewerPluginSync.onRemove
- Defined in plugins/svg-renderer/src/BasicSVGRendererPlugin.ts:63

render

render(): void
Returns void
- Defined in plugins/svg-renderer/src/BasicSVGRendererPlugin.ts:81

`Optional`setDirty

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

toJSON

toJSON(meta?: SerializationMetaType): ISerializedConfig
Parameters
- Optionalmeta: SerializationMetaType
Returns ISerializedConfig
Inherited from AViewerPluginSync.toJSON
- Defined in src/viewer/AViewerPlugin.ts:38

Class BasicSVGRendererPlugin

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns BasicSVGRendererPlugin

Properties

Protected_dirty

Protected Optional_lastStyles

Protected Optional_viewer

Protected_viewerListeners

ReadonlyautoAddToContainer

autoRender

constructor

enabled

Readonlyrenderer

OptionaluiConfig

Static Optional ReadonlyOldPluginType

Static ReadonlyPluginType

Accessors

dirty

Returns boolean

Parameters

Returns void

svgNode

Returns SVGElement

Methods

Protected_onResize

Returns void

Protected_onViewerEvent

Parameters

Returns IViewerEvent

Protected_refreshParams

Returns void

Protected_storeKey

Parameters

Returns string

disable

Parameters

Returns void

dispose

Returns void

download

Returns void

enable

Parameters

Returns void

exportState

Returns ISerializedConfig | Record<string, never>

fromJSON

Parameters

Returns null | BasicSVGRendererPlugin | Promise<null | BasicSVGRendererPlugin>

importState

Parameters

Returns Promise<void>

isDisabled

Returns boolean

onAdded

Parameters

Returns void

onRemove

Parameters

Returns void

render

Returns void

OptionalsetDirty

Parameters

Returns any

toJSON

Parameters

Returns ISerializedConfig

Settings

On This Page

`Protected`_dirty

`Protected` `Optional`_lastStyles

`Protected` `Optional`_viewer

`Protected`_viewerListeners

`Readonly`autoAddToContainer

`Readonly`renderer

`Optional`uiConfig

`Static` `Optional` `Readonly`OldPluginType

`Static` `Readonly`PluginType

`Protected`_onResize

`Protected`_onViewerEvent

`Protected`_refreshParams

`Protected`_storeKey

`Optional`setDirty