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

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

   
Name USplineComponent
Type class
Header File /Engine/Source/Runtime/Engine/Classes/Components/SplineComponent.h
Include Path #include "Components/SplineComponent.h"

Syntax

UCLASS (ClassGroup=Utility, ShowCategories=(Mobility),  
       HideCategories=(Physics, Collision, Lighting, Rendering, Mobile),  
       Meta=(BlueprintSpawnableComponent), MinimalAPI)  
class USplineComponent : public UPrimitiveComponent

Inheritance Hierarchy

Implements Interfaces

Derived Classes

Constructors

Name Remarks Include Path Unreal Specifiers

USplineComponent ( const FObjectInitializer& ObjectInitializer
)

   Components/SplineComponent.h  

Typedefs

Name Type Remarks Include Path
DeselectedInEditorDelegate TMulticastDelegate_OneParam< void, TObjectPtr< USplineComponent > > Delegate that's called when this component is deselected in the editor Components/SplineComponent.h

Constants

Name Type Remarks Include Path
DummyPointPosition const FInterpCurvePointVector The dummy value used for queries when there are no point in a spline Components/SplineComponent.h
DummyPointRotation const FInterpCurvePointQuat   Components/SplineComponent.h
DummyPointScale const FInterpCurvePointVector   Components/SplineComponent.h

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
bAdjustTangentsOnSnap bool Adjust tangents after snapping. Components/SplineComponent.h
  • EditAnywhere
  • Category=Editor
bAllowDiscontinuousSpline bool Whether the spline's leave and arrive tangents can be different Components/SplineComponent.h
  • EditAnywhere
  • Category=Editor
bDrawDebug bool If true, the spline will be rendered if the Splines showflag is set. Components/SplineComponent.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Spline
bInputSplinePointsToConstructionScript bool Whether the spline points should be passed to the User Construction Script so they can be further manipulated by it. Components/SplineComponent.h
  • EditAnywhere
  • Replicated
  • BlueprintReadWrite
  • Category=Spline
bModifiedByConstructionScript bool Whether the UCS has made changes to the spline points Components/SplineComponent.h  
bShouldVisualizeScale bool Whether scale visualization should be displayed Components/SplineComponent.h
  • EditAnywhere
  • Category=Editor
  • Meta=(InlineEditConditionToggle=true)
bSplineHasBeenEdited bool Whether the spline has been edited from its default by the spline component visualizer Components/SplineComponent.h
  • EditAnywhere
  • Replicated
  • Category=Spline
  • Meta=(DisplayName="Override Construction Script")
bStationaryEndpoints bool Whether the endpoints of the spline are considered stationary when traversing the spline at non-constant velocity. Components/SplineComponent.h
  • EditAnywhere
  • Replicated
  • BlueprintReadWrite
  • AdvancedDisplay
  • Category=Spline
  • Meta=(EditCondition="!bClosedLoop")
DefaultUpVector FVector Default up vector in local space to be used when calculating transforms along the spline Components/SplineComponent.h
  • EditAnywhere
  • Replicated
  • BlueprintReadWrite
  • Category=Spline
  • Meta=(Spatial)
Duration float Specifies the duration of the spline in seconds Components/SplineComponent.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Spline
EditorSelectedSplineSegmentColor FLinearColor Color of selected spline component parts in the editor Components/SplineComponent.h
  • EditAnywhere
  • Category=Editor
  • Meta=(DisplayName="Editor Spline Selected Color")
EditorTangentColor FLinearColor Color of spline point tangents in the editor Components/SplineComponent.h
  • EditAnywhere
  • Category=Editor
  • Meta=(DisplayName="Editor Spline Tangent Color")
EditorUnselectedSplineSegmentColor FLinearColor Color of unselected spline component parts in the editor Components/SplineComponent.h
  • EditAnywhere
  • Category=Editor
  • Meta=(DisplayName="Editor Spline Unselected Color")
OnDeselectedInEditor DeselectedInEditorDelegate   Components/SplineComponent.h  
ReparamStepsPerSegment int32 Number of steps per spline segment to place in the reparameterization table Components/SplineComponent.h
  • EditAnywhere
  • Replicated
  • AdvancedDisplay
  • Category=Spline
  • Meta=(ClampMin=4, UIMin=4, ClampMax=100, UIMax=100)
ScaleVisualizationWidth float Width of spline in editor for use with scale visualization Components/SplineComponent.h
  • EditAnywhere
  • Category=Editor
  • Meta=(EditCondition="bShouldVisualizeScale")
SplineCurves FSplineCurves   Components/SplineComponent.h
  • EditAnywhere
  • Replicated
  • Category=Points

Protected

Name Type Remarks Include Path Unreal Specifiers
bClosedLoop bool Whether the spline is to be considered as a closed loop. Components/SplineComponent.h
  • EditAnywhere
  • Replicated
  • Category=Spline
bLoopPositionOverride bool   Components/SplineComponent.h
  • EditAnywhere
  • Replicated
  • Category=Spline
  • Meta=(InlineEditConditionToggle=true)
LastAuthority ELastAuthority   Components/SplineComponent.h  
LineMaterial TSoftObjectPtr< UMaterialInterface > Material used for rendering spline segments. Components/SplineComponent.h
  • Transient
LineMaterialLifetimePtr TObjectPtr< UMaterialInterface > Holds a strong reference to LineMaterial once loaded. Components/SplineComponent.h
  • Transient
LineMaterialLoadID int32   Components/SplineComponent.h  
LoopPosition float   Components/SplineComponent.h
  • EditAnywhere
  • Replicated
  • Category=Spline
  • Meta=(EditCondition="bLoopPositionOverride")
PointMaterial TSoftObjectPtr< UMaterialInterface > Material used for rendering spline points. Components/SplineComponent.h
  • Transient
PointMaterialLifetimePtr TObjectPtr< UMaterialInterface > Holds a strong reference to PointMaterial once loaded. Components/SplineComponent.h
  • Transient
PointMaterialLoadID int32   Components/SplineComponent.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void AddPoint ( const FSplinePoint& Point,
bool bUpdateSpline
)

 Adds an FSplinePoint to the spline. Components/SplineComponent.h
  • BlueprintCallable
  • Category=Spline

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

 Adds an array of FSplinePoints to the spline. Components/SplineComponent.h
  • BlueprintCallable
  • Category=Spline

void AddSplineLocalPoint ( const FVector& Position
)

 Adds a local space point to the spline Components/SplineComponent.h
  • BlueprintCallable
  • Category=Spline
  • Meta=(DeprecatedFunction, DeprecationMessage="Please use AddSplinePoint, specifying SplineCoordinateSpace::Local")

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

 Adds a point to the spline Components/SplineComponent.h
  • BlueprintCallable
  • Category=Spline

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

 Adds a point to the spline at the specified index Components/SplineComponent.h
  • BlueprintCallable
  • Category=Spline

void AddSplineWorldPoint ( const FVector& Position
)

 Deprecated method definitions. Components/SplineComponent.h
  • BlueprintCallable
  • Category=Spline
  • Meta=(DeprecatedFunction, DeprecationMessage="Please use AddSplinePoint, specifying SplineCoordinateSpace::World")

virtual bool AllowsSpinePointLocationEditing()

 Controls the visibility of the Spline point location editor in the details panel. Components/SplineComponent.h  

virtual bool AllowsSplinePointArriveTangentEditing()

 Controls the visibility of the Spline point arrive tangent editor in the details panel. Components/SplineComponent.h  

virtual bool AllowsSplinePointLeaveTangentEditing()

 Controls the visibility of the Spline point leave tangent editor in the details panel. Components/SplineComponent.h  

virtual bool AllowsSplinePointRotationEditing()

 Controls the visibility of the Spline point rotation editor in the details panel. Components/SplineComponent.h  

virtual bool AllowsSplinePointScaleEditing()

 Controls the visibility of the Spline point scale editor in the details panel. Components/SplineComponent.h  

void ApplyComponentInstanceData ( FSplineComponentInstanceData* ComponentInstanceData,
const bool bPostUCS
)

   Components/SplineComponent.h  

void ApplyComponentInstanceData ( FSplineInstanceData* ComponentInstanceData,
const bool bPostUCS
)

   Components/SplineComponent.h  

bool CanResetToDefault()

   Components/SplineComponent.h  

void ClearSplinePoints ( bool bUpdateSpline
)

 Clears all the points in the spline Components/SplineComponent.h
  • BlueprintCallable
  • Category=Spline

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. Components/SplineComponent.h
  • BlueprintCallable
  • Category=Spline

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. Components/SplineComponent.h
  • BlueprintCallable
  • Category=Spline

bool ConvertSplineToPolyline_InDistanceRange ( ESplineCoordinateSpace::Type CoordinateSpace,
const float MaxSquareDistanceFromSpline,
float StartDistAlongSpline,
float EndDistAlongSpline,
TArray< FVector >& OutPoints,
TArray< double >& OutDistancesAlongSpline,
bool bAllowWrappingIfClosed
) const

 Given a threshold and a start and end distance range, returns a list of vertices along the spline that, treated as a list of segments (polyline), matches the spline shape in that range. Components/SplineComponent.h
  • BlueprintPure=false
  • Category=Spline

bool ConvertSplineToPolyline_InTimeRange ( ESplineCoordinateSpace::Type CoordinateSpace,
const float MaxSquareDistanceFromSpline,
float StartTimeAlongSpline,
float EndTimeAlongSpline,
bool bUseConstantVelocity,
TArray< FVector >& OutPoints,
TArray< double >& OutDistancesAlongSpline,
bool bAllowWrappingIfClosed
) const

 Given a threshold and start and end time range, returns a list of vertices along the spline that, treated as a list of segments (polyline), matches the spline shape in that range. Components/SplineComponent.h
  • BlueprintPure=false
  • Category=Spline

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

 Given a threshold, returns a list of vertices along the spline that, treated as a list of segments (polyline), matches the spline shape. Components/SplineComponent.h
  • BlueprintPure=false
  • Category=Spline

void CreateFloatPropertyChannel ( FName PropertyName
)

 Create a float attribute channel. Components/SplineComponent.h
  • BlueprintCallable
  • Category="Spline|Metadata"

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

 Given a threshold, recursively sub-divides the spline section until the list of segments (polyline) matches the spline shape. Components/SplineComponent.h
  • BlueprintCallable
  • Category=Spline

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

 Given a threshold, recursively sub-divides the spline section until the list of segments (polyline) matches the spline shape. Components/SplineComponent.h
  • BlueprintCallable
  • Category=Spline

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

 Given a location, in world space, return a unit direction vector of the spline tangent closest to the location. Components/SplineComponent.h
  • BlueprintCallable
  • Category=Spline

float FindInputKeyClosestToWorldLocation ( const FVector& WorldLocation
) const

 Given a location, in world space, return the input key closest to that location. Components/SplineComponent.h
  • BlueprintCallable
  • Category=Spline

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

 Given a location, in world space, return the input key closest to that location on the specified segment. Components/SplineComponent.h
  • BlueprintCallable
  • Category=Spline

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

 Given a location, in world space, return the point on the curve that is closest to the location. Components/SplineComponent.h
  • BlueprintCallable
  • Category=Spline

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

 Given a location, in world space, return a quaternion corresponding to the spline's rotation closest to the location. Components/SplineComponent.h  

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

 Given a location, in world space, return a unit direction vector corresponding to the spline's right vector closest to the location. Components/SplineComponent.h
  • BlueprintCallable
  • Category=Spline

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

 Given a location, in world space, return the spline's roll closest to the location, in degrees. Components/SplineComponent.h
  • BlueprintCallable
  • Category=Spline

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

 Given a location, in world space, return rotation corresponding to the spline's rotation closest to the location. Components/SplineComponent.h
  • BlueprintCallable
  • Category=Spline

FVector FindScaleClosestToWorldLocation ( const FVector& WorldLocation
) const

 Given a location, in world space, return the spline's scale closest to the location. Components/SplineComponent.h
  • BlueprintCallable
  • Category=Spline

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

 Given a location, in world space, return the tangent vector of the spline closest to the location. Components/SplineComponent.h
  • BlueprintCallable
  • Category=Spline

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

 Given a location, in world space, return an FTransform closest to that location. Components/SplineComponent.h
  • BlueprintCallable
  • Category=Spline

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

 Given a location, in world space, return a unit direction vector corresponding to the spline's up vector closest to the location. Components/SplineComponent.h
  • BlueprintCallable
  • Category=Spline

FVector GetArriveTangentAtSplinePoint ( int32 PointIndex,
ESplineCoordinateSpace::Type CoordinateSpace
) const

 Get the arrive tangent at spline point Components/SplineComponent.h
  • BlueprintCallable
  • Category=Spline

FVector GetDefaultUpVector ( ESplineCoordinateSpace::Type CoordinateSpace
) const

 Gets the default up vector used by this spline Components/SplineComponent.h
  • BlueprintCallable
  • Category=Spline

FVector GetDirectionAtDistanceAlongSpline ( float Distance,
ESplineCoordinateSpace::Type CoordinateSpace
) const

 Given a distance along the length of this spline, return a unit direction vector of the spline tangent there. Components/SplineComponent.h
  • BlueprintCallable
  • Category=Spline

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

 Get unit direction along spline at the provided input key value Components/SplineComponent.h
  • BlueprintCallable
  • Category=Spline

FVector GetDirectionAtSplinePoint ( int32 PointIndex,
ESplineCoordinateSpace::Type CoordinateSpace
) const

 Get the direction at spline point Components/SplineComponent.h
  • BlueprintCallable
  • Category=Spline

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

 Given a time from 0 to the spline duration, return a unit direction vector of the spline tangent there. Components/SplineComponent.h
  • BlueprintCallable
  • Category=Spline

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

 Get distance along the spline at closest point of the provided input location Components/SplineComponent.h
  • BlueprintCallable
  • Category=Spline

float GetDistanceAlongSplineAtSplineInputKey ( float InKey
) const

 Get distance along the spline at the provided input key value Components/SplineComponent.h
  • BlueprintCallable
  • Category=Spline

float GetDistanceAlongSplineAtSplinePoint ( int32 PointIndex
) const

 Get the distance along the spline at the spline point Components/SplineComponent.h
  • BlueprintCallable
  • Category=Spline

virtual TArray< ESplinePointType::Type > GetEnabledSplinePointTypes()

 Get the enabled Spline Point types for this spline component. Components/SplineComponent.h  

float GetFloatPropertyAtIndex ( int32 Index,
FName PropertyName
) const

 Get a float attribute value by index. Components/SplineComponent.h
  • BlueprintCallable
  • Category="Spline|Metadata"

float GetFloatPropertyAtSplineInputKey ( float InKey,
FName PropertyName
) const

 Get a float attribute value by parameter. Components/SplineComponent.h
  • BlueprintCallable
  • Category="Spline|Metadata"

float GetFloatPropertyAtSplinePoint ( int32 Index,
FName PropertyName
) const

 Get a metadata property float value along the spline at spline point Components/SplineComponent.h
  • BlueprintCallable
  • Category=Spline

TArray< FName > GetFloatPropertyChannels()

   Components/SplineComponent.h
  • BlueprintCallable
  • Category="Spline|Metadata"

float GetFloatPropertyInputKeyAtIndex ( int32 Index,
FName PropertyName
) const

 Get a float attribute parameter by index. Components/SplineComponent.h
  • BlueprintCallable
  • Category="Spline|Metadata"

float GetInputKeyAtDistanceAlongSpline ( float Distance
) const

 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. Components/SplineComponent.h
  • BlueprintCallable
  • Category=Spline
  • Meta=(DeprecatedFunction, DeprecationMessage="Please use GetInputKeyValueAtDistanceAlongSpline to get input key at distance or GetTimeAtDistanceAlongSpline to get time value (normalized to duration) at distance (same logic as deprecated function).")

float GetInputKeyValueAtDistanceAlongSpline ( float Distance
) const

 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. Components/SplineComponent.h
  • BlueprintCallable
  • Category=Spline

float GetInputKeyValueAtSplinePoint ( int32 PointIndex
) const

 Get the input key (e.g. the time) of the control point of the spline at the specified index. Components/SplineComponent.h
  • BlueprintCallable
  • Category=Spline

float GetInputKeyValueAtTime ( float Time
) const

 Convert a time value (in the range [0, Duration]) to an input key. Components/SplineComponent.h
  • BlueprintCallable
  • Category=Spline

FVector GetLeaveTangentAtSplinePoint ( int32 PointIndex,
ESplineCoordinateSpace::Type CoordinateSpace
) const

 Get the leave tangent at spline point Components/SplineComponent.h
  • BlueprintCallable
  • Category=Spline

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

 Get local location and tangent at a spline point Components/SplineComponent.h
  • BlueprintCallable
  • Category=Spline
  • Meta=(DeprecatedFunction, DeprecationMessage="Please use GetLocationAndTangentAtSplinePoint, specifying SplineCoordinateSpace::Local")

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

 Get location and tangent at a spline point Components/SplineComponent.h
  • BlueprintCallable
  • Category=Spline

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

 Given a distance along the length of this spline, return the point in space where this puts you Components/SplineComponent.h
  • BlueprintCallable
  • Category=Spline

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

 Get location along spline at the provided input key value Components/SplineComponent.h
  • BlueprintCallable
  • Category=Spline

FVector GetLocationAtSplinePoint ( int32 PointIndex,
ESplineCoordinateSpace::Type CoordinateSpace
) const

 Get the location at spline point Components/SplineComponent.h
  • BlueprintCallable
  • Category=Spline

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

 Given a time from 0 to the spline duration, return the point in space where this puts you Components/SplineComponent.h
  • BlueprintCallable
  • Category=Spline

int32 GetNumberOfPropertyValues ( FName PropertyName
) const

 Get the number of attribute values in a specified attribute channel. Components/SplineComponent.h
  • BlueprintCallable
  • Category="Spline|Metadata"

int32 GetNumberOfSplinePoints()

 Get the number of points that make up this spline Components/SplineComponent.h
  • BlueprintCallable
  • Category=Spline

int32 GetNumberOfSplineSegments()

 Get the number of segments that make up this spline Components/SplineComponent.h
  • BlueprintCallable
  • Category=Spline

FSimpleMulticastDelegate & GetOnSplineChanged()

   Components/SplineComponent.h  

FSimpleMulticastDelegate & GetOnSplineDisplayChanged()

   Components/SplineComponent.h  

FSimpleMulticastDelegate & GetOnSplineUpdated()

   Components/SplineComponent.h  

FQuat GetQuaternionAtDistanceAlongSpline ( float Distance,
ESplineCoordinateSpace::Type CoordinateSpace
) const

 Given a distance along the length of this spline, return a quaternion corresponding to the spline's rotation there. Components/SplineComponent.h  

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

 Get quaternion corresponding to rotation along spline at the provided input key value Components/SplineComponent.h  

FQuat GetQuaternionAtSplinePoint ( int32 PointIndex,
ESplineCoordinateSpace::Type CoordinateSpace
) const

 Get the rotation at spline point as a quaternion Components/SplineComponent.h  

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

 Given a time from 0 to the spline duration, return a quaternion corresponding to the spline's rotation there. Components/SplineComponent.h  

FVector GetRightVectorAtDistanceAlongSpline ( float Distance,
ESplineCoordinateSpace::Type CoordinateSpace
) const

 Given a distance along the length of this spline, return a unit direction vector corresponding to the spline's right vector there. Components/SplineComponent.h
  • BlueprintCallable
  • Category=Spline

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

 Get right vector at the provided input key value Components/SplineComponent.h
  • BlueprintCallable
  • Category=Spline

FVector GetRightVectorAtSplinePoint ( int32 PointIndex,
ESplineCoordinateSpace::Type CoordinateSpace
) const

 Get the right vector at spline point Components/SplineComponent.h
  • BlueprintCallable
  • Category=Spline

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

 Given a time from 0 to the spline duration, return the spline's right vector there. Components/SplineComponent.h
  • BlueprintCallable
  • Category=Spline

float GetRollAtDistanceAlongSpline ( float Distance,
ESplineCoordinateSpace::Type CoordinateSpace
) const

 Given a distance along the length of this spline, return the spline's roll there, in degrees. Components/SplineComponent.h
  • BlueprintCallable
  • Category=Spline

float GetRollAtSplineInputKey ( float InKey,
ESplineCoordinateSpace::Type CoordinateSpace
) const

 Get roll in degrees at the provided input key value Components/SplineComponent.h
  • BlueprintCallable
  • Category=Spline

float GetRollAtSplinePoint ( int32 PointIndex,
ESplineCoordinateSpace::Type CoordinateSpace
) const

 Get the amount of roll at spline point, in degrees Components/SplineComponent.h
  • BlueprintCallable
  • Category=Spline

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

 Given a time from 0 to the spline duration, return the spline's roll there, in degrees. Components/SplineComponent.h
  • BlueprintCallable
  • Category=Spline

FRotator GetRotationAtDistanceAlongSpline ( float Distance,
ESplineCoordinateSpace::Type CoordinateSpace
) const

 Given a distance along the length of this spline, return a rotation corresponding to the spline's rotation there. Components/SplineComponent.h
  • BlueprintCallable
  • Category=Spline

FRotator GetRotationAtSplineInputKey ( float InKey,
ESplineCoordinateSpace::Type CoordinateSpace
) const

 Get rotator corresponding to rotation along spline at the provided input key value Components/SplineComponent.h
  • BlueprintCallable
  • Category=Spline

FRotator GetRotationAtSplinePoint ( int32 PointIndex,
ESplineCoordinateSpace::Type CoordinateSpace
) const

 Get the rotation at spline point as a rotator Components/SplineComponent.h
  • BlueprintCallable
  • Category=Spline

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

 Given a time from 0 to the spline duration, return a rotation corresponding to the spline's position and direction there. Components/SplineComponent.h
  • BlueprintCallable
  • Category=Spline

FVector GetScaleAtDistanceAlongSpline ( float Distance
) const

 Given a distance along the length of this spline, return the spline's scale there. Components/SplineComponent.h
  • BlueprintCallable
  • Category=Spline

FVector GetScaleAtSplineInputKey ( float InKey
) const

 Get scale at the provided input key value Components/SplineComponent.h
  • BlueprintCallable
  • Category=Spline

FVector GetScaleAtSplinePoint ( int32 PointIndex
) const

 Get the scale at spline point Components/SplineComponent.h
  • BlueprintCallable
  • Category=Spline

FVector GetScaleAtTime ( float Time,
bool bUseConstantVelocity
) const

 Given a time from 0 to the spline duration, return the spline's scale there. Components/SplineComponent.h
  • BlueprintCallable
  • Category=Spline

FSpline GetSpline()

   Components/SplineComponent.h  

FSplineCurves GetSplineCurves()

 Safe for caching spline data in the legacy format. Will auto convert data if necessary. Components/SplineComponent.h  

float GetSplineLength()

 Returns total length along this spline Components/SplineComponent.h
  • BlueprintCallable
  • Category=Spline

FSplinePoint GetSplinePointAt ( int32 PointIndex,
ESplineCoordinateSpace::Type CoordinateSpace
) const

 Gets the spline point of the spline at the specified index Components/SplineComponent.h
  • BlueprintCallable
  • Category=Spline
  Components/SplineComponent.h  
  Components/SplineComponent.h  
  Components/SplineComponent.h  
Todo: deprecate Components/SplineComponent.h  
  Components/SplineComponent.h  
  Components/SplineComponent.h  
  Components/SplineComponent.h  
  Components/SplineComponent.h  

ESplinePointType::Type GetSplinePointType ( int32 PointIndex
) const

 Get the type of a spline point Components/SplineComponent.h
  • BlueprintCallable
  • Category=Spline

FVector GetTangentAtDistanceAlongSpline ( float Distance,
ESplineCoordinateSpace::Type CoordinateSpace
) const

 Given a distance along the length of this spline, return the tangent vector of the spline there. Components/SplineComponent.h
  • BlueprintCallable
  • Category=Spline

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

 Get tangent along spline at the provided input key value Components/SplineComponent.h
  • BlueprintCallable
  • Category=Spline

FVector GetTangentAtSplinePoint ( int32 PointIndex,
ESplineCoordinateSpace::Type CoordinateSpace
) const

 Get the tangent at spline point. This fetches the Leave tangent of the point. Components/SplineComponent.h
  • BlueprintCallable
  • Category=Spline

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

 Given a time from 0 to the spline duration, return the spline's tangent there. Components/SplineComponent.h
  • BlueprintCallable
  • Category=Spline

float GetTimeAtDistanceAlongSpline ( float Distance
) const

 Given a distance along the length of this spline, return the corresponding time at that point Components/SplineComponent.h
  • BlueprintCallable
  • Category=Spline

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

 Given a distance along the length of this spline, return an FTransform corresponding to that point on the spline. Components/SplineComponent.h
  • BlueprintCallable
  • Category=Spline

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

 Get transform at the provided input key value Components/SplineComponent.h
  • BlueprintCallable
  • Category=Spline

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

 Get the transform at spline point Components/SplineComponent.h
  • BlueprintCallable
  • Category=Spline

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

 Given a time from 0 to the spline duration, return the spline's transform at the corresponding position. Components/SplineComponent.h
  • BlueprintCallable
  • Category=Spline

FVector GetUpVectorAtDistanceAlongSpline ( float Distance,
ESplineCoordinateSpace::Type CoordinateSpace
) const

 Given a distance along the length of this spline, return a unit direction vector corresponding to the spline's up vector there. Components/SplineComponent.h
  • BlueprintCallable
  • Category=Spline

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

 Get up vector at the provided input key value Components/SplineComponent.h
  • BlueprintCallable
  • Category=Spline

FVector GetUpVectorAtSplinePoint ( int32 PointIndex,
ESplineCoordinateSpace::Type CoordinateSpace
) const

 Get the up vector at spline point Components/SplineComponent.h
  • BlueprintCallable
  • Category=Spline

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

 Given a time from 0 to the spline duration, return the spline's up vector there. Components/SplineComponent.h
  • BlueprintCallable
  • Category=Spline

FVector GetVectorPropertyAtSplinePoint ( int32 Index,
FName PropertyName
) const

 Get a metadata property vector value along the spline at spline point Components/SplineComponent.h
  • BlueprintCallable
  • Category=Spline

int32 GetVersion()

   Components/SplineComponent.h  

FVector GetWorldDirectionAtDistanceAlongSpline ( float Distance
) const

 Given a distance along the length of this spline, return a unit direction vector of the spline tangent there, in world space. Components/SplineComponent.h
  • BlueprintCallable
  • Category=Spline
  • Meta=(DeprecatedFunction, DeprecationMessage="Please use GetDirectionAtDistanceAlongSpline, specifying SplineCoordinateSpace::World")

FVector GetWorldDirectionAtTime ( float Time,
bool bUseConstantVelocity
) const

 Given a time from 0 to the spline duration, return a unit direction vector of the spline tangent there. Components/SplineComponent.h
  • BlueprintCallable
  • Category=Spline
  • Meta=(DeprecatedFunction, DeprecationMessage="Please use GetDirectionAtTime, specifying SplineCoordinateSpace::World")

FVector GetWorldLocationAtDistanceAlongSpline ( float Distance
) const

 Given a distance along the length of this spline, return the point in world space where this puts you Components/SplineComponent.h
  • BlueprintCallable
  • Category=Spline
  • Meta=(DeprecatedFunction, DeprecationMessage="Please use GetLocationAtDistanceAlongSpline, specifying SplineCoordinateSpace::World")

FVector GetWorldLocationAtSplinePoint ( int32 PointIndex
) const

 Get the world location at spline point Components/SplineComponent.h
  • BlueprintCallable
  • Category=Spline
  • Meta=(DeprecatedFunction, DeprecationMessage="Please use GetLocationAtSplinePoint, specifying SplineCoordinateSpace::World")

FVector GetWorldLocationAtTime ( float Time,
bool bUseConstantVelocity
) const

 Given a time from 0 to the spline duration, return the point in space where this puts you Components/SplineComponent.h
  • BlueprintCallable
  • Category=Spline
  • Meta=(DeprecatedFunction, DeprecationMessage="Please use GetLocationAtTime, specifying SplineCoordinateSpace::World")

FRotator GetWorldRotationAtDistanceAlongSpline ( float Distance
) const

 Given a distance along the length of this spline, return a rotation corresponding to the spline's rotation there, in world space. Components/SplineComponent.h
  • BlueprintCallable
  • Category=Spline
  • Meta=(DeprecatedFunction, DeprecationMessage="Please use GetRotationAtDistanceAlongSpline, specifying SplineCoordinateSpace::World")

FRotator GetWorldRotationAtTime ( float Time,
bool bUseConstantVelocity
) const

 Given a time from 0 to the spline duration, return a rotation corresponding to the spline's position and direction there, in world space. Components/SplineComponent.h
  • BlueprintCallable
  • Category=Spline
  • Meta=(DeprecatedFunction, DeprecationMessage="Please use GetRotationAtTime, specifying SplineCoordinateSpace::World")

FVector GetWorldTangentAtDistanceAlongSpline ( float Distance
) const

 Given a distance along the length of this spline, return the tangent vector of the spline there, in world space. Components/SplineComponent.h
  • BlueprintCallable
  • Category=Spline
  • Meta=(DeprecatedFunction, DeprecationMessage="Please use GetTangentAtDistanceAlongSpline, specifying SplineCoordinateSpace::World")

bool IsClosedLoop()

 Check whether the spline is a closed loop or not Components/SplineComponent.h
  • BlueprintCallable
  • Category=Spline

void PopulateFromLegacy()

   Components/SplineComponent.h
  • CallInEditor
  • Category="Spline"

void RemovePropertyAtIndex ( int32 Index,
FName PropertyName
)

 Remove an attribute value by index. Components/SplineComponent.h
  • BlueprintCallable
  • Category="Spline|Metadata"

bool RemovePropertyChannel ( FName PropertyName
)

 Remove an attribute channel. Components/SplineComponent.h
  • BlueprintCallable
  • Category="Spline|Metadata"

void RemoveSplinePoint ( int32 Index,
bool bUpdateSpline
)

 Removes point at specified index from the spline Components/SplineComponent.h
  • BlueprintCallable
  • Category=Spline

void ResetToDefault()

 Reset the spline to its default shape (a spline of two points) Components/SplineComponent.h  

void SetClosedLoop ( bool bInClosedLoop,
bool bUpdateSpline
)

 Specify whether the spline is a closed loop or not. Components/SplineComponent.h
  • BlueprintCallable
  • Category=Spline

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 Components/SplineComponent.h
  • BlueprintCallable
  • Category=Spline

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

 Sets the default up vector used by this spline Components/SplineComponent.h
  • BlueprintCallable
  • Category=Spline

void SetDrawDebug ( bool bShow
)

 Specify whether this spline should be rendered when the Editor/Game spline show flag is set Components/SplineComponent.h
  • BlueprintCallable
  • Category=Spline

void SetFloatPropertyAtIndex ( int32 Index,
float Value,
FName PropertyName
)

 Set a float attribute value by index. Components/SplineComponent.h
  • BlueprintCallable
  • Category="Spline|Metadata"

int32 SetFloatPropertyAtSplineInputKey ( float InKey,
float Value,
FName PropertyName
) const

 Add a float attribute value by parameter. Components/SplineComponent.h
  • BlueprintCallable
  • Category="Spline|Metadata"

int32 SetFloatPropertyInputKeyAtIndex ( int32 Index,
float InKey,
FName PropertyName
)

 Set a float attribute parameter by index. Components/SplineComponent.h
  • BlueprintCallable
  • Category="Spline|Metadata"

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

 Move an existing point to a new location Components/SplineComponent.h
  • BlueprintCallable
  • Category=Spline

virtual void SetOverrideConstructionScript ( bool InOverride
)

 Set the spline to be edited outside of the construction script Components/SplineComponent.h
  • BlueprintCallable
  • Category=Spline

void SetQuaternionAtSplinePoint ( int32 PointIndex,
const FQuat& InQuaternion,
ESplineCoordinateSpace::Type CoordinateSpace,
bool bUpdateSpline
)

   Components/SplineComponent.h
  • BlueprintCallable
  • Category=Spline

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

 Set the rotation of an existing spline point. Components/SplineComponent.h
  • BlueprintCallable
  • Category=Spline

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

 Set the scale at a given spline point Components/SplineComponent.h
  • BlueprintCallable
  • Category=Spline

void SetSelectedSplineSegmentColor ( const FLinearColor& SegmentColor
)

 Specify selected spline component segment color in the editor Components/SplineComponent.h
  • BlueprintCallable
  • Category=Editor

void SetSpline ( const FSpline& InSpline
)

   Components/SplineComponent.h  

void SetSpline ( const FSplineCurves& InSplineCurves
)

   Components/SplineComponent.h  

void SetSplineLocalPoints ( const TArray< FVector >& Points
)

 Sets the spline to an array of local space points Components/SplineComponent.h
  • BlueprintCallable
  • Category=Spline
  • Meta=(DeprecatedFunction, DeprecationMessage="Please use SetSplinePoints, specifying SplineCoordinateSpace::Local")

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

 Sets the spline to an array of points Components/SplineComponent.h
  • BlueprintCallable
  • Category=Spline

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

 Specify the type of a spline point Components/SplineComponent.h
  • BlueprintCallable
  • Category=Spline

void SetSplineWorldPoints ( const TArray< FVector >& Points
)

 Sets the spline to an array of world space points Components/SplineComponent.h
  • BlueprintCallable
  • Category=Spline
  • Meta=(DeprecatedFunction, DeprecationMessage="Please use SetSplinePoints, specifying SplineCoordinateSpace::World")

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

 Specify the tangent at a given spline point Components/SplineComponent.h
  • BlueprintCallable
  • Category=Spline

void SetTangentColor ( const FLinearColor& TangentColor
)

 Specify selected spline component segment color in the editor Components/SplineComponent.h
  • BlueprintCallable
  • Category=Editor

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

 Specify the tangents at a given spline point Components/SplineComponent.h
  • BlueprintCallable
  • Category=Spline

void SetUnselectedSplineSegmentColor ( const FLinearColor& SegmentColor
)

 Specify unselected spline component segment color in the editor Components/SplineComponent.h
  • BlueprintCallable
  • Category=Editor

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

 Specify the up vector at a given spline point Components/SplineComponent.h
  • BlueprintCallable
  • Category=Spline

void SetWorldLocationAtSplinePoint ( int32 PointIndex,
const FVector& InLocation
)

 Move an existing point to a new world location Components/SplineComponent.h
  • BlueprintCallable
  • Category=Spline
  • Meta=(DeprecatedFunction, DeprecationMessage="Please use SetLocationAtSplinePoint, specifying SplineCoordinateSpace::World")

bool SupportsAttributes()

   Components/SplineComponent.h
  • BlueprintCallable
  • Category="Spline|Metadata"

void SynchronizeSplines()

 Reset all spline data to match the current state of SplineCurves Components/SplineComponent.h  

virtual void UpdateSpline()

 Update the spline tangents and SplineReparamTable Components/SplineComponent.h
  • BlueprintCallable
  • Category=Spline

Overridden from UPrimitiveComponent

Name Remarks Include Path Unreal Specifiers

virtual FPrimitiveSceneProxy * CreateSceneProxy()

 Creates a proxy to represent the primitive to the scene manager in the rendering thread. Components/SplineComponent.h  
Whether or not the bounds of this component should be considered when focusing the editor camera to an actor with this component in it. Components/SplineComponent.h  

virtual void GetUsedMaterials ( TArray< UMaterialInterface* >& OutMaterials,
bool bGetDebugMaterials
) const

 Retrieves the materials used in this component Components/SplineComponent.h  

virtual void PushSelectionToProxy()

 Pushes new selection state to the render thread primitive proxy Components/SplineComponent.h  

Overridden from USceneComponent

Name Remarks Include Path Unreal Specifiers

virtual FBoxSphereBounds CalcBounds ( const FTransform& LocalToWorld
) const

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

Overridden from UActorComponent

Name Remarks Include Path Unreal Specifiers

virtual TStructOnScope< FActorComponentInstanceData > GetComponentInstanceData()

 Called before we throw away components during RerunConstructionScripts, to cache any data we wish to persist across that operation Components/SplineComponent.h  

virtual void OnRegister()

 Called when a component is registered, after Scene is set, but before CreateRenderState_Concurrent or OnCreatePhysicsState are called. Components/SplineComponent.h  

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual void GetLifetimeReplicatedProps ( TArray< FLifetimeProperty >& OutLifetimeProps
) const

   Components/SplineComponent.h  

virtual void PostEditChangeChainProperty ( FPropertyChangedChainEvent& PropertyChangedEvent
)

   Components/SplineComponent.h  

virtual void PostLoad()

   Components/SplineComponent.h  

virtual void PostTransacted ( const FTransactionObjectEvent& TransactionEvent
)

   Components/SplineComponent.h  

virtual void Serialize ( FArchive& Ar
)

   Components/SplineComponent.h  

Protected

Name Remarks Include Path Unreal Specifiers

float GetSegmentLength ( const int32 Index,
const float Param
) const

 Returns the length of the specified spline segment up to the parametric value given Components/SplineComponent.h  

Static

Name Remarks Include Path Unreal Specifiers

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 Components/SplineComponent.h  

static FSpline GetDefaultSpline()

   Components/SplineComponent.h  

static FName GetSplinePropertyName()

 Return the name of the authoritative spline property. Components/SplineComponent.h  

static TSet< FName > GetSplinePropertyNames()

 Return the set of names of the backing spline properties. Components/SplineComponent.h  

Deprecated Variables

Name Type Remarks Include Path Unreal Specifiers
bAllowSplineEditingPerInstance_DEPRECATED bool   Components/SplineComponent.h  
SplineInfo_DEPRECATED FInterpCurveVector Deprecated - please use GetSplinePointsPosition() to fetch this FInterpCurve Components/SplineComponent.h  
SplineReparamTable_DEPRECATED FInterpCurveFloat   Components/SplineComponent.h  
SplineRotInfo_DEPRECATED FInterpCurveQuat Deprecated - please use GetSplinePointsRotation() to fetch this FInterpCurve Components/SplineComponent.h  
SplineScaleInfo_DEPRECATED FInterpCurveVector Deprecated - please use GetSplinePointsScale() to fetch this FInterpCurve Components/SplineComponent.h  

See Also

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page