Epok Engine

EPOK RUNTIME

epok::world2d::set_world_position

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

Moves the owner's root so its world position becomes `world`, through the inverse of the parent chain's linear part when the root is attached.

Belongs to
epok::world2d
Header
world2d_content.hpp
Overloads
1

Declaration

Declaration
inline bool set_world_position(SceneComponent2D& root, const Fixed* world)

Moves the owner's root so its world position becomes `world`, through the inverse of the parent chain's linear part when the root is attached.

ParameterTypeMeaning
rootSceneComponent2D &Not documented; consult the linked header.
worldconst Fixed *Not documented; consult the linked header.

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

Example sketch

C++ example
#include "world2d_content.hpp"

// Assume these named values have been initialized with valid data:
// SceneComponent2D & root
// const Fixed * world

auto result = epok::world2d::set_world_position(root, world);

Trade-offs and warnings

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

Declared in runtime/world2d_content.hpp:73

Related members