Contents

Description

Documentation for the PathEngine SDK.

Contents

• Overview
  • Introduction
  • SDK Contents and Installation
  • Getting Started
  • Design Decisions
  • Fundamental Concepts
    • Ground Meshes
    • Obstacles
    • The PathEngine Movement Model
    • Representing Positions on the Ground
    • Why Integer Coordinates?
  • Additional Features Overview
    • Steps and Staircases
    • Off‑Mesh Connections
    • Ground Attributes
    • Regions with Cost to Traverse
    • Key Performance Optimisations
    • Ground Mesh Expansion
    • Memory Allocation Customisation
• Programmers Guide
  • World Representation
    • Choosing an Approach
    • 2D Content Processing
    • 3D Content Processing
    • Direct XML Generation
    • PathEngine Coordinates
    • Obstacle Placement
    • Setting Face Attributes
    • Representing Regions with Cost to Traverse
    • Working with Terrain
    • Pathfinding Through Forests
    • Mesh Federations
  • Linking with the SDK
    • Calling Through Abstract Base Classes
    • Interface Version Numbers
    • Linking with the PathEngine DLL
    • Linking with the TestBed
    • Dynamic Linking on GCC Based Platforms
    • Memory Allocation Hooks
    • Linking with PathEngine Statically
  • Using PathEngine with Other Languages
    • Microsoft CLR
    • Java Native Interface
  • Applying the SDK
    • Miscellaneous API Issues
    • Ownership and Lifetimes
    • Working with the TestBed
    • Shape Validation
    • Preprocess Generation
    • Unobstructed Space Optimisation
    • Converting to and from PathEngine's Position Representation
    • Obstacle Management
    • Collision Queries
    • Performing Collision Queries without Preprocess
    • Connectivity Queries
    • Pathfinding Queries
    • Limiting the Scope for Pathfinding
    • Aborting Pathfinding Early
    • Path Post Processing
    • Advancing Along Paths
    • Group Movement
    • Using PathEngine with Multithreaded Applications
    • Working with Off‑Mesh Connections
    • PathEngine Angles
  • Example Projects
    • Project Setup and Launchers
    • Tutorials
    • Other Examples
    • The 3D Content Processing Demo
    • The Playable Demo
  • Building the Source Code
    • SDK Components
    • Source Code Packages
    • Build Setup
    • Configurations
    • Exception Handling
    • Build Directories and Naming
    • Building in Visual Studio
    • Building with the Python Build Scripts
    • Preprocessor Defines
    • Include Directories
    • Building for Maximum Speed
    • Static Linkage
    • Building the TestBed for Other Platforms
  • Moving to Release 5
  • Moving to Release 5.34
  • Moving to Release 6
• Content Creators Guide
  • Getting Started
  • Content Integration Overview
  • Integer Coordinates and Approximation
  • Anchors and Pinned Shapes
  • Ground Attributes
  • Automating Connections
  • Validation and Error Feedback
  • Exporting Content Chunks
  • Stripping Height Detail out of Terrain Areas
  • Source Content Snapshots
  • Issues with Importing
  • Example Geometry
• Tools
  • Max Exporter
    • Installing
    • Accessing the exporter roll‑out
    • Interface overview
    • Creating a basic ground mesh
    • Working with editable meshes
    • Validation errors
    • Placing anchors
    • Placing obstacles
    • Surface types
    • Setting section IDs
    • Automating connection between ground pieces
    • Exporting content chunks
    • Exporting from MaxScript
  • Maya Exporter
    • Installing
    • Accessing the exporter functionality
    • Accessing the options
    • Options overview
    • Setting up ground meshes for export
    • Placing anchors
    • Placing pinned shapes
    • Marking surface types
    • Adding content processing markup
    • Marking section IDs and terrain layers
    • Error feedback
    • Importer limitations
• API Reference
  • Functions
    • DLLExport_CreateIContentProcessing3D
    • DLLExport_CreateIPathEngine
    • DLLExport_Init
    • PathEngine_InitialiseAndObtainRootInterface
    • PathEngine_InitialiseCP3DAndObtainInterface
    • PathEngine_SetDefaultAllocator
    • PathEngine_ShutDown
  • Interfaces
    • iPathEngine
    • iShape
    • iGround
    • iMesh
    • iAgent
    • iCollisionContext
    • iObstacleSet
    • iPath
    • iExpanded2DObstacles
    • iContentChunk
    • iContentChunkInstance
    • iMeshFederation
    • iSourceTiling
    • iMeshFederationTileGeneratedCallBack
    • iErrorHandler
    • iOutputStream
    • iTerrainCallBack
    • iQueryCallBack
    • iRender3DLinesCallBack
    • iFaceVertexMesh
    • iAnchorsAndPinnedShapes
    • iSolidObjects
    • iProgressCallBack
    • iConnectionTestCallBack
    • iTestBed
    • iContentProcessing3D
    • iAllocator
    • iArrayReceiver
    • iFaceVertexBuilder
    • iSolidObjectsBuilder
    • iRenderGeometry
  • Classes
    • cCollidingLine
    • cHorizontalRange
    • cPosition
  • Values and Strings
    • Anchor Attributes
    • Colour Strings
    • Error Handler Return Codes
    • Face Attributes
    • Key Strings
    • Mesh Loading Options
    • Obstacle Set Creation Attributes
    • Pathfind Preprocess Generation Attributes
    • Pinned Shape Attributes
    • Unobstructed Space Generation Attributes
    • Version Attributes