Class BabylonScene

Constructors

constructor

new BabylonScene(context: Context): Bit.BabylonScene
Parameters
- context: Context
Returns Bit.BabylonScene
- Defined in bitbybit-docs.d.ts:37367

background

canvasCSSBackgroundImage

canvasCSSBackgroundImage(
inputs: SceneCanvasCSSBackgroundImageDto,
): { backgroundImage: string }
Changes the scene background to a css background image for 3D space
Parameters
- inputs: SceneCanvasCSSBackgroundImageDto
  Describes the css of the scene background or image
Returns { backgroundImage: string }
Shortname
css background image
- Defined in bitbybit-docs.d.ts:37509

twoColorLinearGradientBackground

twoColorLinearGradientBackground(
inputs: SceneTwoColorLinearGradientDto,
): { backgroundImage: string }
Creates a two-color linear gradient background for 3D space
Parameters
- inputs: SceneTwoColorLinearGradientDto
  Describes the two-color linear gradient parameters
Returns { backgroundImage: string }
Shortname
two color linear gradient
- Defined in bitbybit-docs.d.ts:37518

twoColorRadialGradientBackground

twoColorRadialGradientBackground(
inputs: SceneTwoColorRadialGradientDto,
): { backgroundImage: string }
Creates a two-color radial gradient background for 3D space
Parameters
- inputs: SceneTwoColorRadialGradientDto
  Describes the two-color radial gradient parameters
Returns { backgroundImage: string }
Shortname
two color radial gradient
- Defined in bitbybit-docs.d.ts:37527

multiColorLinearGradientBackground

multiColorLinearGradientBackground(
inputs: SceneMultiColorLinearGradientDto,
): { backgroundImage: string } | { error: string }
Creates a multi-color linear gradient background for 3D space
Parameters
- inputs: SceneMultiColorLinearGradientDto
  Describes the multi-color linear gradient parameters
Returns { backgroundImage: string } | { error: string }
Shortname
multi color linear gradient
- Defined in bitbybit-docs.d.ts:37536

multiColorRadialGradientBackground

multiColorRadialGradientBackground(
inputs: SceneMultiColorRadialGradientDto,
): { backgroundImage: string } | { error: string }
Creates a multi-color radial gradient background for 3D space
Parameters
- inputs: SceneMultiColorRadialGradientDto
  Describes the multi-color radial gradient parameters
Returns { backgroundImage: string } | { error: string }
Shortname
multi color radial gradient
- Defined in bitbybit-docs.d.ts:37547

canvasBackgroundImage

canvasBackgroundImage(
    inputs: SceneCanvasBackgroundImageDto,
): {
    backgroundImage: string;
    backgroundRepeat: string;
    backgroundSize: string;
    backgroundPosition: string;
    backgroundAttachment: string;
    backgroundOrigin: string;
    backgroundClip: string;
}
Sets a background image with various customization options for 3D space
Parameters
- inputs: SceneCanvasBackgroundImageDto
  Describes the background image parameters
Returns {
    backgroundImage: string;
    backgroundRepeat: string;
    backgroundSize: string;
    backgroundPosition: string;
    backgroundAttachment: string;
    backgroundOrigin: string;
    backgroundClip: string;
}
Shortname
background image
- Defined in bitbybit-docs.d.ts:37558

backgroundColour

backgroundColour(inputs: SceneBackgroundColourDto): void
Changes the scene background colour for 3D space
Parameters
- inputs: SceneBackgroundColourDto
  Describes the colour of the scene background
Returns void
Shortname
colour
- Defined in bitbybit-docs.d.ts:37573

camera

activateCamera

activateCamera(inputs: ActiveCameraDto): void
Activate camera by overwriting currently active camera
Parameters
- inputs: ActiveCameraDto
  Activates the camera
Returns void
Shortname
activate
- Defined in bitbybit-docs.d.ts:37388

getActiveCamera

getActiveCamera(): Camera
Gets the active camera of the scene

Returns Camera
Shortname
get active camera
- Defined in bitbybit-docs.d.ts:37443

adjustActiveArcRotateCamera

adjustActiveArcRotateCamera(inputs: CameraConfigurationDto): void
Adjusts the active arc rotate camera with configuration parameters
Parameters
- inputs: CameraConfigurationDto
Returns void
Shortname
adjust active camera
- Defined in bitbybit-docs.d.ts:37449

environment

clearAllDrawn

clearAllDrawn(): void
Clears all of the drawn objects in the 3D scene

Returns void
Shortname
clear all drawn
- Defined in bitbybit-docs.d.ts:37455

enableSkybox

enableSkybox(inputs: SkyboxDto): void
Enables skybox
Parameters
- inputs: SkyboxDto
  Skybox configuration
Returns void
Shortname
skybox
- Defined in bitbybit-docs.d.ts:37462

enableSkyboxCustomTexture

enableSkyboxCustomTexture(inputs: SkyboxCustomTextureDto): void
Enables skybox with custom texture
Parameters
- inputs: SkyboxCustomTextureDto
  Skybox configuration
Returns void
Shortname
skybox
- Defined in bitbybit-docs.d.ts:37469

fog

fog(inputs: FogDto): void
Enables fog mode
Parameters
- inputs: FogDto
  fog options
Returns void
Shortname
fog
- Defined in bitbybit-docs.d.ts:37494

lights

drawPointLightNoReturn

drawPointLightNoReturn(inputs: PointLightDto): void
Creates and draws a point light in the scene but does not output anything
Parameters
- inputs: PointLightDto
  Describes the light source
Returns void
Shortname
point

Disposable Output
true
- Defined in bitbybit-docs.d.ts:37403

getShadowGenerators

getShadowGenerators(): ShadowGenerator[]
Get shadow generators added by light sources through bitbybit

Returns ShadowGenerator[]
Shortname
point

Disposable Output
true
- Defined in bitbybit-docs.d.ts:37411

drawPointLight

drawPointLight(inputs: PointLightDto): PointLight
Creates and draws a point light in the scene
Parameters
- inputs: PointLightDto
  Describes the light source
Returns PointLight
BabylonJS point light

Shortname
point light

Disposable Output
true
- Defined in bitbybit-docs.d.ts:37420

drawDirectionalLightNoReturn

drawDirectionalLightNoReturn(inputs: DirectionalLightDto): void
Creates and draws a directional light in the scene
Parameters
- inputs: DirectionalLightDto
  Describes the light source
Returns void
Shortname
directional

Disposable Output
true
- Defined in bitbybit-docs.d.ts:37428

drawDirectionalLight

drawDirectionalLight(inputs: DirectionalLightDto): DirectionalLight
Creates and draws a directional light in the scene
Parameters
- inputs: DirectionalLightDto
  Describes the light source
Returns DirectionalLight
BabylonJS directional light

Shortname
directional light

Disposable Output
true
- Defined in bitbybit-docs.d.ts:37437

system

useRightHandedSystem

useRightHandedSystem(inputs: UseRightHandedSystemDto): void
Use right handed system
Parameters
- inputs: UseRightHandedSystemDto
  Activates the camera
Returns void
Shortname
hand right
- Defined in bitbybit-docs.d.ts:37395

Class BabylonScene

Index

Constructors

background

camera

environment

lights

system

Constructors

constructor

Parameters

Returns Bit.BabylonScene

background

canvasCSSBackgroundImage

Parameters

Returns { backgroundImage: string }

Shortname

twoColorLinearGradientBackground

Parameters

Returns { backgroundImage: string }

Shortname

twoColorRadialGradientBackground

Parameters

Returns { backgroundImage: string }

Shortname

multiColorLinearGradientBackground

Parameters

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

Shortname

multiColorRadialGradientBackground

Parameters

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

Shortname

canvasBackgroundImage

Parameters

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

Shortname

backgroundColour

Parameters

Returns void

Shortname

camera

activateCamera

Parameters

Returns void

Shortname

getActiveCamera

Returns Camera

Shortname

adjustActiveArcRotateCamera

Parameters

Returns void

Shortname

environment

clearAllDrawn

Returns void

Shortname

enableSkybox

Parameters

Returns void

Shortname

enableSkyboxCustomTexture

Parameters

Returns void

Shortname

fog

Parameters

Returns void

Shortname

lights

drawPointLightNoReturn

Parameters

Returns void

Shortname

Disposable Output

getShadowGenerators

Returns ShadowGenerator[]

Shortname

Disposable Output

drawPointLight

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