Factory:org.bzdev.anim2d.AnimationLayer2DFactory
Parameter Types
(optional keytype)
(value type)
Range RV Mode Add/Set
drawColor
Default Draw Color
(none) N/A false clear
Drawing color to use as a default
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
Default Fill Color
(none) N/A false clear
Fill color to use as a default
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)
fontParms
Default Font Parameters
(none) N/A false clear
Font parameters to use as a default
fontParms.angle
Rotation Angle
double [-∞, ∞] false set
The angle of rotation from horizontal, counterclockwise in degrees
fontParms.baselinePosition
Baseline Position
org.bzdev.graphs.Graph.BLineP N/A false set
Baseline position (TOP, CENTER, BASE, BOTTOM)
This parameter's value is an enumeration constant, defined by org.bzdev.graphs.Graph.BLineP, whose possible values are
  • BASE. The base line of the text is aligned with (x,y) coordinate at which the text is drawn. This is the default.
  • BOTTOM. The bottom of the text is aligned with (x,y) coordinate at which the text is drawn.
  • CENTER. The center of the text is aligned with (x,y) coordinate at which the text is drawn.
  • TOP. The top of the text is aligned with (x,y) coordinate at which the text is drawn.
The text that is drawn is a string fitting on a single line.
fontParms.color.alpha
Alpha Component
java.lang.Integer [0, 255] false set
The alpha component of the font color (0 for transparent to 255 for opaque)
fontParms.color.blue
Blue Component
java.lang.Integer [0, 255] false set
The blue component of the font color (0 for none to 255 for the maximum value)
fontParms.color.css
CSS Specification
java.lang.String N/A false set
The CSS specification for a font 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 subparameters color.red, color.green, color.blue, and color.alpha, when not null, will override the corresponding components of the CSS color.
fontParms.color.green
Green Component
java.lang.Integer [0, 255] false set
The green component of the font color (0 for none to 255 for the maximum value)
fontParms.color.red
Red Component
java.lang.Integer [0, 255] false set
The red component of the font color (0 for none to 255 for the maximum value)
fontParms.justification
Justification
org.bzdev.graphs.Graph.Just N/A false set
Text justification (LEFT, CENTER, RIGHT)
This parameter's value is an enumeration constant, defined by the enumeration type org.bzdev.graphs.Graph.Just, whose possible values are:
  • CENTER. Text will be centered.
  • LEFT. Text will be left justified. This is the default.
  • RIGHT. Text will be right justified.
The justification is relative to the (x,y) coordinates at which a string is drawn.
fontParms.name
Font or Font-Family Name
java.lang.String N/A false set
The font or font-family name (e.g., Helvetica)
Valid names for this parameter are the names of a font or a font family as defined by Java. Logical font names (these are mapped by Java into the actual font names) that are always supported are
  • serif.
  • sansserif.
  • monospaced.
  • dialog.
  • dialoginput.
fontParms.size
Size
int [1, ∞] false set
The font size (a positive integer)
fontParms.style
Style
org.bzdev.obnaming.misc.GraphFontParm.FontStyle N/A false set
The font style (PLAIN, BOLD, BOLD_ITALIC)
This parameter's value is an enumeration constant, defined by org.bzdev.obnaming.misc.GraphFontParm.FontStyle, whose possible values are:
  • BOLD. The text will be drawn using a bold font.
  • BOLD_ITALIC. The text will be drawn using a bold, italic font.
  • ITALIC. The text will be drawn using an italic font.
  • PLAIN. The text will be drawn using a plain font.
object
Object Data
int N/A false add
Object-specific data (indexed by the rendering order)
This parameter can be used directly to clear a key or to clear the object table. There are a large number of subparameters While all objects have an object.type parameter, the remaining subparameters are used for specific types:
  • If the value of object.type is ARC_CHORD, ARC_OPEN, or ARCH_PIE, the following parameters may be set:
    • object.fill - true if the object's shape is filled; false if it is not filled.
    • object.draw - true if the object's shape is drawn; false if it is not drawn.
    • object.width - the width of the full ellipse of which this object is a partial section.
    • object.height - the height of the full ellipse of which this object is a partial section.
    • object.x - the object's X coordinate.
    • object.y - the object's Y coordinate.
    • object.start - the starting angle of the arc in degrees, measured counterclockwise in units of degrees. The angle is set for the case in which the height and width are the same, followed by an affine transformation that skews the angle if the width and height differ.
    • object.extent - the angular extent in degrees. The angle for the end point is determined by adding the extent to the starting angle to produce the final angle, which is followed by an affine transformation that skews the angle if the width and height differ.
    • object.drawColor - the color used to draw the object (see below for the sub-parameters). Calling clear removes object-specific colors for all objects; calling 'remove' removes the object-specific color for the given key. In both cases, the default color will be used.
    • object.fillColor - the color used to fill the object (see below for the sub-parameters). Calling clear removes object-specific colors for all objects; calling 'remove' removes the object-specific color for the given key. In both cases, the default color will be used.
    • object.stroke - the stroke used to draw the object (see below for the sub-parameters). Calling clear removes object-specific stroke for all objects; calling remove removes the object-specific stroke for the given key. In both cases, the default stroke will be used.
    • object.refPoint - the object's reference point, the point corresponding to (x,y), with a value that is an enumeration constant for the enumeration type org.bzdev.geom.RefPointName:
      • UPPER_LEFT. The point (x,y) corresponds to the upper left corner of the object' bounding box.
      • UPPER_CENTER. The point (x,y) corresponds to the center of the upper edge of the object's bounding box.
      • UPPER_RIGHT. The point (x,y) corresponds to the upper right corner of the object' bounding box.
      • CENTER_LEFT. The point (x,y) corresponds to the center of the left edge of the object's bounding box.
      • CENTER. The point (x,y) corresponds to the center of the object' bounding box.
      • CENTER_RIGHT. The point (x,y) corresponds to the center of the right edge of the object's bounding box.
      • LOWER_LEFT. The point (x,y) corresponds to the lower left corner of the object's bounding box.
      • LOWER_CENTER. The point (x,y) corresponds to the center of the lower edge of the object's bounding box.
      • LOWER_RIGHT. The point (x,y) corresponds to the lower right corner of the object's bounding box.
    For ARC_CHORD, the shape includes a line connecting the end points of the arc. For ARC_OPEN, only the arc itself is part of the curve, although filling the arc will fill the same area as for the ARC_CHORD case. For ARC_PIE, the lines from the center of the ellipse to the end points are included in the shape.
  • If the value of object.type is CONTROL_POINT, the following parameters may be set:
    • object.x - the control point's X coordinate.
    • object.y - the control point's Y coordinate.
  • If the value of object.type is CUBIC_CURVE, the following parameters may be set:
    • object.draw - true if the object is drawn; false if it is not drawn.
    • object.x - the object's X coordinate.
    • object.y - the object's Y coordinate.
    • object.xcontrol1 - the X coordinate of the object's first control point.
    • object.ycontrol1 - the Y coordinate of the object's first control point.
    • object.xcontrol2 - the X coordinate of the object's second control point.
    • object.ycontrol2 - the Y coordinate of the object's second control point.
    • object.xend - the X coordinate of the end point.
    • object.yend - the Y coordinate of the end point.
    • object.drawColor - the color used to draw the object (see below for the sub-parameters). calling clear removes object-specific colors for all objects; calling 'remove' removes the object-specific color for the given key. In both cases, the default color will be used.
    • object.stroke - the stroke used to draw the object (see below for the sub-parameters). calling clear removes object-specific stroke for all objects; calling 'remove' removes the object-specific stroke for the given key. In both cases, the default stroke will be used.
  • If the value of object.type is ELLIPSE, the following parameters may be set:
    • object.draw - true if the object's shape is drawn; false if it is not drawn.
    • object.fill - true if the object's shape is filled; false if it is not filled.
    • object.x - the object's X coordinate.
    • object.y - the object's Y coordinate.
    • object.width - true if the object's shape is drawn; false if it is not drawn.
    • object.height - the object's height.
    • object.drawColor - the color used to draw the object (see below for the sub-parameters). calling clear removes object-specific colors for all objects; calling 'remove' removes the object-specific color for the given key. In both cases, the default color will be used.
    • object.fillColor - the color used to fill the object (see below for the sub-parameters). Calling clear removes object-specific colors for all objects; calling 'remove' removes the object-specific color for the given key. In both cases, the default color will be used.
    • object.stroke - the stroke used to draw the object (see below for the sub-parameters). Calling clear removes object-specific stroke for all objects; calling 'remove' removes the object-specific stroke for the given key. In both cases, the default stroke will be used.
    • object.refPoint - the object's reference point, the point corresponding to (x,y), with a value that is an enumeration constant for the enumeration type org.bzdev.geom.RefPointName:
      • UPPER_LEFT. The point (x,y) corresponds to the upper left corner of the object' bounding box.
      • UPPER_CENTER. The point (x,y) corresponds to the center of the upper edge of the object's bounding box.
      • UPPER_RIGHT. The point (x,y) corresponds to the upper right corner of the object' bounding box.
      • CENTER_LEFT. The point (x,y) corresponds to the center of the left edge of the object's bounding box.
      • CENTER. The point (x,y) corresponds to the center of the object' bounding box.
      • CENTER_RIGHT. The point (x,y) corresponds to the center of the right edge of the object's bounding box.
      • LOWER_LEFT. The point (x,y) corresponds to the lower left corner of the object's bounding box.
      • LOWER_CENTER. The point (x,y) corresponds to the center of the lower edge of the object's bounding box.
      • LOWER_RIGHT. The point (x,y) corresponds to the lower right corner of the object's bounding box.
  • If the value of object.type is IMAGE, the following parameters may be set:
    • object.x - the object's X coordinate.
    • object.y - the object's Y coordinate.
    • imageURL - the URL at which the image can be found. This may be a URL whose scheme is either sresource or resource.
    • object.imageAngle - the angle in degrees by which the image will be rotated in the counter clockwise direction about the reference point.
    • object.imageScaleX - the scaling factor, in the X direction of the image, by which to change the size of the image. When the value is 1.0, an image pixel's size in the X direction will be one unit in either graph coordinate space (when object.imageInGCS is true) or user space (when object.imageInGCS is false).
    • object.imageScaleY - the scaling factor, in the Y direction of the image, by which to change the size of the image. When the value is 1.0, an image pixel's size in the Y direction will be one unit in either graph coordinate space (when object.imageInGCS is true) or user space when object.imageInGCS is false.
    • object.refPoint - the object's reference point, the point corresponding to (x,y), with a value that is an enumeration constant for the enumeration type org.bzdev.geom.RefPointName:
      • UPPER_LEFT. The point (x,y) corresponds to the upper left corner of the object' bounding box.
      • UPPER_CENTER. The point (x,y) corresponds to the center of the upper edge of the object's bounding box.
      • UPPER_RIGHT. The point (x,y) corresponds to the upper right corner of the object' bounding box.
      • CENTER_LEFT. The point (x,y) corresponds to the center of the left edge of the object's bounding box.
      • CENTER. The point (x,y) corresponds to the center of the object' bounding box.
      • CENTER_RIGHT. The point (x,y) corresponds to the center of the right edge of the object's bounding box.
      • LOWER_LEFT. The point (x,y) corresponds to the lower left corner of the object's bounding box.
      • LOWER_CENTER. The point (x,y) corresponds to the center of the lower edge of the object's bounding box.
      • LOWER_RIGHT. The point (x,y) corresponds to the lower right corner of the object's bounding box.
    • object.imageFlipX - the image should be reflected in the X direction (about the Y axis). The image will be in the same bounding box regardless of the value of this parameter. The default is false.
    • object.imageFlipY - the image should be reflected in the Y direction (about the X axis). The image will be in the same bounding box regardless of the value of this parameter. The default is false.
    • object.imageInGCS - true if a pixel takes up one unit in graph coordinate space; false if a pixel takes up one unit in user space. The default is true.
  • If the value of object.type is LINE, the following parameters may be set:
    • object.draw - true if the object's shape is drawn; false if it is not drawn.
    • object.x - the object's X coordinate.
    • object.y - the object's Y coordinate.
    • object.xend - the X coordinate of the end point.
    • object.yend - the Y coordinate of the end point.
    • object.drawColor - the color used to draw the object (see below for the sub-parameters). Calling clear removes object-specific colors for all objects; calling 'remove' removes the object-specific color for the given key. In both cases, the default color will be used.
    • object.stroke - the stroke used to draw the object (see below for the sub-parameters). Calling clear removes object-specific stroke for all objects; Calling 'remove' removes the object-specific stroke for the given key. In both cases, the default stroke will be used.
  • If the value of object.type is MOVE_TO, the following parameters may be set:
  • If the value of object.type is PATH_START, the following parameters may be set:
    • object.windingRule The value 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.
      (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).
    The next element must have a type of either MOVE_TO or MOVE_TO_NEXT, followed by a sequence of objects ending with an object whose type is PATH_END.
  • If the value of object.type is PATH_END, the following parameters may be set:
    • object.draw - true if the object's shape is drawn; false if it is not drawn.
    • object.fill - true if the object's shape is filled; false if it is not filled.
    • object.drawColor - the color used to draw the object (see below for the sub-parameters). Calling clear removes object-specific colors for all objects; calling 'remove' removes the object-specific color for the given key. In both cases, the default color will be used.
    • object.fillColor - the color used to fill the object (see below for the sub-parameters). Calling clear removes object-specific colors for all objects; calling 'remove' removes the object-specific color for the given key. In both cases, the default color will be used.
    • object.stroke - the stroke used to draw the object (see below for the sub-parameters). Calling clear removes object-specific stroke for all objects; calling 'remove' removes the object-specific stroke for the given key. In both cases, the default stroke will be used.
  • If the value of object.type is QUAD_CURVE, the following parameters may be set:
    • object.draw - true if the object's shape is drawn; false if it is not drawn.
    • object.x - the object's X coordinate.
    • object.y - the object's Y coordinate.
    • object.xcontrol - the X coordinate of the control point.
    • object.ycontrol - the Y coordinate of the control point.
    • object.xend - the X coordinate of the end point.
    • object.yend - the X coordinate of the end point.
    • object.drawColor - the color used to draw the object (see below for the sub-parameters). Calling clear removes object-specific colors for all objects; calling 'remove' removes the object-specific color for the given key. In both cases, the default color will be used.
    • object.stroke - the stroke used to draw the object (see below for the sub-parameters). Calling clear removes object-specific stroke for all objects; calling 'remove' removes the object-specific stroke for the given key. In both cases, the default stroke will be used.
    • object.refPoint - the object's reference point, the point corresponding to (x,y), with a value that is an enumeration constant for the enumeration type org.bzdev.geom.RefPointName:
      • UPPER_LEFT. The point (x,y) corresponds to the upper left corner of the object' bounding box.
      • UPPER_CENTER. The point (x,y) corresponds to the center of the upper edge of the object's bounding box.
      • UPPER_RIGHT. The point (x,y) corresponds to the upper right corner of the object' bounding box.
      • CENTER_LEFT. The point (x,y) corresponds to the center of the left edge of the object's bounding box.
      • CENTER. The point (x,y) corresponds to the center of the object' bounding box.
      • CENTER_RIGHT. The point (x,y) corresponds to the center of the right edge of the object's bounding box.
      • LOWER_LEFT. The point (x,y) corresponds to the lower left corner of the object's bounding box.
      • LOWER_CENTER. The point (x,y) corresponds to the center of the lower edge of the object's bounding box.
      • LOWER_RIGHT. The point (x,y) corresponds to the lower right corner of the object's bounding box.
  • If the value of object.type is RECTANGLE, the following parameters may be set:
    • object.draw - true if the object's shape is drawn; false if it is not drawn.
    • object.fill - true if the object's shape is filled; false if it is not filled.
    • object.x - the object's X coordinate.
    • object.y - the object's Y coordinate.
    • object.width - true if the object's shape is drawn; false if it is not drawn.
    • object.height - the object's height.
    • object.drawColor - the color used to draw the object (see below for the sub-parameters). Calling clear removes object-specific colors for all objects; calling 'remove' removes the object-specific color for the given key. In both cases, the default color will be used.
    • object.fillColor - the color used to fill the object (see below for the sub-parameters). Calling clear removes object-specific colors for all objects; calling 'remove' removes the object-specific color for the given key. In both cases, the default color will be used.
    • object.stroke - the stroke used to draw the object (see below for the sub-parameters). Calling clear removes object-specific stroke for all objects; calling 'remove' removes the object-specific stroke for the given key. In both cases, the default stroke will be used.
    • object.refPoint - the object's reference point, the point corresponding to (x,y), with a value that is an enumeration constant for the enumeration type org.bzdev.geom.RefPointName:
      • UPPER_LEFT. The point (x,y) corresponds to the upper left corner of the object' bounding box.
      • UPPER_CENTER. The point (x,y) corresponds to the center of the upper edge of the object's bounding box.
      • UPPER_RIGHT. The point (x,y) corresponds to the upper right corner of the object' bounding box.
      • CENTER_LEFT. The point (x,y) corresponds to the center of the left edge of the object's bounding box.
      • CENTER. The point (x,y) corresponds to the center of the object' bounding box.
      • CENTER_RIGHT. The point (x,y) corresponds to the center of the right edge of the object's bounding box.
      • LOWER_LEFT. The point (x,y) corresponds to the lower left corner of the object's bounding box.
      • LOWER_CENTER. The point (x,y) corresponds to the center of the lower edge of the object's bounding box.
      • LOWER_RIGHT. The point (x,y) corresponds to the lower right corner of the object's bounding box.
  • If the value of object.type is ROUND_RECTANGLE, the following parameters may be set:
    • object.draw - true if the object's shape is drawn; false if it is not drawn.
    • object.fill - true if the object's shape is filled; false if it is not filled.
    • object.x - the object's X coordinate.
    • object.y - the object's Y coordinate.
    • object.width - the object's width
    • object.height - the object's height.
    • object.arcwidth - the width of the arcs used to round off the corners of the rectangle.
    • object.archeight - the height of the arcs used to round off the corners of the rectangle.
    • object.drawColor - the color used to draw the object (see below for the sub-parameters). Calling clear removes object-specific colors for all objects; calling 'remove' removes the object-specific color for the given key. In both cases, the default color will be used.
    • object.fillColor - the color used to fill the object (see below for the sub-parameters). Calling clear removes object-specific colors for all objects; calling 'remove' removes the object-specific color for the given key. In both cases, the default color will be used.
    • object.stroke - the stroke used to draw the object (see below for the sub-parameters). Calling clear removes object-specific stroke for all objects; calling 'remove' removes the object-specific stroke for the given key. In both cases, the default stroke will be used.
    • object.refPoint - the object's reference point, the point corresponding to (x,y), with a value that is an enumeration constant for the enumeration type org.bzdev.geom.RefPointName:
      • UPPER_LEFT. The point (x,y) corresponds to the upper left corner of the object' bounding box.
      • UPPER_CENTER. The point (x,y) corresponds to the center of the upper edge of the object's bounding box.
      • UPPER_RIGHT. The point (x,y) corresponds to the upper right corner of the object' bounding box.
      • CENTER_LEFT. The point (x,y) corresponds to the center of the left edge of the object's bounding box.
      • CENTER. The point (x,y) corresponds to the center of the object' bounding box.
      • CENTER_RIGHT. The point (x,y) corresponds to the center of the right edge of the object's bounding box.
      • LOWER_LEFT. The point (x,y) corresponds to the lower left corner of the object's bounding box.
      • LOWER_CENTER. The point (x,y) corresponds to the center of the lower edge of the object's bounding box.
      • LOWER_RIGHT. The point (x,y) corresponds to the lower right corner of the object's bounding box.
  • If the value of object.type is SEG_CLOSE, no additional parameters may be set.
  • If the value of object.type is SPLINE_POINT, the following parameters may be set:
    • object.x - the spline point's X coordinate.
    • object.y - the spline point's Y coordinate.
  • If the value of object.type is SPLINE_FUNCTION, the following parameters may be set:
    • object.xf - an animation object that is an instance of SimFunction, giving the x coordinate of a point as a function of an argument.
    • object.yf - an animation object that is an instance of SimFunction, giving the y coordinate of a point as a function of an argument.
    • object.t1 - the starting value of the argument for the functions provided by the object.xf and object.yf parameters.
    • object.t1 - the starting value of the argument for the functions provided by the object.xf and object.yf parameters.
    • object.n - the number of points in the interval (t1, t2] at which the functions will be evaluated. The function will also be evaluated at t1.
  • If the value of object.type is SEG_END, the following parameters may be set:
  • If the value of object.type is SEG_END_PREV, no parameters are set, but the preceding key must have set object.type to either SPLINE_POINT or SPLINE_FUNCTION.
  • If the value of object.type is SEG_END_NEXT, no parameters are set, but the next key must set object.type to be either SPLINE_POINT or SPLINE_FUNCTION.
  • If the value of object.type is TEXT, the following parameters may be set:
object.archeight
Rectangle Arc Height
int
double
[-∞, ∞] false set
Y coordinate in graph coordinate space for the height of the arc of a rounded rectangle
object.arcwidth
Rectangle Arc Width
int
double
[-∞, ∞] false set
X coordinate in graph coordinate space for the width of the arc of a rounded rectangle
object.draw
Draw
int
boolean
N/A false set
true if the object should be drawn
object.drawColor
Object-Specific draw Color
int N/A false add
Object-specific drawing color to override the default
object.drawColor.alpha
Alpha
int
java.lang.Integer
[0, 255] false set
The alpha component of the color (0 for transparent to 255 for opaque)
object.drawColor.blue
Blue
int
java.lang.Integer
[0, 255] false set
The blue component of the color (0 for none to 255 for the maximum value)
object.drawColor.css
CSS Color
int
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.
object.drawColor.green
Green
int
java.lang.Integer
[0, 255] false set
The green component of the color (0 for none to 255 for maximum value)
object.drawColor.red
Red
int
java.lang.Integer
[0, 255] false set
The red component of the color (0 for none to 255 for the maximum value)
object.extent
Arc Extent
int
double
[-∞, ∞] false set
Angular extent of an arc (degrees)
This parameter's value is the angular extent of an arc, in units of degrees. The angle for the end point is determined by adding the extent to the starting angle to produce the final angle, which is followed by an affine transformation that skews the angle if the width and height differ.
object.fill
Fill
int
boolean
N/A false set
true if the object should be filled
object.fillColor
Object-Specific fill Color
int N/A false add
Object-specific fill color to override the default
object.fillColor.alpha
Alpha
int
java.lang.Integer
[0, 255] false set
The alpha component of the color (0 for transparent to 255 for opaque)
object.fillColor.blue
Blue
int
java.lang.Integer
[0, 255] false set
The blue component of the color (0 for none to 255 for the maximum value)
object.fillColor.css
CSS Color
int
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.
object.fillColor.green
Green
int
java.lang.Integer
[0, 255] false set
The green component of the color (0 for none to 255 for maximum value)
object.fillColor.red
Red
int
java.lang.Integer
[0, 255] false set
The red component of the color (0 for none to 255 for the maximum value)
object.fontParms
Object-Specific Font Parms
int N/A false add
Object-specific font parameters to override the default
object.fontParms.angle
Rotation Angle
int
double
[-∞, ∞] false set
The angle of rotation from horizontal, counterclockwise in degrees
object.fontParms.baselinePosition
Baseline Position
int
org.bzdev.graphs.Graph.BLineP
N/A false set
Baseline position (TOP, CENTER, BASE, BOTTOM)
This parameter's value is an enumeration constant, defined by org.bzdev.graphs.Graph.BLineP, whose possible values are
  • BASE. The base line of the text is aligned with (x,y) coordinate at which the text is drawn. This is the default.
  • BOTTOM. The bottom of the text is aligned with (x,y) coordinate at which the text is drawn.
  • CENTER. The center of the text is aligned with (x,y) coordinate at which the text is drawn.
  • TOP. The top of the text is aligned with (x,y) coordinate at which the text is drawn.
The text that is drawn is a string fitting on a single line.
object.fontParms.color.alpha
Alpha Component
int
java.lang.Integer
[0, 255] false set
The alpha component of the font color (0 for transparent to 255 for opaque)
object.fontParms.color.blue
Blue Component
int
java.lang.Integer
[0, 255] false set
The blue component of the font color (0 for none to 255 for the maximum value)
object.fontParms.color.css
CSS Specification
int
java.lang.String
N/A false set
The CSS specification for a font 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 subparameters color.red, color.green, color.blue, and color.alpha, when not null, will override the corresponding components of the CSS color.
object.fontParms.color.green
Green Component
int
java.lang.Integer
[0, 255] false set
The green component of the font color (0 for none to 255 for the maximum value)
object.fontParms.color.red
Red Component
int
java.lang.Integer
[0, 255] false set
The red component of the font color (0 for none to 255 for the maximum value)
object.fontParms.justification
Justification
int
org.bzdev.graphs.Graph.Just
N/A false set
Text justification (LEFT, CENTER, RIGHT)
This parameter's value is an enumeration constant, defined by the enumeration type org.bzdev.graphs.Graph.Just, whose possible values are:
  • CENTER. Text will be centered.
  • LEFT. Text will be left justified. This is the default.
  • RIGHT. Text will be right justified.
The justification is relative to the (x,y) coordinates at which a string is drawn.
object.fontParms.name
Font or Font-Family Name
int
java.lang.String
N/A false set
The font or font-family name (e.g., Helvetica)
Valid names for this parameter are the names of a font or a font family as defined by Java. Logical font names (these are mapped by Java into the actual font names) that are always supported are
  • serif.
  • sansserif.
  • monospaced.
  • dialog.
  • dialoginput.
object.fontParms.size
Size
int
int
[1, ∞] false set
The font size (a positive integer)
object.fontParms.style
Style
int
org.bzdev.obnaming.misc.GraphFontParm.FontStyle
N/A false set
The font style (PLAIN, BOLD, BOLD_ITALIC)
This parameter's value is an enumeration constant, defined by org.bzdev.obnaming.misc.GraphFontParm.FontStyle, whose possible values are:
  • BOLD. The text will be drawn using a bold font.
  • BOLD_ITALIC. The text will be drawn using a bold, italic font.
  • ITALIC. The text will be drawn using an italic font.
  • PLAIN. The text will be drawn using a plain font.
object.height
Height of Rectangle/Ellipse
int
double
[-∞, ∞] false set
height in graph coordinate space (ignored for paths)
This parameter's value is the height of an object in graph coordinate space, interpreted on the basis of an object's type.
object.imageAngle
Image Angle
int
double
[-∞, ∞] false set
Angle of rotation for an image in degrees (counterclockwise in graph coordinate space from the positive x axis)
object.imageFlipX
Flip Image For X
int
boolean
N/A false set
Flag indicating if an image's X values are flipped
object.imageFlipY
Flip Image For Y
int
boolean
N/A false set
Flag indicating if an image's Y values are flipped
object.imageInGCS
Image Size in GCS
int
boolean
N/A false set
Flag indicating if the image size is in graph coordinate space units
object.imageScaleX
Image X Scale Factor
int
double
[-∞, ∞] false set
Factor by which to scale an image in the X direction
When the value is 1.0, an image pixel's size in the X direction will be one unit in either graph coordinate space (when object.imageInGCS is true) or user space (when object.imageInGCS is false). To compute the value for the case where object.imageInGCS is true and where the X and Y scale factors are the same, determine the distance between two points on the image in graph-coordinate-space units and divide that distance by the corresponding distance in image-space units.
object.imageScaleY
Image Y Scale Factor
int
double
[-∞, ∞] false set
Factor by which to scale an image in the Y direction
When the value is 1.0, an image pixel's size in the Y direction will be one unit in either graph coordinate space (when object.imageInGCS is true) or user space (when object.imageInGCS is false). To compute the value for the case where object.imageInGCS is true and where the X and Y scale factors are the same, determine the distance between two points on the image in graph-coordinate-space units and divide that distance by the corresponding distance in image-space units.
object.imageURL
Image URL
int
java.lang.String
N/A false set
The URL of an image
object.n
Number of Segments
int
int
[-∞, ∞] false set
Number of segments along a spline (one less than the number of knots)
This parameter's value is used when the parameters object.xf and object.yf are defined. It gives the number of segments between knots in the interval [t1, t2], where t1 is the value of the parameter object.t1 and t2 is the value of the parameter object.t2. The intermediate knots' coordinates are determined by evaluating the functions xf and yf at n-1 points separating n equally-spaced segments. The functions will be evaluated at t1 when the previous descriptor's type is MOVE_TO_NEXT and will be evaluated at t2 when the next descriptor's type is SEG_END_PREV.
object.refPoint
Reference Point
int
org.bzdev.graphs.RefPointName
N/A false set
The reference point relative to an object located at (x,y) - CENTER, UPPER_LEFT, etc)
This parameter's value is a symbolic name for a reference point provided by an enumeration constant defined by the enumeration org.bzdev.graphs.RefPointName:
  • UPPER_LEFT. The reference point is located at the upper left corner of the object's bounding box in graph coordinate space.
  • UPPER_CENTER. The reference point is located at the center of the upper edge of the object's bounding box in graph coordinate space.
  • UPPER_RIGHT. The reference point is located at upper right corner of the object's bounding box in graph coordinate space.
  • CENTER_LEFT. The reference point is located at the center of the left edge of the object's bounding box in graph coordinate space.
  • CENTER. The reference point is located at the center of the object's bounding box in graph coordinate space.
  • CENTER_RIGHT. The reference point is located at the center of the right edge of the object's bounding box in graph coordinate space.
  • LOWER_LEFT. The reference point is located at the lower left corner of the object's bounding box in graph coordinate space.
  • LOWER_CENTER. The reference point is located at the center of the lower edge of the object's bounding box in graph coordinate space.
  • LOWER_RIGHT. The reference point is located at the lower right corner of the object's bounding box in graph coordinate space.
object.shape
int
org.bzdev.anim2d.AnimationShape2D
N/A false set
object.start
Arc Starting Angle
int
double
[-∞, ∞] false set
Starting angle of an arc (degrees)
This parameter's value is the starting angle of an arc in units of degrees, measured counterclockwise. The angle is specified assuming the height and width are the same, and an affine transformation then skews the angle if the width and height differ.
object.stroke
Object-Specific Stroke (indexed)
int N/A false add
Object-specific stroke parameters to override the default
object.stroke.cap
Cap
int
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.
object.stroke.dashIncrement
Dash Increment
int
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.
object.stroke.dashPattern
Dash Pattern
int
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 " ".
object.stroke.dashPhase
Dash Phase
int
double
[-∞, ∞] false set
the offset to the start of the dashing pattern
object.stroke.gcsMode
int
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.
object.stroke.join
Join
int
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.
object.stroke.miterLimit
Miter Limit
int
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.
object.stroke.width
Width
int
double
[-∞, ∞] false set
the line width of a stroke
object.t1
Starting Argument
int
double
[-∞, ∞] false set
Starting argument for functions giving the points along a spline
This parameter will be used when the current descriptor's type is SPLINE_FUNCTION. When the previous descriptor's type is MOVE_TO_NEXT, the functions defined by object.xf and object.yf will be used to compute the coordinates of the first knot. Otherwise the current point set by the previous directive is used.
object.t2
Ending Argument
int
double
[-∞, ∞] false set
Ending argument for functions giving the points along a spline
This parameter will be used when the current descriptor's type is SPLINE_FUNCTION. When the next descriptor's type is SEG_END_PREV, the functions defined by object.xf and object.yf will be used to compute the coordinates of the final knot. Otherwise the point set by a SEG_END directive is used.
object.text
Text
int
java.lang.String
N/A false set
Text to appear at some location in graph coordinate space
object.type
Object Type
int
org.bzdev.anim2d.AnimationLayer2D.Type
N/A false set
The object type (ARC_CHORD, ARC_OPEN, ARC_PIE, CONTROL_POINT, CUBIC_CURVE, ELLIPSE, IMAGE, LINE, MOVE_TO, MOVE_TO_NEXT, PATH_START, PATH_END, QUAD_CURVE, RECTANGLE, ROUND_RECTANGLE, SEG_CLOSE, SPLINE_POINT, SPLINE_FUNCTION SEG_END, SEG_END_PREV, SEG_END_NEXT, TEXT)
This parameter's value is an enumeration constant, used to indicate the type of an object or a descriptor for some feature of an object, and is defined by the enumeration org.bzdev.anim2d.AnimationLayer2D.Type. The value can be one of the following constants:
object.width
Width of Rectangle/Ellipse
int
double
[-∞, ∞] false set
width in graph coordinate space (ignored for paths)
This parameter's value is the width of an object in graph coordinate space, interpreted on the basis of an object's type.
object.windingRule
Winding Rule
int
org.bzdev.geom.SplinePathBuilder.WindingRule
N/A false set
The winding rule for a path (WIND_NON_ZERO, WIND_EVEN_ODD)
This parameter's value is an enumeration constant defined by the enumeration type org.bzdev.geom.SplinePathBuilder.WindingRule:
  • WIND_EVEN_ODD. With this rule, a point is assumed to be in the interior of a path if a line drawn in any direction from that point to infinity is crossed by path segments an odd number of times.
  • WIND_NON_ZERO. With this rule, a point is assumed to be in the interior of a path if a line 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.
These winding rules correspond to the int constants with the same names defined by java.awt.geom.Path2D.
object.x
X Coordinate
int
double
[-∞, ∞] false set
X coordinate in graph coordinate space
This parameter's value provides the X coordinate of an object or a facet of an object. When the parameter's type is one that supports reference points, the location of this coordinate relative to the object is determine by the object's reference point, which can be set using the object.refPoint parameter.
object.xcontrol
X Control Point
int
double
[-∞, ∞] false set
X coordinate in graph coordinate space of the control point (quad curves or path segments)
object.xcontrol1
X Control Point 1
int
double
[-∞, ∞] false set
X coordinate in graph coordinate space of the first control point (cubic curves or path segments)
object.xcontrol2
X Control Point 2
int
double
[-∞, ∞] false set
object.xend
X End of Segment/Line
int
double
[-∞, ∞] false set
X coordinate for the end of a line or path segment in graph coordinate space
object.xf
X Function
int
org.bzdev.devqsim.SimFunction
N/A false set
Function to determine the x coordinate of a point along a spline
This parameter's value is an instance of of org.bzdev.devqsim.SimFunction. The function provides the x coordinate of a point along a spline as a function of an arbitrary parameter t (the same parameter used for object.yf).
object.y
Y Coordinate
int
double
[-∞, ∞] false set
Y coordinate in graph coordinate space
This parameter's value provides the Y coordinate of an object or a facet of an object. When the parameter's type is one that supports reference points, the location of this coordinate relative to the object is determine by the object's reference point, which can be set using the object.refPoint parameter.
object.ycontrol
Y Control Point
int
double
[-∞, ∞] false set
Y coordinate in graph coordinate space of the control point (quad curves or path segments )
object.ycontrol1
Y Control Point 1
int
double
[-∞, ∞] false set
Y coordinate in graph coordinate space of the first control point (cubic curves or path segments)
object.ycontrol2
Y Control Point 2
int
double
[-∞, ∞] false set
object.yend
Y End of Segment/Line
int
double
[-∞, ∞] false set
Y coordinate for the end of a line or path segment in graph coordinate space
object.yf
Y Function
int
org.bzdev.devqsim.SimFunction
N/A false set
Function to determine the y coordinate of a point along a spline
This parameter's value is an instance of of org.bzdev.devqsim.SimFunction. The function provides the x coordinate of a point along a spline as a function of an arbitrary parameter t (the same parameter used for object.xf).
stroke
Default Stroke
(none) N/A false clear
Stoke parameters to use as a default
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.
zorder
Z-Order
long [-∞, ∞] false set
The stacking order - objects with lower values are drawn first.