PathEngine home | previous: | next: |
iMesh objects are ground surfaces ('meshes') on which agents can move, together with things like placed obstacles, preprocess and data structures to enable things like collision and pathfinding queries.
Defined in SDKRoot/code/externalAPI/i_pathengine.h.
(See
The iMesh interface controls preprocess generation for this ground surface, the placement of agents on this ground surface, and creation of collision contexts for those agents. This interface also provides queries about possibilities for movement on this mesh.
See also
Adds a set of anchors and shapes,
represented in the form of an object derived from the | ||
Increments the internal reference count for this API object. | ||
Adds an endpoint for use with the off-mesh connections feature. | ||
Increments the internal reference count for this API object. | ||
Tells PathEngine about the possibility for agents to move 'off-mesh' between a pair of endpoints. | ||
Enables automatic generation of off-mesh connections based on the generation of sample points around the mesh edge and a callback object that determines whether connection is possible for a given pair of sample points. | ||
Adds boundaries corresponding to the set of obstacles in a context to the mesh's base circuits. | ||
Calculates the movement cost for a given line, as applied during pathfinding. | ||
Clears all anchors currently stored on this mesh. | ||
Removes any named obstacles stored on this mesh. | ||
Removes any off-mesh connections or off-mesh connection endpoints associated with a mesh. | ||
Provided to enable | ||
Creates a copy of a path object. | ||
Finds the closest unobstructed position, if one exists within a specified region around a given position. | ||
Finds the closest unobstructed position to a specified target, within a specified query range and within local mesh as defined by a set of supplied root positions, if one exists (with an optional connectivity constraint based on connected regions preprocess). | ||
Finds the shortest path of escape from a specified region from a given start position. | ||
Finds the shortest path of escape from a specified region from a given start position. | ||
Finds the shortest path from a given start position to a given end position for agents with a specified collision shape. | ||
Finds the shortest path from a given start position to a given end position for agents with a specified collision shape. | ||
Finds the shortest path from a given set of start positions to a given end position for agents with a specified collision shape. | ||
Finds the shortest path
from a given set of start positions to a given end position
for agents with a specified collision shape. | ||
Finds the shortest path
from a given start position to a given end position
for agents with a specified collision shape. | ||
Determines the first contact, if any, for an agent with the specified collision shape moving along the specified line. | ||
Background preprocess generation version of | ||
Background preprocess generation version of | ||
Background preprocess generation version of | ||
Background preprocess generation version of | ||
Background preprocess generation version of | ||
Generates preprocess data relating to connectivity between unobstructed space boundaries, to support connected region queries. | ||
Post process path smoothing. | ||
Post process path smoothing. | ||
Generates (release 6 type) preprocess data for pathfinding around agent unobstructed space. | ||
Generates preprocess data for pathfinding around agent unobstructed space. | ||
Generates a random position on the surface of this mesh. | ||
Generates a random position in the specified section. | ||
Generates a random position on the region of a mesh local to the specified centre position. | ||
Generates a representation of (expanded) unobstructed space boundaries for the specified agent shape, on this mesh. | ||
Generates a representation of (expanded) unobstructed space boundaries for the specified agent shape, on this mesh. | ||
A helper function for obtaining information about the 3D mesh under a position. | ||
Used to query ground attributes. | ||
Helper function providing access to the geometry of the underlying 3D mesh. | ||
Returns a normal vector for a face in the underlying 3d mesh. | ||
Helper function providing access to the geometry of the underlying 3D mesh. | ||
Helper function providing access to the geometry of the underlying 3D mesh. | ||
Fills a buffer with the set of agents in a given context overlapped by the given shape at the given position. | ||
Returns the root position for the specified burnt in obstacle, or an explicitly invalid position (position with cell set to -1) in the case of a 2D obstacle. | ||
Returns the coordinates of the specified burnt in obstacle vertex. | ||
Returns the number of vertices in the burnt in obstacle at the given index. | ||
Traverses along the surface of a ground mesh to disambiguate overlapping geometry at a target point. | ||
Returns an index for the connected region at a given position. This can be used to quickly determine the reachability between positions. | ||
Returns an index for the connected region for an agent's current position. | ||
Helper function for retrieving the positions for off-mesh connection endpoints stored with a mesh. | ||
Helper method to obtain the mesh federation tile index. | ||
A helper function to access the ground surface object for a mesh. | ||
Helper function providing access to the geometry of the underlying 3D mesh. | ||
Returns the number of anchors stored with this mesh. | ||
Enables iteration through the set of obstacles burnt into a mesh. | ||
Returns the number of distinct regions in connected region preprocess for the specified shape. | ||
Helper function returning the number of off-mesh connection endpoints stored with a mesh. | ||
Returns the number of fixed obstacles stored with this mesh. | ||
Helper function returning the number of off-mesh connections stored with a mesh. | ||
Helper function returning the number of sections present in the underlying 3D mesh. | ||
Helper function for retrieving information about off-mesh connections stored with a mesh. | ||
Helper for querying local origin of mesh, e.g. for mesh federation tiles. | ||
Returns the section ID for a given position. | ||
Queries for the surface type value associated with the given position on a ground mesh. | ||
Enables you to check whether there are any outstanding references on this object, other than the interface reference through which you are calling, and therefore whether this object will actually be deleted if you call its release method. | ||
Provides the height for a position on the surface of this ground mesh. | ||
Provides the height for a position on the surface of this ground mesh (as a float). | ||
Provides the height for a position on the surface of this ground mesh as a float, taking account of the precision components of the position supplied. | ||
Loads connected region preprocess from persistent storage. | ||
Loads internal data relating to a path from persistent storage. | ||
Loads pathfind preprocess from persistent storage. | ||
Loads unobstructed space from persistent storage. | ||
Creates an | ||
Creates a free standing obstacle set. | ||
Creates a free standing obstacle set. | ||
Constructs an | ||
Constructs an | ||
Constructs an | ||
Constructs an | ||
Helper method for testing whether horizontal coordinates are inside a 3D face. | ||
Enables you to obtain a position on a mesh underneath a point in 3D space. | ||
Used for resolving anchor positions in the case where the anchor should not resolve to 'terrain stand-in' geometry. | ||
Helper for constructing a cPosition from horizontal coordinates and 3D face index. | ||
Obtains a position in the specified section and at the given coordinates, if such a position exists. | ||
Variation on | ||
Attempts to find a cPosition that is both within the specified section and also inside the supplied polygon. | ||
Variation on | ||
Checks whether a position has been marked as blocked through the surface type traverse costs mechanism. | ||
Returns whether or not the specified position is a valid position on this mesh. | ||
Enables you to resolve a position in 3d space to a nearby position on the surface of this ground mesh. | ||
Tells PathEngine that it is ok to discard any data associated with this mesh that is only required for generating unobstructed space or preprocess. | ||
Promotes background preprocess generated for the specified shape to main preprocess, with this then taking effect for any subsequent queries. | ||
A helper function to access the ground surface object for a mesh. | ||
Releases the API object pointer. | ||
Releases unobstructed space previously generated by generateBackgroundUnobstructedSpaceFor(). | ||
Releases connected region preprocess previously generated by generateConnectedRegionPreprocessFor(). | ||
Releases pathfind preprocess previously generated by generatePathfindPreprocessFor(). | ||
Releases unobstructed space previously generated by generateUnobstructedSpaceFor(). | ||
A helper method for drawing the (expanded) unobstructed space boundaries for a pathfinding obstacle. | ||
A helper method for drawing the boundaries for any base obstacles placed on this mesh. | ||
A helper method for drawing lines that hug the surface of the 3D ground mesh. | ||
A helper method for drawing unobstructed space boundary lines. | ||
A helper method for visualising horizontal range boundaries. | ||
A helper method for visualising horizontal range boundaries. | ||
A helper method for visual confirmation of boundaries split off for pathfind space optimisation. | ||
A helper method for drawing unobstructed space boundary lines. | ||
A helper method for visual confirmation of boundaries split off for pathfind space optimisation. | ||
Extended position resolution method that can return multiple positions when more than one piece of ground mesh is local to the query point, and also supports filtering by sectionID if this is desired. | ||
Retrieve named positions stored with this mesh. | ||
Used for iterating through anchors. | ||
Construct an agent from obstacle information stored with the mesh. | ||
Used for iterating through fixed obstacles. | ||
Creates a reversed copy of a path. | ||
Saves unobstructed space to persistent storage. | ||
Saves connected region preprocess to persistent storage. | ||
Saves the underlying ground for this iMesh (backward compatibility version). | ||
Saves the underlying ground for this iMesh. | ||
Saves internal data relating to a path to persistent storage. | ||
Saves pathfind preprocess to persistent storage. | ||
Saves unobstructed space to persistent storage. | ||
Supplies a callback object to be used by PathEngine for looking up height detail at points in the specified terrain layer on this mesh. | ||
A helper function for checking whether unobstructed space is present for a given shape. | ||
A helper function for checking whether pathfinding queries are supported for a given shape (and collision context). | ||
A helper function for checking whether combined unobstructed space is present for a given shape. | ||
A helper function for checking whether connected region preprocess is present for a given shape. | ||
A helper function for checking whether pathfinding queries are supported (with release 6 preprocess type) for a given shape (and collision context). | ||
Intended for use when building content. Associates a position and orientation with a string ID. | ||
Intended for use when building content. Places an obstacle that can later be retrieved as an agent. | ||
Tests whether agents with the given collision shape can move along the specified line without being obstructed. | ||
Tests whether agents with the given collision shape can move along the specified line without being obstructed. This version does not require the end of the line to be fully specified. | ||
Tests whether the specified position is obstructed for agents with the given collision shape. |
Documentation for PathEngine release 6.04 - Copyright © 2002-2024 PathEngine | next: |