Epok Engine

EPOK RUNTIME

epok::world2d::Service::joint_ends

Method · 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.

Method

The two ends of a joint: positions, bodies (null for a fixed end) and whether valid.

Belongs to
epok::world2d::Service
Header
world2d_service.hpp
Overloads
1

Declaration

Declaration
bool joint_ends(Joint2DComponent& joint, Fixed* pa, Fixed* pb, RigidBody2DComponent*& a, RigidBody2DComponent*& b)

The two ends of a joint: positions, bodies (null for a fixed end) and whether valid.

ParameterTypeMeaning
jointJoint2DComponent &Not documented; consult the linked header.
paFixed *Not documented; consult the linked header.
pbFixed *Not documented; consult the linked header.
aRigidBody2DComponent *&Not documented; consult the linked header.
bRigidBody2DComponent *&Not documented; consult the linked header.

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

Example sketch

C++ example
#include "world2d_service.hpp"

// Assume these named values have been initialized with valid data:
// Joint2DComponent & joint
// Fixed * pa
// Fixed * pb
// RigidBody2DComponent *& a
// RigidBody2DComponent *& b

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

auto result = object.joint_ends(joint, pa, pb, a, b);

Trade-offs and warnings

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

Declared in runtime/world2d_service.hpp:831

Related members