1. Epic GamesDeveloper
  3. FPCGActorAndComponentMapping

FPCGActorAndComponentMapping

This class handle any necessary mapping between actors and pcg components.

API > API/Plugins > API/Plugins/PCG

References

   
Module PCG
Header /Engine/Plugins/PCG/Source/PCG/Public/PCGActorAndComponentMapping.h
Include #include "PCGActorAndComponentMapping.h"

Syntax

class FPCGActorAndComponentMapping

Remarks

This class handle any necessary mapping between actors and pcg components. Its meant to be part of the PCG Subsystem and owned by it. We offload some logic to this class to avoid to clutter the subsystem. For now it is used for:

  • Mapping between PCG Components and Partition actors: Dispatch tasks from original components to local components
  • Tracking non partitioned PCG Components that has tracking actors needs.
  • Tracking actors: Be able to react to actors changes, and potentially dirty/refresh affected components

Variables

  Type Name Description
Public variable friend FPCGRuntimeGenScheduler  
Public variable friend UPCGSubsystem  

Constructors

No constructors are accessible with public or protected access.

Destructors

  Type Name Description
Public function    

Functions

  Type Name Description
Public function void Deinitializes callbacks, etc, tied to the PCG subsystem
Public function Const TSet< UPCGComponent * > Return a copy of all the registered components. Thread safe
Public function Const TSet< UPCGComponent * > Return a copy of all the registered non-partitioned components. Thread safe
Public function Const TSet< UPCGComponent * > Return a copy of all the registered partitioned components. Thread safe
Public function Const UPCGComponent *

GetLocalComponent ( uint32 GridSize,
const FIntVector& CellCoords,
const UPCGComponent* InOriginalComponent,
bool bRuntimeGenerated
)

 Retrieves a local component using grid size and grid coordinates, returns nullptr if no such component is found.
Public function Const APCGPartitionActor *

GetPartitionActor ( uint32 GridSize,
const FIntVector& CellCoords,
bool bRuntimeGenerated
)

 Retrieves a partition actor using grid size and grid coordinates, returns nullptr if no such partition actor is found.
Public function void

Initialize ( UWorld* World
)

 Initializes callbacks, etc, tied to the PCG subsystem
Public function void Notify that we exited the Landscape edit mode.
Public function bool

RegisterOrUpdatePCGComponent ( UPCGComponent* InComponent,
bool bDoActorMapping
)

 Register a new PCG Component or update it. Returns true if it was added/updated. Thread safe
Public function void

RegisterPartitionActor ( APCGPartitionActor* InActor,
bool bDoComponentMapping
)

 Register a new Partition actor, will be added to a map and will query all intersecting volume to bind to them if asked.
Public function bool

RemapPCGComponent ( const UPCGComponent* OldComponent,
UPCGComponent* NewComponent,
bool bDoActorMapping
)

 In case of BP Actors, we need to remap the old component destroyed by the construction script to the new one.
Public function void

Tick ()

 Should be called by the subsystem to handle delayed operations.
Public function void Unregister a Partition actor, will be removed from the map and remove itself to all intersecting volumes.
Public function void

UnregisterPCGComponent ( UPCGComponent* InComponent,
bool bForce
)

 Unregister a PCG Component. Can force it, if we have a delayed unregister. Thread safe

Typedefs

Name Description
FActorPreviousData Typedef to store the previous position and previous tags of changed actors.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page