- All Implemented Interfaces:
Graph.Graphic
,NamedObjectOps
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 Summary
ConstructorsConstructorDescriptionConnectingLine2D
(Animation2D animation, String name, boolean intern) Constructor. -
Method Summary
Modifier and TypeMethodDescriptionvoid
addTo
(Graph graph, Graphics2D g2d, Graphics2D g2dgcs) Add this object to a graph.boolean
Determine if this named object can be deleted.protected Object
clone()
Creates and returns a copy of this object.configure
(double u1, double u2) Configure path parameters for a line's end points.configure
(DoubleSupplier getX1, DoubleSupplier getY1, DoubleSupplier getX2, DoubleSupplier getY2) Configure the line's end points.final boolean
delete()
Delete an object.final boolean
Determine if an object is being deleted.getColor()
Get the color for a line drawing this path when addTo is called.boolean
Get GCS mode.final String
getName()
Get an object's name.protected Simulation
Get the object namer for a named object.Get the stroke for a line drawing this path when addTo is called.final boolean
Determine if an object has been deleted.boolean
Determine if an object is interned in a object namer's tables.void
Set the color for a line drawing this path when addTo is called.void
setGcsMode
(boolean gcsMode) Set GCS mode.void
Set the stroke for a line drawing this path when addTo is called.Methods inherited from class org.bzdev.anim2d.AnimationObject2D
addToFrame, addToFrame, getAnimation, getZorder, isVisible, printConfiguration, printState, setVisible, setZorder, setZorder
Methods inherited from class org.bzdev.devqsim.SimObject
addSimulationListener, addTraceSet, bindCallable, bindCallable, bindCallable, bindCallable, bindRunnable, bindRunnable, bindRunnable, bindRunnable, callableObject, callableScript, callScriptFunction, callScriptMethod, clearTraceSets, evalScript, getEventListenerList, getScriptObject, getTraceSets, onDelete, printConfiguration, printConfiguration, printConfiguration, printConfiguration, printConfiguration, printConfiguration, printState, printState, printState, printState, printState, printState, putScriptObject, removeSimulationListener, removeTraceSet, runnableObject, runnableScript, scheduleCall, scheduleCall, scheduleCall, scheduleCall, scheduleCallObject, scheduleScript, scheduleTask, scheduleTask, scheduleTask, scheduleTask, scheduleTaskObject, scheduleTaskScript, startImmediateTask, startImmediateTask, trace, trace, unscheduledTaskThread, unscheduledTaskThread, update, update, usesTraceSet
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface org.bzdev.graphs.Graph.Graphic
boundingBox
Methods inherited from interface org.bzdev.obnaming.NamedObjectOps
canDelete, delete, deletePending, getName, isDeleted, isInterned
-
Constructor Details
-
ConnectingLine2D
Constructor.- Parameters:
animation
- the animationname
- the name of the object; null for an automatically generated nameintern
- true if the object can be looked up by using the methods inSimulation
; false otherwise.- Throws:
IllegalArgumentException
- typically means a name is already in use- See Also:
-
-
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
Configure path parameters for a line's end points. If getX1, getY1, getX2, and getY2 are the suppliers passed toconfigure(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 lineu2
- is the parameter u ∈ [0, 1] for the second end of the line- Returns:
- this object
-
setColor
Set the color for a line drawing this path when addTo is called.- Parameters:
color
- the color
-
getColor
Get the color for a line drawing this path when addTo is called.- Returns:
- the color
-
setStroke
Set the stroke for a line drawing this path when addTo is called.- Parameters:
stroke
- the 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
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 drawng2d
- the user-space Graphics2D to use to draw the Graphicg2dgcs
- the graph-coordinate space Graphics2D to use to draw the Graphic
-
clone
Creates and returns a copy of this object. This method will throw the exception CloneNotSupportedException if the object is interned.- Overrides:
clone
in classObject
- 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 interfaceNamedObjectOps
- Returns:
- true if the object is interned; false if not
-
getObjectNamer
Get the object namer for a named object.- Returns:
- the object namer for this named object
-
getName
Get an object's name.- Specified by:
getName
in interfaceNamedObjectOps
- 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 interfaceNamedObjectOps
- 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 interfaceNamedObjectOps
- 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 interfaceNamedObjectOps
- 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 interfaceNamedObjectOps
- Returns:
- true if deletion is pending; false otherwise
-