Skip to content

EPOK RUNTIME

World2D

world2d.hpp · the world2d module

Module

the world2d module.

Header: world2d.hpp
Include: #include "world2d.hpp"
Stability: Epok runtime API

Include this module

C++ include

#include "world2d.hpp"

Types

Aabb2DStruct declared by the world2d module for the world2d module.Struct Affine2D2x3 affine matrix: linear part `m` (rotation and scale, shear when inherited) plus the translation `t`.Struct Camera2D---- Camera2D ------------------------------------------------------------------------ Projection convention (no dependency whatsoever on the 3D camera or on projection_focal): screen = viewport_center + R(-camera.rotation) * (world - camera.position) * k with k = zoom * pixels_per_unit_2d, and the screen Y axis pointing DOWN while the world Y axis points UP, so the Y component is negated.Struct Collider2D---- 2D colliders -------------------------------------------------------------------- Semantics and deliberate limits: * A collider is placed by a world position plus `offset`, both in world axes.Struct ColliderEntry2DOne synchronized collider.Struct CollisionWorld2DBounded 2D collision world mirroring the shape of epok::CollisionWorld: fixed capacity, no allocation, conservative world AABBs for the broad phase and for sweeps, exact shape tests for triggers.Class template MoveResult2DStruct declared by the world2d module for the world2d module.Struct Pick2DEntryOne candidate for pick_2d: its world AABB and its draw key.Struct ShapeEnum declared by the world2d module for the world2d module.Enum SineTable2DStruct declared by the world2d module for the world2d module.Struct SpatialHit2DStruct declared by the world2d module for the world2d module.Struct

Functions and methods

aabb2d_containsPerforms `aabb2d contains` as part of the world2d module.Function aabb2d_overlapPerforms `aabb2d overlap` as part of the world2d module.Function aabb2d_touchPerforms `aabb2d touch` as part of the world2d module.Function aabb2d_translatedPerforms `aabb2d translated` as part of the world2d module.Function boundsPerforms `bounds` as part of the world2d module.Method box_circle_overlap_2dClosest point on the box to the circle centre; touching counts only when inclusive.Function camera2d_pixels_per_unitPerforms `camera2d pixels per unit` as part of the world2d module.Function camera2d_viewport_centerPerforms `camera2d viewport center` as part of the world2d module.Function circle_overlap_2dPerforms `circle overlap 2d` as part of the world2d module.Function clamp_raw_2dSaturating conversion of a raw Q12 accumulator back into Fixed.Function clearClears clear as part of the world2d module.Method collider2d_boundsPerforms `collider2d bounds` as part of the world2d module.Function collider2d_centerWorld centre of a collider: the owner's world position plus the (unrotated) offset.Function collider2d_overlapShape-aware pair test in world space.Function composeparent * child: the child's local matrix expressed in the parent's space.Function cos_degreesPerforms `cos degrees` as part of the world2d module.Function directionSame as point() without the translation: for directions, extents and velocities.Method disablePerforms `disable` as part of the world2d module.Method distance_squared_raw_2dSquared distance in raw Q24; |position| <= 8192 keeps this inside 2^51.Function draw_key_2d---- draw order ---------------------------------------------------------------------- A single monotonically comparable key so the renderer never needs a multi-field comparator: layer (int8, coarse) above draw_order (int16) above the creation index (uint16, the tie breaker that makes the order stable and reproducible across frames).Function fixed_in_rangePerforms `fixed in range` as part of the world2d module.Function identityPerforms `identity` as part of the world2d module.Method livePerforms `live` as part of the world2d module.Method local_matrixLocal matrix of a Transform2D: translate * rotate * scale, applied in that order to a point (scale first, then rotation, then translation).Function make_sine_table_2dPerforms `make sine table 2d` as part of the world2d module.Function move_and_slide_2dAxis-separated resolution: X is applied first and clipped against every blocking box whose Y span overlaps, then Y is applied against the updated position.Method mul_2dPerforms `mul 2d` as part of the world2d module.Function operator boolPerforms `operator bool` as part of the world2d module.Conversion operator overlapReturns the total number of matches; only the first `output_capacity` are written.Method pick_2dTopmost entry under a screen point (highest draw key wins; ties go to the lowest index, which keeps the result stable).Function pointPerforms `point` as part of the world2d module.Method positionPerforms `position` as part of the world2d module.Method raycast2d`displacement` is the complete segment, not a unit direction.Method screen_to_worldExact inverse of world_to_screen up to Q12 rounding.Function setSets set as part of the world2d module.Method sin_degreesSine of an angle in degrees.Function sine_quarter_2dsin of an angle inside the first quadrant, expressed in raw Q12 degrees [0, 90*4096].Function sine_series_2dPerforms `sine series 2d` as part of the world2d module.Function sort_draw_orderBounded, allocation-free, stable insertion sort of an index array by draw key.Function template syncReplaces the whole live set in one call; slots beyond `count` become disabled and therefore produce trigger exits on the next update_triggers().Method transform2d_clampClamps into the documented range instead of rejecting.Function transform2d_validDocumented validity of a Transform2D.Function update_triggersEnter/Stay/Exit per pair, exactly once each, using the exact shape tests.Function template world_matrix_2dWorld matrix of a SceneComponent2D by walking its attach_parent chain.Function template world_to_screenPerforms `world to screen` as part of the world2d module.Function

Fields, variables and values

activeExposes `active` on `epok::ColliderEntry2D` for the world2d module.Field blockedExposes `blocked` on `epok::MoveResult2D` for the world2d module.Field boxExposes `box` on `epok::Pick2DEntry` for the world2d module.Field BoxNamed value `Box` in `epok::Collider2D::Shape`.Enum value CircleNamed value `Circle` in `epok::Collider2D::Shape`.Enum value colliderExposes `collider` on `epok::ColliderEntry2D` for the world2d module.Field degrees_per_quarter_rawExposes `degrees_per_quarter_raw` on the `epok::detail` namespace for the world2d module.Variable degrees_per_turn_rawExposes `degrees_per_turn_raw` on the `epok::detail` namespace for the world2d module.Variable displacementExposes `displacement` on `epok::MoveResult2D` for the world2d module.Field dropped_trigger_pairsExposes `dropped_trigger_pairs` on `epok::CollisionWorld2D` for the world2d module.Field enabledExposes `enabled` on `epok::Collider2D` for the world2d module.Field enabledExposes `enabled` on `epok::Pick2DEntry` for the world2d module.Field fractionExposes `fraction` on `epok::SpatialHit2D` for the world2d module.Field generationExposes `generation` on `epok::ColliderEntry2D` for the world2d module.Field generationExposes `generation` on `epok::SpatialHit2D` for the world2d module.Field half_extentsExposes `half_extents` on `epok::Collider2D` for the world2d module.Field indexExposes `index` on `epok::MoveResult2D` for the world2d module.Field indexExposes `index` on `epok::SpatialHit2D` for the world2d module.Field keyExposes `key` on `epok::Pick2DEntry` for the world2d module.Field layerExposes `layer` on `epok::Collider2D` for the world2d module.Field layer_maskExposes `layer_mask` on `epok::Collider2D` for the world2d module.Field mExposes `m` on `epok::Affine2D` for the world2d module.Field maxExposes `max` on `epok::Aabb2D` for the world2d module.Field minExposes `min` on `epok::Aabb2D` for the world2d module.Field normalExposes `normal` on `epok::MoveResult2D` for the world2d module.Field normalExposes `normal` on `epok::SpatialHit2D` for the world2d module.Field offsetExposes `offset` on `epok::Collider2D` for the world2d module.Field pixels_per_unit_2dScreen pixels covered by one world unit at zoom 1.Variable pointExposes `point` on `epok::SpatialHit2D` for the world2d module.Field positionExposes `position` on `epok::Camera2D` for the world2d module.Field positionExposes `position` on `epok::ColliderEntry2D` for the world2d module.Field radiusExposes `radius` on `epok::Collider2D` for the world2d module.Field rotationExposes `rotation` on `epok::Camera2D` for the world2d module.Field shapeExposes `shape` on `epok::Collider2D` for the world2d module.Field sine_step_raw1440, exactVariable sine_table_2dExposes `sine_table_2d` on the `epok::detail` namespace for the world2d module.Variable started_insideExposes `started_inside` on `epok::SpatialHit2D` for the world2d module.Field tExposes `t` on `epok::Affine2D` for the world2d module.Field triggerExposes `trigger` on `epok::Collider2D` for the world2d module.Field unresolved_overlapExposes `unresolved_overlap` on `epok::MoveResult2D` for the world2d module.Field valuesExposes `values` on `epok::detail::SineTable2D` for the world2d module.Field viewportx, y, width, height in pixels.Field world2d_depth_limitMaximum length of an attachment chain resolved in one call (root included).Variable world2d_position_limitExposes `world2d_position_limit` on the `epok` namespace for the world2d module.Variable world2d_scale_limitExposes `world2d_scale_limit` on the `epok` namespace for the world2d module.Variable zoomExposes `zoom` on `epok::Camera2D` for the world2d module.Field