Skip to content
Shapemetry

@huukhanhnguyen/model / nodeMethods/parameter

nodeMethods/parameter

angle()

angle(v): number

Parameters

v

unknown

Returns

number


area()

area(v): number

Parameters

v

unknown

Returns

number


boolean()

boolean(v): boolean

Parameters

v

unknown

Returns

boolean


color()

color(v): string

Parameters

v

unknown

Returns

string


currency()

currency(v): number

Parameters

v

unknown

Returns

number


curve()

curve(controlPoints, degree?): CurveData | null | undefined

Build a curve parameter's value (one CurveData document, whose edges hold the CurveEdge entities) 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 a document
  • a curve document → passthrough
  • a node reference's ObjectData[] (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.

Parameters

controlPoints

unknown

degree?

number = 3

Returns

CurveData | null | undefined


fn()

fn(v): unknown

Parameters

v

unknown

Returns

unknown


font()

font(v): unknown

Parameters

v

unknown

Returns

unknown


group()

group(v): unknown

Parameters

v

unknown

Returns

unknown


length()

length(v): number

Parameters

v

unknown

Returns

number


mass()

mass(v): number

Parameters

v

unknown

Returns

number


model()

model(v): unknown

Parameters

v

unknown

Returns

unknown


number()

number(v): number

Parameters

v

unknown

Returns

number


object()

object(v): unknown

Parameters

v

unknown

Returns

unknown


point()

point(v): [number, number, number]

Parameters

v

unknown

Returns

[number, number, number]


string()

string(v): string

Parameters

v

unknown

Returns

string


surface()

surface(controlPoints, columns?, degreeU?, degreeV?): unknown

Build a surface parameter's value (a NurbsSurface, the Surface.* contract) from its args. controlPoints is the primary arg, multi-form:

  • [[x,y,z], …] flat row-major grid → a NURBS surface of columns per row, degrees degreeU/degreeV (auto-clamped, knots/weights uniform)
  • a raw NurbsSurface (has knotsU) → passthrough A richer surface is built with a producer (patch/nurbsSurface/loft) and referenced — the literal is the simple grid case.

Parameters

controlPoints

unknown

columns?

number = 2

degreeU?

number = 3

degreeV?

number = 3

Returns

unknown


text()

text(v): string

Parameters

v

unknown

Returns

string


vector()

vector(v): [number, number, number]

Parameters

v

unknown

Returns

[number, number, number]


volume()

volume(v): number

Parameters

v

unknown

Returns

number

Last updated: 📖 3 min readEdit on GitHub