1. Epic GamesDeveloper
  3. FPCGSplineSamplerParams

FPCGSplineSamplerParams

API > API/Plugins > API/Plugins/PCG

   
Name FPCGSplineSamplerParams
Type struct
Header File /Engine/Plugins/PCG/Source/PCG/Public/Elements/PCGSplineSampler.h
Include Path #include "Elements/PCGSplineSampler.h"

Syntax

USTRUCT (BlueprintType )  
struct FPCGSplineSamplerParams

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
AlphaAttribute FName Attribute that will contain a value in [0,1] representing how far along the point is to the end of the line. Elements/PCGSplineSampler.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category="Settings|Attributes"
  • Meta=(EditCondition="bComputeAlpha&&Dimension!=EPCGSplineSamplingDimension::OnInterior", EditConditionHides)
ArriveTangentAttribute FName Attribute that will contain the arrive tangent vector. Elements/PCGSplineSampler.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category="Settings|Attributes"
  • Meta=(EditCondition="bComputeTangents&&Dimension!=EPCGSplineSamplingDimension::OnInterior", EditConditionHides)
bComputeAlpha bool Compute an alpha value along the spline and write it to an attribute. Elements/PCGSplineSampler.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category="Settings|Attributes"
  • Meta=(EditCondition="Dimension!=EPCGSplineSamplingDimension::OnInterior", EditConditionHides)
bComputeCurvature bool Compute curvature along the spline and write it to an attribute. Elements/PCGSplineSampler.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category="Settings|Attributes"
  • Meta=(EditCondition="Dimension!=EPCGSplineSamplingDimension::OnInterior", EditConditionHides)
bComputeDirectionDelta bool Compute the delta angle to the next point on the spline and write it to an attribute. Elements/PCGSplineSampler.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category="Settings|Attributes"
  • Meta=(EditCondition="Dimension!=EPCGSplineSamplingDimension::OnInterior", EditConditionHides)
bComputeDistance bool Compute distance along the spline and write it to an attribute. Elements/PCGSplineSampler.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category="Settings|Attributes"
  • Meta=(EditCondition="Dimension!=EPCGSplineSamplingDimension::OnInterior", EditConditionHides)
bComputeInputKey bool Compute an input key for each point along the spline and write the key to an attribute. Elements/PCGSplineSampler.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category="Settings|Attributes"
  • Meta=(EditCondition="Dimension!=EPCGSplineSamplingDimension::OnInterior", EditConditionHides)
bComputeSegmentIndex bool Compute the spline segment index and write it to an attribute. Elements/PCGSplineSampler.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category="Settings|Attributes"
  • Meta=(EditCondition="Dimension!=EPCGSplineSamplingDimension::OnInterior", EditConditionHides)
bComputeSubsegmentIndex bool Compute the sub-segment index of a point on the spline and write it to an attribute. Elements/PCGSplineSampler.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category="Settings|Attributes"
  • Meta=(EditCondition="Mode==EPCGSplineSamplingMode::Subdivision&&Dimension!=EPCGSplineSamplingDimension::OnInterior", EditConditionHides)
bComputeTangents bool Compute arrive and leave tangents along the spline and write them to attributes. Elements/PCGSplineSampler.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category="Settings|Attributes"
  • Meta=(EditCondition="Dimension!=EPCGSplineSamplingDimension::OnInterior", EditConditionHides)
bFitToCurve bool If the length of the spline does not divide evenly into the DistanceIncrement, the final sample point will not land on the end of the spline. Elements/PCGSplineSampler.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category=Settings
  • Meta=(EditCondition="Mode==EPCGSplineSamplingMode::Distance&&Dimension!=EPCGSplineSamplingDimension::OnInterior", EditConditionHides)
bProjectOntoSurface bool Project sample points onto one possible surface given by the spline boundary. Elements/PCGSplineSampler.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category=Settings
  • Meta=(EditCondition="Dimension==EPCGSplineSamplingDimension::OnInterior", EditConditionHides)
bSeedFrom2DPosition bool Controls whether we will seed the sampled points using the 3D position or the 2D (XY) position. Elements/PCGSplineSampler.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category="Settings|Seeding"
  • Meta=(EditCondition="SeedingMode==EPCGSplineSamplingSeedingMode::SeedFromPosition", EditConditionHides)
bSeedFromLocalPosition bool Controls whether we will seed the sampled points using the final world position or the local position. Elements/PCGSplineSampler.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category="Settings|Seeding"
  • Meta=(EditCondition="SeedingMode==EPCGSplineSamplingSeedingMode::SeedFromPosition", EditConditionHides)
bTreatSplineAsPolyline bool Use the spline points to form a polyline, instead of computing many sample points along the spline. Elements/PCGSplineSampler.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category=Settings
  • Meta=(EditCondition="Dimension==EPCGSplineSamplingDimension::OnInterior", EditConditionHides)
bUnbounded bool If no Bounding Shape input is provided, the actor bounds are used to limit the sample generation domain. Elements/PCGSplineSampler.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category=Settings
  • Meta=(PCG_Overridable)
CurvatureAttribute FName Attribute that will contain the curvature. Elements/PCGSplineSampler.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category="Settings|Attributes"
  • Meta=(EditCondition="bComputeCurvature&&Dimension!=EPCGSplineSamplingDimension::OnInterior", EditConditionHides)
Dimension EPCGSplineSamplingDimension   Elements/PCGSplineSampler.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category=Settings
DistanceAttribute FName Attribute that will contain the distance along the spline at the sample point. Elements/PCGSplineSampler.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category="Settings|Attributes"
  • Meta=(EditCondition="bComputeDistance&&Dimension!=EPCGSplineSamplingDimension::OnInterior", EditConditionHides)
DistanceIncrement float   Elements/PCGSplineSampler.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category=Settings
  • Meta=(ClampMin="0.1", EditCondition="Mode==EPCGSplineSamplingMode::Distance&&Dimension!=EPCGSplineSamplingDimension::OnInterior", EditConditionHides)
EndOffset float Distance (in cm) from the end of the spline at which sampling will end. Elements/PCGSplineSampler.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category=Settings
  • Meta=(ClampMin="0", EditCondition="Mode!=EPCGSplineSamplingMode::Subdivision&&Dimension!=EPCGSplineSamplingDimension::OnInterior", EditConditionHides)
Fill EPCGSplineSamplingFill   Elements/PCGSplineSampler.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category=Settings
  • Meta=(EditCondition="Dimension!=EPCGSplineSamplingDimension::OnSpline&&Dimension!=EPCGSplineSamplingDimension::OnInterior", EditConditionHides)
InputKeyAttribute FName Attribute that will contain the spline input key, a float value between [0, N], where N is the number of control points. Elements/PCGSplineSampler.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category="Settings|Attributes"
  • Meta=(EditCondition="bComputeInputKey&&Dimension!=EPCGSplineSamplingDimension::OnInterior", EditConditionHides)
InteriorBorderSampleSpacing float The space between each sample point on the spline boundary. Elements/PCGSplineSampler.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category=Settings
  • Meta=(ClampMin="0.1", EditCondition="Dimension==EPCGSplineSamplingDimension::OnInterior&&!bTreatSplineAsPolyline", EditConditionHides)
InteriorDensityFalloffCurve FRuntimeFloatCurve TODO: DirtyCache for OnDependencyChanged when this float curve is an external asset. Elements/PCGSplineSampler.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category=Settings
  • Meta=(PCG_Overridable, PCG_OverridableChildProperties="ExternalCurve", EditCondition="Dimension==EPCGSplineSamplingDimension::OnInterior", EditConditionHides)
InteriorOrientation EPCGSplineSamplingInteriorOrientation Determines the orientation of interior points. Elements/PCGSplineSampler.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category=Settings
  • Meta=(EditCondition="Dimension==EPCGSplineSamplingDimension::OnInterior", EditConditionHides)
InteriorSampleSpacing float The space between each sample point Elements/PCGSplineSampler.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category=Settings
  • Meta=(ClampMin="0.1", EditCondition="Dimension==EPCGSplineSamplingDimension::OnInterior", EditConditionHides)
LeaveTangentAttribute FName Attribute that will contain the leave tangent vector. Elements/PCGSplineSampler.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category="Settings|Attributes"
  • Meta=(EditCondition="bComputeTangents&&Dimension!=EPCGSplineSamplingDimension::OnInterior", EditConditionHides)
MaxRandomOffsetNormalized float Normalized value for the maximum possible offset for each sample point. Elements/PCGSplineSampler.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category=Settings
  • Meta=(ClampMin="0", EditCondition="Mode!=EPCGSplineSamplingMode::Subdivision&&Dimension!=EPCGSplineSamplingDimension::OnInterior", EditConditionHides)
Mode EPCGSplineSamplingMode   Elements/PCGSplineSampler.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category=Settings
  • Meta=(EditCondition="Dimension!=EPCGSplineSamplingDimension::OnInterior", EditConditionHides)
NextDirectionDeltaAttribute FName Attribute that will contain the delta angle to the next point on the spline w.r.t to the current's point Up vector. Elements/PCGSplineSampler.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category="Settings|Attributes"
  • Meta=(EditCondition="bComputeDirectionDelta&&Dimension!=EPCGSplineSamplingDimension::OnInterior", EditConditionHides)
NumHeightSubdivisions int32   Elements/PCGSplineSampler.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category=Settings
  • Meta=(ClampMin="0", EditCondition="Dimension==EPCGSplineSamplingDimension::OnVertical||Dimension==EPCGSplineSamplingDimension::OnVolume", EditConditionHides)
NumPlanarSubdivisions int32   Elements/PCGSplineSampler.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category=Settings
  • Meta=(ClampMin="0", EditCondition="Dimension==EPCGSplineSamplingDimension::OnHorizontal||Dimension==EPCGSplineSamplingDimension::OnVolume", EditConditionHides)
NumSamples int32   Elements/PCGSplineSampler.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category=Settings
  • Meta=(ClampMin="0", EditCondition="Mode==EPCGSplineSamplingMode::NumberOfSamples&&Dimension!=EPCGSplineSamplingDimension::OnInterior", EditConditionHides)
PointSteepness float Each PCG point represents a discretized, volumetric region of world space. Elements/PCGSplineSampler.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category="Settings|Points"
  • Meta=(ClampMin="0", ClampMax="1", PCG_Overridable)
SeedingMode EPCGSplineSamplingSeedingMode Controls the mode for computing a sample point's seed. Elements/PCGSplineSampler.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category="Settings|Seeding"
SegmentIndexAttribute FName Attribute that will contain the spline segment index. Elements/PCGSplineSampler.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category="Settings|Attributes"
  • Meta=(EditCondition="bComputeSegmentIndex&&Dimension!=EPCGSplineSamplingDimension::OnInterior", EditConditionHides)
StartOffset float Distance (in cm) along the spline at which sampling will begin. Elements/PCGSplineSampler.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category=Settings
  • Meta=(ClampMin="0", EditCondition="Mode!=EPCGSplineSamplingMode::Subdivision&&Dimension!=EPCGSplineSamplingDimension::OnInterior", EditConditionHides)
SubdivisionsPerSegment int32   Elements/PCGSplineSampler.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category=Settings
  • Meta=(ClampMin="0", EditCondition="Mode==EPCGSplineSamplingMode::Subdivision&&Dimension!=EPCGSplineSamplingDimension::OnInterior", EditConditionHides)
SubsegmentIndexAttribute FName Attribute that will contain the sub-segment index of a point on the spline. Elements/PCGSplineSampler.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category="Settings|Attributes"
  • Meta=(EditCondition="bComputeSubsegmentIndex&&Mode==EPCGSplineSamplingMode::Subdivision&&Dimension!=EPCGSplineSamplingDimension::OnInterior", EditConditionHides)

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page