Overlay

java.lang.Object
- agi.foundation.graphics.Overlay

All Implemented Interfaces:

IDisposable, IScreenOverlayContainer, AutoCloseable

Direct Known Subclasses:

ScreenOverlay
```
public abstract class Overlay
extends Object
implements IScreenOverlayContainer, IDisposable
```
A visible element drawn in screen space. Overlays are useful for floating logos, heads up displays, and integrating user interfaces into the 3D window.

Constructor Summary

Constructors
Modifier Constructor and Description

protected Overlay()

Constructors
Modifier	Constructor and Description
`protected`	`Overlay()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`bringToFront()` Brings the overlay to the front of the z-order, so it is on top of all other overlays with the same `Parent`
`ScreenOverlayPoint`	`controlToOverlay(double x, double y)` Transforms a given position, specified relative to the overall `Insight3D` control, into coordinates relative to this overlay.
`void`	`dispose()` Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
`protected void`	`dispose(boolean disposing)`
`Color`	`getBorderColor()` Gets the overlay's border color.
`int`	`getBorderSize()` Gets the size of the overlay's border.
`float`	`getBorderTranslucency()` Gets the translucency of the overlay border.
`BoundingRectangle`	`getBounds()` Gets the bounds of the overlay relative to its parent.
`boolean`	`getClipToParent()` Gets a value indicating whether or not the overlay will be clipped by the `Bounds` of its parent.
`Color`	`getColor()` Gets the overlay's color.
`BoundingRectangle`	`getControlBounds()` Gets the bounds of the overlay in coordinates relative to the overall `Insight3D` control.
`ScreenOverlayPoint`	`getControlPosition()` Gets the position of the overlay in coordinates relative to the overall `Insight3D` control.
`ScreenOverlaySize`	`getControlSize()` Gets the size of the overlay in coordinates relative to the overall `Insight3D` control.
`boolean`	`getDisplay()` Gets if this overlay and the collection of overlays that are contained within this overlay should be rendered.
`DisplayCondition`	`getDisplayCondition()` Gets the display condition that determines if the overlay should be rendered.
`boolean`	`getFlipX()` Gets whether the overlay will be flipped along its X axis.
`boolean`	`getFlipY()` Gets whether the overlay will be flipped along its Y axis.
`double`	`getHeight()` Gets the height of the overlay.
`ScreenOverlayUnit`	`getHeightUnit()` Gets the unit of the `Height` property.
`ScreenOverlaySize`	`getMaximumSize()` Gets the maximum size of the overlay.
`ScreenOverlaySize`	`getMinimumSize()` Gets the minimum size of the overlay.
`ScreenOverlayOrigin`	`getOrigin()` Gets the origin from which the overlay's position is defined.
`ScreenOverlayCollection`	`getOverlays()` Gets the collection of overlays that are contained within this overlay.
`ScreenOverlayPadding`	`getPadding()` Gets the padding surrounding the `Overlays` that are contained within this overlay.
`IScreenOverlayContainer`	`getParent()` Gets the overlay's parent.
`boolean`	`getPickingEnabled()` Gets a value indicating whether or not picking on the overlay is enabled.
`ScreenOverlayPinningOrigin`	`getPinningOrigin()` Gets the origin of the `PinningPosition` property, relative to the overlay.
`ScreenOverlayPoint`	`getPinningPosition()` Gets the pinning position of the overlay, relative to the overlay, which determines the point on the overlay that corresponds to the `Position` property.
`ScreenOverlayPoint`	`getPosition()` Gets the position of the overlay relative to its parent.
`double`	`getRotationAngle()` Gets the counter-clockwise rotation of the overlay, in radians.
`ScreenOverlayRotationPoint`	`getRotationPoint()` Gets the point that the overlay is rotated around when the `RotationAngle` property has a value other than 0.0.
`double`	`getScale()` Gets the fractional value used to scale the overlay's `Size` property.
`ScreenOverlaySize`	`getSize()` Gets the size of the overlay.
`Object`	`getTag()` Gets custom data associated with this screen overlay.
`double`	`getTranslationX()` Gets the value with which the overlay will be translated from the X value of the `Position` property.
`double`	`getTranslationY()` Gets the value with which the overlay will be translated from the Y value of the `Position` property.
`float`	`getTranslucency()` Gets the overlay's translucency.
`double`	`getWidth()` Gets the width of the overlay.
`ScreenOverlayUnit`	`getWidthUnit()` Gets the unit of the `Width` property.
`double`	`getX()` Gets the X position of the overlay relative to its parent.
`ScreenOverlayUnit`	`getXUnit()` Gets the unit of the `X` property.
`double`	`getY()` Gets the Y position of the overlay relative to its parent.
`ScreenOverlayUnit`	`getYUnit()` Gets the unit of the `Y` property.
`ScreenOverlayPoint`	`overlayToControl(double x, double y)` Transforms a given position, specified relative to the overlay, into coordinates relative to the overall `Insight3D` control.
`void`	`sendToBack()` Sends the overlay to the back of the z-order, so it is underneath all other overlays with the same `Parent`
`void`	`setBorderColor(Color color)` Sets the overlay's border color.
`void`	`setBorderSize(int value)` Sets the size of the overlay's border.
`void`	`setBorderTranslucency(float translucency)` Sets the translucency of the overlay border.
`void`	`setClipToParent(boolean value)` Sets a value indicating whether or not the overlay will be clipped by the `Bounds` of its parent.
`void`	`setColor(Color color)` Sets the overlay's color.
`void`	`setDisplay(boolean value)` Sets if this overlay and the collection of overlays that are contained within this overlay should be rendered.
`void`	`setDisplayCondition(DisplayCondition value)` Sets the display condition that determines if the overlay should be rendered.
`void`	`setFlipX(boolean flip)` Sets whether the overlay will be flipped along its X axis.
`void`	`setFlipY(boolean flip)` Sets whether the overlay will be flipped along its Y axis.
`void`	`setHeight(double value)` Sets the height of the overlay.
`void`	`setHeightUnit(ScreenOverlayUnit value)` Sets the unit of the `Height` property.
`void`	`setMaximumSize(ScreenOverlaySize value)` Sets the maximum size of the overlay.
`void`	`setMinimumSize(ScreenOverlaySize value)` Sets the minimum size of the overlay.
`void`	`setOrigin(ScreenOverlayOrigin value)` Sets the origin from which the overlay's position is defined.
`void`	`setPadding(ScreenOverlayPadding value)` Sets the padding surrounding the `Overlays` that are contained within this overlay.
`void`	`setPickingEnabled(boolean value)` Sets a value indicating whether or not picking on the overlay is enabled.
`void`	`setPinningOrigin(ScreenOverlayPinningOrigin value)` Sets the origin of the `PinningPosition` property, relative to the overlay.
`void`	`setPinningPosition(ScreenOverlayPoint value)` Sets the pinning position of the overlay, relative to the overlay, which determines the point on the overlay that corresponds to the `Position` property.
`void`	`setPosition(ScreenOverlayPoint value)` Sets the position of the overlay relative to its parent.
`void`	`setRotationAngle(double value)` Sets the counter-clockwise rotation of the overlay, in radians.
`void`	`setRotationPoint(ScreenOverlayRotationPoint value)` Sets the point that the overlay is rotated around when the `RotationAngle` property has a value other than 0.0.
`void`	`setScale(double value)` Sets the fractional value used to scale the overlay's `Size` property.
`void`	`setSize(ScreenOverlaySize value)` Sets the size of the overlay.
`void`	`setTag(Object inVal)` Sets custom data associated with this screen overlay.
`void`	`setTranslationX(double value)` Sets the value with which the overlay will be translated from the X value of the `Position` property.
`void`	`setTranslationY(double value)` Sets the value with which the overlay will be translated from the Y value of the `Position` property.
`void`	`setTranslucency(float translucency)` Sets the overlay's translucency.
`void`	`setWidth(double value)` Sets the width of the overlay.
`void`	`setWidthUnit(ScreenOverlayUnit value)` Sets the unit of the `Width` property.
`void`	`setX(double value)` Sets the X position of the overlay relative to its parent.
`void`	`setXUnit(ScreenOverlayUnit value)` Sets the unit of the `X` property.
`void`	`setY(double value)` Sets the Y position of the overlay relative to its parent.
`void`	`setYUnit(ScreenOverlayUnit value)` Sets the unit of the `Y` property.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface agi.foundation.compatibility.IDisposable
close

- Constructor Detail
  - Overlay
```
protected Overlay()
```
- Method Detail
  - dispose
```
public final void dispose()
```
    Description copied from interface: IDisposable
    
    Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
    
    Specified by:
    
    dispose in interface IDisposable
  - dispose
```
protected void dispose(boolean disposing)
```
  - getPosition
```
public ScreenOverlayPoint getPosition()
```
    Gets the position of the overlay relative to its parent.
  - setPosition
```
public void setPosition(ScreenOverlayPoint value)
```
    Sets the position of the overlay relative to its parent.
  - getPinningPosition
```
public ScreenOverlayPoint getPinningPosition()
```
    Gets the pinning position of the overlay, relative to the overlay, which determines the point on the overlay that corresponds to the Position property.
    
    See Also:
    
    Screen Overlays topic - Pinning
  - setPinningPosition
```
public void setPinningPosition(ScreenOverlayPoint value)
```
    Sets the pinning position of the overlay, relative to the overlay, which determines the point on the overlay that corresponds to the Position property.
    
    See Also:
    
    Screen Overlays topic - Pinning
  - getX
```
public final double getX()
```
    Gets 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.
  - setX
```
public final void setX(double value)
```
    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.
  - getXUnit
```
public final ScreenOverlayUnit getXUnit()
```
    Gets the unit of the X property.
    
    See Also:
    
    Screen Overlays topic - Units
  - setXUnit
```
public final void setXUnit(ScreenOverlayUnit value)
```
    Sets the unit of the X property.
    
    See Also:
    
    Screen Overlays topic - Units
  - getY
```
public final double getY()
```
    Gets 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.
  - setY
```
public final void setY(double value)
```
    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.
  - getYUnit
```
public final ScreenOverlayUnit getYUnit()
```
    Gets the unit of the Y property.
    
    See Also:
    
    Screen Overlays topic - Units
  - setYUnit
```
public final void setYUnit(ScreenOverlayUnit value)
```
    Sets the unit of the Y property.
    
    See Also:
    
    Screen Overlays topic - Units
  - getSize
```
public ScreenOverlaySize getSize()
```
    Gets the size of the overlay.
  - setSize
```
public void setSize(ScreenOverlaySize value)
```
    Sets the size of the overlay.
  - getWidth
```
public final double getWidth()
```
    Gets the width of the overlay. The unit in which the width is defined is specified by the WidthUnit property.
  - setWidth
```
public final void setWidth(double value)
```
    Sets the width of the overlay. The unit in which the width is defined is specified by the WidthUnit property.
  - getWidthUnit
```
public final ScreenOverlayUnit getWidthUnit()
```
    Gets the unit of the Width property.
    
    See Also:
    
    Screen Overlays topic - Units
  - setWidthUnit
```
public final void setWidthUnit(ScreenOverlayUnit value)
```
    Sets the unit of the Width property.
    
    See Also:
    
    Screen Overlays topic - Units
  - getHeight
```
public final double getHeight()
```
    Gets the height of the overlay. The unit in which the height is defined is specified by the HeightUnit property.
  - setHeight
```
public final void setHeight(double value)
```
    Sets the height of the overlay. The unit in which the height is defined is specified by the HeightUnit property.
  - getHeightUnit
```
public final ScreenOverlayUnit getHeightUnit()
```
    Gets the unit of the Height property.
    
    See Also:
    
    Screen Overlays topic - Units
  - setHeightUnit
```
public final void setHeightUnit(ScreenOverlayUnit value)
```
    Sets the unit of the Height property.
    
    See Also:
    
    Screen Overlays topic - Units
  - getMinimumSize
```
public ScreenOverlaySize getMinimumSize()
```
    Gets 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.
  - setMinimumSize
```
public void setMinimumSize(ScreenOverlaySize value)
```
    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.
  - getMaximumSize
```
public ScreenOverlaySize getMaximumSize()
```
    Gets 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.
  - setMaximumSize
```
public void setMaximumSize(ScreenOverlaySize value)
```
    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.
  - getBounds
```
public BoundingRectangle getBounds()
```
    Gets the bounds of the overlay relative to its parent.
  - getBorderColor
```
public Color getBorderColor()
```
    Gets the overlay's border color. By default, the border color is Color.WHITE. However, also by default, the overlay has a BorderSize of 0.0 so the border is not displayed.
    
    See Also:
    
    Screen Overlays topic - Borders
  - setBorderColor
```
public void setBorderColor(Color color)
```
    Sets the overlay's border color. By default, the border color is Color.WHITE. However, also by default, the overlay has a BorderSize of 0.0 so the border is not displayed.
    
    See Also:
    
    Screen Overlays topic - Borders
  - getBorderSize
```
public int getBorderSize()
```
    Gets the size of the overlay's border. By default, this is 0.0 so the border is not displayed.
    
    See Also:
    
    Screen Overlays topic - Borders
  - setBorderSize
```
public void setBorderSize(int value)
```
    Sets the size of the overlay's border. By default, this is 0.0 so the border is not displayed.
    
    See Also:
    
    Screen Overlays topic - Borders
  - getBorderTranslucency
```
public float getBorderTranslucency()
```
    Gets 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.
    
    See Also:
    
    Screen Overlays topic - Borders
  - setBorderTranslucency
```
public void setBorderTranslucency(float translucency)
```
    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.
    
    See Also:
    
    Screen Overlays topic - Borders
  - getTranslationX
```
public double getTranslationX()
```
    Gets the value with which the overlay will be translated from the X value of the Position property.
    
    See Also:
    
    Screen Overlays topic - Transformations
  - setTranslationX
```
public void setTranslationX(double value)
```
    Sets the value with which the overlay will be translated from the X value of the Position property.
    
    See Also:
    
    Screen Overlays topic - Transformations
  - getTranslationY
```
public double getTranslationY()
```
    Gets the value with which the overlay will be translated from the Y value of the Position property.
    
    See Also:
    
    Screen Overlays topic - Transformations
  - setTranslationY
```
public void setTranslationY(double value)
```
    Sets the value with which the overlay will be translated from the Y value of the Position property.
    
    See Also:
    
    Screen Overlays topic - Transformations
  - getRotationAngle
```
public double getRotationAngle()
```
    Gets the counter-clockwise rotation of the overlay, in radians. The overlay is rotated around the point specified by the RotationPoint property.
    
    See Also:
    
    Screen Overlays topic - Transformations
  - setRotationAngle
```
public void setRotationAngle(double value)
```
    Sets the counter-clockwise rotation of the overlay, in radians. The overlay is rotated around the point specified by the RotationPoint property.
    
    See Also:
    
    Screen Overlays topic - Transformations
  - getRotationPoint
```
public ScreenOverlayRotationPoint getRotationPoint()
```
    Gets the point that the overlay is rotated around when the RotationAngle property has a value other than 0.0.
    
    See Also:
    
    Screen Overlays topic - Transformations
  - setRotationPoint
```
public void setRotationPoint(ScreenOverlayRotationPoint value)
```
    Sets the point that the overlay is rotated around when the RotationAngle property has a value other than 0.0.
    
    See Also:
    
    Screen Overlays topic - Transformations
  - getScale
```
public double getScale()
```
    Gets 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.
    
    See Also:
    
    Screen Overlays topic - Transformations
  - setScale
```
public void setScale(double value)
```
    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.
    
    See Also:
    
    Screen Overlays topic - Transformations
  - getFlipX
```
public boolean getFlipX()
```
    Gets whether the overlay will be flipped along its X axis.
    
    See Also:
    
    Screen Overlays topic - Transformations
  - setFlipX
```
public void setFlipX(boolean flip)
```
    Sets whether the overlay will be flipped along its X axis.
    
    See Also:
    
    Screen Overlays topic - Transformations
  - getFlipY
```
public boolean getFlipY()
```
    Gets whether the overlay will be flipped along its Y axis.
    
    See Also:
    
    Screen Overlays topic - Transformations
  - setFlipY
```
public void setFlipY(boolean flip)
```
    Sets whether the overlay will be flipped along its Y axis.
    
    See Also:
    
    Screen Overlays topic - Transformations
  - getOrigin
```
public ScreenOverlayOrigin getOrigin()
```
    Gets 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.
    
    See Also:
    
    Screen Overlays topic - Origin
  - setOrigin
```
public void setOrigin(ScreenOverlayOrigin value)
```
    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.
    
    See Also:
    
    Screen Overlays topic - Origin
  - getPinningOrigin
```
public ScreenOverlayPinningOrigin getPinningOrigin()
```
    Gets 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.
    
    See Also:
    
    Screen Overlays topic - Pinning
  - setPinningOrigin
```
public void setPinningOrigin(ScreenOverlayPinningOrigin value)
```
    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.
    
    See Also:
    
    Screen Overlays topic - Pinning
  - getParent
```
public IScreenOverlayContainer getParent()
```
    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's ScreenOverlays (get) collection.
    
    See Also:
    
    Screen Overlays topic - Nesting Overlays
  - getTranslucency
```
public float getTranslucency()
```
    Gets 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.
  - setTranslucency
```
public void setTranslucency(float translucency)
```
    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.
  - getColor
```
public Color getColor()
```
    Gets the overlay's color. By default, the overlay is Color.WHITE.
  - setColor
```
public void setColor(Color color)
```
    Sets the overlay's color. By default, the overlay is Color.WHITE.
  - getPickingEnabled
```
public boolean getPickingEnabled()
```
    Gets 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.
    
    See Also:
    
    Screen Overlays topic - Picking
  - setPickingEnabled
```
public void setPickingEnabled(boolean value)
```
    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.
    
    See Also:
    
    Screen Overlays topic - Picking
  - getClipToParent
```
public boolean getClipToParent()
```
    Gets 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.
    
    See Also:
    
    Screen Overlays topic - Nesting Overlays
  - setClipToParent
```
public void setClipToParent(boolean value)
```
    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.
    
    See Also:
    
    Screen Overlays topic - Nesting Overlays
  - getDisplay
```
public boolean getDisplay()
```
    Gets if this overlay and the collection of overlays that are contained within this overlay should be rendered.
    A overlay must be added to the ScreenOverlayManager before it is rendered. Once in the manager, setting this property to false is more efficient than removing the overlay from the manager. Although, it is recommended to remove the overlay from the manager if the overlay will be hidden for a long period of time.
    
    Specified by:
    
    getDisplay in interface IScreenOverlayContainer
    
    See Also:
    
    ScreenOverlayManager
  - setDisplay
```
public void setDisplay(boolean value)
```
    Sets if this overlay and the collection of overlays that are contained within this overlay should be rendered.
    A overlay must be added to the ScreenOverlayManager before it is rendered. Once in the manager, setting this property to false is more efficient than removing the overlay from the manager. Although, it is recommended to remove the overlay from the manager if the overlay will be hidden for a long period of time.
    
    Specified by:
    
    setDisplay in interface IScreenOverlayContainer
    
    See Also:
    
    ScreenOverlayManager
  - getControlPosition
```
public ScreenOverlayPoint getControlPosition()
```
    Gets the position of the overlay in coordinates relative to the overall Insight3D control.
    
    See Also:
    
    Screen Overlays topic - Control Coordinates
  - getControlSize
```
public ScreenOverlaySize getControlSize()
```
    Gets the size of the overlay in coordinates relative to the overall Insight3D control.
    
    See Also:
    
    Screen Overlays topic - Control Coordinates
  - getControlBounds
```
public BoundingRectangle getControlBounds()
```
    Gets the bounds of the overlay in coordinates relative to the overall Insight3D control.
    
    See Also:
    
    Screen Overlays topic - Control Coordinates
  - getDisplayCondition
```
public DisplayCondition getDisplayCondition()
```
    Gets 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.
    When DisplayCondition is null, no display condition is evaluated before the overlay is rendered.
    
    See Also:
    
    Display Conditions topic, DisplayCondition, Display
  - setDisplayCondition
```
public void setDisplayCondition(DisplayCondition value)
```
    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.
    When DisplayCondition is null, no display condition is evaluated before the overlay is rendered.
    
    See Also:
    
    Display Conditions topic, DisplayCondition, Display
  - getTag
```
public final Object getTag()
```
    Gets custom data associated with this screen overlay.
    This property is commonly used in conjunction with picking. Custom data that needs to be retrieved or modified when this screen overlay is picked is assigned to this property. When the screen overlay is picked, this property is used to access the custom data.
    
    See Also:
    
    Picking topic
  - setTag
```
public final void setTag(Object inVal)
```
    Sets custom data associated with this screen overlay.
    This property is commonly used in conjunction with picking. Custom data that needs to be retrieved or modified when this screen overlay is picked is assigned to this property. When the screen overlay is picked, this property is used to access the custom data.
    
    See Also:
    
    Picking topic
  - getOverlays
```
public ScreenOverlayCollection getOverlays()
```
    Gets the collection of overlays that are contained within this overlay.
    
    Specified by:
    
    getOverlays in interface IScreenOverlayContainer
    
    See Also:
    
    Screen Overlays topic - Nesting Overlays
  - getPadding
```
public ScreenOverlayPadding getPadding()
```
    Gets the padding surrounding the Overlays that are contained within this overlay.
    
    Specified by:
    
    getPadding in interface IScreenOverlayContainer
    
    See Also:
    
    Screen Overlays topic - Nesting Overlays
  - setPadding
```
public void setPadding(ScreenOverlayPadding value)
```
    Sets the padding surrounding the Overlays that are contained within this overlay.
    
    Specified by:
    
    setPadding in interface IScreenOverlayContainer
    
    See Also:
    
    Screen Overlays topic - Nesting Overlays
  - bringToFront
```
public void bringToFront()
```
    Brings the overlay to the front of the z-order, so it is on top of all other overlays with the same Parent
    
    See Also:
    
    Screen Overlays topic - Z-Order
  - sendToBack
```
public void sendToBack()
```
    Sends the overlay to the back of the z-order, so it is underneath all other overlays with the same Parent
    
    See Also:
    
    Screen Overlays topic - Z-Order
  - overlayToControl
```
public ScreenOverlayPoint overlayToControl(double x,
                                           double y)
```
    Transforms a given position, specified relative to the overlay, into coordinates relative to the overall Insight3D control.
    
    Parameters:
    
    x - The horizontal position to transform.
    
    y - The vertical position to transform.
    
    Returns:
    
    The position relative to the overall control.
    
    See Also:
    
    Screen Overlays topic - Control Coordinates
  - controlToOverlay
```
public ScreenOverlayPoint controlToOverlay(double x,
                                           double y)
```
    Transforms a given position, specified relative to the overall Insight3D control, into coordinates relative to this overlay.
    
    Parameters:
    
    x - The horizontal position to transform.
    
    y - The vertical position to transform.
    
    Returns:
    
    The position relative to this overlay.
    
    See Also:
    
    Screen Overlays topic - Control Coordinates

Class Overlay

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface agi.foundation.compatibility.IDisposable

Constructor Detail

Method Detail

dispose

dispose

getPosition

setPosition

getPinningPosition

setPinningPosition

getX

setX

getXUnit

setXUnit

getY

setY

getYUnit

setYUnit

getSize

setSize

getWidth

setWidth

getWidthUnit

setWidthUnit

getHeight

setHeight

getHeightUnit

setHeightUnit

getMinimumSize

setMinimumSize

getMaximumSize

setMaximumSize

getBounds

getBorderColor

setBorderColor

getBorderSize

setBorderSize

getBorderTranslucency

setBorderTranslucency

getTranslationX

setTranslationX

getTranslationY

setTranslationY

getRotationAngle

setRotationAngle

getRotationPoint

setRotationPoint

getScale

setScale

getFlipX

setFlipX

getFlipY

setFlipY

getOrigin

setOrigin

getPinningOrigin

setPinningOrigin

getParent

getTranslucency

setTranslucency

getColor

setColor

getPickingEnabled

setPickingEnabled

getClipToParent

setClipToParent

getDisplay

setDisplay

getControlPosition

getControlSize

getControlBounds

getDisplayCondition

setDisplayCondition

getTag

setTag

getOverlays