configurator-core/src/roomle-configurator.
# Table of contents
# Constructors
# Methods
- preparePerspectiveImage
- prepareTopImage
- renderPerspectiveImage
- switchToConfiguratorSettings
- switchToPlannerSettings
- updateBounds
- getCameraTargetForBBox
- placeCameraForPerspectiveImage
# Constructors
# constructor
• new default()
# Methods
# preparePerspectiveImage
▸ preparePerspectiveImage(scene
, uiScene
, camera
, cameraTarget
, options?
, objectRotation?
, onBeforeRender?
): Promise
<Base64Image
>
# Parameters
Name | Type | Default value |
---|---|---|
scene | Scene | undefined |
uiScene | Scene | undefined |
camera | PerspectiveCamera | undefined |
cameraTarget | CameraTarget | undefined |
options | PrepareImageOptions | {} |
objectRotation | number | 0 |
onBeforeRender? | (camera : Camera ) => void | undefined |
# Returns
Promise
<Base64Image
>
# prepareTopImage
▸ prepareTopImage(scene
, uiScene
, cameraTarget
, options?
): Promise
<Base64Image
>
# Parameters
Name | Type |
---|---|
scene | Scene |
uiScene | Scene |
cameraTarget | CameraTarget |
options | PrepareImageOptions |
# Returns
Promise
<Base64Image
>
# renderPerspectiveImage
▸ renderPerspectiveImage(scene
, camera
, cameraTarget
, size?
): Promise
<Base64Image
>
# Parameters
Name | Type |
---|---|
scene | Scene |
camera | PerspectiveCamera |
cameraTarget | CameraTarget |
size? | number |
# Returns
Promise
<Base64Image
>
# switchToConfiguratorSettings
▸ switchToConfiguratorSettings(): void
# Returns
void
# switchToPlannerSettings
▸ switchToPlannerSettings(): void
# Returns
void
# updateBounds
▸ updateBounds(bounds
): void
# Parameters
Name | Type |
---|---|
bounds | Box3 |
# Returns
void
# getCameraTargetForBBox
▸ Static
getCameraTargetForBBox(bbox
, spacing?
): CameraTarget
# Parameters
Name | Type | Default value |
---|---|---|
bbox | Box3 | undefined |
spacing | number | 0 |
# Returns
# placeCameraForPerspectiveImage
▸ Static
placeCameraForPerspectiveImage(camera
, cameraTarget
, angleX
, angleY
): void
# Parameters
Name | Type |
---|---|
camera | PerspectiveCamera |
cameraTarget | CameraTarget |
angleX | number |
angleY | number |
# Returns
void