Why use it
The boolean result makes success, availability or state explicit without exceptions.
EPOK RUNTIME
epok::skeletal_query_detail::bone_matrix
Function · 1 overload
Function
Performs `bone matrix` as part of rigid skeletal animation and pose evaluation.
Declaration
Declaration
inline bool bone_matrix(const SkeletalMesh& model,const Animator& animator,int16_t aim_bone,const int16_t* aim_stop_bones,Fixed aim_pitch,uint32_t bone,PoseKind pose,Affine<Fixed>& output)Performs `bone matrix` as part of rigid skeletal animation and pose evaluation.
| Parameter | Type | Meaning |
|---|---|---|
model | const SkeletalMesh & | Value supplied for model. Keep referenced or pointed-to data valid for the complete call. |
animator | const Animator & | Value supplied for animator. Keep referenced or pointed-to data valid for the complete call. |
aim_bone | int16_t | Value supplied for aim_bone. Keep referenced or pointed-to data valid for the complete call. |
aim_stop_bones | const int16_t * | Value supplied for aim_stop_bones. Keep referenced or pointed-to data valid for the complete call. |
aim_pitch | Fixed | Value supplied for aim_pitch. Keep referenced or pointed-to data valid for the complete call. |
bone | uint32_t | Value supplied for bone. Keep referenced or pointed-to data valid for the complete call. |
pose | PoseKind | Value supplied for pose. Keep referenced or pointed-to data valid for the complete call. |
output | Affine<Fixed> & | Value supplied for output. Keep referenced or pointed-to data valid for the complete call. |
Returns: bool. Check the value before continuing when it represents success, availability or a resource handle.
Example
C++ example
#include "skeletal.hpp"
// Assume these named values have been initialized with valid data:
// const SkeletalMesh & model
// const Animator & animator
// int16_t aim_bone
// const int16_t * aim_stop_bones
// Fixed aim_pitch
// uint32_t bone
// PoseKind pose
// Affine<Fixed> & output
auto result = epok::skeletal_query_detail::bone_matrix(model, animator, aim_bone, aim_stop_bones, aim_pitch, bone, pose, output);Trade-offs and warnings
Check the return value; `false` is part of normal control flow for many PSX resource operations. Pointer/reference arguments are borrowed unless the source contract says otherwise; keep them valid for the complete operation and never assume null is accepted.
Declared in runtime/skeletal.hpp:142
Related members
aabb_may_touchPerforms `aabb may touch` as part of bounded AABB collision queries and movement.Function templateaabb_overlapPerforms `aabb overlap` as part of bounded AABB collision queries and movement.Function templateaabb2d_containsPerforms `aabb2d contains` as part of the world2d module.Functionaabb2d_overlapPerforms `aabb2d overlap` as part of the world2d module.Functionaabb2d_touchPerforms `aabb2d touch` as part of the world2d module.Functionaabb2d_translatedPerforms `aabb2d translated` as part of the world2d module.Functionactivate_texture_bankPerforms `activate texture bank` as part of the epok module.Functionactive_cameraPerforms `active camera` as part of the epok module.Functionactor_for_slotPerforms `actor for slot` as part of the actor tables module.Functionallocate_actor_dataPerforms `allocate actor data` as part of the epok module.Functionattach_componentSpatial attachment between components of the same domain.Functionaudio_initializePerforms `audio initialize` as part of SPU sound playback and voice ownership.Function