Epok Engine

EPOK RUNTIME

epok::CollisionWorld::raycast

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

Segment query: delta is the complete displacement, not a unit direction.

Belongs to
epok::CollisionWorld
Header
collision.hpp
Overloads
1

Declaration

const
Declaration
SpatialHitT<Number> raycast(const Number* origin,const Number* delta,uint32_t mask=0xffffffffu,int ignore=-1,bool triggers=false) const

Segment query: delta is the complete displacement, not a unit direction.

ParameterTypeMeaning
originconst Number *Not documented; consult the linked header.
deltaconst Number *Not documented; consult the linked header.
maskuint32_tNot documented; consult the linked header.
ignoreintNot documented; consult the linked header.
triggersboolNot documented; consult the linked header.

Returns: SpatialHitT<Number>. Consult the linked header for its meaning.

Example sketch

C++ example
#include "collision.hpp"

// Assume these named values have been initialized with valid data:
// const Number * origin
// const Number * delta
// uint32_t mask
// int ignore
// bool triggers

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

auto result = object.raycast(origin, delta, mask, ignore, triggers);

Trade-offs and warnings

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

Declared in runtime/collision.hpp:379

Related members