ShadowInfo

A snapshot of SketchUp’s shadow and sun settings.

Retrieve it with model.getShadowInfo(). It captures the geographic location, sun angle, time of day, and display toggles that control how shadows render.

Example

let model = await SketchUpApi.getActiveModel();
let shadows = await model.getShadowInfo();

console.log(shadows.city);
// => 'Boulder (CO)'
console.log(shadows.latitude);
// => 40.0
console.log(shadows.displayShadows);
// => true or false

See

Model.getShadowInfo

Properties

city

readonly city: string

The location name used for sun angle calculations, like 'Boulder (CO)'. Labeled “Location” in the SketchUp UI.

country

readonly country: string

The country name associated with the model location, like 'USA'.

dark

readonly dark: number

Shadow darkness as a value from 0 (transparent) to 100 (fully dark), like 45. Corresponds to the Dark slider in Window > Shadows.

daylightSavings

readonly daylightSavings: boolean

Whether daylight saving time is in effect for the shadow time calculation.

dayOfYear

readonly dayOfYear: number

Day of the year (1–365) used to compute the sun angle, like 312.

displayNorth

readonly displayNorth: boolean

Whether the north direction indicator is shown in the viewport.

displayOnAllFaces

readonly displayOnAllFaces: boolean

Whether shadows are cast onto faces.

displayOnGroundPlane

readonly displayOnGroundPlane: boolean

Whether shadows are cast onto the ground plane.

displayShadows

readonly displayShadows: boolean

Whether shadows appear at all.

edgesCastShadows

readonly edgesCastShadows: boolean

Whether edges cast shadows.

latitude

readonly latitude: number

Geographic latitude in decimal degrees, like 40.018. Positive is north.

light

readonly light: number

Ambient light level from 0 (dark) to 100 (fully lit), like 80. Corresponds to the Light slider in Window > Shadows.

longitude

readonly longitude: number

Geographic longitude in decimal degrees, like -105.24. Positive is east.

northAngle

readonly northAngle: number

The angle of north relative to the model axes, in degrees, like 0.

shadowTime

readonly shadowTime: string

The current shadow time as a date-time string, like '2013-11-08 13:30.000000 +0000'.

shadowTime_time_t

readonly shadowTime_time_t: number

Shadow time as Unix epoch seconds, like 1383917400.

sunDirection

readonly sunDirection: Vector3d

The computed direction of the sun as a 3D vector.

sunRise

readonly sunRise: string

Computed sunrise time as a date-time string, like '2013-11-08 06:43.000000 +0000'.

sunRise_time_t

readonly sunRise_time_t: number

Sunrise time as Unix epoch seconds, like 1383892994.

sunSet

readonly sunSet: string

Computed sunset time as a date-time string, like '2013-11-08 16:45.000000 +0000'.

sunSet_time_t

readonly sunSet_time_t: number

Sunset time as Unix epoch seconds, like 1383929157.

tZOffset

readonly tZOffset: number

UTC timezone offset in hours, like -7 for Mountain Time.

useSunForAllShading

readonly useSunForAllShading: boolean

Whether the sun direction is used for all shading, including faces that would otherwise be in shadow.

Methods

refresh()

refresh(): Promise<ShadowInfo>

Re-fetches the shadow info from SketchUp to pick up any changes made since this snapshot was taken.

Returns

Promise<ShadowInfo>

toString()

toString(): string

Returns

string