1. Epic GamesDeveloper
  3. USplineComponent

USplineComponent

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

API > API/Runtime > API/Runtime/Engine > API/Runtime/Engine/Components

Inheritance Hierarchy

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

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

Constructors

  Type Name Description
Public function  

USplineComponent ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Public function void

AddPoint ( const FSplinePoint& Point,
bool bUpdateSpline
)

 Adds an FSplinePoint to the spline.
Public function void

AddPoints ( const TArray< FSplinePoint >& Points,
bool bUpdateSpline
)

 Adds an array of FSplinePoints to the spline.
Public function void

AddSplineLocalPoint ( const FVector& Position
)

 Adds a local space point to the spline
Public function void

AddSplinePoint ( const FVector& Position,
ESplineCoordinateSpace::Type CoordinateSpace,
bool bUpdateSpline
)

 Adds a point to the spline
Public function void

AddSplinePointAtIndex ( const FVector& Position,
int32 Index,
ESplineCoordinateSpace::Type CoordinateSpace,
bool bUpdateSpline
)

 Adds a point to the spline at the specified index
Public function void

AddSplineWorldPoint ( const FVector& Position
)

 Deprecated method definitions.
Public function Virtual Const bool Controls the visibility of the Spline point location editor in the details panel.
Public function Virtual Const bool Controls the visibility of the Spline point arrive tangent editor in the details panel.
Public function Virtual Const bool Controls the visibility of the Spline point leave tangent editor in the details panel.
Public function Virtual Const bool Controls the visibility of the Spline point rotation editor in the details panel.
Public function Virtual Const bool Controls the visibility of the Spline point scale editor in the details panel.
Public function void

ApplyComponentInstanceData ( FSplineInstanceData* ComponentInstanceData,
const bool bPostUCS
)

  
Public function void

ClearSplinePoints ( bool bUpdateSpline
)

 Clears all the points in the spline
Public function Const bool

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

 Given a threshold, returns a list of vertices along the spline segment that, treated as a list of segments (polyline), matches the spline shape.
Public function Const bool

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

 Given a threshold, returns a list of vertices along the spline that, treated as a list of segments (polyline), matches the spline shape.
Public function Const bool

DivideSplineIntoPolylineRecursive ( float StartDistanceAlongSpline,
float EndDistanceAlongSpline,
ESplineCoordinateSpace::Type CoordinateSpace,
const float MaxSquareDistanceFromSpline,
TArray< FVector >& OutPoints
)

 Given a threshold, recursively sub-divides the spline section until the list of segments (polyline) matches the spline shape.
Public function Const bool

DivideSplineIntoPolylineRecursiveWithDistances ( float StartDistanceAlongSpline,
float EndDistanceAlongSpline,
ESplineCoordinateSpace::Type CoordinateSpace,
const float MaxSquareDistanceFromSpline,
TArray< FVector >& OutPoints,
TArray< double >& OutDistancesAlongSpline
)

 Given a threshold, recursively sub-divides the spline section until the list of segments (polyline) matches the spline shape.
Public function Static void

Draw ( FPrimitiveDrawInterface* PDI,
const FSceneView* View,
const FInterpCurveVector& SplineInfo,
const FMatrix& LocalToWorld,
const FLinearColor& LineColor,
uint8 DepthPriorityGroup
)

 Helper function to draw a vector curve
Public function Const FVector

FindDirectionClosestToWorldLocation ( const FVector& WorldLocation,
ESplineCoordinateSpace::Type CoordinateSpace
)

 Given a location, in world space, return a unit direction vector of the spline tangent closest to the location.
Public function Const float

FindInputKeyClosestToWorldLocation ( const FVector& WorldLocation
)

 Given a location, in world space, return the input key closest to that location.
Public function Const FVector

FindLocationClosestToWorldLocation ( const FVector& WorldLocation,
ESplineCoordinateSpace::Type CoordinateSpace
)

 Given a location, in world space, return the point on the curve that is closest to the location.
Public function Const FQuat

FindQuaternionClosestToWorldLocation ( const FVector& WorldLocation,
ESplineCoordinateSpace::Type CoordinateSpace
)

 Given a location, in world space, return a quaternion corresponding to the spline's rotation closest to the location.
Public function Const FVector

FindRightVectorClosestToWorldLocation ( const FVector& WorldLocation,
ESplineCoordinateSpace::Type CoordinateSpace
)

 Given a location, in world space, return a unit direction vector corresponding to the spline's right vector closest to the location.
Public function Const float

FindRollClosestToWorldLocation ( const FVector& WorldLocation,
ESplineCoordinateSpace::Type CoordinateSpace
)

 Given a location, in world space, return the spline's roll closest to the location, in degrees.
Public function Const FRotator

FindRotationClosestToWorldLocation ( const FVector& WorldLocation,
ESplineCoordinateSpace::Type CoordinateSpace
)

 Given a location, in world space, return rotation corresponding to the spline's rotation closest to the location.
Public function Const FVector

FindScaleClosestToWorldLocation ( const FVector& WorldLocation
)

 Given a location, in world space, return the spline's scale closest to the location.
Public function Const FVector

FindTangentClosestToWorldLocation ( const FVector& WorldLocation,
ESplineCoordinateSpace::Type CoordinateSpace
)

 Given a location, in world space, return the tangent vector of the spline closest to the location.
Public function Const FTransform

FindTransformClosestToWorldLocation ( const FVector& WorldLocation,
ESplineCoordinateSpace::Type CoordinateSpace,
bool bUseScale
)

 Given a location, in world space, return an FTransform closest to that location.
Public function Const FVector

FindUpVectorClosestToWorldLocation ( const FVector& WorldLocation,
ESplineCoordinateSpace::Type CoordinateSpace
)

 Given a location, in world space, return a unit direction vector corresponding to the spline's up vector closest to the location.
Public function Const FVector

GetArriveTangentAtSplinePoint ( int32 PointIndex,
ESplineCoordinateSpace::Type CoordinateSpace
)

 Get the arrive tangent at spline point
Public function Const FVector Gets the default up vector used by this spline
Public function Const FVector Given a distance along the length of this spline, return a unit direction vector of the spline tangent there.
Public function Const FVector Get unit direction along spline at the provided input key value
Public function Const FVector

GetDirectionAtSplinePoint ( int32 PointIndex,
ESplineCoordinateSpace::Type CoordinateSpace
)

 Get the direction at spline point
Public function Const FVector

GetDirectionAtTime ( float Time,
ESplineCoordinateSpace::Type CoordinateSpace,
bool bUseConstantVelocity
)

 Given a time from 0 to the spline duration, return a unit direction vector of the spline tangent there.
Public function Const float

GetDistanceAlongSplineAtLocation ( const FVector& InLocation,
ESplineCoordinateSpace::Type CoordinateSpace
)

 Get distance along the spline at closest point of the provided input location
Public function Const float Get distance along the spline at the provided input key value
Public function Const float Get the distance along the spline at the spline point
Public function Virtual Const TArray< ESplinePointType::Type > Get the enabled Spline Point types for this spline component.
Public function Const float

GetFloatPropertyAtSplineInputKey ( float InKey,
FName PropertyName
)

 Get a metadata property float value along the spline at spline input key
Public function Const float

GetFloatPropertyAtSplinePoint ( int32 Index,
FName PropertyName
)

 Get a metadata property float value along the spline at spline point
Public function Const float Given a distance along the length of this spline, return the corresponding input key at that point This method has been deprecated because it was incorrectly returning the input key at time.
Public function Const float Given a distance along the length of this spline, return the corresponding input key at that point with a fractional component between the current input key and the next as a percentage.
Public function Const float

GetInputKeyValueAtSplinePoint ( int32 PointIndex
)

 Get the input key (e.g. the time) of the control point of the spline at the specified index.
Public function Const FVector

GetLeaveTangentAtSplinePoint ( int32 PointIndex,
ESplineCoordinateSpace::Type CoordinateSpace
)

 Get the leave tangent at spline point
Public function Const void

GetLocalLocationAndTangentAtSplinePoint ( int32 PointIndex,
FVector& LocalLocation,
FVector& LocalTangent
)

 Get local location and tangent at a spline point
Public function Const void

GetLocationAndTangentAtSplinePoint ( int32 PointIndex,
FVector& Location,
FVector& Tangent,
ESplineCoordinateSpace::Type CoordinateSpace
)

 Get location and tangent at a spline point
Public function Const FVector Given a distance along the length of this spline, return the point in space where this puts you
Public function Const FVector Get location along spline at the provided input key value
Public function Const FVector

GetLocationAtSplinePoint ( int32 PointIndex,
ESplineCoordinateSpace::Type CoordinateSpace
)

 Get the location at spline point
Public function Const FVector

GetLocationAtTime ( float Time,
ESplineCoordinateSpace::Type CoordinateSpace,
bool bUseConstantVelocity
)

 Given a time from 0 to the spline duration, return the point in space where this puts you
Public function Const int32 Get the number of points that make up this spline
Public function Const int32 Get the number of segments that make up this spline
Public function Const FQuat Given a distance along the length of this spline, return a quaternion corresponding to the spline's rotation there.
Public function Const FQuat Get quaternion corresponding to rotation along spline at the provided input key value
Public function Const FQuat

GetQuaternionAtSplinePoint ( int32 PointIndex,
ESplineCoordinateSpace::Type CoordinateSpace
)

 Get the rotation at spline point as a quaternion
Public function Const FQuat

GetQuaternionAtTime ( float Time,
ESplineCoordinateSpace::Type CoordinateSpace,
bool bUseConstantVelocity
)

 Given a time from 0 to the spline duration, return a quaternion corresponding to the spline's rotation there.
Public function Const FVector Given a distance along the length of this spline, return a unit direction vector corresponding to the spline's right vector there.
Public function Const FVector Get right vector at the provided input key value
Public function Const FVector

GetRightVectorAtSplinePoint ( int32 PointIndex,
ESplineCoordinateSpace::Type CoordinateSpace
)

 Get the right vector at spline point
Public function Const FVector

GetRightVectorAtTime ( float Time,
ESplineCoordinateSpace::Type CoordinateSpace,
bool bUseConstantVelocity
)

 Given a time from 0 to the spline duration, return the spline's right vector there.
Public function Const float

GetRollAtDistanceAlongSpline ( float Distance,
ESplineCoordinateSpace::Type CoordinateSpace
)

 Given a distance along the length of this spline, return the spline's roll there, in degrees.
Public function Const float

GetRollAtSplineInputKey ( float InKey,
ESplineCoordinateSpace::Type CoordinateSpace
)

 Get roll in degrees at the provided input key value
Public function Const float

GetRollAtSplinePoint ( int32 PointIndex,
ESplineCoordinateSpace::Type CoordinateSpace
)

 Get the amount of roll at spline point, in degrees
Public function Const float

GetRollAtTime ( float Time,
ESplineCoordinateSpace::Type CoordinateSpace,
bool bUseConstantVelocity
)

 Given a time from 0 to the spline duration, return the spline's roll there, in degrees.
Public function Const FRotator Given a distance along the length of this spline, return a rotation corresponding to the spline's rotation there.
Public function Const FRotator Get rotator corresponding to rotation along spline at the provided input key value
Public function Const FRotator

GetRotationAtSplinePoint ( int32 PointIndex,
ESplineCoordinateSpace::Type CoordinateSpace
)

 Get the rotation at spline point as a rotator
Public function Const FRotator

GetRotationAtTime ( float Time,
ESplineCoordinateSpace::Type CoordinateSpace,
bool bUseConstantVelocity
)

 Given a time from 0 to the spline duration, return a rotation corresponding to the spline's position and direction there.
Public function Const FVector

GetScaleAtDistanceAlongSpline ( float Distance
)

 Given a distance along the length of this spline, return the spline's scale there.
Public function Const FVector

GetScaleAtSplineInputKey ( float InKey
)

 Get scale at the provided input key value
Public function Const FVector

GetScaleAtSplinePoint ( int32 PointIndex
)

 Get the scale at spline point
Public function Const FVector

GetScaleAtTime ( float Time,
bool bUseConstantVelocity
)

 Given a time from 0 to the spline duration, return the spline's scale there.
Public function Const float Returns total length along this spline
Public function Const FSplinePoint

GetSplinePointAt ( int32 PointIndex,
ESplineCoordinateSpace::Type CoordinateSpace
)

 Gets the spline point of the spline at the specified index
Public function Virtual Const const USplineMetadata *  
Public function Virtual USplineMetadata *  
Public function Const const FInterpCurveVector &  
Public function FInterpCurveVector &  
Public function Const const FInterpCurveQuat &  
Public function FInterpCurveQuat &  
Public function FInterpCurveVector &  
Public function Const const FInterpCurveVector &  
Public function Const ESplinePointType::Type

GetSplinePointType ( int32 PointIndex
)

 Get the type of a spline point
Public function Const FVector Given a distance along the length of this spline, return the tangent vector of the spline there.
Public function Const FVector

GetTangentAtSplineInputKey ( float InKey,
ESplineCoordinateSpace::Type CoordinateSpace
)

 Get tangent along spline at the provided input key value
Public function Const FVector

GetTangentAtSplinePoint ( int32 PointIndex,
ESplineCoordinateSpace::Type CoordinateSpace
)

 Get the tangent at spline point. This fetches the Leave tangent of the point.
Public function Const FVector

GetTangentAtTime ( float Time,
ESplineCoordinateSpace::Type CoordinateSpace,
bool bUseConstantVelocity
)

 Given a time from 0 to the spline duration, return the spline's tangent there.
Public function Const float

GetTimeAtDistanceAlongSpline ( float Distance
)

 Given a distance along the length of this spline, return the corresponding time at that point
Public function Const FTransform

GetTransformAtDistanceAlongSpline ( float Distance,
ESplineCoordinateSpace::Type CoordinateSpace,
bool bUseScale
)

 Given a distance along the length of this spline, return an FTransform corresponding to that point on the spline.
Public function Const FTransform

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

 Get transform at the provided input key value
Public function Const FTransform

GetTransformAtSplinePoint ( int32 PointIndex,
ESplineCoordinateSpace::Type CoordinateSpace,
bool bUseScale
)

 Get the transform at spline point
Public function Const FTransform

GetTransformAtTime ( float Time,
ESplineCoordinateSpace::Type CoordinateSpace,
bool bUseConstantVelocity,
bool bUseScale
)

 Given a time from 0 to the spline duration, return the spline's transform at the corresponding position.
Public function Const FVector Given a distance along the length of this spline, return a unit direction vector corresponding to the spline's up vector there.
Public function Const FVector Get up vector at the provided input key value
Public function Const FVector

GetUpVectorAtSplinePoint ( int32 PointIndex,
ESplineCoordinateSpace::Type CoordinateSpace
)

 Get the up vector at spline point
Public function Const FVector

GetUpVectorAtTime ( float Time,
ESplineCoordinateSpace::Type CoordinateSpace,
bool bUseConstantVelocity
)

 Given a time from 0 to the spline duration, return the spline's up vector there.
Public function Const FVector

GetVectorPropertyAtSplineInputKey ( float InKey,
FName PropertyName
)

 Get a metadata property vector value along the spline at spline input key
Public function Const FVector

GetVectorPropertyAtSplinePoint ( int32 Index,
FName PropertyName
)

 Get a metadata property vector value along the spline at spline point
Public function Const FVector Given a distance along the length of this spline, return a unit direction vector of the spline tangent there, in world space.
Public function Const 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.
Public function Const FVector Given a distance along the length of this spline, return the point in world space where this puts you
Public function Const FVector

GetWorldLocationAtSplinePoint ( int32 PointIndex
)

 Get the world location at spline point
Public function Const FVector

GetWorldLocationAtTime ( float Time,
bool bUseConstantVelocity
)

 Given a time from 0 to the spline duration, return the point in space where this puts you
Public function Const FRotator Given a distance along the length of this spline, return a rotation corresponding to the spline's rotation there, in world space.
Public function Const 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, in world space.
Public function Const FVector Given a distance along the length of this spline, return the tangent vector of the spline there, in world space.
Public function Const bool Check whether the spline is a closed loop or not
Public function void

RemoveSplinePoint ( int32 Index,
bool bUpdateSpline
)

 Removes point at specified index from the spline
Public function void Reset the spline to its default shape (a spline of two points)
Public function void

SetClosedLoop ( bool bInClosedLoop,
bool bUpdateSpline
)

 Specify whether the spline is a closed loop or not.
Public function 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
Public function void

SetDefaultUpVector ( const FVector& UpVector,
ESplineCoordinateSpace::Type CoordinateSpace
)

 Sets the default up vector used by this spline
Public function void

SetDrawDebug ( bool bShow
)

 Specify whether this spline should be rendered when the Editor/Game spline show flag is set
Public function void

SetLocationAtSplinePoint ( int32 PointIndex,
const FVector& InLocation,
ESplineCoordinateSpace::Type CoordinateSpace,
bool bUpdateSpline
)

 Move an existing point to a new location
Public function void

SetRotationAtSplinePoint ( int32 PointIndex,
const FRotator& InRotation,
ESplineCoordinateSpace::Type CoordinateSpace,
bool bUpdateSpline
)

 Set the rotation of an existing spline point
Public function void

SetScaleAtSplinePoint ( int32 PointIndex,
const FVector& InScaleVector,
bool bUpdateSpline
)

 Set the scale at a given spline point
Public function void Specify selected spline component segment color in the editor
Public function void

SetSplineLocalPoints ( const TArray< FVector >& Points
)

 Sets the spline to an array of local space points
Public function void

SetSplinePoints ( const TArray< FVector >& Points,
ESplineCoordinateSpace::Type CoordinateSpace,
bool bUpdateSpline
)

 Sets the spline to an array of points
Public function void

SetSplinePointType ( int32 PointIndex,
ESplinePointType::Type Type,
bool bUpdateSpline
)

 Specify the type of a spline point
Public function void

SetSplineWorldPoints ( const TArray< FVector >& Points
)

 Sets the spline to an array of world space points
Public function void

SetTangentAtSplinePoint ( int32 PointIndex,
const FVector& InTangent,
ESplineCoordinateSpace::Type CoordinateSpace,
bool bUpdateSpline
)

 Specify the tangent at a given spline point
Public function void

SetTangentColor ( const FLinearColor& TangentColor
)

 Specify selected spline component segment color in the editor
Public function void

SetTangentsAtSplinePoint ( int32 PointIndex,
const FVector& InArriveTangent,
const FVector& InLeaveTangent,
ESplineCoordinateSpace::Type CoordinateSpace,
bool bUpdateSpline
)

 Specify the tangents at a given spline point
Public function void Specify unselected spline component segment color in the editor
Public function void

SetUpVectorAtSplinePoint ( int32 PointIndex,
const FVector& InUpVector,
ESplineCoordinateSpace::Type CoordinateSpace,
bool bUpdateSpline
)

 Specify the up vector at a given spline point
Public function void

SetWorldLocationAtSplinePoint ( int32 PointIndex,
const FVector& InLocation
)

 Move an existing point to a new world location
Public function Virtual void Update the spline tangents and SplineReparamTable

Overridden from UPrimitiveComponent

  Type Name Description
Public function Virtual FPrimitiveSceneProxy * Creates a proxy to represent the primitive to the scene manager in the rendering thread.
Public function Virtual Const bool Whether or not the bounds of this component should be considered when focusing the editor camera to an actor with this component in it.
Public function Virtual void Pushes new selection state to the render thread primitive proxy

Overridden from USceneComponent

  Type Name Description
Public function Virtual Const FBoxSphereBounds

CalcBounds ( const FTransform& LocalToWorld
)

 Calculate the bounds of the component. Default behavior is a bounding box/sphere of zero size.

Overridden from UActorComponent

  Type Name Description
Public function Virtual Const TStructOnScope< FActorComponentInstanceData > Called before we throw away components during RerunConstructionScripts, to cache any data we wish to persist across that operation

Overridden from UObject

  Type Name Description
Public function Virtual Const void Returns properties that are replicated for the lifetime of the actor channel
Public function Virtual void This alternate version of PostEditChange is called when properties inside structs are modified.
Public function Virtual void Do any object-specific cleanup required immediately after loading an object.
Public function Virtual void Handles reading, writing, and reference collecting using FArchive.

Typedefs

Name Description
DeselectedInEditorDelegate Delegate that's called when this component is deselected in the editor

Constants

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

Deprecated Variables

  Type Name Description
Public variable bool bAllowSplineEditingPerInstance_DEPRECATED  
Public variable FInterpCurveVector SplineInfo_DEPRECATED Deprecated - please use GetSplinePointsPosition() to fetch this FInterpCurve
Public variable FInterpCurveFloat SplineReparamTable_DEPRECATED  
Public variable FInterpCurveQuat SplineRotInfo_DEPRECATED Deprecated - please use GetSplinePointsRotation() to fetch this FInterpCurve
Public variable FInterpCurveVector SplineScaleInfo_DEPRECATED Deprecated - please use GetSplinePointsScale() to fetch this FInterpCurve

See Also

https://docs.unrealengine.com/latest/INT/Resources/ContentExamples/Blueprint_Splines

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page