Choose your operating system:
Windows
macOS
Linux
Module |
|
Header |
/Engine/Source/Runtime/Engine/Classes/Components/SplineComponent.h |
Include |
#include "Components/SplineComponent.h" |
class USplineComponent : public UPrimitiveComponent
A spline component is a spline shape which can be used for other purposes (e.g. animating objects). It contains debug rendering capabilities.
Name | Description | ||
---|---|---|---|
|
bAllowDiscontinuousSpline |
Whether the spline's leave and arrive tangents can be different |
|
|
bDrawDebug |
If true, the spline will be rendered if the Splines showflag is set. |
|
|
bInputSplinePointsToConstructionScript |
Whether the spline points should be passed to the User Construction Script so they can be further manipulated by it. |
|
|
bModifiedByConstructionScript |
Whether the UCS has made changes to the spline points |
|
|
bShouldVisualizeScale |
Whether scale visualization should be displayed |
|
|
bSplineHasBeenEdited |
Whether the spline has been edited from its default by the spline component visualizer |
|
|
bStationaryEndpoints |
Whether the endpoints of the spline are considered stationary when traversing the spline at non-constant velocity. |
|
|
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 |
|
EditorSelectedSplineSegmentColor |
Color of selected spline component parts in the editor |
|
|
EditorTangentColor |
Color of spline point tangents in the editor |
|
|
EditorUnselectedSplineSegmentColor |
Color of unselected spline component parts in the editor |
|
|
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 |
|
SplineCurves |
Name | Description | |
---|---|---|
|
USplineComponent ( |
Name | Description | ||
---|---|---|---|
|
AddPoint ( |
Adds an FSplinePoint to the spline. |
|
|
AddPoints ( |
Adds an array of FSplinePoints to the spline. |
|
|
AddSplineLocalPoint ( |
Adds a local space point to the spline |
|
|
AddSplinePoint ( |
Adds a point to the spline |
|
|
AddSplinePointAtIndex ( |
Adds a point to the spline at the specified index |
|
|
AddSplineWorldPoint ( |
Deprecated method definitions. |
|
|
AllowsSpinePointLocationEditing() |
Controls the visibility of the Spline point location editor in the details panel. |
|
|
AllowsSplinePointArriveTangentEditing() |
Controls the visibility of the Spline point arrive tangent editor in the details panel. |
|
|
AllowsSplinePointLeaveTangentEditing() |
Controls the visibility of the Spline point leave tangent editor in the details panel. |
|
|
AllowsSplinePointRotationEditing() |
Controls the visibility of the Spline point rotation editor in the details panel. |
|
|
AllowsSplinePointScaleEditing() |
Controls the visibility of the Spline point scale editor in the details panel. |
|
|
ApplyComponentInstanceData ( |
||
|
ClearSplinePoints ( |
Clears all the points in the spline |
|
|
ConvertSplineSegmentToPolyLine ( |
Given a threshold, returns a list of vertices along the spline segment that, treated as a list of segments (polyline), matches the spline shape. |
|
|
ConvertSplineToPolyLine ( |
Given a threshold, returns a list of vertices along the spline that, treated as a list of segments (polyline), matches the spline shape. |
|
|
DivideSplineIntoPolylineRecursive ( |
Given a threshold, recursively sub-divides the spline section until the list of segments (polyline) matches the spline shape. |
|
|
Draw ( |
Helper function to draw a vector curve |
|
|
FindDirectionClosestToWorldLocation ( |
Given a location, in world space, return a unit direction vector of the spline tangent closest to the location. |
|
|
float |
FindInputKeyClosestToWorldLocation ( |
Given a location, in world space, return the input key closest to that location. |
|
FindLocationClosestToWorldLocation ( |
Given a location, in world space, return the point on the curve that is closest to the location. |
|
|
FindQuaternionClosestToWorldLocation ( |
Given a location, in world space, return a quaternion corresponding to the spline's rotation closest to the location. |
|
|
FindRightVectorClosestToWorldLocation ( |
Given a location, in world space, return a unit direction vector corresponding to the spline's right vector closest to the location. |
|
|
float |
FindRollClosestToWorldLocation ( |
Given a location, in world space, return the spline's roll closest to the location, in degrees. |
|
FindRotationClosestToWorldLocation ( |
Given a location, in world space, return rotation corresponding to the spline's rotation closest to the location. |
|
|
FindScaleClosestToWorldLocation ( |
Given a location, in world space, return the spline's scale closest to the location. |
|
|
FindTangentClosestToWorldLocation ( |
Given a location, in world space, return the tangent vector of the spline closest to the location. |
|
|
FindTransformClosestToWorldLocation ( |
Given a location, in world space, return an FTransform closest to that location. |
|
|
FindUpVectorClosestToWorldLocation ( |
Given a location, in world space, return a unit direction vector corresponding to the spline's up vector closest to the location. |
|
|
GetArriveTangentAtSplinePoint ( |
Get the arrive tangent at spline point |
|
|
GetDefaultUpVector ( |
Gets the default up vector used by this spline |
|
|
GetDirectionAtDistanceAlongSpline ( |
Given a distance along the length of this spline, return a unit direction vector of the spline tangent there. |
|
|
GetDirectionAtSplineInputKey ( |
Get unit direction along spline at the provided input key value |
|
|
GetDirectionAtSplinePoint ( |
Get the direction at spline point |
|
|
GetDirectionAtTime ( |
Given a time from 0 to the spline duration, return a unit direction vector of the spline tangent there. |
|
|
float |
GetDistanceAlongSplineAtSplineInputKey ( |
Get distance along the spline at the provided input key value |
|
float |
GetDistanceAlongSplineAtSplinePoint ( |
Get the distance along the spline at the spline point |
|
GetEnabledSplinePointTypes() |
Get the enabled Spline Point types for this spline component. |
|
|
float |
GetFloatPropertyAtSplineInputKey ( |
Get a metadata property float value along the spline at spline input key |
|
float |
GetFloatPropertyAtSplinePoint |
Get a metadata property float value along the spline at spline point |
|
float |
GetInputKeyAtDistanceAlongSpline ( |
Given a distance along the length of this spline, return the corresponding input key at that point |
|
GetLeaveTangentAtSplinePoint ( |
Get the leave tangent at spline point |
|
|
GetLocalLocationAndTangentAtSplinePoint |
Get local location and tangent at a spline point |
|
|
GetLocationAndTangentAtSplinePoint ( |
Get location and tangent at a spline point |
|
|
GetLocationAtDistanceAlongSpline ( |
Given a distance along the length of this spline, return the point in space where this puts you |
|
|
GetLocationAtSplineInputKey ( |
Get location along spline at the provided input key value |
|
|
GetLocationAtSplinePoint ( |
Get the location at spline point |
|
|
GetLocationAtTime ( |
Given a time from 0 to the spline duration, return the point in space where this puts you |
|
|
GetNumberOfSplinePoints() |
Get the number of points that make up this spline |
|
|
GetNumberOfSplineSegments() |
Get the number of segments that make up this spline |
|
|
GetQuaternionAtDistanceAlongSpline ( |
Given a distance along the length of this spline, return a quaternion corresponding to the spline's rotation there. |
|
|
GetQuaternionAtSplineInputKey ( |
Get quaternion corresponding to rotation along spline at the provided input key value |
|
|
GetQuaternionAtSplinePoint ( |
Get the rotation at spline point as a quaternion |
|
|
GetQuaternionAtTime ( |
Given a time from 0 to the spline duration, return a quaternion corresponding to the spline's rotation there. |
|
|
GetRightVectorAtDistanceAlongSpline ( |
Given a distance along the length of this spline, return a unit direction vector corresponding to the spline's right vector there. |
|
|
GetRightVectorAtSplineInputKey ( |
Get right vector at the provided input key value |
|
|
GetRightVectorAtSplinePoint ( |
Get the right vector at spline point |
|
|
GetRightVectorAtTime ( |
Given a time from 0 to the spline duration, return the spline's right vector there. |
|
|
float |
GetRollAtDistanceAlongSpline ( |
Given a distance along the length of this spline, return the spline's roll there, in degrees. |
|
float |
GetRollAtSplineInputKey ( |
Get roll in degrees at the provided input key value |
|
float |
GetRollAtSplinePoint ( |
Get the amount of roll at spline point, in degrees |
|
float |
GetRollAtTime ( |
Given a time from 0 to the spline duration, return the spline's roll there, in degrees. |
|
GetRotationAtDistanceAlongSpline ( |
Given a distance along the length of this spline, return a rotation corresponding to the spline's rotation there. |
|
|
GetRotationAtSplineInputKey ( |
Get rotator corresponding to rotation along spline at the provided input key value |
|
|
GetRotationAtSplinePoint ( |
Get the rotation at spline point as a rotator |
|
|
GetRotationAtTime ( |
Given a time from 0 to the spline duration, return a rotation corresponding to the spline's position and direction there. |
|
|
GetScaleAtDistanceAlongSpline ( |
Given a distance along the length of this spline, return the spline's scale there. |
|
|
GetScaleAtSplineInputKey ( |
Get scale at the provided input key value |
|
|
GetScaleAtSplinePoint ( |
Get the scale at spline point |
|
|
GetScaleAtTime ( |
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 ( |
Get the type of a spline point |
|
GetTangentAtDistanceAlongSpline ( |
Given a distance along the length of this spline, return the tangent vector of the spline there. |
|
|
GetTangentAtSplineInputKey ( |
Get tangent along spline at the provided input key value |
|
|
GetTangentAtSplinePoint ( |
Get the tangent at spline point. This fetches the Leave tangent of the point. |
|
|
GetTangentAtTime ( |
Given a time from 0 to the spline duration, return the spline's tangent there. |
|
|
GetTransformAtDistanceAlongSpline ( |
Given a distance along the length of this spline, return an FTransform corresponding to that point on the spline. |
|
|
GetTransformAtSplineInputKey ( |
Get transform at the provided input key value |
|
|
GetTransformAtSplinePoint ( |
Get the transform at spline point |
|
|
GetTransformAtTime ( |
Given a time from 0 to the spline duration, return the spline's transform at the corresponding position. |
|
|
GetUpVectorAtDistanceAlongSpline ( |
Given a distance along the length of this spline, return a unit direction vector corresponding to the spline's up vector there. |
|
|
GetUpVectorAtSplineInputKey ( |
Get up vector at the provided input key value |
|
|
GetUpVectorAtSplinePoint ( |
Get the up vector at spline point |
|
|
GetUpVectorAtTime ( |
Given a time from 0 to the spline duration, return the spline's up vector there. |
|
|
GetVectorPropertyAtSplineInputKey ( |
Get a metadata property vector value along the spline at spline input key |
|
|
GetVectorPropertyAtSplinePoint |
Get a metadata property vector value along the spline at spline point |
|
|
GetWorldDirectionAtDistanceAlongSpline ( |
Given a distance along the length of this spline, return a unit direction vector of the spline tangent there, in world space. |
|
|
GetWorldDirectionAtTime ( |
Given a time from 0 to the spline duration, return a unit direction vector of the spline tangent there. |
|
|
GetWorldLocationAtDistanceAlongSpline ( |
Given a distance along the length of this spline, return the point in world space where this puts you |
|
|
GetWorldLocationAtSplinePoint ( |
Get the world location at spline point |
|
|
GetWorldLocationAtTime ( |
Given a time from 0 to the spline duration, return the point in space where this puts you |
|
|
GetWorldRotationAtDistanceAlongSpline ( |
Given a distance along the length of this spline, return a rotation corresponding to the spline's rotation there, in world space. |
|
|
GetWorldRotationAtTime ( |
Given a time from 0 to the spline duration, return a rotation corresponding to the spline's position and direction there, in world space. |
|
|
GetWorldTangentAtDistanceAlongSpline ( |
Given a distance along the length of this spline, return the tangent vector of the spline there, in world space. |
|
|
IsClosedLoop() |
Check whether the spline is a closed loop or not |
|
|
RemoveSplinePoint |
Removes point at specified index from the spline |
|
|
SetClosedLoop |
Specify whether the spline is a closed loop or not. |
|
|
SetClosedLoopAtPosition |
Specify whether the spline is a closed loop or not, and if so, the input key corresponding to the loop point |
|
|
SetDefaultUpVector ( |
Sets the default up vector used by this spline |
|
|
SetDrawDebug ( |
Specify whether this spline should be rendered when the Editor/Game spline show flag is set |
|
|
SetLocationAtSplinePoint ( |
Move an existing point to a new location |
|
|
SetRotationAtSplinePoint ( |
Set the rotation of an existing spline point |
|
|
SetScaleAtSplinePoint |
Set the scale at a given spline point |
|
|
SetSelectedSplineSegmentColor ( |
Specify selected spline component segment color in the editor |
|
|
SetSplineLocalPoints |
Sets the spline to an array of local space points |
|
|
SetSplinePoints ( |
Sets the spline to an array of points |
|
|
SetSplinePointType ( |
Specify the type of a spline point |
|
|
SetSplineWorldPoints |
Sets the spline to an array of world space points |
|
|
SetTangentAtSplinePoint ( |
Specify the tangent at a given spline point |
|
|
SetTangentColor ( |
Specify selected spline component segment color in the editor |
|
|
SetTangentsAtSplinePoint ( |
Specify the tangents at a given spline point |
|
|
SetUnselectedSplineSegmentColor ( |
Specify unselected spline component segment color in the editor |
|
|
SetUpVectorAtSplinePoint ( |
Specify the up vector at a given spline point |
|
|
SetWorldLocationAtSplinePoint |
Move an existing point to a new world location |
|
|
UpdateSpline() |
Update the spline tangents and SplineReparamTable |
Name | Description | ||
---|---|---|---|
|
FPrimitiveSc... |
CreateSceneProxy() |
Creates a proxy to represent the primitive to the scene manager in the rendering thread. |
|
IgnoreBoundsForEditorFocus() |
Whether or not the bounds of this component should be considered when focusing the editor camera to an actor with this component in it. |
Name | Description | ||
---|---|---|---|
|
FBoxSphereBo... |
CalcBounds ( |
Calculate the bounds of the component. Default behavior is a bounding box/sphere of zero size. |
Name | Description | ||
---|---|---|---|
|
TStructOnSco... |
GetComponentInstanceData() |
Called before we throw away components during RerunConstructionScripts, to cache any data we wish to persist across that operation |
Name | Description | ||
---|---|---|---|
|
PostEditChangeChainProperty ( |
This alternate version of PostEditChange is called when properties inside structs are modified. |
|
|
PostLoad() |
Do any object-specific cleanup required immediately after loading an object. |
|
|
Serialize ( |
Handles reading, writing, and reference collecting using FArchive. |
Name |
Description |
---|---|
DummyPointPosition |
The dummy value used for queries when there are no point in a spline |
DummyPointRotation |
|
DummyPointScale |
Name | Description | ||
---|---|---|---|
|
bAllowSplineEditingPerInstance_DEPRECATED |
||
|
SplineInfo_DEPRECATED |
Deprecated - please use GetSplinePointsPosition() to fetch this FInterpCurve |
|
|
SplineReparamTable_DEPRECATED |
||
|
SplineRotInfo_DEPRECATED |
Deprecated - please use GetSplinePointsRotation() to fetch this FInterpCurve |
|
|
SplineScaleInfo_DEPRECATED |
Deprecated - please use GetSplinePointsScale() to fetch this FInterpCurve |