EPOK RUNTIME
epok::Skeleton2DComponent
Class
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.
Class
---- Skeleton2D ---------------------------------------------------------------------------
Basic usage
This generated sketch illustrates syntax for reaching the type; adapt it to the actual API contract. Open a member below for an operation-specific example.
C++ example
#include "world2d_skeleton.hpp"
epok::Skeleton2DComponent& value = /* obtain a valid instance from your game */;Fields and constants
bone_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.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.Fieldlink2dExposes `link2d` on `epok::Skeleton2DComponent` for the world2d skeleton module.FieldplayingExposes `playing` on `epok::Skeleton2DComponent` for the world2d skeleton module.FieldrestExposes `rest` on `epok::Skeleton2DComponent` for the world2d skeleton module.FieldspeedExposes `speed` on `epok::Skeleton2DComponent` for the world2d skeleton module.Fieldstatic_class_idExposes `static_class_id` on `epok::Skeleton2DComponent` for the world2d skeleton module.VariabletimeExposes `time` on `epok::Skeleton2DComponent` for the world2d skeleton module.FieldPublic methods
~Skeleton2DComponentReleases the resources owned by `epok::Skeleton2DComponent`.destructoradvanceCalled 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.MethodseekJumps 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.Method