Factory:org.bzdev.roadanim.BicycleFactory
Parameter Types
(optional keytype)
(value type)
Range RV Mode Add/Set
bicycleColor
Bicycle Color
(none) N/A false clear
The bicycle color
The bicycle color uses several subparameters: bicycleColor.red, bicycleColor.green,and bicycleColor.red. These set the color used for a bicycle.
bicycleColor.alpha
Alpha
java.lang.Integer [0, 255] false set
The alpha component of the color (0 for transparent to 255 for opaque)
bicycleColor.blue
Blue
java.lang.Integer [0, 255] false set
The blue component of the color (0 for none to 255 for the maximum value)
bicycleColor.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.
bicycleColor.green
Green
java.lang.Integer [0, 255] false set
The green component of the color (0 for none to 255 for maximum value)
bicycleColor.red
Red
java.lang.Integer [0, 255] false set
The red component of the color (0 for none to 255 for the maximum value)
bikeHead
bike Head Distance
double (0.0, ∞] false set
The distance in meters from the helmet to the far end of the front wheel
bikeTail
bike Tail Distance
double (0.0, ∞] false set
The distance in meters from the helmet to the far end of the rearwheel
bikeWidth
Bicycle Tubing width
double (0.0, ∞] false set
The width in meters for the bicycle tubing.
handlebarHalfLength
Handlebar Half Length
double (0.0, ∞] false set
The distance from the bicycle axis to the start of the handle bar's tail
handlebarPosition
Handlebar Position
java.lang.Double (0.0, ∞] false set
The distance in meters from the helmet to the center of the handlebars
handlebarTail
HandleBar Tail
double (0.0, ∞] false set
The length in meters of a rectangle representing the portion of the handlebars parallel to the bicycle's axis
helmetAngle
Helmet Angle
double [-∞, ∞] false set
The angle in radians between the axes of the helmet and bicycle, measured counterclockwise
helmetColor
Helmet Color
(none) N/A false clear
The helmet color
The helmet color uses several subparameters: helmetColor.red, helmetColor.green,and helmetColor.red. These set the color provided for a bicycle helmet.
helmetColor.alpha
Alpha
java.lang.Integer [0, 255] false set
The alpha component of the color (0 for transparent to 255 for opaque)
helmetColor.blue
Blue
java.lang.Integer [0, 255] false set
The blue component of the color (0 for none to 255 for the maximum value)
helmetColor.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.
helmetColor.green
Green
java.lang.Integer [0, 255] false set
The green component of the color (0 for none to 255 for maximum value)
helmetColor.red
Red
java.lang.Integer [0, 255] false set
The red component of the color (0 for none to 255 for the maximum value)
helmetScaleFactor
Helmet Scale Factor
double (0.0, ∞] false set
The factor by which to multiple the default helmet dimensions.
The typical use is to increase the size of the helmet if the default is hard to see due to the scale chosen for an animation's graph. The default represents typical helmet sizes. This value also affects the font size for the string provided by the lookString parameter. Values above roughly 1.5 will result in a helmet appearing noticably out of scale.
initialAngle
Initial Angle
double [-∞, ∞] false set
The initial angle in degrees
The value of this parameter is the initial angle in graph coordinate space, measured in degrees. Positive values are counterclockwise in graph coordinate space.
initialX
Initial X Coordinate
double [-∞, ∞] false set
The initial X coordinate
The value of this parameter is the initial X coordinate in graph coordinate space units.
initialY
Initial Y Coordinate
double [-∞, ∞] false set
The initial Y coordinate
The value of this parameter is the initial Y coordinate in graph coordinate space units.
lookString
Look String
java.lang.String N/A false set
The string to display when the parameter looking has the value "true"
lookStringScaleFactor
Look-String Scale Factor
double (1.0, ∞] false set
The scale factor to apply to the font used to display the string provided by the parameter lookString
The default value is 1.0. In some cases, even with a value of helmetScaleFactor that is larger than 1.0, the string may be hard to read. This parameter will scale the font size used to display the string in order to increase the size further.
looking
Looking
boolean N/A false set
True if the string defined by the parameter lookString should be displayed; false otherwise
When set to true, the text that will then be displayed will appear in front of the helmet icon, which in most cases will have been rotated to show the direction in which a bicyclist is looking. The text is rotated as well.
lookingFontColor
Look-String Font Color
(none) N/A false clear
The font color to use for the string defined by the parameter lookString
This font color has several subparameters: lookingFontColor.red, lookingFontColor.green,and helmetColor.red and applies only to the text displayed when the parameter looking has the value true.
lookingFontColor.alpha
Alpha
java.lang.Integer [0, 255] false set
The alpha component of the color (0 for transparent to 255 for opaque)
lookingFontColor.blue
Blue
java.lang.Integer [0, 255] false set
The blue component of the color (0 for none to 255 for the maximum value)
lookingFontColor.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.
lookingFontColor.green
Green
java.lang.Integer [0, 255] false set
The green component of the color (0 for none to 255 for maximum value)
lookingFontColor.red
Red
java.lang.Integer [0, 255] false set
The red component of the color (0 for none to 255 for the maximum value)
refPointFractX
RefPoint X Fraction
double [0.0, 1.0] false set
The X position of the reference point as a fraction of the bounding box of the object
This parameter's value is the X position of the reference point as a fractional distance between the smallest X value of the object's bounding box and the largest X value of the object's bounding box, with the smallest value indicated by 0.0 and the largest value by 1.0.
refPointFractY
RefPoint Y Fraction
double [0.0, 1.0] false set
The Y position of the reference point as a fraction of the bounding box of the object
This parameter's value is the Y position of the reference point as a fractional distance between the smallest Y value of the object's bounding box and the largest Y value of the object's bounding box, with the smallest value indicated by 0.0 and the largest value by 1.0.
refPointMode
RefPoint Configuration Mode
org.bzdev.anim2d.PlacedObject2DFactory.RefPointMode N/A false set
Configuration mode (BY_NAME, BY_COORD, or BY_FRACTION)
This parameter's value is an enumeration constant defined by org.bzdev.anim2d.PlacedObject2DFactory.RefPointMode:
refPointName
RefPoint Name
org.bzdev.graphs.RefPointName N/A false set
The RefPoint name (CENTER, UPPER_LEFT, UPPER_CENTER, UPPER_RIGHT, LOWER_LEFT, LOWER_CENTER, LOWER_RIGHT)
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.
refPointX
RefPoint X Coordinate
double [-∞, ∞] false set
The X coordinate of the reference point (graph coordinate space units) when an object is drawn at (0.0, 0.0)
This parameter's value is the X coordinate of the reference point in graph coordinate space (the default is 0.0, and by convention should correspond to a centered object or some distinguished feature). The object will be drawn at this point when given coordinates of (0,0, 0.0) in graph coordinate space.
refPointY
RefPoint Y Coordinate
double [-∞, ∞] false set
The Y coordinate of the reference point (graph coordinate space units) when an object is drawn at (0.0, 0.0)
This parameter's value is the Y coordinate of the reference point in graph coordinate space (the default is 0.0, and by convention should correspond to a centered object or some distinguished feature). The object will be drawn at this point when given coordinates of (0,0, 0.0) in graph coordinate space.
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.acceleration
Acceleration
int
java.lang.Double
[-∞, ∞] false set
The acceleration of an object while the object has a path
This parameter's value is the acceleration of an object (unit distance per second squared) while the object has a path.
timeline.angle
Angle
int
java.lang.Double
[-∞, ∞] false set
The angle in degrees, measured counterclockwise from the positive x axis
timeline.angleFunction
Angle Function
int
org.bzdev.devqsim.SimFunction
N/A false set
the angle as a function of time while the object has a path
the angle as a function of time while the object has a path To remove an angle function, set it to animation.nullFunction() where animation is the animation associated with this factory. The argument for this function is the time measured from the time set by the value of the parameter timeline.time0. When an angle function is provided, the parameters providing a angular velocity and acceleration are ignored, and the object's angular velocity and position are updated based on the derivatives of the function (if not provided, a value is set to Double.NaN).
timeline.angleRelative
Angle Relative
int
java.lang.Boolean
N/A false set
The angle-relative flag.
When this parameter's value is true, the path angle is assumed to be the angle relative to the path (i.e., measured with respect to a tangent vector for the path). When this parameter's value is false, the angle is measured relative to the X axis in graph coordinate space.
timeline.angularAcceleration
Angular Acceleration
int
java.lang.Double
[-∞, ∞] false set
The angular Acceleration while the object has a path
This parameter's value provides the angular acceleration in degrees per second squared while the object has a path.
timeline.angularVelocity
Angular Velocity
int
java.lang.Double
[-∞, ∞] false set
The angular velocity while the object has a path
This parameter's value provides the angular velocity in degrees/second while the object has a path.
timeline.distanceFunction
Distance Function
int
org.bzdev.devqsim.SimFunction
N/A false set
The distance along the path as a function of time
This parameter provides a function that determines the distance along the path as a function of time. To remove a distance function, set it to animation.nullFunction() where animation is the animation associated with this factory. The argument for this function is the time measured from the time set by the value of the parameter timeline.time0. When a distance function is provided, the parameters providing a velocity and acceleration are ignored, and the object's velocity and position are updated based on the derivatives of the function (if not provided, a value is set to Double.NaN).
timeline.helmetAngle
Helmet Angle
int
java.lang.Double
[-∞, ∞] false set
The angle, measured counterclockwise in degrees, that the helmet makes with the bicycle
When not defined at a particular time, the previous value of timeline.helmetAngle, or helmetAnlge if no value has been provided for a previous time, is used.
timeline.lookString
Look String
int
java.lang.String
N/A false set
The string to display when the timeline.lookString parameter the value true
When not defined at a particular time, the previous value of timeline.lookString, or lookString if no value has been provided for a previous time, is used.
timeline.looking
Looking
int
java.lang.Boolean
N/A false set
True when the timeline.lookString parameter should be displayed; false otherwise
When set to true at a particular time, the text that will then be displayed will appear in front of the helmet icon, which in most cases will have been rotated to show the direction in which a bicyclist is looking. The text is rotated as well. When not defined, the previous value of timeline.looking, or looking if no value has been provided for a previous time, is used.
timeline.lookingFontColor
int N/A false add
timeline.lookingFontColor.alpha
Alpha Look-String Color Component
int
java.lang.Integer
[0, 255] false set
The alpha component of the timeline.lookString color (0 for none to 255 for the maximum value)
When not provided at a particular time, there are two cases:
timeline.lookingFontColor.blue
Blue Look-String Color Component
int
java.lang.Integer
[0, 255] false set
The blue component of the timeline.lookString color (0 for none to 255 for the maximum value)
When not provided at a particular time, there are two cases:
  • If timeline.lookingFontColor.alph timeline.lookingFontColor.GREEN, and timeline.lookingFontColor.BLUE are not provided, the previous value, or previously defined color, is used.
  • If at least one of timeline.lookingFontColor.red timeline.lookingFontColor.GREEN, or timeline.lookingFontColor.BLUE are provided, a default green value of 0 is used.
timeline.lookingFontColor.green
Green Look-String Color Component
int
java.lang.Integer
[0, 255] false set
The green component of the timeline.lookString color (0 for none to 255 for the maximum value)
When not provided at a particular time, there are two cases:
timeline.lookingFontColor.red
Red Look-String Color Component
int
java.lang.Integer
[0, 255] false set
<html The red component of the <CODE>timeline.lookString</CODE> color <br> (0 for none to 255 for the maximum value)</html>
When not provided at a particular time, there are two cases:
timeline.path
Path
int
org.bzdev.anim2d.AnimationPath2D
N/A false set
The path to follow
This parameter's value provides the path an object will follow. To indicate that no path is to be used, set this parameter to amimation.nullPath(), where animation is the instance of org.bzdev.anim2d.Animation2D associated with this factory. The path is a parametrized path with the path parameter usually being denoted by the variable u.
timeline.pathAngle
Angle
int
java.lang.Double
[-∞, ∞] false set
The angle of the object while the object has a path
This parameter provides the angle for an object in units of degrees. The interpretation of the angle is set by the value of timeline.angleRelative.
timeline.t0
int
double
[-∞, ∞] false set
the interval to wait before motion on the path starts
This parameter's value is the time to wait from the time for this timeline entry (the value of the parameter timeline.time) before motion along a path starts.
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.u0
Initial Parameter Value
int
double
[-∞, ∞] false set
the initial value of the path's parameter
This parameter's value is the initial value of the path's path parameter.
timeline.velocity
Velocity
int
java.lang.Double
[-∞, ∞] false set
The velocity of an object while the object has a path
This parameter's value is the velocity of an object (unit distance per second) while the object has a path.
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.x
X Coordinate
int
java.lang.Double
[-∞, ∞] false set
The x coordinate for a timeline entry
timeline.y
Y Coordinate
int
java.lang.Double
[-∞, ∞] false set
The y coordinate for a timeline entry
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.