Class Image

  • All Implemented Interfaces:
    Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, QuickInfoSupporter, SizeOfHandler, Serializable

    public class Image
    extends AbstractDrawOperation
    Draws the image obtained from a callable actor at the specified location.

    -logging-level <OFF|SEVERE|WARNING|INFO|CONFIG|FINE|FINER|FINEST> (property: loggingLevel)
        The logging level for outputting errors and debugging output.
        default: WARNING
        min-user-mode: Expert
     
    -x <int> (property: X)
        The X position of the top-left corner of the image (1-based).
        default: 1
        minimum: 1
     
    -y <int> (property: Y)
        The Y position of the top-left corner of the image (1-based).
        default: 1
        minimum: 1
     
    -image-actor <adams.flow.core.CallableActorReference> (property: imageActor)
        The callable actor to use for obtaining the image from.
        default:
     
    -alpha <int> (property: alpha)
        The alpha value to use for the overlay: 0=transparent, 255=opaque.
        default: 255
        minimum: 0
        maximum: 255
     
    Author:
    fracpete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form
    • Field Detail

      • m_X

        protected int m_X
        the X position of the image (1-based).
      • m_Y

        protected int m_Y
        the Y position of the image (1-based).
      • m_Alpha

        protected int m_Alpha
        the alpha value to use for the overlay (0: transparent, 255: opaque).
    • Constructor Detail

      • Image

        public Image()
    • Method Detail

      • setX

        public void setX​(int value)
        Sets the X position of the image (top-left corner).
        Parameters:
        value - the position, 1-based
      • getX

        public int getX()
        Returns the X position of the image (top-left corner).
        Returns:
        the position, 1-based
      • XTipText

        public String XTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.
      • setY

        public void setY​(int value)
        Sets the Y position of the image (top-left corner).
        Parameters:
        value - the position, 1-based
      • getY

        public int getY()
        Returns the Y position of the image (top-left corner).
        Returns:
        the position, 1-based
      • YTipText

        public String YTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.
      • setImageActor

        public void setImageActor​(CallableActorReference value)
        Sets the callable actor to obtain the image from.
        Parameters:
        value - the actor reference
      • getImageActor

        public CallableActorReference getImageActor()
        Returns the callable actor to obtain the image from.
        Returns:
        the actor reference
      • imageActorTipText

        public String imageActorTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.
      • setAlpha

        public void setAlpha​(int value)
        Sets the alpha value to use for the overlay: 0=transparent, 255=opaque.
        Parameters:
        value - the alphae value
      • getAlpha

        public int getAlpha()
        Returns the alpha value to use for the overlay: 0=transparent, 255=opaque.
        Returns:
        the alpha value
      • alphaTipText

        public String alphaTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the gui