Class GeometryUVPreviewPlugin<TE>

Base Class for Sync Viewer Plugins

Type Parameters

TE extends AViewerPluginEventMap = AViewerPluginEventMap

Hierarchy (View Summary)

AViewerPluginSync<TE>
- GeometryUVPreviewPlugin

Index

Constructors

constructor

new GeometryUVPreviewPlugin<
TE extends AViewerPluginEventMap = AViewerPluginEventMap,
>(
enabled?: boolean,
): GeometryUVPreviewPlugin<TE>
Type Parameters
- TE extends AViewerPluginEventMap = AViewerPluginEventMap
Parameters
- enabled: boolean = true
Returns GeometryUVPreviewPlugin<TE>
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<IViewerEventTypes, (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<any, string, any> = 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:112
set dirty(value: boolean): void
Parameters
- value: boolean
Returns void
Inherited from AViewerPluginSync.dirty
- Defined in src/viewer/AViewerPlugin.ts:116

Methods

`Protected`_onViewerEvent

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

`Protected`_storeKey

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

addGeometry

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

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
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, 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
    | GeometryUVPreviewPlugin<TE>
    | Promise<null | GeometryUVPreviewPlugin<TE>>
Parameters
- data: ISerializedConfig
- Optionalmeta: SerializationMetaType
Returns null | GeometryUVPreviewPlugin<TE> | Promise<null | GeometryUVPreviewPlugin<TE>>
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 src/plugins/ui/GeometryUVPreviewPlugin.ts:35

onRemove

onRemove(viewer: ThreeViewer): void
Parameters
- viewer: ThreeViewer
Returns void
Overrides AViewerPluginSync.onRemove
- Defined in src/plugins/ui/GeometryUVPreviewPlugin.ts:43

refreshUi

refreshUi(): void
Returns void
- Defined in src/plugins/ui/GeometryUVPreviewPlugin.ts:127

removeGeometry

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