openbone_core library
OpenBone runtime core for Dart: documents, instances, inputs, events, audio commands and the draw list, over the
native C++ runtime (libopenbone) through dart:ffi. No Flutter dependency; package:openbone/openbone.dart adds
the widget.
Classes
- OpenBoneAnimationInfo
- OpenBoneAudioAsset
- An image asset or atlas page a renderer has to provide. src is a data: URL or a path relative to the document. A sound file of the document: src is a data: URL or a path relative to the document.
- OpenBoneAudioBus
- A mixer bus of the document.
- OpenBoneAudioCommand
- A command for the host's audio engine (the runtime does not play sound itself).
- OpenBoneBindings
- dart:ffi bindings for libopenbone (runtimes/cpp/include/openbone.h). Generated by ffigen; do not edit.
- OpenBoneBone
- A bone's world transform: x' = ax + by + x0, y' = cx + dy + y0 (skeleton space, y up).
- OpenBoneBoundingBox
- One active bounding box: the world polygon of a slot's current bounding-box attachment.
- OpenBoneClip
- OpenBoneDocument
- A loaded document. Immutable; share it between any number of OpenBoneInstances (each keeps the native document alive on its own, so disposing the document while instances run is safe).
- OpenBoneDrawItem
- One draw call worth of geometry (skeleton space, y up), in draw order.
- OpenBoneDrawList
- OpenBoneEvent
- OpenBoneInputInfo
- OpenBoneInstance
- A playing skeleton: animation tracks or a state machine, inputs, pointer events, pose and draw list.
- OpenBoneLog
- OpenBoneNative
-
Access to the native library. OpenBoneNative.libraryPath may be set before first use to load a specific build;
otherwise
OPENBONE_LIBRARY(environment) is tried, then the platform's bundled plugin library, then a host build made bytool/build_native.sh(.dart_tool/openbone_native/). - OpenBoneSkeletonBounds
- The active bounding boxes of an instance for one pose: every slot, in draw order, whose bone is active and whose current attachment is a bounding box. A snapshot: call update (or OpenBoneInstance.boundingBoxes again) after the pose changes. All coordinates are skeleton space. With no box, aabb is null and every query returns nothing.
- OpenBoneSlot
- OpenBoneStateChange
- OpenBoneStateMachineInfo
- OpenBoneText
- OpenBoneTexture
Enums
- OpenBoneAudioType
-
play / stop / fade a sound; mix: a mute button muted or unmuted a bus (
busnull = everything, seemuted). - OpenBoneBlend
- OpenBoneInputType
- OpenBoneItemKind
- OpenBonePointerType
Constants
- openBoneParticleDotTexture → const String
-
The texture id of the runtime's built-in soft particle sprite (no image file; see
ob_particle_dot_alpha).
Exceptions / Errors
- OpenBoneException
-
Thrown when the native runtime reports a failure (the message is
ob_last_error()).