Class ConnectingLine2D

All Implemented Interfaces:
Graph.Graphic, NamedObjectOps

public class ConnectingLine2D extends AnimationObject2D
Create a line whose end points may vary with time. A functional interface, DoubleSupplier, makes it possible to use lambda expressions or method references to determine the line's end points. Two path parameters can be set so that only a portion of this line is visible.

One use of this class is to be able to visually determine if some feature lies between two designated points whose position changes with time.

  • Constructor Details

  • Method Details

    • configure

      public ConnectingLine2D configure(DoubleSupplier getX1, DoubleSupplier getY1, DoubleSupplier getX2, DoubleSupplier getY2)
      Configure the line's end points.
      Parameters:
      getX1 - the supplier that provides the X coordinate of the first end point.
      getY1 - the supplier that provides the Y coordinate of the first end point.
      getX2 - the supplier that provides the X coordinate of the second end point.
      getY2 - the supplier that provides the Y coordinate of the second end point.
      Returns:
      this object
    • configure

      public ConnectingLine2D configure(double u1, double u2)
      Configure path parameters for a line's end points. If getX1, getY1, getX2, and getY2 are the suppliers passed to configure(DoubleSupplier,DoubleSupplier,DoubleSupplier,DoubleSupplier), if P1 is the point whose coordinates are provided by getX1 and getY1, and if P2 is the point whose coordinates are provided by getX2 and getY2, then a point P(u) on the line is given by P(u) = P1(1-u) + P2u for u ∈ [0, 1].
      Parameters:
      u1 - is the parameter u ∈ [0, 1] for the first end of the line
      u2 - is the parameter u ∈ [0, 1] for the second end of the line
      Returns:
      this object
    • setColor

      public void setColor(Color color)
      Set the color for a line drawing this path when addTo is called.
      Parameters:
      color - the color
    • getColor

      public Color getColor()
      Get the color for a line drawing this path when addTo is called.
      Returns:
      the color
    • setStroke

      public void setStroke(Stroke stroke)
      Set the stroke for a line drawing this path when addTo is called.
      Parameters:
      stroke - the stroke
    • getStroke

      public Stroke getStroke()
      Get the stroke for a line drawing this path when addTo is called.
      Returns:
      the stroke
    • setGcsMode

      public void setGcsMode(boolean gcsMode)
      Set GCS mode. When GCS mode is set the stroke's width and dash array are interpreted in graph coordinate space units; otherwise in user-space units (the default).
      Parameters:
      gcsMode - true if the stroke's units are in graph coordinate space units; false if they are in user space units.
    • getGcsMode

      public boolean getGcsMode()
      Get GCS mode. When GCS mode is set the stroke's width and dash array are interpreted in graph coordinate space units; otherwise in user-space units.
      Returns:
      true if in graph-coordinate-space mode; false if in user-space mode
    • addTo

      public void addTo(Graph graph, Graphics2D g2d, Graphics2D g2dgcs)
      Description copied from interface: Graph.Graphic
      Add this object to a graph. The drawing operation is assumed to be a complex one that might involve fills, etc.

      Any modifications to g2d or g2dGCS made by an implementation of this method should be undone before this method returns. For classes provided by the org.bzdev.anim2d package, such modifications must be undone before this method returns.

      Two graphics contexts are provided as arguments. g2d will typically be used as the first argument to the graph's draw or fill methods. In this case, the shape of an object is described in graph coordinate space but the widths of strokes drawn by fill operations, gradient paint, etc., have user-space units. The result is that line widths as they appear in an image are not sensitive to the mapping from graph coordinate space to user space. One should use the draw and fill methods specified by Graph, using g2d as their first argument. By contrast, if a line width, etc., should be in graph-coordinate space units, one can use the g2dGCS argument directly. This will rarely be done when plotting a graph but is useful in animations.

      Parameters:
      graph - the graph on which this object should be drawn
      g2d - the user-space Graphics2D to use to draw the Graphic
      g2dgcs - the graph-coordinate space Graphics2D to use to draw the Graphic
    • clone

      protected Object clone() throws CloneNotSupportedException
      Creates and returns a copy of this object. This method will throw the exception CloneNotSupportedException if the object is interned.
      Overrides:
      clone in class Object
      Throws:
      CloneNotSupportedException - a clone could not be created
      See Also:
    • isInterned

      public boolean isInterned()
      Determine if an object is interned in a object namer's tables.
      Specified by:
      isInterned in interface NamedObjectOps
      Returns:
      true if the object is interned; false if not
    • getObjectNamer

      protected Simulation getObjectNamer()
      Get the object namer for a named object.
      Returns:
      the object namer for this named object
    • getName

      public final String getName()
      Get an object's name.
      Specified by:
      getName in interface NamedObjectOps
      Returns:
      the name of the object
    • canDelete

      public boolean canDelete()
      Determine if this named object can be deleted. A named object can be deleted if the method delete has not been called and if the object is not in a state that prevents the object from being deleted. Subclasses that override this method must call canDelete() for their superclasses and return false if the superclass' canDelete method returns false. The default method returns true if delete() has not been called and returned true.
      Specified by:
      canDelete in interface NamedObjectOps
      Returns:
      true if this object can be deleted; false otherwise
    • delete

      public final boolean delete()
      Delete an object. An object can only be deleted once. If this method returns true, the object (if interned) will have been removed from the object namer tables.

      The implementations provided by DefaultNamedObect and generated because of a @NamedObject annotation provide a protected method named onDelete. A subclass that overrides onDelete() must call the onDelete method of its superclass after it's onDelete method has been called and any cleanup actions performed. In some cases, this may happen at a later time (e.g., if a thread is used for some of the cleanup operations or if it is otherwise necessary to wait).

      Specified by:
      delete in interface NamedObjectOps
      Returns:
      true if the deletion request was accepted; false otherwise
    • isDeleted

      public final boolean isDeleted()
      Determine if an object has been deleted. An object is deleted if the method delete() has been called and returned true.
      Specified by:
      isDeleted in interface NamedObjectOps
      Returns:
      true if deleted; false otherwise
    • deletePending

      public final boolean deletePending()
      Determine if an object is being deleted. An deletion is pending if the method delete() has been called and returned true but the deletion has not been completed.
      Specified by:
      deletePending in interface NamedObjectOps
      Returns:
      true if deletion is pending; false otherwise