- All Implemented Interfaces:
Graph.Graphic
,NamedObjectOps
Unlike many animation objects, a PolarGrid 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
Constructors -
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.int
Get the angular spacing.getColor()
Get the color used to draw lines representing polar coordinates.final String
getName()
Get an object's name.protected Simulation
Get the object namer for a named object.double
Get the radial spacing.double
Get the width of the stroke used to draw grid lines.double
Get the X origin for polar coordinates.double
Get the Y origin for polar coordinates.boolean
Determine if the origin is located by its absolute position.boolean
Determine if the origin is located by its fractional position.final boolean
Determine if an object has been deleted.boolean
Determine if an object is interned in a object namer's tables.void
setAngularSpacing
(int spacing) Set the angular spacing between radial lines used to represent polar coordinates.void
Set the color used to draw lines representing polar coordinates.void
setOrigin
(double xo, double yo, boolean fractional) Set the origin for polar coordinates.void
setRadialSpacing
(double spacing) Set the radial spacing for the circles used to represent polar coordinates.void
setStrokeWidth
(double strokeWidth) Set the width of the stroke used to draw grid lines.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
-
PolarGrid
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
-
getRadialSpacing
public double getRadialSpacing()Get the radial spacing. The radial spacing is the spacing between concentric circles drawn to show polar coordinates.- Returns:
- the radial spacing in GCS (Graph Coordinate Space) units
-
getAngularSpacing
public int getAngularSpacing()Get the angular spacing. The angular spacing is the spacing between adjacent radial lines drawn to show polar coordinates.- Returns:
- the angular spacing in degrees.
-
hasFractionalOrigin
public boolean hasFractionalOrigin()Determine if the origin is located by its fractional position. When true,getXOrigin()
will return a fraction f such that the X origin is located atgraph.getXLower()*(1.0-f) + graph.getXUpper()*f
andgetYOrigin()
will return a faction f such that the Y origin is located atgraph.getXLower()*(1.0-f) + graph.getXUpper()*f
. When false, the x and y GCS (Graph Coordinate Space) coordinates of the origin are the values returned bygetXOrigin()
andgetYOrigin()
respectively.- Returns:
- true if the origin's location is specified by its fractional position in the graph; false if the origin is located by its absolute position using GCS coordinates.
- See Also:
-
hasAbsoluteOrigin
public boolean hasAbsoluteOrigin()Determine if the origin is located by its absolute position. When true, the x and y GCS (Graph Coordinate Space) coordinates of the origin are the values returned bygetXOrigin()
andgetXOrigin()
respectively. When false,getXOrigin()
will return a fraction f such that the X origin on a graph is located atgraph.getXLower()*(1.0-f) + graph.getXUpper()*f
andgetYOrigin()
will return a faction f such that the Y origin is located atgraph.getXLower()*(1.0-f) + graph.getXUpper()*f
.- Returns:
- true if the origin is located by its absolute position using GCS coordinates; false if the origin's location is specified by its fractional position in the graph
- See Also:
-
getXOrigin
public double getXOrigin()Get the X origin for polar coordinates. The interpretation of the value returned depends on the value returned byhasFractionalOrigin()
orhasAbsoluteOrigin()
. WhenhasFractionalOrigin()
returns true, the value returned is the fraction f such that the X origin on a graph is located atgraph.getXLower()*(1.0-f) + graph.getXUpper()*f
in graph coordinate space units. WhenhasAbsoluteOrigin()
returns true, the value returned is the X coordinate of the origin in GCS units.- Returns:
- the X origin.
-
getYOrigin
public double getYOrigin()Get the Y origin for polar coordinates. The interpretation of the value returned depends on the value returned byhasFractionalOrigin()
orhasAbsoluteOrigin()
. WhenhasFractionalOrigin()
returns true, the value returned is the fraction f such that the Y origin on a graph is located atgraph.getYLower()*(1.0-f) + graph.getYUpper()*f
in graph coordinate space units. WhenhasAbsoluteOrigin()
returns true, the value returned is the Y coordinate of the origin in GCS units.- Returns:
- the Y origin.
-
getColor
Get the color used to draw lines representing polar coordinates.- Returns:
- the line color
-
setOrigin
public void setOrigin(double xo, double yo, boolean fractional) Set the origin for polar coordinates. When fractional units are used, xo is a fraction f such that the X origin is located atgraph.getXLower()*(1.0-f) + graph.getXUpper()*f
and yo is a fraction f such that the Y origin is located atgraph.getYLower()*(1.0-f) + graph.getYUpper()*f
. When absolute units are used, (xo, yo) is the location of the polar coordinate system's origin in GCS.- Parameters:
xo
- a fraction in the range [0,1] giving the X coordinate of the origin as a fraction of the value betweengraph.getXLower()
andgarph.getXUpper()
when the argumentfractional
is true; the X coordinate in GCS units when the argumentfractional
is falseyo
- a fraction in the range [0,1] giving the Y coordinate of the origin as a fraction of the value betweengraph.getXLower()
andgarph.getXUpper()
when the argumentfractional
is true; the X coordinate in GCS units when the argumentfractional
is falsefractional
- true if fractional units are used; false if absolute units are used
-
setColor
Set the color used to draw lines representing polar coordinates.- Parameters:
lineColor
- the line color; null for a default
-
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 a default
-
setRadialSpacing
public void setRadialSpacing(double spacing) Set the radial spacing for the circles used to represent polar coordinates.- Parameters:
spacing
- the radial spacing in GCS units; 0.0 or negative for the default behavior
-
setAngularSpacing
public void setAngularSpacing(int spacing) Set the angular spacing between radial lines used to represent polar coordinates. This value, when multiplied by 2, 3, or 5, should be a divisor of 90.- Parameters:
spacing
- the angle in degrees
-
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
-