`@bendyline/molen-figures/kernel`

min

Vec3

max

Vec3

s

color

Returns

void

cap()

cap(
   region, 
   ring, 
   s, 
   color, 
   apex?, 
   outward?
): number;

Fan-close a ring onto a new vertex at apex (default: the ring center).

Parameters

apex?

Vec3

outward?

boolean

Returns

number

disc()

disc(
   region, 
   center, 
   normal, 
   radius, 
   sides, 
   s, 
   color
): void;

A flat disc facing normal (hard normal), fanned from its center.

Parameters

region

center

Vec3

normal

Vec3

radius

number

sides

number

s

color

Returns

void

ellipsoid()

ellipsoid(
   region, 
   center, 
   axis, 
   radii, 
   segments, 
   rings, 
   s, 
   color, 
   latMin?, 
   latMax?
): RingRef | undefined;

A lat-long ellipsoid with its polar axis along axis (unit), radii (a, b, c) along the two tangents and the axis; latMin/latMax (−1..1, fraction of the axis) crop it for caps and shells. Returns the ring nearest latMin when the bottom is open.

Parameters

region

center

Vec3

axis

Vec3

radii

Vec3

segments

number

rings

number

s

color

latMin?

number

latMax?

number

Returns

RingRef | undefined

finalize()

finalize(tier, skinned?): SkinnedMeshBuffers;

Smooth (area-weighted) normals for shared vertices; hard normals where given; quantized.

Parameters

tier

FigureTier

skinned?

boolean

Returns

SkinnedMeshBuffers

loft()

loft(
   region, 
   a, 
   b
): void;

Quads between two rings of equal side count (b is "further along" the segment).

Parameters

region

a

RingRef

b

RingRef

Returns

void

mark()

mark(): number;

Vertex count so far (a mark for mirrorX).

Returns

number

mirrorX()

mirrorX(mark, jointMirror): void;

Duplicate everything emitted since mark mirrored across x = 0 with reversed winding and remapped joints, in the same order (deterministic left/right symmetry).

Parameters

mark

number

jointMirror

(joint) => number

Returns

void

quad()

quad(
   region, 
   a, 
   b, 
   c, 
   d
): void;

Parameters

region

a

number

b

number

c

number

d

number

Returns

void

ring()

ring(
   region, 
   center, 
   axis, 
   rx, 
   rz, 
   sides, 
   s, 
   color, 
   phase?
): RingRef;

A ring of sides vertices around center in the plane perpendicular to axis, with radii rx along the first tangent and rz along the second (for a vertical axis: +X and +Z). bulge offsets the ring along the axis per vertex (0..1 of rx) for organic caps.

Parameters

region

center

Vec3

axis

Vec3

rx

number

rz

number

sides

number

s

color

phase?

number

Returns

RingRef

triangle()

triangle(
   region, 
   a, 
   b, 
   c
): void;

Parameters

region

a

number

b

number

c

number

Returns

void

triangleCount()

triangleCount(): number;

Returns

number

vertex()

vertex(
   p, 
   color, 
   s, 
   hardNormal?
): number;

Append a vertex; returns its index.

Parameters

p

Vec3

color

s

FigureDescriptor.build

hardNormal?

Vec3

Returns

number

Interfaces

FigureAttachmentData

Extends

JsonObject

Indexable

[key: string]: JsonValue | undefined

Properties

anchor?

optional anchor?: FigureAnchor;

Which point of the attached entity sits on the socket (default origin).

offset?

optional offset?: object;

Extra socket-local offset.

pos?

optional pos?: Vec3;

rot?

optional rot?: Quat;

socket

socket: string;

Socket name on the parent figure, e.g. 'head.top', 'hand.r', 'back', 'saddle'.

FigureBody

Properties

bounds

bounds: FigureBounds;

buffers

buffers: SkinnedMeshBuffers;

inverseBind

inverseBind: Float32Array;

16 floats (column-major) per joint: the inverse of its rest-pose figure-space transform.

rig

rig: FigureRig;

FigureBounds

Properties

max

max: Vec3;

min

min: Vec3;

sphere

sphere: object;

center

center: Vec3;

radius

radius: number;

FigureData

The authored descriptor: a preset plus overrides (the figure component and molen/figure@1).

Extends

FigureDescriptor

Indexable

[key: string]: JsonValue | undefined

Properties

age?

optional age?: FigureAge;

Inherited from

FigureDescriptor.age

blendTicks?

optional blendTicks?: number;

Ticks to blend between modes (default 12).

build?

optional build?: number;

Inherited from

facing?

optional facing?: "velocity" | "manual";

How the figure turns: toward its velocity (default) or left to whoever writes transform.rot.

features?

optional features?: Partial<FigureFeatures>;

Inherited from

FigureDescriptor.features

height?

optional height?: number;

Inherited from

FigureDescriptor.height

palette?

optional palette?: Partial<FigurePalette>;

Inherited from

FigureDescriptor.palette

preset

preset: 
  | "human.adult"
  | "human.child"
  | "human.elder"
  | "dog"
  | "cat"
  | "horse"
  | "deer"
  | "cow"
  | "sheep";

Inherited from

FigureDescriptor.preset

proportions?

optional proportions?: Partial<FigureProportions>;

Inherited from

FigureDescriptor.proportions

seed?

optional seed?: string;

Inherited from

FigureDescriptor.seed

speedSource?

optional speedSource?: "auto" | "transform" | "none";

Where speed comes from: movers/velocities ('auto', default), transform deltas, or nothing.

turnRate?

optional turnRate?: number;

Max turn rate in rad/s for facing: 'velocity' (default 10).

FigureDescriptor

The authored descriptor: a preset plus overrides (the figure component and molen/figure@1).

Extends

JsonObject

Extended by

FigureData

Indexable

[key: string]: JsonValue | undefined

Properties

age?

optional age?: FigureAge;

build?

optional build?: number;

features?

optional features?: Partial<FigureFeatures>;

height?

optional height?: number;

palette?

optional palette?: Partial<FigurePalette>;

preset

preset: 
  | "human.adult"
  | "human.child"
  | "human.elder"
  | "dog"
  | "cat"
  | "horse"
  | "deer"
  | "cow"
  | "sheep";

proportions?

optional proportions?: Partial<FigureProportions>;

seed?

optional seed?: string;

FigureEntry

Properties

descriptor

descriptor: ResolvedFigureDescriptor;

key

key: string;

rig

rig: FigureRig;

seed

seed: number;

FigureFeatures

Extends

JsonObject

Indexable

[key: string]: JsonValue | undefined

Properties

ears

ears: FigureEarStyle;

feet

feet: FigureFootStyle;

hair

hair: FigureHairStyle;

hands

hands: FigureHandStyle;

horns

horns: FigureHornStyle;

legs

legs: FigureLegwearStyle;

mane

mane: boolean;

sleeves

sleeves: FigureSleeveStyle;

tail

tail: FigureTailStyle;

FigureIntentData

Extends

JsonObject

Indexable

[key: string]: JsonValue | undefined

Properties

footIk?

optional footIk?: boolean;

Plant feet on the ground field (opt-in; both halves must sample the same ground).

ik?

optional ik?: Partial<Record<FigureIkEffector, Vec3>>;

Figure-local effector goals solved by two-bone IK after the gait.

lookAt?

optional lookAt?: 
  | {
  pos: Vec3;
}
  | {
  entity: string;
};

Aim the head at a world point or another entity.

mode?

optional mode?: FigureMode;

Force a mode instead of deriving it from motion.

overrides?

optional overrides?: Record<string, Quat>;

Joint-local rotations by canonical joint name, replacing the gait for those joints.

FigureJoint

Properties

bindPos

bindPos: Vec3;

Parent-local rest offset, meters.

bindRot

bindRot: Quat;

length

length: number;

Length of the segment this joint drives, meters (0 for leaf/helper joints).

name

name: string;

parent

parent: number;

Parent joint index, always smaller than the joint's own index; -1 for the root.

FigureMeshGroup

Properties

count

count: number;

Number of indices in the group.

region

region: FigureRegion;

start

start: number;

Offset into indices of the group's first index.

FigureMetrics

Properties

ankleHeight

ankleHeight: number;

archetype

archetype: FigureArchetype;

bodyLength

bodyLength: number;

bodyRadius

bodyRadius: number;

chestLen

chestLen: number;

chestZ

chestZ: number;

earLen

earLen: number;

footLen

footLen: number;

foreArmLen

foreArmLen: number;

handLen

handLen: number;

headHeight

headHeight: number;

headLen

headLen: number;

Head length along its axis (biped: up; quadruped: forward along the muzzle).

headPitch

headPitch: number;

Quadruped head pitch below the neck line, radians.

headWidth

headWidth: number;

height

height: number;

hipHalf

hipHalf: number;

hipHeight

hipHeight: number;

hipsLen

hipsLen: number;

hips → spine, spine → chest, chest → neck segment lengths.

hipZ

hipZ: number;

legLength

legLength: number;

Hip-to-ankle (biped) or shoulder-to-ground (quadruped) length: the Froude scale.

legY

legY: number;

Quadruped leg joint height (shoulder and hip).

limbRadius

limbRadius: number;

lowerLegLen

lowerLegLen: number;

neckLen

neckLen: number;

neckPitch

neckPitch: number;

quadFootLen

quadFootLen: number;

quadLowerLen

quadLowerLen: number;

quadToesLen

quadToesLen: number;

quadUpperLen

quadUpperLen: number;

shoulderHalf

shoulderHalf: number;

snoutLen

snoutLen: number;

spineLen

spineLen: number;

tailLen

tailLen: number;

torsoRadius

torsoRadius: number;

upperArmLen

upperArmLen: number;

upperLegLen

upperLegLen: number;

FigurePalette

Colors as "#rrggbb" (sRGB). Skin doubles as fur/hide for animals; markings are secondary.

Extends

JsonObject

Indexable

[key: string]: JsonValue | undefined

Properties

accent

accent: string;

bottom

bottom: string;

eyes

eyes: string;

hair

hair: string;

markings

markings: string;

shoes

shoes: string;

skin

skin: string;

top

top: string;

FigurePose

Properties

local

local: Float32Array;

7 floats per joint in rig order: parent-local position xyz and rotation xyzw.

rig

rig: FigureRig;

FigurePreset

Properties

age

age: FigureAge;

archetype

archetype: FigureArchetype;

build

build: number;

features

features: FigureFeatures;

height

height: number;

palette

palette: FigurePalette;

proportions

proportions: FigureProportions;

species

species: FigureSpecies;

FigureProportions

Proportion multipliers applied to the archetype's canonical segment table (1 = preset).

Extends

JsonObject

Indexable

[key: string]: JsonValue | undefined

Properties

armRatio

armRatio: number;

bodyLength

bodyLength: number;

Quadruped body length as a multiple of height (withers).

earSize

earSize: number;

headScale

headScale: number;

hipWidth

hipWidth: number;

legRatio

legRatio: number;

neckLength

neckLength: number;

neckPitch

neckPitch: number;

Neck pitch above the spine line, radians (quadrupeds; 0 for bipeds).

shoulderWidth

shoulderWidth: number;

snoutLength

snoutLength: number;

Snout length as a multiple of the head unit (0 = flat face).

tailLength

tailLength: number;

Tail length as a multiple of height.

torsoRatio

torsoRatio: number;

FigureRig

Properties

archetype

archetype: FigureArchetype;

eyeHeight

eyeHeight: number;

height

height: number;

hipHeight

hipHeight: number;

index

index: Readonly<Record<string, number>>;

joints

joints: readonly FigureJoint[];

key

key: string;

Content key of the descriptor this rig was derived from.

legLength

legLength: number;

metrics

metrics: FigureMetrics;

socketIndex

socketIndex: Readonly<Record<string, number>>;

sockets

sockets: readonly FigureSocket[];

FigureRuntime

Properties

world

readonly world: World;

Methods

entryFor()

entryFor(id): FigureEntry | undefined;

The resolved rig of a figure entity (cached), or undefined when it has no valid figure.

Parameters

id

string

Returns

FigureEntry | undefined

poseFor()

poseFor(id, tick): FigurePose | undefined;

The entity's pose at a tick, with its intent, look-at, and anchor applied (memoized per tick).

Parameters

id

string

tick

number

Returns

FigurePose | undefined

socketLocal()

socketLocal(
   id, 
   socket, 
   tick
): TransformLike | undefined;

A socket's figure-space transform under the entity's current pose.

Parameters

id

string

socket

string

tick

number

Returns

TransformLike | undefined

socketWorld()

socketWorld(
   id, 
   socket, 
   tick
): TransformLike | undefined;

A socket's world-space transform.

Parameters

id

string

socket

string

tick

number

Returns

TransformLike | undefined

warnOnce()

warnOnce(id, code): void;

Emit figures-error once per (entity, code).

Parameters

id

string

code

string

Returns

void

FiguresHandle

Properties

runtime

readonly runtime: FigureRuntime;

world

readonly world: World;

Methods

attach()

attach(
   itemId, 
   figureId, 
   socket, 
   offset?, 
   anchor?
): boolean;

Parent itemId to a figure socket; places it immediately so it never pops.

Parameters

itemId

string

figureId

string

socket

string

offset?

pos?

Vec3

rot?

Quat

anchor?

FigureAnchor

Returns

boolean

descriptorOf()

descriptorOf(id): ResolvedFigureDescriptor | undefined;

Parameters

id

string

Returns

ResolvedFigureDescriptor | undefined

detach()

detach(itemId, opts?): boolean;

Remove the attachment (and by default the parent link), keeping the world pose.

Parameters

itemId

string

opts?

keepWorld?

boolean

Returns

boolean

dismount()

dismount(riderId): boolean;

Parameters

riderId

string

Returns

boolean

dispose()

dispose(): void;

Returns

void

mount()

mount(
   riderId, 
   figureId, 
   seat?
): boolean;

Seat a rider on a figure mount (adds mountable from the rig when absent).

Parameters

riderId

string

figureId

string

seat?

string

Returns

boolean

poseAt()

poseAt(id, tick?): FigurePose | undefined;

The entity's pose at a tick (default: the current tick).

Parameters

id

string

tick?

number

Returns

FigurePose | undefined

rigOf()

rigOf(id): FigureRig | undefined;

Parameters

id

string

Returns

FigureRig | undefined

socket()

socket(
   id, 
   name, 
   tick?
): TransformLike | undefined;

A socket's world transform at a tick (default: the current tick).

Parameters

id

string

name

string

tick?

number

Returns

TransformLike | undefined

FigureSocket

Properties

joint

joint: number;

name

name: string;

pos

pos: Vec3;

Joint-local offset, meters.

rot

rot: Quat;

Joint-local orientation; +Z of the socket faces "out".

FiguresOptions

Extends

LocomotionOptions

Properties

groundHeight?

optional groundHeight?: (x, z) => number;

Ground height at a world XZ (default: the world's ground field, else y = 0).

Parameters

x

number

z

number

Returns

number

Inherited from

LocomotionOptions.groundHeight

FigureStateData

Kernel-owned, piecewise-constant: written only when motion changes, never per tick.

Extends

JsonObject

Indexable

[key: string]: JsonValue | undefined

Properties

gait?

optional gait?: FigureGait;

lookAtTick?

optional lookAtTick?: number;

Tick the look-at target last changed (aim blend start).

mode

mode: FigureMode;

modeAtTick

modeAtTick: number;

Tick the current mode began (blend start).

phaseAt

phaseAt: number;

Gait phase [0, 1) at phaseAtTick; phase(t) = frac(phaseAt + strideRate * (t - phaseAtTick) / tickRate).

phaseAtTick

phaseAtTick: number;

prevMode?

optional prevMode?: FigureMode;

speed

speed: number;

Planar speed, m/s, quantized.

strideRate

strideRate: number;

Gait cycles per second.

travel?

optional travel?: number;

Travel direction relative to facing, radians (absent = forward).

LocomotionMemory

Previous positions of transform-delta figures, kept as a snapshot provider blob.

Properties

prev: Record<EntityId, Vec3>;

LocomotionOptions

Extended by

FiguresOptions

Properties

groundHeight?

optional groundHeight?: (x, z) => number;

Ground height at a world XZ (default: the world's ground field, else y = 0).

Parameters

x

number

z

number

Returns

number

PoseBuffer

Properties

q

q: Float32Array;

4 floats per joint: [x, y, z, w].

root

root: Float32Array;

Root translation [x, y, z] added to the root joint's bind offset.

PoseEvalOptions

Properties

anchor?

optional anchor?: FigureAnchor;

Re-anchor the root so this point sits at the figure origin (seats, saddles).

blendTicks?

optional blendTicks?: number;

Ticks to blend from state.prevMode (default 12).

ik?

optional ik?: Partial<Record<FigureIkEffector, Vec3>>;

Figure-local effector goals solved after the gait.

lookTarget?

optional lookTarget?: Vec3;

Figure-local point the head aims at.

lookWeight?

optional lookWeight?: number;

0..1 weight of the look-at (default 1).

overrides?

optional overrides?: Record<string, Quat>;

Joint-local rotations by name that replace the evaluated rotation.

seed?

optional seed?: number;

Seed for idle variation (see figureSeed).

tickRate

tickRate: number;

ResolvedFigureDescriptor

A descriptor with every preset default filled in: the input of the rig and body generators.

Extends

JsonObject

Indexable

[key: string]: JsonValue | undefined

Properties

age

age: FigureAge;

archetype

archetype: FigureArchetype;

build

build: number;

-1 (slight) … 1 (heavy): limb and torso radii, shoulder width.

features

features: FigureFeatures;

height

height: number;

Standing height (bipeds: head top; quadrupeds: withers), meters.

palette

palette: FigurePalette;

preset

preset: 
  | "human.adult"
  | "human.child"
  | "human.elder"
  | "dog"
  | "cat"
  | "horse"
  | "deer"
  | "cow"
  | "sheep";

proportions

proportions: FigureProportions;

seed

seed: string;

Symmetry-safe detail jitter only; '' = none.

species

species: FigureSpecies;

RingRef

Properties

center

center: Vec3;

sides

sides: number;

start

start: number;

Index of the ring's first vertex.

SkinnedMeshBuffers

Properties

bytes

bytes: number;

colors

colors: Uint8Array;

8-bit linear RGB triplets.

groups

groups: FigureMeshGroup[];

indices

indices: Uint16Array<ArrayBufferLike> | Uint32Array<ArrayBufferLike>;

joints?

optional joints?: Uint8Array<ArrayBufferLike>;

4 joint indices per vertex (2 used); absent on rigid tiers.

normals

normals: Float32Array;

positions

positions: Float32Array;

tier

tier: FigureTier;

triangleCount

triangleCount: number;

vertexCount

vertexCount: number;

weights?

optional weights?: Float32Array<ArrayBufferLike>;

4 weights per vertex summing to 1; absent on rigid tiers.

TwoBoneSolution

Properties

lowerDir

lowerDir: Vec3;

Unit direction of the lower segment (middle joint to effector).

mid

mid: Vec3;

Middle joint position.

reached

reached: boolean;

False when the target was clamped to the reachable annulus.

upperDir

upperDir: Vec3;

Unit direction of the upper segment (root to middle joint).

Type Aliases

FigureAge

type FigureAge = "child" | "adult" | "elder";

FigureAnchor

type FigureAnchor = "origin" | "pelvis" | "eye";

FigureArchetype

type FigureArchetype = "biped" | "quadruped";

FigureEarStyle

type FigureEarStyle = "none" | "round" | "pointed" | "floppy";

FigureFootStyle

type FigureFootStyle = "plantigrade" | "digitigrade" | "unguligrade";

FigureGait

type FigureGait = "walk" | "trot" | "gallop";

FigureHairStyle

type FigureHairStyle = "none" | "cap" | "bob" | "long";

FigureHandStyle

type FigureHandStyle = "mitten" | "fingers";

FigureHornStyle

type FigureHornStyle = "none" | "short" | "long" | "antlers";

FigureIkEffector

type FigureIkEffector = "hand.l" | "hand.r" | "foot.l" | "foot.r";

FigureLegwearStyle

type FigureLegwearStyle = "shorts" | "long";

FigureMode

type FigureMode = "idle" | "walk" | "run" | "jump" | "fall" | "sit" | "custom";

FigurePresetId

type FigurePresetId = typeof FIGURE_PRESET_IDS[number];

FigureRegion

type FigureRegion = 
  | "skin"
  | "hair"
  | "brow"
  | "eyes"
  | "top"
  | "sleeves"
  | "bottom"
  | "shoes"
  | "accent"
  | "markings";

FigureSleeveStyle

type FigureSleeveStyle = "none" | "short" | "long";

FigureSpecies

type FigureSpecies = "human" | "dog" | "cat" | "horse" | "deer" | "cow" | "sheep";

FigureTailStyle

type FigureTailStyle = "none" | "short" | "long" | "bushy";

FigureTier

type FigureTier = 0 | 1 | 2;

RGB

type RGB = [number, number, number];

Linear RGB, each channel 0..1.

Skin

type Skin = readonly [number, number, number, number];

A pair of joint influences: [joint, weight] each; weights need not be normalized.

Variables

BIPED_JOINT_NAMES

const BIPED_JOINT_NAMES: readonly string[];

BIPED_SOCKET_NAMES

const BIPED_SOCKET_NAMES: readonly string[];

Figure

const Figure: ComponentType<FigureData>;

FIGURE_ATTACHMENT_COMPONENT

const FIGURE_ATTACHMENT_COMPONENT: "figureAttachment";

FIGURE_COMPONENT

const FIGURE_COMPONENT: "figure";

FIGURE_EXAMPLE

const FIGURE_EXAMPLE: JsonValue;

FIGURE_FILE_EXAMPLE

const FIGURE_FILE_EXAMPLE: JsonValue;

FIGURE_FORMAT

const FIGURE_FORMAT: "molen/figure@1";

FIGURE_INTENT_COMPONENT

const FIGURE_INTENT_COMPONENT: "figureIntent";

FIGURE_MODES

const FIGURE_MODES: readonly FigureMode[];

FIGURE_PRESET_IDS

const FIGURE_PRESET_IDS: readonly ["human.adult", "human.child", "human.elder", "dog", "cat", "horse", "deer", "cow", "sheep"];

Shipped presets; molen figure presets lists them with their descriptors.

FIGURE_PRESETS

const FIGURE_PRESETS: Readonly<Record<FigurePresetId, FigurePreset>>;

FIGURE_REGIONS

const FIGURE_REGIONS: readonly FigureRegion[];

Fixed region order used when concatenating mesh groups.

FIGURE_STATE_COMPONENT

const FIGURE_STATE_COMPONENT: "figureState";

FigureAttachment

const FigureAttachment: ComponentType<FigureAttachmentData>;

figureDescriptorFields

const figureDescriptorFields: object;

The descriptor fields (no envelope): shared by the component and the file format.

Type Declaration

age

age: z.ZodType<FigureDescriptor["age"]>;

build

build: z.ZodType<number | undefined>;

features

features: z.ZodType<Partial<FigureFeatures> | undefined>;

height

height: z.ZodType<number | undefined>;

palette

palette: z.ZodType<Partial<FigurePalette> | undefined>;

preset

preset: z.ZodType<FigureDescriptor["preset"]>;

proportions

proportions: z.ZodType<Partial<FigureProportions> | undefined>;

seed

seed: z.ZodType<string | undefined>;

figureDescriptorSchema

const figureDescriptorSchema: z.ZodType<FigureDescriptor>;

FigureIntent

const FigureIntent: ComponentType<FigureIntentData>;

FigureState

const FigureState: ComponentType<FigureStateData>;

GRAVITY

const GRAVITY: number;

QUADRUPED_JOINT_NAMES

const QUADRUPED_JOINT_NAMES: readonly string[];

QUADRUPED_SOCKET_NAMES

const QUADRUPED_SOCKET_NAMES: readonly string[];

Functions

attachmentLocal()

function attachmentLocal(socket, attachment): TransformLike;

The socket-local transform of an attachment: socket composed with the authored offset.

Parameters

socket

TransformLike

attachment

FigureAttachmentData

Returns

TransformLike

bipedRunFor()

function bipedRunFor(fr, wasRunning): boolean;

Biped walk/run choice from Froude with hysteresis (run above 0.5, back below 0.4).

Parameters

fr

number

wasRunning

boolean

Returns

boolean

createFigureRuntime()

function createFigureRuntime(world): FigureRuntime;

Parameters

world

World

Returns

FigureRuntime

deriveMetrics()

function deriveMetrics(d): FigureMetrics;

Parameters

d

Returns

FigureMetrics

deriveRig()

function deriveRig(d): FigureRig;

Derive the canonical rig of a resolved descriptor (pure; cache by descriptorKey).

Parameters

d

Returns

descriptorKey()

function descriptorKey(resolved): string;

Stable content key of a resolved descriptor (same body ⇔ same key, in any process).

Parameters

resolved

Returns

string

evaluatePose()

function evaluatePose(
   rig, 
   state, 
   tick, 
   opts, 
   out?
): FigurePose;

Evaluate the pose of a rig at a tick. state undefined means a standing idle. Pass out to reuse a pose buffer of the same rig (no allocation per call).

Parameters

rig

state

FigureStateData | undefined

tick

number

opts

PoseEvalOptions

out?

Returns

figureBodyKey()

function figureBodyKey(descriptor, tier): string;

Content key of one body: descriptor key plus tier.

Parameters

descriptor

tier

FigureTier

Returns

string

figureMountable()

function figureMountable(rig): MountableData;

A mountable component for a figure: rideable sockets become passenger seats.

Parameters

rig

Returns

MountableData

figurePhase()

function figurePhase(
   state, 
   tick, 
   tickRate
): number;

Gait phase in [0, 1) at a (possibly fractional) tick.

Parameters

state

FigureStateData

tick

number

tickRate

number

Returns

number

figurePreset()

function figurePreset(id): FigurePreset;

Parameters

id

Returns

FigurePreset

figureSeed()

function figureSeed(seed, entityId): number;

The integer seed of a figure: its descriptor seed, else the entity id.

Parameters

seed

string | undefined

entityId

string

Returns

number

figuresOf()

function figuresOf(world): FiguresHandle | undefined;

The figures handle installed on a world, if any.

Parameters

world

World

Returns

FiguresHandle | undefined

figuresScriptApi()

function figuresScriptApi(handle): object;

The script-api namespace for figures (molen.figures.*); pass via buildWorld capabilities.

Parameters

handle

FiguresHandle

Returns

object

figureToWorld()

function figureToWorld(entity, local): TransformLike;

A figure-space transform into world space through the entity transform.

Parameters

entity

TransformLike

local

TransformLike

Returns

TransformLike

fmix32()

function fmix32(x): number;

murmur3 finalizer: a full-avalanche 32-bit mix.

Parameters

x

number

Returns

number

froude()

function froude(speed, legLength): number;

Froude number v² / (g · L): the dimensionless gait speed.

Parameters

speed

number

legLength

number

Returns

number

generateFigureBody()

function generateFigureBody(
   descriptor, 
   tier, 
   rig?
): FigureBody;

Generate the body of a resolved descriptor at a detail tier (0 near, 1 medium, 2 distant rigid). Pass the rig when already derived; it must come from the same descriptor.

Parameters

descriptor

tier

FigureTier

rig?

Returns

FigureBody

idleThresholds()

function idleThresholds(height): object;

Idle/moving speed thresholds (m/s) with hysteresis, scaled by height.

Parameters

height

number

Returns

object

enter

enter: number;

exit

exit: number;

installFigures()

function installFigures(world, opts?): FiguresHandle;

Install the figures systems (idempotent per world) and return the handle.

Parameters

world

World

opts?

FiguresOptions

Returns

FiguresHandle

jointTransform()

function jointTransform(model, joint): TransformLike;

A joint's figure-space transform from a model buffer.

Parameters

model

Float32Array

joint

number

Returns

TransformLike

mirrorName()

function mirrorName(name): string;

The name of the mirrored joint or socket ('.l' ↔ '.r', 'fl' ↔ 'fr', 'hl' ↔ 'hr').

Parameters

name

string

Returns

string

parseColor()

function parseColor(hex): RGB;

Parse "#rrggbb" into linear RGB; invalid input yields mid grey.

Parameters

hex

string

Returns

poseModelSpace()

function poseModelSpace(pose, out?): Float32Array;

Forward kinematics: every joint's figure-space transform (7 floats per joint).

Parameters

pose

out?

Float32Array<ArrayBufferLike>

Returns

Float32Array

quadrupedGaitFor()

function quadrupedGaitFor(fr, prev): FigureGait;

Quadruped gait from Froude with ±12% hysteresis around walk<0.4≤trot<2.0≤gallop.

Parameters

fr

number

FigureGait | undefined

Returns

FigureGait

registerFiguresComponents()

function registerFiguresComponents(): void;

Returns

void

registerFiguresSchema()

function registerFiguresSchema(): void;

Returns

void

resolveFigureDescriptor()

function resolveFigureDescriptor(descriptor): ResolvedFigureDescriptor;

Fill a descriptor from its preset; throws on an unknown preset. Extra keys are ignored.

Parameters

descriptor

FigureDescriptor

Returns

rigBindModel()

function rigBindModel(rig): Float64Array;

Rest-pose transforms of every joint in figure space (7 floats per joint: pos, quat).

Parameters

rig

Returns

Float64Array

rigInverseBind()

function rigInverseBind(rig): Float32Array;

Inverse bind matrices of a rig (column-major 4x4 per joint), for skinning.

Parameters

rig

Returns

Float32Array

scaleColor()

function scaleColor(color, factor): RGB;

Scale a linear color (for shading variation such as darker hooves or a lighter belly).

Parameters

color

factor

number

Returns

socketBindPosition()

function socketBindPosition(
   rig, 
   name, 
   model?
): Vec3 | undefined;

A socket's rest-pose position in figure space.

Parameters

rig

name

string

model?

Float64Array<ArrayBufferLike>

Returns

Vec3 | undefined

socketTransform()

function socketTransform(
   rig, 
   pose, 
   socket, 
   model?
): TransformLike | undefined;

A socket's figure-space transform under a pose (model = poseModelSpace, computed if absent).

Parameters

rig

pose