GlobeLocationLayer Object

The GlobeLocationLayer object holds information about how location layers like cities are rendered on a CelestialObject's globe. This object is not creatable in script, but an array of GlobeLocationLayers 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 with which names and markers will be drawn.	Type: Variable Access: Read/Write
DeclaredName	The name of the object as declared.	Type: String Access: Read-Only
Font	The font used to render the location names.	Type: ViewFont Access: Read/Write
Label	The label used to identify the layer in the View Output Properties interface.	Type: String Access: Read/Write
LocationLatitude	An array of planetodetic latitude coordinates for each location.	Type: Array Access: Read/Write Units: deg
LocationLongitude	An array of longitude coordinates for each location.	Type: Array Access: Read/Write Units: deg
LocationName	The names associated with each location.	Type: StringArray Access: Read/Write
MarkerSize	The size at which markers will be rendered.	Type: Variable Access: Read/Write Units: pixel
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
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
Name	The name displayed for this object in output windows such as views, plots, and reports.	Type: String Access: Read/Write
NumberOfLocations	The number of locations.	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
ShowLayer	Determines whether the layer will be rendered.	Type: Variable Access: Read/Write
ShowMarkers	Determines whether location markers will be rendered.	Type: Variable Access: Read/Write
ShowNames	Determines whether the location names 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.

GlobeLocationLayer Object

Description

Available In Editions:

Timing Precision Mode