Class VirtualDressingRoom2DParallax

Hierarchy

VirtualDressingRoomInteractive
- VirtualDressingRoom2DParallax

Constructors

constructor

new VirtualDressingRoom2DParallax(webViewer: WebViewer, computeServer: ComputeServer): VirtualDressingRoom2DParallax
Parameters
- webViewer: WebViewer
- computeServer: ComputeServer
Returns VirtualDressingRoom2DParallax
Overrides VirtualDressingRoomInteractive.constructor
- Defined in sdk/src/Features/VirtualDressingRoom/VirtualDressingRoom2DParallax.ts:38

Accessors

animation

get animation(): null | IAnimation
Returns null | IAnimation
Inherited from VirtualDressingRoomInteractive.animation
- Defined in sdk/src/Features/VirtualDressingRoom/IVirtualDressingRoom.ts:237
set animation(newAnimation: null | IAnimation): void
Parameters
- newAnimation: null | IAnimation
Returns void
Inherited from VirtualDressingRoomInteractive.animation
- Defined in sdk/src/Features/VirtualDressingRoom/IVirtualDressingRoom.ts:241

avatar

get avatar(): null | IAvatar
Returns null | IAvatar
Inherited from VirtualDressingRoomInteractive.avatar
- Defined in sdk/src/Features/VirtualDressingRoom/IVirtualDressingRoom.ts:176
set avatar(avatar: null | IAvatar): void
Parameters
- avatar: null | IAvatar
Returns void
Inherited from VirtualDressingRoomInteractive.avatar
- Defined in sdk/src/Features/VirtualDressingRoom/IVirtualDressingRoom.ts:180

computeServer

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

focusGarment

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

garmentInfoDotsUpdatedCallback

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

garments

get garments(): null | IGarment[]
Returns null | IGarment[]
Inherited from VirtualDressingRoomInteractive.garments
- Defined in sdk/src/Features/VirtualDressingRoom/IVirtualDressingRoom.ts:221
set garments(garments: null | IGarment[]): void
Parameters
- garments: null | IGarment[]
Returns void
Inherited from VirtualDressingRoomInteractive.garments
- Defined in sdk/src/Features/VirtualDressingRoom/IVirtualDressingRoom.ts:194

gizmosHidden

set gizmosHidden(hidden: boolean): void
Parameters
- hidden: boolean
Returns void
Inherited from VirtualDressingRoomInteractive.gizmosHidden
- Defined in sdk/src/Features/VirtualDressingRoom/VirtualDressingRoomInteractive.ts:1605

scene

get scene(): null | IScene
Returns null | IScene
Inherited from VirtualDressingRoomInteractive.scene
- Defined in sdk/src/Features/VirtualDressingRoom/IVirtualDressingRoom.ts:163
set scene(scene: null | IScene): void
Parameters
- scene: null | IScene
Returns void
Inherited from VirtualDressingRoomInteractive.scene
- Defined in sdk/src/Features/VirtualDressingRoom/IVirtualDressingRoom.ts:167

tryOnFinishedCallback

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

useRigidTryon

get useRigidTryon(): boolean
Returns boolean
Inherited from VirtualDressingRoomInteractive.useRigidTryon
- Defined in sdk/src/Features/VirtualDressingRoom/IVirtualDressingRoom.ts:252
set useRigidTryon(useRigidTryon: boolean): void
Parameters
- useRigidTryon: boolean
Returns void
Inherited from VirtualDressingRoomInteractive.useRigidTryon
- Defined in sdk/src/Features/VirtualDressingRoom/IVirtualDressingRoom.ts:256

webViewer

get webViewer(): WebViewer
Returns WebViewer
Inherited from VirtualDressingRoomInteractive.webViewer
- Defined in sdk/src/Features/VirtualDressingRoom/IVirtualDressingRoom.ts:155

Methods

addEventListener

addEventListener<K>(type: K, listener: ((...ev: Parameters<(LoadEvents & ErrorEvents & DebugEvents)[K]>) => void)): VirtualDressingRoom2DParallax
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 VirtualDressingRoom2DParallax
Inherited from VirtualDressingRoomInteractive.addEventListener
- Defined in sdk/src/Events/index.ts:9

cleanup

cleanup(): Promise<void>
Returns Promise<void>
Inherited from VirtualDressingRoomInteractive.cleanup
- Defined in sdk/src/Features/VirtualDressingRoom/VirtualDressingRoomInteractive.ts:580

computeGarmentInfoDotLocations

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

createAnimation

createAnimation(asset: IAsset): Promise<IAnimation>
Parameters
- asset: IAsset
Returns Promise<IAnimation>
Inherited from VirtualDressingRoomInteractive.createAnimation
- Defined in sdk/src/Features/VirtualDressingRoom/VirtualDressingRoomInteractive.ts:113

createAvatar

createAvatar(asset: IAsset): Promise<IAvatar>
Parameters
- asset: IAsset
Returns Promise<IAvatar>
Overrides VirtualDressingRoomInteractive.createAvatar
- Defined in sdk/src/Features/VirtualDressingRoom/VirtualDressingRoom2DParallax.ts:145

createGarment

createGarment(asset: IAsset): Promise<IGarment>
Parameters
- asset: IAsset
Returns Promise<IGarment>
Overrides VirtualDressingRoomInteractive.createGarment
- Defined in sdk/src/Features/VirtualDressingRoom/VirtualDressingRoom2DParallax.ts:149

createScene

createScene(asset: IAsset): Promise<IScene>
Parameters
- asset: IAsset
Returns Promise<IScene>
Overrides VirtualDressingRoomInteractive.createScene
- Defined in sdk/src/Features/VirtualDressingRoom/VirtualDressingRoom2DParallax.ts:163

disableSizeVisualisation

disableSizeVisualisation(): Promise<void>
Returns Promise<void>
Inherited from VirtualDressingRoomInteractive.disableSizeVisualisation
- Defined in sdk/src/Features/VirtualDressingRoom/VirtualDressingRoomInteractive.ts:568

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 VirtualDressingRoomInteractive.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>
Overrides VirtualDressingRoomInteractive.enableSizeVisualisation
- Defined in sdk/src/Features/VirtualDressingRoom/VirtualDressingRoom2DParallax.ts:448

preloadAvatarComponents

preloadAvatarComponents(avatar: IAvatar): Promise<void>
Parameters
- avatar: IAvatar
Returns Promise<void>
Overrides VirtualDressingRoomInteractive.preloadAvatarComponents
- Defined in sdk/src/Features/VirtualDressingRoom/VirtualDressingRoom2DParallax.ts:44

preloadGarmentComponents

preloadGarmentComponents(garment: IGarment): Promise<void>
Parameters
- garment: IGarment
Returns Promise<void>
Overrides VirtualDressingRoomInteractive.preloadGarmentComponents
- Defined in sdk/src/Features/VirtualDressingRoom/VirtualDressingRoom2DParallax.ts:89

preloadSceneComponents

preloadSceneComponents(scene: IScene): Promise<void>
Parameters
- scene: IScene
Returns Promise<void>
Overrides VirtualDressingRoomInteractive.preloadSceneComponents
- Defined in sdk/src/Features/VirtualDressingRoom/VirtualDressingRoom2DParallax.ts:141

refresh

refresh(): Promise<void>
Returns Promise<void>
Inherited from VirtualDressingRoomInteractive.refresh
- Defined in sdk/src/Features/VirtualDressingRoom/VirtualDressingRoomInteractive.ts:123

rotate

rotate(mode?: VDRRotationMode, orientation?: VDRRotationOrientation, degrees?: number, animationTimeInSeconds?: number): void
Parameters
- mode: VDRRotationMode = VDRRotationMode.CAMERA
- orientation: VDRRotationOrientation = VDRRotationOrientation.HORIZONTAL
- degrees: number = 45
- animationTimeInSeconds: number = 0.75
Returns void
Inherited from VirtualDressingRoomInteractive.rotate
- Defined in sdk/src/Features/VirtualDressingRoom/VirtualDressingRoomInteractive.ts:1406

Class VirtualDressingRoom2DParallax

Hierarchy

Index

Constructors

Accessors

Methods

Constructors

constructor

Parameters

webViewer: WebViewer

computeServer: ComputeServer

Returns VirtualDressingRoom2DParallax

Accessors

animation

Returns null | IAnimation

Parameters

newAnimation: null | IAnimation

Returns void

avatar

Returns null | IAvatar

Parameters

avatar: 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

garments: null | IGarment[]

Returns void

gizmosHidden

Parameters

hidden: boolean

Returns void

scene

Returns null | IScene

Parameters

scene: 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 VirtualDressingRoom2DParallax

cleanup

Returns Promise<void>

computeGarmentInfoDotLocations

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

createAnimation

Parameters

asset: IAsset

Returns Promise<IAnimation>

createAvatar

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