TimeToolTimeIntervalCollectionLighting#

class ansys.stk.core.analysis_workbench.TimeToolTimeIntervalCollectionLighting#

Bases: ITimeToolTimeIntervalCollection, IAnalysisWorkbenchComponent

Defined by computing sunlight, penumbra and umbra intervals as seen at specified location using specified selection of eclipsing bodies.

Overview#

location

The location point to compute sunlight, penumbra and umbra.

eclipsing_bodies

A custom list of eclipsing bodies. This list is used if UseObjectEclipsingBodies is set to false.

use_object_eclipsing_bodies

When true, configure eclipsing bodies list based on that of parent STK Object.

Import detail#

from ansys.stk.core.analysis_workbench import TimeToolTimeIntervalCollectionLighting

Property detail#

property TimeToolTimeIntervalCollectionLighting.location: IVectorGeometryToolPoint#

The location point to compute sunlight, penumbra and umbra.

property TimeToolTimeIntervalCollectionLighting.eclipsing_bodies: list#

A custom list of eclipsing bodies. This list is used if UseObjectEclipsingBodies is set to false.

property TimeToolTimeIntervalCollectionLighting.use_object_eclipsing_bodies: bool#

When true, configure eclipsing bodies list based on that of parent STK Object.