- All Implemented Interfaces:
Graph.Graphic
,NamedObjectOps
- Axis lines are vertical and horizontal lines that go through the point (0.0, 0.0) in graph coordinate space.
- Coarse-grid lines are lines spaced by a specified spacing, which is the same in the X and Y directions.
- Fine-grid lines are lines at locations that subdivide the coarse grid so that two adjacent and parallel course-grid lines will be separated by (N-1) fine-grid lines, where N is the subspacing divisor. When N is 1, a fine grid is not shown.
Unlike many animation objects, a CartesianGrid2D has an infinite size, but
only the portion that is visible within a graph's dimensions
will be drawn. To add a grid to a graph, use the graph's
add
method.
-
Constructor Summary
ConstructorsConstructorDescriptionCartesianGrid2D
(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.boolean
Determine if this named object can be deleted.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.Get the color for the axis.final String
getName()
Get an object's name.protected Simulation
Get the object namer for a named object.double
Get the grid spacing.Get the color for the coarse-grid lines.double
Get the width of the stroke used to draw grid lines.int
Get the grid subspacing divisor.Get the color for the fine-grid lines.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 colors for grid lines.void
setSpacing
(double spacing) Set the grid spacing.void
setStrokeWidth
(double strokeWidth) Set the width of the stroke used to draw grid lines.void
setSubspacing
(int subspacing) Set the grid subspacing divisor.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
-
CartesianGrid2D
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
-
getSpacing
public double getSpacing()Get the grid spacing. A value of 0.0 indicates that a default value will be used.- Returns:
- the grid spacing in GCS units
-
getSubspacing
public int getSubspacing()Get the grid subspacing divisor.- Returns:
- the grid subspacing divisor
-
setSpacing
public void setSpacing(double spacing) Set the grid spacing.- Parameters:
spacing
- the grid spacing in GCS units; 0.0 for a default
-
setSubspacing
public void setSubspacing(int subspacing) Set the grid subspacing divisor. The value determines how a coarse grid is partitioned into a fine grid. Each box in the coarse grid is partitioned intosubspacing
boxes along each axis. For example,- If subspacing is 1, coarse-grid boxes are not partitioed.
- If subspacing is 2, coarse-grid boxes are halved in each direction, creating 4 fine-grid boxes per coarse-grid box.
- If subspacing is 5, coarse-grid boxes are split into fifths with a total of 25 boxes per coarse-grid box.
- Parameters:
subspacing
- the subspacing divisor
-
getSpacingColor
Get the color for the coarse-grid lines.- Returns:
- the coarse-grid line color
-
getSubspacingColor
Get the color for the fine-grid lines.- Returns:
- the fine-grid line color
-
getAxisColor
Get the color for the axis. A point is on the axis if in graph cordinate space either x = 0 or y = 0. The width of a line representing an axis is the same as for other lines in the grid.- Returns:
- the axis-line color
-
setColors
Set the colors for grid lines. When a point is drawn, the axis color is used if the point is on an axis, otherwise the spacing color is drawn if the point is on the coarse grid. If the point is not on the coarse grid (which includes the axes), and is on the fine grid, the subspacing color is used.- Parameters:
axisColor
- the color for the axisspacingColor
- the color for the coarse gridsubspacingColor
- the color for the fine grid
-
getStrokeWidth
public double getStrokeWidth()Get the width of the stroke used to draw grid lines.- Returns:
- the stroke width
-
setStrokeWidth
public void setStrokeWidth(double strokeWidth) Set the width of the stroke used to draw grid lines.- Parameters:
strokeWidth
- the stroke width; 0.0 or negative for the default
-
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
-
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
-