Class GeometryUVPreviewPlugin<TEvent>

Base Class for Sync Viewer Plugins

Type Parameters

TEvent extends string

Hierarchy (view full)

AViewerPluginSync<TEvent>
- GeometryUVPreviewPlugin

Index

Constructors

constructor

new GeometryUVPreviewPlugin<TEvent>(enabled?): GeometryUVPreviewPlugin<TEvent>
Type Parameters
- TEvent extends string
Parameters
- enabled: boolean = true
Returns GeometryUVPreviewPlugin<TEvent>
Overrides AViewerPluginSync.constructor
- Defined in src/plugins/ui/GeometryUVPreviewPlugin.ts:28

Properties

`Protected` _dirty

_dirty: boolean = false

`Protected` `Optional` _viewer

_viewer?: ThreeViewer

`Protected` _viewerListeners

_viewerListeners: PartialRecord<"update" | "dispose" | "preRender" | "postRender" | "preFrame" | "postFrame" | "*" | "addPlugin" | "renderEnabled" | "renderDisabled", ((e) => void)> = {}

Type declaration

- (e): void
- Parameters
  - e: IViewerEvent
  Returns void

constructor

constructor: typeof AViewerPluginSync & typeof AViewerPlugin

enabled

enabled: boolean = true

mainDiv

mainDiv: HTMLDivElement = ...

`Optional` stylesheet

stylesheet?: HTMLStyleElement

targetBlocks

targetBlocks: TargetBlock[] = []

toJSON

toJSON: any = null

`Optional` uiConfig

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

`Static` `Readonly` PluginType

PluginType: "GeometryUVPreviewPlugin" = 'GeometryUVPreviewPlugin'

Accessors

dirty

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

Methods

`Protected` _onViewerEvent

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

`Private` _postRender

_postRender(): void
Returns void
- Defined in src/plugins/ui/GeometryUVPreviewPlugin.ts:51

`Protected` _storeKey

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

addGeometry

addGeometry(target, name, visible?): this
Parameters
- target: ValOrFunc<undefined | IGeometry<NormalBufferAttributes>>
- name: string
- visible: boolean = true
Returns this
- Defined in src/plugins/ui/GeometryUVPreviewPlugin.ts:70

disable

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

dispose

dispose(): void
Returns void
Overrides AViewerPluginSync.dispose
- Defined in src/plugins/ui/GeometryUVPreviewPlugin.ts:145

downloadGeometryUV

downloadGeometryUV(targetDef): this
Parameters
- targetDef: TargetBlock
Returns this
- Defined in src/plugins/ui/GeometryUVPreviewPlugin.ts:111

enable

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

exportState

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

fromJSON

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

importState

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

isDisabled

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

removeGeometry

removeGeometry(target): this
Parameters
- target: ValOrFunc<undefined | IGeometry<NormalBufferAttributes>>
Returns this
- Defined in src/plugins/ui/GeometryUVPreviewPlugin.ts:100

setDirty

setDirty(): void
Returns void
Overrides AViewerPluginSync.setDirty
- Defined in src/plugins/ui/GeometryUVPreviewPlugin.ts:141

Class GeometryUVPreviewPlugin<TEvent>

Type Parameters

TEvent extends string

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

TEvent extends string

Parameters

enabled: boolean = true

Returns GeometryUVPreviewPlugin<TEvent>

Properties

Protected _dirty

Protected Optional _viewer

Protected _viewerListeners

Type declaration

Parameters

e: IViewerEvent

Returns void

constructor

enabled

mainDiv

Optional stylesheet

targetBlocks

toJSON

Optional uiConfig

Static Readonly PluginType

Accessors

dirty

Returns boolean

Parameters

value: boolean

Returns void

Methods

Protected _onViewerEvent

Parameters

e: IViewerEvent

Returns IViewerEvent

Private _postRender

Returns void

Protected _storeKey

Parameters

Optional prefix: string

Returns string

addGeometry

Parameters

target: ValOrFunc<undefined | IGeometry<NormalBufferAttributes>>

name: string

visible: boolean = true

Returns this

disable

Parameters

key: any

Returns void

dispose

Returns void

downloadGeometryUV

Parameters

targetDef: TargetBlock

Returns this

enable

Parameters

key: any

Returns void

exportState

Returns ISerializedConfig | Record<string, never>

fromJSON

Parameters

data: ISerializedConfig

Optional meta: SerializationMetaType

Returns null | GeometryUVPreviewPlugin<TEvent> | Promise<null | GeometryUVPreviewPlugin<TEvent>>

importState

Parameters

state: any

Returns Promise<void>

`Protected` _dirty

`Protected` `Optional` _viewer

`Protected` _viewerListeners

`Optional` stylesheet

`Optional` uiConfig

`Static` `Readonly` PluginType

`Protected` _onViewerEvent

`Private` _postRender

`Protected` _storeKey

`Optional` prefix: string

`Optional` meta: SerializationMetaType