Class GeometryUVPreviewPlugin<TEvent>

Base Class for Sync Viewer Plugins

Type Parameters

TEvent extends string

Hierarchy (View Summary)

AViewerPluginSync<TEvent>
- GeometryUVPreviewPlugin

Index

Constructors

constructor

new GeometryUVPreviewPlugin<TEvent extends string>(
enabled?: boolean,
): 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<
    | "dispose"
    | "*"
    | "update"
    | "preRender"
    | "postRender"
    | "preFrame"
    | "postFrame"
    | "addPlugin"
    | "removePlugin"
    | "renderEnabled"
    | "renderDisabled",
    (e: IViewerEvent) => 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 = undefined

`Static` `Optional` `Readonly`OldPluginType

OldPluginType?: string

`Static` `Readonly`PluginType

PluginType: "GeometryUVPreviewPlugin" = 'GeometryUVPreviewPlugin'

Accessors

dirty

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

Methods

`Protected`_onViewerEvent

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

`Protected`_storeKey

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

addGeometry

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

disable

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

dispose

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

downloadGeometryUV

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

enable

enable(key: any): 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: ISerializedConfig,
    meta?: SerializationMetaType,
):
    | null
    | GeometryUVPreviewPlugin<TEvent>
    | Promise<null | GeometryUVPreviewPlugin<TEvent>>
Parameters
- data: ISerializedConfig
- Optionalmeta: SerializationMetaType
Returns
    | null
    | GeometryUVPreviewPlugin<TEvent>
    | Promise<null | GeometryUVPreviewPlugin<TEvent>>
Inherited from AViewerPluginSync.fromJSON
- Defined in src/viewer/AViewerPlugin.ts:41

importState

importState(state: any): 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

removeGeometry

removeGeometry(target: ValOrFunc<undefined | IGeometry>): this
Parameters
- target: ValOrFunc<undefined | IGeometry>
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

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns GeometryUVPreviewPlugin<TEvent>

Properties

Protected_dirty

Protected Optional_viewer

Protected_viewerListeners

constructor

enabled

mainDiv

Optionalstylesheet

targetBlocks

toJSON

OptionaluiConfig

Static Optional ReadonlyOldPluginType

Static ReadonlyPluginType

Accessors

dirty

Returns boolean

Parameters

Returns void

Methods

Protected_onViewerEvent

Parameters

Returns IViewerEvent

Protected_storeKey

Parameters

Returns string

addGeometry

Parameters

Returns this

disable

Parameters

Returns void

dispose

Returns void

downloadGeometryUV

Parameters

Returns this

enable

Parameters

Returns void

exportState

Returns ISerializedConfig | Record<string, never>

fromJSON

Parameters

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

importState

Parameters

Returns Promise<void>

isDisabled

Returns boolean

onAdded

Parameters

Returns void

onRemove

Parameters

Returns void

refreshUi

Returns void

removeGeometry

Parameters

Returns this

setDirty

Returns void

Settings

On This Page

`Protected`_dirty

`Protected` `Optional`_viewer

`Protected`_viewerListeners

`Optional`stylesheet

`Optional`uiConfig

`Static` `Optional` `Readonly`OldPluginType

`Static` `Readonly`PluginType

`Protected`_onViewerEvent

`Protected`_storeKey

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