ScreenOverlay Class |
A visible element drawn in screen space. Overlays are useful for floating logos, heads up displays, and
integrating user interfaces into the 3D window.
Inheritance HierarchySystemObject
AGI.Foundation.GraphicsOverlay
AGI.Foundation.GraphicsScreenOverlay
AGI.Foundation.GraphicsTextureScreenOverlay
AGI.Foundation.GraphicsOverlay
AGI.Foundation.GraphicsScreenOverlay
AGI.Foundation.GraphicsTextureScreenOverlay
Namespace: AGI.Foundation.Graphics
Assembly: AGI.Foundation.Graphics (in AGI.Foundation.Graphics.dll) Version: 24.2.419.0 (24.2.419.0)
SyntaxThe ScreenOverlay type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | ScreenOverlay(ScreenOverlayPoint, ScreenOverlaySize) |
Initializes the overlay with the specified position and size.
|
| ScreenOverlay(Double, Double, Double, Double) |
Initializes the overlay with the specified x position, y position, width, and height, all specified in pixels.
|
Properties| Name | Description | |
|---|---|---|
 | BorderColor |
Gets or sets the overlay's border color. By default, the border color is White. However, also
by default, the overlay has a BorderSize of 0.0 so the border is not displayed.
(Inherited from Overlay.) |
| BorderSize |
Gets or sets the size of the overlay's border. By default, this is 0.0 so the border is not displayed.
(Inherited from Overlay.) |
| 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.
(Inherited from Overlay.) |
| Bounds |
Gets the bounds of the overlay relative to its parent.
(Inherited from Overlay.) |
| 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 , part of this overlay may be visible outside of its parent's bounds.
(Inherited from Overlay.) |
| Color |
Gets or sets the overlay's color. By default, the overlay is White.
(Inherited from Overlay.) |
| ControlBounds |
Gets the bounds of the overlay in coordinates relative to the overall Insight3D
control.
(Inherited from Overlay.) |
| ControlPosition |
Gets the position of the overlay in coordinates relative to the overall
Insight3D control.
(Inherited from Overlay.) |
| ControlSize |
Gets the size of the overlay in coordinates relative to the overall Insight3D
control.
(Inherited from Overlay.) |
| Display |
Gets or sets if this overlay and the collection of overlays that are contained within this overlay should be
rendered.
(Inherited from Overlay.) |
| 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.
(Inherited from Overlay.) |
| FlipX |
Gets or sets whether the overlay will be flipped along its X axis.
(Inherited from Overlay.) |
| FlipY |
Gets or sets whether the overlay will be flipped along its Y axis.
(Inherited from Overlay.) |
| Height |
Gets or sets the height of the overlay. The unit in which the height
is defined is specified by the HeightUnit property.
(Inherited from Overlay.) |
| HeightUnit |
Gets or sets the unit of the Height property.
(Inherited from Overlay.) |
| 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.
(Inherited from Overlay.) |
| 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.
(Inherited from Overlay.) |
| 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 ScreenOverlayOrigin 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.
(Inherited from Overlay.) |
| Overlays |
Gets the collection of overlays that are contained within this overlay.
(Inherited from Overlay.) |
| Padding |
Gets or sets the padding surrounding the Overlays that are contained within this overlay.
(Inherited from Overlay.) |
| 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 ScreenOverlayManager if this
overlay was added to the SceneManager'sScreenOverlays collection.
(Inherited from Overlay.) |
| 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.
(Inherited from Overlay.) |
| PinningOrigin |
Gets or sets the origin of the PinningPosition property, relative to the overlay. By default, the value of this property
is ScreenOverlayPinningOrigin.Automatic, which
indicates that the origin of the PinningPosition property is the same as the Origin property of
the screen overlay. See ScreenOverlayPinningOrigin 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.
(Inherited from Overlay.) |
| 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.
(Inherited from Overlay.) |
| Position |
Gets or sets the position of the overlay relative to its parent.
(Inherited from Overlay.) |
| RotationAngle |
Gets or sets the counter-clockwise rotation of the overlay, in radians. The overlay is rotated around the point
specified by the RotationPoint property.
(Inherited from Overlay.) |
| RotationPoint |
Gets or sets the point that the overlay is rotated around when the RotationAngle property has a
value other than 0.0.
(Inherited from Overlay.) |
| 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.
(Inherited from Overlay.) |
| Size |
Gets or sets the size of the overlay.
(Inherited from Overlay.) |
| Tag |
Gets or sets custom data associated with this screen overlay.
(Inherited from Overlay.) |
| TranslationX |
Gets or sets the value with which the overlay will be translated from the X value of the
Position property.
(Inherited from Overlay.) |
| TranslationY |
Gets or sets the value with which the overlay will be translated from the Y value of the
Position property.
(Inherited from Overlay.) |
| 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.
(Inherited from Overlay.) |
| Width |
Gets or sets the width of the overlay. The unit in which the width
is defined is specified by the WidthUnit property.
(Inherited from Overlay.) |
| WidthUnit |
Gets or sets the unit of the Width property.
(Inherited from Overlay.) |
| 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 XUnit property. The position is measured horizontally
from the Origin, which is, by default, the lower-left corner.
(Inherited from Overlay.) |
| XUnit |
Gets or sets the unit of the X property.
(Inherited from Overlay.) |
| 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 YUnit property. The position is measured vertically
from the Origin, which is, by default, the lower-left corner.
(Inherited from Overlay.) |
| YUnit |
Gets or sets the unit of the Y property.
(Inherited from Overlay.) |
Methods| Name | Description | |
|---|---|---|
| BringToFront |
Brings the overlay to the front of the z-order, so it is on top of all other overlays with the same
Parent (Inherited from Overlay.) |
| ControlToOverlay |
Transforms a given position, specified relative to the overall Insight3D
control, into coordinates relative to this overlay.
(Inherited from Overlay.) |
| Dispose | (Inherited from Overlay.) |
 | Dispose(Boolean) | (Overrides OverlayDispose(Boolean).) |
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
| Finalize | (Overrides ObjectFinalize.) |
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| OverlayToControl |
Transforms a given position, specified relative to the overlay, into coordinates relative to the overall
Insight3D control.
(Inherited from Overlay.) |
| SendToBack |
Sends the overlay to the back of the z-order, so it is underneath all other overlays with the same
Parent (Inherited from Overlay.) |
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
See Also