Skip to content
Shapemetry

Model - Parameter

API reference for src/nodeMethods/parameter on @huukhanhnguyen/model, reachable from ./compute.

See the Guide for the ModelJSON / evaluate pipeline.

API reference

Signatures are generated from the live package .d.ts - not hand-written.

angle

const

const angle: typeof _huukhanhnguyen_geometry_catalog_vector.angle

boolean

function

boolean(v: unknown): boolean

color

function

color(v: unknown): string

curve

function

Build a curve parameter's value (ONE curve ENTITY, CurveEntity) from its args. controlPoints is the primary arg, multi-form:

  • [[x,y,z], …] point rows → a NURBS curve of the given degree through them (degree auto-clamps to points-1, so a 2-point default is a line)
  • a raw NurbsCurve (has controlPoints) → wrapped as an entity
  • a curve entity → passthrough
  • a node reference's Entity[] (groups baked) → its first curve A richer curve (arc / smooth spline) is built with the matching producer and referenced here — the literal is the simple case.
curve(controlPoints: unknown, degree?: number, definitions?: DefinitionMap): CurveEntity | null | undefined

fn

function

fn(v: unknown): unknown

font

function

font(v: unknown): unknown

group

function

group(v: unknown): unknown

mass

function

mass(v: unknown): number

model

function

model(v: unknown): unknown

object

function

object(v: unknown): unknown

string

function

string(v: unknown): string

surface

namespace

namespace surface

Members: asPaths, hydrateCurves, loft, nurbsSurface, patchFromCorners, patchFromCurve, revolve, surfaceDivide, surfaceValueFromGrid, sweepMorph

text

function

text(v: unknown): string

vector

namespace

namespace vector

Members: add, angle, between, cross, dot, length, normalize, scale, subtract

volume

function

Enclosed volume, mm³ — exact in the kernel when the set bounds a volume, else the mesh partial sum (see module doc); 0 for no faces.

volume(input: unknown): number
Last updated: 📖 1 min readEdit on GitHub