Epok Engine

EPOK RUNTIME

epok::box_circle_overlap_2d

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

Closest point on the box to the circle centre; touching counts only when inclusive.

Belongs to
epok
Header
world2d.hpp
Overloads
1

Declaration

Declaration
inline bool box_circle_overlap_2d(const Aabb2D& box, const Fixed* center, Fixed radius, bool inclusive = false)

Closest point on the box to the circle centre; touching counts only when inclusive.

ParameterTypeMeaning
boxconst Aabb2D &Not documented; consult the linked header.
centerconst Fixed *Not documented; consult the linked header.
radiusFixedNot documented; consult the linked header.
inclusiveboolNot documented; consult the linked header.

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

Example sketch

C++ example
#include "world2d.hpp"

// Assume these named values have been initialized with valid data:
// const Aabb2D & box
// const Fixed * center
// Fixed radius
// bool inclusive

auto result = epok::box_circle_overlap_2d(box, center, radius, inclusive);

Trade-offs and warnings

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

Declared in runtime/world2d.hpp:369

Related members