Class TilesRendererPlugin

TilesRendererPlugin is a plugin for loading and rendering OGC 3D Tiles using 3d-tiles-renderer package.

Specification - https://www.ogc.org/standards/3dtiles/

Hierarchy

AViewerPluginSync<TilesRendererPluginEventMap>
- TilesRendererPlugin

Index

Constructors

Constructors

constructor

new TilesRendererPlugin(): TilesRendererPlugin
Returns TilesRendererPlugin
Overrides AViewerPluginSync<TilesRendererPluginEventMap>.constructor
- Defined in plugins/3d-tiles-renderer/src/TilesRendererPlugin.ts:59

Properties

`Protected`_dirty

_dirty: boolean = false

`Protected`_importer

_importer: Importer<TilesRendererLoader> = ...

`Protected` `Optional`_viewer

_viewer?: ThreeViewer

`Protected`_viewerListeners

_viewerListeners: PartialRecord<IViewerEventTypes, (e: IViewerEvent) => void> = {}

constructor

constructor: typeof AViewerPluginSync & typeof AViewerPlugin

dependencies

dependencies: never[] = []

enabled

enabled: boolean = true

objects

objects: TilesRendererGroup[] = []

`Optional`uiConfig

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

`Static` `Readonly`DUMMY_EXT

DUMMY_EXT: "tileset" = 'tileset'

`Static` `Optional` `Readonly`OldPluginType

OldPluginType?: string

`Static` `Readonly`PluginType

PluginType: string = 'TilesRendererPlugin'

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

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
Inherited from AViewerPluginSync.dispose
- Defined in src/viewer/AViewerPlugin.ts:34

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 | TilesRendererPlugin | Promise<null | TilesRendererPlugin>
Parameters
- data: ISerializedConfig
- Optionalmeta: SerializationMetaType
Returns null | TilesRendererPlugin | Promise<null | TilesRendererPlugin>
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

load

load(
url: string,
options?: ImportAddOptions,
): Promise<undefined | TilesRendererGroup>
Parameters
- url: string
- Optionaloptions: ImportAddOptions
Returns Promise<undefined | TilesRendererGroup>
- Defined in plugins/3d-tiles-renderer/src/TilesRendererPlugin.ts:63

loadCesiumIon

loadCesiumIon(
    info:
        | undefined
        | boolean
        | {
            apiToken: string;
            assetId?: null
            | string;
            autoRefreshToken?: boolean;
        },
    options?: ImportAddOptions,
): Promise<undefined | TilesRendererGroup>
Parameters
- info:
      | undefined
      | boolean
      | { apiToken: string; assetId?: null
      | string; autoRefreshToken?: boolean }
- Optionaloptions: ImportAddOptions
Returns Promise<undefined | TilesRendererGroup>
- Defined in plugins/3d-tiles-renderer/src/TilesRendererPlugin.ts:83

onAdded

onAdded(viewer: ThreeViewer): void
Parameters
- viewer: ThreeViewer
Returns void
Overrides AViewerPluginSync.onAdded
- Defined in plugins/3d-tiles-renderer/src/TilesRendererPlugin.ts:94

onRemove

onRemove(viewer: ThreeViewer): void
Parameters
- viewer: ThreeViewer
Returns void
Overrides AViewerPluginSync.onRemove
- Defined in plugins/3d-tiles-renderer/src/TilesRendererPlugin.ts:112

promptForURL

promptForURL(): Promise<
    | undefined
    | TilesRendererGroup
    | IObject3D<
        IObject3DEventMap,
        undefined
        | IGeometry<NormalBufferAttributes, BufferGeometryEventMap>,
        undefined | IMaterial<IMaterialEventMap> | IMaterial<IMaterialEventMap>[],
    > & ImportResultExtras
    | ITexture<TextureEventMap> & ImportResultExtras
    | ICamera<ICameraEventMap> & ImportResultExtras
    | ISerializedConfig & ImportResultExtras
    | RootSceneImportResult & ImportResultExtras
    | IMaterial<IMaterialEventMap> & ImportResultExtras
    | ImportResult[],
>
Returns Promise<
    | undefined
    | TilesRendererGroup
    | IObject3D<
        IObject3DEventMap,
        undefined
        | IGeometry<NormalBufferAttributes, BufferGeometryEventMap>,
        undefined | IMaterial<IMaterialEventMap> | IMaterial<IMaterialEventMap>[],
    > & ImportResultExtras
    | ITexture<TextureEventMap> & ImportResultExtras
    | ICamera<ICameraEventMap> & ImportResultExtras
    | ISerializedConfig & ImportResultExtras
    | RootSceneImportResult & ImportResultExtras
    | IMaterial<IMaterialEventMap> & ImportResultExtras
    | ImportResult[],
>
- Defined in plugins/3d-tiles-renderer/src/TilesRendererPlugin.ts:216

`Optional`setDirty

setDirty(...args: any[]): any
Parameters
- ...args: any[]
Returns any
Inherited from AViewerPluginSync.setDirty
- Defined in src/viewer/AViewerPlugin.ts:89

toJSON

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

Class TilesRendererPlugin

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns TilesRendererPlugin

Properties

Protected_dirty

Protected_importer

Protected Optional_viewer

Protected_viewerListeners

constructor

dependencies

enabled

objects

OptionaluiConfig

Static ReadonlyDUMMY_EXT

Static Optional ReadonlyOldPluginType

Static ReadonlyPluginType

Accessors

dirty

Returns boolean

Parameters

Returns void

Methods

Protected_onViewerEvent

Parameters

Returns IViewerEvent

Protected_storeKey

Parameters

Returns string

disable

Parameters

Returns void

dispose

Returns void

enable

Parameters

Returns void

exportState

Returns ISerializedConfig | Record<string, never>

fromJSON

Parameters

Returns null | TilesRendererPlugin | Promise<null | TilesRendererPlugin>

importState

Parameters

Returns Promise<void>

isDisabled

Returns boolean

load

Parameters

Returns Promise<undefined | TilesRendererGroup>

loadCesiumIon

Parameters

Returns Promise<undefined | TilesRendererGroup>

onAdded

Parameters

Returns void

onRemove

Parameters

Returns void

promptForURL

OptionalsetDirty

Parameters

Returns any

toJSON

Parameters

Returns ISerializedConfig

Settings

On This Page

`Protected`_dirty

`Protected`_importer

`Protected` `Optional`_viewer

`Protected`_viewerListeners

`Optional`uiConfig

`Static` `Readonly`DUMMY_EXT

`Static` `Optional` `Readonly`OldPluginType

`Static` `Readonly`PluginType

`Protected`_onViewerEvent

`Protected`_storeKey

`Optional`setDirty