Class Sunlight`Experimental`

Since

Cesium 1.132.0

Point sunlight analysis utility for shadow calculations.

⚠️ Warning: This is an experimental feature that uses Cesium's internal APIs. The API may change or break in future versions of Cesium or cesium-utils.

Example

const sunlight = new Sunlight(viewer);
sunlight.analyze(point, JulianDate.now());

Index

Constructors

constructor

new Sunlight(viewer: Viewer): Sunlight
Experimental
Parameters
- viewer: Viewer
Returns Sunlight
- Defined in experimental/sunlight.ts:37

Properties

`Private` `Experimental`_analyzing

_analyzing: boolean = false

`Private` `Experimental`_objectsToExclude

_objectsToExclude: any[] = []

`Private` `Optional` `Experimental`_pointEntityId

_pointEntityId?: string

`Private` `Experimental`_points

_points: EntityCollection

`Private` `Experimental`_polylines

_polylines: PolylineCollection

`Private` `Experimental`_uniformState

_uniformState: any

`Private` `Experimental`_viewer

_viewer: Viewer

Accessors

isAnalyzing

get isAnalyzing(): boolean
Experimental
Whether sunlight analysis is currently in progress.

Returns boolean
- Defined in experimental/sunlight.ts:57

sunDirectionWC

get sunDirectionWC(): Cartesian3
Experimental
A normalized vector to the sun in 3D world coordinates at the current scene time.

Returns Cartesian3
- Defined in experimental/sunlight.ts:52

sunPositionWC

get sunPositionWC(): Cartesian3
Experimental
The sun position in 3D world coordinates at the current scene time.

Returns Cartesian3
- Defined in experimental/sunlight.ts:47

Methods

`Private`_analyzeSingleTime

_analyzeSingleTime(
    from: Cartesian3,
    time: JulianDate,
    options?: AnalyzeOptions,
): Promise<AnalysisResult>
Experimental
Parameters
- from: Cartesian3
- time: JulianDate
- Optionaloptions: AnalyzeOptions
Returns Promise<AnalysisResult>
- Defined in experimental/sunlight.ts:187

`Private`_analyzeTimeRange

_analyzeTimeRange(
    from: Cartesian3,
    timeRange: TimeRange,
    options?: AnalyzeOptions,
): Promise<AnalysisResult[]>
Experimental
Parameters
- from: Cartesian3
- timeRange: TimeRange
- Optionaloptions: AnalyzeOptions
Returns Promise<AnalysisResult[]>
- Defined in experimental/sunlight.ts:225

`Private`_getExcludedObjects

_getExcludedObjects(objectsToExclude?: any[]): any[]
Experimental
Parameters
- OptionalobjectsToExclude: any[]
Returns any[]
- Defined in experimental/sunlight.ts:261

`Private`_pick

_pick(
    from: Cartesian3,
    objectsToExclude?: any[],
    width?: number,
): Promise<{ [key: string]: any }>
Experimental
Parameters
- from: Cartesian3
- OptionalobjectsToExclude: any[]
- width: number = 0.1
Returns Promise<{ [key: string]: any }>
A promise tht resolves to an object containing the object and position of the first intersection.

See
https://github.com/CesiumGS/cesium/blob/1.136/packages/engine/Source/Scene/Scene.js#L4868
- Defined in experimental/sunlight.ts:244

analyze

analyze(
    from: Cartesian3,
    at: JulianDate,
    options?: AnalyzeOptions,
): Promise<AnalysisResult>
Experimental
Analyze the sunlight acceptance from a given point at a given time.
Parameters
- from: Cartesian3
  target point to analyze
- at: JulianDate
  time to analyze
- Optionaloptions: AnalyzeOptions
  Sunlight.AnalyzeOptions
Returns Promise<AnalysisResult>
- Defined in experimental/sunlight.ts:95
analyze(
    from: Cartesian3,
    range: TimeRange,
    options?: AnalyzeOptions,
): Promise<AnalysisResult[]>
Experimental
Analyze the sunlight acceptance from a given point at a given time range.
Parameters
- from: Cartesian3
  target point to analyze
- range: TimeRange
  time range to analyze
- Optionaloptions: AnalyzeOptions
  Sunlight.AnalyzeOptions
Returns Promise<AnalysisResult[]>
- Defined in experimental/sunlight.ts:106

clear

clear(): void
Experimental
Remove all instances created for debug purpose

Returns void
- Defined in experimental/sunlight.ts:142

setTargetPoint

setTargetPoint(
    at: Cartesian3,
    show?: boolean,
    errorBoundary?: number,
    color?: Color,
): Entity
Experimental
Create an ellipsoid entity for ray collision detection to complement cesium's native click event accuracy
Parameters
- at: Cartesian3
  where to create the entity
- Optionalshow: boolean
  whether to show point entity
- OptionalerrorBoundary: number
  size of the point entity for error tolerance
- color: Color = ...
Returns Entity
- Defined in experimental/sunlight.ts:154

virtualSun

virtualSun(
from: Cartesian3,
radius?: number,
): { direction: Cartesian3; position: Cartesian3 }
Experimental
Gets virtual position and direction of the sun to reduce calculation overhead.
Parameters
- from: Cartesian3
  target point to start from
- radius: number = 10000
  virtual distance between target point and the sun. Defaults to 10000 (10km)
Returns { direction: Cartesian3; position: Cartesian3 }
- Defined in experimental/sunlight.ts:67

Class SunlightExperimental

Since

Example

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns Sunlight

Properties

Private Experimental_analyzing

Private Experimental_objectsToExclude

Private Optional Experimental_pointEntityId

Private Experimental_points

Private Experimental_polylines

Private Experimental_uniformState

Private Experimental_viewer

Accessors

isAnalyzing

Returns boolean

sunDirectionWC

Returns Cartesian3

sunPositionWC

Returns Cartesian3

Methods

Private_analyzeSingleTime

Parameters

Returns Promise<AnalysisResult>

Private_analyzeTimeRange

Parameters

Returns Promise<AnalysisResult[]>

Private_getExcludedObjects

Parameters

Returns any[]

Private_pick

Parameters

Returns Promise<{ [key: string]: any }>

See

analyze

Parameters

Returns Promise<AnalysisResult>

Parameters

Returns Promise<AnalysisResult[]>

clear

Returns void

setTargetPoint

Parameters

Returns Entity

virtualSun

Parameters

Returns { direction: Cartesian3; position: Cartesian3 }

Settings

On This Page

Class Sunlight`Experimental`

`Private` `Experimental`_analyzing

`Private` `Experimental`_objectsToExclude

`Private` `Optional` `Experimental`_pointEntityId

`Private` `Experimental`_points

`Private` `Experimental`_polylines

`Private` `Experimental`_uniformState

`Private` `Experimental`_viewer

`Private`_analyzeSingleTime

`Private`_analyzeTimeRange

`Private`_getExcludedObjects

`Private`_pick