UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
Public Member Functions | Friends | List of all members
FLegacySpline Class Reference

Public Member Functions

ENGINE_API FLegacySpline ()=default
 
ENGINE_API FLegacySpline (const FNewSpline &Other)
 
ENGINE_API FLegacySpline (const FSplineCurves &Other)
 
void AddPoint (const FSplinePoint &InPoint)
 
void InsertPoint (const FSplinePoint &InPoint, int32 Index)
 
FSplinePoint GetPoint (const int32 Index) const
 
void RemovePoint (int32 Index)
 
void SetLocation (int32 Index, const FVector &InLocation)
 
FVector GetLocation (const int32 Index) const
 
void SetInTangent (const int32 Index, const FVector &InTangent)
 
FVector GetInTangent (const int32 Index) const
 
void SetOutTangent (const int32 Index, const FVector &OutTangent)
 
FVector GetOutTangent (const int32 Index) const
 
void SetRotation (int32 Index, const FQuat &InRotation)
 
FQuat GetRotation (const int32 Index) const
 
void SetScale (int32 Index, const FVector &InScale)
 
FVector GetScale (const int32 Index) const
 
void SetSplinePointType (int32 Index, EInterpCurveMode Type)
 
EInterpCurveMode GetSplinePointType (int32 Index) const
 
float GetParameterAtIndex (int32 Index) const
 
float GetParameterAtDistance (float Distance) const
 
float GetDistanceAtParameter (float Parameter) const
 
FVector Evaluate (float Param) const
 
FVector EvaluateDerivative (float Param) const
 
FQuat EvaluateRotation (float Param) const
 
FVector EvaluateScale (float Param) const
 
float FindNearest (const FVector &InLocation, float &OutSquaredDist) const
 
float FindNearestOnSegment (const FVector &InLocation, int32 SegmentIndex, float &OutSquaredDist) const
 
bool operator== (const FLegacySpline &Other) const
 
bool operator!= (const FLegacySpline &Other) const
 
bool Serialize (FArchive &Ar)
 
FInterpCurveVector & GetSplinePointsPosition ()
 
const FInterpCurveVector & GetSplinePointsPosition () const
 
FInterpCurveQuat & GetSplinePointsRotation ()
 
const FInterpCurveQuat & GetSplinePointsRotation () const
 
FInterpCurveVector & GetSplinePointsScale ()
 
const FInterpCurveVector & GetSplinePointsScale () const
 
float GetSegmentLength (const int32 Index, const float Param, const FVector &Scale3D=FVector(1.0f)) const
 
float GetSplineLength () const
 
int32 GetNumControlPoints () const
 
void Reset ()
 
void ResetRotation ()
 
void ResetScale ()
 
void UpdateSpline (const FSpline::FUpdateSplineParams &InParams)
 

Friends

ENGINE_API FArchive & operator<< (FArchive &Ar, FLegacySpline &Spline)
 

Detailed Description

FLegacySpline Definition

Constructor & Destructor Documentation

◆ FLegacySpline() [1/3]

ENGINE_API FLegacySpline::FLegacySpline ( )
default

◆ FLegacySpline() [2/3]

FLegacySpline::FLegacySpline ( const FNewSpline &  Other)

FLegacySpline Implementation

◆ FLegacySpline() [3/3]

FLegacySpline::FLegacySpline ( const FSplineCurves &  Other)

Member Function Documentation

◆ AddPoint()

void FLegacySpline::AddPoint ( const FSplinePoint &  InPoint)

◆ Evaluate()

FVector FLegacySpline::Evaluate ( float  Param) const

◆ EvaluateDerivative()

FVector FLegacySpline::EvaluateDerivative ( float  Param) const

◆ EvaluateRotation()

FQuat FLegacySpline::EvaluateRotation ( float  Param) const

◆ EvaluateScale()

FVector FLegacySpline::EvaluateScale ( float  Param) const

◆ FindNearest()

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

◆ FindNearestOnSegment()

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

◆ GetDistanceAtParameter()

float FLegacySpline::GetDistanceAtParameter ( float  Parameter) const

◆ GetInTangent()

FVector FLegacySpline::GetInTangent ( const int32  Index) const

◆ GetLocation()

FVector FLegacySpline::GetLocation ( const int32  Index) const

◆ GetNumControlPoints()

int32 FLegacySpline::GetNumControlPoints ( ) const

Returns the total number of control points on this spline.

◆ GetOutTangent()

FVector FLegacySpline::GetOutTangent ( const int32  Index) const

◆ GetParameterAtDistance()

float FLegacySpline::GetParameterAtDistance ( float  Distance) const

◆ GetParameterAtIndex()

float FLegacySpline::GetParameterAtIndex ( int32  Index) const

◆ GetPoint()

FSplinePoint FLegacySpline::GetPoint ( const int32  Index) const

◆ GetRotation()

FQuat FLegacySpline::GetRotation ( const int32  Index) const

◆ GetScale()

FVector FLegacySpline::GetScale ( const int32  Index) const

◆ GetSegmentLength()

float FLegacySpline::GetSegmentLength ( const int32  Index,
const float  Param,
const FVector &  Scale3D = FVector(1.0f) 
) const

Returns the length of the specified spline segment up to the parametric value given

◆ GetSplineLength()

float FLegacySpline::GetSplineLength ( ) const

Returns total length along this spline

◆ GetSplinePointsPosition() [1/2]

FInterpCurveVector & FLegacySpline::GetSplinePointsPosition ( )
inline

◆ GetSplinePointsPosition() [2/2]

const FInterpCurveVector & FLegacySpline::GetSplinePointsPosition ( ) const
inline

◆ GetSplinePointsRotation() [1/2]

FInterpCurveQuat & FLegacySpline::GetSplinePointsRotation ( )
inline

◆ GetSplinePointsRotation() [2/2]

const FInterpCurveQuat & FLegacySpline::GetSplinePointsRotation ( ) const
inline

◆ GetSplinePointsScale() [1/2]

FInterpCurveVector & FLegacySpline::GetSplinePointsScale ( )
inline

◆ GetSplinePointsScale() [2/2]

const FInterpCurveVector & FLegacySpline::GetSplinePointsScale ( ) const
inline

◆ GetSplinePointType()

EInterpCurveMode FLegacySpline::GetSplinePointType ( int32  Index) const

◆ InsertPoint()

void FLegacySpline::InsertPoint ( const FSplinePoint &  InPoint,
int32  Index 
)

◆ operator!=()

bool FLegacySpline::operator!= ( const FLegacySpline &  Other) const
inline

◆ operator==()

bool FLegacySpline::operator== ( const FLegacySpline &  Other) const
inline

◆ RemovePoint()

void FLegacySpline::RemovePoint ( int32  Index)

◆ Reset()

void FLegacySpline::Reset ( )

Reset the spline to an empty spline.

◆ ResetRotation()

void FLegacySpline::ResetRotation ( )

Reset the rotation attribute channel to default values.

◆ ResetScale()

void FLegacySpline::ResetScale ( )

Reset the scale attribute channel to default values.

◆ Serialize()

bool FLegacySpline::Serialize ( FArchive &  Ar)

◆ SetInTangent()

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

◆ SetLocation()

void FLegacySpline::SetLocation ( int32  Index,
const FVector &  InLocation 
)

◆ SetOutTangent()

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

◆ SetRotation()

void FLegacySpline::SetRotation ( int32  Index,
const FQuat &  InRotation 
)

◆ SetScale()

void FLegacySpline::SetScale ( int32  Index,
const FVector &  InScale 
)

◆ SetSplinePointType()

void FLegacySpline::SetSplinePointType ( int32  Index,
EInterpCurveMode  Type 
)

◆ UpdateSpline()

void FLegacySpline::UpdateSpline ( const FSpline::FUpdateSplineParams &  InParams)

Update the spline's internal data according to the passed-in params.

Friends And Related Symbol Documentation

◆ operator<<

ENGINE_API FArchive & operator<< ( FArchive &  Ar,
FLegacySpline &  Spline 
)
friend
The documentation for this class was generated from the following file: