UPCGSplineIntersectionSettings

Intersects splines against other splines (or themselves) and returns varied results based on user need.

API > API/Plugins > API/Plugins/PCG

Intersects splines against other splines (or themselves) and returns varied results based on user need.

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

Syntax

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

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

UPCGSplineIntersectionSettings()

   Elements/PCGSplineIntersection.h  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
bOutputComplexIntersections bool Controls whether we'll output intersection ranges (start/end) when relevant instead of singular points. Elements/PCGSplineIntersection.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category=Settings
  • Meta=(PCG_Overridable)
bOutputIntersectionType bool Controls whether intersection types will be written to the attributes. Elements/PCGSplineIntersection.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category=Settings
  • Meta=(PCG_Overridable, InlineEditConditionToggle)
bOutputSplineIndices bool Controls whether the output will contain the index of the intersecting splines Elements/PCGSplineIntersection.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category=Settings
  • Meta=(EditCondition="Type!=EPCGSplineIntersectionType::Self")
bUseBestFitBox bool Controls whether the output for intersection points is oriented using a best fit box (using PCA - Principal Component Analysis) or if it's aligned on the longest intersection. Elements/PCGSplineIntersection.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category=Settings
  • Meta=(PCG_Overridable, EditCondition="Output==EPCGSplineIntersectionOutput::IntersectionPointsOnly", EditConditionHides)
DistanceThreshold double Maximum distance at which we report an intersection on the splines. Elements/PCGSplineIntersection.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category=Settings
  • Meta=(ClampMin="0.0001", PCG_Overridable)
IntersectingSplineIndexAttribute FPCGAttributePropertyOutputNoSourceSelector Attribute that will contain the first intersecting spline index, or -1 if not an intersection control point. Elements/PCGSplineIntersection.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category=Settings
  • Meta=(PCG_Overridable, PCG_DiscardPropertySelection, PCG_DiscardExtraSelection, EditCondition="bOutputSplineIndices")
IntersectionTypeAttribute FPCGAttributePropertyOutputNoSourceSelector Attribute that will contain the intersection type (0: not an intersection, 1: point intersection, 2: intersection start, 3: intersection end.) Elements/PCGSplineIntersection.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category=Settings
  • Meta=(PCG_Overridable, PCG_DiscardPropertySelection, PCG_DiscardExtraSelection, EditCondition="bOutputIntersectionType")
OriginatingSplineIndexAttribute FPCGAttributePropertyOutputNoSourceSelector Attribute that will contain the first spline index (only in the output case of intersection points.) Elements/PCGSplineIntersection.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category=Settings
  • Meta=(PCG_Overridable, PCG_DiscardPropertySelection, PCG_DiscardExtraSelection, EditCondition="bOutputSplineIndices && Type!=EPCGSplineIntersectionType::Self && Output==EPCGSplineIntersectionOutput::IntersectionPointsOnly")
Output EPCGSplineIntersectionOutput Controls type of output result. Elements/PCGSplineIntersection.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category=Settings
Type EPCGSplineIntersectionType Controls type of intersection test that will be done. Elements/PCGSplineIntersection.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category=Settings

Functions

Public

Public Virtual

Overridden from UPCGSettings

Name Remarks Include Path Unreal Specifiers

virtual EPCGChangeType GetChangeTypeForProperty ( const FName& InPropertyName
) const

 Gets the change impact for a given property. Elements/PCGSplineIntersection.h  

virtual FName GetDefaultNodeName()

   Elements/PCGSplineIntersection.h  

virtual FText GetDefaultNodeTitle()

   Elements/PCGSplineIntersection.h  

virtual EPCGSettingsType GetType()

   Elements/PCGSplineIntersection.h  

Protected Virtual

Overridden from UPCGSettings

Name Remarks Include Path Unreal Specifiers

virtual FPCGElementPtr CreateElement()

   Elements/PCGSplineIntersection.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/PCGSplineIntersection.h  

virtual TArray< FPCGPinProperties > OutputPinProperties()

   Elements/PCGSplineIntersection.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page