Skip to content

compas_threejs.lights.sunlight.Sunlight ¤

Sunlight(
    color: Color = white(),
    point: Point = Point(0, 0, 0),
    direction: Vector = Vector(-1, -1, -1),
    intensity: float = 500,
    helper: bool = False,
    **kwargs,
)

A class representing sunlight in a 3D scene.

The Sunlight class is a type of light source that simulates sunlight. It is defined by its color, position, direction, intensity, and an optional helper for visualization.

Attributes:

  • color (:class:`compas.colors.Color`) –

    The color of the sunlight. Defaults to white.

  • point (:class:`compas.geometry.Point`) –

    The position of the sunlight source in 3D space. Defaults to the origin (0, 0, 0).

  • direction (:class:`compas.geometry.Vector`) –

    The direction vector of the sunlight. Defaults to (-1, -1, -1).

  • intensity (float) –

    The intensity of the sunlight. Defaults to 500.

  • helper (bool) –

    A flag indicating whether a helper visualization is enabled. Defaults to False.

  • guid (str) –

    A unique identifier for the sunlight instance, automatically generated.