Class WebARController

Hierarchy

WebARController

Index

Constructors

Properties

desktopModal enableScaling levelOfDetail mobilePopover modConfigOptions webArOnDemand

Methods

autoOpenURL canAutoRedirect generateURL getCommonRequestParams getExistingURL getProduct getURL isSupported makeDesktopRequest makeMobileRequest makeRequest reportGenerateError

Constructors

constructor

new WebARController(modConfigOptions: MxtModularConfiguratorOptions): WebARController
Parameters
- modConfigOptions: MxtModularConfiguratorOptions
Returns WebARController
- Defined in js/modularconfig/controllers/WebARController.tsx:34

Properties

`Protected` desktopModal

desktopModal: WebARDesktopModal

`Protected` enableScaling

enableScaling: boolean

`Protected` levelOfDetail

levelOfDetail: LOD

`Protected` mobilePopover

mobilePopover: WebARMobilePopover

`Protected` modConfigOptions

modConfigOptions: MxtModularConfiguratorOptions

`Protected` webArOnDemand

webArOnDemand: MxtWebArOnDemand

Methods

autoOpenURL

autoOpenURL(webARURL: string): void
Parameters
- webARURL: string
Returns void
- Defined in js/modularconfig/controllers/WebARController.tsx:247

canAutoRedirect

canAutoRedirect(): boolean
Returns boolean
- Defined in js/modularconfig/controllers/WebARController.tsx:73

generateURL

generateURL(product: Product): Promise<string>
Generate a new WebAR On-Demand asset and URL

Returns
WebAR URL or null
Parameters
- product: Product
  
  the product to view in AR
Returns Promise<string>
- Defined in js/modularconfig/controllers/WebARController.tsx:126

`Protected` getCommonRequestParams

getCommonRequestParams(product: Product): {
    fileName: string;
    productAssemblies: ProductAssemblyLite[];
    productID: string;
}
Parameters
- product: Product
Returns {
    fileName: string;
    productAssemblies: ProductAssemblyLite[];
    productID: string;
}
- fileName: string
- productAssemblies: ProductAssemblyLite[]
- productID: string
- Defined in js/modularconfig/controllers/WebARController.tsx:87

getExistingURL

getExistingURL(product: Product): Promise<string>
Check for an existing generated WebAR On-Demand asset's URL

Returns
WebAR URL or null
Parameters
- product: Product
  
  the product to view in AR
Returns Promise<string>
- Defined in js/modularconfig/controllers/WebARController.tsx:107

getProduct

getProduct(): Product
Returns

Returns Product
- Defined in js/modularconfig/controllers/WebARController.tsx:144

getURL

getURL(): Promise<string>
Returns Promise<string>
- Defined in js/modularconfig/controllers/WebARController.tsx:186

isSupported

isSupported(): boolean
Returns boolean
- Defined in js/modularconfig/controllers/WebARController.tsx:69

`Protected` makeDesktopRequest

makeDesktopRequest(): Promise<void>
Returns Promise<void>
- Defined in js/modularconfig/controllers/WebARController.tsx:225

`Protected` makeMobileRequest

makeMobileRequest(popoverTarget: HTMLElement): Promise<void>
Parameters
- popoverTarget: HTMLElement
Returns Promise<void>
- Defined in js/modularconfig/controllers/WebARController.tsx:210

makeRequest

makeRequest(mobileTarget: HTMLElement): Promise<void>
Parameters
- mobileTarget: HTMLElement
Returns Promise<void>
- Defined in js/modularconfig/controllers/WebARController.tsx:199

`Protected` reportGenerateError

reportGenerateError(className: string, methodName: string): void
Parameters
- className: string
- methodName: string
Returns void
- Defined in js/modularconfig/controllers/WebARController.tsx:263

Generated using TypeDoc