API (v2.0.0) - Giro3D
    Preparing search index...

    Interface SunExposureOptions

    interface SunExposureOptions {
        colorMap?: ColorMap;
        end?: Date;
        instance: Instance;
        limits: Box3 | Extent | Sphere;
        objects: (
            Object3D<Object3DEventMap>
            | Entity3D<Entity3DEventMap, EntityUserData>
        )[];
        showHelpers?: boolean;
        spatialResolution?: number;
        start: Date;
        temporalResolution?: number;
    }
    Index

    Properties

    colorMap?: ColorMap

    The color map to use on the point cloud preview to display irradiation. Note that once the computation is finished, you can modify the colormaps on the resulting point cloud.

    a rainbow colormap
    
    end?: Date

    The date at the end of the simulation time range. If unspecified, then the time range will be [start, start] and only one simulation step will be performed.

    instance: Instance

    The Giro3D instance to use. This must be the same instance as the one that will host the resulting point cloud.

    limits: Box3 | Extent | Sphere

    The area of interest to limit the simulation. The smaller the area of interest, the faster the simulation will be.

    objects: (
        Object3D<Object3DEventMap>
        | Entity3D<Entity3DEventMap, EntityUserData>
    )[]

    The objects to include in the computation.

    showHelpers?: boolean

    If true, show helpers to help visualize the computation steps. Helpers will remain visible until the dispose() method is called.

    false
    
    spatialResolution?: number

    The spatial resolution, in scene units. This is the average space between simulation probes. If unspecified, a default value is computed from the dimensions of limits.

    start: Date

    The date at the start of the simulation time range.

    temporalResolution?: number

    The temporal resolution, in seconds. This is the interval between simulation steps. If end was not set, then this parameter has no effect.

    3600