#include <NavigationModifier.h>

Inheritance diagram for FAreaNavModifier:

Public Member Functions
ENGINE_API	FAreaNavModifier ()

ENGINE_API	FAreaNavModifier (float Radius, float Height, const FTransform &LocalToWorld, const TSubclassOf< UNavAreaBase > AreaClass)

ENGINE_API	FAreaNavModifier (const FVector &Extent, const FTransform &LocalToWorld, const TSubclassOf< UNavAreaBase > AreaClass)

ENGINE_API	FAreaNavModifier (const FBox &Box, const FTransform &LocalToWorld, const TSubclassOf< UNavAreaBase > AreaClass)

ENGINE_API	FAreaNavModifier (const TArray< FVector > &Points, ENavigationCoordSystem::Type CoordType, const FTransform &LocalToWorld, const TSubclassOf< UNavAreaBase > AreaClass)

ENGINE_API	FAreaNavModifier (const TConstArrayView< FVector > Points, ENavigationCoordSystem::Type CoordType, const FTransform &LocalToWorld, const TSubclassOf< UNavAreaBase > AreaClass)

ENGINE_API	FAreaNavModifier (const TArray< FVector > &Points, const int32 FirstIndex, const int32 LastIndex, ENavigationCoordSystem::Type CoordType, const FTransform &LocalToWorld, const TSubclassOf< UNavAreaBase > AreaClass)

ENGINE_API	FAreaNavModifier (const TNavStatArray< FVector > &Points, const int32 FirstIndex, const int32 LastIndex, ENavigationCoordSystem::Type CoordType, const FTransform &LocalToWorld, const TSubclassOf< UNavAreaBase > AreaClass)

ENGINE_API	FAreaNavModifier (const UBrushComponent *BrushComponent, const TSubclassOf< UNavAreaBase > AreaClass)

ENGINE_API void	InitializePerInstanceConvex (const TNavStatArray< FVector > &Points, const int32 FirstIndex, const int32 LastIndex, const TSubclassOf< UNavAreaBase > AreaClass)

ENGINE_API void	InitializeConvex (const TNavStatArray< FVector > &Points, const int32 FirstIndex, const int32 LastIndex, const FTransform &LocalToWorld, const TSubclassOf< UNavAreaBase > AreaClass)

const FBox &	GetBounds () const

ENavigationShapeType::Type	GetShapeType () const

ENavigationAreaMode::Type	GetApplyMode () const

bool	IsLowAreaModifier () const

bool	ShouldExpandTopByCellHeight () const

bool	ShouldIncludeAgentHeight () const

void	SetExpandTopByCellHeight (bool bExpand)

FAreaNavModifier &	SetIncludeAgentHeight (bool bInclude)

const TSubclassOf< UNavAreaBase >	GetAreaClass () const

const TSubclassOf< UNavAreaBase >	GetAreaClassToReplace () const

ENGINE_API void	SetAreaClass (const TSubclassOf< UNavAreaBase > AreaClass)

ENGINE_API void	SetApplyMode (ENavigationAreaMode::Type InApplyMode)

ENGINE_API void	SetAreaClassToReplace (const TSubclassOf< UNavAreaBase > AreaClass)

ENGINE_API void	GetCylinder (FCylinderNavAreaData &Data) const

ENGINE_API void	GetBox (FBoxNavAreaData &Data) const

ENGINE_API void	GetConvex (FConvexNavAreaData &Data) const

ENGINE_API void	GetPerInstanceConvex (const FTransform &InLocalToWorld, FConvexNavAreaData &OutData) const

Public Member Functions inherited from FNavigationModifier
	FNavigationModifier ()

bool	HasMetaAreas () const

Public Attributes
float	Cost

float	FixedCost

Protected Member Functions
ENGINE_API void	Init (const TSubclassOf< UNavAreaBase > InAreaClass)

ENGINE_API void	SetConvex (const FVector *InPoints, const int32 FirstIndex, const int32 LastIndex, ENavigationCoordSystem::Type CoordType, const FTransform &LocalToWorld)

ENGINE_API void	SetPerInstanceConvex (const FVector *InPoints, const int32 InFirstIndex, const int32 InLastIndex)

ENGINE_API void	SetBox (const FBox &Box, const FTransform &LocalToWorld)

Static Protected Member Functions
static ENGINE_API void	FillConvexNavAreaData (const FVector *InPoints, const int32 InNumPoints, const FTransform &InLocalToWorld, FConvexNavAreaData &OutConvexData, FBox &OutBounds)

Protected Attributes
TWeakObjectPtr< UClass >	AreaClassOb

TWeakObjectPtr< UClass >	ReplaceAreaClassOb

FBox	Bounds

TArray< FVector >	Points

TEnumAsByte< ENavigationShapeType::Type >	ShapeType

TEnumAsByte< ENavigationAreaMode::Type >	ApplyMode

uint8	bExpandTopByCellHeight: 1

uint8	bIncludeAgentHeight: 1

uint8	bIsLowAreaModifier: 1

Protected Attributes inherited from FNavigationModifier
int32	bHasMetaAreas: 1

Detailed Description

Area modifier: base

Constructor & Destructor Documentation

◆ FAreaNavModifier() [1/9]

FAreaNavModifier::FAreaNavModifier ( )

◆ FAreaNavModifier() [2/9]

FAreaNavModifier::FAreaNavModifier	(	float	Radius,
		float	Height,
		const FTransform &	LocalToWorld,
		const TSubclassOf< UNavAreaBase >	AreaClass
	)

◆ FAreaNavModifier() [3/9]

FAreaNavModifier::FAreaNavModifier	(	const FVector &	Extent,
		const FTransform &	LocalToWorld,
		const TSubclassOf< UNavAreaBase >	AreaClass
	)

◆ FAreaNavModifier() [4/9]

FAreaNavModifier::FAreaNavModifier	(	const FBox &	Box,
		const FTransform &	LocalToWorld,
		const TSubclassOf< UNavAreaBase >	AreaClass
	)

◆ FAreaNavModifier() [5/9]

FAreaNavModifier::FAreaNavModifier	(	const TArray< FVector > &	Points,
		ENavigationCoordSystem::Type	CoordType,
		const FTransform &	LocalToWorld,
		const TSubclassOf< UNavAreaBase >	AreaClass
	)

◆ FAreaNavModifier() [6/9]

FAreaNavModifier::FAreaNavModifier	(	const TConstArrayView< FVector >	Points,
		ENavigationCoordSystem::Type	CoordType,
		const FTransform &	LocalToWorld,
		const TSubclassOf< UNavAreaBase >	AreaClass
	)

◆ FAreaNavModifier() [7/9]

FAreaNavModifier::FAreaNavModifier	(	const TArray< FVector > &	Points,
		const int32	FirstIndex,
		const int32	LastIndex,
		ENavigationCoordSystem::Type	CoordType,
		const FTransform &	LocalToWorld,
		const TSubclassOf< UNavAreaBase >	AreaClass
	)

◆ FAreaNavModifier() [8/9]

FAreaNavModifier::FAreaNavModifier	(	const TNavStatArray< FVector > &	Points,
		const int32	FirstIndex,
		const int32	LastIndex,
		ENavigationCoordSystem::Type	CoordType,
		const FTransform &	LocalToWorld,
		const TSubclassOf< UNavAreaBase >	AreaClass
	)

◆ FAreaNavModifier() [9/9]

FAreaNavModifier::FAreaNavModifier	(	const UBrushComponent *	BrushComponent,
		const TSubclassOf< UNavAreaBase >	AreaClass
	)

Member Function Documentation

◆ FillConvexNavAreaData()

void FAreaNavModifier::FillConvexNavAreaData	(	const FVector *	InPoints,
		const int32	InNumPoints,
		const FTransform &	InLocalToWorld,
		FConvexNavAreaData &	OutConvexData,
		FBox &	OutBounds
	)

staticprotected

◆ GetApplyMode()

ENavigationAreaMode::Type FAreaNavModifier::GetApplyMode ( ) const

inline

◆ GetAreaClass()

const TSubclassOf< UNavAreaBase > FAreaNavModifier::GetAreaClass ( ) const

inline

◆ GetAreaClassToReplace()

const TSubclassOf< UNavAreaBase > FAreaNavModifier::GetAreaClassToReplace ( ) const

inline

◆ GetBounds()

const FBox & FAreaNavModifier::GetBounds ( ) const

inline

◆ GetBox()

void FAreaNavModifier::GetBox ( FBoxNavAreaData & Data ) const

◆ GetConvex()

void FAreaNavModifier::GetConvex ( FConvexNavAreaData & Data ) const

◆ GetCylinder()

void FAreaNavModifier::GetCylinder ( FCylinderNavAreaData & Data ) const

◆ GetPerInstanceConvex()

void FAreaNavModifier::GetPerInstanceConvex	(	const FTransform &	InLocalToWorld,
		FConvexNavAreaData &	OutData
	)		const

◆ GetShapeType()

ENavigationShapeType::Type FAreaNavModifier::GetShapeType ( ) const

inline

◆ Init()

void FAreaNavModifier::Init ( const TSubclassOf< UNavAreaBase > InAreaClass )

protected

◆ InitializeConvex()

void FAreaNavModifier::InitializeConvex	(	const TNavStatArray< FVector > &	Points,
		const int32	FirstIndex,
		const int32	LastIndex,
		const FTransform &	LocalToWorld,
		const TSubclassOf< UNavAreaBase >	AreaClass
	)

◆ InitializePerInstanceConvex()

void FAreaNavModifier::InitializePerInstanceConvex	(	const TNavStatArray< FVector > &	Points,
		const int32	FirstIndex,
		const int32	LastIndex,
		const TSubclassOf< UNavAreaBase >	AreaClass
	)

◆ IsLowAreaModifier()

bool FAreaNavModifier::IsLowAreaModifier ( ) const

inline

◆ SetApplyMode()

void FAreaNavModifier::SetApplyMode ( ENavigationAreaMode::Type InApplyMode )

operation mode, ReplaceInLowPass will always automatically use UNavArea_LowHeight as ReplaceAreaClass!

◆ SetAreaClass()

void FAreaNavModifier::SetAreaClass ( const TSubclassOf< UNavAreaBase > AreaClass )

navigation area applied by this modifier

◆ SetAreaClassToReplace()

void FAreaNavModifier::SetAreaClassToReplace ( const TSubclassOf< UNavAreaBase > AreaClass )

additional class for used by some ApplyModes, setting it will automatically change ApplyMode to keep backwards compatibility!

◆ SetBox()

void FAreaNavModifier::SetBox	(	const FBox &	Box,
		const FTransform &	LocalToWorld
	)

protected

◆ SetConvex()

void FAreaNavModifier::SetConvex	(	const FVector *	InPoints,
		const int32	FirstIndex,
		const int32	LastIndex,
		ENavigationCoordSystem::Type	CoordType,
		const FTransform &	LocalToWorld
	)

protected

Parameters

CoordType specifies which coord system the input data is in

◆ SetExpandTopByCellHeight()

void FAreaNavModifier::SetExpandTopByCellHeight ( bool bExpand )

inline

◆ SetIncludeAgentHeight()

FAreaNavModifier & FAreaNavModifier::SetIncludeAgentHeight ( bool bInclude )

inline

◆ SetPerInstanceConvex()

void FAreaNavModifier::SetPerInstanceConvex	(	const FVector *	InPoints,
		const int32	InFirstIndex,
		const int32	InLastIndex
	)

protected

◆ ShouldExpandTopByCellHeight()

bool FAreaNavModifier::ShouldExpandTopByCellHeight ( ) const

inline

◆ ShouldIncludeAgentHeight()

bool FAreaNavModifier::ShouldIncludeAgentHeight ( ) const

inline

Member Data Documentation

◆ ApplyMode

TEnumAsByte<ENavigationAreaMode::Type> FAreaNavModifier::ApplyMode

protected

◆ AreaClassOb

TWeakObjectPtr<UClass> FAreaNavModifier::AreaClassOb

protected

this should take a value of a game specific navigation modifier

◆ bExpandTopByCellHeight

uint8 FAreaNavModifier::bExpandTopByCellHeight

protected

if set, area shape will be extended at the top by one cell height

◆ bIncludeAgentHeight

uint8 FAreaNavModifier::bIncludeAgentHeight

protected

if set, area shape will be extended by agent's height to cover area underneath like regular colliding geometry

◆ bIsLowAreaModifier

uint8 FAreaNavModifier::bIsLowAreaModifier

protected

set when this modifier affects low spans in navmesh generation step

◆ Bounds

FBox FAreaNavModifier::Bounds

protected

◆ Cost

float FAreaNavModifier::Cost

transient value used for navigation modifiers sorting. If < 0 then not set

◆ FixedCost

float FAreaNavModifier::FixedCost

◆ Points

TArray<FVector> FAreaNavModifier::Points

protected

◆ ReplaceAreaClassOb

TWeakObjectPtr<UClass> FAreaNavModifier::ReplaceAreaClassOb

protected

◆ ShapeType

TEnumAsByte<ENavigationShapeType::Type> FAreaNavModifier::ShapeType

protected

The documentation for this struct was generated from the following files:

Engine/Source/Runtime/Engine/Public/AI/NavigationModifier.h
Engine/Source/Runtime/Engine/Private/AI/Navigation/NavigationModifier.cpp

Public Member Functions

Public Attributes

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ FAreaNavModifier() [1/9]

◆ FAreaNavModifier() [2/9]

◆ FAreaNavModifier() [3/9]

◆ FAreaNavModifier() [4/9]

◆ FAreaNavModifier() [5/9]

◆ FAreaNavModifier() [6/9]

◆ FAreaNavModifier() [7/9]

◆ FAreaNavModifier() [8/9]

◆ FAreaNavModifier() [9/9]

Member Function Documentation

◆ FillConvexNavAreaData()

◆ GetApplyMode()

◆ GetAreaClass()

◆ GetAreaClassToReplace()

◆ GetBounds()

◆ GetBox()

◆ GetConvex()

◆ GetCylinder()

◆ GetPerInstanceConvex()

◆ GetShapeType()

◆ Init()

◆ InitializeConvex()

◆ InitializePerInstanceConvex()

◆ IsLowAreaModifier()

◆ SetApplyMode()

◆ SetAreaClass()

◆ SetAreaClassToReplace()

◆ SetBox()

◆ SetConvex()

◆ SetExpandTopByCellHeight()

◆ SetIncludeAgentHeight()

◆ SetPerInstanceConvex()

◆ ShouldExpandTopByCellHeight()

◆ ShouldIncludeAgentHeight()

Member Data Documentation

◆ ApplyMode

◆ AreaClassOb

◆ bExpandTopByCellHeight

◆ bIncludeAgentHeight

◆ bIsLowAreaModifier

◆ Bounds

◆ Cost

◆ FixedCost

◆ Points

◆ ReplaceAreaClassOb

◆ ShapeType