- All Implemented Interfaces:
Graph.Graphic
,NamedObjectOps
Shape
or
shapes create by instances of
PathIterator
.
If multiple shapes are provided, their outlines are combined
with their inside and outside regions determined by a
winding rule (using the enumeration
WindingRule
.)
If the winding rule that is provided is null, the winding rule of
an initial path iterator, or the path iterator for an initial shape,
is used.-
Constructor Summary
ConstructorsConstructorDescriptionAnimationShape2D
(Animation2D animation, String name, boolean intern) Constructor. -
Method Summary
Modifier and TypeMethodDescriptionvoid
addTo
(Graph g, Graphics2D g2d, Graphics2D g2dGCS) Add this object to a graph.void
Append an instance ofShape
to this object.void
appendShape
(Shape s) Append an instance ofShape
to this object.Get the bounding box for this Graphic.boolean
Determine if this named object can be deleted.void
clear()
Clear the current path by removing its shape.protected Object
clone()
Creates and returns a copy of this object.final boolean
delete()
Delete an object.final boolean
Determine if an object is being deleted.final String
getName()
Get an object's name.protected Simulation
Get the object namer for a named object.getShape()
Get a copy of the current shape.final boolean
Determine if an object has been deleted.boolean
Determine if an object is interned in a object namer's tables.void
printConfiguration
(String iPrefix, String prefix, boolean printName, PrintWriter out) Print this simulation object's configuration.void
Set the color used to draw the outline of a shape.void
Set the color used to fill a shape.void
setGCSMode
(boolean gcsMode) Set the Graph-Coordinate-Space mode (GCS mode) for this shape.void
Provide a winding rule for this shape and initialize the shape to an empty shape.void
Set the shape for this animation shape given a path iterator defining a shape.void
Set the shape for this animation shape given an instance ofShape
.void
Set the stroke used to draw the outline of a shape.Methods inherited from class org.bzdev.anim2d.AnimationObject2D
addToFrame, addToFrame, getAnimation, getZorder, isVisible, 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.obnaming.NamedObjectOps
canDelete, delete, deletePending, getName, isDeleted, isInterned
-
Constructor Details
-
AnimationShape2D
Constructor. The constructor sets the visibility of this object to false. This is done because, while an animation shape can be used on its own, it will typically be used as part of an animation layer, and an animation layer's visibility will determine if the shape is shown or not. When used directly, the caller must set the shape's visibility explicitly, and should set the Z-order as well.- 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
-
boundingBox
Description copied from interface:Graph.Graphic
Get the bounding box for this Graphic. Classes implementing this method should override it if a bounding box can be determined efficiently. It is intended for cases where a bounding-box comparison can allow drawing operations to be avoided.The value returned must not be modified.
- Returns:
- the bounding box for this Graphic in graph coordinate space; null if a bounding box has not been computed
-
getShape
Get a copy of the current shape. Note: the object returned is actually an instance ofPath2D
.- Returns:
- the shape
-
clear
public void clear()Clear the current path by removing its shape. -
setShape
Provide a winding rule for this shape and initialize the shape to an empty shape.- Parameters:
wr
- the winding rule for this animation shape- Throws:
NullPointerException
- the winding rule was null;
-
setShape
Set the shape for this animation shape given an instance ofShape
. If the winding rule wr is null, the winding rule will be that provided by the shape's path iterator.- Parameters:
wr
- the winding rule for the shape; null to use the winding rule provided by the shape's path iterators
- the shape- Throws:
NullPointerException
- both arguments are null
-
setShape
Set the shape for this animation shape given a path iterator defining a shape. If the winding rule wr is null, the winding rule will be that provided by the path iterator pi.- Parameters:
wr
- the winding rule for the shapepi
- the path iterator defining a shape.- Throws:
NullPointerException
- both arguments are null
-
appendShape
Append an instance ofShape
to this object. The winding rule is set by the first method that sets or appends a shape or animation path when there is no existing shape.- Parameters:
s
- the shape
-
appendShape
Append an instance ofShape
to this object. The winding rule is set by the first method that sets or appends a shape or animation path when there is no existing shape.- Parameters:
pi
- the path iterator defining a shape
-
setDrawColor
Set the color used to draw the outline of a shape.- Parameters:
c
- the color; null if the outline should not be drawn
-
setFillColor
Set the color used to fill a shape.- Parameters:
c
- the color; null if the shape should not be drawn
-
setStroke
Set the stroke used to draw the outline of a shape.- Parameters:
stroke
- the stroke; null for a default
-
setGCSMode
public void setGCSMode(boolean gcsMode) Set the Graph-Coordinate-Space mode (GCS mode) for this shape. When the outline of a shape is drawn, GCS mode determines if the width of the stroke is specified in GCS units or in user-space units. The default value isfalse
.- Parameters:
gcsMode
- true if the stroke width is given in GCS units; false if the stroke width is given in user-space units
-
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:
g
- 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
-
printConfiguration
Print this simulation object's configuration. Documentation for the use of this method is provided by the documentation for theSimObject
methodSimObject.printConfiguration(String,String,boolean,PrintWriter)
.When the second argument has a value of true, the object name and class name will be printed in a standard format with its indentation provided by the iPrefix argument. In addition, the configuration that is printed includes the following items.
Defined in
AnimationObject2D
:- the Z-order.
- whether or not this object is visible.
AnimationLayer2D
:- the number of objects in this animation layer.
- Overrides:
printConfiguration
in classAnimationObject2D
- Parameters:
iPrefix
- the prefix to use for an initial line when printName is true with null treated as an empty stringprefix
- a prefix string (typically whitespace) to put at the start of each line other than the initial line that is printed when printName is trueprintName
- requests printing the name of an objectout
- the output print writer
-
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
-