dolphin.lightlab · class ·

dolphinLightWorld

A dolphin light world record carrying shapes, lights, coastalEnvironment, nodes, sunx, and related state.

classcpudolphindolphin.lightlablightlabmethodsource-example

Build bounded lighting experiments with geometry, visibility, transport, film, and GPU/CPU contracts.

external class dolphinLightWorld

Status: source-declared

Fields and methods (15)
list of dolphinLightShape shapes
Stores shapes as list of dolphinLightShape.
list of dolphinLocalLight lights
Stores lights as list of dolphinLocalLight.
bool coastalEnvironment
Stores coastal environment as bool.
list of dolphinLightNode nodes
Stores nodes as list of dolphinLightNode.
float sunx
Stores sunx as float.
float sunRadius
Stores sun radius as float.
int maxBounces
Stores max bounces as int.
int localShadowSamples
Stores local shadow samples as int.
int rays
Stores rays as int.
dolphinLightWorld()
Dolphin light world.
Group()
Group. Complete example
AppendLight(int sourceShape,float x,float y,float z,float r,float g,float b,float intensity,float radius) returns bool
Append light. Complete example
AppendShape(int id,int kind,int mat,int components,float x,float y,float z,float sx,float sy,float sz,float yaw)
Append shape. Complete example
AppendAffineShape(int id,int kind,int mat,int components,Vector3 center,float sx,float sy,float sz,dolphinAffine3 basis)
Append affine shape. Complete example
AddShape(dolphinLightShape shape)
Add shape. Complete example

Use dolphinLightWorld

A complete small caller. Values are illustrative; check the returned result and package requirements before connecting live resources.

cpu · source-example · type checked

using dolphin.lightlab

// Build bounded lighting experiments with geometry, visibility, transport, film, and GPU/CPU contracts.
dolphinLightWorld sample = dolphinLightWorld()
Console.Log(Text.From(sample.coastalEnvironment))
project.mech
manifestVersion = "2"
package = "api.example.dolphin_lightlab__dolphinlightworld"
version = "0.1.0"
languageEdition = "yeho-core-2026.1"

[app]
kind = "headless"

[[dependencies]]
package = "dolphin.lightlab"
version = "0.1.0"
path = "../../../dolphin/packages/lightlab"

[[dependencies]]
package = "dolphin.materials"
version = "0.1.0"
path = "../../../dolphin/packages/materials"

[[dependencies]]
package = "dolphin.math"
version = "0.1.0"
path = "../../../dolphin/packages/math"

[[dependencies]]
package = "dolphin.spatial3d"
version = "0.1.0"
path = "../../../dolphin/packages/spatial3d"

dolphinLightWorld.Group

A complete caller for this public method. Sample inputs are illustrative; native resources require their owning lifecycle.

cpu · method · source-example · type checked

using dolphin.lightlab

// Group.
dolphinLightWorld instance = dolphinLightWorld()
instance.Group()
Console.Log("Group completed")
project.mech
manifestVersion = "2"
package = "api.example.dolphin_lightlab__dolphinlightworld"
version = "0.1.0"
languageEdition = "yeho-core-2026.1"

[app]
kind = "headless"

[[dependencies]]
package = "dolphin.lightlab"
version = "0.1.0"
path = "../../../dolphin/packages/lightlab"

[[dependencies]]
package = "dolphin.materials"
version = "0.1.0"
path = "../../../dolphin/packages/materials"

[[dependencies]]
package = "dolphin.math"
version = "0.1.0"
path = "../../../dolphin/packages/math"

[[dependencies]]
package = "dolphin.spatial3d"
version = "0.1.0"
path = "../../../dolphin/packages/spatial3d"

dolphinLightWorld.AppendLight

A complete caller for this public method. Sample inputs are illustrative; native resources require their owning lifecycle.

cpu · method · source-example · type checked

using dolphin.lightlab

// Append light.
dolphinLightWorld instance = dolphinLightWorld()
int argument_sourceShape = 1
float argument_x = 1.0
float argument_y = 1.0
float argument_z = 1.0
float argument_r = 1.0
float argument_g = 1.0
float argument_b = 1.0
float argument_intensity = 1.0
float argument_radius = 1.0
bool result = instance.AppendLight(argument_sourceShape, argument_x, argument_y, argument_z, argument_r, argument_g, argument_b, argument_intensity, argument_radius)
Console.Log(Text.From(result))
project.mech
manifestVersion = "2"
package = "api.example.dolphin_lightlab__dolphinlightworld"
version = "0.1.0"
languageEdition = "yeho-core-2026.1"

[app]
kind = "headless"

[[dependencies]]
package = "dolphin.lightlab"
version = "0.1.0"
path = "../../../dolphin/packages/lightlab"

[[dependencies]]
package = "dolphin.materials"
version = "0.1.0"
path = "../../../dolphin/packages/materials"

[[dependencies]]
package = "dolphin.math"
version = "0.1.0"
path = "../../../dolphin/packages/math"

[[dependencies]]
package = "dolphin.spatial3d"
version = "0.1.0"
path = "../../../dolphin/packages/spatial3d"

dolphinLightWorld.AppendShape

A complete caller for this public method. Sample inputs are illustrative; native resources require their owning lifecycle.

cpu · method · source-example · type checked

using dolphin.lightlab

// Append shape.
dolphinLightWorld instance = dolphinLightWorld()
int argument_id = 1
int argument_kind = 1
int argument_mat = 1
int argument_components = 1
float argument_x = 1.0
float argument_y = 1.0
float argument_z = 1.0
float argument_sx = 1.0
float argument_sy = 1.0
float argument_sz = 1.0
float argument_yaw = 1.0
instance.AppendShape(argument_id, argument_kind, argument_mat, argument_components, argument_x, argument_y, argument_z, argument_sx, argument_sy, argument_sz, argument_yaw)
Console.Log("AppendShape completed")
project.mech
manifestVersion = "2"
package = "api.example.dolphin_lightlab__dolphinlightworld"
version = "0.1.0"
languageEdition = "yeho-core-2026.1"

[app]
kind = "headless"

[[dependencies]]
package = "dolphin.lightlab"
version = "0.1.0"
path = "../../../dolphin/packages/lightlab"

[[dependencies]]
package = "dolphin.materials"
version = "0.1.0"
path = "../../../dolphin/packages/materials"

[[dependencies]]
package = "dolphin.math"
version = "0.1.0"
path = "../../../dolphin/packages/math"

[[dependencies]]
package = "dolphin.spatial3d"
version = "0.1.0"
path = "../../../dolphin/packages/spatial3d"

dolphinLightWorld.AppendAffineShape

A complete caller for this public method. Sample inputs are illustrative; native resources require their owning lifecycle.

cpu · method · source-example · type checked

using dolphin.lightlab

// Append affine shape.
dolphinLightWorld instance = dolphinLightWorld()
int argument_id = 1
int argument_kind = 1
int argument_mat = 1
int argument_components = 1
Vector3 argument_center = Vector3(1.0, 1.0, 1.0)
float argument_sx = 1.0
float argument_sy = 1.0
float argument_sz = 1.0
dolphinAffine3 argument_basis = dolphinAffine3()
instance.AppendAffineShape(argument_id, argument_kind, argument_mat, argument_components, argument_center, argument_sx, argument_sy, argument_sz, argument_basis)
Console.Log("AppendAffineShape completed")
project.mech
manifestVersion = "2"
package = "api.example.dolphin_lightlab__dolphinlightworld"
version = "0.1.0"
languageEdition = "yeho-core-2026.1"

[app]
kind = "headless"

[[dependencies]]
package = "dolphin.lightlab"
version = "0.1.0"
path = "../../../dolphin/packages/lightlab"

[[dependencies]]
package = "dolphin.materials"
version = "0.1.0"
path = "../../../dolphin/packages/materials"

[[dependencies]]
package = "dolphin.math"
version = "0.1.0"
path = "../../../dolphin/packages/math"

[[dependencies]]
package = "dolphin.spatial3d"
version = "0.1.0"
path = "../../../dolphin/packages/spatial3d"

dolphinLightWorld.AddShape

A complete caller for this public method. Sample inputs are illustrative; native resources require their owning lifecycle.

cpu · method · source-example · type checked

using dolphin.lightlab

// Add shape.
dolphinLightWorld instance = dolphinLightWorld()
dolphinLightShape argument_shape = dolphinLightShape(1, 1, 1, 1, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0)
instance.AddShape(argument_shape)
Console.Log("AddShape completed")
project.mech
manifestVersion = "2"
package = "api.example.dolphin_lightlab__dolphinlightworld"
version = "0.1.0"
languageEdition = "yeho-core-2026.1"

[app]
kind = "headless"

[[dependencies]]
package = "dolphin.lightlab"
version = "0.1.0"
path = "../../../dolphin/packages/lightlab"

[[dependencies]]
package = "dolphin.materials"
version = "0.1.0"
path = "../../../dolphin/packages/materials"

[[dependencies]]
package = "dolphin.math"
version = "0.1.0"
path = "../../../dolphin/packages/math"

[[dependencies]]
package = "dolphin.spatial3d"
version = "0.1.0"
path = "../../../dolphin/packages/spatial3d"
Notes and source

Package presence and a declaration do not establish support on every host. Host services need their platform and lifecycle setup.

dolphin/packages/lightlab/src/lightlab.yh:26