1. Epic GamesDeveloper
  3. UNavLocalGridManager

UNavLocalGridManager

Manager for local navigation grids

API > API/Runtime > API/Runtime/AIModule

Manager for local navigation grids

Builds non overlapping grid from multiple sources, that can be used later for pathfinding. Check also: UGridPathFollowingComponent, FNavLocalGridData

   
Name UNavLocalGridManager
Type class
Header File /Engine/Source/Runtime/AIModule/Classes/Navigation/NavLocalGridManager.h
Include Path #include "Navigation/NavLocalGridManager.h"

Syntax

UCLASS (Experimental, MinimalAPI)  
class UNavLocalGridManager : public UObject

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

UNavLocalGridManager ( const FObjectInitializer& ObjectInitializer
)

   Navigation/NavLocalGridManager.h  

Constants

Name Type Remarks Include Path
GridCellSize float   Navigation/NavLocalGridManager.h

Functions

Public

Name Remarks Include Path Unreal Specifiers

int32 AddGridData ( const FNavLocalGridData& GridData,
bool bUpdate
)

 Adds new grid Navigation/NavLocalGridManager.h  

bool FindPath ( const FVector& Start,
const FVector& End,
TArray< FVector >& PathPoints
) const

 Tries to find a path using grids, returns false when start and end locations are not on the same grid Navigation/NavLocalGridManager.h  

const FNavLocalGridData & GetGridData ( int32 GridIdx
) const

 Get combined, non overlapping grid by index Navigation/NavLocalGridManager.h  

int32 GetGridIndex ( const FVector& WorldLocation
) const

 Find combined grid at location Navigation/NavLocalGridManager.h  

uint8 GetGridValueAt ( const FVector& WorldLocation
) const

 Find combined grid value at world location Navigation/NavLocalGridManager.h  

int32 GetMaxActiveSources()

 Get limit of source grids Navigation/NavLocalGridManager.h  

int32 GetNumGrids()

 Get number of combined, non overlapping grids Navigation/NavLocalGridManager.h  

int32 GetNumSources()

 Get number of known source grids Navigation/NavLocalGridManager.h  

const FNavLocalGridData & GetSourceData ( int32 SourceIdx
) const

 Get source grid by index Navigation/NavLocalGridManager.h  

int32 GetVersion()

 Get version of grid data, incremented with each rebuild Navigation/NavLocalGridManager.h  

bool HasSourceGridLimit()

 Check if source grid limit is set Navigation/NavLocalGridManager.h  

void RebuildGrids()

 Rebuild overlapping grids if needed Navigation/NavLocalGridManager.h  

void RemoveGridData ( int32 GridId,
bool bUpdate
)

 Removes grid Navigation/NavLocalGridManager.h  

bool SetCellSize ( float CellSize
)

 Set shared size of grid cell, allowed only when there's no grid added Navigation/NavLocalGridManager.h  

void SetMaxActiveSources ( int32 NumActiveSources
)

 Set limit of source grids, 0 or negative means unlimited Navigation/NavLocalGridManager.h  

void UpdateAccessTime ( int32 CombinedGridIdx
)

 Updates LastAccessTime in all source grids Navigation/NavLocalGridManager.h  

Protected

Name Remarks Include Path Unreal Specifiers

virtual void ProjectGrids ( const TArray< int32 >& GridIndices
)

 Projects combined grids to navigation data Navigation/NavLocalGridManager.h  

bool UpdateSourceGrids()

 Ensures limit of source grids, removing oldest entries (LastAccessTime) Navigation/NavLocalGridManager.h  

Static

Name Remarks Include Path Unreal Specifiers

static int32 AddLocalNavigationGridForBox ( UObject* WorldContextObject,
const FVector& Location,
FVector Extent,
FRotator Rotation,
const int32 Radius2D,
const float Height,
bool bRebuildGrids
)

   Navigation/NavLocalGridManager.h
  • BlueprintCallable
  • Category="AI|Navigation"
  • Meta=(WorldContext="WorldContextObject")

static int32 AddLocalNavigationGridForCapsule ( UObject* WorldContextObject,
const FVector& Location,
float CapsuleRadius,
float CapsuleHalfHeight,
const int32 Radius2D,
const float Height,
bool bRebuildGrids
)

   Navigation/NavLocalGridManager.h
  • BlueprintCallable
  • Category="AI|Navigation"
  • Meta=(WorldContext="WorldContextObject")

static int32 AddLocalNavigationGridForPoint ( UObject* WorldContextObject,
const FVector& Location,
const int32 Radius2D,
const float Height,
bool bRebuildGrids
)

 Creates new grid data for single point Navigation/NavLocalGridManager.h
  • BlueprintCallable
  • Category="AI|Navigation"
  • Meta=(WorldContext="WorldContextObject")

static int32 AddLocalNavigationGridForPoints ( UObject* WorldContextObject,
const TArray< FVector >& Locations,
const int32 Radius2D,
const float Height,
bool bRebuildGrids
)

 Creates single grid data for set of points Navigation/NavLocalGridManager.h
  • BlueprintCallable
  • Category="AI|Navigation"
  • Meta=(WorldContext="WorldContextObject")

static bool FindLocalNavigationGridPath ( UObject* WorldContextObject,
const FVector& Start,
const FVector& End,
TArray< FVector >& PathPoints
)

   Navigation/NavLocalGridManager.h
  • BlueprintCallable
  • Category="AI|Navigation"
  • Meta=(WorldContext="WorldContextObject")

static float GetCellSize()

 Get shared size of grid cell, static but there's only one active manager Navigation/NavLocalGridManager.h  

static UNavLocalGridManager * GetCurrent ( UWorld* World
)

   Navigation/NavLocalGridManager.h  

static UNavLocalGridManager * GetCurrent ( const UObject* WorldContextObject
)

   Navigation/NavLocalGridManager.h  

static void RemoveLocalNavigationGrid ( UObject* WorldContextObject,
int32 GridId,
bool bRebuildGrids
)

   Navigation/NavLocalGridManager.h
  • BlueprintCallable
  • Category="AI|Navigation"
  • Meta=(WorldContext="WorldContextObject")

static bool SetLocalNavigationGridDensity ( UObject* WorldContextObject,
float CellSize
)

   Navigation/NavLocalGridManager.h
  • BlueprintCallable
  • Category="AI|Navigation"
  • Meta=(WorldContext="WorldContextObject")

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page