Description | Example | Return Message | Group

Lighting Sunlight

Control the graphical display of sunlit regions during animation (Deprecated Command)

Syntax

Lighting <ScenarioPath> Sunlight {DisplayOption} <Value> [{DisplayOption2} <Value2> ... ]

ATTENTION: THIS COMMAND IS DEPRECATED and has been replaced by:

Lighting

Description

Note: This command was deprecated in STK 10, it should no longer be used. This command has been replaced by the Lighting Day command.

The Lighting Sunlight command allows you to define the display of sunlit regions in the 2D Graphics window. Regions of sunlight can be displayed as filled areas and the boundaries around the regions as lines.

Hint: {DisplayOptions} can be strung together to set multiple values at once.

{DisplayOption} <Value> Description
Fill On Regions of lighting conditions display as filled areas.
Off Regions of lighting conditions are not filled.
FillStyle {FillStyle} Select the style of the filled areas representing lighting regions using either the name of the fill style or the number (from 0 to 7) representing the desired style.

For valid {FillStyle} options see Common Options.

FillColor {Color} Define the color for the display of the filled areas that represent regions of light.

For valid {Color} options see Common Options.

ShowLine On Outline the boundaries for regions of lighting.
Off Do not outline the boundaries of different lighting regions.
LineStyle {LineStyle} Select the style of the lines representing the boundaries between lighting regions. {LineStyle} can be a name such as Solid, Dashed, Dotted, etc, or a number 0, 1, 2, etc. For all valid {LineStyle} options see Common Options.
LineWidth <Width> Specify the pixel width value of the lines representing the boundaries between lighting regions. Valid values are 1.0 - 10.0
LineColor {Color} Define the color of the lines that will define the boundaries for regions of light.

For valid {Color} options see Common Options.

WindowID <WinNumber> Enter the number of the 3D window to which the changes should be applied.

Example

To display sunlit regions as filled areas in all 2D Graphics windows:

Lighting * Sunlight Fill On

ReturnMessage

If activated, Connect returns an acknowledgement message.

Group Membership

This command belongs to the following group(s):

2D Graphics Window

Deprecated Commands

Version

10

STK Programming Interface 11.0.1