Model - Other#

API reference for 101 public exports whose source module the bundled .d.ts does not carry — mostly compute catalog namespace objects.

See the Guide for the ModelJSON / evaluate pipeline.

API reference#

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

add#

const

const add: typeof _huukhanhnguyen_geometry_catalog_vector.add

add3D#

const

const add3D: typeof add3D

alpha#

const

const alpha: typeof _huukhanhnguyen_geometry_catalog_colorValue.alpha

annotation#

namespace

namespace annotation

Members: BUILTIN_ANNOTATION_STYLE, BUILTIN_TEXT_STYLE, centerMark, dimensionAngular, dimensionLinear, dimensionRadial, drawAngularDimension, drawLeader, drawLinearDimension, drawRadialDimension, formatDimension, imageEntity, leader, resolveStyles, resolveStylesForMethod, resolveTextStyle, textEntity

apply#

const

const apply: typeof apply

asShapes#

function

asShapes(input: unknown): ShellEntity[]

axis#

namespace

namespace axis

Members: direction, fromPointDirection, fromTwoPoints, origin, pointAt

between#

const

const between: typeof _huukhanhnguyen_geometry_catalog_vector.between

boundsValue#

namespace

namespace boundsValue

Members: center, point, size

chainCutLoops#

const

const chainCutLoops: typeof chainCutLoops

clipMeshToPlane#

const

const clipMeshToPlane: typeof clipMeshToPlane

clipPolygonToWindow#

const

const clipPolygonToWindow: typeof clipPolygonToWindow

clipSegmentToLoops#

const

const clipSegmentToLoops: typeof clipSegmentToLoops

clipSegmentToWindow#

const

const clipSegmentToWindow: typeof clipSegmentToWindow

colorValue#

namespace

namespace colorValue

Members: alpha, contrast, darken, hsl, lighten, luminance, mix, rgb, rotate, saturate

compose#

const

const compose: typeof compose

contrast#

const

const contrast: typeof _huukhanhnguyen_geometry_catalog_colorValue.contrast

cross#

const

const cross: typeof _huukhanhnguyen_geometry_catalog_vector.cross

darken#

const

const darken: typeof _huukhanhnguyen_geometry_catalog_colorValue.darken

DEFAULT_SET_SHEET#

const

const DEFAULT_SET_SHEET: { width: 420

deform#

namespace

namespace deform

Members: bend, taper, twist

direction#

const

const direction: typeof direction

displacement#

namespace

namespace displacement

Members: displaceEntities

distance#

const

const distance: typeof distance

dot#

const

const dot: typeof _huukhanhnguyen_geometry_catalog_vector.dot

dot3D#

const

const dot3D: typeof dot3D

entity#

namespace

namespace entity

Members: applyLabel, applyLocked, applyPoint, applyVector, applyVisible, attribute, curveSelfUnion, entitiesBoundingBox, flatten, flattenToXY, flip, keepEntities, layer, material, move, moveMatrix, reflectionMatrix, resize, reverse, rotate, rotateMatrix, solidSelfUnion, transformEntity, vertexDelete, vertexMove, vertexRotate, vertexScale, view

face#

namespace

namespace face

Members: asPaths, asShapes, coplanarGroups, faceOffset, faceTrim, fill, fromPath2d, groupedThickenPaths, newellNormal, planarIntersect, planarOffsetAll, planarSubtract, planarUnion, planarUnionAll, planarUnionRegions, planeMatrix, planeNormal, reverseShape, straightSkeleton, thickenPaths, toPath2d, toPolylines3D

faceValue#

namespace

namespace faceValue

Members: area, centroid, contains, normal

fitLine#

const

const fitLine: typeof _huukhanhnguyen_geometry_catalog_statValue.fitLine

formatValue#

namespace

namespace formatValue

Members: currency, date, formatDimension, number, percent

forwardOf#

const

const forwardOf: typeof forwardOf

fromAxisAngle#

const

const fromAxisAngle: typeof fromAxisAngle

fromEuler#

const

const fromEuler: typeof fromEuler

fromPointDirection#

const

const fromPointDirection: typeof fromPointDirection

fromPointNormal#

const

const fromPointNormal: typeof fromPointNormal

fromTwoPoints#

const

const fromTwoPoints: typeof fromTwoPoints

hsl#

const

const hsl: typeof _huukhanhnguyen_geometry_catalog_colorValue.hsl

hydrateCurves#

function

hydrateCurves(input: unknown): NurbsCurve[]

identity#

const

const identity: typeof identity

interpolate#

const

const interpolate: typeof interpolate

invert#

const

const invert: typeof invert

length3D#

const

const length3D: typeof length3D

lighten#

const

const lighten: typeof _huukhanhnguyen_geometry_catalog_colorValue.lighten

luminance#

const

const luminance: typeof _huukhanhnguyen_geometry_catalog_colorValue.luminance

max#

const

const max: typeof _huukhanhnguyen_geometry_catalog_statValue.max

mean#

const

const mean: typeof _huukhanhnguyen_geometry_catalog_statValue.mean

median#

const

const median: typeof _huukhanhnguyen_geometry_catalog_statValue.median

mesh#

namespace

namespace mesh

Members: chunkTriangleIndices, computeVertexNormals, faceToMesh, meshFacesToTriangles, meshLattice, meshSubdivision, placeMesh

midpoint#

const

const midpoint: typeof midpoint

min#

const

const min: typeof _huukhanhnguyen_geometry_catalog_statValue.min

mix#

const

const mix: typeof _huukhanhnguyen_geometry_catalog_colorValue.mix

multiply#

const

const multiply: typeof multiply

noiseValue#

namespace

namespace noiseValue

Members: fbm, perlin, turbulence, worley

normalize#

const

const normalize: typeof _huukhanhnguyen_geometry_catalog_vector.normalize

origin#

const

const origin: typeof origin

parameter#

namespace

namespace parameter

Members: angle, area, boolean, color, currency, curve, fn, font, group, length, mass, model, number, object, point, string, surface, text, vector, volume

parseMutable#

const

Parse OUTSIDE the shared cache — for callers that mutate the tree.

const parseMutable: (expr: string) => Expression

percentile#

const

const percentile: typeof _huukhanhnguyen_geometry_catalog_statValue.percentile

perlin#

const

const perlin: typeof _huukhanhnguyen_geometry_catalog_noiseValue.perlin

planarization#

namespace

namespace planarization

Members: facePlanarize

plane#

namespace

namespace plane

Members: distance, fromPointNormal, normal, point

planeMatrix#

function

planeMatrix(face: ShellEntity): Transformation$1

planeNormal#

function

planeNormal(face: ShellEntity): Point$1

pointCloudValue#

namespace

namespace pointCloudValue

Members: bounds, centroid, cluster, convexHull, downsample, fitPlane, nearest, normals, principalAxes

pointInLoops#

const

const pointInLoops: typeof pointInLoops

PRINCIPAL_VIEW_BASIS#

const

const PRINCIPAL_VIEW_BASIS: typeof PRINCIPAL_VIEW_BASIS

projection#

namespace

namespace projection

Members: PRINCIPAL_VIEW_BASIS, add3D, chainCutLoops, clipMeshToPlane, clipPolygonToWindow, clipSegmentToLoops, clipSegmentToWindow, dot3D, forwardOf, length3D, pointInLoops, scale3D, sectionBasis, subtract3D, viewForwardOf

quaternionValue#

namespace

namespace quaternionValue

Members: fromAxisAngle, fromEuler, identity, multiply, rotate, slerp, toAxisAngle, toEuler

randomValue#

namespace

namespace randomValue

Members: integer, normal, pointsInLoops, uniform, value

rgb#

const

const rgb: typeof _huukhanhnguyen_geometry_catalog_colorValue.rgb

rotation#

const

const rotation: typeof rotation

saturate#

const

const saturate: typeof _huukhanhnguyen_geometry_catalog_colorValue.saturate

scale#

const

const scale: typeof _huukhanhnguyen_geometry_catalog_vector.scale

scale3D#

const

const scale3D: typeof scale3D

scaling#

const

const scaling: typeof scaling

section#

namespace

namespace section

Members: clipFaces, sectionCut, sectionCutWithPatterns, sectionPlane, stampCutPatternHatches

sectionBasis#

const

const sectionBasis: typeof sectionBasis

siteSunDirection#

function

Unit vector TOWARD the sun in model space (Z-up, +Y = project north before northAngle). This is what resolveEnvironment turns settings.environment into (document/environment.ts); project a silhouette along its negation for a shadow range. Below the horizon the vector simply has z < 0 — the caller decides whether a night study means "no shadows".

siteSunDirection(site: Site, moment: SunMoment): [number, number, number]

siteSunPosition#

function

Altitude/azimuth of the sun (degrees). Azimuth is the compass bearing of the sun measured from true north, clockwise (90 = east, 180 = south).

siteSunPosition(site: Site, moment: SunMoment): { altitudeDegrees: number; azimuthDegrees: number; }

skeleton#

namespace

namespace skeleton

Members: evaluateAnimationChain, evaluateSkeletonChain, evaluateTrackNode, faceSkeleton, jointWorldPoses, jointsToNestedNodes

slerp#

const

const slerp: typeof slerp

solid#

namespace

namespace solid

Members: asFaces, curveFill, edgeFillet, extrude, faceEdgeDissolve, faceExtrude, faceVertexDelete, faceVertexMove, faceVertexRotate, faceVertexScale, facesToMesh, facesToTriangleMesh, isClosedSolid, markWholeArray, meshToFaces, nurbsToFaces, solidIntersect, solidSelfUnionImpl, solidSubtract, solidUnion, sweep, tessellateFaces, vertexFillet

solidValue#

namespace

namespace solidValue

Members: centroid, isClosed, surfaceArea, toFaces, volume

statValue#

namespace

namespace statValue

Members: fitLine, max, mean, median, min, percentile, std, sum, variance

std#

const

const std: typeof _huukhanhnguyen_geometry_catalog_statValue.std

subdivision#

namespace

namespace subdivision

Members: triangleArea, weldTriangleMesh

subtract#

const

const subtract: typeof _huukhanhnguyen_geometry_catalog_vector.subtract

subtract3D#

const

const subtract3D: typeof subtract3D

sum#

const

const sum: typeof _huukhanhnguyen_geometry_catalog_statValue.sum

surfaceValue#

namespace

namespace surfaceValue

Members: area, curvature, isocurve, normalAt, pointAt

toAxisAngle#

const

const toAxisAngle: typeof toAxisAngle

toEuler#

const

const toEuler: typeof toEuler

transformValue#

namespace

namespace transformValue

Members: apply, applyVector, compose, invert, rotation, scaling, translation

translate#

const

const translate: typeof translate

translation#

const

const translation: typeof translation

turbulence#

const

const turbulence: typeof _huukhanhnguyen_geometry_catalog_noiseValue.turbulence

unfold#

namespace

namespace unfold

Members: faceUnfold

UnitSymbols#

const

const UnitSymbols: Record<UnitType, Record<string, string>>

variance#

const

const variance: typeof _huukhanhnguyen_geometry_catalog_statValue.variance

viewForwardOf#

const

const viewForwardOf: typeof viewForwardOf