className: UXRDeviceVisualizationComponent

code: [UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(Blueprintable, Meta=(BlueprintSpawnableComponent), ClassGroup=MotionController) class UXRDeviceVisualizationComponent : public [UStaticMeshComponent](API\Runtime\Engine\Components\UStaticMeshComponent)

bIsRenderingActive

description: Set by the parent MotionController once tracking kicks in.

bIsVisualizationActive

description: Whether the visualization offered by this component is being used.

CustomDisplayMesh

type: TObjectPtr<USt...

description: A mesh override that'll be displayed attached to this MotionController.

DisplayDeviceId

type: FXRDeviceId

DisplayMeshMaterialOverrides

type: TArray<TObject...

description: Material overrides for the specified display mesh.

DisplayModelLoadState

type: EModelLoadStatu...

DisplayModelSource

type: FName

description: Determines the source of the desired model.


description: Adds a splash element to the loading screen.

module: XRBase

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="Input|HeadMountedDisplay|LoadingScreen") static void AddLoadingScreenSplash ( class [UTexture](API\Runtime\Engine\Engine\UTexture) * Texture, FVector Translation, FRotator Rotation, FVector2D Size, FRotator DeltaRotation, bool bClearBeforeAdd )


description: Hide the splash screen and return to normal display.

code: static void HideLoadingScreen()


code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="Input|HeadMountedDisplay|LoadingScreen") static void SetLoadingScreen ( class [UTexture](API\Runtime\Engine\Engine\UTexture) * Texture, FVector2D Scale, FVector Offset, bool bShowLoadingMovie, bool bShowOnSet )


description: Show the loading screen and override the VR display


code: UXRLoadingScreenFunctionLibrary ( const [FObjectInitializer](API\Runtime\CoreUObject\UObject\FObjectInitializer) & ObjectInitializer )


className: UXRLoadingScreenFunctionLibrary

description: XR Loading Screen Function Library


description: Adds an explicitly provided Input Mapping Context to the input system.

module: XRCreative

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="XR Creative") void AddInputMappingContext ( [UInputMappingContext](API\Plugins\EnhancedInput\UInputMappingContext) * Context, int32 Priority )


description: Called before destroying the object. This is called immediately upon deciding to destroy the object, to allow the object to begin an asynchronous cleanup process.

code: virtual void BeginDestroy()


description: Overridable native event for when play begins for this actor.

code: virtual void BeginPlay()


code: void ConfigureToolset ( [UXRCreativeToolset](API\Plugins\XRCreative\UXRCreativeToolset) * InToolset )


description: Gets the input interface for the currently active input method. Will switch between editor and player based input as needed


code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="XR Creative") FTransform GetHeadTransform() const


code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="XR Creative") FTransform GetHeadTransformRoomSpace() const


code: bool GetLaserForHand ( EControllerHand InHand, FVector & OutLaserStart, FVector & OutLaserEnd ) const


code: void HandleSessionShutdown ( [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [IConcertClientSession](API\Plugins\Concert\IConcertClientSession) > InSession )


code: void HandleSessionStartup ( [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [IConcertClientSession](API\Plugins\Concert\IConcertClientSession) > InSession )


description:
Does this actor have a locally controlled owner responsible for replication? (APlayerControllertypically)
true if this actor can call RPCs or false if no such owner chain exists

code: virtual bool HasLocalNetOwner() const


description: Includes special handling to not dirty editor worlds.

code: [AActor](API\Runtime\Engine\GameFramework\AActor) * InternalSpawnTransientActor ( [TSubclassOf](API\Runtime\CoreUObject\Templates\TSubclassOf)< [AActor](API\Runtime\Engine\GameFramework\AActor) > ActorClass, const [FString](API\Runtime\Core\Containers\FString) & ActorName, [TOptional](API\Runtime\Core\IO\TOptional)< [TFunctionRef](API\Runtime\Core\GenericPlatform\TFunctionRef)< void([AActor](API\Runtime\Engine\GameFramework\AActor) *)>> DeferredConstructionCallback )


description: Called when an instance of this class is placed (in editor) or spawned.

code: virtual void OnConstruction ( const FTransform & Transform )


description: Play haptic feedback asset on a given hand - only left and right supported

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="XR Creative") virtual void PlayHapticEffect ( [UHapticFeedbackEffect_Base](API\Runtime\Engine\Haptics\UHapticFeedbackEffect_Base) * HapticEffect, const int ControllerID, const EControllerHand Hand, float Scale, bool bLoop )


code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="XR Creative") [ALevelSequenceActor](API\Runtime\LevelSequence\ALevelSequenceActor) * OpenLevelSequence ( [ULevelSequence](API\Runtime\LevelSequence\ULevelSequence) * LevelSequence )


code: void ProcessHaptics ( const float DeltaTime )


description: Utility functions for registering and unregistering our input component with the correct input system.

code: void RegisterInputComponent()


description: Removes an explicitly provided Input Mapping Context to the input system.

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="XR Creative") void RemoveInputMappingContext ( [UInputMappingContext](API\Plugins\EnhancedInput\UInputMappingContext) * Context )


description: Registers the given object with the Avatar's Input Component This allows dynamic input bindings such as input events in blueprints to work correctly Note: Ensure you call UnregisterObjectForInput when you are finished with the object otherwise input events will still fire until GC actually destroys the object

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="XR Creative") void RegisterObjectForInput ( [UObject](API\Runtime\CoreUObject\UObject\UObject) * Object )


code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="XR Creative") [AActor](API\Runtime\Engine\GameFramework\AActor) * SpawnTransientActor ( [TSubclassOf](API\Runtime\CoreUObject\Templates\TSubclassOf)< [AActor](API\Runtime\Engine\GameFramework\AActor) > ActorClass, const [FString](API\Runtime\Core\Containers\FString) & ActorName )


code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="XR Creative") void SetComponentTickInEditor ( [UActorComponent](API\Runtime\Engine\Components\UActorComponent) * Component, bool bShouldTickInEditor )


code: [AActor](API\Runtime\Engine\GameFramework\AActor) * SpawnTransientActor ( [TSubclassOf](API\Runtime\CoreUObject\Templates\TSubclassOf)< [AActor](API\Runtime\Engine\GameFramework\AActor) > ActorClass, const [FString](API\Runtime\Core\Containers\FString) & ActorName, [TFunctionRef](API\Runtime\Core\GenericPlatform\TFunctionRef)< void([AActor](API\Runtime\Engine\GameFramework\AActor) *)> DeferredConstructionCallback )


description: Instantly stop a haptic feedback for a given hand - only left and right supported

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="XR Creative") void StopHapticEffect ( EControllerHand Hand, const int ControllerID )


description: Function called every frame on this Actor. Override this function to implement custom logic to be executed every frame. Note that Tick is disabled by default, and you will need to check PrimaryActorTick.bCanEverTick is set to true to enable it.

code: virtual void Tick ( float DeltaSeconds )


code: void UnregisterInputComponent()


description: Unregisters the given object with the Avatar's Input Component

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="XR Creative") void UnregisterObjectForInput ( [UObject](API\Runtime\CoreUObject\UObject\UObject) * Object )


code: AXRCreativeAvatar ( const [FObjectInitializer](API\Runtime\CoreUObject\UObject\FObjectInitializer) & ObjectInitializer )


className: AXRCreativeAvatar

code: [UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)() class AXRCreativeAvatar : public [APawn](API\Runtime\Engine\GameFramework\APawn)

type: TSharedPtr<FAc...

description: Currently playing haptic effects for both the left and right hand

bIsInputRegistered

type: bool

LeftController

type: TObjectPtr<UMo...

LeftControllerModel

type: TObjectPtr<USk...

LeftControllerPointer

type: TObjectPtr<UXR...

MenuWidget

type: TObjectPtr<UWi...

OnSessionShutdownHandle

type: FDelegateHandle

description: Delegate handle for a the callback when a session shuts down

OnSessionStartupHandle

description: Delegate handle for a the callback when a session starts up

WeakSession

type: TWeakPtr<IConc...

description: Weak pointer to the client session with which to send events. May be null or stale.


code: void ConstructDefaults ( ETransformGizmoSubElements EnableElements )


code: [UGizmoArrowComponent](API\Runtime\InteractiveToolsFramework\BaseGizmos\UGizmoArrowComponent) * SetupAxisArrow ( [UGizmoArrowComponent](API\Runtime\InteractiveToolsFramework\BaseGizmos\UGizmoArrowComponent) * InComponent, const [FLinearColor](API\Runtime\Core\Math\FLinearColor) & InColor, const FVector & InAxis )


code: [UGizmoCircleComponent](API\Runtime\InteractiveToolsFramework\BaseGizmos\UGizmoCircleComponent) * SetupAxisRotateCircle ( [UGizmoCircleComponent](API\Runtime\InteractiveToolsFramework\BaseGizmos\UGizmoCircleComponent) * InComponent, const [FLinearColor](API\Runtime\Core\Math\FLinearColor) & InColor, const FVector & InAxis )


code: [UGizmoRectangleComponent](API\Runtime\InteractiveToolsFramework\BaseGizmos\UGizmoRectangleComponent) * SetupAxisScaleRect ( [UGizmoRectangleComponent](API\Runtime\InteractiveToolsFramework\BaseGizmos\UGizmoRectangleComponent) * InComponent, const [FLinearColor](API\Runtime\Core\Math\FLinearColor) & InColor, const FVector & InAxis0, const FVector & InAxis1 )


code: [UGizmoRectangleComponent](API\Runtime\InteractiveToolsFramework\BaseGizmos\UGizmoRectangleComponent) * SetupPlaneRect ( [UGizmoRectangleComponent](API\Runtime\InteractiveToolsFramework\BaseGizmos\UGizmoRectangleComponent) * InComponent, const [FLinearColor](API\Runtime\Core\Math\FLinearColor) & InColor, const FVector & InAxis0, const FVector & InAxis1 )


code: [UGizmoRectangleComponent](API\Runtime\InteractiveToolsFramework\BaseGizmos\UGizmoRectangleComponent) * SetupPlaneScaleFunc ( [UGizmoRectangleComponent](API\Runtime\InteractiveToolsFramework\BaseGizmos\UGizmoRectangleComponent) * InComponent, const [FLinearColor](API\Runtime\Core\Math\FLinearColor) & InColor, const FVector & InAxis0, const FVector & InAxis1 )


code: AXRCreativeBaseTransformGizmoActor()


className: AXRCreativeBaseTransformGizmoActor

GizmoLineThickness

type: float

description: Only used during Setup(...) component methods; set before calling those or ConstructDefaults.


code: [UXRCreativeToolset](API\Plugins\XRCreative\UXRCreativeToolset) * GetToolset() const


className: AXRCreativeGameMode

code: [UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)() class AXRCreativeGameMode : public [AGameModeBase](API\Runtime\Engine\GameFramework\AGameModeBase)

ToolsetClass

type: TSoftObjectPtr<...


description: Called when the game starts or when spawned.

code: virtual void BeginPlay()


code: virtual bool HasLocalNetOwner() const


description: Sets default values for this actor's properties.

code: AXRCreativeTeleporter ( const [FObjectInitializer](API\Runtime\CoreUObject\UObject\FObjectInitializer) & ObjectInitializer )


description: Called every frame.

code: virtual void Tick ( float DeltaTime )


className: AXRCreativeTeleporter

code: [UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)() class AXRCreativeTeleporter : public [AActor](API\Runtime\Engine\GameFramework\AActor)


className: FXRCreativeToolEntry

ToolClass

type: TSubclassOf<UX...

ToolIcon

type: TObjectPtr<UTe...


code: virtual [FText](API\Runtime\Core\Internationalization\FText) GetDisplayName() const


code: virtual [TSubclassOf](API\Runtime\CoreUObject\Templates\TSubclassOf)< [UXRCreativePaletteToolTab](API\Plugins\XRCreative\UXRCreativePaletteToolTab) > GetPaletteTabClass() const


code: virtual [FName](API\Runtime\Core\UObject\FName) GetToolName() const


className: UXRCreativeBlueprintableTool

code: [UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(Abstract, Blueprintable) class UXRCreativeBlueprintableTool : public [UXRCreativeTool](API\Plugins\XRCreative\UXRCreativeTool)

DisplayName

type: FText

ToolActor

type: TSubclassOf<AA...

ToolInputMappingContext

type: TObjectPtr<UIn...


code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="XR Creative|Tools") bool CanRedo() const


code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="XR Creative|Tools") bool CanUndo() const


code: void EditorToolsTick ( float InDeltaTime )


code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="XR Creative|Tools") EToolContextCoordinateSystem GetCurrentCoordinateSystem() const


description: Initializes the component. Occurs at level startup or actor spawn. This is before BeginPlay (Actor or Component). All Components in the level will be Initialized on load before any Actor/Component gets BeginPlay Requires component to be registered, and bWantsInitializeComponent to be true.

code: virtual void InitializeComponent()


code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="XR Creative|Tools") bool HaveActiveTool()


code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="XR Creative|Tools") void LeftMousePressed()


code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="XR Creative|Tools") void LeftMouseReleased()


code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="XR Creative|Tools") void Redo()


code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="XR Creative|Tools") void SetCurrentCoordinateSystem ( EToolContextCoordinateSystem CoordSystem )


code: void SetPointerComponent ( [UXRCreativePointerComponent](API\Plugins\XRCreative\UXRCreativePointerComponent) * InPointer )


description: Function called every frame on this ActorComponent. Override this function to implement custom logic to be executed every frame. Only executes if the component is registered, and also PrimaryComponentTick.bCanEverTick must be set to true.

code: virtual void TickComponent ( float DeltaTime, enum ELevelTick TickType, [FActorComponentTickFunction](API\Runtime\Engine\Engine\FActorComponentTickFunction) * ThisTickFunction )


code: void ToolsTick ( float InDeltaTime )


description: Handle this component being Uninitialized. Called fromAActor::EndPlayonly if bHasBeenInitialized is true

code: virtual void UninitializeComponent()


code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="XR Creative|Tools") void Undo()


code: void SetOwner ( class [AXRCreativeAvatar](API\Plugins\XRCreative\AXRCreativeAvatar) * InOwner )


className: UXRCreativePalette

code: [UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)() class UXRCreativePalette : public [UCommonUserWidget](API\Plugins\CommonUI\UCommonUserWidget)

Owner

type: TObjectPtr<AXR...

Tabs

type: TArray<TObject...


className: UXRCreativeITFComponent

code: [UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)() class UXRCreativeITFComponent : public [UActorComponent](API\Runtime\Engine\Components\UActorComponent)

ContextQueriesAPI

type: TSharedPtr< FXR...

CurrentCoordinateSystem

type: EToolContextCoo...

CurrentMouseState

type: FInputDeviceSta...

CurrentViewCameraState

type: FViewCameraStat...

FullTRSGizmoActorClass

type: TSubclassOf<AX...

PDIRenderComponent

type: TObjectPtr< UXR...

SelectionSet

type: TObjectPtr<UTy...


description: If bScaledByImpact is false, this is the smoothed filter output, roughly `TraceMaxLength_ units away, roughly in the +X direction. If bScaledByImpact is true, the magnitude is shortened to match the length of a blocking hit (if any).

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="XR Creative") FVector GetFilteredTraceEnd ( const bool bScaledByImpact ) const


className: UXRCreativePaletteTab

code: [UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)() class UXRCreativePaletteTab : public [UCommonActivatableWidget](API\Plugins\CommonUI\UCommonActivatableWidget)


className: UXRCreativePaletteToolTab

code: [UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)() class UXRCreativePaletteToolTab : public [UXRCreativePaletteTab](API\Plugins\XRCreative\UXRCreativePaletteTab)

Tool

type: TWeakObjectPtr<...


description: If bScaledByImpact is false, this returns the raw input to the smoothing filter, `TraceMaxLength_ units away the +X direction. If bScaledByImpact is true, the magnitude is shortened to the length of the blocking hit (if any).

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="XR Creative") FVector GetRawTraceEnd ( const bool bScaledByImpact ) const


code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="XR Creative") bool IsEnabled() const


code: virtual void InitializeComponent()


code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="XR Creative") const [FHitResult](API\Runtime\Engine\Engine\FHitResult) & GetHitResult() const


code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="XR Creative") void SetEnabled ( bool bInEnabled )


className: UXRCreativePointerComponent

code: [UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)() class UXRCreativePointerComponent : public [USceneComponent](API\Runtime\Engine\Components\USceneComponent)

bEnabled

type: bool

HitResult

type: FHitResult

RawTraceEnd

type: FVector

SmoothingFilter

type: TPimplPtr< UE::...

SmoothingLag

type: float


code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintPure, Category="XR Creative") static [UXRCreativeSettings](API\Plugins\XRCreative\UXRCreativeSettings) * GetXRCreativeSettings()


className: UXRCreativeSettings

code: [UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(Config=XRCreativeSettings, DisplayName="XR Creative") class UXRCreativeSettings : public [UDeveloperSettingsBackedByCVars](API\Runtime\DeveloperSettings\Engine\UDeveloperSettingsBackedByCVars)

FloatArray

type: TArray< float >

SubsystemHelpersClass

type: TSoftClassPtr< ...


code: virtual void TickComponent ( float DeltaTime, enum ELevelTick TickType, [FActorComponentTickFunction](API\Runtime\Engine\Engine\FActorComponentTickFunction) * ThisTickFunction )


className: UXRCreativeStyle

code: [UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(BlueprintType) class UXRCreativeStyle : public [UPrimaryDataAsset](API\Runtime\Engine\Engine\UPrimaryDataAsset)

BoldTextStyle

type: TSubclassOf<UC...


description: Enter VR Mode

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="XR Creative") static bool EnterVRMode()


description: Implement this for initialization of instances of the system

code: virtual void Initialize ( [FSubsystemCollectionBase](API\Runtime\Engine\Subsystems\FSubsystemCollectionBase) & Collection )


description: Exit VR Mode

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="XR Creative") static void ExitVRMode()


className: UXRCreativeSubsystem

code: [UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)() class UXRCreativeSubsystem : public [UEngineSubsystem](API\Runtime\Engine\Subsystems\UEngineSubsystem)

EngineInitCompleteDelegate

type: FDelegateHandle

Helpers

type: TObjectPtr<UXR...


className: UXRCreativeSubsystemHelpers

code: [UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(Abstract, Blueprintable) class UXRCreativeSubsystemHelpers : public [UObject](API\Runtime\CoreUObject\UObject\UObject)


code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="XR Creative") virtual [FText](API\Runtime\Core\Internationalization\FText) GetDisplayName() const


code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="XR Creative") virtual [TSubclassOf](API\Runtime\CoreUObject\Templates\TSubclassOf)< class [UXRCreativePaletteToolTab](API\Plugins\XRCreative\UXRCreativePaletteToolTab) > GetPaletteTabClass() const


code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="XR Creative") virtual [FName](API\Runtime\Core\UObject\FName) GetToolName() const


className: UXRCreativeTool

code: [UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(Abstract, BlueprintType) class UXRCreativeTool : public [UObject](API\Runtime\CoreUObject\UObject\UObject)


className: UXRCreativeToolset

code: [UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(BlueprintType) class UXRCreativeToolset : public [UPrimaryDataAsset](API\Runtime\Engine\Engine\UPrimaryDataAsset)

Palette

type: TSubclassOf<UX...

Style

type: TSoftObjectPtr<...

Tools

type: TArray<FXRCrea...


description: Renders HMD Visualization on a system that might not have that HMD as native

module: XRVisualization

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="Input|XRTracking") static void RenderHMD ( const [FXRHMDData](API\Runtime\HeadMountedDisplay\FXRHMDData) & XRHMDData )


description: Renders Motion Controller Visualization on a system that might not have that HMD as native

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="Input|XRTracking") static void RenderMotionController ( const [FXRMotionControllerData](API\Runtime\HeadMountedDisplay\FXRMotionControllerData) & XRControllerData, bool bRight )


className: UXRVisualizationFunctionLibrary

description: No destructors are accessible with public or protected access.


className: UXRVisualizationLoadHelper

description: No constructors are accessible with public or protected access.

code: [UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)() class UXRVisualizationLoadHelper : public [UObject](API\Runtime\CoreUObject\UObject\UObject)

GenericHMD

type: TObjectPtr< cla...


description: Returns true if this actor allows changing the spatially loaded flag.

module: ZoneGraph

code: virtual bool CanChangeIsSpatiallyLoadedFlag() const


description: Called when this actor is explicitly being destroyed during gameplay or in the editor, not called during level streaming or gameplay ending

code: virtual void Destroyed()


description: Overridable function called whenever this actor is being removed from a level

code: virtual void EndPlay ( const [EEndPlayReason::Type](API\Runtime\Engine\Engine\EEndPlayReason__Type) EndPlayReason )


description: Combined hash of all ZoneShapes that were used to build the data.

code: uint32 GetCombinedShapeHash() const


code: const [FZoneGraphStorage](API\Plugins\ZoneGraph\FZoneGraphStorage) & GetStorage() const


code: FCriticalSection & GetStorageLock() const


description: TODO: I wonder if the storage is unnecessary indirection?


code: void OnRegistered ( const [FZoneGraphDataHandle](API\Plugins\ZoneGraph\FZoneGraphDataHandle) DataHandle )


description: Called when an actor is done spawning into the world (fromUWorld::SpawnActor), both in the editor and during gameplay For actors with a root component, the location and rotation will have already been set. This is called before calling construction scripts, but after native components have been created

code: virtual void PostActorCreated()


description: Called when a property on this object has been modified externally

code: virtual void PostEditChangeProperty ( [FPropertyChangedEvent](API\Runtime\CoreUObject\UObject\FPropertyChangedEvent) & PropertyChangedEvent )


description: Called after applying a transaction to the object. Default implementation simply calls PostEditChange.

code: virtual void PostEditUndo()


description: Do any object-specific cleanup required immediately after loading an object. This is not called for newly-created objects, and by default will always execute on the game thread.

code: virtual void PostLoad()


description: Called after all currently registered components are cleared


description: Called before all the components in the Components array are registered, called both in editor and during gameplay

code: virtual void PreRegisterAllComponents()


description: Sets Combined hash of all ZoneShapes that were used to build the data.

code: void SetCombinedShapeHash ( const uint32 Hash )


code: AZoneGraphData ( const [FObjectInitializer](API\Runtime\CoreUObject\UObject\FObjectInitializer) & ObjectInitializer )


className: AZoneGraphData

code: [UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(Config=ZoneGraph, defaultconfig, NotBlueprintable) class AZoneGraphData : public [AActor](API\Runtime\Engine\GameFramework\AActor)

bEnableDrawing

description: If set to true then this zone graph data will be drawing itself when requested as part of "show navigation"

RenderingComp

type: TObjectPtr<UZo...

ZoneStorage

type: FZoneGraphStora...

ZoneStorageLock

type: FCriticalSectio...

description: Critical section to prevent rendering of the zone graph storage data while it's getting rebuilt


code: const [UZoneShapeComponent](API\Plugins\ZoneGraph\UZoneShapeComponent) * GetShape() const


description:
Called during saving to determine if the object is forced to be editor only or not
true if this object should never be loaded outside the editor

code: virtual bool IsEditorOnly() const


code: AZoneShape ( const [FObjectInitializer](API\Runtime\CoreUObject\UObject\FObjectInitializer) & ObjectInitializer )


className: AZoneShape

description: Zone Shape actor for standalone zone markup.

code: [UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(HideCategories=(Input)) class AZoneShape : public [AActor](API\Runtime\Engine\GameFramework\AActor)


className: EZoneGraphLaneRoutingCountRule

code: enum EZoneGraphLaneRoutingCountRule { Any, One, Many, }


className: EZoneGraphTags

code: enum EZoneGraphTags { MaxTags = 32, MaxTagIndex = MaxTags - 1, }


className: EZoneLaneDirection

code: enum EZoneLaneDirection { None = 0x0, Forward = 0x1, Backward = 0x2, }


className: EZoneLaneLinkFlags

description: Flags describing the details of a linked adjacent lane. Flags are only used for adjacent lanes.

code: enum EZoneLaneLinkFlags { None = 0, All = ((uint8) 0xff), Left = 1 << 0, Right = 1 << 1, Splitting = 1 << 2, Merging = 1 << 3, OppositeDirection = 1 << 4, }


className: EZoneLaneLinkType

description: Describes how the linked lane relates to the lane spatially. Each type is a bitmask, so that some APIs can filter based on link types.

code: enum EZoneLaneLinkType { None = 0, All = ((uint8) 0xff), Outgoing = 1 << 0, Incoming = 1 << 1, Adjacent = 1 << 2, }


className: EZoneLaneTagMaskComparison

code: enum EZoneLaneTagMaskComparison { Any, All, Not, }


className: EZoneShapeLaneConnectionRestrictions

code: enum EZoneShapeLaneConnectionRestrictions { None = 0, NoLeftTurn = 1 << 0, NoRightTurn = 1 << 1, OneLanePerDestination = 1 << 2, MergeLanesToOneDestinationLane = 1 << 3, }


className: EZoneShapePolygonRoutingType

code: enum EZoneShapePolygonRoutingType { Bezier, Arcs, }


className: FLaneHighlight

code: struct FLaneHighlight

Rotation

type: FQuat


className: FOnZoneGraphBuildSettingsChanged

description: Called when build settings change.

code: typedef TMulticastDelegate_NoParams< void > FOnZoneGraphBuildSettingsChanged


className: FOnZoneGraphDataBuildDone

description: Called when build is completed.

code: typedef TMulticastDelegate_OneParam< void, const [FZoneGraphBuildData](API\Plugins\ZoneGraph\FZoneGraphBuildData) & > FOnZoneGraphDataBuildDone


className: FOnZoneGraphData

code: typedef TMulticastDelegate_OneParam< void, const [AZoneGraphData](API\Plugins\ZoneGraph\AZoneGraphData) * > FOnZoneGraphData


className: FOnZoneGraphLaneProfileChanged

description: Called when name in a lane profile has changed.

code: typedef TMulticastDelegate_OneParam< void, const [FZoneLaneProfileRef](API\Plugins\ZoneGraph\FZoneLaneProfileRef) & > FOnZoneGraphLaneProfileChanged


className: FOnZoneGraphTagsChanged

description: Called when tags have changed.

code: typedef TMulticastDelegate_NoParams< void > FOnZoneGraphTagsChanged


className: FOnZoneGraphRequestRebuild

description: Called when rebuild is requested

code: typedef TMulticastDelegate_NoParams< void > FOnZoneGraphRequestRebuild


code: void Reset ( int32 InGeneration )


className: FRegisteredZoneGraphData

description: Struct representing registered ZoneGraph data in the subsystem.

bInUse

type: bool

ZoneGraphData

type: TObjectPtr<AZo...


className: FZoneData

BoundaryPointsBegin

description: First point of the zone boundary polyline inFZoneGraphStorage::BoundaryPoints.

BoundaryPointsEnd

description: One past the last point of the zone boundary polyline.

Bounds

type: FBox

description: Bounding box of the zone.

LanesBegin

description: First lane of the zone inFZoneGraphStorage::Lanes.

LanesEnd

description: One past the last lane.

Tags

type: FZoneGraphTagMa...

description: Zone tags.


code: FZoneGraphAStar ( const [FZoneGraphAStarWrapper](API\Plugins\ZoneGraph\FZoneGraphAStarWrapper) & Graph )


className: FZoneGraphAStar

description: A Star algorithm using lanes on zone graph

code: struct FZoneGraphAStar : public [FGraphAStar< FZoneGraphAStarWrapper, FGraphAStarDefaultPolicy, FZoneGraphAStarNode >](API\Runtime\AIModule\FGraphAStar)


className: Super

code: typedef [FGraphAStarDefaultNode](API\Runtime\AIModule\FGraphAStarDefaultNode)< [FZoneGraphAStarWrapper](API\Plugins\ZoneGraph\FZoneGraphAStarWrapper) > Super


code: [FGraphAStarDefaultNode](API\Runtime\AIModule\FGraphAStarDefaultNode) & operator= ( const [FGraphAStarDefaultNode](API\Runtime\AIModule\FGraphAStarDefaultNode) & Other )


code: FZoneGraphAStarNode ( const [FZoneGraphAStarNode](API\Plugins\ZoneGraph\FZoneGraphAStarNode) & Other )


code: FZoneGraphAStarNode ( const [FNodeRef](API\Plugins\ZoneGraph\FZoneGraphAStarNode\FNodeRef) InNodeRef, const FVector InPosition )


className: FZoneGraphAStarNode

description: Node representation forFZoneGraphAStar

code: struct FZoneGraphAStarNode : public [FGraphAStarDefaultNode< FZoneGraphAStarWrapper >](API\Runtime\AIModule\FGraphAStarDefaultNode)

Position

type: FVector


className: FNodeRef

description: FGraphAStar: TGraph.

code: typedef int32 FNodeRef


code: [FNodeRef](API\Plugins\ZoneGraph\FZoneGraphAStarWrapper\FNodeRef) GetNeighbour ( const [FZoneGraphAStarNode](API\Plugins\ZoneGraph\FZoneGraphAStarNode) & Node, const int32 NeighbourIndex ) const


code: int32 GetNeighbourCountV2 ( const [FZoneGraphAStarNode](API\Plugins\ZoneGraph\FZoneGraphAStarNode) & Node ) const


code: bool IsValidRef ( const [FNodeRef](API\Plugins\ZoneGraph\FZoneGraphAStarWrapper\FNodeRef) NodeRef ) const


code: FZoneGraphAStarWrapper ( const [FZoneGraphStorage](API\Plugins\ZoneGraph\FZoneGraphStorage) & InZoneGraph )


className: FZoneGraphAStarWrapper

description: Warpper around zone graph to be used byFGraphAStar

code: struct FZoneGraphAStarWrapper

ZoneGraph

type: constFZoneGrap...


className: FZoneGraphBuildData

description: Build time data, can be used to map things between editor representation and baked data.

ZoneShapeComponentBuildData

type: TMap<TObjectPt...


code: static void AppendShapeToZoneStorage ( const [UZoneShapeComponent](API\Plugins\ZoneGraph\UZoneShapeComponent) & ShapeComp, const FMatrix & LocalToWorld, [FZoneGraphStorage](API\Plugins\ZoneGraph\FZoneGraphStorage) & OutZoneStorage, [TArray](API\Runtime\Core\Containers\TArray)< [FZoneShapeLaneInternalLink](API\Plugins\ZoneGraph\FZoneShapeLaneInternalLink) > & OutInternalLinks, [FZoneGraphBuildData](API\Plugins\ZoneGraph\FZoneGraphBuildData) * InBuildData )


code: void Build ( [AZoneGraphData](API\Plugins\ZoneGraph\AZoneGraphData) & ZoneGraphData )


description: Converts single zone shape into a zone storage, used in UI for editing and rendering.

code: static void BuildSingleShape ( const [UZoneShapeComponent](API\Plugins\ZoneGraph\UZoneShapeComponent) & ShapeComp, const FMatrix & LocalToWorld, [FZoneGraphStorage](API\Plugins\ZoneGraph\FZoneGraphStorage) & OutZoneStorage )


description: Builds zone graph for each zone graph data based on registered shapes.

code: void BuildAll ( const [TArray](API\Runtime\Core\Containers\TArray)< [AZoneGraphData](API\Plugins\ZoneGraph\AZoneGraphData) * > & AllZoneGraphData, const bool bForceRebuild )


code: uint32 CalculateCombinedShapeHash ( const [AZoneGraphData](API\Plugins\ZoneGraph\AZoneGraphData) & ZoneGraphData ) const


code: void FindShapeConnections ( const [UZoneShapeComponent](API\Plugins\ZoneGraph\UZoneShapeComponent) & SourceShapeComp, [TArray](API\Runtime\Core\Containers\TArray)< [FZoneShapeConnection](API\Plugins\ZoneGraph\FZoneShapeConnection) > & OutShapeConnections ) const


code: static void ConnectLanes ( [TArray](API\Runtime\Core\Containers\TArray)< [FZoneShapeLaneInternalLink](API\Plugins\ZoneGraph\FZoneShapeLaneInternalLink) > & InternalLinks, [FZoneGraphStorage](API\Plugins\ZoneGraph\FZoneGraphStorage) & OutZoneStorage )


code: const [TArray](API\Runtime\Core\Containers\TArray)< [FZoneGraphBuilderRegisteredComponent](API\Plugins\ZoneGraph\FZoneGraphBuilderRegisteredCompo-) > & GetRegisteredZoneShapeComponents() const


code: void OnLaneProfileChanged ( const [FZoneLaneProfileRef](API\Plugins\ZoneGraph\FZoneLaneProfileRef) & ChangedLaneProfileRef )


code: void OnZoneShapeComponentChanged ( [UZoneShapeComponent](API\Plugins\ZoneGraph\UZoneShapeComponent) & ShapeComp )


code: void RegisterZoneShapeComponent ( [UZoneShapeComponent](API\Plugins\ZoneGraph\UZoneShapeComponent) & ShapeComp )


code: void UnregisterZoneShapeComponent ( [UZoneShapeComponent](API\Plugins\ZoneGraph\UZoneShapeComponent) & ShapeComp )


className: FZoneGraphBuilder

BuildData

type: FZoneGraphBuild...

OnBuildSettingsChangedHandle

type: FDelegateHandle

ShapeComponents

type: TArray<FZoneGr...

ShapeComponentsFreeList

type: TArray< int32 >


code: typedef [THierarchicalHashGrid2D](API\Runtime\AIModule\THierarchicalHashGrid2D)< 5, 4 > FZoneGraphBuilderHashGrid2D


code: FZoneGraphBuilderRegisteredComponent()


code: FZoneGraphBuilderRegisteredComponent ( [UZoneShapeComponent](API\Plugins\ZoneGraph\UZoneShapeComponent) * InComponent )


className: FZoneGraphBuilderRegisteredComponent


description: Connection restrictions for specified lane based on PolygonRoutingRules

code: [EZoneShapeLaneConnectionRestrictions](API\Plugins\ZoneGraph\EZoneShapeLaneConnectionRestrict-) GetConnectionRestrictions ( const [FZoneGraphTagMask](API\Plugins\ZoneGraph\FZoneGraphTagMask) ZoneTags, const [FZoneLaneProfileRef](API\Plugins\ZoneGraph\FZoneLaneProfileRef) & SourceLaneProfile, const int32 SourceConnectionCount, const [FZoneLaneProfileRef](API\Plugins\ZoneGraph\FZoneLaneProfileRef) & DestinationLaneProfile, const int32 DestinationConnectionCount ) const


description: tessellation tolerance for specific case, or common tolerance if no match.

code: float GetLaneTessellationTolerance ( const [FZoneGraphTagMask](API\Plugins\ZoneGraph\FZoneGraphTagMask) LaneTags ) const


className: FZoneGraphBuildSettings

CommonTessellationTolerance

type: float

description: Common tolerance for all lane tessellation, the error between tessellated point and the spline.

ConnectionSnapAngle

description: Max relative angle (in degrees) between two shape points for them to be snapped together.

ConnectionSnapDistance

description: Max distance between two shape points for them to be snapped together.

LaneConnectionAngle

description: Max relative angle (in degrees) between two lane profiles for them to be connected with lanes.

LaneConnectionMask

description: Mask of tags which should be used to check if lanes should connect.

PolygonRoutingRules

description: Routing rules applied to polygon shapes

SpecificTessellationTolerances

description: Custom tessellation tolerances based on lane tags, first match is returned.

TurnThresholdAngle

description: When the relative angle (in degrees) to destination on a polygon is more than the specified angle, it is considered left or right turn.


code: bool DoesOverlap ( const [FZoneGraphBVNode](API\Plugins\ZoneGraph\FZoneGraphBVNode) & Other ) const


code: FZoneGraphBVNode ( const uint16 InMinX, const uint16 InMinY, const uint16 InMinZ, const uint16 InMaxX, const uint16 InMaxY, const uint16 InMaxZ )


className: FZoneGraphBVNode

description: Quantized BV-tree node.

Index

description: ItemIndex, or if negative, the node is internal and the index is relative index to next sibling.

MinX

description: Quantized node bounds


description: Build BV-tree from boxes, the index of the box in the array will be the index of the query result.

code: void Build ( [TStridedView](API\Runtime\Core\Containers\TStridedView)< const FBox > Boxes )


description: quantized node bounds based on world bounds.

code: [FZoneGraphBVNode](API\Plugins\ZoneGraph\FZoneGraphBVNode) CalcNodeBounds ( const FBox & Box ) const


description: world bounding box of a node.

code: FBox CalcWorldBounds ( const [FZoneGraphBVNode](API\Plugins\ZoneGraph\FZoneGraphBVNode) & Node ) const


description: Tree nodes.

code: TConstArrayView< [FZoneGraphBVNode](API\Plugins\ZoneGraph\FZoneGraphBVNode) > GetNodes() const


description: number of nodes in the tree

code: int32 GetNumNodes() const


description: quantization origin

code: const FVector & GetOrigin() const


description: world-to-quantized scaling factor

code: float GetQuantizationScale() const


className: MaxQuantizedCoord

description: Max quantized coordinate value during conversion, the scale is truncated to account for the expansion inCalcNodeBounds().

code: static constexpr float MaxQuantizedCoord = float( ((uint16) 0xffff) - 1);


description: Queries the BV-tree, calls Function on each child node which bounds overlap the query bounds.

code: template<typename TFunc> void Query ( const FBox & Bounds, TFunc && Function ) const


description: Queries the BV-tree, return index of overlapping items.

code: void Query ( const FBox & Bounds, [TArray](API\Runtime\Core\Containers\TArray)< int32 > & OutItems ) const


className: FZoneGraphBVTree

description: Quantized BV-Tree

Nodes

description: BV-tree nodes.

Origin

description: Quantization range origin

QuantizationScale

description: Scale to convert from world coordinates to quantized range.


code: FZoneGraphCompactLaneLocation()


code: FZoneGraphCompactLaneLocation ( const [FZoneGraphLaneLocation](API\Plugins\ZoneGraph\FZoneGraphLaneLocation) & Location )


code: FZoneGraphCompactLaneLocation ( const [FZoneGraphLaneHandle](API\Plugins\ZoneGraph\FZoneGraphLaneHandle) Handle, const float Distance )


className: FZoneGraphCompactLaneLocation

description: Minimal amount of data to search and compare lane location.

LaneHandle

type: FZoneGraphLaneH...


className: InvalidGeneration

code: static const uint16 InvalidGeneration = 0;


code: bool operator== ( const [FZoneGraphDataHandle](API\Plugins\ZoneGraph\FZoneGraphDataHandle) & Other ) const


code: bool operator!= ( const [FZoneGraphDataHandle](API\Plugins\ZoneGraph\FZoneGraphDataHandle) & Other ) const


code: FZoneGraphDataHandle ( const uint16 InIndex, const uint16 InGeneration )


code: bool operator== ( const [FZoneGraphLaneHandle](API\Plugins\ZoneGraph\FZoneGraphLaneHandle) & Other ) const


code: FZoneGraphLaneHandle ( const int32 InLaneIndex, const [FZoneGraphDataHandle](API\Plugins\ZoneGraph\FZoneGraphDataHandle) InDataHandle )


className: FZoneGraphLaneHandle

DataHandle

type: FZoneGraphDataH...


code: bool operator!= ( const [FZoneGraphLaneHandle](API\Plugins\ZoneGraph\FZoneGraphLaneHandle) & Other ) const


className: FZoneGraphLaneLocation


code: void Add ( const [FZoneGraphLaneHandle](API\Plugins\ZoneGraph\FZoneGraphLaneHandle) & LaneHandle )


code: void Reset ( const [TArray](API\Runtime\Core\Containers\TArray)< [FZoneGraphLaneHandle](API\Plugins\ZoneGraph\FZoneGraphLaneHandle) >::SizeType NewSize )


className: FZoneGraphLanePath

code: struct FZoneGraphLanePath

EndLaneLocation

type: FZoneGraphLaneL...


className: FZoneGraphLaneRoutingRule

Comment

type: FString

DestinationIncomingConnections

type: EZoneGraphLaneR...

DestinationLaneProfile

type: FZoneLaneProfil...

ZoneTagFilter

type: FZoneGraphTagFi...


code: bool operator== ( const [FZoneGraphLaneSection](API\Plugins\ZoneGraph\FZoneGraphLaneSection) & Other ) const


className: FZoneGraphLaneSection

description: Section of a lane


code: bool HasFlags ( const [EZoneLaneLinkFlags](API\Plugins\ZoneGraph\EZoneLaneLinkFlags) InFlags ) const


code: void SetFlags ( const [EZoneLaneLinkFlags](API\Plugins\ZoneGraph\EZoneLaneLinkFlags) InFlags )


code: FZoneGraphLinkedLane ( const [FZoneGraphLaneHandle](API\Plugins\ZoneGraph\FZoneGraphLaneHandle) InDestLane, const [EZoneLaneLinkType](API\Plugins\ZoneGraph\EZoneLaneLinkType) InType, const [EZoneLaneLinkFlags](API\Plugins\ZoneGraph\EZoneLaneLinkFlags) InFlags )


className: FZoneGraphLinkedLane

description: Linked lane, used for query results. See also:FZoneLaneLinkData

DestLane

description: Destination lane handle

Flags

description: Specifics about the connection type, see EZoneLaneLinkFlags.

Type

type: EZoneLaneLinkTy...

description: Type of the connection.


description: True, if any of the properties in the chain has the Key set

code: bool HasMetaDataInChain ( const [FProperty](API\Runtime\CoreUObject\UObject\FProperty) * InProperty, [FName](API\Runtime\Core\UObject\FName) Key ) const


description: Checks whether the archive wants to skip the property independent of the other flags

code: virtual bool ShouldSkipProperty ( const [FProperty](API\Runtime\CoreUObject\UObject\FProperty) * InProperty ) const


description: Archive based object hashing to be used with ZoneGraph data calculation. If a property is has "IncludeInHash" meta tag, any of it's child properties will be included in the hash. Editor only s it relies on meta data.

code: class FZoneGraphObjectCRC32 : public [FArchiveObjectCrc32](API\Runtime\CoreUObject\Serialization\FArchiveObjectCrc32)


code: [FVector::FReal](API\Runtime\Core\Math\TVector\FReal) GetHeuristicCost ( const [FZoneGraphAStarNode](API\Plugins\ZoneGraph\FZoneGraphAStarNode) & NeighbourNode, const [FZoneGraphAStarNode](API\Plugins\ZoneGraph\FZoneGraphAStarNode) & EndNode ) const


code: [FVector::FReal](API\Runtime\Core\Math\TVector\FReal) GetTraversalCost ( const [FZoneGraphAStarNode](API\Plugins\ZoneGraph\FZoneGraphAStarNode) & CurNode, const [FZoneGraphAStarNode](API\Plugins\ZoneGraph\FZoneGraphAStarNode) & NeighbourNode ) const


code: bool IsEnd ( const [FZoneGraphAStarNode](API\Plugins\ZoneGraph\FZoneGraphAStarNode) & Node ) const


code: bool IsStart ( const [FZoneGraphAStarNode](API\Plugins\ZoneGraph\FZoneGraphAStarNode) & Node ) const


code: bool IsTraversalAllowed ( const [FNodeRef](API\Plugins\ZoneGraph\FZoneGraphPathFilter\FNodeRef) StartNodeRef, const [FNodeRef](API\Plugins\ZoneGraph\FZoneGraphPathFilter\FNodeRef) & Neighbour ) const


code: bool WantsPartialSolution() const


code: FZoneGraphPathFilter ( const [FZoneGraphStorage](API\Plugins\ZoneGraph\FZoneGraphStorage) & InGraph, const [FZoneGraphLaneLocation](API\Plugins\ZoneGraph\FZoneGraphLaneLocation) & InStartLocation, const [FZoneGraphLaneLocation](API\Plugins\ZoneGraph\FZoneGraphLaneLocation) & InEndLocation, const [FZoneGraphTagFilter](API\Plugins\ZoneGraph\FZoneGraphTagFilter) InZoneTagFilter )


className: FZoneGraphPathFilter

description: Context forFGraphAStar::FindPath()

code: struct FZoneGraphPathFilter


code: static [FZoneVisibility](API\Plugins\ZoneGraph\FZoneGraphSceneProxy\FZoneVisibility) CalculateZoneVisibility ( const [FDrawDistances](API\Plugins\ZoneGraph\FZoneGraphSceneProxy\FDrawDistances) & Distances, const FVector Origin, const FVector Position )


className: FDrawDistances

code: struct FDrawDistances


className: FZoneVisibility

code: struct FZoneVisibility

bDetailsVisible

type: bool


code: uint32 GetAllocatedSize() const


code: static [FDrawDistances](API\Plugins\ZoneGraph\FZoneGraphSceneProxy\FDrawDistances) GetDrawDistances ( const float MinDrawDistance, const float MaxDrawDistance )


description: Draw the scene proxy as a dynamic element

code: virtual void GetDynamicMeshElements ( const [TArray](API\Runtime\Core\Containers\TArray)< const [FSceneView](API\Runtime\Engine\FSceneView) * > & Views, const [FSceneViewFamily](API\Runtime\Engine\FSceneViewFamily) & ViewFamily, uint32 VisibilityMap, [FMeshElementCollector](API\Runtime\Engine\FMeshElementCollector) & Collector ) const


description: Every derived class should override these functions

code: virtual uint32 GetMemoryFootprint() const


description: Return a type (or subtype) specific hash for sorting purposes

code: virtual SIZE_T GetTypeHash() const


description:
Determines the relevance of this primitive's elements to the given view. Called in the rendering thread.
The relevance of the primitive's elements to the view.

code: virtual [FPrimitiveViewRelevance](API\Runtime\Engine\FPrimitiveViewRelevance) GetViewRelevance ( const [FSceneView](API\Runtime\Engine\FSceneView) * View ) const


code: static bool ShouldRenderZoneGraph ( const [FSceneView](API\Runtime\Engine\FSceneView) & View )


code: FZoneGraphSceneProxy ( const [UPrimitiveComponent](API\Runtime\Engine\Components\UPrimitiveComponent) & InComponent, const [AZoneGraphData](API\Plugins\ZoneGraph\AZoneGraphData) & ZoneGraph )


code: virtual ~FZoneGraphSceneProxy()


className: FZoneGraphSceneProxy

description: Exported to API for GameplayDebugger module

code: class FZoneGraphSceneProxy : public [FDebugRenderSceneProxy](API\Runtime\Engine\FDebugRenderSceneProxy)


code: const [FZoneData](API\Plugins\ZoneGraph\FZoneData) & GetZoneDataFromLaneIndex ( int32 LaneIndex ) const


className: FZoneGraphStorage

BoundaryPoints

type: TArray< FVector...

description: All the zone boundary points, referred by zones.

Bounds

type: FBox

description: Bounding box of all zones.

DataHandle

description: The handle that this storage represents, updated when data is registered to ZoneGraphSubsystem, used for query results.

LaneLinks

type: TArray<FZoneLa...

description: All the lane links, referred by lanes.

LanePointProgressions

type: TArray< float >

description: All the lane progression distances, referred by lanes.

LanePoints

description: All the lane points, referred by lanes.

Lanes

description: All the lanes, referred by zones.

LaneTangentVectors

description: All the lane tangent vectors, referred by lanes.

LaneUpVectors

description: All the lane up vectors, referred by lanes.

ZoneBVTree

type: FZoneGraphBVTre...

description: BV-Tree of Zones.

Zones

type: TArray<FZoneDa...

description: All the zones.


code: static const [FZoneGraphTag](API\Plugins\ZoneGraph\FZoneGraphTag) None = FZoneGraphTag();


className: NoneValue

code: static const uint8 NoneValue = 0xff;


code: bool operator== ( const [FZoneGraphTag](API\Plugins\ZoneGraph\FZoneGraphTag) & RHS ) const


code: bool operator!= ( const [FZoneGraphTag](API\Plugins\ZoneGraph\FZoneGraphTag) & RHS ) const


code: FZoneGraphTag ( const uint8 InBit )


code: bool operator== ( const [FZoneGraphTagFilter](API\Plugins\ZoneGraph\FZoneGraphTagFilter) & RHS ) const


code: bool operator!= ( const [FZoneGraphTagFilter](API\Plugins\ZoneGraph\FZoneGraphTagFilter) & RHS ) const


code: bool Pass ( const [FZoneGraphTagMask](API\Plugins\ZoneGraph\FZoneGraphTagMask) Tags ) const


className: FZoneGraphTagFilter

description: Filter passes if any of the 'AnyTags', and all of the 'AllTags', and none of the 'NotTags' are present. Setting include or exclude tags to None, will skip that particular check.

AllTags

type: FZoneGraphTagMa...


className: FZoneGraphTagInfo

Color

type: FColor

Name

type: FName

Tag

type: FZoneGraphTag


code: void Add ( const [FZoneGraphTagMask](API\Plugins\ZoneGraph\FZoneGraphTagMask) InTags )


code: void Add ( const [FZoneGraphTag](API\Plugins\ZoneGraph\FZoneGraphTag) InTag )


className: All

code: static const [FZoneGraphTagMask](API\Plugins\ZoneGraph\FZoneGraphTagMask) All = FZoneGraphTagMask(0xffffffff);


code: bool CompareMasks ( const [FZoneGraphTagMask](API\Plugins\ZoneGraph\FZoneGraphTagMask) InTags, const [EZoneLaneTagMaskComparison](API\Plugins\ZoneGraph\EZoneLaneTagMaskComparison) Operand ) const


code: bool Contains ( const [FZoneGraphTag](API\Plugins\ZoneGraph\FZoneGraphTag) InTag ) const


code: bool ContainsAny ( const [FZoneGraphTagMask](API\Plugins\ZoneGraph\FZoneGraphTagMask) InTags ) const


code: bool ContainsAll ( const [FZoneGraphTagMask](API\Plugins\ZoneGraph\FZoneGraphTagMask) InTags ) const


code: static const [FZoneGraphTagMask](API\Plugins\ZoneGraph\FZoneGraphTagMask) None = FZoneGraphTagMask(0);


code: bool operator!= ( const [FZoneGraphTagMask](API\Plugins\ZoneGraph\FZoneGraphTagMask) & RHS ) const


code: bool operator== ( const [FZoneGraphTagMask](API\Plugins\ZoneGraph\FZoneGraphTagMask) & RHS ) const


code: void Remove ( const [FZoneGraphTagMask](API\Plugins\ZoneGraph\FZoneGraphTagMask) InTags )


code: void Remove ( const [FZoneGraphTag](API\Plugins\ZoneGraph\FZoneGraphTag) InTag )


code: FZoneGraphTagMask ( const [FZoneGraphTag](API\Plugins\ZoneGraph\FZoneGraphTag) InTag )


code: FZoneGraphTagMask ( uint32 InMask )


className: FZoneGraphTessellationSettings

LaneFilter

description: Lanes to apply this tolerance.

TessellationTolerance

type: float

description: Tessellation tolerance, the error between tessellated point and the spline.


className: InvalidIndex

code: static const uint32 InvalidIndex = uint32(-1);


className: Invalid

code: static const [FZoneHandle](API\Plugins\ZoneGraph\FZoneHandle) Invalid = FZoneHandle();


code: bool operator== ( const [FZoneHandle](API\Plugins\ZoneGraph\FZoneHandle) & RHS ) const


code: bool operator!= ( const [FZoneHandle](API\Plugins\ZoneGraph\FZoneHandle) & RHS ) const


className: FZoneLaneData

description: TODO: We could replace *End with *Num, and use uint16. Begin probably needs to be int32/uint32.

EndEntryId

description: Source data entry ID.

LinksBegin

description: First link inFZoneGraphStorage::LaneLinks.

LinksEnd

description: One past the last lane link.

PointsBegin

description: First point of the lane polyline inFZoneGraphStorage::LanePoints.

PointsEnd

description: One past the last point of the lane polyline.

StartEntryId

description: Source data entry ID, this generally corresponds to input data point index.

Tags

description: Lane tags.

Width

description: Width of the lane.

ZoneIndex

description: Indexof the zone this lane belongs to.


code: bool operator== ( const [FZoneLaneDesc](API\Plugins\ZoneGraph\FZoneLaneDesc) & Other ) const


className: FZoneLaneDesc

description: Describes single lane.

Direction

type: EZoneLaneDirect...

description: Direction of the lane.

Tags

description: Lane tags.

Width

description: Width of the lane.


code: bool HasFlags ( const [EZoneLaneLinkFlags](API\Plugins\ZoneGraph\EZoneLaneLinkFlags) InFlags ) const


code: void SetFlags ( const [EZoneLaneLinkFlags](API\Plugins\ZoneGraph\EZoneLaneLinkFlags) InFlags )


code: FZoneLaneLinkData ( const int32 InDestLaneIndex, const [EZoneLaneLinkType](API\Plugins\ZoneGraph\EZoneLaneLinkType) InType, const [EZoneLaneLinkFlags](API\Plugins\ZoneGraph\EZoneLaneLinkFlags) InFlags )


className: FZoneLaneLinkData

DestLaneIndex

description: Indexto destination lane inFZoneGraphStorage::Lanes.

Flags

description: Specifics about the connection type, see EZoneLaneLinkFlags.

Type

description: Type of the connection.


description: Gets combined total with of all lanes.

code: float GetLanesTotalWidth() const


description: Returns true of the profile is symmetrical.

code: bool IsSymmetrical() const


description: Reverses the lane profile. The lanes array will be reversed, as well as the lane directions.

code: void ReverseLanes()


className: FZoneLaneProfile

description: Describes template of multiple parallel lanes, created in settings.

ID

type: FGuid


code: bool Equals ( const [FZoneLaneProfile](API\Plugins\ZoneGraph\FZoneLaneProfile) & LaneProfile ) const


code: bool operator== ( const [FZoneLaneProfileRef](API\Plugins\ZoneGraph\FZoneLaneProfileRef) & RHS ) const


code: FZoneLaneProfileRef ( const [FZoneLaneProfile](API\Plugins\ZoneGraph\FZoneLaneProfile) & LaneProfile )


className: FZoneLaneProfileRef

description: Reference to a lane profile.


className: FZoneShapeComponentBuildData

description: Build time data forUZoneShapeComponent.

Lanes

type: TArray<FZoneGr...


className: FZoneShapeConnection

description: Connection between two shape connectors.

ConnectorIndex

description: Connector index at the connected shape.

ShapeComponent

type: TWeakObjectPtr<...

description: Connected shape.


className: FZoneShapeConnector

description: Shape connectors represent locations where shapes can be connected together.

bReverseLaneProfile

description: True if lane profile should be treated as reversed.

LaneProfile

type: FZoneLaneProfil...

description: Lane template of the connector.

Normal

type: FVector

description: Normal direction of the connector.

PointIndex

description: Point index ofUZoneShapeComponent.

Position

description: Position of the connector.

ShapeType

type: FZoneShapeType

description: Which type of shape the connector belongs to.

Up

description: Up direction of the connector.


className: GUID

description: The GUID for this custom version number

code: static const [FGuid](API\Runtime\Core\Misc\FGuid) GUID;


className: Type

code: enum Type { BeforeCustomVersionWasAdded = 0, AddedRoll, VersionPlusOne, LatestVersion = VersionPlusOne - 1, }


className: FZoneShapeCustomVersion

description: No constructors are accessible with public or protected access.

code: struct FZoneShapeCustomVersion


code: bool operator< ( const [FZoneShapeLaneInternalLink](API\Plugins\ZoneGraph\FZoneShapeLaneInternalLink) & RHS ) const


code: FZoneShapeLaneInternalLink ( const int32 InLaneIdex, const [FZoneLaneLinkData](API\Plugins\ZoneGraph\FZoneLaneLinkData) InLinkData )


className: FZoneShapeLaneInternalLink

description: Struct describing a link for a specified lane, used during building

LaneIndex

description: Lane index to which the link belongs to

LinkData

type: FZoneLaneLinkDa...

description: Link details


description: Returns incoming Bezier control point. Adjust rotation.

code: FVector GetInControlPoint() const


description: Returns left edge of lane profile control point (similar relation as outgoing control point). Adjust rotation.

code: FVector GetLaneProfileLeft() const


description: Returns right edge of lane profile control point (similar relation as incoming control point). Adjust rotation.

code: FVector GetLaneProfileRight() const


description: Returns outgoing Bezier control point. Adjust rotation.

code: FVector GetOutControlPoint() const


className: InheritLaneProfile

code: static const uint8 InheritLaneProfile = 0xff;


code: void SetLaneConnectionRestrictions ( const [EZoneShapeLaneConnectionRestrictions](API\Plugins\ZoneGraph\EZoneShapeLaneConnectionRestrict-) Restrictions )


description: Sets incoming Bezier control point. Adjust rotation.

code: void SetInControlPoint ( const FVector & InPoint )


description: Sets left edge of lane profile control point.

code: void SetLaneProfileLeft ( const FVector & InPoint )


description: Returns right edge of lane profile control point. Adjust rotation.

code: void SetLaneProfileRight ( const FVector & InPoint )


description: Sets outgoing Bezier control point. Adjust rotation.

code: void SetOutControlPoint ( const FVector & InPoint )


description: Sets rotation pitch/yaw to match Forward direction, and then uses Up direction to find roll angle.

code: void SetRotationFromForwardAndUp ( const FVector & Forward, const FVector & Up )


code: FZoneShapePoint ( const FVector & InPosition )


className: FZoneShapePoint

bReverseLaneProfile

type: bool

description: True of lane profile should be reversed.

InnerTurnRadius

description: Inner turn radius associated with this point. Used when polygon shape routing is set to 'Arcs'.

LaneConnectionRestrictions

description: Lane connection restrictions

LaneProfile

description: Indexto external array referring to Lane Profile, or FZoneShapePoint::InheritLaneProfile if we should use Shape's lane profile.

Position

description: Position of the point

Rotation

type: FRotator

description: Rotation of the point.

TangentLength

description: Length of the Bezier point tangents, or cached half-width of the lane profile.

Type

type: FZoneShapePoint...

description: Type of the control point


className: FZoneShapePointType

code: enum FZoneShapePointType { Sharp, Bezier, AutoBezier, LaneProfile, }


className: FZoneShapeType

code: enum FZoneShapeType { Spline, Polygon, }


description:
Singleton-like access to this module's interface. This is just for convenience! Beware of calling this during the shutdown phase, though. Your module might have been unloaded already.
Returns singleton instance, loading the module on demand if needed

code: static [IZoneGraphModule](API\Plugins\ZoneGraph\IZoneGraphModule) & Get()


description:
Checks to see if this module is loaded and ready. It is only valid to callGet()ifIsAvailable()returns true.
True if the module is loaded and ready to use

code: static bool IsAvailable()


className: IZoneGraphModule

description: The public interface to this module. In most cases, this interface is only public to sibling modules within this plugin.

code: class IZoneGraphModule : public [IModuleInterface](API\Runtime\Core\Modules\IModuleInterface)


className: operator&

code: constexpr [EZoneLaneLinkType](API\Plugins\ZoneGraph\EZoneLaneLinkType) operator& ( [EZoneLaneLinkType](API\Plugins\ZoneGraph\EZoneLaneLinkType) Lhs, [EZoneLaneLinkType](API\Plugins\ZoneGraph\EZoneLaneLinkType) Rhs )


code: constexpr [EZoneLaneLinkFlags](API\Plugins\ZoneGraph\EZoneLaneLinkFlags) operator& ( [EZoneLaneLinkFlags](API\Plugins\ZoneGraph\EZoneLaneLinkFlags) Lhs, [EZoneLaneLinkFlags](API\Plugins\ZoneGraph\EZoneLaneLinkFlags) Rhs )


code: constexpr [EZoneShapeLaneConnectionRestrictions](API\Plugins\ZoneGraph\EZoneShapeLaneConnectionRestrict-) operator& ( [EZoneShapeLaneConnectionRestrictions](API\Plugins\ZoneGraph\EZoneShapeLaneConnectionRestrict-) Lhs, [EZoneShapeLaneConnectionRestrictions](API\Plugins\ZoneGraph\EZoneShapeLaneConnectionRestrict-) Rhs )


className: operator&=

code: [EZoneLaneLinkType](API\Plugins\ZoneGraph\EZoneLaneLinkType) & operator&= ( [EZoneLaneLinkType](API\Plugins\ZoneGraph\EZoneLaneLinkType) & Lhs, [EZoneLaneLinkType](API\Plugins\ZoneGraph\EZoneLaneLinkType) Rhs )


code: [EZoneLaneLinkFlags](API\Plugins\ZoneGraph\EZoneLaneLinkFlags) & operator&= ( [EZoneLaneLinkFlags](API\Plugins\ZoneGraph\EZoneLaneLinkFlags) & Lhs, [EZoneLaneLinkFlags](API\Plugins\ZoneGraph\EZoneLaneLinkFlags) Rhs )


code: [EZoneShapeLaneConnectionRestrictions](API\Plugins\ZoneGraph\EZoneShapeLaneConnectionRestrict-) & operator&= ( [EZoneShapeLaneConnectionRestrictions](API\Plugins\ZoneGraph\EZoneShapeLaneConnectionRestrict-) & Lhs, [EZoneShapeLaneConnectionRestrictions](API\Plugins\ZoneGraph\EZoneShapeLaneConnectionRestrict-) Rhs )


className: operator~

code: constexpr [EZoneLaneLinkType](API\Plugins\ZoneGraph\EZoneLaneLinkType) operator~ ( [EZoneLaneLinkType](API\Plugins\ZoneGraph\EZoneLaneLinkType) E )


code: constexpr [EZoneLaneLinkFlags](API\Plugins\ZoneGraph\EZoneLaneLinkFlags) operator~ ( [EZoneLaneLinkFlags](API\Plugins\ZoneGraph\EZoneLaneLinkFlags) E )


code: constexpr [EZoneShapeLaneConnectionRestrictions](API\Plugins\ZoneGraph\EZoneShapeLaneConnectionRestrict-) operator~ ( [EZoneShapeLaneConnectionRestrictions](API\Plugins\ZoneGraph\EZoneShapeLaneConnectionRestrict-) E )


className: operator^

code: constexpr [EZoneLaneLinkType](API\Plugins\ZoneGraph\EZoneLaneLinkType) operator^ ( [EZoneLaneLinkType](API\Plugins\ZoneGraph\EZoneLaneLinkType) Lhs, [EZoneLaneLinkType](API\Plugins\ZoneGraph\EZoneLaneLinkType) Rhs )


code: constexpr [EZoneLaneLinkFlags](API\Plugins\ZoneGraph\EZoneLaneLinkFlags) operator^ ( [EZoneLaneLinkFlags](API\Plugins\ZoneGraph\EZoneLaneLinkFlags) Lhs, [EZoneLaneLinkFlags](API\Plugins\ZoneGraph\EZoneLaneLinkFlags) Rhs )


code: constexpr [EZoneShapeLaneConnectionRestrictions](API\Plugins\ZoneGraph\EZoneShapeLaneConnectionRestrict-) operator^ ( [EZoneShapeLaneConnectionRestrictions](API\Plugins\ZoneGraph\EZoneShapeLaneConnectionRestrict-) Lhs, [EZoneShapeLaneConnectionRestrictions](API\Plugins\ZoneGraph\EZoneShapeLaneConnectionRestrict-) Rhs )


className: operator^=

code: [EZoneLaneLinkFlags](API\Plugins\ZoneGraph\EZoneLaneLinkFlags) & operator^= ( [EZoneLaneLinkFlags](API\Plugins\ZoneGraph\EZoneLaneLinkFlags) & Lhs, [EZoneLaneLinkFlags](API\Plugins\ZoneGraph\EZoneLaneLinkFlags) Rhs )


code: [EZoneLaneLinkType](API\Plugins\ZoneGraph\EZoneLaneLinkType) & operator^= ( [EZoneLaneLinkType](API\Plugins\ZoneGraph\EZoneLaneLinkType) & Lhs, [EZoneLaneLinkType](API\Plugins\ZoneGraph\EZoneLaneLinkType) Rhs )


code: [EZoneShapeLaneConnectionRestrictions](API\Plugins\ZoneGraph\EZoneShapeLaneConnectionRestrict-) & operator^= ( [EZoneShapeLaneConnectionRestrictions](API\Plugins\ZoneGraph\EZoneShapeLaneConnectionRestrict-) & Lhs, [EZoneShapeLaneConnectionRestrictions](API\Plugins\ZoneGraph\EZoneShapeLaneConnectionRestrict-) Rhs )


className: operator!

code: constexpr bool operator! ( [EZoneLaneLinkType](API\Plugins\ZoneGraph\EZoneLaneLinkType) E )


code: constexpr bool operator! ( [EZoneLaneLinkFlags](API\Plugins\ZoneGraph\EZoneLaneLinkFlags) E )


code: constexpr bool operator! ( [EZoneShapeLaneConnectionRestrictions](API\Plugins\ZoneGraph\EZoneShapeLaneConnectionRestrict-) E )


description: Evaluates cubic bezier value at specified time

code: namespace UE { namespace CubicBezier { FVector UE::CubicBezier::Eval ( const FVector & P0, const FVector & P1, const FVector & P2, const FVector & P3, const float t ) } }


description: Evaluates cubic bezier derivative at specified time

code: namespace UE { namespace CubicBezier { FVector UE::CubicBezier::EvalDerivate ( const FVector & P0, const FVector & P1, const FVector & P2, const FVector & P3, const float t ) } }


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

code: virtual FBoxSphereBounds CalcBounds ( const FTransform & LocalToWorld ) const


code: void CheckDrawFlagTimerFunction()


description:
Creates a proxy to represent the primitive to the scene manager in the rendering thread.
The proxy object.

code: virtual [FPrimitiveSceneProxy](API\Runtime\Engine\FPrimitiveSceneProxy) * CreateSceneProxy()


code: static bool IsNavigationShowFlagSet ( const [UWorld](API\Runtime\Engine\Engine\UWorld) * World )


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

code: virtual void OnRegister()


description: Called when a component is unregistered. Called after DestroyRenderState_Concurrent and OnDestroyPhysicsState are called.

code: virtual void OnUnregister()


code: UZoneGraphRenderingComponent ( const [FObjectInitializer](API\Runtime\CoreUObject\UObject\FObjectInitializer) & ObjectInitializer )


className: UZoneGraphRenderingComponent

code: [UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(HideCategories=Object, EditInlineNew) class UZoneGraphRenderingComponent : public [UPrimitiveComponent](API\Runtime\Engine\Components\UPrimitiveComponent)

DebugTextDrawingDelegateHandle

type: FDelegateHandle

TimerHandle

type: FTimerHandle


description:
Calculates hash values from all build settings Can be used to determine if the settings have changed between builds. Use property meta tag "ExcludeFromHash" to exclude non build related properties.
Hash value of all build related settings.

code: uint32 GetBuildHash() const


code: const [FZoneGraphBuildSettings](API\Plugins\ZoneGraph\FZoneGraphBuildSettings) & GetBuildSettings() const


code: const [FZoneLaneProfile](API\Plugins\ZoneGraph\FZoneLaneProfile) * GetDefaultLaneProfile() const


code: const [FZoneLaneProfile](API\Plugins\ZoneGraph\FZoneLaneProfile) * GetLaneProfileByID ( const [FGuid](API\Runtime\Core\Misc\FGuid) & ID ) const


code: const [FZoneLaneProfile](API\Plugins\ZoneGraph\FZoneLaneProfile) * GetLaneProfileByRef ( const [FZoneLaneProfileRef](API\Plugins\ZoneGraph\FZoneLaneProfileRef) & LaneProfileRef ) const


code: const [TArray](API\Runtime\Core\Containers\TArray)< [FZoneLaneProfile](API\Plugins\ZoneGraph\FZoneLaneProfile) > & GetLaneProfiles() const


code: float GetShapeMaxDrawDistance() const


code: TConstArrayView< [FZoneGraphTagInfo](API\Plugins\ZoneGraph\FZoneGraphTagInfo) > GetTagInfos() const


code: void GetValidTagInfos ( [TArray](API\Runtime\Core\Containers\TArray)< [FZoneGraphTagInfo](API\Plugins\ZoneGraph\FZoneGraphTagInfo) > & OutInfos ) const


description: This alternate version of PostEditChange is called when properties inside structs are modified. The property that was actually modified is located at the tail of the list. The head of the list of theFStructPropertymember variable that contains the property that was modified.

code: virtual void PostEditChangeChainProperty ( [FPropertyChangedChainEvent](API\Runtime\CoreUObject\UObject\FPropertyChangedChainEvent) & PropertyChangedEvent )


code: UZoneGraphSettings ( const [FObjectInitializer](API\Runtime\CoreUObject\UObject\FObjectInitializer) & ObjectInitializer )


className: UZoneGraphSettings

description: Implements the settings for the ZoneGraph plugin.

code: [UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(Config=Plugins, defaultconfig, DisplayName="Zone Graph") class UZoneGraphSettings : public [UDeveloperSettings](API\Runtime\DeveloperSettings\Engine\UDeveloperSettings)

bBuildZoneGraphWhileEditing

description: When set to true ZoneGraph will build as it is being edited.

BuildSettings

type: FZoneGraphBuild...

LaneProfiles

type: TArray<FZoneLa...

ShapeMaxDrawDistance

description: Max draw distance for shapes visualization.

Tags

type: FZoneGraphTagIn...

VisualizedTags

type: FZoneGraphTagMa...

description: Tags which affect visualization (i.e. color of lanes).


description: Moves LaneLocation along a lane.

code: bool AdvanceLaneLocation ( const [FZoneGraphLaneLocation](API\Plugins\ZoneGraph\FZoneGraphLaneLocation) & InLaneLocation, const float AdvanceDistance, [FZoneGraphLaneLocation](API\Plugins\ZoneGraph\FZoneGraphLaneLocation) & OutLaneLocation ) const


description: Returns point at a distance along a specific lane.

code: bool CalculateLocationAlongLane ( const [FZoneGraphLaneHandle](API\Plugins\ZoneGraph\FZoneGraphLaneHandle) LaneHandle, const float Distance, [FZoneGraphLaneLocation](API\Plugins\ZoneGraph\FZoneGraphLaneLocation) & OutLaneLocation ) const


description: Implement this for deinitialization of instances of the system

code: virtual void Deinitialize()


description: Find sections of lanes fully overlapping (including lane width). Finds results from all registered ZoneGraph data.

code: bool FindLaneOverlaps ( const FVector & Center, const float Radius, const [FZoneGraphTagFilter](API\Plugins\ZoneGraph\FZoneGraphTagFilter) TagFilter, [TArray](API\Runtime\Core\Containers\TArray)< [FZoneGraphLaneSection](API\Plugins\ZoneGraph\FZoneGraphLaneSection) > & OutLaneSections ) const


description: Find nearest location on a specific lane.

code: bool FindNearestLocationOnLane ( const [FZoneGraphLaneHandle](API\Plugins\ZoneGraph\FZoneGraphLaneHandle) LaneHandle, const FBox & Bounds, [FZoneGraphLaneLocation](API\Plugins\ZoneGraph\FZoneGraphLaneLocation) & OutLaneLocation, float & OutDistanceSqr ) const


description: Find nearest lane that touches the query bounds. Finds results from all registered ZoneGraph data.

code: bool FindNearestLane ( const FBox & QueryBounds, const [FZoneGraphTagFilter](API\Plugins\ZoneGraph\FZoneGraphTagFilter) TagFilter, [FZoneGraphLaneLocation](API\Plugins\ZoneGraph\FZoneGraphLaneLocation) & OutLaneLocation, float & OutDistanceSqr ) const


code: bool FindNearestLocationOnLane ( const [FZoneGraphLaneHandle](API\Plugins\ZoneGraph\FZoneGraphLaneHandle) LaneHandle, const FVector & Center, const float Range, [FZoneGraphLaneLocation](API\Plugins\ZoneGraph\FZoneGraphLaneLocation) & OutLaneLocation, float & OutDistanceSqr ) const


description: Find overlapping lanes that touches the query bounds. Finds results from all registered ZoneGraph data.

code: bool FindOverlappingLanes ( const FBox & QueryBounds, const [FZoneGraphTagFilter](API\Plugins\ZoneGraph\FZoneGraphTagFilter) TagFilter, [TArray](API\Runtime\Core\Containers\TArray)< [FZoneGraphLaneHandle](API\Plugins\ZoneGraph\FZoneGraphLaneHandle) > & OutLanes ) const


description: Returns bounds of all ZoneGraph data.

code: FBox GetCombinedBounds() const


description: Returns handle to first linked lane matching the connection type and flags.

code: bool GetFirstLinkedLane ( const [FZoneGraphLaneHandle](API\Plugins\ZoneGraph\FZoneGraphLaneHandle) LaneHandle, const [EZoneLaneLinkType](API\Plugins\ZoneGraph\EZoneLaneLinkType) Types, const [EZoneLaneLinkFlags](API\Plugins\ZoneGraph\EZoneLaneLinkFlags) IncludeFlags, const [EZoneLaneLinkFlags](API\Plugins\ZoneGraph\EZoneLaneLinkFlags) ExcludeFlags, [FZoneGraphLinkedLane](API\Plugins\ZoneGraph\FZoneGraphLinkedLane) & OutLinkedLane ) const


description: Returns the length of a specific lane.

code: bool GetLaneLength ( const [FZoneGraphLaneHandle](API\Plugins\ZoneGraph\FZoneGraphLaneHandle) LaneHandle, float & OutLength ) const


description: Returns the Tags of a specific lane.

code: bool GetLaneTags ( const [FZoneGraphLaneHandle](API\Plugins\ZoneGraph\FZoneGraphLaneHandle) LaneHandle, [FZoneGraphTagMask](API\Plugins\ZoneGraph\FZoneGraphTagMask) & OutTags ) const


description: Returns the width of a specific lane.

code: bool GetLaneWidth ( const [FZoneGraphLaneHandle](API\Plugins\ZoneGraph\FZoneGraphLaneHandle) LaneHandle, float & OutWidth ) const


description: Returns all links to connected lanes of a specific lane.

code: bool GetLinkedLanes ( const [FZoneGraphLaneHandle](API\Plugins\ZoneGraph\FZoneGraphLaneHandle) LaneHandle, const [EZoneLaneLinkType](API\Plugins\ZoneGraph\EZoneLaneLinkType) Types, const [EZoneLaneLinkFlags](API\Plugins\ZoneGraph\EZoneLaneLinkFlags) IncludeFlags, const [EZoneLaneLinkFlags](API\Plugins\ZoneGraph\EZoneLaneLinkFlags) ExcludeFlags, [TArray](API\Runtime\Core\Containers\TArray)< [FZoneGraphLinkedLane](API\Plugins\ZoneGraph\FZoneGraphLinkedLane) > & OutLinkedLanes ) const


code: TConstArrayView< [FRegisteredZoneGraphData](API\Plugins\ZoneGraph\FRegisteredZoneGraphData) > GetRegisteredZoneGraphData() const


description: Return the stat id to use for this tickable

code: virtual [TStatId](API\Runtime\Core\Stats\TStatId) GetStatId() const


description: Returns tag based on name.

code: [FZoneGraphTag](API\Plugins\ZoneGraph\FZoneGraphTag) GetTagByName ( [FName](API\Runtime\Core\UObject\FName) TagName ) const


description: Returns info about a specific tag.

code: const [FZoneGraphTagInfo](API\Plugins\ZoneGraph\FZoneGraphTagInfo) * GetTagInfo ( [FZoneGraphTag](API\Plugins\ZoneGraph\FZoneGraphTag) Tag ) const


description: Returns the name of a specific tag.

code: [FName](API\Runtime\Core\UObject\FName) GetTagName ( [FZoneGraphTag](API\Plugins\ZoneGraph\FZoneGraphTag) Tag ) const


description: Returns all tag infos.

code: TConstArrayView< [FZoneGraphTagInfo](API\Plugins\ZoneGraph\FZoneGraphTagInfo) > GetTagInfos() const


description: Returns Zone Graph data associated with specified handle.

code: const [AZoneGraphData](API\Plugins\ZoneGraph\AZoneGraphData) * GetZoneGraphData ( const [FZoneGraphDataHandle](API\Plugins\ZoneGraph\FZoneGraphDataHandle) DataHandle ) const


description: Returns Zone Graph data storage associated with specified handle, or nullptr if not found.

code: const [FZoneGraphStorage](API\Plugins\ZoneGraph\FZoneGraphStorage) * GetZoneGraphStorage ( const [FZoneGraphDataHandle](API\Plugins\ZoneGraph\FZoneGraphDataHandle) DataHandle ) const


description: USubsystemimplementation Begin.

code: virtual void Initialize ( [FSubsystemCollectionBase](API\Runtime\Engine\Subsystems\FSubsystemCollectionBase) & Collection )


description: Returns true if lane handle is valid.

code: bool IsLaneValid ( const [FZoneGraphLaneHandle](API\Plugins\ZoneGraph\FZoneGraphLaneHandle) LaneHandle ) const


code: void OnActorMoved ( [AActor](API\Runtime\Engine\GameFramework\AActor) * Actor )


description: Called once all UWorldSubsystems have been initialized

code: virtual void PostInitialize()


code: [FZoneGraphDataHandle](API\Plugins\ZoneGraph\FZoneGraphDataHandle) RegisterZoneGraphData ( [AZoneGraphData](API\Plugins\ZoneGraph\AZoneGraphData) & InZoneGraphData )


description: Rebuilds the graph.

code: void RebuildGraph ( const bool bForceRebuild )


code: void RemoveRegisteredDataItem ( const int32 Index )


code: void RegisterZoneGraphDataInstances()


description:
Used to determine whether the object should be ticked in the editor. Defaults to false since that is the previous behavior.
true if this tickable object can be ticked in the editor

code: virtual bool IsTickableInEditor() const


code: void SpawnMissingZoneGraphData()


description: Pure virtual that must be overloaded by the inheriting class. It will be called from within LevelTick.cpp after ticking all actors or from the rendering thread (depending on bIsRenderingThreadObject)

code: virtual void Tick ( float DeltaTime )


code: void UnregisterZoneGraphData ( [AZoneGraphData](API\Plugins\ZoneGraph\AZoneGraphData) & InZoneGraphData )


className: UZoneGraphSubsystem

code: [UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)() class UZoneGraphSubsystem : public [UTickableWorldSubsystem](API\Runtime\Engine\Subsystems\UTickableWorldSubsystem)

DataRegistrationSection

type: FCriticalSectio...

RegisteredZoneGraphData

type: TArray<FRegist...

ZoneGraphDataFreeList

type: TArray< int32 >


description:
Adds new one if one does not exists
index to the lane profile, or INDEX_NONE if new lane template could not be added.

code: int32 AddUniquePerPointLaneProfile ( const [FZoneLaneProfileRef](API\Plugins\ZoneGraph\FZoneLaneProfileRef) & NewLaneProfileRef )


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

code: virtual FBoxSphereBounds CalcBounds ( const FTransform & LocalToWorld ) const


description: Removes unused items from the per point lane template array.

code: void CompactPerPointLaneProfiles()


description: Removes per point lane templates.

code: void ClearPerPointLaneProfiles()


description:
Creates a proxy to represent the primitive to the scene manager in the rendering thread.
The proxy object.

code: virtual [FPrimitiveSceneProxy](API\Runtime\Engine\FPrimitiveSceneProxy) * CreateSceneProxy()


className: FOnShapeDataChanged

code: class FOnShapeDataChanged : public TBaseMulticastDelegate_NoParams< void >


description: View to connected shapes.

code: TConstArrayView< [FZoneShapeConnection](API\Plugins\ZoneGraph\FZoneShapeConnection) > GetConnectedShapes() const


description: Mutable reference to the points array.

code: [TArray](API\Runtime\Core\Containers\TArray)< [FZoneShapePoint](API\Plugins\ZoneGraph\FZoneShapePoint) > & GetMutablePoints()


description: Tags that can be changed.


description: Number of points in the shape.

code: int32 GetNumPoints() const


description: Number of segments in the shape.

code: int32 GetNumSegments() const


description: lane templates referred by points.

code: TConstArrayView< [FZoneLaneProfileRef](API\Plugins\ZoneGraph\FZoneLaneProfileRef) > GetPerPointLaneProfiles() const


description: View to the points array.

code: TConstArrayView< [FZoneShapePoint](API\Plugins\ZoneGraph\FZoneShapePoint) > GetPoints() const


description: Lane template for each point in the polygon shape.

code: void GetPolygonLaneProfiles ( [TArray](API\Runtime\Core\Containers\TArray)< [FZoneLaneProfile](API\Plugins\ZoneGraph\FZoneLaneProfile) > & OutLaneProfiles ) const


description: Polygon routing type


description: View to shape connectors array.

code: TConstArrayView< [FZoneShapeConnector](API\Plugins\ZoneGraph\FZoneShapeConnector) > GetShapeConnectors() const


description: Hash value of the shape data. Can be used to determine if the shape has changed.

code: uint32 GetShapeHash() const


description: Shape type.


description: The shape template used for the spline shape.

code: void GetSplineLaneProfile ( [FZoneLaneProfile](API\Plugins\ZoneGraph\FZoneLaneProfile) & OutLaneProfile ) const


description: Shape's tags.


description: Returns whether this component is an editor-only object or not

code: virtual bool IsEditorOnly() const


description: True if common lane profile is reversed.

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(Category=Zone, BlueprintPure) bool IsLaneProfileReversed() const


description: Returns true if the shape is closed form.

code: bool IsShapeClosed() const


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

code: virtual void OnRegister()


description: Called when a component is unregistered. Called after DestroyRenderState_Concurrent and OnDestroyPhysicsState are called.

code: virtual void OnUnregister()


description: Called when a property on this object has been modified externally

code: virtual void PostEditChangeProperty ( [FPropertyChangedEvent](API\Runtime\CoreUObject\UObject\FPropertyChangedEvent) & PropertyChangedEvent )


description: Called after importing property values for this object (paste, duplicate or .t3d import) Allow the object to perform any cleanup for properties which shouldn't be duplicated or are unsupported by the script serialization

code: virtual void PostEditImport()


description: Called after applying a transaction to the object. Default implementation simply calls PostEditChange.

code: virtual void PostEditUndo()


description: Do any object-specific cleanup required immediately after loading an object. This is not called for newly-created objects, and by default will always execute on the game thread.

code: virtual void PostLoad()


description: Handles reading, writing, and reference collecting usingFArchive. This implementation handles allFPropertyserialization, but can be overridden for native variables.

code: virtual void Serialize ( [FArchive](API\Runtime\Core\Serialization\FArchive) & Ar )


description: Sets lane profile which is used for spline lanes, and polygon points which are set to Inherit.

code: void SetCommonLaneProfile ( const [FZoneLaneProfileRef](API\Plugins\ZoneGraph\FZoneLaneProfileRef) & LaneProfileRef )


description: Sets the polygon routing type.

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(Category=Zone, BlueprintCallable) void SetPolygonRoutingType ( const [EZoneShapePolygonRoutingType](API\Plugins\ZoneGraph\EZoneShapePolygonRoutingType) NewType )


description:
Set whether common lane profile should be reversed.
Newly set reversed state.

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(Category=Zone, BlueprintCallable) bool SetReverseLaneProfile ( bool bReverse )


description: Sets shape type.

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(Category=Zone, BlueprintCallable) void SetShapeType ( [FZoneShapeType](API\Plugins\ZoneGraph\FZoneShapeType) Type )


description: Sets shape tags.

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(Category=Zone, BlueprintCallable) void SetTags ( const [FZoneGraphTagMask](API\Plugins\ZoneGraph\FZoneGraphTagMask) NewTags )


description: Updates how shape connectors are connected to other shapes.

code: void UpdateConnectedShapes()


description: Updates how shape connectors are connected to other shapes. In case a connection is found, the mating shape is updated too.

code: void UpdateMatingConnectedShapes()


description: Calculates rotation and tangent for a specific point.

code: void UpdatePointRotationAndTangent ( int32 PointIndex )


description: Updates shape, calculates auto tangents, and adjusts lane points to match the lane templates, updates connectors and connections.

code: void UpdateShape()


description: Updates shape connectors from the points.

code: void UpdateShapeConnectors()


className: UZoneShapeComponent

code: [UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(ClassGroup=Custom, BlueprintType, ShowCategories=(Mobility), HideCategories=(Physics, Collision, Lighting, Rendering, Mobile), Meta=(BlueprintSpawnableComponent)) class UZoneShapeComponent : public [UPrimitiveComponent](API\Runtime\Engine\Components\UPrimitiveComponent)


code: UZoneShapeComponent ( const [FObjectInitializer](API\Runtime\CoreUObject\UObject\FObjectInitializer) & ObjectInitializer )


className: EZoneGraphObstacleDisturbanceAreaAction

description: Actions for disturbances.

module: ZoneGraphAnnotations

code: enum EZoneGraphObstacleDisturbanceAreaAction { Add, Remove, }


className: FZoneGraphDataEscapeGraph

description: PerZoneGraphData escape graph.

code: struct FZoneGraphDataEscapeGraph

bInUse

description: True, if this entry is in use.

DataHandle

type: FZoneGraphDataH...

description: Handle of the data this Disturbance data relates to

LanesToEscape

type: TArray<FZoneGr...

description: Array of lanes to avoid.

LanesToEscapeLookup

type: TMap< int32, in...

description: Lookup from ZoneGraph Lane index to index in LanesToEscape

MaxEscapeCost

type: float

description: Max escape cost, used for visualization

PreviousLanes

description: Array of previous lanes that were marked.


className: FZoneGraphDisturbanceArea

description: Event for indicating an area of disturbance.

code: [USTRUCT](Programming/UnrealArchitecture/Reference/Structs)() struct FZoneGraphDisturbanceArea : public [FZoneGraphAnnotationEventBase](API\Plugins\ZoneGraphAnnotations\FZoneGraphAnnotationEventBase)

Duration

description: Duration of the danger.

InstigatorID

description: ID of the instigator of this event, events from the same instigator are combined.

Position

type: FVector

description: Center of the area.

Radius

description: Radius of the effect.


description: Finds a span based on the split distances.

code: uint8 FindSpanIndex ( const float Distance ) const


className: MaxSpans

code: static constexpr uint8 MaxSpans = 8;


code: FZoneGraphEscapeLaneAction()


code: FZoneGraphEscapeLaneAction ( const int32 InLaneIndex )


className: FZoneGraphEscapeLaneAction

description: Data describing how to Disturbance a lane, the lane is split in half and each half has its' own Disturbance action and direction.

code: struct FZoneGraphEscapeLaneAction

LaneIndex

description: LaneIndexthe data belongs to.

LaneLength

description: Cached lane length from ZoneGraph.

SpanCount

description: Number of spans on this lane

Spans

type: FZoneGraphEscap...

description: Disturbance actions for Start (0), and End (1) spans of the lane.

Tags

description: Disturbance annotation tags


className: FZoneGraphEscapeLaneSpan

description: Instructions how to escape from one half of a lane.

code: struct FZoneGraphEscapeLaneSpan

bLeadsToExit

type: bool

description: True if the action leads to exit

bReverseLaneDirection

description: True if the Disturbance action should move backwards along the lane.

Danger

description: Max danger value from all danger locations.

Direction

description: Lane direction, used for debug drawing.

EscapeCost

description: Disturbance cost value, lower the value leads to safety.

ExitLaneIndex

description: Indexto exit lane within current ZoneGraph data

ExitLinkType

type: EZoneLaneLinkTy...

description: Describes what type of linked lane to follow.

Position

description: Representative position of the action, used during graph calculation and debug drawing.

SplitDistance

description: Distance along the lane where lane is split in 2 spans.


code: bool operator== ( const [FZoneGraphObstacleDisturbanceArea](API\Plugins\ZoneGraphAnnotations\Annotations\FZoneGraphObstacleDisturbanceAre-) & Other ) const


className: FZoneGraphObstacleDisturbanceArea

description: Event for indicating an obstacle.

Action

type: EZoneGraphObsta...

description: Disturbance event action (ex: add/remove).

ObstacleID

type: FMassLaneObstac...

description: ID.

ObstacleRadius

description: Radius of the obstacle.

Position

description: Center of the obstacle.

Radius

description: Radius of the effect of the disturbance.


description: Triggers Danger event at specific location.

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="ZoneGraphAnnotations", Meta=(WorldContext="WorldContextObject")) static void TriggerDanger ( [UObject](API\Runtime\CoreUObject\UObject\UObject) * WorldContextObject, const [AActor](API\Runtime\Engine\GameFramework\AActor) * Instigator, const FVector Position, const float Radius, const float Duration )


code: void CalculateEscapeGraph ( [FZoneGraphDataEscapeGraph](API\Plugins\ZoneGraphAnnotations\Annotations\FZoneGraphDataEscapeGraph) & EscapeGraph )


description: Set of utilities for dealing with Disturbance Annotation.


description: Called when scene proxy is rebuilt.

code: virtual void DebugDraw ( [FZoneGraphAnnotationSceneProxy](API\Plugins\ZoneGraphAnnotations\FZoneGraphAnnotationSceneProxy) * DebugProxy )


description: Called when it's time to draw to canvas.

code: virtual void DebugDrawCanvas ( [UCanvas](API\Runtime\Engine\Engine\UCanvas) * Canvas, [APlayerController](API\Runtime\Engine\GameFramework\APlayerController) * )


description: Tags applied by the Annotation, used to lookup Annotations from tags.

code: virtual [FZoneGraphTagMask](API\Plugins\ZoneGraph\FZoneGraphTagMask) GetAnnotationTags() const


description: Disturbance action for a specific lane, or null of the lane does not have Disturbance action.

code: const [FZoneGraphEscapeLaneAction](API\Plugins\ZoneGraphAnnotations\Annotations\FZoneGraphEscapeLaneAction) * GetEscapeAction ( const [FZoneGraphLaneHandle](API\Plugins\ZoneGraph\FZoneGraphLaneHandle) LaneHandle ) const


description: Called when new events are ready to be processed

code: virtual void HandleEvents ( const [FInstancedStructContainer](API\Plugins\StructUtils\FInstancedStructContainer) & Events )


description: Called duringOnRegister(), or after all subsystems have been initialized.


description: Called when new ZoneGraph data is added.

code: virtual void PostZoneGraphDataAdded ( const [AZoneGraphData](API\Plugins\ZoneGraph\AZoneGraphData) & ZoneGraphData )


description: Called when new ZoneGraph data is removed.

code: virtual void PreZoneGraphDataRemoved ( const [AZoneGraphData](API\Plugins\ZoneGraph\AZoneGraphData) & ZoneGraphData )


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

code: virtual void TickAnnotation ( const float DeltaTime, [FZoneGraphAnnotationTagContainer](API\Plugins\ZoneGraphAnnotations\FZoneGraphAnnotationTagContainer) & AnnotationTagContainer )


code: void UpdateAnnotationTags ( [FZoneGraphAnnotationTagContainer](API\Plugins\ZoneGraphAnnotations\FZoneGraphAnnotationTagContainer) & AnnotationTagContainer )


code: void UpdateDangerLanes()


code: UZoneGraphDisturbanceAnnotation ( const [FObjectInitializer](API\Runtime\CoreUObject\UObject\FObjectInitializer) & ObjectInitializer )


className: UZoneGraphDisturbanceAnnotation

description: ZoneGraph Disturbance Annotation

AffectedLaneTags

type: FZoneGraphTagFi...

description: Filter specifying which lanes the Annotation is applied to.

bDisturbancesChanged

description: Flag indicating if the event processing changed the dangers.

DangerAnnotationTag

type: FZoneGraphTag

description: Tag to mark the lanes that should be fled.

Dangers

description: Array of currently active dangers.

EscapeGraphs

description: Disturbance graph for each ZoneGraphData

EscapeLaneTags

description: Filter specifying which lanes can be used during Disturbance.

IdealSpanLength

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

ObstacleAnnotationTag

description: Tag to mark the lanes influenced by an obstacle.

Obstacles

description: Array of obstacles.

PreviouslyAppliedTags

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

ZoneGraphSubsystem

type: TObjectPtr<UZo...

description: Cached ZoneGraphSubsystem


code: virtual FBox CalcBounds ( const FTransform & LocalToWorld ) const


code: virtual void DebugDraw ( [FDebugRenderSceneProxy](API\Runtime\Engine\FDebugRenderSceneProxy) * DebugProxy )


code: virtual void Trigger()


className: UZoneGraphDisturbanceAnnotationTest

description: Test for Disturbance Annotation


description: Called after an actor has been moved in the editor

code: virtual void PostEditMove ( bool bFinished )


code: AZoneGraphAnnotationTestingActor ( const [FObjectInitializer](API\Runtime\CoreUObject\UObject\FObjectInitializer) & ObjectInitializer )


description: Simple trigger function to trigger something on the tests. Ideally this would be part of each test, but it does not work there.

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, CallInEditor, Category="Test") void Trigger()


className: AZoneGraphAnnotationTestingActor

description: Debug actor to test Mass ZoneGraph Annotations.

code: [UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(HideCategories=(Actor, Input, Collision, Rendering, Replication, Partition, HLOD, Cooking)) class AZoneGraphAnnotationTestingActor : public [AActor](API\Runtime\Engine\GameFramework\AActor)


code: uint64 GetValue() const


className: InvalidID

code: static const [FMassLaneObstacleID](API\Plugins\ZoneGraphAnnotations\FMassLaneObstacleID) InvalidID;


code: bool IsValid() const


className: NextUniqueID

code: static uint64 NextUniqueID = 0;


code: bool operator== ( const [FMassLaneObstacleID](API\Plugins\ZoneGraphAnnotations\FMassLaneObstacleID) & Other ) const


code: FMassLaneObstacleID()


code: FMassLaneObstacleID &40; uint64 ID &41;


className: FMassLaneObstacleID

code: class FMassLaneObstacleID


className: FRegisteredZoneGraphAnnotation

description: Struct representing registered ZoneGraph data in the subsystem.

AnnotationTags

type: FZoneGraphTagMa...


className: FZoneGraphAnnotationEventBase

description: Base structs for all events forUZoneGraphAnnotationSubsystem.


description: Every derived class should override these functions

code: virtual uint32 GetMemoryFootprint() const


description: Return a type (or subtype) specific hash for sorting purposes

code: virtual SIZE_T GetTypeHash() const


description:
Determines the relevance of this primitive's elements to the given view. Called in the rendering thread.
The relevance of the primitive's elements to the view.

code: virtual [FPrimitiveViewRelevance](API\Runtime\Engine\FPrimitiveViewRelevance) GetViewRelevance ( const [FSceneView](API\Runtime\Engine\FSceneView) * View ) const


code: FZoneGraphAnnotationSceneProxy ( const [UPrimitiveComponent](API\Runtime\Engine\Components\UPrimitiveComponent) & InComponent, const [EDrawType](API\Runtime\Engine\FDebugRenderSceneProxy\EDrawType) InDrawType )


className: FZoneGraphAnnotationSceneProxy

code: class FZoneGraphAnnotationSceneProxy : public [FDebugRenderSceneProxy](API\Runtime\Engine\FDebugRenderSceneProxy)


code: [TArrayView](API\Runtime\Core\Containers\TArrayView)< [FZoneGraphTagMask](API\Plugins\ZoneGraph\FZoneGraphTagMask) > GetMutableAnnotationTagsForData ( const [FZoneGraphDataHandle](API\Plugins\ZoneGraph\FZoneGraphDataHandle) DataHandle )


className: FZoneGraphAnnotationTagContainer

description: Annotation tags per zone graph data

code: struct FZoneGraphAnnotationTagContainer

CombinedStaticTags

description: Mask combining all static tags used by any of the registered ZoneGraphData.


className: FZoneGraphDataAnnotationTags

description: Struct holding combined tags for a specific ZoneGraphData.

code: struct FZoneGraphDataAnnotationTags


className: GetTypeHash

code: uint32 GetTypeHash ( const [FMassLaneObstacleID](API\Plugins\ZoneGraphAnnotations\FMassLaneObstacleID) & Obs )


description:
Singleton-like access to this module's interface. This is just for convenience! Beware of calling this during the shutdown phase, though. Your module might have been unloaded already.
Returns singleton instance, loading the module on demand if needed

code: static [IZoneGraphAnnotationsModule](API\Plugins\ZoneGraphAnnotations\IZoneGraphAnnotationsModule) & Get()


description:
Checks to see if this module is loaded and ready. It is only valid to callGet()ifIsAvailable()returns true.
True if the module is loaded and ready to use

code: static bool IsAvailable()


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

code: virtual FBoxSphereBounds CalcBounds ( const FTransform & LocalToWorld ) const


className: IZoneGraphAnnotationsModule

description: The public interface to this module. In most cases, this interface is only public to sibling modules within this plugin.

code: class IZoneGraphAnnotationsModule : public [IModuleInterface](API\Runtime\Core\Modules\IModuleInterface)


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

code: virtual [FDebugRenderSceneProxy](API\Runtime\Engine\FDebugRenderSceneProxy) * CreateDebugSceneProxy()


description: Called when scene proxy is rebuilt.

code: virtual void DebugDraw ( [FZoneGraphAnnotationSceneProxy](API\Plugins\ZoneGraphAnnotations\FZoneGraphAnnotationSceneProxy) * DebugProxy )


description: Called when it's time to draw to canvas.

code: virtual void DebugDrawCanvas ( [UCanvas](API\Runtime\Engine\Engine\UCanvas) * Canvas, [APlayerController](API\Runtime\Engine\GameFramework\APlayerController) * )


description: Tags applied by the Annotation, used to lookup Annotations from tags.

code: virtual [FZoneGraphTagMask](API\Plugins\ZoneGraph\FZoneGraphTagMask) GetAnnotationTags() const


description: Returns first view point (player controller or debug camera)

code: void GetFirstViewPoint ( FVector & ViewLocation, FRotator & ViewRotation ) const


description: Returns ZoneGraph max debug draw distance.

code: float GetMaxDebugDrawDistance() const


code: void OnPostWorldInit ( [UWorld](API\Runtime\Engine\Engine\UWorld) * World, const [UWorld::InitializationValues](API\Runtime\Engine\Engine\UWorld\InitializationValues) )


description: Called when new events are ready to be processed

code: virtual void HandleEvents ( const [FInstancedStructContainer](API\Plugins\StructUtils\FInstancedStructContainer) & Events )


code: void OnPreZoneGraphDataRemoved ( const [AZoneGraphData](API\Plugins\ZoneGraph\AZoneGraphData) * ZoneGraphData )


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

code: virtual void OnRegister()


code: void OnPostZoneGraphDataAdded ( const [AZoneGraphData](API\Plugins\ZoneGraph\AZoneGraphData) * ZoneGraphData )


description: Called when a component is unregistered. Called after DestroyRenderState_Concurrent and OnDestroyPhysicsState are called.

code: virtual void OnUnregister()


description: This alternate version of PostEditChange is called when properties inside structs are modified. The property that was actually modified is located at the tail of the list. The head of the list of theFStructPropertymember variable that contains the property that was modified.

code: virtual void PostEditChangeChainProperty ( [FPropertyChangedChainEvent](API\Runtime\CoreUObject\UObject\FPropertyChangedChainEvent) & PropertyChangedEvent )


description: Called duringOnRegister(), or after all subsystems have been initialized.


description: Called when new ZoneGraph data is added.

code: virtual void PostZoneGraphDataAdded ( const [AZoneGraphData](API\Plugins\ZoneGraph\AZoneGraphData) & ZoneGraphData )


description: Called when new ZoneGraph data is removed.

code: virtual void PreZoneGraphDataRemoved ( const [AZoneGraphData](API\Plugins\ZoneGraph\AZoneGraphData) & ZoneGraphData )


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

code: virtual void TickAnnotation ( const float DeltaTime, [FZoneGraphAnnotationTagContainer](API\Plugins\ZoneGraphAnnotations\FZoneGraphAnnotationTagContainer) & AnnotationTagContainer )


code: UZoneGraphAnnotationComponent ( const [FObjectInitializer](API\Runtime\CoreUObject\UObject\FObjectInitializer) & ObjectInitializer )


className: UZoneGraphAnnotationComponent

code: [UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(Abstract) class UZoneGraphAnnotationComponent : public [UDebugDrawComponent](API\Runtime\Engine\Debug\UDebugDrawComponent)

CanvasDebugDrawDelegateHandle

type: FDelegateHandle


code: void AddToAnnotationLookup ( [UZoneGraphAnnotationComponent](API\Plugins\ZoneGraphAnnotations\UZoneGraphAnnotationComponent) & Annotation, const [FZoneGraphTagMask](API\Plugins\ZoneGraph\FZoneGraphTagMask) AnnotationTags )


description: Implement this for deinitialization of instances of the system

code: virtual void Deinitialize()


description: bitmask of Annotation tags at given lane

code: [FZoneGraphTagMask](API\Plugins\ZoneGraph\FZoneGraphTagMask) GetAnnotationTags ( const [FZoneGraphLaneHandle](API\Plugins\ZoneGraph\FZoneGraphLaneHandle) LaneHandle ) const