ParaShape

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.

ArgTypeDefaultMinMaxOptionsDescription
valueangle0A parameter value in degrees.

boolean - Boolean

A true/false parameter value.

role binding, type value, valid on parameters, returns boolean, default key boolean.

ArgTypeDefaultMinMaxOptionsDescription
valuebooleanfalseA 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.

ArgTypeDefaultMinMaxOptionsDescription
valuecolor'#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.

ArgTypeDefaultMinMaxOptionsDescription
valuelength0A 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.

ArgTypeDefaultMinMaxOptionsDescription
valuelength[][]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.

ArgTypeDefaultMinMaxOptionsDescription
valuepoint[][]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.

ArgTypeDefaultMinMaxOptionsDescription
valuepoint[][][[[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.

ArgTypeDefaultMinMaxOptionsDescription
valuenumber0A 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.

ArgTypeDefaultMinMaxOptionsDescription
valueinteger0A 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.

ArgTypeDefaultMinMaxOptionsDescription
valuestring''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.

ArgTypeDefaultMinMaxOptionsDescription
valueurl''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.

ArgTypeDefaultMinMaxOptionsDescription
controlPointspoint[][] | 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.
degreeUinteger11NURBS degree along U; must be >= 1 and <= the control net's row count minus 1, or evaluate fails loud.
degreeVinteger11NURBS degree along V; must be >= 1 and <= the control net's column count minus 1, or evaluate fails loud.
knotsUnumber[][]Empty = clamped-uniform.
knotsVnumber[][]Empty = clamped-uniform.

Edit on GitHub