1. Epic GamesDeveloper
  3. UPCGBlueprintElement

UPCGBlueprintElement

Class is no longer supported and doesn't support PCGBasePointData.

API > API/Plugins > API/Plugins/PCG

Class is no longer supported and doesn't support PCGBasePointData. Please sub-class UPCGBlueprintBaseElement instead or use one of its existing child classes (ex: PCGBlueprintPointProcessorElement, PCGBlueprintSimplePointProcessorElement).

   
Name UPCGBlueprintElement
Type class
Header File /Engine/Plugins/PCG/Source/PCG/Public/Elements/Blueprint/PCGBlueprintDeprecatedElement.h
Include Path #include "Elements/Blueprint/PCGBlueprintDeprecatedElement.h"

Syntax

UCLASS (MinimalAPI, Abstract, BlueprintType, Blueprintable, HideCategories=(Object),  
       Meta=(DisplayName="Deprecated Blueprint Element"))  
class UPCGBlueprintElement : public UPCGBlueprintBaseElement

Inheritance Hierarchy

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
OnBlueprintChangedDelegate FOnPCGBlueprintChanged   Elements/Blueprint/PCGBlueprintDeprecatedElement.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void ExecuteWithContext ( FPCGContext& InContext,
const FPCGDataCollection& Input,
FPCGDataCollection& Output
)

 Main execution function that will contain the logic for this PCG Element, with the context as parameter. Elements/Blueprint/PCGBlueprintDeprecatedElement.h
  • BlueprintNativeEvent
  • Category="PCG|Execution"

FPCGContext & GetContext()

 Retrieves the execution context - note that this will not be valid outside of the Execute functions Elements/Blueprint/PCGBlueprintDeprecatedElement.h
  • BlueprintCallable
  • Category="PCG|Advanced"
  • Meta=(HideSelfPin="true")

FRandomStream GetRandomStream ( FPCGContext& InContext
) const

 Creates a random stream from the settings & source component Elements/Blueprint/PCGBlueprintDeprecatedElement.h
  • BlueprintCallable
  • BlueprintPure=false
  • Category="PCG|Random"

int GetSeed ( FPCGContext& InContext
) const

 Gets the seed from the associated settings & source component Elements/Blueprint/PCGBlueprintDeprecatedElement.h
  • BlueprintCallable
  • Category="PCG|Random"

void IterationLoop ( FPCGContext& InContext,
int64 NumIterations,
UPCGPointData*& OutData,
const UPCGSpatialData* OptionalA,
const UPCGSpatialData* OptionalB,
UPCGPointData* OptionalOutData
) const

 Calls the IterationLoopBody a fixed number of times, optional parameters are used to potentially initialized the Out Data, but otherwise are used to remove the need to have variables Elements/Blueprint/PCGBlueprintDeprecatedElement.h
  • BlueprintCallable
  • BlueprintPure=false
  • Category="PCG|Flow Control"
  • Meta=(HideSelfPin="true")

bool IterationLoopBody ( const FPCGContext& InContext,
int64 Iteration,
const UPCGSpatialData* InA,
const UPCGSpatialData* InB,
FPCGPoint& OutPoint,
UPCGMetadata* OutMetadata
) const

 Multi-threaded loop that will be called N number of times (defined by Iteration Loop parameter NumIterations). Elements/Blueprint/PCGBlueprintDeprecatedElement.h
  • BlueprintImplementableEvent
  • Category="PCG|Flow Control"

void NestedLoop ( FPCGContext& InContext,
const UPCGPointData* InOuterData,
const UPCGPointData* InInnerData,
UPCGPointData*& OutData,
UPCGPointData* OptionalOutData
) const

 Calls the NestedLoopBody function on all nested loop pairs (e.g. (o, i) for all o in Outer, i in Inner) Elements/Blueprint/PCGBlueprintDeprecatedElement.h
  • BlueprintCallable
  • BlueprintPure=false
  • Category="PCG|FLow Control"
  • Meta=(HideSelfPin="true")

bool NestedLoopBody ( const FPCGContext& InContext,
const UPCGPointData* InOuterData,
const UPCGPointData* InInnerData,
const FPCGPoint& InOuterPoint,
const FPCGPoint& InInnerPoint,
FPCGPoint& OutPoint,
UPCGMetadata* OutMetadata,
int64 OuterIteration,
int64 InnerIteration
) const

 Multi-threaded loop that will iterate on all nested loop pairs (e.g. (o, i) for all o in Outer, i in Inner). Elements/Blueprint/PCGBlueprintDeprecatedElement.h
  • BlueprintImplementableEvent
  • Category="PCG|Flow Control"

void PointLoop ( FPCGContext& InContext,
const UPCGPointData* InData,
UPCGPointData*& OutData,
UPCGPointData* OptionalOutData
) const

 Calls the PointLoopBody function on all points Elements/Blueprint/PCGBlueprintDeprecatedElement.h
  • BlueprintCallable
  • BlueprintPure=false
  • Category="PCG|Flow Control"
  • Meta=(HideSelfPin="true")

bool PointLoopBody ( const FPCGContext& InContext,
const UPCGPointData* InData,
const FPCGPoint& InPoint,
FPCGPoint& OutPoint,
UPCGMetadata* OutMetadata,
int64 Iteration
) const

 Multi-threaded loop that will iterate on all points in InData. Elements/Blueprint/PCGBlueprintDeprecatedElement.h
  • BlueprintImplementableEvent
  • Category="PCG|Flow Control"

void VariableLoop ( FPCGContext& InContext,
const UPCGPointData* InData,
UPCGPointData*& OutData,
UPCGPointData* OptionalOutData
) const

 Calls the VariableLoopBody function on all points, each call can return a variable number of points Elements/Blueprint/PCGBlueprintDeprecatedElement.h
  • BlueprintCallable
  • BlueprintPure=false
  • Category="PCG|Flow Control"
  • Meta=(HideSelfPin="true")

TArray< FPCGPoint > VariableLoopBody ( const FPCGContext& InContext,
const UPCGPointData* InData,
const FPCGPoint& InPoint,
UPCGMetadata* OutMetadata,
int64 Iteration
) const

 Multi-threaded loop that will be called on all points in InData. Elements/Blueprint/PCGBlueprintDeprecatedElement.h
  • BlueprintImplementableEvent
  • Category="PCG|Flow Control"

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page