1. Epic GamesDeveloper
  3. FPCGSplineStruct

FPCGSplineStruct

Subset of the Spline Component API in a standalone struct

API > API/Plugins > API/Plugins/PCG

Subset of the Spline Component API in a standalone struct

   
Name FPCGSplineStruct
Type struct
Header File /Engine/Plugins/PCG/Source/PCG/Public/Data/PCGSplineStruct.h
Include Path #include "Data/PCGSplineStruct.h"

Syntax

USTRUCT ()  
struct FPCGSplineStruct

Constructors

Name Remarks Include Path Unreal Specifiers
  Data/PCGSplineStruct.h  
  Data/PCGSplineStruct.h  
  Data/PCGSplineStruct.h  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
bClosedLoop bool   Data/PCGSplineStruct.h  
Bounds FBoxSphereBounds   Data/PCGSplineStruct.h  
DefaultUpVector FVector   Data/PCGSplineStruct.h  
LocalBounds FBoxSphereBounds   Data/PCGSplineStruct.h  
ReparamStepsPerSegment int32   Data/PCGSplineStruct.h  
Transform FTransform Replaces the component transform. Data/PCGSplineStruct.h  

Protected

Name Type Remarks Include Path Unreal Specifiers
CachedSortedAttributeChannelNames TArray< FName >   Data/PCGSplineStruct.h  
SpinLock UE::FSpinLock   Data/PCGSplineStruct.h  
Spline FSpline   Data/PCGSplineStruct.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void AddPoint ( const FSplinePoint& InSplinePoint,
bool bUpdateSpline,
const int64* InOptionalEntryKey
)

 Spline-related methods. Data/PCGSplineStruct.h  

void AddPoints ( const TArray< FSplinePoint >& InSplinePoints,
bool bUpdateSpline,
const TArray< int64 >* InOptionalEntryKeys
)

   Data/PCGSplineStruct.h  
To be called at any moment we want to access individual metadata, like with accessors. Data/PCGSplineStruct.h  

void ApplyTo ( USplineComponent* InSplineComponent
) const

   Data/PCGSplineStruct.h  

bool ConvertSplineSegmentToPolyLine ( int32 SplinePointStartIndex,
ESplineCoordinateSpace::Type CoordinateSpace,
const float MaxSquareDistanceFromSpline,
TArray< FVector >& OutPoints
) const

 Given a threshold, returns a list of vertices along the spline segment that, treated as a list of segments (polyline), matches the spline shape. Data/PCGSplineStruct.h  

bool ConvertSplineToPolyLine ( ESplineCoordinateSpace::Type CoordinateSpace,
const float MaxSquareDistanceFromSpline,
TArray< FVector >& OutPoints
) const

 Given a threshold, returns a list of vertices along the spline that, treated as a list of segments (polyline), matches the spline shape. Data/PCGSplineStruct.h  

float FindInputKeyClosestToWorldLocation ( const FVector& WorldLocation
) const

   Data/PCGSplineStruct.h  

float FindInputKeyOnSegmentClosestToWorldLocation ( const FVector& WorldLocation,
int32 Index
) const

   Data/PCGSplineStruct.h  

FVector GetArriveTangent ( const int32 Index
) const

   Data/PCGSplineStruct.h  

const TArray< FName > & GetAttributeChannelNames()

 Gets a lexicographically sorted list of channel names. Data/PCGSplineStruct.h  

float GetAttributeValue ( float InputKey,
FName ChannelName
) const

 Evaluate the specified attribute channel at the specified spline input key. Data/PCGSplineStruct.h  

FBox GetBounds()

   Data/PCGSplineStruct.h  

TConstArrayView< PCGMetadataEntryKey > GetConstControlPointsEntryKeys()

   Data/PCGSplineStruct.h  

FVector::FReal GetDistanceAlongSplineAtSplinePoint ( int32 PointIndex
) const

   Data/PCGSplineStruct.h  

float GetInputKeyAtDistanceAlongSpline ( FVector::FReal Distance
) const

   Data/PCGSplineStruct.h  

float GetInputKeyAtSegmentStart ( int InSegmentIndex
) const

 Return the input key at segment start for the given segment. Data/PCGSplineStruct.h  

FVector GetLeaveTangent ( const int32 Index
) const

   Data/PCGSplineStruct.h  

FVector GetLocation ( const int32 Index
) const

   Data/PCGSplineStruct.h  

FVector GetLocationAtDistanceAlongSpline ( FVector::FReal Distance,
ESplineCoordinateSpace::Type CoordinateSpace
) const

   Data/PCGSplineStruct.h  

FVector GetLocationAtSplineInputKey ( float InKey,
ESplineCoordinateSpace::Type CoordinateSpace
) const

   Data/PCGSplineStruct.h  

TArrayView< PCGMetadataEntryKey > GetMutableControlPointsEntryKeys()

   Data/PCGSplineStruct.h  

int GetNumberOfPoints()

   Data/PCGSplineStruct.h  

int GetNumberOfSplineSegments()

   Data/PCGSplineStruct.h  

FQuat GetQuaternionAtSplineInputKey ( float InKey,
ESplineCoordinateSpace::Type CoordinateSpace
) const

   Data/PCGSplineStruct.h  

FVector GetRightVectorAtSplineInputKey ( float InKey,
ESplineCoordinateSpace::Type CoordinateSpace
) const

   Data/PCGSplineStruct.h  

FQuat GetRotation ( const int32 Index
) const

   Data/PCGSplineStruct.h  

FVector GetScale ( const int32 Index
) const

   Data/PCGSplineStruct.h  

FVector GetScaleAtSplineInputKey ( float InKey
) const

   Data/PCGSplineStruct.h  

FBox GetSegmentBounds ( int32 Index
) const

   Data/PCGSplineStruct.h  

TTuple< int, float > GetSegmentStartIndexAndKeyAtInputKey ( float InKey
) const

 Return the index of the segment for a given InputKey, and the input key at the segment start. Data/PCGSplineStruct.h  

FVector::FReal GetSplineLength()

   Data/PCGSplineStruct.h  

const FInterpCurveVector & GetSplinePointsPosition()

   Data/PCGSplineStruct.h  

const FInterpCurveQuat & GetSplinePointsRotation()

   Data/PCGSplineStruct.h  

const FInterpCurveVector & GetSplinePointsScale()

   Data/PCGSplineStruct.h  

EInterpCurveMode GetSplinePointType ( int32 Index
) const

   Data/PCGSplineStruct.h  

FVector GetTangentAtSplineInputKey ( float InKey,
ESplineCoordinateSpace::Type CoordinateSpace
) const

   Data/PCGSplineStruct.h  

FTransform GetTransform()

   Data/PCGSplineStruct.h  

FTransform GetTransformAtDistanceAlongSpline ( FVector::FReal Distance,
ESplineCoordinateSpace::Type CoordinateSpace,
bool bUseScale
) const

   Data/PCGSplineStruct.h  

FTransform GetTransformAtSplineInputKey ( float InKey,
ESplineCoordinateSpace::Type CoordinateSpace,
bool bUseScale
) const

   Data/PCGSplineStruct.h  

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

   Data/PCGSplineStruct.h  

void Initialize ( const USplineComponent* InSplineComponent
)

   Data/PCGSplineStruct.h  

bool IsClosedLoop()

   Data/PCGSplineStruct.h  

void PostSerialize ( const FArchive& Ar
)

   Data/PCGSplineStruct.h  

void SetArriveTangent ( const int32 Index,
const FVector& InArriveTangent
)

   Data/PCGSplineStruct.h  

void SetLeaveTangent ( const int32 Index,
const FVector& LeaveTangent
)

   Data/PCGSplineStruct.h  

void SetLocation ( int32 Index,
const FVector& InLocation
)

   Data/PCGSplineStruct.h  

void SetRotation ( int32 Index,
const FQuat& InRotation
)

   Data/PCGSplineStruct.h  

void SetScale ( int32 Index,
const FVector& InScale
)

   Data/PCGSplineStruct.h  

void SetSplinePointType ( int32 Index,
EInterpCurveMode Type
)

   Data/PCGSplineStruct.h  

void UpdateSpline()

   Data/PCGSplineStruct.h  

Operators

Name Remarks Include Path Unreal Specifiers
  Data/PCGSplineStruct.h  
  Data/PCGSplineStruct.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page