UZoneGraphDisturbanceAnnotation

ZoneGraph Disturbance Annotation

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

References

Module

ZoneGraphAnnotations

Header

/Engine/Plugins/Runtime/ZoneGraphAnnotations/Source/ZoneGraphAnnotations/Public/Annotations/ZoneGraphDisturbanceAnnotation.h

Include

#include "Annotations/ZoneGraphDisturbanceAnnotation.h"

Syntax

UCLASS(ClassGroup=AI, BlueprintType, Meta=(BlueprintSpawnableComponent))
class UZoneGraphDisturbanceAnnotation : public UZoneGraphAnnotationComponent

Remarks

ZoneGraph Disturbance Annotation

Variables

Name Description

Protected variable UProperty Category, EditAnywhere

FZoneGraphTagFi...

 

AffectedLaneTags

Filter specifying which lanes the Annotation is applied to.

Protected variable

bool

 

bDisturbancesChanged

Flag indicating if the event processing changed the dangers.

Protected variable UProperty Category, EditAnywhere

FZoneGraphTag

 

DangerAnnotationTag

Tag to mark the lanes that should be fled.

Protected variable

TArray< FZoneGr...

 

Dangers

Array of currently active dangers.

Protected variable

TArray< FZoneGr...

 

EscapeGraphs

Disturbance graph for each ZoneGraphData

Protected variable UProperty Category, EditAnywhere

FZoneGraphTagFi...

 

EscapeLaneTags

Filter specifying which lanes can be used during Disturbance.

Protected variable UProperty Category, EditAnywhere

float

 

IdealSpanLength

Ideal span length for lane subdivision. Each lane will have between 2 and 8 spans.

Protected variable UProperty Category, EditAnywhere

FZoneGraphTag

 

ObstacleAnnotationTag

Tag to mark the lanes influenced by an obstacle.

Protected variable

TArray< FZoneGr...

 

Obstacles

Array of obstacles.

Protected variable

FZoneGraphTagMa...

 

PreviouslyAppliedTags

Combined mask of tags added in previous update (used for clearing previous state)

Protected variable UProperty Transient

UZoneGraphSubsy...

 

ZoneGraphSubsystem

Cached ZoneGraphSubsystem

Constructors

Name Description

Public function

UZoneGraphDisturbanceAnnotation

(
    const FObjectInitializer& ObjectIn...
)

Functions

Overridden from UZoneGraphAnnotationComponent

Name Description

Protected function Virtual

void

 

DebugDraw

Called when scene proxy is rebuilt.

Protected function Virtual

void

 

DebugDrawCanvas

(
    UCanvas* Canvas,
    APlayerController*
)

Called when it's time to draw to canvas.

Protected function Virtual Const

FZoneGraphTa...

 

GetAnnotationTags()

Protected function Virtual

void

 

HandleEvents

(
    TConstArrayView< const UScriptStruc...,
    const FInstancedStructStream& Even...
)

Called when new events are ready to be processed

Protected function Virtual

void

 

PostSubsystemsInitialized()

Called during OnRegister(), or after all subsystems have been initialized.

Protected function Virtual

void

 

PostZoneGraphDataAdded

(
    const AZoneGraphData& ZoneGraphDat...
)

Called when new ZoneGraph data is added.

Protected function Virtual

void

 

PreZoneGraphDataRemoved

(
    const AZoneGraphData& ZoneGraphDat...
)

Called when new ZoneGraph data is removed.

Protected function Virtual

void

 

TickAnnotation

(
    const float DeltaTime,
    FZoneGraphAnnotationTagContainer& ...
)

Ticks the Annotation and changes the tags in the container when needed.