Parameter methods
The value methods of root parameters.
12 methods: angle, boolean, color, length, lengths, points, face, number, integer, text, url, surface.
angle - Angle
A parameter value in degrees.
role binding, type value, valid on parameters, returns angle, default key angle.
| Arg | Type | Default | Min | Max | Options | Description |
|---|---|---|---|---|---|---|
value | angle | 0 | A parameter value in degrees. |
boolean - Boolean
A true/false parameter value.
role binding, type value, valid on parameters, returns boolean, default key boolean.
| Arg | Type | Default | Min | Max | Options | Description |
|---|---|---|---|---|---|---|
value | boolean | false | A true/false parameter value. |
color - Color
A '#rrggbb' (or '#rrggbbaa') color parameter value.
role binding, type value, valid on parameters, returns color, default key color.
| Arg | Type | Default | Min | Max | Options | Description |
|---|---|---|---|---|---|---|
value | color | '#ffffff' | A '#rrggbb' (or '#rrggbbaa') color parameter value. |
length - Length
A parameter value in millimeters.
role binding, type value, valid on parameters, returns length, default key length.
| Arg | Type | Default | Min | Max | Options | Description |
|---|---|---|---|---|---|---|
value | length | 0 | A parameter value in millimeters. |
lengths - Length List
A list of parameter values, each in millimeters.
role binding, type value, valid on parameters, returns length[], default key lengths.
| Arg | Type | Default | Min | Max | Options | Description |
|---|---|---|---|---|---|---|
value | length[] | [] | A list of parameter values, each in millimeters. |
points - Point List
A list of [x, y, z] points in millimeters, read back as the same nested array.
role binding, type value, valid on parameters, returns point[], default key points.
| Arg | Type | Default | Min | Max | Options | Description |
|---|---|---|---|---|---|---|
value | point[] | [] | A list of [x, y, z] points in millimeters, read back as the same nested array. |
face - Face
One planar face with holes: an array of rings, each ring an array of [x, y, z] rows in millimeters, closed by repeating its first row last (GeoJSON RFC 7946 section 3.1.6). Ring 0 is the outer boundary, the rest are holes inside it. Read back as the same nested array; a curve argument takes it as several closed chains.
role binding, type value, valid on parameters, returns point[][], default key face.
| Arg | Type | Default | Min | Max | Options | Description |
|---|---|---|---|---|---|---|
value | point[][] | [[[0,0,0],[1000,0,0],[1000,1000,0],[0,1000,0],[0,0,0]]] | One planar face with holes: an array of rings, each ring an array of [x, y, z] rows in millimeters, closed by repeating its first row last (GeoJSON RFC 7946 section 3.1.6). Ring 0 is the outer boundary, the rest are holes inside it. Read back as the same nested array; a curve argument takes it as several closed chains. |
number - Number
A dimensionless numeric parameter value.
role binding, type value, valid on parameters, returns number, default key number.
| Arg | Type | Default | Min | Max | Options | Description |
|---|---|---|---|---|---|---|
value | number | 0 | A dimensionless numeric parameter value. |
integer - Integer
A whole-number parameter value; a fraction fails evaluate.
role binding, type value, valid on parameters, returns integer, default key integer.
| Arg | Type | Default | Min | Max | Options | Description |
|---|---|---|---|---|---|---|
value | integer | 0 | A whole-number parameter value; a fraction fails evaluate. |
text - Text
A text parameter value.
role binding, type value, valid on parameters, returns string, default key text.
| Arg | Type | Default | Min | Max | Options | Description |
|---|---|---|---|---|---|---|
value | string | '' | A text parameter value. |
url - URL
The address itself — a 'data:' or 'https:' URI, or blank when unset.
role binding, type value, valid on parameters, returns url, default key url.
| Arg | Type | Default | Min | Max | Options | Description |
|---|---|---|---|---|---|---|
value | url | '' | The address itself — a 'data:' or 'https:' URI, or blank when unset. |
surface - Surface
A NURBS surface value (control net).
role binding, type value, valid on parameters, returns surface, default key surface.
| Arg | Type | Default | Min | Max | Options | Description |
|---|---|---|---|---|---|---|
controlPoints | point[][] | surface | [[[0,0,0],[1000,0,0]],[[0,1000,0],[1000,1000,0]]] | A control net: rows of point rows [x,y,z] in mm (u-index outer, v-index inner), or an existing surface value. | |||
degreeU | integer | 1 | 1 | NURBS degree along U; must be >= 1 and <= the control net's row count minus 1, or evaluate fails loud. | ||
degreeV | integer | 1 | 1 | NURBS degree along V; must be >= 1 and <= the control net's column count minus 1, or evaluate fails loud. | ||
knotsU | number[] | [] | Empty = clamped-uniform. | |||
knotsV | number[] | [] | Empty = clamped-uniform. |