UPCGAttractSettings | Unreal Engine 5.7 Documentation

Attracts points (interpolates) from the source towards points from the target.


Name	UPCGAttractSettings
Type	class
Header File	/Engine/Plugins/PCG/Source/PCG/Public/Elements/PCGAttractElement.h
Include Path	#include "Elements/PCGAttractElement.h"

Syntax

UCLASS (MinimalAPI, BlueprintType, ClassGroup=(Procedural))  
class UPCGAttractSettings : public UPCGSettings

Inheritance Hierarchy

UObjectBase → UObjectBaseUtility → UObject → UPCGData → UPCGSettingsInterface → UPCGSettings → UPCGAttractSettings

Constructors

Name	Remarks	Include Path	Unreal Specifiers
UPCGAttractSettings()		Elements/PCGAttractElement.h

Variables

Public

Name	Type	Remarks	Include Path	Unreal Specifiers
AttractorIndexAttribute	FPCGAttributePropertyInputSelector	Index attribute on the source that maps a point to a point from the target.	Elements/PCGAttractElement.h	EditAnywhere BlueprintReadWrite Category=Settings Meta=(EditCondition="Mode == EPCGAttractMode::FromIndex", EditConditionHides, PCG_Overridable)
bOutputAttractIndex	bool		Elements/PCGAttractElement.h	EditAnywhere BlueprintReadWrite Category=Settings Meta=(InlineEditConditionToggle, PCG_Overridable)
bRemoveUnattractedPoints	bool	Can optionally remove points that weren't attracted to points on the target.	Elements/PCGAttractElement.h	EditAnywhere BlueprintReadWrite Category=Settings Meta=(PCG_Overridable)
bUseSourceWeight	bool		Elements/PCGAttractElement.h	EditAnywhere BlueprintReadWrite Category=Settings Meta=(InlineEditConditionToggle, PCG_Overridable)
bUseTargetWeight	bool		Elements/PCGAttractElement.h	EditAnywhere BlueprintReadWrite Category=Settings Meta=(InlineEditConditionToggle, PCG_Overridable)
Distance	double	Will be used to determine which points to attract.	Elements/PCGAttractElement.h	EditAnywhere BlueprintReadWrite Category=Settings Meta=(EditCondition="Mode != EPCGAttractMode::FromIndex", ClampMin="0.01", PCG_Overridable)
Mode	EPCGAttractMode	Controls the criteria used for the attract operation.	Elements/PCGAttractElement.h	EditAnywhere BlueprintReadWrite Category=Settings Meta=(PCG_Overridable)
OutputAttractIndexAttribute	FPCGAttributePropertyOutputNoSourceSelector		Elements/PCGAttractElement.h	EditAnywhere BlueprintReadWrite Category=Settings Meta=(EditCondition="bOutputAttractIndex", PCG_Overridable)
SourceAndTargetAttributeMapping	TMap< FPCGAttributePropertyInputSelector, FPCGAttributePropertyInputSelector >		Elements/PCGAttractElement.h	EditAnywhere BlueprintReadWrite Category=Settings
SourceWeightAttribute	FPCGAttributePropertyInputSelector	This attribute will determine the weight of the fusion result for the source point.	Elements/PCGAttractElement.h	EditAnywhere BlueprintReadWrite Category=Settings Meta=(EditCondition="bUseSourceWeight", PCG_Overridable)
TargetAttribute	FPCGAttributePropertyInputSelector	The target attribute used when attracted by attribute value.	Elements/PCGAttractElement.h	EditAnywhere BlueprintReadWrite Category=Settings Meta=(EditCondition="Mode == EPCGAttractMode::MinAttribute \|\| Mode == EPCGAttractMode::MaxAttribute", EditConditionHides, PCG_Overridable)
TargetWeightAttribute	FPCGAttributePropertyInputSelector	This attribute will determine the weight of the fusion result for the target point.	Elements/PCGAttractElement.h	EditAnywhere BlueprintReadWrite Category=Settings Meta=(EditCondition="bUseTargetWeight", PCG_Overridable)
Weight	double		Elements/PCGAttractElement.h	EditAnywhere BlueprintReadWrite Category=Settings Meta=(ClampMin="-1.0", ClampMax="1.0", EditCondition="!bUseSourceWeight && !bUseTargetWeight", PCG_Overridable)

Functions

Public

Overridden from UPCGSettings

Name	Remarks	Include Path	Unreal Specifiers
virtual FName GetDefaultNodeName()		Elements/PCGAttractElement.h
virtual FText GetDefaultNodeTitle()		Elements/PCGAttractElement.h
virtual FText GetNodeTooltipText()		Elements/PCGAttractElement.h
virtual EPCGSettingsType GetType()		Elements/PCGAttractElement.h

Protected

Overridden from UPCGSettings

Name	Remarks	Include Path
virtual FPCGElementPtr CreateElement()		Elements/PCGAttractElement.h
virtual TArray< FPCGPinProperties > InputPinProperties()	Returns an array of all the input pin properties. You should not add manually a "params" pin, it is handled automatically by FillOverridableParamsPins.	Elements/PCGAttractElement.h
virtual TArray< FPCGPinProperties > OutputPinProperties()		Elements/PCGAttractElement.h

Navigation

Syntax

Inheritance Hierarchy

Constructors

Variables

Public

Functions

Public

Overridden from UPCGSettings

Protected

Overridden from UPCGSettings