enum

Kozai::Illumination::Shadow

Inherits Enum < Comparable < Value < Object

Whether a satellite is in sunlight, and how completely.

Constants

Sunlit = 0

In full sunlight.

Penumbra = 1

Inside the penumbra: the Earth covers part of the Sun's disc but not all of it. The satellite is dimming, not dark.

Umbra = 2

Inside the umbra: no part of the Sun's disc is visible from it.

Instance methods

lit?

Whether any sunlight reaches it at all.

NOTE: true in the penumbra. The alternative — counting a partly lit satellite as eclipsed — would report it as vanishing several seconds before it fades, and the three-state value is reported alongside so that a caller wanting the stricter reading can have it.

Source
penumbra?

Returns true if this enum value equals Penumbra

Source
sunlit?

Returns true if this enum value equals Sunlit

Source
to_json_name

The lower-case name used in the API.

Source
umbra?

Returns true if this enum value equals Umbra

Source