Docs - Bit By Bit Developers

Hierarchy

BabylonScene

Constructors

constructor

new BabylonScene(context: Context): BabylonScene

- Defined in bitbybit-docs.d.ts:33978
Parameters
- context: Context
Returns BabylonScene

Methods

activateCamera

activateCamera(inputs: ActiveCameraDto): void

- Defined in bitbybit-docs.d.ts:33999
Activate camera by overwriting currently active camera

group

camera

shortname

activate

Parameters
- inputs: ActiveCameraDto
  
  Activates the camera
Returns void

adjustActiveArcRotateCamera

adjustActiveArcRotateCamera(inputs: CameraConfigurationDto): void

- Defined in bitbybit-docs.d.ts:34060
Adjusts the active arc rotate camera with configuration parameters

group

camera

shortname

adjust active camera

Parameters
- inputs: CameraConfigurationDto
Returns void

backgroundColour

backgroundColour(inputs: SceneBackgroundColourDto): void

- Defined in bitbybit-docs.d.ts:34184
Changes the scene background colour for 3D space

group

background

shortname

colour

Parameters
- inputs: SceneBackgroundColourDto
  
  Describes the colour of the scene background
Returns void

canvasBackgroundImage

canvasBackgroundImage(inputs: SceneCanvasBackgroundImageDto): { backgroundAttachment: string; backgroundClip: string; backgroundImage: string; backgroundOrigin: string; backgroundPosition: string; backgroundRepeat: string; backgroundSize: string }

- Defined in bitbybit-docs.d.ts:34169
Sets a background image with various customization options for 3D space

group

background

shortname

background image

Parameters
- inputs: SceneCanvasBackgroundImageDto
  
  Describes the background image parameters
Returns { backgroundAttachment: string; backgroundClip: string; backgroundImage: string; backgroundOrigin: string; backgroundPosition: string; backgroundRepeat: string; backgroundSize: string }
- backgroundAttachment: string
- backgroundClip: string
- backgroundImage: string
- backgroundOrigin: string
- backgroundPosition: string
- backgroundRepeat: string
- backgroundSize: string

canvasCSSBackgroundImage

canvasCSSBackgroundImage(inputs: SceneCanvasCSSBackgroundImageDto): { backgroundImage: string }

- Defined in bitbybit-docs.d.ts:34120
Changes the scene background to a css background image for 3D space

group

background

shortname

css background image

Parameters
- inputs: SceneCanvasCSSBackgroundImageDto
  
  Describes the css of the scene background or image
Returns { backgroundImage: string }
- backgroundImage: string

clearAllDrawn

clearAllDrawn(): void

- Defined in bitbybit-docs.d.ts:34066
Clears all of the drawn objects in the 3D scene

group

environment

shortname

clear all drawn

Returns void

drawDirectionalLight

drawDirectionalLight(inputs: DirectionalLightDto): DirectionalLight

- Defined in bitbybit-docs.d.ts:34048
Creates and draws a directional light in the scene

group

lights

shortname

directional light

disposableoutput

true

Parameters
- inputs: DirectionalLightDto
  
  Describes the light source
Returns DirectionalLight

BabylonJS directional light

drawDirectionalLightNoReturn

drawDirectionalLightNoReturn(inputs: DirectionalLightDto): void

- Defined in bitbybit-docs.d.ts:34039
Creates and draws a directional light in the scene

group

lights

shortname

directional

disposableoutput

true

Parameters
- inputs: DirectionalLightDto
  
  Describes the light source
Returns void

drawPointLight

drawPointLight(inputs: PointLightDto): PointLight

- Defined in bitbybit-docs.d.ts:34031
Creates and draws a point light in the scene

group

lights

shortname

point light

disposableoutput

true

Parameters
- inputs: PointLightDto
  
  Describes the light source
Returns PointLight

BabylonJS point light

drawPointLightNoReturn

drawPointLightNoReturn(inputs: PointLightDto): void

- Defined in bitbybit-docs.d.ts:34014
Creates and draws a point light in the scene but does not output anything

group

lights

shortname

point

disposableoutput

true

Parameters
- inputs: PointLightDto
  
  Describes the light source
Returns void

enableSkybox

enableSkybox(inputs: SkyboxDto): void

- Defined in bitbybit-docs.d.ts:34073
Enables skybox

group

environment

shortname

skybox

Parameters
- inputs: SkyboxDto
  
  Skybox configuration
Returns void

enableSkyboxCustomTexture

enableSkyboxCustomTexture(inputs: SkyboxCustomTextureDto): void

- Defined in bitbybit-docs.d.ts:34080
Enables skybox with custom texture

group

environment

shortname

skybox

Parameters
- inputs: SkyboxCustomTextureDto
  
  Skybox configuration
Returns void

fog

fog(inputs: FogDto): void

- Defined in bitbybit-docs.d.ts:34105
Enables fog mode

group

environment

shortname

fog

Parameters
- inputs: FogDto
  
  fog options
Returns void

getActiveCamera

getActiveCamera(): Camera

- Defined in bitbybit-docs.d.ts:34054
Gets the active camera of the scene

group

camera

shortname

get active camera

Returns Camera

getShadowGenerators

getShadowGenerators(): ShadowGenerator[]

- Defined in bitbybit-docs.d.ts:34022
Get shadow generators added by light sources through bitbybit

group

lights

shortname

point

disposableoutput

true

Returns ShadowGenerator[]

multiColorLinearGradientBackground

multiColorLinearGradientBackground(inputs: SceneMultiColorLinearGradientDto): { backgroundImage: string } | { error: string }

- Defined in bitbybit-docs.d.ts:34147
Creates a multi-color linear gradient background for 3D space

group

background

shortname

multi color linear gradient

Parameters
- inputs: SceneMultiColorLinearGradientDto
  
  Describes the multi-color linear gradient parameters
Returns { backgroundImage: string } | { error: string }

multiColorRadialGradientBackground

multiColorRadialGradientBackground(inputs: SceneMultiColorRadialGradientDto): { backgroundImage: string } | { error: string }

- Defined in bitbybit-docs.d.ts:34158
Creates a multi-color radial gradient background for 3D space

group

background

shortname

multi color radial gradient

Parameters
- inputs: SceneMultiColorRadialGradientDto
  
  Describes the multi-color radial gradient parameters
Returns { backgroundImage: string } | { error: string }

twoColorLinearGradientBackground

twoColorLinearGradientBackground(inputs: SceneTwoColorLinearGradientDto): { backgroundImage: string }

- Defined in bitbybit-docs.d.ts:34129
Creates a two-color linear gradient background for 3D space

group

background

shortname

two color linear gradient

Parameters
- inputs: SceneTwoColorLinearGradientDto
  
  Describes the two-color linear gradient parameters
Returns { backgroundImage: string }
- backgroundImage: string

twoColorRadialGradientBackground

twoColorRadialGradientBackground(inputs: SceneTwoColorRadialGradientDto): { backgroundImage: string }

- Defined in bitbybit-docs.d.ts:34138
Creates a two-color radial gradient background for 3D space

group

background

shortname

two color radial gradient

Parameters
- inputs: SceneTwoColorRadialGradientDto
  
  Describes the two-color radial gradient parameters
Returns { backgroundImage: string }
- backgroundImage: string

useRightHandedSystem

useRightHandedSystem(inputs: UseRightHandedSystemDto): void

- Defined in bitbybit-docs.d.ts:34006
Use right handed system

group

system

shortname

hand right

Parameters
- inputs: UseRightHandedSystemDto
  
  Activates the camera
Returns void

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Parameters

context: Context

Returns BabylonScene

Methods

activateCamera

Parameters

inputs: ActiveCameraDto

Returns void

adjustActiveArcRotateCamera

Parameters

inputs: CameraConfigurationDto

Returns void

backgroundColour

Parameters

inputs: SceneBackgroundColourDto

Returns void

canvasBackgroundImage

Parameters

inputs: SceneCanvasBackgroundImageDto

Returns { backgroundAttachment: string; backgroundClip: string; backgroundImage: string; backgroundOrigin: string; backgroundPosition: string; backgroundRepeat: string; backgroundSize: string }

backgroundAttachment: string

backgroundClip: string

backgroundImage: string

backgroundOrigin: string

backgroundPosition: string

backgroundRepeat: string

backgroundSize: string

canvasCSSBackgroundImage

Parameters

inputs: SceneCanvasCSSBackgroundImageDto

Returns { backgroundImage: string }

backgroundImage: string

clearAllDrawn

Returns void

drawDirectionalLight

Parameters

inputs: DirectionalLightDto

Returns DirectionalLight

drawDirectionalLightNoReturn

Parameters

inputs: DirectionalLightDto

Returns void

drawPointLight

Parameters

inputs: PointLightDto

Returns PointLight

drawPointLightNoReturn

Parameters

inputs: PointLightDto

Returns void

enableSkybox

Parameters

inputs: SkyboxDto

Returns void

enableSkyboxCustomTexture

Parameters

inputs: SkyboxCustomTextureDto

Returns void

fog

Parameters

inputs: FogDto

Returns void

getActiveCamera

Returns Camera

getShadowGenerators

Returns ShadowGenerator[]

multiColorLinearGradientBackground

Parameters

inputs: SceneMultiColorLinearGradientDto

Returns { backgroundImage: string } | { error: string }

multiColorRadialGradientBackground

Parameters

inputs: SceneMultiColorRadialGradientDto

Returns { backgroundImage: string } | { error: string }