Display lines connecting objects in the 2D Graphics window
Graphics <ScenarioPath> ObjectLine {Action} FromObj <TruncObjectPath1> ToObj <TruncObjectPath2> [{LineOptions}]
The Graphics ObjectLine command allows you to display lines connecting objects in the 2D Graphics window. Indicate the object from which the line should start and the object to which the line should span using the truncated object paths of the objects. Use the {Action} options and their associated {LineOptions} to define the display of the lines in the 2D Graphics window.
Valid values for {Action} are described in the following table.
| {Action} | Description |
|---|---|
| Add | Display a line between the objects specified using <TruncObjectPath1> and <TruncObjectPath2>. |
| Modify | Modify the attributes of the line between the objects specified using <TruncObjectPath1> and <TruncObjectPath2>. If there is currently no line connecting the specified objects, Connect will return a NACK. |
| Delete | Remove the line between the objects specified using <TruncObjectPath1> and <TruncObjectPath2>. If there is currently no line connecting the specified objects, Connect will return a NACK. |
| DeleteAll | Remove all lines between objects.
Note: No other parameters should be entered if DeleteAll is entered, except the optional WindowID <WinNumber> option. |
For any {Action}, use the following {LineOptions} to define or delete the lines connecting objects in the 2D Graphics window.
| {LineOption} | Description |
|---|---|
| WindowID <WinNumber> | Indicate the 2D Graphics window within which you would like the action to take place. If this option is not specified, lines in the first 2D Graphics window will be affected. |
If {Action} is Add or Modify, use the following {LineOptions} to define the display of the lines connecting objects in the 2D Graphics window.
| {LineOption} | Description |
|---|---|
| Show {On | Off|} | Turning Show Off hides an individual line between the specified objects. |
| Color {Color} | Set the color of the line. For valid {Color} options see Common Options. |
| LineWidth <Width> | Indicate a pixel width value between 1.0 and 10.0 |
| FromObjData <ObjectData> | Use this option to enter additional
information about the From Object.
If the FromObj is an MTO, then use this option to specify the track number that the Object Line will be drawn from. |
| ToObjData <ObjectData> | Use this option to enter additional
information about the To Object.
If the ToObj is an MTO, then use this option to specify the track number that the Object Line will be drawn to. |
| IntervalType {UseIntervals | AlwaysOn} | Indicate whether the line should be always on, or should use the defined intervals. |
| AddIntervals <numIntervals> ("<StartTime>" "<StopTime>")... | Adds the specified intervals. |
| ModifyInterval "<StartTime>" "<StopTime>" Color {Color} | Modifies the color of a single interval. For valid {Color} options see Common Options. |
| LoadIntervals "<IntervalFile>" | Adds the intervals in the file to the existing interval list. |
| ImportIntervals "<TimeComponent>" | Adds the intervals from the specified
Interval or Interval List component to the existing interval list.
For information about "<TimeComponent>" see Component Specification. |
| DeleteIntervals <numIntervals> ("<StartTime>" "<StopTime>")... | Deletes the specified intervals. Valid only if {Action} is Modify. |
| DeleteAllIntervals | Deletes all intervals. |
| DrawAsGreatArc {On | Off} | If on, the line will be drawn as a great arc, preventing it from intersecting the central body. This will create a line that stays on the surface of the central body, rather than going through it in a straight line. |
Note: All Times are entered in Connect Date units
To display a red line of line width 3 between Satellite1 and Satellite2 in the first 2D Graphics window:
Graphics * ObjectLine Add FromObj Satellite/Satellite1 ToObj Satellite/Satellite2 Color red LineWidth 3
To display a line between Facility1 and Satellite2 in the second 2D Graphics window:
Graphics * ObjectLine Add FromObj Facility/Facility1 ToObj Satellite/Satellite2 Color 1 WindowID 2
To modify the line from Satellite1 to Satellite2, created in the first example, so that it displays in blue with a line width of 5:
Graphics * ObjectLine Modify FromObj Satellite/Satellite1 ToObj Satellite/Satellite2 Color blue LineWidth 5
To hide the line previously created between Satellite1 and Satellite2:
Graphics * ObjectLine Modify FromObj Satellite/Satellite1 ToObj Satellite/Satellite2 Show Off
To remove the line between Satellite1 and Satellite2:
Graphics * ObjectLine Delete FromObj Satellite/Satellite1 ToObj Satellite/Satellite2
To remove the line between Facility1 and Satellite2 in 2D Graphics window number 2:
Graphics * ObjectLine Delete FromObj Facility/Facility1 ToObj Satellite/Satellite2 WindowID 2
To add a line between Satellite1 and Facility1, with two intervals:
Graphics * ObjectLine Add FromObj Satellite/Satellite1 ToObj Facility/Facility1 AddIntervals 2 "1 Jul 2005 12:00:00.00" "1 Jul 2005 13:01:00.00" "1 Jul 2005 13:01:00.00" "1 Jul 2005 14:02:00.00"
To modify the line to use display intervals:
Graphics * ObjectLine Modify FromObj Satellite/Satellite1 ToObj Facility/Facility1 IntervalType UseIntervals
The following two commands will set the colors of the two intervals:
Graphics * ObjectLine Modify FromObj Satellite/Satellite1 ToObj Facility/Facility1 ModifyInterval "1 Jul 2005 12:00:00.00" "1 Jul 2005 13:01:00.00" Color red
Graphics * ObjectLine Modify FromObj Satellite/Satellite1 ToObj Facility/Facility1 ModifyInterval "1 Jul 2005 13:01:00.00" "1 Jul 2005 14:02:00.00" Color cyan
To add a line between track 1 of mto1 and track 2 of mto2:
Graphics * ObjectLine Add FromObj MTO/mto1 FromObjData 1 ToObj MTO/mto2 ToObjData 2 Color yellow linewidth 2
Delete all object lines in the first 2d graphics window:
Graphics * ObjectLine DeleteAll
If activated, Connect returns an acknowledgement message.
This command belongs to the following group(s):
10
STK Programming Interface 11.0.1