Factory:org.bzdev.anim2d.PolarGridFactory
Parameter Types
(optional keytype)
(value type)
Range RV Mode Add/Set
angularSpacing
Angular Spacing
int [1, ∞] false set
The angular spacing in degrees for radial lines
color
Grid Color
(none) N/A false clear
The color used to draw grid lines
color.alpha
Alpha
java.lang.Integer [0, 255] false set
The alpha component of the color (0 for transparent to 255 for opaque)
color.blue
Blue
java.lang.Integer [0, 255] false set
The blue component of the color (0 for none to 255 for the maximum value)
color.css
CSS Color
java.lang.String N/A false set
The CSS specification for the color
This parameter's value provides a color via a string containing a CSS (Cascading Style Sheet) color (level 3). The specification for a CSS color, level 3, can be found in a W3C recommendation, and consists of one of the following:
  • 6 hexadecimal digits following an '#' and providing an opaque color (i.e., the alpha value is 255 in a RGBA color space).
  • rgb(RED,BLUE,GREEN), where RED, BLUE,, and GREEN are either numbers in the range [0, 255] or a number (typically floating point) followed by a '%'.
  • rgba(RED,BLUE,GREEN,ALPHA), where RED, BLUE, and GREEN are either numbers in the range [0, 255] or a number (typically floating point) followed by a '%', and ALPHA varies from 0.0 (fully transparent to 1.0 (opaque).
  • hsl(HUE,SATURATION,LIGHTNESS), where HUE is in the range [0,360], SATURATION is a number in the range [0,100] followed immediately by a '%', and where LIGHTNESS is a number in the range [0,100] followed immediately by a '%'.
  • hsl(HUE,SATURATION,LIGHTNESS, ALPHA), where HUE is in the range [0,360), SATURATION is a number in the range [0,100] followed immediately by a '%', where LIGHTNESS is a number in the range [0,100] followed immediately by a '%', and where ALPHA is a floating point number in the range [0, 1].
  • a keyword denoting an X11 color with the addition of "gray" and its synonym "grey" from SVG 1.0. X11 colors are described in the document X11 color names. The variant of these names that this class uses are the ones given in the W3C recommendation cited above. These are all lower case with no whitespace.
  • the value null, indicating that this parameter is not in use.
The subparameters red, green, blue, and alpha, when not null, will override the corresponding components of the CSS color. If the css, red, green, blue, and alpha parameters are all null, a default color (possibly null) will be used.
color.green
Green
java.lang.Integer [0, 255] false set
The green component of the color (0 for none to 255 for maximum value)
color.red
Red
java.lang.Integer [0, 255] false set
The red component of the color (0 for none to 255 for the maximum value)
fractional
Fractional Origin Coordinates
boolean N/A false set
True if the coordinates are fractional; false if absolute
radialSpacing
Radial Spacing
double [-∞, ∞] false set
The radial spacing in graph-coordinate-space units for circular grid lines; 0.0 indicates a default behavior
strokeWidth
Stroke Width
double (0.0, ∞] false set
The width of the stroke in user-space units used for drawing grid lines
timeline
Timeline
int N/A false add
Timeline entries (use only to clear)
This is an integer-keyed set of values that define changes in an object's configuration. Subclasses may provide additional timeline parameters.
timeline.time
Time
int
java.lang.Double
[-∞, ∞] false set
The time for a timeline entry
This parameter must be provided if a timeline entry exists. The units are those used by the double-precession time unit for the simulation (for animations, this is generally seconds).
timeline.traceSetMode
TraceSet Mode
int
org.bzdev.devqsim.TraceSetMode
N/A false set
The trace-set mode for a timeline entry
This parameter indicates how the trace sets associated with a timeline entry should be interpreted. The values are an enumeration whose type is org.bzdev.devqsim.TraceSetMode and are used as follows:
  • KEEP - keep the existing trace sets, adding additional ones specified by the parameter timeline.traceSets.
  • REMOVE - remove the trace sets specified by the parameter timeline.traceSets.
  • REPLACE - remove all existing trace sets and replace those with the ones specified by the timeline.traceSets parameter.
timeline.traceSets
Trace Sets
int
org.bzdev.devqsim.TraceSet
N/A false add
The trace sets for a timeline entry
This parameter represents a set of TraceSet objects (the three-argument add method is used to add entries). How the entries are interpreted depends on the trace set mode for this timeline entry.
timeline.visible
Visibility
int
java.lang.Boolean
N/A false set
The visibility for a timeline entry
This parameter's value determines the visibility of an object. When false the object is invisible and when true the object is visible.
timeline.zorder
Z-order
int
java.lang.Long
[-∞, ∞] false set
The z-order for a timeline entry
This parameter's value determines the stacking order of animation objects. Those with smaller values of this parameter are drawn before those with larger values.
traceSets
Trace Sets
org.bzdev.devqsim.TraceSet N/A false add
A set of TraceSet objects, used for tracing
This parameter provides a set of TraceSets a SimObject will use for tracing. One should use the add and remove factory methods as this parameter refers to a set of values.
visible
Visibility
boolean N/A false set
The visibility flag - objects with this set to false are invisible.
xo
Origin X Coordinate
double [-∞, ∞] false set
The X coordinate in graph coordinate space units for the origin of the polar grid
yo
Origin Y Coordinate
double [-∞, ∞] false set
The Y coordinate in graph coordinate space units for the origin of the polar grid
zorder
Z-Order
long [-∞, ∞] false set
The stacking order - objects with lower values are drawn first.