Skip to content

Choose an integration mode

Full editor

Choose ModelLabEditor for content pipelines, QA tools, model debugging, and visual authoring. It includes the largest UI and should normally remain out of customer-facing bundles.

Production viewer

Choose ModelLabViewer when the package should own the canvas, model loading, camera controls, environment, lighting, animation playback, material restoration, and sequence runtime.

Headless runtime

Choose the headless entry points when your application already owns a React Three Fiber <Canvas>. Combine:

  • ModelPivotGroup for corrected rotation axes.
  • ImmersiveSequencePlayer for camera/model/light playback.
  • CinematicEffectDriver for animated materials.
  • applyMaterialOverrides for exported material state.

Utility-only integration

Utilities such as setViewerPivot, sampleSequence, and parseViewerPreset can be used without rendering any component.

Decision table

RequirementRecommended entry point
Internal authoring tool/editor
Drop-in production viewer/viewer
Existing custom canvas/sequence, /pivot, /effects
Validate JSON on a server or build step/viewer schema functions
Change pivot in stored configuration/pivot

Released under the MIT License.