GlobeLineLayer Object

The GlobeLineLayer object holds information about how line layers like political boundaries are rendered on a CelestialObject's globe. This object is not creatable in script, but an array of GlobeLineLayers is always created as a child object of the GlobeOptions object as seen in the example below:

Users cannot create instances of this type of object. However, users can access instances of this object type that have been created indirectly, for example as children of other objects. Users can also access any static properties and methods on this object type.

Available In Editions:

Timing Precision Mode

This page describes functionality in millisecond timing precision mode. Millisecond timing precision mode is deprecated and will be removed in a future release. We recommend that you migrate your Mission Plans to nanosecond timing precision mode.

Name	Description	Attributes
Color	The color used to render the lines in the layer.	Type: Variable Access: Read/Write
DeclaredName	The name of the object as declared.	Type: String Access: Read-Only
Label	The label used to identify the layer in the View Output Properties interface.	Type: String Access: Read/Write
Latitude	An array of planetodetic latitude coordinates for each data point.	Type: Array Access: Read/Write Units: deg
LineDataFilename	A binary file containing line data in latitude-longitude coordinates. The line layer binary file format is documented in the Appendix of the Help File. Specifying a line data file will override the values in the Latitude and Longitude array properties. This property will be cleared if the NumberOfDataPoints property is set.	Type: String Access: Read/Write
LineWidth	The width of the line used to render the layer.	Type: Variable Access: Read/Write Units: pixel
Longitude	An array of longitude coordinates for each data point.	Type: Array Access: Read/Write Units: deg
MaximumRenderDistance	The maximum distance from the viewpoint camera location to the surface of the CelestialObject at which the layer will be rendered.	Type: Variable Access: Read/Write Units: km
MinimumRenderDistance	The minimum distance from the viewpoint camera location to the surface of the CelestialObject at which the layer will be rendered.	Type: Variable Access: Read/Write Units: km
Name	The name displayed for this object in output windows such as views, plots, and reports.	Type: String Access: Read/Write
NumberOfDataPoints	The number of data points to use when specifying the coordinates using the Latitude and Longitude array properties. This property will be set to zero if LineDataFilename is set.	Type: Variable Access: Read/Write
NumberOfLineSegments	The number of line segments represented by the latitude-longitude data.	Type: Variable Access: Read/Write
ObjectId	The unique identifier for the object.	Type: Variable Access: Read-Only
ObjectType	The type of the object.	Type: String Access: Read-Only
SegmentLengths	The length of each segment within the data. The sum of all segment lengths must equal the total number of data points.	Type: Array Access: Read/Write
ShowLayer	Determines whether the layer will be rendered.	Type: Variable Access: Read/Write

Name	Description
ClearSavedStates	Clears previous saved states for this object.
GetFromFile	Load the object state from the specified FreeFlyer object file.
GetFromString	Load the object state from the specified string.
PutToFile	Convert the object state to FreeFlyer object xml and write to a file.
PutToString	Convert the object state to FreeFlyer object xml and return as a string.
ReferenceEquals	Returns 1 if the argument refers to the calling object and 0 otherwise.
Restore	Restore an object's state from a previously saved state.
Save	Save the object's state so that it can be restored later.

GlobeLineLayer Object

Description

Available In Editions:

Timing Precision Mode