Interface IVirtualDressingRoom

A factory interface to create assets.

Hierarchy

IAssetFactory
EventEmitter<LoadEvents & ErrorEvents & DebugEvents>
- IVirtualDressingRoom

Accessors

animation

get animation(): null | IAnimation
Returns null | IAnimation
- Defined in sdk/src/Features/VirtualDressingRoom/IVirtualDressingRoom.ts:39
set animation(newAnimation: null | IAnimation): void
Parameters
- newAnimation: null | IAnimation
Returns void
- Defined in sdk/src/Features/VirtualDressingRoom/IVirtualDressingRoom.ts:40

avatar

get avatar(): null | IAvatar
Returns null | IAvatar
- Defined in sdk/src/Features/VirtualDressingRoom/IVirtualDressingRoom.ts:35
set avatar(newAvatar: null | IAvatar): void
Parameters
- newAvatar: null | IAvatar
Returns void
- Defined in sdk/src/Features/VirtualDressingRoom/IVirtualDressingRoom.ts:36

computeServer

set computeServer(computeServer: ComputeServer): void
Parameters
- computeServer: ComputeServer
Returns void
- Defined in sdk/src/Features/VirtualDressingRoom/IVirtualDressingRoom.ts:42

focusGarment

set focusGarment(garment: null | IGarment): void
Parameters
- garment: null | IGarment
Returns void
- Defined in sdk/src/Features/VirtualDressingRoom/IVirtualDressingRoom.ts:44

garmentInfoDotsUpdatedCallback

set garmentInfoDotsUpdatedCallback(callback: undefined | ((infoDotLocations: {
x: number;
y: number;
}[]) => void)): void
Parameters
- callback: undefined | ((infoDotLocations: {
  x: number;
  y: number;
  }[]) => void)
Returns void
- Defined in sdk/src/Features/VirtualDressingRoom/IVirtualDressingRoom.ts:50

garments

get garments(): null | IGarment[]
Returns null | IGarment[]
- Defined in sdk/src/Features/VirtualDressingRoom/IVirtualDressingRoom.ts:33
set garments(newGarments: null | IGarment[]): void
Parameters
- newGarments: null | IGarment[]
Returns void
- Defined in sdk/src/Features/VirtualDressingRoom/IVirtualDressingRoom.ts:34

scene

get scene(): null | IScene
Returns null | IScene
- Defined in sdk/src/Features/VirtualDressingRoom/IVirtualDressingRoom.ts:37
set scene(newScene: null | IScene): void
Parameters
- newScene: null | IScene
Returns void
- Defined in sdk/src/Features/VirtualDressingRoom/IVirtualDressingRoom.ts:38

tryOnFinishedCallback

set tryOnFinishedCallback(callback: undefined | ((avatar: IAvatar, garments: IGarment[]) => void)): void
Parameters
- callback: undefined | ((avatar: IAvatar, garments: IGarment[]) => void)
Returns void
- Defined in sdk/src/Features/VirtualDressingRoom/IVirtualDressingRoom.ts:49

useRigidTryon

get useRigidTryon(): boolean
Returns boolean
- Defined in sdk/src/Features/VirtualDressingRoom/IVirtualDressingRoom.ts:46
set useRigidTryon(useRigidTryon: boolean): void
Parameters
- useRigidTryon: boolean
Returns void
- Defined in sdk/src/Features/VirtualDressingRoom/IVirtualDressingRoom.ts:47

webViewer

get webViewer(): WebViewer
Returns WebViewer
- Defined in sdk/src/Features/VirtualDressingRoom/IVirtualDressingRoom.ts:41

Methods

addEventListener

addEventListener<K>(type: K, listener: ((...ev: Parameters<(LoadEvents & ErrorEvents & DebugEvents)[K]>) => void)): IVirtualDressingRoom
Type Parameters
- K extends string | number
Parameters
- type: K
- listener: ((...ev: Parameters<(LoadEvents & ErrorEvents & DebugEvents)[K]>) => void)
  - - (...ev: Parameters<(LoadEvents & ErrorEvents & DebugEvents)[K]>): void
    - Parameters
      
      Rest ...ev: Parameters<(LoadEvents & ErrorEvents & DebugEvents)[K]>
      
      Returns void
Returns IVirtualDressingRoom
Inherited from EventEmitter.addEventListener
- Defined in sdk/src/Events/index.ts:9

cleanup

cleanup(): Promise<void>
Returns Promise<void>
- Defined in sdk/src/Features/VirtualDressingRoom/IVirtualDressingRoom.ts:60

computeGarmentInfoDotLocations

computeGarmentInfoDotLocations(): Promise<{
x: number;
y: number;
}[]>
Returns Promise<{
x: number;
y: number;
}[]>
- Defined in sdk/src/Features/VirtualDressingRoom/IVirtualDressingRoom.ts:68

createAnimation

createAnimation(asset: IAsset): Promise<IAnimation>
Parameters
- asset: IAsset
Returns Promise<IAnimation>
Inherited from IAssetFactory.createAnimation
- Defined in sdk/src/Data/Asset/IAssetFactory.ts:14

createAvatar

createAvatar(asset: IAsset): Promise<IAvatar>
Parameters
- asset: IAsset
Returns Promise<IAvatar>
Inherited from IAssetFactory.createAvatar
- Defined in sdk/src/Data/Asset/IAssetFactory.ts:11

createGarment

createGarment(asset: IAsset): Promise<IGarment>
Parameters
- asset: IAsset
Returns Promise<IGarment>
Inherited from IAssetFactory.createGarment
- Defined in sdk/src/Data/Asset/IAssetFactory.ts:12

createScene

createScene(asset: IAsset): Promise<IScene>
Parameters
- asset: IAsset
Returns Promise<IScene>
Inherited from IAssetFactory.createScene
- Defined in sdk/src/Data/Asset/IAssetFactory.ts:13

disableSizeVisualisation

disableSizeVisualisation(): Promise<void>
Returns Promise<void>
- Defined in sdk/src/Features/VirtualDressingRoom/IVirtualDressingRoom.ts:58

emit

emit<K>(type: K, ...args: Parameters<(LoadEvents & ErrorEvents & DebugEvents)[K]>): Parameters<(LoadEvents & ErrorEvents & DebugEvents)[K]>
Type Parameters
- K extends string | number
Parameters
- type: K
- Rest ...args: Parameters<(LoadEvents & ErrorEvents & DebugEvents)[K]>
Returns Parameters<(LoadEvents & ErrorEvents & DebugEvents)[K]>
Inherited from EventEmitter.emit
- Defined in sdk/src/Events/index.ts:18

enableSizeVisualisation

enableSizeVisualisation(garment: IGarment, configuration?: VDRSizeVisualisationConfiguration): Promise<SizeRecommendationResponse>
Parameters
- garment: IGarment
- Optional configuration: VDRSizeVisualisationConfiguration
Returns Promise<SizeRecommendationResponse>
- Defined in sdk/src/Features/VirtualDressingRoom/IVirtualDressingRoom.ts:54

preloadAvatarComponents

preloadAvatarComponents(avatar: IAvatar): Promise<void>
Parameters
- avatar: IAvatar
Returns Promise<void>
- Defined in sdk/src/Features/VirtualDressingRoom/IVirtualDressingRoom.ts:64

preloadGarmentComponents

preloadGarmentComponents(garment: IGarment): Promise<void>
Parameters
- garment: IGarment
Returns Promise<void>
- Defined in sdk/src/Features/VirtualDressingRoom/IVirtualDressingRoom.ts:65

preloadSceneComponents

preloadSceneComponents(scene: IScene): Promise<void>
Parameters
- scene: IScene
Returns Promise<void>
- Defined in sdk/src/Features/VirtualDressingRoom/IVirtualDressingRoom.ts:66

refresh

refresh(): Promise<void>
Returns Promise<void>
- Defined in sdk/src/Features/VirtualDressingRoom/IVirtualDressingRoom.ts:59

rotate

rotate(mode: VDRRotationMode, orientation: VDRRotationOrientation, degrees: number, animationTimeInSeconds: number): void
Parameters
- mode: VDRRotationMode
- orientation: VDRRotationOrientation
- degrees: number
- animationTimeInSeconds: number
Returns void
- Defined in sdk/src/Features/VirtualDressingRoom/IVirtualDressingRoom.ts:70

Interface IVirtualDressingRoom

Hierarchy

Index

Accessors

Methods

Accessors

animation

Returns null | IAnimation

Parameters

newAnimation: null | IAnimation

Returns void

avatar

Returns null | IAvatar

Parameters

newAvatar: null | IAvatar

Returns void

computeServer

Parameters

computeServer: ComputeServer

Returns void

focusGarment

Parameters

garment: null | IGarment

Returns void

garmentInfoDotsUpdatedCallback

Parameters

callback: undefined | ((infoDotLocations: { x: number; y: number; }[]) => void)

Returns void

garments

Returns null | IGarment[]

Parameters

newGarments: null | IGarment[]

Returns void

scene

Returns null | IScene

Parameters

newScene: null | IScene

Returns void

tryOnFinishedCallback

Parameters

callback: undefined | ((avatar: IAvatar, garments: IGarment[]) => void)

Returns void

useRigidTryon

Returns boolean

Parameters

useRigidTryon: boolean

Returns void

webViewer

Returns WebViewer

Methods

addEventListener

Type Parameters

K extends string | number

Parameters

type: K

listener: ((...ev: Parameters<(LoadEvents & ErrorEvents & DebugEvents)[K]>) => void)

Parameters

Rest ...ev: Parameters<(LoadEvents & ErrorEvents & DebugEvents)[K]>

Returns void

Returns IVirtualDressingRoom

cleanup

Returns Promise<void>

computeGarmentInfoDotLocations

Returns Promise<{ x: number; y: number; }[]>

createAnimation

Parameters

asset: IAsset

Returns Promise<IAnimation>

createAvatar

Parameters

asset: IAsset

Returns Promise<IAvatar>

createGarment

Parameters

asset: IAsset

Returns Promise<IGarment>

createScene

Parameters

asset: IAsset

Returns Promise<IScene>

callback: undefined | ((infoDotLocations: {
x: number;
y: number;
}[]) => void)

`Rest` ...ev: Parameters<(LoadEvents & ErrorEvents & DebugEvents)[K]>

Returns Promise<{
x: number;
y: number;
}[]>

`Rest` ...args: Parameters<(LoadEvents & ErrorEvents & DebugEvents)[K]>

`Optional` configuration: VDRSizeVisualisationConfiguration