SpatialAnalysisToolConditionLighting#

class ansys.stk.core.analysis_workbench.SpatialAnalysisToolConditionLighting#

Bases: ISpatialAnalysisToolVolume, IAnalysisWorkbenchComponent

A lighting volume interface.

Overview#

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.

lighting_conditions

Get or set the lighting conditions.

Import detail#

from ansys.stk.core.analysis_workbench import SpatialAnalysisToolConditionLighting

Property detail#

property SpatialAnalysisToolConditionLighting.eclipsing_bodies: list#

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

property SpatialAnalysisToolConditionLighting.use_object_eclipsing_bodies: bool#

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

property SpatialAnalysisToolConditionLighting.lighting_conditions: LightingConditionsType#

Get or set the lighting conditions.