UZoneGraphAnnotationComponent

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

References

Module

ZoneGraphAnnotations

Header

/Engine/Plugins/Runtime/ZoneGraphAnnotations/Source/ZoneGraphAnnotations/Public/ZoneGraphAnnotationComponent.h

Include

#include "ZoneGraphAnnotationComponent.h"

Syntax

UCLASS(Abstract)
class UZoneGraphAnnotationComponent : public UDebugDrawComponent

Variables

Name Description

Protected variable UProperty Category, EditAnywhere

bool

 

bEnableDebugDrawing

Protected variable

FDelegateHandle

 

CanvasDebugDrawDelegateHandle

Protected variable

FDelegateHandle

 

OnPostWorldInitDelegateHandle

Protected variable

FDelegateHandle

 

OnPostZoneGraphDataAddedHandle

Protected variable

FDelegateHandle

 

OnPreZoneGraphDataRemovedHandle

Constructors

Name Description

Public function

UZoneGraphAnnotationComponent

(
    const FObjectInitializer& ObjectIn...
)

Functions

Name Description

Public function Virtual

void

 

DebugDraw

Called when scene proxy is rebuilt.

Public function Virtual

void

 

DebugDrawCanvas

(
    UCanvas* Canvas,
    APlayerController*
)

Called when it's time to draw to canvas.

Public function Virtual Const

FZoneGraphTa...

 

GetAnnotationTags()

Public function Virtual

void

 

HandleEvents

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

Called when new events are ready to be processed

Protected function

void

 

OnPostWorldInit

(
    UWorld* World,
    const UWorld::InitializationValues
)

Protected function

void

 

OnPostZoneGraphDataAdded

(
    const AZoneGraphData* ZoneGrap...
)

Protected function

void

 

OnPreZoneGraphDataRemoved

(
    const AZoneGraphData* ZoneGrap...
)

Public function Virtual

void

 

PostSubsystemsInitialized()

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

Public function Virtual

void

 

PostZoneGraphDataAdded

(
    const AZoneGraphData& ZoneGraphDat...
)

Called when new ZoneGraph data is added.

Public function Virtual

void

 

PreZoneGraphDataRemoved

(
    const AZoneGraphData& ZoneGraphDat...
)

Called when new ZoneGraph data is removed.

Public function Virtual

void

 

TickAnnotation

(
    const float DeltaTime,
    FZoneGraphAnnotationTagContainer& ...
)

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

Overridden from UDebugDrawComponent

Name Description

Protected function Virtual

FDebugRender...

 

CreateDebugSceneProxy()

Method that derived class should override to create the scene proxy and customize a custom delegate helper (if any)

Overridden from USceneComponent

Name Description

Protected function Virtual Const

FBoxSphereBo...

 

CalcBounds

(
    const FTransform& LocalToWorld
)

Calculate the bounds of the component. Default behavior is a bounding box/sphere of zero size.

Overridden from UActorComponent

Name Description

Protected function Virtual

void

 

OnRegister()

Called when a component is registered, after Scene is set, but before CreateRenderState_Concurrent or OnCreatePhysicsState are called.

Protected function Virtual

void

 

OnUnregister()

Called when a component is unregistered.

Overridden from UObject

Name Description

Protected function Virtual

void

 

PostEditChangeChainProperty

(
    FPropertyChangedChainEvent& Proper...
)

This alternate version of PostEditChange is called when properties inside structs are modified.