Class BasicSVGRendererPlugin

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

Hierarchy

AViewerPluginSync<"">
- BasicSVGRendererPlugin

Index

Constructors

constructor

new BasicSVGRendererPlugin(enabled?, autoAddToContainer?): 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: ((_) => void);
} = ...

Type declaration

postRender: ((_) => void)
- - (_): void
  - Parameters
    - _: IViewerEvent
    Returns 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:107
set dirty(value): void
Parameters
- value: boolean
Returns void
Inherited from AViewerPluginSync.dirty
- Defined in src/viewer/AViewerPlugin.ts:111

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
Parameters
- e: IViewerEvent
Returns IViewerEvent
Inherited from AViewerPluginSync._onViewerEvent
- Defined in src/viewer/AViewerPlugin.ts:63

`Protected` _refreshParams

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

`Protected` _storeKey

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

disable

disable(key): void
Parameters
- key: any
Returns void
Inherited from AViewerPluginSync.disable
- Defined in src/viewer/AViewerPlugin.ts:70

dispose

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

download

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

enable

enable(key): void
Parameters
- key: any
Returns void
Inherited from AViewerPluginSync.enable
- Defined in src/viewer/AViewerPlugin.ts:75

exportState

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

fromJSON

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

importState

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

isDisabled

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

onAdded

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

onRemove

onRemove(viewer): 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
Parameters
- Rest ...args: any[]
Returns any
Inherited from AViewerPluginSync.setDirty
- Defined in src/viewer/AViewerPlugin.ts:84

toJSON

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

Class BasicSVGRendererPlugin

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

enabled: boolean = true

autoAddToContainer: boolean = true

Returns BasicSVGRendererPlugin

Properties

Protected _dirty

Protected Optional _lastStyles

Protected Optional _viewer

Protected _viewerListeners

Type declaration

postRender: ((_) => void)

Parameters

_: IViewerEvent

Returns void

Readonly autoAddToContainer

autoRender

constructor

enabled

Readonly renderer

Optional uiConfig

Static Optional Readonly OldPluginType

Static Readonly PluginType

Accessors

dirty

Returns boolean

Parameters

value: boolean

Returns void

svgNode

Returns SVGElement

Methods

Protected _onResize

Returns void

Protected _onViewerEvent

Parameters

e: IViewerEvent

Returns IViewerEvent

Protected _refreshParams

Returns void

Protected _storeKey

Parameters

Optional prefix: string

Returns string

disable

Parameters

key: any

Returns void

dispose

Returns void

download

Returns void

enable

Parameters

key: any

Returns void

exportState

Returns ISerializedConfig | Record<string, never>

fromJSON

Parameters

data: ISerializedConfig

Optional meta: SerializationMetaType

Returns null | BasicSVGRendererPlugin | Promise<null | BasicSVGRendererPlugin>

importState

Parameters

state: any

Returns Promise<void>

isDisabled

Returns boolean

onAdded

Parameters

viewer: ThreeViewer

`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` prefix: string

`Optional` meta: SerializationMetaType

`Optional` setDirty

`Rest` ...args: any[]

`Optional` meta: SerializationMetaType