Description | Example | Return Message | Group

Graphics Lighting

Control the graphical display of lighting conditions for a vehicle

Syntax

Graphics <ObjectPath> Lighting {LightCondition} {LightConditionOption1} <Value1> [{LightConditionOption1} <Value2>... ]

Description

The Graphics Lighting command allows you to control the display of lighting conditions for vehicles by indicating {LightConditions} and defining their associated {LightConditionOptions}. Valid values for {LightCondition} are outlined in the following Table.

{LightCondition} Description
Sunlight Draw a line on the vehicle track in the 2D Graphics window(s) where the vehicle is in complete sunlight.
Penumbra Draw a line on the vehicle track in the 2D Graphics window(s) where the Sun is partially blocked by the Earth and, therefore, the vehicle is only in partial sunlight.
Umbra Draw a line on the vehicle track in the 2D Graphics window(s) where the Sun is completely blocked by the Earth and, therefore, the vehicle isn't in sunlight at all.
SunPenAtAltitude Display the dividing line between sunlight and penumbra at the vehicle altitude.
PenUmbAtAltitude Display the dividing line between penumbra and umbra at the vehicle altitude.

Warning: If {LightCondition} is SunPenAtAltitude or PenUmbAtAltitude then Show {On | Off} is the only valid {LightConditionOption}, any others will be ignored.

{LightConditionOptions} help to define the display of a chosen {LightCondition} in the 2D Graphics window(s). Valid values for {LightConditionOption} and their associated parameters are outlined in the following Table.

{LightConditionOption} <Value>
Show {On | Off}
Style {LineStyle}

For valid {LineStyle} options see Common Options.

LineWidth <Width>

Indicate a pixel width value, valid value is between 1.0 and 10.0.

Color {Color}

For valid {Color} options see Common Options.

Marker {MarkerType}

Visit Connect help for the Graphics Marker command for a description of {MarkerType} and it's parameters.

Example

To draw a line with a width of 2 on the vehicle track in regions of umbra and use a plus to represent the vehicle while it is within the umbra region:

Graphics */Satellite/attSat Lighting Umbra Show On LineWidth 2 Marker Plus

To draw a red line to indicate regions of sunlight along the vehicle track:

Graphics */Satellite/attSat Lighting SunLight Show On Color red

To display dividing line between sunlight and penumbra at the attSat satellite's altitude:

Graphics */Satellite/attSat Lighting SunPenAtAltitude Show On

ReturnMessage

If activated, Connect returns an acknowledgement message.

Group Membership

This command belongs to the following group(s):

2D Object Graphics

Vehicles

Version

4.3

STK Programming Interface 11.0.1