Class Scene

constructor

• new Scene(descriptor?: SceneDescriptor): Scene

  Parameters

  • descriptor: SceneDescriptor = {}

  Returns Scene

Static ReadonlyMAX_LIGHTS

background

• get background(): Color

  Returns Color

• set background(value: Color): void

  Parameters

  • value: Color

  Returns void

enabledLights

• get enabledLights(): Light[]

  Returns Light[]

glyphFields

• get glyphFields(): readonly GlyphField[]

  Returns readonly GlyphField[]

lights

• get lights(): readonly Light[]

  Returns readonly Light[]

meshes

• get meshes(): readonly Mesh[]

  Returns readonly Mesh[]

pointClouds

• get pointClouds(): readonly PointCloud[]

  Returns readonly PointCloud[]

visibleGlyphFields

• get visibleGlyphFields(): GlyphField[]

  Returns GlyphField[]

visibleMeshes

• get visibleMeshes(): Mesh[]

  Returns Mesh[]

visiblePointClouds

• get visiblePointClouds(): PointCloud[]

  Returns PointCloud[]

add

• add(mesh: Mesh): this

  Parameters

  • mesh: Mesh

  Returns this

• add(pointCloud: PointCloud): this

  Parameters

  • pointCloud: PointCloud

  Returns this

• add(glyphField: GlyphField): this

  Parameters

  • glyphField: GlyphField

  Returns this

addLight

• addLight(light: Light): this

  Parameters

  • light: Light

  Returns this

clear

• clear(): this

  Returns this

clearGlyphFields

• clearGlyphFields(): this

  Returns this

clearLights

• clearLights(): this

  Returns this

clearPointClouds

• clearPointClouds(): this

  Returns this

destroy

• destroy(): void

  Returns void

findAllByName

• findAllByName(name: string): Mesh[]

  Parameters

  • name: string

  Returns Mesh[]

findAllGlyphFieldsByName

• findAllGlyphFieldsByName(name: string): GlyphField[]

  Parameters

  • name: string

  Returns GlyphField[]

findAllPointCloudsByName

• findAllPointCloudsByName(name: string): PointCloud[]

  Parameters

  • name: string

  Returns PointCloud[]

findByName

• findByName(name: string): Mesh | undefined

  Parameters

  • name: string

  Returns Mesh | undefined

findGlyphFieldByName

• findGlyphFieldByName(name: string): GlyphField | undefined

  Parameters

  • name: string

  Returns GlyphField | undefined

findPointCloudByName

• findPointCloudByName(name: string): PointCloud | undefined

  Parameters

  • name: string

  Returns PointCloud | undefined

getAmbientColor

• getAmbientColor(): Color

  Returns Color

getLightingData

• getLightingData(): { ambient: Color; lights: Light[] }

  Returns { ambient: Color; lights: Light[] }

remove

• remove(mesh: Mesh): this

  Parameters

  • mesh: Mesh

  Returns this

• remove(pointCloud: PointCloud): this

  Parameters

  • pointCloud: PointCloud

  Returns this

• remove(glyphField: GlyphField): this

  Parameters

  • glyphField: GlyphField

  Returns this

removeLight

• removeLight(light: Light): this

  Parameters

  • light: Light

  Returns this

traverse

• traverse(callback: (mesh: Mesh) => void): void

  Parameters

  • callback: (mesh: Mesh) => void

  Returns void

traverseGlyphFields

• traverseGlyphFields(callback: (g: GlyphField) => void): void

  Parameters

  • callback: (g: GlyphField) => void

  Returns void

traversePointClouds

• traversePointClouds(callback: (pc: PointCloud) => void): void

  Parameters

  • callback: (pc: PointCloud) => void

  Returns void

traverseVisible

• traverseVisible(callback: (mesh: Mesh) => void): void

  Parameters

  • callback: (mesh: Mesh) => void

  Returns void

traverseVisibleGlyphFields

• traverseVisibleGlyphFields(callback: (g: GlyphField) => void): void

  Parameters

  • callback: (g: GlyphField) => void

  Returns void

traverseVisiblePointClouds

• traverseVisiblePointClouds(callback: (pc: PointCloud) => void): void

  Parameters

  • callback: (pc: PointCloud) => void

  Returns void