Class PolygonAnnotator

    • Field Detail

      • m_Color

        protected Color m_Color
        the color to use.
      • m_StrokeThickness

        protected float m_StrokeThickness
        the thickness of the stroke.
      • m_MinDistance

        protected int m_MinDistance
        the minimum distance in pixels that the trace pixels must be apart.
      • m_LabelSuffix

        protected String m_LabelSuffix
        the label suffix to use.
      • m_Dragged

        protected boolean m_Dragged
        whether dragging has happened at all.
      • m_SelectionFrom

        protected Point m_SelectionFrom
        the starting corner of the selection box.
      • m_SelectionTo

        protected Point m_SelectionTo
        the finishing corner of the selection box.
      • m_SelectionTrace

        protected List<Point> m_SelectionTrace
        the selection trace.
      • m_MouseListener

        protected MouseListener m_MouseListener
        the mouse listener to install.
      • m_MouseMotionListener

        protected MouseMotionListener m_MouseMotionListener
        the mouse motion listener to install.
    • Constructor Detail

      • PolygonAnnotator

        public PolygonAnnotator()
    • Method Detail

      • setColor

        public void setColor​(Color value)
        Sets the color to use.
        Parameters:
        value - the color
      • getColor

        public Color getColor()
        Returns the color to use.
        Returns:
        the color
      • colorTipText

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

        public void setStrokeThickness​(float value)
        Sets the stroke thickness to use.
        Parameters:
        value - the thickness
      • getStrokeThickness

        public float getStrokeThickness()
        Returns the current stroke thickness.
        Returns:
        the thickness
      • strokeThicknessTipText

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

        public void setMinDistance​(int value)
        Sets the minimum distance in pixels that a new point must be away from the last trace point.
        Parameters:
        value - the distance
      • getMinDistance

        public int getMinDistance()
        Returns the minimum distance in pixels that a new point must be away from the last trace point.
        Returns:
        the distance
      • minDistanceTipText

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

        protected String getDefaultLabelSuffix()
        Returns the default suffix to use for the label.
        Returns:
        the default
      • setLabelSuffix

        public void setLabelSuffix​(String value)
        Sets the suffix to use for the label.
        Specified by:
        setLabelSuffix in interface LabelSuffixHandler
        Parameters:
        value - the suffix
      • labelSuffixTipText

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

        protected MouseListener createMouseListener()
        Creates the listener for mouse events.
        Returns:
        the instance
      • createMouseMotionListener

        protected MouseMotionListener createMouseMotionListener()
        Creates the listener for mouse motion events.
        Returns:
        the instance
      • canAddTracePoint

        public boolean canAddTracePoint​(Point p)
        Returns whether the current point is at least the specified distance away from the last one.
        Parameters:
        p - the point to check
        Returns:
        true if can be added
      • traceToPolygon

        public Polygon traceToPolygon()
        Turns the trace into a polygon.
        Returns:
        the polygon, null if unable to convert (eg empty trace)
      • processSelection

        protected void processSelection​(int modifiersEx)
        Processes the selection.
        Parameters:
        modifiersEx - the associated modifiers
      • doInstall

        protected void doInstall()
        Installs the annotator with the owner.
        Specified by:
        doInstall in class AbstractAnnotator
      • doUninstall

        protected void doUninstall()
        Uninstalls the annotator with the owner.
        Specified by:
        doUninstall in class AbstractAnnotator