Description | Example | Return Message | Group

Lighting

Set lighting transition line and area display options.

Syntax

Lighting <ScenarioPath> {LightingType} {DisplayOptions}

Related Commands

Description

Use the Lighting command to set UmbraPenumbra and SunlightPenumbra transition line display options, and Day and Night area display options in a 2D Graphics windows.

Valid values for {LightingType} are: UmbraPenumbra, SunlightPenumbra, Day, Night.

The following tables describe the {DisplayOptions} for the Lighting types.

Options for UmbraPenumbra and SunlightPenumbra Lighting Type

UmbraPenumbra controls outline transition options for the umbra/penumbra line.

SunlightPenumbra controls outline transition options for the sunlight/penumbra line.

{DisplayOptions} Description
ShowLine {On | Off} Show or hide the line.
LineStyle {LineStyle} Specify the style of the outline. {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> Indicates the width of the outline. <Width> is a value between 1.0 and 10.0.
LineColor {Color} Specify the outline color. For all valid {Color} options see Common Options
WindowId <WinNumber> Specify the 2d Graphics window where the lighting options are being set. The default is the first 2D Graphics window.

Options for Day and Night Lighting Type

Day controls fill options for day area.

Night controls fill options for night area.

{DisplayOptions} Description
Fill {On | Off} Turn Fill on or off.
FillColor {Color} Specify the fill color. For all valid {Color} options see Common Options
EdgeTranslucency <Width> Indicates the width of the edge translucency. <Width> is a value between 0.0 and 100.0.
CenterTranslucency <Width> Indicates the width of the center translucency. <Width> is a value between 0.0 and 100.0.
WindowId <WinNumber> Specify the 2d Graphics window where the lighting options are being set. The default is the first 2D Graphics window.

Note: Lighting fill may not be available for older video cards.

Example

To set display options for UmbraPenumbra line:

Lighting * UmbraPenumbra ShowLine On LineStyle Dotted LineColor yellow

To set display options for SunlightPenumbra line:

Lighting * SunlightPenumbra LineColor red lineWidth 4

To set display options for Day area:

Lighting * Day Fill On EdgeTranslucency 10.0

To set display options for Night area:

Lighting * Night Fill On FillColor blue WindowId 2

ReturnMessage

If activated, Connect returns an acknowledgement message.

Group Membership

This command belongs to the following group(s):

2D Graphics Window

Version

10

STK Programming Interface 11.0.1