Skip to main content

Class: ARPlugin

Plugins.ARPlugin

Hierarchy

Properties

PluginType

Static Readonly PluginType: "WEBXR_ARPlugin"

Defined in

webgi/src/plugins/ARPlugin.ts:29


enabled

enabled: boolean = true

Overrides

AViewerPlugin.enabled

Defined in

webgi/src/plugins/ARPlugin.ts:31


dependencies

dependencies: typeof GBufferPlugin[]

Defined in

webgi/src/plugins/ARPlugin.ts:41


domOverlay

Optional domOverlay: Object

Type declaration

NameType
rootHTMLElement

Defined in

webgi/src/plugins/ARPlugin.ts:43


estimateLighting

estimateLighting: boolean = false

Defined in

webgi/src/plugins/ARPlugin.ts:46


placeOnWall

placeOnWall: boolean = false

Defined in

webgi/src/plugins/ARPlugin.ts:49


xrResolutionScale

xrResolutionScale: number = 1

Defined in

webgi/src/plugins/ARPlugin.ts:52


toJSON

toJSON: any = undefined

Overrides

AViewerPlugin.toJSON

Defined in

webgi/src/plugins/ARPlugin.ts:54


_dirty

Protected _dirty: boolean = false

Inherited from

AViewerPlugin._dirty

Defined in

webgi/src/core/AViewerPlugin.ts:23


_viewer

Protected Optional _viewer: ViewerApp

Inherited from

AViewerPlugin._viewer

Defined in

webgi/src/core/AViewerPlugin.ts:27

Constructors

constructor

new ARPlugin()

Inherited from

AViewerPlugin.constructor

Defined in

webgi/node_modules/ts-browser-helpers/dist/EventDispatcher.d.ts:41

Accessors

dirty

get dirty(): boolean

Returns

boolean

Inherited from

AViewerPlugin.dirty

Defined in

webgi/src/core/AViewerPlugin.ts:16

set dirty(value): void

Parameters

NameType
valueboolean

Returns

void

Inherited from

AViewerPlugin.dirty

Defined in

webgi/src/core/AViewerPlugin.ts:20

Methods

onDispose

onDispose(viewer): Promise<void>

Parameters

NameType
viewerViewerApp

Returns

Promise<void>

Inherited from

AViewerPlugin.onDispose

Defined in

webgi/src/core/AViewerPlugin.ts:36


onRemove

onRemove(viewer): Promise<void>

Parameters

NameType
viewerViewerApp

Returns

Promise<void>

Inherited from

AViewerPlugin.onRemove

Defined in

webgi/src/core/AViewerPlugin.ts:40


fromJSON

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

Parameters

NameType
dataany
meta?any

Returns

null | ARPlugin | Promise<null | ARPlugin>

Inherited from

AViewerPlugin.fromJSON

Defined in

webgi/src/core/AViewerPlugin.ts:52


exportState

exportState(): any

Returns

any

Inherited from

AViewerPlugin.exportState

Defined in

webgi/src/core/AViewerPlugin.ts:64


importState

importState(state): Promise<void>

Parameters

NameType
stateany

Returns

Promise<void>

Inherited from

AViewerPlugin.importState

Defined in

webgi/src/core/AViewerPlugin.ts:67


storeState

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

Parameters

NameType
prefix?string
storage?Storage
data?any

Returns

void

Inherited from

AViewerPlugin.storeState

Defined in

webgi/src/core/AViewerPlugin.ts:74


loadState

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

Parameters

NameType
prefix?string
storage?Storage

Returns

Promise<void>

Inherited from

AViewerPlugin.loadState

Defined in

webgi/src/core/AViewerPlugin.ts:84


onAdded

onAdded(viewer): Promise<void>

Parameters

NameType
viewerViewerApp

Returns

Promise<void>

Overrides

AViewerPlugin.onAdded

Defined in

webgi/src/plugins/ARPlugin.ts:57


enterAR

enterAR(): void

Returns

void

Defined in

webgi/src/plugins/ARPlugin.ts:93


exitAR

exitAR(): void

Returns

void

Defined in

webgi/src/plugins/ARPlugin.ts:116


moveToFloor

moveToFloor(xrFrame): void

Parameters

NameType
xrFrameXRFrame

Returns

void

Defined in

webgi/src/plugins/ARPlugin.ts:333


_storeKey

Protected _storeKey(prefix?): string

Parameters

NameType
prefix?string

Returns

string

Inherited from

AViewerPlugin._storeKey

Defined in

webgi/src/core/AViewerPlugin.ts:60