1. Epic GamesDeveloper
  3. UPCGSplineData

UPCGSplineData

API > API/Plugins > API/Plugins/PCG

   
Name UPCGSplineData
Type class
Header File /Engine/Plugins/PCG/Source/PCG/Public/Data/PCGSplineData.h
Include Path #include "Data/PCGSplineData.h"

Syntax

UCLASS (MinimalAPI, BlueprintType, ClassGroup=(Procedural))  
class UPCGSplineData : public UPCGPolyLineData

Inheritance Hierarchy

Derived Classes

Constructors

Name Remarks Include Path Unreal Specifiers

UPCGSplineData()

   Data/PCGSplineData.h  

Typedefs

Name Type Remarks Include Path
TypeInfo FPCGDataTypeInfoSpline   Data/PCGSplineData.h

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
SplineStruct FPCGSplineStruct Minimal data needed to replicate the behavior from USplineComponent. Data/PCGSplineData.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void ApplyTo ( USplineComponent* InSpline
) const

   Data/PCGSplineData.h  

TUniquePtr< IPCGAttributeAccessorKeys > CreateAccessorKeys ( const FPCGAttributePropertySelector& InSelector,
bool bQuiet
)

 Helper to create an accessor keys for data that doesn't yet exist. Data/PCGSplineData.h  

TUniquePtr< const IPCGAttributeAccessorKeys > CreateConstAccessorKeys ( const FPCGAttributePropertySelector& InSelector,
bool bQuiet
) const

   Data/PCGSplineData.h  

virtual FVector::FReal GetCurvatureAtDistance ( int SegmentIndex,
FVector::FReal Distance
) const

   Data/PCGSplineData.h  

virtual float GetInputKeyAtDistance ( int SegmentIndex,
FVector::FReal Distance
) const

   Data/PCGSplineData.h  

virtual FVector GetLocationAtDistance ( int SegmentIndex,
FVector::FReal Distance,
bool bWorldSpace
) const

   Data/PCGSplineData.h  

TArray< int64 > GetMetadataEntryKeysForSplinePoints()

   Data/PCGSplineData.h
  • BlueprintCallable
  • Category="SplineData"

TArray< FSplinePoint > GetSplinePoints()

   Data/PCGSplineData.h
  • BlueprintCallable
  • Category="SplineData"

virtual FTransform GetTransformAtDistance ( int SegmentIndex,
FVector::FReal Distance,
bool bWorldSpace,
FBox* OutBounds
) const

   Data/PCGSplineData.h  

void Initialize ( const USplineComponent* InSpline
)

 Initialize a spline data from a Spline Component. Data/PCGSplineData.h
  • BlueprintCallable
  • Category="SplineData"
  • Meta=(DisplayName="Initialize From Spline Component")

void Initialize ( const TArray< FSplinePoint >& InSplinePoints,
bool bInClosedLoop,
const FTransform& InTransform,
TArray< PCGMetadataEntryKey > InOptionalEntryKeys
)

 Initialize a spline data Data/PCGSplineData.h  

void Initialize ( const FPCGSplineStruct& InSplineStruct
)

   Data/PCGSplineData.h  

void K2_Initialize ( const TArray< FSplinePoint >& InSplinePoints,
bool bInClosedLoop,
const FTransform& InTransform,
TArray< int64 > InOptionalEntryKeys
)

 Initialize a spline data Data/PCGSplineData.h
  • BlueprintCallable
  • Category="SplineData"
  • Meta=(DisplayName="Initialize From Spline Points", AutoCreateRefTerm="InOptionalEntryKeys")

void WriteMetadataToEntry ( float InputKey,
PCGMetadataEntryKey& OutEntryKey,
UPCGMetadata* OutMetadata
) const

   Data/PCGSplineData.h  

Overridden from UPCGPolyLineData

Name Remarks Include Path Unreal Specifiers

virtual void AllocateMetadataEntries()

   Data/PCGSplineData.h  

virtual TConstArrayView< PCGMetadataEntryKey > GetConstVerticesEntryKeys()

   Data/PCGSplineData.h  

virtual FVector::FReal GetDistanceAtSegmentStart ( int SegmentIndex
) const

 Get the cumulative distance along the line to the start of a segment. Data/PCGSplineData.h  

virtual FVector GetLocationAtAlpha ( float Alpha
) const

 Get the location of the point at the normalized [0, 1] parameter across the entire the poly line. Data/PCGSplineData.h  

virtual TArrayView< PCGMetadataEntryKey > GetMutableVerticesEntryKeys()

   Data/PCGSplineData.h  

virtual int GetNumSegments ()

 Get the number of segments in this line. Data/PCGSplineData.h  

virtual FVector::FReal GetSegmentLength ( int SegmentIndex
) const

 Get the length of a specific segment of the line. Data/PCGSplineData.h  

virtual void GetTangentsAtSegmentStart ( int SegmentIndex,
FVector& OutArriveTangent,
FVector& OutLeaveTangent
) const

 Get the arrive and leave tangents for a control point via its segment index. Data/PCGSplineData.h  

virtual FTransform GetTransform()

 Get the world-space transform of the entire line. Data/PCGSplineData.h  

virtual FTransform GetTransformAtAlpha ( float Alpha
) const

 Get the full transform at the normalized [0, 1] parameter across the entire the poly line. Data/PCGSplineData.h  

virtual bool IsClosed()

 True if the line is a closed loop. Data/PCGSplineData.h  

virtual void WriteMetadataToPoint ( float InputKey,
FPCGPoint& OutPoint,
UPCGMetadata* OutMetadata
) const

 This function should be called in the Sample/Project point function, but can also be called if the sampling is done manually. Data/PCGSplineData.h  

Overridden from UPCGSpatialDataWithPointCache

Name Remarks Include Path Unreal Specifiers

virtual const UPCGPointArrayData * CreatePointArrayData ( FPCGContext* Context,
const FBox& InBounds
) const

   Data/PCGSplineData.h  

virtual const UPCGPointData * CreatePointData ( FPCGContext* Context
) const

   Data/PCGSplineData.h  

Overridden from UPCGSpatialData

Name Remarks Include Path Unreal Specifiers

virtual FBox GetBounds()

 Returns the full bounds (including density fall-off) of the data Data/PCGSplineData.h  

virtual void InitializeTargetMetadata ( const FPCGInitializeFromDataParams& InParams,
UPCGMetadata* MetadataToInitialize
) const

 Initialize another metadata from this data. Data/PCGSplineData.h  

virtual UPCGSpatialData * ProjectOn ( FPCGContext* InContext,
const UPCGSpatialData* InOther,
const FPCGProjectionParams& InParams
) const

   Data/PCGSplineData.h  

virtual bool SamplePoint ( const FTransform& Transform,
const FBox& Bounds,
FPCGPoint& OutPoint,
UPCGMetadata* OutMetadata
) const

 Sample rotation, scale and other attributes from this data at the query position. Data/PCGSplineData.h  

Overridden from UPCGData

Name Remarks Include Path Unreal Specifiers

virtual void AddToCrc ( FArchiveCrc32& Ar,
bool bFullDataCrc
) const

 Adds this data to Crc. Data/PCGSplineData.h  

virtual TArray< FPCGMetadataDomainID > GetAllSupportedMetadataDomainIDs()

 To be enabled when we are sure Default translate well from Data to Elements (or we have a path for deprecation) virtual FPCGMetadataDomainIDGetDefaultMetadataDomainID() const override { return PCGMetadataDomainID::Elements; } Data/PCGSplineData.h  

virtual PRAGMA_DISABLE_DEPRECATION_WARNINGSEPCGDataType GetDataType()

 @todo_pcg To be deprecated when we switch to the new type Data/PCGSplineData.h  

virtual const FPCGDataTypeBaseId & GetDataTypeId()

   Data/PCGSplineData.h  
Return the associated domain ID for a given domain name in the selector. Data/PCGSplineData.h  

virtual bool SetDomainFromDomainID ( const FPCGMetadataDomainID& InDomainID,
FPCGAttributePropertySelector& InOutSelector
) const

 Write the domain name into the selector associated with this domain ID. Data/PCGSplineData.h  

Protected

Name Remarks Include Path Unreal Specifiers

virtual void CopySplineData ( UPCGSplineData* InCopy
) const

   Data/PCGSplineData.h  

const UPCGBasePointData * CreateBasePointData ( FPCGContext* Context,
TSubclassOf< UPCGBasePointData > PointDataClass
) const

   Data/PCGSplineData.h  

Overridden from UPCGSpatialData

Name Remarks Include Path Unreal Specifiers

virtual UPCGSpatialData * CopyInternal ( FPCGContext* Context
) const

   Data/PCGSplineData.h  

Static

Name Remarks Include Path Unreal Specifiers

static TUniquePtr< IPCGAttributeAccessor > CreateStaticAccessor ( const FPCGAttributePropertySelector& InSelector,
bool bQuiet
)

 Static helper to create an accessor on a data that doesn't yet exist, as accessors for spline data don't rely on existing data. Data/PCGSplineData.h  

static FPCGAttributeAccessorMethods GetSplineAccessorMethods()

 Get the functions to the accessor factory. Data/PCGSplineData.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page