@bendyline/molen-figures/client

Molen figures capability: stylized human, biped and quadruped rigs, gaits and sockets (kernel) with procedural skinned bodies (client).

import { /* … */ } from '@bendyline/molen-figures/client';

Classes

FigureGeometryCache

Constructors

Constructor

new FigureGeometryCache(): FigureGeometryCache;

Returns

FigureGeometryCache

Accessors

size

Get Signature

get size(): number;

Returns

number

Methods

acquire()

acquire(descriptor, tier): CachedFigureGeometry;

Acquire (generating on a miss) the geometry of a descriptor at a tier.

Parameters

descriptor

ResolvedFigureDescriptor

tier

FigureTier

Returns

CachedFigureGeometry

dispose()

dispose(): void;

Returns

void

release()

release(key): void;

Parameters

key

string

Returns

void

rigFor()

rigFor(descriptor): FigureRig;

The rig of a descriptor (cached by descriptor key).

Parameters

descriptor

ResolvedFigureDescriptor

Returns

FigureRig

Interfaces

CachedFigureGeometry

Properties

body

body: FigureBody;

geometry

geometry: BufferGeometry;

key

key: string;

---

FigureKindOptions

Properties

hysteresis?

optional hysteresis?: number;

Fractional hysteresis around each tier boundary (default 0.1).

material?

optional material?: Material<MaterialEventMap>;

Material for every figure (default: a vertex-colored standard material).

tierDistances?

optional tierDistances?: [number, number];

Camera distances (meters) beyond which tier 1 and tier 2 bodies are used on the live path; default [0.35, 1] times the client's animation distantDistance.

---

FigureMesh

Properties

bones

bones: Bone<Object3DEventMap>[];

Bones in rig order (empty for rigid tiers).

mesh

mesh: 
  | SkinnedMesh<BufferGeometry<NormalBufferAttributes, BufferGeometryEventMap>, Material<MaterialEventMap> | Material<MaterialEventMap>[], Object3DEventMap>
| Mesh<BufferGeometry<NormalBufferAttributes, BufferGeometryEventMap>, Material<MaterialEventMap> | Material<MaterialEventMap>[], Object3DEventMap>;

root

root: Group;

The root the backend places: the mesh and (for skinned tiers) the bone hierarchy.

skeleton

skeleton: Skeleton | undefined;

Methods

dispose()

dispose(): void;

Returns

void

Functions

applyPose()

function applyPose(pose, bones): void;

Write a pose's local joint transforms into the bones (rig order).

Parameters

pose

FigurePose

bones

readonly Bone<Object3DEventMap>[]

Returns

void

---

figureBodyToSkinnedMesh()

function figureBodyToSkinnedMesh(
   body, 
   geometry, 
   material
): FigureMesh;

Wrap a generated body (its geometry already uploaded) in a posable mesh.

Parameters

body

FigureBody

geometry

BufferGeometry

material

Material

Returns

FigureMesh

---

figureGeometry()

function figureGeometry(buffers): BufferGeometry;

A three.js geometry over kernel-generated figure buffers (shared by every entity with the key).

Parameters

buffers

SkinnedMeshBuffers

Returns

BufferGeometry

---

figureKind()

function figureKind(options?): RenderableKind;

The figure renderable kind for ClientOptions.kinds.

Parameters

options?

FigureKindOptions

Returns

RenderableKind

References

evaluatePose

Re-exports evaluatePose

---

FigureData

Re-exports FigureData

---

FigurePose

Re-exports FigurePose

---

FigureRig

Re-exports FigureRig

---

figureSeed

Re-exports figureSeed

---

FigureStateData

Re-exports FigureStateData

---

FigureTier

Re-exports FigureTier

---

PoseEvalOptions

Re-exports PoseEvalOptions

---

ResolvedFigureDescriptor

Re-exports ResolvedFigureDescriptor

---

resolveFigureDescriptor

Re-exports resolveFigureDescriptor

---

strideRateFor

Re-exports strideRateFor