1. Epic GamesDeveloper
  3. ANavigationData

ANavigationData

Represents abstract Navigation Data (sub-classed as NavMesh, NavGraph, etc) Used as a common interface for all navigation types handled by NavigationSystem

Unreal Engine C++ API Reference > Runtime > NavigationSystem

Inheritance Hierarchy

References

   
Module NavigationSystem
Header /Engine/Source/Runtime/NavigationSystem/Public/NavigationData.h
Include #include "NavigationData.h"

Syntax

class ANavigationData :  
    public AActor,  
    public INavigationDataInterface

Remarks

Represents abstract Navigation Data (sub-classed as NavMesh, NavGraph, etc) Used as a common interface for all navigation types handled by NavigationSystem

Variables

  Type Name Description
Protected variable TArray< FNavPathWeakPtr > ActivePaths Container for all path objects generated with this Navigation Data instance.
Protected variable FCriticalSection ActivePathsLock Synchronization object for paths registration from main thread and async pathfinding thread
Protected variable TMap< const UClass *, int32 > AreaClassToIdMap Mapping for SupportedAreas
Protected variable uint32: 1 bAutoDestroyWhenNoNavigation Should this instance auto-destroy when there's no navigation system on world when it gets created/loaded
Protected variable uint32: 1 bCanBeMainNavData If set, navigation data can act as default one in navigation system's queries
Protected variable uint32: 1 bCanSpawnOnRebuild If set, navigation data will be spawned in persistent level during rebuild if actor doesn't exist
Protected variable uint32: 1 bEnableDrawing If set to true then this navigation data will be drawing itself when requested as part of "show navigation"
Protected variable uint32: 1 bForceRebuildOnLoad Game-time config
Protected variable uint32: 1 bIsBuildingOnLoad  
Protected variable uint32: 1 bRebuildingSuspended Set via SetRebuildingSuspended and controlling if RebuildDirtyAreas get passed over to the generator instantly or cached in SuspendedDirtyAreas to be applied at later date with SetRebuildingSuspended(false) call
Protected variable uint32: 1 bRegistered Whether this instance is registered with Navigation System
Protected variable uint32: 1 bSupportsDefaultAgent Was it generated for default agent (SupportedAgents[0])
Protected variable uint32 DataVersion Navigation data versioning.
Protected variable FSharedNavQueryFilter DefaultQueryFilter Query filter used when no other has been passed to relevant functions
Protected variable FFindPathPtr FindHierarchicalPathImplementation  
Protected variable FFindPathPtr FindPathImplementation  
Protected variable FNavDataConfig NavDataConfig  
Protected variable TSharedPtr< FNavDataGenerator, ESPMode::ThreadSafe > NavDataGenerator  
Protected variable float NextObservedPathsTickInSeconds Contains how much time left to the next ObservedPaths processing
Protected variable TArray< FNavPathWeakPtr > ObservedPaths Contains paths that requested observing its goal's location.
Protected variable float ObservedPathsTickInterval All observed paths will be processed every ObservedPathsTickInterval seconds
Protected variable TMap< UClass *, FSharedConstNavQueryFilter > QueryFilters Map of query filters by UNavigationQueryFilter class
Protected variable FNavRaycastPtr RaycastImplementation  
Public variable TObjectPtr< UPrimitiveComponent > RenderingComp  
Protected variable TArray< FNavPathRecalculationRequest > RepathRequests Paths that requested re-calculation
Protected variable ERuntimeGenerationType RuntimeGeneration Navigation data runtime generation options
Protected variable TArray< FSupportedAreaData > SupportedAreas Serialized area class - ID mapping
Protected variable TArray< FNavigationDirtyArea > SuspendedDirtyAreas Caches requests to rebuild dirty areas while nav rebuilding is suspended via SetRebuildingSuspended(true) call.
Protected variable FTestPathPtr TestHierarchicalPathImplementation  
Protected variable FTestPathPtr TestPathImplementation  

Constructors

  Type Name Description
Public function  

ANavigationData ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Public function Virtual Const void

BatchProjectPoints ( TArray< FNavigationProjectionWork >& Workload,
FSharedConstNavQueryFilter Filter,
const UObject* Querier
)

 Project batch of points using shared search filter.
Public function Virtual Const void

BatchProjectPoints ( TArray< FNavigationProjectionWork >& Workload,
const FVector& Extent,
FSharedConstNavQueryFilter Filter,
const UObject* Querier
)

 Batches ProjectPoint's work for efficiency
Public function Virtual Const void

BatchRaycast ( TArray< FNavigationRaycastWork >& Workload,
FSharedConstNavQueryFilter QueryFilter,
const UObject* Querier
)

 Raycasts batched for efficiency
Public function Virtual Const void Batch processing (important with async rebuilding)
Public function Virtual Const ENavigationQueryResult::Type

CalcPathCost ( const FVector& PathStart,
const FVector& PathEnd,
FVector::FReal& OutPathCost,
FSharedConstNavQueryFilter QueryFilter,
const UObject* Querier
)

 Calculates path from PathStart to PathEnd and retrieves its cost.
Public function Virtual Const ENavigationQueryResult::Type

CalcPathLength ( const FVector& PathStart,
const FVector& PathEnd,
FVector::FReal& OutPathLength,
FSharedConstNavQueryFilter QueryFilter,
const UObject* Querier
)

 Calculates path from PathStart to PathEnd and retrieves its length.
Public function Virtual Const ENavigationQueryResult::Type

CalcPathLengthAndCost ( const FVector& PathStart,
const FVector& PathEnd,
FVector::FReal& OutPathLength,
FVector::FReal& OutPathCost,
FSharedConstNavQueryFilter QueryFilter,
const UObject* Querier
)

 Calculates path from PathStart to PathEnd and retrieves its length.
Public function Const bool  
Public function Virtual void Cancels current build
Public function Const bool  
Public function Virtual void

CleanUp ()

  
Public function Virtual void  
Public function Virtual void Creates new generator in case navigation supports it
Public function Virtual UPrimitiveComponent * All the rest
Public function Const FNavPathSharedPtr Created an instance of navigation path of specified type.
Public function Virtual Const bool

DoesNodeContainLocation ( NavNodeRef NodeRef,
const FVector& WorldSpaceLocation
)

 Checks if specified navigation node contains given location
Public function Virtual Const bool

DoesSupportAgent ( const FNavAgentProperties& AgentProps
)

  
Public function Virtual void Blocks until navigation build is complete
Protected function Virtual void  
Public function Virtual Const void

FillNavigationDataChunkActor ( const FBox& QueryBounds,
ANavigationDataChunkActor& DataChunkActor,
FBox& OutTilesBounds
)

  
Public function Const FPathFindingResult

FindHierarchicalPath ( const FNavAgentProperties& AgentProperties,
const FPathFindingQuery& Query
)

 Synchronously looks for a path from to for agent with properties .
Public function Virtual Const bool

FindOverlappingEdges ( const FNavLocation& StartLocation,
TConstArrayView< FVector > ConvexPolygon,
TArray< FVector >& OutEdges,
FSharedConstNavQueryFilter Filter,
const UObject* Querier
)

 Returns the navmesh edges that touch the convex polygon. The edges are not clipped by the polygon.
Public function Const FPathFindingResult

FindPath ( const FNavAgentProperties& AgentProperties,
const FPathFindingQuery& Query
)

 Synchronously looks for a path from to for agent with properties .
Public function Virtual Const void Finishes batch processing and release locks
Public function Const const UClass *

GetAreaClass ( int32 AreaID
)

 Get class associated with AreaID
Public function Const int32

GetAreaID ( const UClass* AreaClass
)

 Get ID assigned to AreaClas or -1 when not assigned
Public function Virtual Const FBox Returns bounding box for the navmesh.
Public function Const const FNavDataConfig & Generation & data access.
Public function Const FVector  
Public function Const FSharedConstNavQueryFilter Querying.
Public function Const const INavigationQueryFilterInterface *  
Public function FNavDataGenerator * Retrieves navigation data generator
Public function Const const FNavDataGenerator *  
Public function Virtual Const int32 Get max areas supported by this navigation data
Public function Const uint16  
Public function Const TArray< FBox > Returns list of navigable bounds.
Public function Const TArray< FBox > Returns list of navigable bounds that belongs to specific level
Protected function Virtual Const int32

GetNewAreaID ( const UClass* AreaClass
)

 Get ID to assign for newly added area
Public function Virtual Const int32 Retrieves the number of suspended dirty areas
Public function Virtual Const bool

GetPathSegmentBoundaryEdges ( const FNavigationPath& Path,
const FNavPathPoint& StartPoint,
const FNavPathPoint& EndPoint,
const TConstArrayView< FVector > SearchArea,
TArray< FVector >& OutEdges,
const float MaxAreaEnterCost,
FSharedConstNavQueryFilter Filter,
const UObject* Querier
)

 Searches navmesh edges between the two path points, search up to the convex polygon described in SearchArea.
Public function Const FSharedConstNavQueryFilter Filters.
Public function Virtual Const FNavLocation

GetRandomPoint ( FSharedConstNavQueryFilter Filter,
const UObject* Querier
)

  
Public function Virtual Const bool

GetRandomPointInNavigableRadius ( const FVector& Origin,
float Radius,
FNavLocation& OutResult,
FSharedConstNavQueryFilter Filter,
const UObject* Querier
)

 Finds a random location in navigable space, in given Radius
Public function Virtual Const bool

GetRandomReachablePointInRadius ( const FVector& Origin,
float Radius,
FNavLocation& OutResult,
FSharedConstNavQueryFilter Filter,
const UObject* Querier
)

 Finds a random location in Radius, reachable from Origin
Public function Const ERuntimeGenerationType  
Public function Const void Read all supported areas
Public function Virtual Const double  
Public function Const double  
Protected function void  
Public function Const bool

IsAreaAssigned ( int32 AreaID
)

 Check if AreaID was assigned to class (class itself may not be loaded yet!)
Public function Const bool  
Public function Const bool  
Public function Virtual Const bool Retrieves if this NavData instance's navigation generation is suspended
Public function Const bool  
Public function Const bool  
Public function Virtual void Any loading before NavDataGenerator->RebuildAll()
Public function Virtual Const uint32  
Public function Virtual Const bool  
Public function Const bool  
Public function Virtual void

OnNavAreaAdded ( const UClass* NavAreaClass,
int32 AgentIndex
)

 Areas.
Public function Virtual void Called after changes to registered area classes
Public function void

OnNavAreaEvent ( const UClass* NavAreaClass,
ENavAreaEvent::Type Event
)

  
Public function Virtual void

OnNavAreaRemoved ( const UClass* NavAreaClass
)

 Area was removed from navigation system
Public function Virtual void  
Public function Virtual void  
Public function Virtual void

OnStreamingLevelAdded ( ULevel* InLevel,
UWorld* InWorld
)

  
Public function Virtual void

OnStreamingLevelRemoved ( ULevel* InLevel,
UWorld* InWorld
)

  
Public function Virtual void  
Public function Virtual void  
Public function void  
Public function void

ProcessNavAreas ( const TSet< const UClass* >& AreaClasses,
int32 AgentIndex
)

 Add all existing areas
Protected function void Removes from ActivePaths all paths that no longer have shared references (and are invalid in fact)
Public function Const bool

Raycast ( const FVector& RayStart,
const FVector& RayEnd,
FVector& HitLocation,
FSharedConstNavQueryFilter QueryFilter,
const UObject* Querier
)

 Synchronously makes a raycast on navigation data using QueryFilter
Public function Virtual void Triggers rebuild in case navigation supports it
Public function Virtual void

RebuildDirtyAreas ( const TArray< FNavigationDirtyArea >& DirtyAreas
)

 Request navigation data update after changes in nav octree
Protected function void

RegisterActivePath ( FNavPathSharedPtr SharedPath
)

  
Protected function void Releases navigation generator if any has been created register self with navigation system as new NavAreaDefinition(s) observer
Public function void

RegisterObservedPath ( FNavPathSharedPtr SharedPath
)

  
Public function void Removes cached query filter
Protected function void  
Public function void

RequestRePath ( FNavPathSharedPtr Path,
ENavPathUpdateType::Type Reason
)

  
Public function Virtual void

RestrictBuildingToActiveTiles ( bool InRestrictBuildingToActiveTiles
)

  
Public function Virtual void

SetConfig ( const FNavDataConfig& Src
)

  
Public function void

SetIsBuildingOnLoad ( bool bValue
)

  
Public function void

SetNavRenderingEnabled ( bool bEnable
)

 Updates state of rendering component
Public function Virtual void

SetRebuildingSuspended ( const bool bNewSuspend
)

 Configures this NavData instance's navigation generation to be suspended or active.
Public function void

SetSupportsDefaultAgent ( bool bIsDefault
)

  
Public function void

StoreQueryFilter ( TSubclassOf< UNavigationQueryFilter > FilterClass,
FSharedConstNavQueryFilter NavFilter
)

 Store cached query filter
Public function Virtual Const bool  
Public function Virtual Const bool  
Public function Const bool

TestHierarchicalPath ( const FNavAgentProperties& AgentProperties,
const FPathFindingQuery& Query,
int32* NumVisitedNodes
)

 Synchronously checks if path between two points exists using hierarchical graph FNavAgentProperties will be found automatically
Public function Const bool

TestPath ( const FNavAgentProperties& AgentProperties,
const FPathFindingQuery& Query,
int32* NumVisitedNodes
)

 Synchronously checks if path between two points exists FNavAgentProperties will be found automatically
Public function Virtual void

TickAsyncBuild ( float DeltaSeconds
)

 Ticks navigation build If the generator is set to time sliced rebuild then this function will only get called when there is sufficient time (effectively roughly once in n frames where n is the number of time sliced nav data generators currently building)
Public function Virtual void Custom navigation links.

Overridden from AActor

  Type Name Description
Public function Virtual void

ApplyWorldOffset ( const FVector& InOffset,
bool bWorldShift
)

 Called by owning level to shift an actor location and all relevant data structures by specified delta
Public function Virtual Const bool Returns true if this actor allows changing the spatially loaded flag.
Public function Virtual void Called when this actor is explicitly being destroyed during gameplay or in the editor, not called during level streaming or gameplay ending
Public function Virtual void

EndPlay ( const EEndPlayReason::Type EndPlayReason
)

 Overridable function called whenever this actor is being removed from a level
Public function Virtual void Allow actors to initialize themselves on the C++ side after all of their components have been initialized, only called during gameplay
Public function Virtual void Rerun construction scripts, destroying all autogenerated components; will attempt to preserve the root component location.
Public function Virtual void

TickActor ( float DeltaTime,
enum ELevelTick TickType,
FActorTickFunction& ThisTickFunction
)

 Dispatches the once-per frame Tick() function for this actor

Overridden from UObject

  Type Name Description
Public function Virtual void Called after applying a transaction to the object.
Public function Virtual void Life cycle.
Public function Virtual void Do any object-specific cleanup required immediately after loading an object.

Overridden from INavigationDataInterface

  Type Name Description
Public function Virtual Const bool

FindMoveAlongSurface ( const FNavLocation& StartLocation,
const FVector& TargetPosition,
FNavLocation& OutLocation,
FSharedConstNavQueryFilter Filter,
const UObject* Querier
)

 Tries to move current nav location towards target constrained to navigable area.
Public function Virtual Const bool

ProjectPoint ( const FVector& Point,
FNavLocation& OutLocation,
const FVector& Extent,
FSharedConstNavQueryFilter Filter,
const UObject* Querier
)

 Tries to project given Point to this navigation type, within given Extent.

Typedefs

Name Description
FFindPathPtr  
FNavRaycastPtr  
FTestPathPtr  

Deprecated Variables

  Type Name Description
Protected variable uint32: 1 bRebuildAtRuntime_DEPRECATED If true, the NavMesh can be dynamically rebuilt at runtime.

Deprecated Functions

  Type Name Description
Public function Virtual Const ENavigationQueryResult::Type

CalcPathCost ( const FVector& PathStart,
const FVector& PathEnd,
float& OutPathCost,
FSharedConstNavQueryFilter QueryFilter,
const UObject* Querier
)

 Use new version with FVector::FReal
Public function Virtual Const ENavigationQueryResult::Type

CalcPathLength ( const FVector& PathStart,
const FVector& PathEnd,
float& OutPathLength,
FSharedConstNavQueryFilter QueryFilter,
const UObject* Querier
)

 Use new version with FVector::FReal
Public function Virtual Const ENavigationQueryResult::Type

CalcPathLengthAndCost ( const FVector& PathStart,
const FVector& PathEnd,
float& OutPathLength,
float& OutPathCost,
FSharedConstNavQueryFilter QueryFilter,
const UObject* Querier
)

 Use new version with FVector::FReal
Public function Const void

DrawDebugPath ( FNavigationPath* Path,
const FColor PathColor,
UCanvas* Canvas,
const bool bPersistent,
const uint32 NextPathPointIndex
)

 Use version that takes LifeTime instead.
Public function Const void

DrawDebugPath ( FNavigationPath* Path,
const FColor PathColor,
UCanvas* Canvas,
const bool bPersistent,
const float LifeTime,
const uint32 NextPathPointIndex
)

 Use version that takes LifeTime instead.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page