Skip to main content

Class: ARPlugin

Plugins.ARPlugin

Hierarchy

Properties

PluginType

Static Readonly PluginType: "WEBXR_ARPlugin"


enabled

enabled: boolean = true

Overrides

AViewerPlugin.enabled


dependencies

dependencies: typeof GBufferPlugin[]


domOverlay

Optional domOverlay: Object

Type declaration

NameType
rootHTMLElement

estimateLighting

estimateLighting: boolean = false


placeOnWall

placeOnWall: boolean = false


xrResolutionScale

xrResolutionScale: number = 1


toJSON

toJSON: any = undefined

Overrides

AViewerPlugin.toJSON


_dirty

Protected _dirty: boolean = false

Inherited from

AViewerPlugin._dirty


_viewer

Protected Optional _viewer: ViewerApp

Inherited from

AViewerPlugin._viewer

Constructors

constructor

new ARPlugin()

Inherited from

AViewerPlugin.constructor

Accessors

dirty

get dirty(): boolean

Returns

boolean

Inherited from

AViewerPlugin.dirty

set dirty(value): void

Parameters

NameType
valueboolean

Returns

void

Inherited from

AViewerPlugin.dirty


viewer

get viewer(): undefined | ViewerApp

Returns

undefined | ViewerApp

Inherited from

AViewerPlugin.viewer

Methods

onDispose

onDispose(viewer): Promise<void>

Parameters

NameType
viewerViewerApp

Returns

Promise<void>

Inherited from

AViewerPlugin.onDispose


onRemove

onRemove(viewer): Promise<void>

Parameters

NameType
viewerViewerApp

Returns

Promise<void>

Inherited from

AViewerPlugin.onRemove


fromJSON

fromJSON(data, meta?): null | ARPlugin | Promise<null | ARPlugin>

Parameters

NameType
dataany
meta?any

Returns

null | ARPlugin | Promise<null | ARPlugin>

Inherited from

AViewerPlugin.fromJSON


exportState

exportState(): any

Returns

any

Inherited from

AViewerPlugin.exportState


importState

importState(state): Promise<void>

Parameters

NameType
stateany

Returns

Promise<void>

Inherited from

AViewerPlugin.importState


storeState

storeState(prefix?, storage?, data?): void

Parameters

NameType
prefix?string
storage?Storage
data?any

Returns

void

Inherited from

AViewerPlugin.storeState


loadState

loadState(prefix?, storage?): Promise<void>

Parameters

NameType
prefix?string
storage?Storage

Returns

Promise<void>

Inherited from

AViewerPlugin.loadState


onAdded

onAdded(viewer): Promise<void>

Parameters

NameType
viewerViewerApp

Returns

Promise<void>

Overrides

AViewerPlugin.onAdded


enterAR

enterAR(): void

Returns

void


exitAR

exitAR(): void

Returns

void


moveToFloor

moveToFloor(xrFrame): void

Parameters

NameType
xrFrameXRFrame

Returns

void


_storeKey

Protected _storeKey(prefix?): string

Parameters

NameType
prefix?string

Returns

string

Inherited from

AViewerPlugin._storeKey