ParaShape

Expression vocabulary

The expression vocabulary the engine accepts, as the engine reports it. Grammar and semantics: Parameters and expressions.

Namespaces

Static namespaces, PascalCase. Each function is called as Namespace.function(...).

Point

  • Point.distance(from: point, to: point) -> number
  • Point.midpoint(from: point, to: point) -> point
  • Point.interpolate(from: point, to: point, fraction: number) -> point
  • Point.translate(point: point, offset: vector) -> point

Vector

  • Vector.length(vector: vector) -> number
  • Vector.normalize(vector: vector) -> vector
  • Vector.dot(a: vector, b: vector) -> number
  • Vector.cross(a: vector, b: vector) -> vector
  • Vector.angle(a: vector, b: vector) -> number
  • Vector.add(a: vector, b: vector) -> vector
  • Vector.subtract(a: vector, b: vector) -> vector
  • Vector.scale(vector: vector, factor: number) -> vector
  • Vector.fromTo(from: point, to: point) -> vector

Plane

  • Plane.fromPointNormal(point: point, normal: vector) -> plane
  • Plane.point(plane: plane) -> point
  • Plane.normal(plane: plane) -> vector
  • Plane.distance(plane: plane, queryPoint: point) -> number

Line

  • Line.fromPointDirection(origin: point, direction: vector) -> line
  • Line.fromTwoPoints(fromPoint: point, toPoint: point) -> line
  • Line.origin(line: line) -> point
  • Line.direction(line: line) -> vector
  • Line.pointAt(line: line, distance: number) -> point

Transformation

  • Transformation.translation(vector: vector) -> transform
  • Transformation.rotation(axis: line, angle: number) -> transform
  • Transformation.scaling(sx: number, sy: number, sz: number) -> transform
  • Transformation.compose(a: transform, b: transform) -> transform
  • Transformation.invert(matrix: transform) -> transform
  • Transformation.apply(matrix: transform, point: point) -> point
  • Transformation.applyVector(matrix: transform, vector: vector) -> vector

Color

  • Color.mix(from: color, to: color, fraction?: number) -> color
  • Color.darken(color: color, step?: number) -> color
  • Color.lighten(color: color, step?: number) -> color
  • Color.saturate(color: color, step?: number) -> color
  • Color.rotate(color: color, degrees?: number) -> color
  • Color.hsl(hue: number, saturation?: number, lightness?: number) -> color
  • Color.rgb(red: number, green: number, blue: number) -> color
  • Color.alpha(color: color, value: number) -> color
  • Color.contrast(background: color, dark?: color, light?: color) -> color
  • Color.luminance(color: color) -> number

Format

  • Format.currency(value: number, code?: string, locale?: string) -> string
  • Format.number(value: number, decimals?: number, locale?: string) -> string
  • Format.percent(value: number, decimals?: number, locale?: string) -> string
  • Format.date(value: number | string, locale?: string, style?: string) -> string

Arc

  • Arc.fromCenter(center: point, normal: vector, radius: number, startAngle: number, endAngle: number) -> curve
  • Arc.threePoints(startPoint: point, middlePoint: point, endPoint: point) -> curve
  • Arc.tangentEnd(startPoint: point, tangent: vector, endPoint: point) -> curve

Ellipse

  • Ellipse.fromCenter(center: point, normal: vector, radiusX: number, radiusY: number, xAxis: vector, startAngle: number, endAngle: number) -> curve

Bezier

  • Bezier.cubic(startPoint: point, control1Point: point, control2Point: point, endPoint: point) -> curve
  • Bezier.quadratic(startPoint: point, controlPoint: point, endPoint: point) -> curve

Nurbs

  • Nurbs.curve(points: point[], degree: number, knots: number[], weights: number[]) -> curve

Spline

  • Spline.through(points: point[], degree?: number, closed?: boolean) -> curve

Property

  • Property.parent(name: string) -> number
  • Property.animate(name: string, seconds: number, values: array) -> action
  • Property.set(name: string, values: array) -> action

Builtins

Math

  • Math.abs(value: number) -> number
  • Math.sign(value: number) -> number
  • Math.floor(value: number) -> number
  • Math.ceil(value: number) -> number
  • Math.round(value: number) -> number
  • Math.trunc(value: number) -> number
  • Math.fround(value: number) -> number
  • Math.clz32(value: number) -> number
  • Math.imul(a: number, b: number) -> number
  • Math.sqrt(value: number) -> number
  • Math.cbrt(value: number) -> number
  • Math.exp(value: number) -> number
  • Math.expm1(value: number) -> number
  • Math.log(value: number) -> number
  • Math.log2(value: number) -> number
  • Math.log10(value: number) -> number
  • Math.log1p(value: number) -> number
  • Math.sin(value: number) -> number
  • Math.cos(value: number) -> number
  • Math.tan(value: number) -> number
  • Math.asin(value: number) -> number
  • Math.acos(value: number) -> number
  • Math.atan(value: number) -> number
  • Math.sinh(value: number) -> number
  • Math.cosh(value: number) -> number
  • Math.tanh(value: number) -> number
  • Math.asinh(value: number) -> number
  • Math.acosh(value: number) -> number
  • Math.atanh(value: number) -> number
  • Math.atan2(y: number, x: number) -> number
  • Math.pow(base: number, exponent: number) -> number
  • Math.min(values?: number) -> number
  • Math.max(values?: number) -> number
  • Math.hypot(values?: number) -> number
  • Math.random() -> number

Number

  • Number.isInteger(value: any) -> boolean
  • Number.isFinite(value: any) -> boolean
  • Number.isNaN(value: any) -> boolean
  • Number.parseFloat(text?: string) -> number
  • Number.parseInt(text?: string, radix?: number) -> number

Object

  • Object.keys(object?: object) -> array
  • Object.values(object?: object) -> array
  • Object.entries(object?: object) -> array

Array

  • Array.from(source?: array, mapFn?: function) -> array

Global

  • Global.isNaN(value?: number) -> boolean
  • Global.parseFloat(text?: string) -> number
  • Global.parseInt(text?: string, radix?: number) -> number
  • Global.Number(value?: number) -> number
  • Global.String(value?: string) -> string
  • Global.Boolean(value?: boolean) -> boolean
  • Global.Array(values?: any) -> array

Constants

  • Math.PI = 3.141592653589793
  • Math.E = 2.718281828459045
  • Math.LN2 = 0.6931471805599453
  • Math.LN10 = 2.302585092994046
  • Math.LOG2E = 1.4426950408889634
  • Math.LOG10E = 0.4342944819032518
  • Math.SQRT2 = 1.4142135623730951
  • Math.SQRT1_2 = 0.7071067811865476
  • Number.MAX_SAFE_INTEGER = 9007199254740991
  • Number.MIN_SAFE_INTEGER = -9007199254740991
  • Number.MAX_VALUE = 1.7976931348623157e+308
  • Number.MIN_VALUE = 2.2250738585072014e-308
  • Number.EPSILON = 2.220446049250313e-16
  • Number.POSITIVE_INFINITY = null
  • Number.NEGATIVE_INFINITY = null
  • Number.NaN = null

Array methods

  • .map(callback: function) -> array
  • .filter(callback: function) -> array
  • .reduce(callback: function, initialValue?: any) -> any
  • .find(callback: function) -> any
  • .findIndex(callback: function) -> number
  • .some(callback: function) -> boolean
  • .every(callback: function) -> boolean
  • .includes(searchElement?: any) -> boolean
  • .indexOf(searchElement?: any) -> number
  • .slice(start?: number, end?: number) -> array
  • .concat(values?: any) -> array
  • .join(separator?: string) -> string
  • .flat(depth?: number) -> array
  • .at(index?: number) -> any
  • .reverse() -> array

String methods

  • .charAt(index?: number) -> string
  • .at(index?: number) -> any
  • .indexOf(searchValue?: string) -> number
  • .slice(start?: number, end?: number) -> string
  • .split(separator?: string) -> array
  • .includes(searchValue?: string) -> boolean
  • .startsWith(searchValue?: string) -> boolean
  • .endsWith(searchValue?: string) -> boolean
  • .toUpperCase() -> string
  • .toLowerCase() -> string
  • .trim() -> string
  • .trimStart() -> string
  • .trimEnd() -> string
  • .replace(pattern?: string, replacement?: string) -> string
  • .replaceAll(pattern?: string, replacement?: string) -> string
  • .repeat(count?: number) -> string
  • .padStart(targetLength?: number, padString?: string) -> string
  • .padEnd(targetLength?: number, padString?: string) -> string
  • .concat(values?: any) -> string

Properties, keywords, operators and budgets

  • Properties: array.length -> number; string.length -> number
  • Keywords: true, false, null, undefined
  • Binary operators, lowest to highest precedence: || (2), && (3), == (4), === (4), != (4), !== (4), < (5), <= (5), > (5), >= (5), + (6), - (6), * (7), / (7), % (7), ** (8, right-associative)
  • Unary operators: +, -, !, ~
  • Fields of a component readable as key.<field>: materials, layers, patterns, options
  • Shadings: wireframe, shaded, realistic, xray
  • Budgets: evalStepBudget = 100000, maxArrayLength = 1000000, maxCallDepth = 64, exprMaxAstDepth = 100, exprMaxLength = 8000

Edit on GitHub