GraphicsOverlay Object

The GraphicsOverlay object is a collection of shapes that can be drawn in a 2D or 3D Mission View. Each shape can be used to add a line, annotation, point, triangle, triangle strip, or icon to the view. The position of each shape is specified relative to the body-fixed frame of the GraphicsOverlay's ReferenceObject. The properties and methods of the GraphicsOverlay are only available via FreeForm script.

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
AnnotationColors	The colors associated with each annotation in the AnnotationLabels array.	Type: Array Access: Read/Write
AnnotationFont	The font used by annotations in the active shape, determined by CurrentShapeIndex.	Type: ViewFont Access: Read/Write
AnnotationLabels	The text of each annotation in the active shape, determined by CurrentShapeIndex.	Type: StringArray Access: Read/Write
AnnotationLocations	The x, y, and z locations of the specified annotations. These are defined with respect to the body fixed coordinate system of the ReferenceObject before any transformations are applied.	Type: Array Access: Read/Write Units: km
Colors	The colors associated with each vertex in the Vertices array.	Type: Array Access: Read/Write
CurrentShapeIndex	The index of the currently active shape. This determines which shape is affected by the shape properties and methods (Ex. ShapePosition). If the GraphicsOverlay contains no shapes, CurrentShapeIndex will return -1.	Type: Variable Access: Read/Write
DeclaredName	The name of the object as declared.	Type: String Access: Read-Only
DefaultColor	The color used for newly added vertices and annotations when a color is not explicitly specified.	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
NumberOfAnnotations	The number of annotations in the active shape, determined by CurrentShapeIndex.	Type: Variable Access: Read/Write
NumberOfShapes	The number of shapes in the Shapes array.	Type: Variable Access: Read-Only
NumberOfVertices	The number of vertices in the active shape, determined by CurrentShapeIndex.	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
Orientation	The quaternion orientation of the GraphicsOverlay with respect to the body fixed coordinate system of the ReferenceObject. The order of transformations is Scaling => Rotation => Translation.	Type: Array Access: Read/Write
Position	The offset position of the GraphicsOverlay with respect to the body fixed coordinate system of the ReferenceObject. The order of transformations is Scaling => Rotation => Translation.	Type: Array Access: Read/Write Units: km
Scale	The x, y, and z scaling factors of the GraphicsOverlay. The order of transformations is Scaling => Rotation => Translation.	Type: Array Access: Read/Write
ShapeIconFilename	Specifies an image to draw at each vertex of the active shape, determined by CurrentShapeIndex, in the 2d map mode of the Mission View when the ShapeType is 'Icons'. Supported image formats include PNG, TIF, JPG, BMP, and GIF.	Type: String Access: Read/Write
ShapeIconReferencePoint	Determines which point on the image will be located at the specified vertices when the shape Type is 'Icons'.	Type: String Access: Read/Write
ShapeIconRotation	The clockwise rotation of the icon about the ShapeIconReferencePoint when the shape Type is 'Icons'.	Type: Variable Access: Read/Write Units: deg
ShapeIconScale	A scale, specified in kilometers, determining how large the icon will be drawn on the 2d map. The image will be drawn with a height proportional to the specified scale. The width will be automatically selected as to maintain the original aspect ratio of the image. For example, mapping a celestial object with a circumference of 2000 km and an icon scale of 500 km, the image will be drawn at half the height of the entire map when fully zoomed out.	Type: Variable Access: Read/Write Units: km
ShapeOpacity	The opacity of the active shape, determined by CurrentShapeIndex, when drawn in the 2d map mode of the Mission View. This property has no effect for other view modes.	Type: Variable Access: Read/Write
ShapeOrientation	The quaternion orientation of the active shape, determined by CurrentShapeIndex, with respect to the body fixed coordinate system of the GraphicsOverlay. The order of shape transformations is Scaling => Rotation => Translation.	Type: Array Access: Read/Write
ShapePointWidth	The width of the active shape, determined by CurrentShapeIndex, when the current shape is of the 'Points' type.	Type: Variable Access: Read/Write Units: pixel
ShapePosition	The offset position of the active shape, determined by CurrentShapeIndex, with respect to the body fixed coordinate system of the GraphicsOverlay. The order of shape transformations is Scaling => Rotation => Translation.	Type: Array Access: Read/Write Units: km
Shapes	The shapes managed by the GraphicsOverlay.	Type: Array of GraphicsOverlayShape Access: Read/Write
ShapeScale	The x, y, and z scaling factors of the active shape, determined by CurrentShapeIndex. The order of shape transformations is Scaling => Rotation => Translation.	Type: Array Access: Read/Write
ShapeTickType	Specifies which tick mark type to draw at each vertex of the active shape, determined by CurrentShapeIndex. Tick marks will be drawn for 'Lines', 'Annotations', 'Points', and 'Icons' shape types only.	Type: String Access: Read/Write
ShapeTickWidth	The width of the tick marks.	Type: Variable Access: Read/Write
ShapeType	The shape type of the active shape, determined by CurrentShapeIndex.	Type: String Access: Read/Write
ShapeVisible	Determines whether the active shape, determined by CurrentShapeIndex, is visible.	Type: Variable Access: Read/Write
ShowTextBackDrop	Determines whether a translucent black rectangle is drawn behind annotations in the 2d map mode of the Mission View for the active shape, determined by CurrentShapeIndex. This option can improve text readability.This property takes precedence over the ViewWindow.DisableLabelBackdrops property.	Type: Variable Access: Read/Write
Vertices	The x, y, and z components of the vertices that make up the overlay geometry. These are defined with respect to the body fixed coordinate system of the ReferenceObject before any transformations are applied.	Type: Array Access: Read/Write Units: km

Name	Description
AddOverlayElement	Adds an element to the active shape of the GraphicsOverlay.
AddShape	Adds a shape to the GraphicsOverlay and makes it the active shape.
ClearOverlayElements	Clears all elements associated with the active shape of the GraphicsObject overlay.
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.
RemoveShape	Removes the shape at CurrentShapeIndex. If the removed shape is the last shape in the Shapes array, CurrentShapeIndex will be set to the number of remaining shapes - 1.
Restore	Restore an object's state from a previously saved state.
Save	Save the object's state so that it can be restored later.
SetReferenceObject	Takes the objectID corresponding to the CelestialObject, Spacecraft, CoordinateSystem, or Sensor from which the overlay geometry is to be referenced.

GraphicsOverlay Object

Description

Available In Editions:

Timing Precision Mode