Epok Engine

EPOK RUNTIME

Navigation

navigation.hpp · the navigation module

Module

the navigation module.

Header
navigation.hpp
Include
#include "navigation.hpp"
Stability
Epok runtime API

Include this module

C++ include
#include "navigation.hpp"

Types

GraphStruct declared by the navigation module for the navigation module.StructHandleStruct declared by the navigation module for the navigation module.StructNodeStruct declared by the navigation module for the navigation module.StructObstacleStruct declared by the navigation module for the navigation module.StructRequestStruct declared by the navigation module for the navigation module.StructStatsStruct declared by the navigation module for the navigation module.StructStatusEnum declared by the navigation module for the navigation module.EnumSurfaceStruct declared by the navigation module for the navigation module.StructTraversalStruct declared by the navigation module for the navigation module.StructWorldClass declared by the navigation module for the navigation module.Class

Functions and methods

add_obstacleAdds obstacle as part of the navigation module.MethodcancelPerforms `cancel` as part of the navigation module.Methodedge_openPerforms `edge open` as part of the navigation module.MethodfloorBarycentric floor query in Q8; the closest reachable layer wins.MethodgetReturns get as part of the navigation module.MethodlocatePerforms `locate` as part of the navigation module.MethodoccupyPerforms `occupy` as part of the navigation module.MethodrebuildReplace the current topology (procedural levels/streaming).Methodremove_obstacleRemoves obstacle as part of the navigation module.MethodreplanPerforms `replan` as part of the navigation module.MethodrequestRequests request as part of the navigation module.MethodreservePerforms `reserve` as part of the navigation module.MethodresetResets reset as part of the navigation module.Methodset_obstacleSets obstacle as part of the navigation module.MethodtickPerforms `tick` as part of the navigation module.MethodtraversalPerforms `traversal` as part of the navigation module.MethodupdatingPerforms `updating` as part of the navigation module.Method

Fields, variables and values

arcExposes `arc` on `epok::nav::Traversal` for the navigation module.FieldArrivedNamed value `Arrived` in `epok::nav::Status`.Enum valueavoidExposes `avoid` on `epok::nav::Request` for the navigation module.FieldBlockedNamed value `Blocked` in `epok::nav::Status`.Enum valuebudgetIntentionally public budget, shared by ALL agents; set once per frame.FieldcompletedExposes `completed` on `epok::nav::Stats` for the navigation module.FieldcountExposes `count` on `epok::nav::Graph` for the navigation module.FielddurationExposes `duration` on `epok::nav::Traversal` for the navigation module.FieldexpandedExposes `expanded` on `epok::nav::Stats` for the navigation module.FieldfromExposes `from` on `epok::nav::Request` for the navigation module.FieldfromExposes `from` on `epok::nav::Traversal` for the navigation module.FieldgenerationExposes `generation` on `epok::nav::Handle` for the navigation module.FieldgenerationExposes `generation` on `epok::nav::Request` for the navigation module.FieldgraphExposes `graph` on `epok::nav::World` for the navigation module.FieldheightExposes `height` on `epok::nav::Graph` for the navigation module.FieldIdleNamed value `Idle` in `epok::nav::Status`.Enum valueinvalidExposes `invalid` on the `epok::nav` namespace for the navigation module.VariablekindExposes `kind` on `epok::nav::Traversal` for the navigation module.FieldlengthExposes `length` on `epok::nav::Request` for the navigation module.FieldlinksExposes `links` on `epok::nav::Node` for the navigation module.FieldmaxExposes `max` on `epok::nav::World::Obstacle` for the navigation module.Fieldmax_nodesExposes `max_nodes` on the `epok::nav` namespace for the navigation module.Variablemax_obstaclesExposes `max_obstacles` on `epok::nav::World` for the navigation module.Variablemax_pathExposes `max_path` on the `epok::nav` namespace for the navigation module.Variablemax_requestsExposes `max_requests` on the `epok::nav` namespace for the navigation module.VariableminExposes `min` on `epok::nav::World::Obstacle` for the navigation module.FieldnodesExposes `nodes` on `epok::nav::Graph` for the navigation module.FieldNoPathNamed value `NoPath` in `epok::nav::Status`.Enum valueoccupiedExposes `occupied` on `epok::nav::Request` for the navigation module.FieldOffGraphNamed value `OffGraph` in `epok::nav::Status`.Enum valuepExposes `p` on `epok::nav::Surface` for the navigation module.FieldpathExposes `path` on `epok::nav::Request` for the navigation module.FieldQueuedNamed value `Queued` in `epok::nav::Status`.Enum valueradiusExposes `radius` on `epok::nav::Graph` for the navigation module.FieldReadyNamed value `Ready` in `epok::nav::Status`.Enum valuerebuiltExposes `rebuilt` on `epok::nav::Stats` for the navigation module.FieldrejectedExposes `rejected` on `epok::nav::Stats` for the navigation module.FieldrequestsExposes `requests` on `epok::nav::World` for the navigation module.FieldreservedExposes `reserved` on `epok::nav::Request` for the navigation module.FieldrevisionExposes `revision` on `epok::nav::Request` for the navigation module.FieldrevisionExposes `revision` on `epok::nav::World` for the navigation module.FieldSearchingNamed value `Searching` in `epok::nav::Status`.Enum valueslotExposes `slot` on `epok::nav::Handle` for the navigation module.FieldsnapExposes `snap` on `epok::nav::Graph` for the navigation module.FieldstatsExposes `stats` on `epok::nav::World` for the navigation module.FieldstatusExposes `status` on `epok::nav::Request` for the navigation module.FieldstepExposes `step` on `epok::nav::Graph` for the navigation module.Fieldsurface_countExposes `surface_count` on `epok::nav::Graph` for the navigation module.FieldsurfacesExposes `surfaces` on `epok::nav::Graph` for the navigation module.FieldtoExposes `to` on `epok::nav::Request` for the navigation module.FieldtoExposes `to` on `epok::nav::Traversal` for the navigation module.FieldTooLongNamed value `TooLong` in `epok::nav::Status`.Enum valuetraversal_countExposes `traversal_count` on `epok::nav::Graph` for the navigation module.FieldtraversalsExposes `traversals` on `epok::nav::Graph` for the navigation module.FieldusedExposes `used` on `epok::nav::Request` for the navigation module.FieldusedExposes `used` on `epok::nav::World::Obstacle` for the navigation module.FieldworkExposes `work` on `epok::nav::Stats` for the navigation module.FieldworldOne fixed workspace shared by all agents and reused on scene transitions.VariablexExposes `x` on `epok::nav::Node` for the navigation module.FieldyExposes `y` on `epok::nav::Node` for the navigation module.FieldyieldsExposes `yields` on `epok::nav::Stats` for the navigation module.FieldzExposes `z` on `epok::nav::Node` for the navigation module.Field