AGI STK Graphics 11 Send comments on this topic.
IAgStkGraphicsOverlay Interface

Description

A visible element drawn in screen space. Overlays are useful for floating logos, heads up displays, and integrating user interfaces into the 3D window.

Object Model




Public Methods

Public Method BringToFront Brings the overlay to the front of the z-order, so it is on top of all other overlays with the same Parent
Public Method ControlToOverlay Transforms a given position, specified relative to the overall globe control, into coordinates relative to this overlay. Returns an array with a size of 4 and the elements are in the order x position, y position, x Screen Overlay Unit, y Screen Overlay Unit.
Public Method OverlayToControl Transforms a given position, specified relative to the overlay, into coordinates relative to the overall globe control. Returns an array with a size of 4 and the elements are in the order x position, y position, x Screen Overlay Unit, y Screen Overlay Unit.
Public Method SendToBack Sends the overlay to the back of the z-order, so it is underneath all other overlays with the same Parent

Public Properties

Public Property BorderColor Gets or sets the overlay's border color. By default, the border color is White. However, also by default, the overlay has a Border Size of 0.0 so the border is not displayed.
Public Property BorderSize Gets or sets the size of the overlay's border. By default, this is 0.0 so the border is not displayed.
Public Property BorderTranslucency Gets or sets the translucency of the overlay border. Translucency is a value between 0.0 and 1.0, where 0.0 is completely opaque and 1.0 is completely transparent.
Public Property Bounds Gets the bounds of the overlay relative to its parent. The array contains the properties defining the bounds in the order left x location, top y location, width, height.
Public Property ClipToParent Gets or sets a value indicating whether or not the overlay will be clipped by the Bounds of its parent. If this property is false, part of this overlay may be visible outside of its parent's bounds.
Public Property Color Gets or sets the overlay's color. By default, the overlay is White.
Public Property ControlBounds Gets the bounds of the overlay in coordinates relative to the overall globe control. The array contains the properties defining the bounds in the order left x location, top y location, width, height.
Public Property ControlPosition Gets the position of the overlay in coordinates relative to the overall globe control. The array represents the position of the overlay and has a size of 4. The elements are in the order x position, y position, x Screen Overlay Unit, y Screen Overlay Unit.
Public Property ControlSize Gets the size of the overlay in coordinates relative to the overall globe control. The elements are in the order width, height, width Screen Overlay Unit, height Screen Overlay Unit.
Public Property Display Gets or sets if this overlay and the collection of overlays that are contained within this overlay should be rendered.
Public Property DisplayCondition Gets or sets the display condition that determines if the overlay should be rendered. Both this and Display must evaulate to true for the overlay to be rendered.
Public Property FlipX Gets or sets whether the overlay will be flipped along its X axis.
Public Property FlipY Gets or sets whether the overlay will be flipped along its Y axis.
Public Property Height Gets or sets the height of the overlay. The unit in which the height is defined is specified by the Height Unit property.
Public Property HeightUnit Gets or sets the unit of the Height property.
Public Property MaximumSize Gets or sets the maximum size of the overlay. The overlay will never be larger than this size, even if the overlay's Size is specified as a percentage of its parent and its parent is very large. It will also not become larger than this size as a result of a Scale transformation. The array elements represent the size of the overlay in the order width, height, width Screen Overlay Unit, height Screen Overlay Unit.
Public Property MinimumSize Gets or sets the minimum size of the overlay. The overlay will never be smaller than this size, even if the overlay's Size is specified as a percentage of its parent and its parent is very small. It will also not become smaller than this size as a result of a Scale transformation. The array elements represent the size of the overlay in the order width, height, width Screen Overlay Unit, height Screen Overlay Unit.
Public Property Origin Gets or sets the origin from which the overlay's position is defined. By default, the value of this property is ScreenOverlayOrigin.BottomLeft. See Screen Overlay Origin for a list of the possible origins and a description of how the origin affects the measurement of the overlay's position and size properties.
Public Property Overlays Gets the collection of overlays that are contained within this overlay.
Public Property Padding Gets or sets the padding surrounding the Overlays that are contained within this overlay. The array contains the components of the padding arranged in the order left, top, right, bottom.
Public Property Parent Gets the overlay's parent. This may be another overlay if this overlay was added to that overlay's Overlays collection. Or, it may be the Screen Overlay Manager if this overlay was added to the SceneManager's Screen Overlays collection.
Public Property PickingEnabled Gets or sets a value indicating whether or not picking on the overlay is enabled. If picking is disabled, this overlay will never show up in the result of Scene.PickScreenOverlay, even if it occupies the specified pick position.
Public Property PinningOrigin Gets or sets the origin of the Pinning Position property, relative to the overlay. By default, the value of this property is ScreenOverlayPinningOrigin.Automatic, which indicates that the origin of the Pinning Position property is the same as the Origin property of the screen overlay. See Screen Overlay Pinning Origin for a list of the possible pinning origins and a description of how the pinning origin affects the measurement of the overlay's position property.
Public Property PinningPosition Gets or sets the pinning position of the overlay, relative to the overlay, which determines the point on the overlay that corresponds to the Position property. The array represents the pinning position of the overlay and has a size of 4. The elements are in the order x position, y position, x Screen Overlay Unit, y Screen Overlay Unit.
Public Property Position Gets or sets the position of the overlay relative to its parent. The array represents the position of the overlay and has a size of 4. The elements are in the order x position, y position, x Screen Overlay Unit, y Screen Overlay Unit.
Public Property RotationAngle Gets or sets the counter-clockwise rotation of the overlay, in radians. The overlay is rotated around the point specified by the Rotation Point property.
Public Property RotationPoint Gets or sets the point that the overlay is rotated around when the Rotation Angle property has a value other than 0.0. The array contains seven elements defining the properties of the rotation point. The elements are ordered as follows: UseOriginAsPoint (Boolean), Screen Overlay Origin, RelativeToParent (Boolean), x position, y position, x Screen Overlay Unit, y Screen Overlay Unit.
Public Property Scale Gets or sets the fractional value used to scale the overlay's Size property. A value greater than 1.0 will make the overlay larger while a value less than 1.0 will make it smaller.
Public Property Size Gets or sets the size of the overlay. The array elements represent the size of the overlay in the order width, height, width Screen Overlay Unit, height Screen Overlay Unit.
Public Property Tag Gets or sets custom value associated with this primitive.
Public Property TranslationX Gets or sets the value with which the overlay will be translated from the X value of the Position property.
Public Property TranslationY Gets or sets the value with which the overlay will be translated from the Y value of the Position property.
Public Property Translucency Gets or sets the overlay's translucency. Translucency is a value between 0.0 and 1.0, where 0.0 is completely opaque and 1.0 is completely transparent.
Public Property Width Gets or sets the width of the overlay. The unit in which the width is defined is specified by the Width Unit property.
Public Property WidthUnit Gets or sets the unit of the Width property.
Public Property X Gets or sets the X position of the overlay relative to its parent. The unit in which the position is defined is specified by the X Unit property. The position is measured horizontally from the Origin, which is, by default, the lower-left corner.
Public Property XUnit Gets or sets the unit of the X property.
Public Property Y Gets or sets the Y position of the overlay relative to its parent. The unit in which the position is defined is specified by the Y Unit property. The position is measured vertically from the Origin, which is, by default, the lower-left corner.
Public Property YUnit Gets or sets the unit of the Y property.

CoClasses that Implement IAgStkGraphicsOverlay

© 2016 All Rights Reserved.

STK Programming Interface 11.0.1