UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
Classes | Macros | Enumerations | Variables
GraphAStar.h File Reference
#include "AI/NavigationSystemBase.h"

Go to the source code of this file.

Classes

struct  FGraphAStarDefaultPolicy
 
struct  FGraphAStarDefaultNode< TGraph >
 
class  FRangeChecklessAllocator< DoRangeCheck >
 
struct  TAllocatorTraits< FRangeChecklessAllocator< true > >
 
struct  TAllocatorTraits< FRangeChecklessAllocator< false > >
 
struct  FGraphAStar< TGraph, Policy, TSearchNode, DoRangeCheck >
 
struct  FGraphAStar< TGraph, Policy, TSearchNode, DoRangeCheck >::FNodeSorter
 
struct  FGraphAStar< TGraph, Policy, TSearchNode, DoRangeCheck >::FNodePool
 
struct  FGraphAStar< TGraph, Policy, TSearchNode, DoRangeCheck >::FOpenList
 

Macros

#define ENABLE_GRAPH_ASTAR_LOGGING   0
 
#define UE_GRAPH_ASTAR_LOG(...)
 
#define DECLARE_OPTIONALLY_IMPLEMENTED_TEMPLATE_CLASS_FUNCTION_IMPL(TemplateClass, TemplateClassParameter, ConditionalReturnType, ConditionalFunctionName, DefaultImpl)
 
#define DECLARE_OPTIONALLY_IMPLEMENTED_TEMPLATE_CLASS_FUNCTION(ConditionalReturnType, ConditionalFunctionName, DefaultImpl)   DECLARE_OPTIONALLY_IMPLEMENTED_TEMPLATE_CLASS_FUNCTION_IMPL( TemplateClass, TemplateClass, ConditionalReturnType, ConditionalFunctionName, DefaultImpl )
 
#define DECLARE_OPTIONALLY_IMPLEMENTED_TEMPLATE_CLASS_FUNCTION_CONST(ConditionalReturnType, ConditionalFunctionName, DefaultImpl)   DECLARE_OPTIONALLY_IMPLEMENTED_TEMPLATE_CLASS_FUNCTION_IMPL( TemplateClass, const TemplateClass, ConditionalReturnType, ConditionalFunctionName, DefaultImpl )
 
#define DECLARE_OPTIONALLY_IMPLEMENTED_TEMPLATE_CLASS_FUNCTION_1PARAM_IMPL(TemplateClass, TemplateClassParameter, ConditionalReturnType, ConditionalFunctionName, ConditionalParamType1, DefaultImpl)
 
#define DECLARE_OPTIONALLY_IMPLEMENTED_TEMPLATE_CLASS_FUNCTION_1PARAM(ConditionalReturnType, ConditionalFunctionName, ConditionalParamType1, DefaultImpl)   DECLARE_OPTIONALLY_IMPLEMENTED_TEMPLATE_CLASS_FUNCTION_1PARAM_IMPL( TemplateClass, TemplateClass, ConditionalReturnType, ConditionalFunctionName, ConditionalParamType1, DefaultImpl)
 
#define DECLARE_OPTIONALLY_IMPLEMENTED_TEMPLATE_CLASS_FUNCTION_1PARAM_CONST(ConditionalReturnType, ConditionalFunctionName, ConditionalParamType1, DefaultImpl)   DECLARE_OPTIONALLY_IMPLEMENTED_TEMPLATE_CLASS_FUNCTION_1PARAM_IMPL( TemplateClass, const TemplateClass, ConditionalReturnType, ConditionalFunctionName, ConditionalParamType1, DefaultImpl)
 
#define DECLARE_OPTIONALLY_IMPLEMENTED_TEMPLATE_CLASS_FUNCTION_2PARAMS_IMPL(TemplateClass, TemplateClassParameter, ConditionalReturnType, ConditionalFunctionName, ConditionalParamType1, ConditionalParamType2, DefaultImpl)
 
#define DECLARE_OPTIONALLY_IMPLEMENTED_TEMPLATE_CLASS_FUNCTION_2PARAMS(ConditionalReturnType, ConditionalFunctionName, ConditionalParamType1, ConditionalParamType2, DefaultImpl)   DECLARE_OPTIONALLY_IMPLEMENTED_TEMPLATE_CLASS_FUNCTION_2PARAMS_IMPL( TemplateClass, TemplateClass, ConditionalReturnType, ConditionalFunctionName, ConditionalParamType1, ConditionalParamType2, DefaultImpl)
 
#define DECLARE_OPTIONALLY_IMPLEMENTED_TEMPLATE_CLASS_FUNCTION_2PARAMS_CONST(ConditionalReturnType, ConditionalFunctionName, ConditionalParamType1, ConditionalParamType2, DefaultImpl)   DECLARE_OPTIONALLY_IMPLEMENTED_TEMPLATE_CLASS_FUNCTION_2PARAMS_IMPL(TemplateClass, const TemplateClass, ConditionalReturnType, ConditionalFunctionName, ConditionalParamType1, ConditionalParamType2, DefaultImpl)
 
#define DECLARE_OPTIONALLY_IMPLEMENTED_TEMPLATE_CLASS_FUNCTION_CUSTOM(ConditionalFunctionName, QueryReturnType, QueryFunctionName, QueryParam, QueryDefaultImpl, QueryImpl)
 

Enumerations

enum  EGraphAStarResult { SearchFail , SearchSuccess , GoalUnreachable , InfiniteLoop }
 

Variables

const int32 NO_COUNT = INT_MAX
 

Macro Definition Documentation

◆ DECLARE_OPTIONALLY_IMPLEMENTED_TEMPLATE_CLASS_FUNCTION

#define DECLARE_OPTIONALLY_IMPLEMENTED_TEMPLATE_CLASS_FUNCTION (   ConditionalReturnType,
  ConditionalFunctionName,
  DefaultImpl 
)    DECLARE_OPTIONALLY_IMPLEMENTED_TEMPLATE_CLASS_FUNCTION_IMPL( TemplateClass, TemplateClass, ConditionalReturnType, ConditionalFunctionName, DefaultImpl )

◆ DECLARE_OPTIONALLY_IMPLEMENTED_TEMPLATE_CLASS_FUNCTION_1PARAM

#define DECLARE_OPTIONALLY_IMPLEMENTED_TEMPLATE_CLASS_FUNCTION_1PARAM (   ConditionalReturnType,
  ConditionalFunctionName,
  ConditionalParamType1,
  DefaultImpl 
)    DECLARE_OPTIONALLY_IMPLEMENTED_TEMPLATE_CLASS_FUNCTION_1PARAM_IMPL( TemplateClass, TemplateClass, ConditionalReturnType, ConditionalFunctionName, ConditionalParamType1, DefaultImpl)

◆ DECLARE_OPTIONALLY_IMPLEMENTED_TEMPLATE_CLASS_FUNCTION_1PARAM_CONST

#define DECLARE_OPTIONALLY_IMPLEMENTED_TEMPLATE_CLASS_FUNCTION_1PARAM_CONST (   ConditionalReturnType,
  ConditionalFunctionName,
  ConditionalParamType1,
  DefaultImpl 
)    DECLARE_OPTIONALLY_IMPLEMENTED_TEMPLATE_CLASS_FUNCTION_1PARAM_IMPL( TemplateClass, const TemplateClass, ConditionalReturnType, ConditionalFunctionName, ConditionalParamType1, DefaultImpl)

◆ DECLARE_OPTIONALLY_IMPLEMENTED_TEMPLATE_CLASS_FUNCTION_1PARAM_IMPL

#define DECLARE_OPTIONALLY_IMPLEMENTED_TEMPLATE_CLASS_FUNCTION_1PARAM_IMPL (   TemplateClass,
  TemplateClassParameter,
  ConditionalReturnType,
  ConditionalFunctionName,
  ConditionalParamType1,
  DefaultImpl 
)
Value:
struct CQuery##ConditionalFunctionName \
{ \
template<typename TemplateClass> auto Requires(TemplateClassParameter& Obj, ConditionalParamType1 Param1) -> decltype(Obj.ConditionalFunctionName(Param1)); \
}; \
template <typename TemplateClass> \
static inline decltype(auto) ConditionalFunctionName(TemplateClassParameter & Obj, ConditionalParamType1 Param1) \
{ \
if constexpr (TModels_V<CQuery##ConditionalFunctionName, TemplateClass>) \
{ \
return Obj.ConditionalFunctionName(Param1); \
} \
else \
{ \
return (ConditionalReturnType)(DefaultImpl); \
} \
}
StaticCastSharedRef
UE_FORCEINLINE_HINT TSharedRef< CastToType, Mode > StaticCastSharedRef(TSharedRef< CastFromType, Mode > const &InSharedRef)
Definition SharedPointer.h:127

◆ DECLARE_OPTIONALLY_IMPLEMENTED_TEMPLATE_CLASS_FUNCTION_2PARAMS

#define DECLARE_OPTIONALLY_IMPLEMENTED_TEMPLATE_CLASS_FUNCTION_2PARAMS (   ConditionalReturnType,
  ConditionalFunctionName,
  ConditionalParamType1,
  ConditionalParamType2,
  DefaultImpl 
)    DECLARE_OPTIONALLY_IMPLEMENTED_TEMPLATE_CLASS_FUNCTION_2PARAMS_IMPL( TemplateClass, TemplateClass, ConditionalReturnType, ConditionalFunctionName, ConditionalParamType1, ConditionalParamType2, DefaultImpl)

◆ DECLARE_OPTIONALLY_IMPLEMENTED_TEMPLATE_CLASS_FUNCTION_2PARAMS_CONST

#define DECLARE_OPTIONALLY_IMPLEMENTED_TEMPLATE_CLASS_FUNCTION_2PARAMS_CONST (   ConditionalReturnType,
  ConditionalFunctionName,
  ConditionalParamType1,
  ConditionalParamType2,
  DefaultImpl 
)    DECLARE_OPTIONALLY_IMPLEMENTED_TEMPLATE_CLASS_FUNCTION_2PARAMS_IMPL(TemplateClass, const TemplateClass, ConditionalReturnType, ConditionalFunctionName, ConditionalParamType1, ConditionalParamType2, DefaultImpl)

◆ DECLARE_OPTIONALLY_IMPLEMENTED_TEMPLATE_CLASS_FUNCTION_2PARAMS_IMPL

#define DECLARE_OPTIONALLY_IMPLEMENTED_TEMPLATE_CLASS_FUNCTION_2PARAMS_IMPL (   TemplateClass,
  TemplateClassParameter,
  ConditionalReturnType,
  ConditionalFunctionName,
  ConditionalParamType1,
  ConditionalParamType2,
  DefaultImpl 
)
Value:
struct CQuery##ConditionalFunctionName \
{ \
template<typename TemplateClass> auto Requires(TemplateClassParameter& Obj, ConditionalParamType1 Param1, ConditionalParamType2 Param2) -> decltype(Obj.ConditionalFunctionName(Param1,Param2)); \
}; \
template <typename TemplateClass> \
static inline decltype(auto) ConditionalFunctionName(TemplateClassParameter & Obj, ConditionalParamType1 Param1, ConditionalParamType2 Param2) \
{ \
if constexpr (TModels_V<CQuery##ConditionalFunctionName, TemplateClass>) \
{ \
return Obj.ConditionalFunctionName(Param1, Param2); \
} \
else \
{ \
return (ConditionalReturnType)(DefaultImpl); \
} \
}

◆ DECLARE_OPTIONALLY_IMPLEMENTED_TEMPLATE_CLASS_FUNCTION_CONST

#define DECLARE_OPTIONALLY_IMPLEMENTED_TEMPLATE_CLASS_FUNCTION_CONST (   ConditionalReturnType,
  ConditionalFunctionName,
  DefaultImpl 
)    DECLARE_OPTIONALLY_IMPLEMENTED_TEMPLATE_CLASS_FUNCTION_IMPL( TemplateClass, const TemplateClass, ConditionalReturnType, ConditionalFunctionName, DefaultImpl )

◆ DECLARE_OPTIONALLY_IMPLEMENTED_TEMPLATE_CLASS_FUNCTION_CUSTOM

#define DECLARE_OPTIONALLY_IMPLEMENTED_TEMPLATE_CLASS_FUNCTION_CUSTOM (   ConditionalFunctionName,
  QueryReturnType,
  QueryFunctionName,
  QueryParam,
  QueryDefaultImpl,
  QueryImpl 
)
Value:
struct CQuery##QueryFunctionName \
{ \
template<typename TemplateClass> auto Requires(const TemplateClass& Obj) -> decltype(Obj.ConditionalFunctionName()); \
}; \
template <typename TemplateClass> \
static inline QueryReturnType QueryFunctionName(const TemplateClass& Obj, QueryParam) \
{ \
if constexpr (TModels_V<CQuery##QueryFunctionName, TemplateClass>) \
{ \
return QueryImpl; \
} \
else \
{ \
return QueryDefaultImpl; \
} \
}
QueryParam
const bool const FCollisionResponseContainer const struct FCollisionQueryParams & QueryParam
Definition PhysicsInterfaceUtils.h:19

◆ DECLARE_OPTIONALLY_IMPLEMENTED_TEMPLATE_CLASS_FUNCTION_IMPL

#define DECLARE_OPTIONALLY_IMPLEMENTED_TEMPLATE_CLASS_FUNCTION_IMPL (   TemplateClass,
  TemplateClassParameter,
  ConditionalReturnType,
  ConditionalFunctionName,
  DefaultImpl 
)
Value:
struct CQuery##ConditionalFunctionName \
{ \
template<typename TemplateClass> auto Requires(TemplateClassParameter& Obj) -> decltype(Obj.ConditionalFunctionName()); \
}; \
template <typename TemplateClass> \
static inline decltype(auto) ConditionalFunctionName(TemplateClassParameter & Obj) \
{ \
if constexpr (TModels_V<CQuery##ConditionalFunctionName, TemplateClass>) \
{ \
return Obj.ConditionalFunctionName(); \
} \
else \
{ \
return (ConditionalReturnType)(DefaultImpl); \
} \
}

◆ ENABLE_GRAPH_ASTAR_LOGGING

#define ENABLE_GRAPH_ASTAR_LOGGING   0

◆ UE_GRAPH_ASTAR_LOG

#define UE_GRAPH_ASTAR_LOG (   ...)

Enumeration Type Documentation

◆ EGraphAStarResult

enum EGraphAStarResult
Enumerator
SearchFail 
SearchSuccess 
GoalUnreachable 
InfiniteLoop 

Variable Documentation

◆ NO_COUNT

const int32 NO_COUNT = INT_MAX
inline