Class GridItemListPlugin

A helper plugin to create a a simple list of small grids like for material or object configurator

Hierarchy

  • AViewerPluginSync<"">
    • GridItemListPlugin

Constructors

constructor

Properties

_dirty _viewer? _viewerListeners constructor create enabled removeAll toJSON uiConfig? OldPluginType? PluginType

Accessors

dirty

Methods

_onViewerEvent _storeKey disable dispose enable exportState fromJSON importState isDisabled onAdded onRemove rebuildUi setDirty?

Constructors

constructor

  • new GridItemListPlugin(): GridItemListPlugin

  • Creates THREE.EventDispatcher | EventDispatcher object.

    Returns GridItemListPlugin

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) => void)> = {}

Type declaration

    • (e): void

    • Parameters

      • e: IViewerEvent

      Returns void

constructor

constructor: typeof AViewerPluginSync & typeof AViewerPlugin

create

create: (<T>(tag, title, cols, x, y, items, processDiv) => HTMLDivElement) = GridItemList.Create

Type declaration

    • <T>(tag, title, cols, x, y, items, processDiv): HTMLDivElement

    • Type Parameters

      Parameters

      • tag: string
      • title: string
      • cols: number
      • x: number
      • y: number
      • items: T[]
      • processDiv: ((d, item, container) => void)
          • (d, item, container): void

          • Parameters

            • d: HTMLDivElement
            • item: T
            • container: HTMLElement

            Returns void

      Returns HTMLDivElement

enabled

enabled: boolean = true

removeAll

removeAll: ((tag?) => void) = GridItemList.RemoveAll

Type declaration

    • (tag?): void

    • Parameters

      • Optional tag: string

      Returns void

toJSON

toJSON: any = undefined

Optional uiConfig

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

Static Optional Readonly OldPluginType

OldPluginType?: string

Static Readonly PluginType

PluginType: string = 'AViewerPlugin'

Accessors

dirty

Methods

Protected _onViewerEvent

  • _onViewerEvent(e): IViewerEvent

  • Parameters

    • e: IViewerEvent

    Returns IViewerEvent

Protected _storeKey

  • _storeKey(prefix?): string

  • Parameters

    • Optional prefix: string

    Returns string

disable

dispose

enable

exportState

  • exportState(): ISerializedConfig | Record<string, never>

  • Returns ISerializedConfig | Record<string, never>

fromJSON

importState

  • importState(state): Promise<void>

  • Parameters

    • state: any

    Returns Promise<void>

isDisabled

onAdded

onRemove

rebuildUi

Optional setDirty

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc