Skip to main content

Module skeletal

Module skeletal 

Source
Expand description

Caller-buffered VibeScript motor rig sampling, attachments and skinning. Caller-buffered skeletal animation using the rigid motor algebra (etalon_render::skeletal). Joint transforms are rigid; authoring scale is baked into mesh/bind positions. Sampling, hierarchy composition and skinning allocate no heap memory.

Re-exports§

pub use fauna_rig::FaunaBiomechanicalArchetype;
pub use fauna_rig::FaunaSkeletalRig10d;
pub use fauna_rig::FAUNA_MAX_JOINTS;
pub use fauna_rig::FAUNA_PARENT_INDICES;

Modules§

absm
Zero-Heap Multi-Layer Animation Blending State Machine (re-exported from etalon-render).
activity
Bounded visual activity timeline (re-exported from etalon-render).
authoring
Bounded skin influence authoring and seam remapping (re-exported from etalon-render).
blend_space
Zero-Heap 1D & 2D Delaunay Animation Blend Spaces (re-exported from etalon-render).
fauna_rig
Hardware GPU PGA Motor Dual-Quaternion Skinning, Multi-Layer ABSM, 2D Delaunay Blend Space & Constrained Motor IK for Australian Fauna.
gpu_morph
GPU Morph Target & .10d MAGIC_EONT Ontogenetic Deformation Bridge (re-exported from etalon-render).
gpu_skin
GPU Dual-Quaternion Skinning Palette & Reference Kernel (re-exported from etalon-render).
ik_motor
Analytical Two-Bone, Constrained FABRIK, Coupled Swing-Twist Reach Cones, Scapulo-Humeral Rhythm & Biarticular Tendon Coupling (re-exported from etalon-render).
player
Cold resident allocation and allocation-free visual playback lifecycle (etalon_render::skeletal::player).

Structs§

AbsmLayer
Single animation layer within an AbsmMachine.
AbsmMachine
Multi-layer zero-heap Animation Blending State Machine (AbsmMachine).
AbsmStateNode
A state node inside an super::absm_machine::AbsmLayer.
AbsmTransition
Directed transition edge between two states in an super::absm_machine::AbsmLayer.
AnimationClip
Fixed-capacity skeletal animation clip (HotZeroHeap).
AnimationEvent
Discrete event marker embedded in an AnimationClip timeline.
AnimationSignal
Timeline event emitted when an animation playhead crosses a normalized trigger timestamp.
AnimationStateMachine
Zero-heap animation state machine controller.
BlendPoint1D
A single sample point inside a BlendSpace1D.
BlendPoint2D
A 2D parameter sample point inside a BlendSpace2D.
BlendSample2D
Result of sampling a BlendSpace2D at a 2D parameter coordinate.
BlendSpace1D
Fixed-capacity 1D animation blend space (MAX_POINTS default 8).
BlendSpace2D
Fixed-capacity 2D Delaunay animation blend space (MAX_POINTS = 16, MAX_TRIS = 32).
BlendTriangle
A Delaunay triangle indexing 3 points in BlendSpace2D::points.
BodyFitSpec
Neutral body-fit specification applied in bind/CCF space before orbit-frame normalisation.
BoneLayerMask
128-bit bone mask (1 bit per joint up to MAX_JOINTS = 128).
BoneTrack
Fixed-capacity keyframe track for a single bone (HotZeroHeap).
Clip
EontPostureConfig
Ontogenetic and metabolic posture/cadence modulator (EONT1 compatible).
GpuInstanceMorphWeights
48-byte per-instance morph weight uniform/storage record uploaded to the GPU.
GpuJointMotorPair
64-byte GPU storage record per joint storing both current-frame and previous-frame skinning PGA Motors ($M_{\text{skin}, j} = M_{\text{world}, j} \circ M_{\text{inv_bind}, j}$).
GpuMorphDelta
32-byte GPU storage record holding a single morph target’s per-vertex position and normal delta.
GpuSkinnedVertex
24-byte static vertex skinning attribute (JOINTS_0 + WEIGHTS_0) uploaded once per mesh.
Joint
Key
Keyframe3D
Single keyframe sample for a BoneTrack.
Motor
A 3D PGA Motor (even multivector / unit dual quaternion) in f64 precision. Real part $R = (r_w, r_x, r_y, r_z)$, Dual part $D = (d_w, d_x, d_y, d_z)$.
MotorBivector
Lie algebra $\mathfrak{se}(3)$ screw bivector (rotation axis/angle + translation along screw axis).
OntogeneticStateHeader
Domain-neutral 40-byte ontogenetic and metabolic state header (EONT1 layout).
PlaybackReceipt
RootMotionDelta
Frame-to-frame root motion displacement extracted from the skeleton’s root joint.
RootMotionExtractor
Extracts continuous root motion from the root bone (eliminating loop-wrap teleport spikes) and locks horizontal (x, z) drift on the visual skeleton.
SignalQueue
Fixed-capacity FIFO ring buffer for AnimationSignal events (HotZeroHeap).
SignalTrigger
Authored signal trigger attached to an animation state.
SkeletalCounts
Validated element counts and encoded payload size for skeletal admission budgeting.
SkeletalPlayer
Buffers are allocated once on validated scene admission, never on advance. Geometry stays in the authored bind frame; output can receive a uniform orbit transform without altering the rig or losing attachment alignment.
SkeletalRigDescriptor
Direct borrowed rig descriptor implementing SkeletalSectionSource.
SkinWeight
Track
Transform3D
3D affine transform representation (rotation stored as [x, y, z, w]).
TwoBoneIkResult
Output receipt for solve_two_bone_motor_ik_zero_heap.
ZeroHeapSkeleton
Fixed-capacity skeletal rig (MAX_BONES = 64).

Enums§

AbsmParameter
Typed parameter value driving ABSM transitions and blend spaces.
AbsmStateSource
Motion generator source for a state inside an super::absm_machine::AbsmLayer.
JointConstraint
Angular constraint applied to a joint during solve_constrained_fabrik_motor_ik_zero_heap.
LayerBlendMode
How an ABSM layer combines its output pose with lower layers.
LeafCondition
Atomic predicate for transition evaluation (stack-resident, Copy).
PlayerError
PoseTimePolicy
SkeletalError
TransitionCondition
Zero-heap transition firing condition supporting single predicates and And/Or combinators.
TransitionMode
Animation state machine transition blend mode.

Constants§

MAX_BONES
Maximum bones supported per skeleton instance (fits in GPU uniform blocks).
MAX_GPU_MORPH_TARGETS
Maximum morph targets evaluated simultaneously per instance on the GPU.
MAX_GPU_RIG_JOINTS
Maximum joints supported per GPU skeletal rig palette (128 joints = 8 KiB per instance).
MAX_GPU_SKELETON_INSTANCES
Maximum concurrent skeletal instances resident in a single GPU storage buffer.
MAX_IK_CHAIN
Maximum joints in a single constrained FABRIK chain (HotZeroHeap stack bound).
MAX_JOINTS
MAX_KEYS
MAX_VERTICES

Traits§

BodyFitSource
Conversion trait allowing host body-fit descriptors (e.g. AnatomyBodyFit) to configure SkeletalPlayer::set_body_fit without reverse crate dependencies.
SkeletalSectionSource
Zero-copy section source abstraction so SkeletalPlayer can be constructed from .10d SkeletalSection payloads or direct in-memory slice descriptors without introducing reverse crate dependencies.

Functions§

compose_palette_into
Iterative parent-before-child composition and inverse bind application. globals doubles as reusable attachment transforms for tools and clothing.
compute_ontogenetic_morph_weights_from_header_zero_heap
Convenience wrapper extracting stage, damage_permill, and hydration_permill directly from an OntogeneticStateHeader (EntityOntologyMiniHeader).
compute_ontogenetic_morph_weights_zero_heap
Computes GpuInstanceMorphWeights with zero heap allocations (HotZeroHeap), combining explicit pose/facial blend-shape weights with ontogenetic/metabolic state (damage_permill, hydration_permill, and stage ontogenetic factor).
evaluate_morph_deltas_zero_heap
Evaluates linear blend-shape morph deltas into caller-supplied vertex position and normal buffers with zero heap allocations (HotZeroHeap).
evaluate_skinning_motor_palette_zero_heap
Evaluates the GPU skinning Motor palette in a single zero-heap pass (HotZeroHeap).
gpu_shader_skin_vertex_reference
Deterministic software reference implementation of the WGSL vertex shader PGA Motor dual-quaternion skinning kernel (HotZeroHeap).
hemisphere_align_motor
Aligns candidate to the same $S^3$ double-cover hemisphere as reference.
ontogenetic_stage_growth_factor
Maps a DevelopmentalStage discriminant (0..=4) to a normalized ontogenetic growth factor in [0.0, 1.0].
sample_blend_space_1d_zero_heap
Evaluates a BlendSpace1D at param and blends the corresponding clip Motor poses into out_pose using Motor::sclerp (HotZeroHeap).
sample_blend_space_2d_zero_heap
Samples a BlendSpace2D at query and blends the 3 enclosing triangle clip poses per joint using barycentric Motor::sclerp with zero heap allocation (HotZeroHeap).
sample_pose_into
Samples a local pose, optionally transitioning from a caller-owned pose. blend is target influence [0, 1]. Missing tracks retain the rig rest pose. Validation finishes before modifying any output. Time is visual, not a game day.
skin_vertices_gpu_reference_into
Batch helper that skins a slice of vertices via gpu_shader_skin_vertex_reference into caller-supplied output slices (HotZeroHeap).
skin_vertices_into
Four-influence linear blend skinning of immutable bind geometry. Positions and normals share the same palette. UVs, tangents and material topology are unchanged; tangent reconstruction remains the renderer’s job. No partial writes on malformed influences or inadequate output buffers.
solve_constrained_fabrik_motor_ik_zero_heap
Solves multi-joint Constrained Forward-And-Backward Reaching Inverse Kinematics (FABRIK) directly on a chain of up to MAX_IK_CHAIN = 16 PGA Motors with zero heap allocations (HotZeroHeap).
solve_two_bone_motor_ik_zero_heap
Analytically solves two-bone inverse kinematics (e.g., hip–knee–ankle or shoulder–elbow–wrist) directly on PGA Motors using the Law of Cosines and a pole-vector bend plane (HotZeroHeap).
valid_motor
Returns true when m is a finite, unit-norm, Plücker-orthogonal PGA Motor.
validate_joints
Validates topological parent ordering and motor invariants for joints.