Urchin Reference - AmbientLight

An AmbientLight is an Urbject that implements the Light interface and shines evenly across all Trigons in the Scene regardless of distance or orientation.

Constructors

AmbientLight( ): AmbientLight

Initializes with default attribute values.

AmbientLight( { brightness?: number, color?: Color, state?: number, group?: number, superCopy?: Urbject } ): AmbientLight

Initializes with the given values or default values if not provided. The default values are:

brightness	0.6	The brightness of the light. Any value over 1 is considered "overexposed".
color	new Color("WHITE")	The color of the light. See also: Color
state	Default from Urbject constructor	See also: Urbject
group	Default from Urbject constructor	See also: Urbject
superCopy	Default from Urbject constructor	See also: Urbject

Variables

Public Variables

brightness: number	The brightness of the light. Any value over 1 is considered "overexposed".
color: Color	The color of the light. See also: Color

Functions

Public Functions

copy(options?: { shallow: boolean } ): AmbientLight	Returns a copy of the AmbientLight. If shallow is true, the children of this Urbject will not be included in the copy.
getInstance(camera: Camera): FrameInstance	Returns the FrameInstance of the Urbject with this light added. See also: Urbject, FrameInstance
intensityOn(t: Trigon): number	Returns the intensity of the light on the given Trigon. See also: Trigon

Static Functions

AmbientLight.copy(l: AmbientLight, options?: { shallow: boolean } ): AmbientLight	Returns a copy of the AmbientLight or a new AmbientLight from an Object with all of the necessary AmbientLight and Urbject public attributes. If shallow is true, the children of the Urbject will not be included in the copy.
AmbientLight.getInstance(l: AmbientLight, camera: Camera): FrameInstance	Returns the FrameInstance of the given AmbientLight with its light added. See also: Urbject, FrameInstance
AmbientLight.intensityOn(l: AmbientLight, t: Trigon): number	Returns the intensity of the light on the given Trigon. See also: Trigon

Home