Class BabylonScene

Hierarchy

BabylonScene

Index

Constructors

constructor

Methods

Constructors

constructor

new BabylonScene(context: Context): BabylonScene

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

Methods

activateCamera

activateCamera(inputs: ActiveCameraDto): void

- Defined in bitbybit-docs.d.ts:18419
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:18480
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:18412
Changes the scene background colour for 3D space

group

environment

shortname

colour

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

clearAllDrawn

clearAllDrawn(): void

- Defined in bitbybit-docs.d.ts:18486
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:18468
Creates and draws a directional light in the scene

group

lights

shortname

directional

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:18459
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:18451
Creates and draws a point light in the scene

group

lights

shortname

point

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:18434
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:18493
Enables skybox

group

environment

shortname

skybox

Parameters
- inputs: SkyboxDto
  
  Skybox configuration
Returns void

fog

fog(inputs: FogDto): void

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

group

environment

shortname

fog

Parameters
- inputs: FogDto
  
  fog options
Returns void

getActiveCamera

getActiveCamera(): Camera

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

group

camera

shortname

get active camera

Returns Camera

getShadowGenerators

getShadowGenerators(): ShadowGenerator[]

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

group

lights

shortname

point

disposableoutput

true

Returns ShadowGenerator[]

useRightHandedSystem

useRightHandedSystem(inputs: UseRightHandedSystemDto): void

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

group

system

shortname

hand right

Parameters
- inputs: UseRightHandedSystemDto
  
  Activates the camera
Returns void

Generated using TypeDoc