1. Epic GamesDeveloper
  3. FSpline

FSpline

A general purpose, reflected spline. The implementation can be configured at runtime.

API > API/Runtime > API/Runtime/Engine

A general purpose, reflected spline. The implementation can be configured at runtime.

   
Name FSpline
Type struct
Header File /Engine/Source/Runtime/Engine/Classes/Curves/Spline.h
Include Path #include "Curves/Spline.h"

Syntax

USTRUCT ()  
struct FSpline

Constructors

Name Remarks Include Path Unreal Specifiers

FSpline ( const FSpline& Other
)

   Curves/Spline.h  

FSpline ()

 FSpline Implementation Curves/Spline.h  

Destructors

Name Remarks Include Path Unreal Specifiers

~FSpline()

   Curves/Spline.h  

Structs

Name Remarks
FUpdateSplineParams  

Constants

Name Type Remarks Include Path
PositionCurve const FInterpCurveVector   Curves/Spline.h
RotationCurve const FInterpCurveQuat   Curves/Spline.h
ScaleCurve const FInterpCurveVector   Curves/Spline.h

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
LegacyData TSharedPtr< FLegacySpline >   Curves/Spline.h  
NewData TSharedPtr< FNewSpline >   Curves/Spline.h  

Protected

Name Type Remarks Include Path Unreal Specifiers
CachedUpdateSplineParams FUpdateSplineParams   Curves/Spline.h  
CurrentImplementation uint8   Curves/Spline.h  
FSpline FSpline Probably better implemented as a TSharedPtr or something Curves/Spline.h  
OnSplineImplementationChangedHandle FDelegateHandle   Curves/Spline.h  
PreviousImplementation uint8   Curves/Spline.h  
Version uint32   Curves/Spline.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

int32 AddAttributeValue ( float Param,
const AttrType& Value,
FName AttributeName
) const

   Curves/Spline.h  

void AddPoint ( const FSplinePoint& InPoint
)

 Adds point by parameter. Curves/Spline.h  

bool CreateAttributeChannel ( FName AttributeName
) const

   Curves/Spline.h  

FVector Evaluate ( float Param
) const

   Curves/Spline.h  

AttrType EvaluateAttribute ( float Param,
FName AttributeName
) const

   Curves/Spline.h  

FVector EvaluateDerivative ( float Param
) const

   Curves/Spline.h  

FQuat EvaluateRotation ( float Param
) const

   Curves/Spline.h  

FVector EvaluateScale ( float Param
) const

   Curves/Spline.h  

bool ExportTextItem ( FString& ValueStr,
FSpline const& DefaultValue,
UObject* Parent,
int32 PortFlags,
UObject* ExportRootScope
) const

   Curves/Spline.h  

float FindNearest ( const FVector& InLocation,
float& OutSquaredDist
) const

   Curves/Spline.h  

float FindNearestOnSegment ( const FVector& InLocation,
int32 SegmentIndex,
float& OutSquaredDist
) const

   Curves/Spline.h  

float GetAttributeParameter ( int32 Index,
const FName& Name
) const

   Curves/Spline.h  

AttrType GetAttributeValue ( int32 Index,
const FName& Name
) const

   Curves/Spline.h  

float GetDistanceAtParameter ( float Parameter
) const

   Curves/Spline.h  

TArray< FName > GetFloatPropertyChannels()

   Curves/Spline.h  

FVector GetInTangent ( const int32 Index
) const

   Curves/Spline.h  

FVector GetLocation ( const int32 Index
) const

   Curves/Spline.h  

int32 GetNumControlPoints()

 Returns the total number of control points on this spline. Curves/Spline.h  

int32 GetNumSegments()

 Returns the total number of segments on this spline. Curves/Spline.h  

FQuat GetOrientation ( int32 Index
) const

   Curves/Spline.h  

FQuat GetOrientation ( float Param
) const

   Curves/Spline.h  

FVector GetOutTangent ( const int32 Index
) const

   Curves/Spline.h  

float GetParameterAtDistance ( float Distance
) const

   Curves/Spline.h  

float GetParameterAtIndex ( int32 Index
) const

   Curves/Spline.h  

FSplinePoint GetPoint ( const int32 Index
) const

   Curves/Spline.h  

FQuat GetRotation ( const int32 Index
) const

   Curves/Spline.h  

FVector GetScale ( const int32 Index
) const

   Curves/Spline.h  

float GetSegmentLength ( const int32 Index,
const float Param,
const FVector& Scale3D
) const

 Returns the length of the specified spline segment up to the parametric value given Curves/Spline.h  

TSharedPtr< UE::Geometry::Spline::TSplineInterface< FVector > > GetSplineInterface()

   Curves/Spline.h  

float GetSplineLength()

 Returns total length along this spline Curves/Spline.h  

const FInterpCurveVector & GetSplinePointsPosition()

   Curves/Spline.h  

const FInterpCurveQuat & GetSplinePointsRotation()

   Curves/Spline.h  

const FInterpCurveVector & GetSplinePointsScale()

   Curves/Spline.h  

EInterpCurveMode GetSplinePointType ( int32 Index
) const

   Curves/Spline.h  

TArray< FName > GetVectorPropertyChannels()

   Curves/Spline.h  

uint32 GetVersion()

   Curves/Spline.h  

bool HasAttributeChannel ( FName AttributeName
) const

   Curves/Spline.h  

bool ImportTextItem ( const TCHAR*& Buffer,
int32 PortFlags,
UObject* Parent,
FOutputDevice* ErrorText
)

   Curves/Spline.h  

void InsertPoint ( const FSplinePoint& InPoint,
int32 Index
)

 Adds point by index. Curves/Spline.h  

bool IsClosedLoop()

   Curves/Spline.h  

int32 NumAttributeValues ( FName AttributeName
) const

   Curves/Spline.h  

bool RemoveAttributeChannel ( FName AttributeName
) const

   Curves/Spline.h  

void RemoveAttributeValue ( int32 Index,
FName AttributeName
)

   Curves/Spline.h  

void RemovePoint ( const int32 Index
)

   Curves/Spline.h  

void Reset()

 Reset the spline to an empty spline. Curves/Spline.h  

void ResetRotation()

 Reset the rotation attribute channel to default values. Curves/Spline.h  

void ResetScale()

 Reset the scale attribute channel to default values. Curves/Spline.h  

bool Serialize ( FArchive& Ar
)

   Curves/Spline.h  

void SerializeLoad ( FArchive& Ar
)

   Curves/Spline.h  

void SerializeSave ( FArchive& Ar
) const

   Curves/Spline.h  

int32 SetAttributeParameter ( int32 Index,
float Parameter,
const FName& Name
)

   Curves/Spline.h  

void SetAttributeValue ( int32 Index,
const AttrType& Value,
const FName& Name
)

   Curves/Spline.h  

void SetClosedLoop ( bool bClosed
)

   Curves/Spline.h  

void SetInTangent ( const int32 Index,
const FVector& InTangent
)

   Curves/Spline.h  

void SetLocation ( int32 Index,
const FVector& InLocation
)

   Curves/Spline.h  

void SetOrientation ( int32 Index,
const FQuat& InOrientation
)

   Curves/Spline.h  

void SetOutTangent ( const int32 Index,
const FVector& OutTangent
)

   Curves/Spline.h  

void SetRotation ( int32 Index,
const FQuat& InRotation
)

   Curves/Spline.h  

void SetScale ( int32 Index,
const FVector& InScale
)

   Curves/Spline.h  

void SetSplinePointType ( int32 Index,
EInterpCurveMode Type
)

   Curves/Spline.h  

bool SupportsAttributes()

 Non-Templated functions. Curves/Spline.h  

void UpdateSpline ()

 Update the spline's internal data according to the most recently used update params (or default params if never updated). Curves/Spline.h  

void UpdateSpline ( const FUpdateSplineParams& InParams
)

 Update the spline's internal data according to the passed-in params. Curves/Spline.h  

Static

Name Remarks Include Path Unreal Specifiers

static bool IsEnabledStatic()

 True if a given FSpline will actually be implemented when instantiated. Curves/Spline.h  

Operators

Name Remarks Include Path Unreal Specifiers

bool operator!= ( const FSpline& Other
) const

   Curves/Spline.h  

FSpline & operator= ( const FSpline& Other
)

   Curves/Spline.h  

FSpline & operator= ( const FSplineCurves& Other
)

   Curves/Spline.h  

bool operator== ( const FSpline& Other
) const

   Curves/Spline.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page