Factory:org.bzdev.anim2d.AnimationShape2DFactory
Parameter Types
(optional keytype)
(value type)
Range RV Mode Add/Set
drawColor
drawColor
(none) N/A false clear
The draw color for this shape
This parameter specifies the color used to draw the object (see below for the sub-parameters). If not provided, the outline of this shape will not be drawn.
drawColor.alpha
Alpha
java.lang.Integer [0, 255] false set
The alpha component of the color (0 for transparent to 255 for opaque)
drawColor.blue
Blue
java.lang.Integer [0, 255] false set
The blue component of the color (0 for none to 255 for the maximum value)
drawColor.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.
drawColor.green
Green
java.lang.Integer [0, 255] false set
The green component of the color (0 for none to 255 for maximum value)
drawColor.red
Red
java.lang.Integer [0, 255] false set
The red component of the color (0 for none to 255 for the maximum value)
fillColor
Fill Color
(none) N/A false clear
The fill color for this shape
This parameter specifies the color used to fill the object (see below for the sub-parameters). If not provided, the interior of this shape will not be filled.
fillColor.alpha
Alpha
java.lang.Integer [0, 255] false set
The alpha component of the color (0 for transparent to 255 for opaque)
fillColor.blue
Blue
java.lang.Integer [0, 255] false set
The blue component of the color (0 for none to 255 for the maximum value)
fillColor.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.
fillColor.green
Green
java.lang.Integer [0, 255] false set
The green component of the color (0 for none to 255 for maximum value)
fillColor.red
Red
java.lang.Integer [0, 255] false set
The red component of the color (0 for none to 255 for the maximum value)
shape
Animation Path or Shape
int
org.bzdev.anim2d.AnimationPath2D
N/A false set
An animation path representing part of the outline for this shape or an actual shape
This parameter represents a table indexed by an integer providing a sequence of animation paths (org.bzdev.anim2d.AnimationPath2D) that make up the outline of the shape. How the paths are used to determine the interior or exterior of a shape depends on the windingRule parameter. The value for this parameter can also be any instance of java.awt.Shape or java.awt.geom.PathIterator. Because org.bzdev.anim2d.AnimationPath2D does not allow disjoint path segments, a key is used so that each component of the shape's boundary can be expressed as a single continous path.
stroke
Stroke
(none) N/A false clear
The stroke used for drawing the outline of this shape
stroke.cap
Cap
org.bzdev.obnaming.misc.BasicStrokeParm.Cap N/A false set
The type of the line-segment cap
This parameter's value, the type of a line-segment cap, is one of the following enumeration constants defined by the enumeration org.bzdev.obnaming.misc.BasicStrokeParm.Cap:
  • BUTT. Subpaths and dash segments end with no added decoration.
  • ROUND. Subpaths and dash segments end with a round decoration.
  • SQUARE.Subpaths and dash segments end with a square decoration that extends half the line width beyond the end of each subpath or dash segment.
stroke.dashIncrement
Dash Increment
double (0.0, ∞] false set
the length of a '-' or ' ' in a dash pattern
The length is in either user-space units or graph coordinate space units, depending on the value of the parameter gcsMode.
stroke.dashPattern
Dash Pattern
java.lang.String N/A false set
A pattern of alternating "-" and " " sequences
The value of this parameter is a string. If the string has a length of zero, the line is solid. Otherwise the pattern should be represented by a sequence of "-" or " " giving the length of dashes or empty space respectively as multiples of the value of dashIncrement. Each "-" and each " " represents a component of a segment whose length is dashIncrement. Thus, if dashIncrement is 10.0, then the pattern "-- - " will consist of a dash of length 20.0, a space of length 20.0, a dash of length 10.0, and a space of length 10.0, with the pattern repeating as needed. Unless the dash pattern is a string whose length is 0, the pattern must start with a "-" instead of a " ".
stroke.dashPhase
Dash Phase
double [-∞, ∞] false set
the offset to the start of the dashing pattern
stroke.gcsMode
boolean N/A false set
A boolean that indicates whether stroke parameters are provided in graph coordinate space or user space.
The value of this parameter indicates whether the width, dashPhase, and dashIncrement are provided in graph coordinate space or user space. The value true indicates graph coordinate space and the value false (the default) indicates user space.
stroke.join
Join
org.bzdev.obnaming.misc.BasicStrokeParm.Join N/A false set
The method for joining line segments
This parameter's value, the type of the method used to join line segments, is one of the following enumeration constants defined by org.bzdev.obnaming.misc.BasicStrokeParm.Join:
  • BEVEL. Connected path segments are joined by connecting the outer corners of their outlines with a straight line segment.
  • MITER. Connected path segments are joined by extending the outer corners until they meet.
  • ROUND. Connected path segments are joined by rounding off the corner at a radius of half the line width.
stroke.miterLimit
Miter Limit
double [1.0, ∞] false set
the miter limit for a stroke
This parameter's value is the limit such that a line join is trimmed when the ratio of miter length to stroke width is greater than this value. The miter length is the diagonal length of the miter, which is the distance between the inside corner and the outside corner of the intersection. The smaller the angle formed by two line segments, the longer the miter length and the sharper the angle of intersection. The default miterlimit value of 10.0 causes all angles less than 11 degrees to be trimmed. Trimming miters converts the decoration of the line join to bevel. This values applies only to a line join that has a MITER join decoration, and must be larger than or equal to 1.0.
stroke.width
Width
double [-∞, ∞] false set
the line width of a stroke
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.
windingRule
Winding Rule
org.bzdev.geom.SplinePathBuilder.WindingRule N/A false set
The winding rule for this shape (as strings, use "WIND_EVEN_ODD" or "WIND_NON_ZER0")
The value for a winding rule is an enumeration whose type is org.bzdev.geom.SplinePathBuilder.WindingRule, with enumeration constants
  • WIND_EVEN_ODD, which specifies that a point lies inside the path if a ray drawn in any direction from that point to infinity is crossed by path segments an odd number of times.
  • WIND_NON_ZERO, which specifies that a point lies inside the path if a ray drawn in any direction from that point to infinity is crossed by path segments a different number of times in the counter-clockwise direction than the clockwise direction. /ul> (the description for these enumeration constants was copied from the Java documentation for {@link java.awt.geom.PathIterator}, which defines integer-valued constants with the same name).
zorder
Z-Order
long [-∞, ∞] false set
The stacking order - objects with lower values are drawn first.