Epok Engine

EPOK RUNTIME

epok::skeletal_query_detail::apply_space

Function · 1 overload

Function

Performs `apply space` as part of rigid skeletal animation and pose evaluation.

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

Declaration

Declaration
inline bool apply_space(const ActorData& entity,CoordinateSpace space,Fixed* position,SkeletalError& error)

Performs `apply space` as part of rigid skeletal animation and pose evaluation.

ParameterTypeMeaning
entityconst ActorData &Value supplied for entity. Keep referenced or pointed-to data valid for the complete call.
spaceCoordinateSpaceValue supplied for space. Keep referenced or pointed-to data valid for the complete call.
positionFixed *Value supplied for position. Keep referenced or pointed-to data valid for the complete call.
errorSkeletalError &Value supplied for error. 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 ActorData & entity
// CoordinateSpace space
// Fixed * position
// SkeletalError & error

auto result = epok::skeletal_query_detail::apply_space(entity, space, position, error);

Why use it

The boolean result makes success, availability or state explicit without exceptions.

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:184

Related members