Epok Engine

EPOK RUNTIME

epok::character3d::advance

Function · 2 overloads

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 `advance` as part of shared world-unit character commands, collision locomotion and motion samples.

Belongs to
epok::character3d
Header
character3d.hpp
Overloads
2

Declaration 1 of 2

Declaration
inline CharacterMotionSample3D advance(ActorData& body,State& state,const Tuning& t,const CharacterCommand3D& command,Fixed dt)

Performs `advance` as part of shared world-unit character commands, collision locomotion and motion samples.

ParameterTypeMeaning
bodyActorData &Not documented; consult the linked header.
stateState &Not documented; consult the linked header.
tconst Tuning &Not documented; consult the linked header.
commandconst CharacterCommand3D &Not documented; consult the linked header.
dtFixedNot documented; consult the linked header.

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

Example sketch

C++ example
#include "character3d.hpp"

// Assume these named values have been initialized with valid data:
// ActorData & body
// State & state
// const Tuning & t
// const CharacterCommand3D & command
// Fixed dt

auto result = epok::character3d::advance(body, state, t, command, dt);

Trade-offs and warnings

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

Declared in runtime/character3d.hpp:93

Declaration 2 of 2

template
Declaration
template<class Queries> inline CharacterMotionSample3D advance(ActorData& body,State& state,const Tuning& t,const CharacterCommand3D& command,Fixed dt,Queries& queries,bool measure_speed=true)

A query adapter can reuse an already synchronized world without changing the motor's integration/contact rules.

ParameterTypeMeaning
bodyActorData &Not documented; consult the linked header.
stateState &Not documented; consult the linked header.
tconst Tuning &Not documented; consult the linked header.
commandconst CharacterCommand3D &Not documented; consult the linked header.
dtFixedNot documented; consult the linked header.
queriesQueries &Not documented; consult the linked header.
measure_speedboolNot documented; consult the linked header.

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

Example sketch

C++ example
#include "character3d.hpp"

// Replace these template arguments with types or values accepted by the declaration:
// Queries

// Assume these named values have been initialized with valid data:
// ActorData & body
// State & state
// const Tuning & t
// const CharacterCommand3D & command
// Fixed dt
// Queries & queries
// bool measure_speed

epok::character3d& object = /* obtain a valid instance */;

auto result = object.advance<Queries>(body, state, t, command, dt, queries, measure_speed);

Trade-offs and warnings

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

Declared in runtime/character3d.hpp:53

Related members