Navigation
API > API/Plugins > API/Plugins/PCG
Calculates the distance between two points (inherently a n*n operation)
| Name | UPCGDistanceSettings |
| Type | class |
| Header File | /Engine/Plugins/PCG/Source/PCG/Public/Elements/PCGDistance.h |
| Include Path | #include "Elements/PCGDistance.h" |
Syntax
UCLASS (BlueprintType, ClassGroup=(Procedural))
class UPCGDistanceSettings : public UPCGSettings
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UPCGData → UPCGSettingsInterface → UPCGSettings → UPCGDistanceSettings
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bCheckSourceAgainstRespectiveTarget | bool | If this option is on, each source will be tested against its respective target (for a N:N operation). | Elements/PCGDistance.h |
|
| bOutputDistanceVector | bool | Controls whether the attribute will be a scalar or a vector | Elements/PCGDistance.h |
|
| bOutputToAttribute | bool | Output the distance or distance vector to an attribute. | Elements/PCGDistance.h |
|
| bSetDensity | bool | If true, will also set the density to be 0 - 1 based on MaximumDistance | Elements/PCGDistance.h |
|
| MaximumDistance | double | A maximum distance to search, which is used as an optimization | Elements/PCGDistance.h |
|
| OutputAttribute | FPCGAttributePropertySelector | The attribute output for the resulting distance value. | Elements/PCGDistance.h |
|
| SourceShape | PCGDistanceShape | What shape is used on the 'source' points | Elements/PCGDistance.h |
|
| TargetShape | PCGDistanceShape | What shape is used on the 'target' points | Elements/PCGDistance.h |
|
Functions
Public
Overridden from UPCGSettings
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual FName GetDefaultNodeName() |
Elements/PCGDistance.h | ||
virtual FText GetDefaultNodeTitle() |
Elements/PCGDistance.h | ||
virtual FText GetNodeTooltipText() |
Elements/PCGDistance.h | ||
virtual EPCGSettingsType GetType() |
Elements/PCGDistance.h |
Overridden from UObject
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void PostLoad() |
Elements/PCGDistance.h |
Protected
Overridden from UPCGSettings
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual FPCGElementPtr CreateElement() |
Elements/PCGDistance.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/PCGDistance.h | |
virtual TArray< FPCGPinProperties > OutputPinProperties() |
Elements/PCGDistance.h |
Deprecated Variables
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| AttributeName_DEPRECATED | FName | Elements/PCGDistance.h |
|