Somakine · The open body framework

QUICK START viewer.ts

const viewer = await createSomakine(container, {
  dataset,
  accessibleLabel: "Interactive body model",
  onSelection: ({ structure }) => {
    console.log(structure.id);
  },
});

viewer.setLayer("muscle");
viewer.selectStructure(structureId);
viewer.selectStructure(structureId, { side: "left" }); // one side of a paired structure
viewer.selectStructures([structureId, anotherStructureId]); // IDs may span Regions
viewer.setStructureStyle(structureId, { color: "#e19a5b" });

CORE API viewer

createSomakine(container, options): Create a viewer with a verified data pack and host callbacks.
setLocale(locale) · setInteractionMode(mode): Switch labels and choose primary drag rotation or panning.
setLayer(type | null) · setVisible(ids, options?): Show one structure type or apply a host-computed visibility set; { side } isolates one side.
selectStructure(id, options?) · selectStructures(entries, options?): Highlight one structure or a cross-Region set; entries may be { id, side } for mixed sides. Unknown IDs are ignored and visibility is preserved.
focusStructure(id, options?): Explicitly isolate one structure (or one side) and its declared context geometry.
{ side: "left" | "right" }: Restrict select/focus/visible/style to one side of a paired structure; ViewerSelection.side reports the resolved side.
onSelectionGroup(selections): Receive the resolved selection records after a single or multi-structure highlight; canvas Ctrl/Cmd-click toggles picked meshes.
setStructureStyle(id, style, options?): Set a structure-specific colour, emissive, opacity, or surface style; a { side } styles one side. Pass null to reset.
showBody() · reset(): Restore the complete framed model and initial camera.
dispose(): Release controls, listeners, renderer, and loaded resources.

options accepts the data pack, accessibility label, view vectors, abort signal, asset resolver, callbacks, and canvas background. Public types include ViewerSelection, ViewerSelectionGroup, ViewerState, ViewerPhase, InteractionMode, StructureStyle, StructureSide, LateralSide, StructureSelectionOptions, StructureSelectionEntry, CreateSomakineOptions, SomakineViewer, ViewFit, AssetResolver, and Asset. Utilities: calculateViewFit · normalizeViewVector · createPrimitiveObject · findGltfNode · defaultAssetResolver · verifyAssetBytes · assertSelfContainedGlb · disposeObject3D · combineStructureSides · matchesSide · structureHighlightObjects · applySideVisibility · pickStructureHit.

The open body framework.

A small viewer API, ready for your interface.