Factory: | org.bzdev.anim2d.AnimationPath2DFactory | |||||
---|---|---|---|---|---|---|
Parameter | Types (optional keytype) (value type) |
Range | RV Mode | Add/Set | ||
|
(none) | N/A | false | clear | ||
The color | ||||||
Clearing this parameter restores the default. Its subparameters determine the color. | ||||||
|
java.lang.Integer | [0, 255] | false | set | ||
The alpha component of the color (0 for transparent to 255 for opaque) | ||||||
|
java.lang.Integer | [0, 255] | false | set | ||
The blue component of the color (0 for none to 255 for the maximum value) | ||||||
|
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:
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. | ||||||
|
java.lang.Integer | [0, 255] | false | set | ||
The green component of the color (0 for none to 255 for maximum value) | ||||||
|
java.lang.Integer | [0, 255] | false | set | ||
The red component of the color (0 for none to 255 for the maximum value) | ||||||
|
int | N/A | false | add | ||
A table of points along the path | ||||||
This parameter can be used directly to remove all entries associated with a key or to clear all the keys. The table consists of a sequence of descriptors, each with a type. Specific subparameters go with each of these types, and only specific sequences are allowed:
| ||||||
|
int int |
[-∞, ∞] | false | set | ||
Number of segments between points at which functions are evaluated | ||||||
The value of this parameter is an integer giving the number of segments between the values at which the functions provided by the parameters xf and yf are evaluated. The number of segments is one less than the number of points. | ||||||
|
int double |
[-∞, ∞] | false | set | ||
Starting argument for functions giving the points along a spline | ||||||
The value of this parameter is an arbitrary real number. The arguments to the functions provided by the xf and yf parameters will vary from the value of the parameter t1 to the value of the parameter t2. | ||||||
|
int double |
[-∞, ∞] | false | set | ||
Ending argument for functions giving the points along a spline | ||||||
The value of this parameter is an arbitrary real number. The arguments to the functions provided by the xf and yf parameters will vary from the value of the parameter t1 to the value of the parameter t2. | ||||||
|
int org.bzdev.geom.SplinePathBuilder.CPointType |
N/A | false | set | ||
the type of a path entry - an enumeration constant MOVE_TO, MOVE_TO_NEXT, CONTROL, SPLINE, SPLINE_FUNCTION, SEG_END, SEG_END_PREV, SEG_END_NEXT, or CLOSE defined by SplinePathBuilder.CPointType | ||||||
The value of this parameter is an enumeration constant defined by the enumeration type org.bzdev.geom.SplinePathBuilder.CPointType :
| ||||||
|
int double |
[-∞, ∞] | false | set | ||
The X component of a point in graph-coordinate space units | ||||||
This parameter is used when the type parameter has the value MOVE_TO, CONTROL, SPLINE, and SEG_END | ||||||
|
int org.bzdev.obnaming.NamedFunctionOps |
N/A | false | set | ||
Function to determine the x coordinate of a point along a spline | ||||||
The parameter is an object implementing the NamedFunctionOps interface, and returns a value in graph coordinate space units. The argument to the function is a path parameter. Such objects include org.bzdev.devqsim.SimFunction . | ||||||
|
int double |
[-∞, ∞] | false | set | ||
The Y component of a point in graph coordinate space units | ||||||
This parameter is used when the type parameter has the value MOVE_TO, CONTROL, SPLINE, and SEG_END) | ||||||
|
int org.bzdev.obnaming.NamedFunctionOps |
N/A | false | set | ||
Function to determine the y coordinate of a point along a spline | ||||||
The parameter is an object implementing the NamedFunctionOps interface, and returns a value in graph coordinate space units. The argument to the function is a path parameter. Such objects include org.bzdev.devqsim.SimFunction . | ||||||
|
double | [-∞, ∞] | false | set | ||
The radius of circles indicating segment end points | ||||||
The value is expressed in user-space units, with a default value of 5.0. If a path is drawn with abnormally thick lines, a larger radius may be needed. This parameter is used in conjunction with the showSegments parameter. It's primary use is for debugging or testing. | ||||||
|
boolean | N/A | false | set | ||
A flag indicating if segment end points should be shown | ||||||
This parameter by default has the value false . Setting it to true is useful in some cases because the end points of segments occur at integral values of the path parameter. The coordinates of these end points are listed in order by the array used to configure the cpoint parameters. | ||||||
|
(none) | N/A | false | clear | ||
The stroke (a basic stroke) | ||||||
Clearing this parameter restores the default. Its subparameters determine the stroke's properties. | ||||||
|
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 :
| ||||||
|
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 . | ||||||
|
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 " ". | ||||||
|
double | [-∞, ∞] | false | set | ||
the offset to the start of the dashing pattern | ||||||
|
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. | ||||||
|
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 :
| ||||||
|
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. | ||||||
|
double | [-∞, ∞] | false | set | ||
the line width of a stroke | ||||||
|
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. | ||||||
|
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). | ||||||
|
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:
| ||||||
|
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. | ||||||
|
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. | ||||||
|
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. | ||||||
|
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. | ||||||
|
boolean | N/A | false | set | ||
The visibility flag - objects with this set to false are invisible. | ||||||
|
org.bzdev.geom.SplinePathBuilder.WindingRule | N/A | false | set | ||
The winding rule (WIND_EVEN_ODD or WIND_NON_ZERO); clearing restores the default | ||||||
This parameter's value is an enumeration constant defined by the enumeration type org.bzdev.geom.SplinePathBuilder.WindingRule :
int constants with the same names defined by java.awt.geom.Path2D . | ||||||
|
long | [-∞, ∞] | false | set | ||
The stacking order - objects with lower values are drawn first. |