Class: ARPlugin
Plugins.ARPlugin
Hierarchy
AViewerPlugin
<""
>↳
ARPlugin
Properties
PluginType
▪ Static
Readonly
PluginType: "WEBXR_ARPlugin"
Defined in
webgi/src/plugins/ARPlugin.ts:30
enabled
• enabled: boolean
= true
Overrides
Defined in
webgi/src/plugins/ARPlugin.ts:32
dependencies
• dependencies: typeof GBufferPlugin
[]
Defined in
webgi/src/plugins/ARPlugin.ts:42
domOverlay
• Optional
domOverlay: Object
Type declaration
Name | Type |
---|---|
root | HTMLElement |
Defined in
webgi/src/plugins/ARPlugin.ts:44
estimateLighting
• estimateLighting: boolean
= false
Defined in
webgi/src/plugins/ARPlugin.ts:47
placeOnWall
• placeOnWall: boolean
= false
Defined in
webgi/src/plugins/ARPlugin.ts:50
xrResolutionScale
• xrResolutionScale: number
= 1
Defined in
webgi/src/plugins/ARPlugin.ts:53
toJSON
• toJSON: any
= undefined
Overrides
Defined in
webgi/src/plugins/ARPlugin.ts:55
_dirty
• Protected
_dirty: boolean
= false
Inherited from
Defined in
webgi/src/core/AViewerPlugin.ts:23
_viewer
• Protected
Optional
_viewer: ViewerApp
Inherited from
Defined in
webgi/src/core/AViewerPlugin.ts:27
Constructors
constructor
• new ARPlugin()
Inherited from
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
Name | Type |
---|---|
value | boolean |
Returns
void
Inherited from
AViewerPlugin.dirty
Defined in
webgi/src/core/AViewerPlugin.ts:20
viewer
• get
viewer(): undefined
| TViewer
Returns
undefined
| TViewer
Inherited from
AViewerPlugin.viewer
Defined in
webgi/src/core/AViewerPlugin.ts:29
Methods
onDispose
▸ onDispose(viewer
): Promise
<void
>
Parameters
Name | Type |
---|---|
viewer | ViewerApp |
Returns
Promise
<void
>
Inherited from
Defined in
webgi/src/core/AViewerPlugin.ts:40
onRemove
▸ onRemove(viewer
): Promise
<void
>
Parameters
Name | Type |
---|---|
viewer | ViewerApp |
Returns
Promise
<void
>
Inherited from
Defined in
webgi/src/core/AViewerPlugin.ts:44
fromJSON
▸ fromJSON(data
, meta?
): null
| ARPlugin
| Promise
<null
| ARPlugin
>
Parameters
Name | Type |
---|---|
data | any |
meta? | any |
Returns
null
| ARPlugin
| Promise
<null
| ARPlugin
>
Inherited from
Defined in
webgi/src/core/AViewerPlugin.ts:56
exportState
▸ exportState(): any
Returns
any
Inherited from
Defined in
webgi/src/core/AViewerPlugin.ts:68
importState
▸ importState(state
): Promise
<void
>
Parameters
Name | Type |
---|---|
state | any |
Returns
Promise
<void
>
Inherited from
Defined in
webgi/src/core/AViewerPlugin.ts:71
storeState
▸ storeState(prefix?
, storage?
, data?
): void
Parameters
Name | Type |
---|---|
prefix? | string |
storage? | Storage |
data? | any |
Returns
void
Inherited from
Defined in
webgi/src/core/AViewerPlugin.ts:78
loadState
▸ loadState(prefix?
, storage?
): Promise
<void
>
Parameters
Name | Type |
---|---|
prefix? | string |
storage? | Storage |
Returns
Promise
<void
>
Inherited from
Defined in
webgi/src/core/AViewerPlugin.ts:88
onAdded
▸ onAdded(viewer
): Promise
<void
>
Parameters
Name | Type |
---|---|
viewer | ViewerApp |
Returns
Promise
<void
>
Overrides
Defined in
webgi/src/plugins/ARPlugin.ts:58
enterAR
▸ enterAR(): void
Returns
void
Defined in
webgi/src/plugins/ARPlugin.ts:94
exitAR
▸ exitAR(): void
Returns
void
Defined in
webgi/src/plugins/ARPlugin.ts:122
moveToFloor
▸ moveToFloor(xrFrame
): void
Parameters
Name | Type |
---|---|
xrFrame | XRFrame |
Returns
void
Defined in
webgi/src/plugins/ARPlugin.ts:344
_storeKey
▸ Protected
_storeKey(prefix?
): string
Parameters
Name | Type |
---|---|
prefix? | string |
Returns
string