EPOK RUNTIME
World2D Skeleton
world2d_skeleton.hpp · the world2d skeleton module
Declarations are extracted from the pinned headers. Examples and general guidance are generated sketches, not verified complete programs; consult the linked source and guides for the actual contract.
Module
the world2d skeleton module.
Include this module
C++ include
#include "world2d_skeleton.hpp"Types
Skeleton2DComponent---- Skeleton2D ---------------------------------------------------------------------------ClassSkeletonClip2DOne animation: `key_count` poses at increasing `times` (seconds), each `bone_count` (rotation, x, y) triples in the skeleton's bone order.StructSkeletonIk2DA two-bone IK chain: `upper` and `lower` index the skeleton's bones; `tip` is the actor at the end of the lower bone and `target` the actor it reaches for.StructFunctions and methods
~Skeleton2DComponentReleases the resources owned by `epok::Skeleton2DComponent`.destructoractor_rootThe root transform of an actor, or null.FunctionadvanceCalled by the service every simulation step: advances the animation, poses the bones, then solves the IK chains.MethodapplyPoses the bones at `seconds` of the current animation.Methodclass_idPerforms `class id` as part of the world2d skeleton module.Methodget_animationReturns animation as part of the world2d skeleton module.Methodget_animation_countReturns animation count as part of the world2d skeleton module.Methodget_boneReturns bone as part of the world2d skeleton module.Methodget_bone_countReturns bone count as part of the world2d skeleton module.Methodget_speedReturns speed as part of the world2d skeleton module.Methodget_timeReturns time as part of the world2d skeleton module.Methodis_ik_enabledReports whether ik enabled as part of the world2d skeleton module.Methodis_playingReports whether playing as part of the world2d skeleton module.Methodlevel_attachedPerforms `level attached` as part of the world2d skeleton module.MethodplayStarts animation `index` from its beginning; an index out of range stops.Methodreset_poseStops and puts every bone back in its rest pose.Methodroot_worldPerforms `root world` as part of the world2d skeleton module.FunctionseekJumps the current animation to `seconds` and poses the bones at once.Methodset_ik_enabledSets ik enabled as part of the world2d skeleton module.Methodset_ik_targetSets ik target as part of the world2d skeleton module.Methodset_speedSets speed as part of the world2d skeleton module.MethodstopStops stop as part of the world2d skeleton module.Methodtake_finishedTrue once after a non-looping animation reaches its end.Methodwrap_degrees_rawAn angle in raw Q12 degrees brought into (-180, 180].FunctionFields, variables and values
bend_positiveExposes `bend_positive` on `epok::SkeletonIk2D` for the world2d skeleton module.Fieldbone_countExposes `bone_count` on `epok::Skeleton2DComponent` for the world2d skeleton module.FieldbonesCooked: bone actors, their rest pose (rotation, x, y), animations and IK chains.FieldclipPlayback.Fieldclip_countExposes `clip_count` on `epok::Skeleton2DComponent` for the world2d skeleton module.FieldclipsExposes `clips` on `epok::Skeleton2DComponent` for the world2d skeleton module.Fielddegrees_turn_rawExposes `degrees_turn_raw` on the `epok::world2d` namespace for the world2d skeleton module.VariableenabledExposes `enabled` on `epok::SkeletonIk2D` for the world2d skeleton module.FieldfinishedExposes `finished` on `epok::Skeleton2DComponent` for the world2d skeleton module.FieldikExposes `ik` on `epok::Skeleton2DComponent` for the world2d skeleton module.Fieldik_countExposes `ik_count` on `epok::Skeleton2DComponent` for the world2d skeleton module.Fieldkey_countExposes `key_count` on `epok::SkeletonClip2D` for the world2d skeleton module.FieldlengthExposes `length` on `epok::SkeletonClip2D` for the world2d skeleton module.Fieldlink2dExposes `link2d` on `epok::Skeleton2DComponent` for the world2d skeleton module.FieldloopingExposes `looping` on `epok::SkeletonClip2D` for the world2d skeleton module.FieldlowerExposes `lower` on `epok::SkeletonIk2D` for the world2d skeleton module.FieldplayingExposes `playing` on `epok::Skeleton2DComponent` for the world2d skeleton module.FieldposesExposes `poses` on `epok::SkeletonClip2D` for the world2d skeleton module.FieldrestExposes `rest` on `epok::Skeleton2DComponent` for the world2d skeleton module.Fieldskeleton2d_bone_limitExposes `skeleton2d_bone_limit` on the `epok::world2d` namespace for the world2d skeleton module.Variableskeleton2d_ik_limitExposes `skeleton2d_ik_limit` on the `epok::world2d` namespace for the world2d skeleton module.VariableskeletonsExposes `skeletons` on the `epok::world2d` namespace for the world2d skeleton module.VariablespeedExposes `speed` on `epok::Skeleton2DComponent` for the world2d skeleton module.Fieldstatic_class_idExposes `static_class_id` on `epok::Skeleton2DComponent` for the world2d skeleton module.VariabletargetExposes `target` on `epok::SkeletonIk2D` for the world2d skeleton module.FieldtimeExposes `time` on `epok::Skeleton2DComponent` for the world2d skeleton module.FieldtimesExposes `times` on `epok::SkeletonClip2D` for the world2d skeleton module.FieldtipExposes `tip` on `epok::SkeletonIk2D` for the world2d skeleton module.FieldupperExposes `upper` on `epok::SkeletonIk2D` for the world2d skeleton module.Field