Description
The GraphicsOverlayShape object is an element in an array of shapes accessed via the GraphicsOverlay Shapes array property. Each GraphicsOverlayShape can be used to add a line, annotation, point, triangle, triangle strip, or icon to its parent GraphicsOverlay.
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.
Inheritance Hierarchy: ObjectàGraphicsOverlayShape
Available In Editions:
Engineer
Mission
Timing Precision Mode
This page describes functionality in millisecond timing precision mode.
Name
|
Description
|
AnnotationFont
|
The font used to render annotations.
|
Annotations
|
When the shape type is 'Annotations', this array contains the annotations to display.
|
Colors
|
The colors associated with each shape element.
|
DeclaredName
|
The name of the object as declared.
|
IconFilename
|
Specifies an image to draw at each vertex of the shape in the 2d map mode of the Mission View when the shape Type is 'Icons'. Supported image formats include PNG, TIF, JPG, BMP, and GIF.
|
IconReferencePoint
|
Determines which point on the image will be located at the specified vertices when the shape Type is 'Icons'.
|
IconRotation
|
The clockwise rotation of the icon about the ShapeIconReferencePoint when the shape Type is 'Icons'.
|
IconScale
|
A scale, specified in kilometers, determining how large the icon will be drawn on the 2d map when the shape Type is 'Icons'. 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.
|
Name
|
The name displayed for this object in output windows such as views, plots, and reports.
|
NumberOfElements
|
Gets or Sets the number of elements in the shape.
|
ObjectId
|
The unique identifier for the object.
|
ObjectType
|
The type of the object.
|
Opacity
|
The opacity of the shape when drawn in the 2d map mode of the Mission View. This property has no effect for other view modes.
|
Orientation
|
The quaternion orientation of the shape with respect to the body fixed coordinate system of the GraphicsOverlay. The order of shape transformations is Scaling => Rotation => Translation.
|
PointWidth
|
The width of points when the TickType is not specified. When the TickType is specified, the TickWidth property will be used instead.
|
Position
|
The offset position of the shape with respect to the body fixed coordinate system of the GraphicsOverlay. The order of shape transformations is Scaling => Rotation => Translation.
|
Scale
|
The x, y, and z scaling factors of the shape. The order of shape transformations is Scaling => Rotation => Translation.
|
ShowTextBackDrop
|
Determines whether a translucent black rectangle is drawn behind annotations in the 2d map mode of the Mission View for the shape. This options can improve text readability.This property takes precedence over the ViewWindow.DisableLabelBackdrops property.
|
TickType
|
Specifies which tick mark type to draw at each vertex of the shape. Tick marks will be drawn for 'Lines', 'Annotations', 'Points', and 'Icons' shape types only.
|
TickWidth
|
The width of the tick marks.
|
Type
|
The type of shape to draw.
|
Vertices
|
The vertices which define the geometry of the shape.
|
Visible
|
Determines whether the shape is visible.
|
|
Name
|
Description
|
AddElement
|
Adds an element to the shape.
|
ClearElements
|
Clears all elements associated with the shape.
|
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.
|
ResetLineWidth
|
Resets the width used to draw lines for GraphicsOverlay Shapes of type Lines to 1 pixel.
|
Restore
|
Restore an object's state from a previously saved state.
|
Save
|
Save the object's state so that it can be restored later.
|
SetLineWidth
|
Sets the width used to draw lines for GraphicsOverlay Shapes of type Lines.
|
|
Name
|
Description
|
IconFileName
|
Specifies an image to draw at each vertex of the shape in the 2d map mode of the Mission View when the shape Type is 'Icons'. Supported image formats include PNG, TIF, JPG, BMP, and GIF.
This property has been Deprecated. Please use IconFilename instead.
|
|
See also
Graphics Overlays Guide
|
