Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Runtime > Engine > Components > USplineComponent

Light Theme

Dark Theme

USplineComponent

A spline component is a spline shape which can be used for other purposes (e.g. animating objects).

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UActorComponent

USceneComponent

UPrimitiveComponent

USplineComponent

PAPER2UPaperTerrainSplineComponent

References

Module	Engine
Header	/Engine/Source/Runtime/Engine/Classes/Components/SplineComponent.h
Include	#include "Components/SplineComponent.h"

Syntax

class USplineComponent : public UPrimitiveComponent

Remarks

A spline component is a spline shape which can be used for other purposes (e.g. animating objects). It contains debug rendering capabilities.

Variables

	Name	Description
bool	bAllowDiscontinuousSpline	Whether the spline's leave and arrive tangents can be different
bool	bDrawDebug	If true, the spline will be rendered if the Splines showflag is set.
bool	bInputSplinePointsToConstructionScript	Whether the spline points should be passed to the User Construction Script so they can be further manipulated by it.
bool	bModifiedByConstructionScript	Whether the UCS has made changes to the spline points
bool	bShouldVisualizeScale	Whether scale visualization should be displayed
bool	bSplineHasBeenEdited	Whether the spline has been edited from its default by the spline component visualizer
bool	bStationaryEndpoints	Whether the endpoints of the spline are considered stationary when traversing the spline at non-constant velocity.
FVector	DefaultUpVector	Default up vector in local space to be used when calculating transforms along the spline
float	Duration	Specifies the duration of the spline in seconds
FLinearColor	EditorSelectedSplineSegmentColor	Color of a selected spline component segment in the editor
FLinearColor	EditorUnselectedSplineSegmentColor	Color of an unselected spline component segment in the editor
int32	ReparamStepsPerSegment	Number of steps per spline segment to place in the reparameterization table
float	ScaleVisualizationWidth	Width of spline in editor for use with scale visualization
FSplineCurves	SplineCurves

Constructors

	Name	Description
	USplineComponent ( const FObjectInitializer& ObjectIn... )

Functions

	Name	Description
void	AddPoint ( const FSplinePoint& Point, bool bUpdateSpline )	Adds an FSplinePoint to the spline.
void	AddPoints ( const TArray< FSplinePoint >& Poin..., bool bUpdateSpline )	Adds an array of FSplinePoints to the spline.
void	AddSplineLocalPoint ( const FVector& Position )	Adds a local space point to the spline
void	AddSplinePoint ( const FVector& Position, ESplineCoordinateSpace::Type Coordi..., bool bUpdateSpline )	Adds a point to the spline
void	AddSplinePointAtIndex ( const FVector& Position, int32 Index, ESplineCoordinateSpace::Type Coordi..., bool bUpdateSpline )	Adds a point to the spline at the specified index
void	AddSplineWorldPoint ( const FVector& Position )	Deprecated method definitions.
void	ApplyComponentInstanceData ( FSplineInstanceData* Component..., const bool bPostUCS )
void	ClearSplinePoints ( bool bUpdateSpline )	Clears all the points in the spline
void	Draw ( FPrimitiveDrawInterface* PDI, const FSceneView* View, const FInterpCurveVector& SplineIn..., const FMatrix& LocalToWorld, const FLinearColor& LineColor, uint8 DepthPriorityGroup )	Helper function to draw a vector curve
FVector	FindDirectionClosestToWorldLocation ( const FVector& WorldLocation, ESplineCoordinateSpace::Type Coordi... )	Given a location, in world spcae, return a unit direction vector of the spline tangent closest to the location.
float	FindInputKeyClosestToWorldLocation ( const FVector& WorldLocation )	Given a location, in world space, return the input key closest to that location.
FVector	FindLocationClosestToWorldLocation ( const FVector& WorldLocation, ESplineCoordinateSpace::Type Coordi... )	Given a location, in world space, return the point on the curve that is closest to the location.
FQuat	FindQuaternionClosestToWorldLocation ( const FVector& WorldLocation, ESplineCoordinateSpace::Type Coordi... )	Given a location, in world space, return a quaternion corresponding to the spline's rotation closest to the location.
FVector	FindRightVectorClosestToWorldLocation ( const FVector& WorldLocation, ESplineCoordinateSpace::Type Coordi... )	Given a location, in world space, return a unit direction vector corresponding to the spline's right vector closest to the location.
float	FindRollClosestToWorldLocation ( const FVector& WorldLocation, ESplineCoordinateSpace::Type Coordi... )	Given a location, in world space, return the spline's roll closest to the location, in degrees.
FRotator	FindRotationClosestToWorldLocation ( const FVector& WorldLocation, ESplineCoordinateSpace::Type Coordi... )	Given a location, in world space, return rotation corresponding to the spline's rotation closest to the location.
FVector	FindScaleClosestToWorldLocation ( const FVector& WorldLocation )	Given a location, in world space, return the spline's scale closest to the location.
FVector	FindTangentClosestToWorldLocation ( const FVector& WorldLocation, ESplineCoordinateSpace::Type Coordi... )	Given a location, in world space, return the tangent vector of the spline closest to the location.
FTransform	FindTransformClosestToWorldLocation ( const FVector& WorldLocation, ESplineCoordinateSpace::Type Coordi..., bool bUseScale )	Given a location, in world space, return an FTransform closest to that location.
FVector	FindUpVectorClosestToWorldLocation ( const FVector& WorldLocation, ESplineCoordinateSpace::Type Coordi... )	Given a location, in world space, return a unit direction vector corresponding to the spline's up vector closest to the location.
FVector	GetArriveTangentAtSplinePoint ( int32 PointIndex, ESplineCoordinateSpace::Type Coordi... )	Get the arrive tangent at spline point
FVector	GetDefaultUpVector ( ESplineCoordinateSpace::Type Coordi... )	Gets the default up vector used by this spline
FVector	GetDirectionAtDistanceAlongSpline ( float Distance, ESplineCoordinateSpace::Type Coordi... )	Given a distance along the length of this spline, return a unit direction vector of the spline tangent there.
FVector	GetDirectionAtSplineInputKey ( float InKey, ESplineCoordinateSpace::Type Coordi... )	Get unit direction along spline at the provided input key value
FVector	GetDirectionAtSplinePoint ( int32 PointIndex, ESplineCoordinateSpace::Type Coordi... )	Get the location at spline point
FVector	GetDirectionAtTime ( float Time, ESplineCoordinateSpace::Type Coordi..., bool bUseConstantVelocity )	Given a time from 0 to the spline duration, return a unit direction vector of the spline tangent there.
float	GetDistanceAlongSplineAtSplinePoint ( int32 PointIndex )	Get the distance along the spline at the spline point
float	GetFloatPropertyAtSplineInputKey ( float InKey, FName PropertyName )	Get a metadata property float value along the spline at spline input key
float	GetFloatPropertyAtSplinePoint ( int32 Index, FName PropertyName )	Get a metadata property float value along the spline at spline point
float	GetInputKeyAtDistanceAlongSpline ( float Distance )	Given a distance along the length of this spline, return the corresponding input key at that point
FVector	GetLeaveTangentAtSplinePoint ( int32 PointIndex, ESplineCoordinateSpace::Type Coordi... )	Get the leave tangent at spline point
void	GetLocalLocationAndTangentAtSplinePoint ( int32 PointIndex, FVector& LocalLocation, FVector& LocalTangent )	Get local location and tangent at a spline point
void	GetLocationAndTangentAtSplinePoint ( int32 PointIndex, FVector& Location, FVector& Tangent, ESplineCoordinateSpace::Type Coordi... )	Get location and tangent at a spline point
FVector	GetLocationAtDistanceAlongSpline ( float Distance, ESplineCoordinateSpace::Type Coordi... )	Given a distance along the length of this spline, return the point in space where this puts you
FVector	GetLocationAtSplineInputKey ( float InKey, ESplineCoordinateSpace::Type Coordi... )	Get location along spline at the provided input key value
FVector	GetLocationAtSplinePoint ( int32 PointIndex, ESplineCoordinateSpace::Type Coordi... )	Get the location at spline point
FVector	GetLocationAtTime ( float Time, ESplineCoordinateSpace::Type Coordi..., bool bUseConstantVelocity )	Given a time from 0 to the spline duration, return the point in space where this puts you
int32	GetNumberOfSplinePoints()	Get the number of points that make up this spline
int32	GetNumberOfSplineSegments()	Get the number of segments that make up this spline
FQuat	GetQuaternionAtDistanceAlongSpline ( float Distance, ESplineCoordinateSpace::Type Coordi... )	Given a distance along the length of this spline, return a quaternion corresponding to the spline's rotation there.
FQuat	GetQuaternionAtSplineInputKey ( float InKey, ESplineCoordinateSpace::Type Coordi... )	Get quaternion corresponding to rotation along spline at the provided input key value
FQuat	GetQuaternionAtSplinePoint ( int32 PointIndex, ESplineCoordinateSpace::Type Coordi... )	Get the rotation at spline point as a quaternion
FQuat	GetQuaternionAtTime ( float Time, ESplineCoordinateSpace::Type Coordi..., bool bUseConstantVelocity )	Given a time from 0 to the spline duration, return a quaternion corresponding to the spline's rotation there.
FVector	GetRightVectorAtDistanceAlongSpline ( float Distance, ESplineCoordinateSpace::Type Coordi... )	Given a distance along the length of this spline, return a unit direction vector corresponding to the spline's right vector there.
FVector	GetRightVectorAtSplineInputKey ( float InKey, ESplineCoordinateSpace::Type Coordi... )	Get up vector at the provided input key value
FVector	GetRightVectorAtSplinePoint ( int32 PointIndex, ESplineCoordinateSpace::Type Coordi... )	Get the right vector at spline point
FVector	GetRightVectorAtTime ( float Time, ESplineCoordinateSpace::Type Coordi..., bool bUseConstantVelocity )	Given a time from 0 to the spline duration, return the spline's right vector there.
float	GetRollAtDistanceAlongSpline ( float Distance, ESplineCoordinateSpace::Type Coordi... )	Given a distance along the length of this spline, return the spline's roll there, in degrees.
float	GetRollAtSplineInputKey ( float InKey, ESplineCoordinateSpace::Type Coordi... )	Get roll in degrees at the provided input key value
float	GetRollAtSplinePoint ( int32 PointIndex, ESplineCoordinateSpace::Type Coordi... )	Get the amount of roll at spline point, in degrees
float	GetRollAtTime ( float Time, ESplineCoordinateSpace::Type Coordi..., bool bUseConstantVelocity )	Given a time from 0 to the spline duration, return the spline's roll there, in degrees.
FRotator	GetRotationAtDistanceAlongSpline ( float Distance, ESplineCoordinateSpace::Type Coordi... )	Given a distance along the length of this spline, return a rotation corresponding to the spline's rotation there.
FRotator	GetRotationAtSplineInputKey ( float InKey, ESplineCoordinateSpace::Type Coordi... )	Get rotator corresponding to rotation along spline at the provided input key value
FRotator	GetRotationAtSplinePoint ( int32 PointIndex, ESplineCoordinateSpace::Type Coordi... )	Get the rotation at spline point as a rotator
FRotator	GetRotationAtTime ( float Time, ESplineCoordinateSpace::Type Coordi..., bool bUseConstantVelocity )	Given a time from 0 to the spline duration, return a rotation corresponding to the spline's position and direction there.
FVector	GetScaleAtDistanceAlongSpline ( float Distance )	Given a distance along the length of this spline, return the spline's scale there.
FVector	GetScaleAtSplineInputKey ( float InKey )	Get scale at the provided input key value
FVector	GetScaleAtSplinePoint ( int32 PointIndex )	Get the scale at spline point
FVector	GetScaleAtTime ( float Time, bool bUseConstantVelocity )	Given a time from 0 to the spline duration, return the spline's scale there.
float	GetSplineLength()	Returns total length along this spline
const USplin...	GetSplinePointsMetadata()
USplineMetad...	GetSplinePointsMetadata()
const FInter...	GetSplinePointsPosition()
FInterpCurve...	GetSplinePointsPosition()
const FInter...	GetSplinePointsRotation()
FInterpCurve...	GetSplinePointsRotation()
FInterpCurve...	GetSplinePointsScale()
const FInter...	GetSplinePointsScale()
ESplinePoint...	GetSplinePointType ( int32 PointIndex )	Get the type of a spline point
FVector	GetTangentAtDistanceAlongSpline ( float Distance, ESplineCoordinateSpace::Type Coordi... )	Given a distance along the length of this spline, return the tangent vector of the spline there.
FVector	GetTangentAtSplineInputKey ( float InKey, ESplineCoordinateSpace::Type Coordi... )	Get tangent along spline at the provided input key value
FVector	GetTangentAtSplinePoint ( int32 PointIndex, ESplineCoordinateSpace::Type Coordi... )	Get the tangent at spline point. This fetches the Leave tangent of the point.
FVector	GetTangentAtTime ( float Time, ESplineCoordinateSpace::Type Coordi..., bool bUseConstantVelocity )	Given a time from 0 to the spline duration, return the spline's tangent there.
FTransform	GetTransformAtDistanceAlongSpline ( float Distance, ESplineCoordinateSpace::Type Coordi..., bool bUseScale )	Given a distance along the length of this spline, return an FTransform corresponding to that point on the spline.
FTransform	GetTransformAtSplineInputKey ( float InKey, ESplineCoordinateSpace::Type Coordi..., bool bUseScale )	Get transform at the provided input key value
FTransform	GetTransformAtSplinePoint ( int32 PointIndex, ESplineCoordinateSpace::Type Coordi..., bool bUseScale )	Get the transform at spline point
FTransform	GetTransformAtTime ( float Time, ESplineCoordinateSpace::Type Coordi..., bool bUseConstantVelocity, bool bUseScale )	Given a time from 0 to the spline duration, return the spline's transform at the corresponding position.
FVector	GetUpVectorAtDistanceAlongSpline ( float Distance, ESplineCoordinateSpace::Type Coordi... )	Given a distance along the length of this spline, return a unit direction vector corresponding to the spline's up vector there.
FVector	GetUpVectorAtSplineInputKey ( float InKey, ESplineCoordinateSpace::Type Coordi... )	Get up vector at the provided input key value
FVector	GetUpVectorAtSplinePoint ( int32 PointIndex, ESplineCoordinateSpace::Type Coordi... )	Get the up vector at spline point
FVector	GetUpVectorAtTime ( float Time, ESplineCoordinateSpace::Type Coordi..., bool bUseConstantVelocity )	Given a time from 0 to the spline duration, return the spline's up vector there.
FVector	GetVectorPropertyAtSplineInputKey ( float InKey, FName PropertyName )	Get a metadata property vector value along the spline at spline input key
FVector	GetVectorPropertyAtSplinePoint ( int32 Index, FName PropertyName )	Get a metadata property vector value along the spline at spline point
FVector	GetWorldDirectionAtDistanceAlongSpline ( float Distance )	Given a distance along the length of this spline, return a unit direction vector of the spline tangent there, in world space.
FVector	GetWorldDirectionAtTime ( float Time, bool bUseConstantVelocity )	Given a time from 0 to the spline duration, return a unit direction vector of the spline tangent there.
FVector	GetWorldLocationAtDistanceAlongSpline ( float Distance )	Given a distance along the length of this spline, return the point in world space where this puts you
FVector	GetWorldLocationAtSplinePoint ( int32 PointIndex )	Get the world location at spline point
FVector	GetWorldLocationAtTime ( float Time, bool bUseConstantVelocity )	Given a time from 0 to the spline duration, return the point in space where this puts you
FRotator	GetWorldRotationAtDistanceAlongSpline ( float Distance )	Given a distance along the length of this spline, return a rotation corresponding to the spline's rotation there, in world space.
FRotator	GetWorldRotationAtTime ( float Time, bool bUseConstantVelocity )	Given a time from 0 to the spline duration, return a rotation corresponding to the spline's position and direction there.
FVector	GetWorldTangentAtDistanceAlongSpline ( float Distance )	Given a distance along the length of this spline, return the tangent vector of the spline there, in world space.
bool	IsClosedLoop()	Check whether the spline is a closed loop or not
void	RemoveSplinePoint ( int32 Index, bool bUpdateSpline )	Removes point at specified index from the spline
void	SetClosedLoop ( bool bInClosedLoop, bool bUpdateSpline )	Specify whether the spline is a closed loop or not.
void	SetClosedLoopAtPosition ( bool bInClosedLoop, float Key, bool bUpdateSpline )	Specify whether the spline is a closed loop or not, and if so, the input key corresponding to the loop point
void	SetDefaultUpVector ( const FVector& UpVector, ESplineCoordinateSpace::Type Coordi... )	Sets the default up vector used by this spline
void	SetDrawDebug ( bool bShow )	Specify whether this spline should be rendered when the Editor/Game spline show flag is set
void	SetLocationAtSplinePoint ( int32 PointIndex, const FVector& InLocation, ESplineCoordinateSpace::Type Coordi..., bool bUpdateSpline )	Move an existing point to a new location
void	SetSelectedSplineSegmentColor ( const FLinearColor& SegmentColor )	Specify selected spline component segment color in the editor
void	SetSplineLocalPoints ( const TArray< FVector >& Points )	Sets the spline to an array of local space points
void	SetSplinePoints ( const TArray< FVector >& Points, ESplineCoordinateSpace::Type Coordi..., bool bUpdateSpline )	Sets the spline to an array of points
void	SetSplinePointType ( int32 PointIndex, ESplinePointType::Type Type, bool bUpdateSpline )	Specify the type of a spline point
void	SetSplineWorldPoints ( const TArray< FVector >& Points )	Sets the spline to an array of world space points
void	SetTangentAtSplinePoint ( int32 PointIndex, const FVector& InTangent, ESplineCoordinateSpace::Type Coordi..., bool bUpdateSpline )	Specify the tangent at a given spline point
void	SetTangentsAtSplinePoint ( int32 PointIndex, const FVector& InArriveTangent, const FVector& InLeaveTangent, ESplineCoordinateSpace::Type Coordi..., bool bUpdateSpline )	Specify the tangents at a given spline point
void	SetUnselectedSplineSegmentColor ( const FLinearColor& SegmentColor )	Specify unselected spline component segment color in the editor
void	SetUpVectorAtSplinePoint ( int32 PointIndex, const FVector& InUpVector, ESplineCoordinateSpace::Type Coordi..., bool bUpdateSpline )	Specify the up vector at a given spline point
void	SetWorldLocationAtSplinePoint ( int32 PointIndex, const FVector& InLocation )	Move an existing point to a new world location
void	UpdateSpline()	Update the spline tangents and SplineReparamTable

Overridden from UPrimitiveComponent

		Name	Description
	FPrimitiveSc...	CreateSceneProxy()	Creates a proxy to represent the primitive to the scene manager in the rendering thread.

Overridden from USceneComponent

		Name	Description
	FBoxSphereBo...	CalcBounds ( const FTransform& LocalToWorld )	Calculate the bounds of the component. Default behavior is a bounding box/sphere of zero size.

Overridden from UActorComponent

		Name	Description
	TStructOnSco...	GetComponentInstanceData()	Called before we throw away components during RerunConstructionScripts, to cache any data we wish to persist across that operation

Overridden from UObject

	Name	Description
void	PostEditChangeChainProperty ( FPropertyChangedChainEvent& Proper... )	This alternate version of PostEditChange is called when properties inside structs are modified.
void	PostLoad()	Do any object-specific cleanup required immediately after loading an object.
void	Serialize ( FArchive& Ar )	Handles reading, writing, and reference collecting using FArchive.

Constants

Name	Description
DummyPointPosition	The dummy value used for queries when there are no point in a spline
DummyPointRotation
DummyPointScale

Deprecated Variables

	Name	Description
bool	bAllowSplineEditingPerInstance_DEPRECATED
FInterpCurveVec...	SplineInfo_DEPRECATED	Deprecated - please use GetSplinePointsPosition() to fetch this FInterpCurve
FInterpCurveFlo...	SplineReparamTable_DEPRECATED
FInterpCurveQua...	SplineRotInfo_DEPRECATED	Deprecated - please use GetSplinePointsRotation() to fetch this FInterpCurve
FInterpCurveVec...	SplineScaleInfo_DEPRECATED	Deprecated - please use GetSplinePointsScale() to fetch this FInterpCurve