Epok Engine

EPOK RUNTIME

epok::skeletal_query_detail::model_vertex

Function · 1 overload

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.

Function

Performs `model vertex` as part of rigid skeletal animation and pose evaluation.

Belongs to
epok::skeletal_query_detail
Header
skeletal.hpp
Overloads
1

Declaration

Declaration
inline bool model_vertex(const SkeletalMesh& model,const Animator& animator,int16_t aim_bone,const int16_t* aim_stop_bones,Fixed aim_pitch,uint32_t portable,PoseKind pose,Fixed* output,SkeletalError& error)

Performs `model vertex` as part of rigid skeletal animation and pose evaluation.

ParameterTypeMeaning
modelconst SkeletalMesh &Not documented; consult the linked header.
animatorconst Animator &Not documented; consult the linked header.
aim_boneint16_tNot documented; consult the linked header.
aim_stop_bonesconst int16_t *Not documented; consult the linked header.
aim_pitchFixedNot documented; consult the linked header.
portableuint32_tNot documented; consult the linked header.
posePoseKindNot documented; consult the linked header.
outputFixed *Not documented; consult the linked header.
errorSkeletalError &Not documented; consult the linked header.

Returns: bool. Consult the linked header for its meaning.

Example sketch

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 portable
// PoseKind pose
// Fixed * output
// SkeletalError & error

auto result = epok::skeletal_query_detail::model_vertex(model, animator, aim_bone, aim_stop_bones, aim_pitch, portable, pose, output, error);

Trade-offs and warnings

Consult the linked header for this operation’s ownership, lifetime and failure behavior.

Declared in runtime/skeletal.hpp:189

Related members