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 | ||
---|---|---|---|
|
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 |
|
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 |
|
|
OnDeselectedInEditor |
||
|
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 |
|
SplineCurves |
Name | Description | |
---|---|---|
|
USplineComponent ( |
Name | Description | ||
---|---|---|---|
|
void |
AddPoint ( |
Adds an FSplinePoint to the spline. |
|
void |
AddPoints ( |
Adds an array of FSplinePoints to the spline. |
|
void |
AddSplineLocalPoint ( |
Adds a local space point to the spline |
|
void |
AddSplinePoint ( |
Adds a point to the spline |
|
void |
AddSplinePointAtIndex ( |
Adds a point to the spline at the specified index |
|
void |
AddSplineWorldPoint ( |
Deprecated method definitions. |
|
bool |
AllowsSpinePointLocationEditing() |
Controls the visibility of the Spline point location editor in the details panel. |
|
bool |
AllowsSplinePointArriveTangentEditing() |
Controls the visibility of the Spline point arrive tangent editor in the details panel. |
|
bool |
AllowsSplinePointLeaveTangentEditing() |
Controls the visibility of the Spline point leave tangent editor in the details panel. |
|
bool |
AllowsSplinePointRotationEditing() |
Controls the visibility of the Spline point rotation editor in the details panel. |
|
bool |
AllowsSplinePointScaleEditing() |
Controls the visibility of the Spline point scale editor in the details panel. |
|
void |
ApplyComponentInstanceData ( |
|
|
void |
ClearSplinePoints ( |
Clears all the points in the spline |
|
bool |
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. |
|
bool |
ConvertSplineToPolyLine ( |
Given a threshold, returns a list of vertices along the spline that, treated as a list of segments (polyline), matches the spline shape. |
|
bool |
DivideSplineIntoPolylineRecursive ( |
Given a threshold, recursively sub-divides the spline section until the list of segments (polyline) matches the spline shape. |
|
bool |
DivideSplineIntoPolylineRecursiveWithDistances ( |
Given a threshold, recursively sub-divides the spline section until the list of segments (polyline) matches the spline shape. |
|
void |
Draw ( |
Helper function to draw a vector curve |
|
FVector |
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. |
|
FVector |
FindLocationClosestToWorldLocation ( |
Given a location, in world space, return the point on the curve that is closest to the location. |
|
FQuat |
FindQuaternionClosestToWorldLocation ( |
Given a location, in world space, return a quaternion corresponding to the spline's rotation closest to the location. |
|
FVector |
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. |
|
FRotator |
FindRotationClosestToWorldLocation ( |
Given a location, in world space, return rotation corresponding to the spline's rotation closest to the location. |
|
FVector |
FindScaleClosestToWorldLocation ( |
Given a location, in world space, return the spline's scale closest to the location. |
|
FVector |
FindTangentClosestToWorldLocation ( |
Given a location, in world space, return the tangent vector of the spline closest to the location. |
|
FTransform |
FindTransformClosestToWorldLocation ( |
Given a location, in world space, return an FTransform closest to that location. |
|
FVector |
FindUpVectorClosestToWorldLocation ( |
Given a location, in world space, return a unit direction vector corresponding to the spline's up vector closest to the location. |
|
FVector |
GetArriveTangentAtSplinePoint ( |
Get the arrive tangent at spline point |
|
FVector |
GetDefaultUpVector ( |
Gets the default up vector used by this spline |
|
FVector |
GetDirectionAtDistanceAlongSpline ( |
Given a distance along the length of this spline, return a unit direction vector of the spline tangent there. |
|
FVector |
GetDirectionAtSplineInputKey ( |
Get unit direction along spline at the provided input key value |
|
FVector |
GetDirectionAtSplinePoint ( |
Get the direction at spline point |
|
FVector |
GetDirectionAtTime ( |
Given a time from 0 to the spline duration, return a unit direction vector of the spline tangent there. |
|
float |
GetDistanceAlongSplineAtLocation ( |
Get distance along the spline at closest point of the provided input location |
|
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 This method has been deprecated because it was incorrectly returning the input key at time. |
|
float |
GetInputKeyValueAtDistanceAlongSpline ( |
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. |
|
float |
GetInputKeyValueAtSplinePoint ( |
Get the input key (e.g. the time) of the control point of the spline at the specified index. |
|
FVector |
GetLeaveTangentAtSplinePoint ( |
Get the leave tangent at spline point |
|
void |
GetLocalLocationAndTangentAtSplinePoint ( |
Get local location and tangent at a spline point |
|
void |
GetLocationAndTangentAtSplinePoint ( |
Get location and tangent at a spline point |
|
FVector |
GetLocationAtDistanceAlongSpline ( |
Given a distance along the length of this spline, return the point in space where this puts you |
|
FVector |
GetLocationAtSplineInputKey ( |
Get location along spline at the provided input key value |
|
FVector |
GetLocationAtSplinePoint ( |
Get the location at spline point |
|
FVector |
GetLocationAtTime ( |
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 ( |
Given a distance along the length of this spline, return a quaternion corresponding to the spline's rotation there. |
|
FQuat |
GetQuaternionAtSplineInputKey ( |
Get quaternion corresponding to rotation along spline at the provided input key value |
|
FQuat |
GetQuaternionAtSplinePoint ( |
Get the rotation at spline point as a quaternion |
|
FQuat |
GetQuaternionAtTime ( |
Given a time from 0 to the spline duration, return a quaternion corresponding to the spline's rotation there. |
|
FVector |
GetRightVectorAtDistanceAlongSpline ( |
Given a distance along the length of this spline, return a unit direction vector corresponding to the spline's right vector there. |
|
FVector |
GetRightVectorAtSplineInputKey ( |
Get right vector at the provided input key value |
|
FVector |
GetRightVectorAtSplinePoint ( |
Get the right vector at spline point |
|
FVector |
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. |
|
FRotator |
GetRotationAtDistanceAlongSpline ( |
Given a distance along the length of this spline, return a rotation corresponding to the spline's rotation there. |
|
FRotator |
GetRotationAtSplineInputKey ( |
Get rotator corresponding to rotation along spline at the provided input key value |
|
FRotator |
GetRotationAtSplinePoint ( |
Get the rotation at spline point as a rotator |
|
FRotator |
GetRotationAtTime ( |
Given a time from 0 to the spline duration, return a rotation corresponding to the spline's position and direction there. |
|
FVector |
GetScaleAtDistanceAlongSpline ( |
Given a distance along the length of this spline, return the spline's scale there. |
|
FVector |
GetScaleAtSplineInputKey ( |
Get scale at the provided input key value |
|
FVector |
GetScaleAtSplinePoint ( |
Get the scale at spline point |
|
FVector |
GetScaleAtTime ( |
Given a time from 0 to the spline duration, return the spline's scale there. |
|
float |
GetSplineLength() |
Returns total length along this spline |
|
GetSplinePointAt ( |
Gets the spline point of the spline at the specified index |
|
|
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 |
|
FVector |
GetTangentAtDistanceAlongSpline ( |
Given a distance along the length of this spline, return the tangent vector of the spline there. |
|
FVector |
GetTangentAtSplineInputKey ( |
Get tangent along spline at the provided input key value |
|
FVector |
GetTangentAtSplinePoint ( |
Get the tangent at spline point. This fetches the Leave tangent of the point. |
|
FVector |
GetTangentAtTime ( |
Given a time from 0 to the spline duration, return the spline's tangent there. |
|
float |
GetTimeAtDistanceAlongSpline ( |
Given a distance along the length of this spline, return the corresponding time at that point |
|
FTransform |
GetTransformAtDistanceAlongSpline ( |
Given a distance along the length of this spline, return an FTransform corresponding to that point on the spline. |
|
FTransform |
GetTransformAtSplineInputKey ( |
Get transform at the provided input key value |
|
FTransform |
GetTransformAtSplinePoint ( |
Get the transform at spline point |
|
FTransform |
GetTransformAtTime ( |
Given a time from 0 to the spline duration, return the spline's transform at the corresponding position. |
|
FVector |
GetUpVectorAtDistanceAlongSpline ( |
Given a distance along the length of this spline, return a unit direction vector corresponding to the spline's up vector there. |
|
FVector |
GetUpVectorAtSplineInputKey ( |
Get up vector at the provided input key value |
|
FVector |
GetUpVectorAtSplinePoint ( |
Get the up vector at spline point |
|
FVector |
GetUpVectorAtTime ( |
Given a time from 0 to the spline duration, return the spline's up vector there. |
|
FVector |
GetVectorPropertyAtSplineInputKey ( |
Get a metadata property vector value along the spline at spline input key |
|
FVector |
GetVectorPropertyAtSplinePoint ( |
Get a metadata property vector value along the spline at spline point |
|
FVector |
GetWorldDirectionAtDistanceAlongSpline ( |
Given a distance along the length of this spline, return a unit direction vector of the spline tangent there, in world space. |
|
FVector |
GetWorldDirectionAtTime ( |
Given a time from 0 to the spline duration, return a unit direction vector of the spline tangent there. |
|
FVector |
GetWorldLocationAtDistanceAlongSpline ( |
Given a distance along the length of this spline, return the point in world space where this puts you |
|
FVector |
GetWorldLocationAtSplinePoint ( |
Get the world location at spline point |
|
FVector |
GetWorldLocationAtTime ( |
Given a time from 0 to the spline duration, return the point in space where this puts you |
|
FRotator |
GetWorldRotationAtDistanceAlongSpline ( |
Given a distance along the length of this spline, return a rotation corresponding to the spline's rotation there, in world space. |
|
FRotator |
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. |
|
FVector |
GetWorldTangentAtDistanceAlongSpline ( |
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 ( |
Removes point at specified index from the spline |
|
void |
ResetToDefault() |
Reset the spline to its default shape (a spline of two points) |
|
void |
SetClosedLoop ( |
Specify whether the spline is a closed loop or not. |
|
void |
SetClosedLoopAtPosition ( |
Specify whether the spline is a closed loop or not, and if so, the input key corresponding to the loop point |
|
void |
SetDefaultUpVector ( |
Sets the default up vector used by this spline |
|
void |
SetDrawDebug ( |
Specify whether this spline should be rendered when the Editor/Game spline show flag is set |
|
void |
SetLocationAtSplinePoint ( |
Move an existing point to a new location |
|
void |
SetRotationAtSplinePoint ( |
Set the rotation of an existing spline point |
|
void |
SetScaleAtSplinePoint ( |
Set the scale at a given spline point |
|
void |
SetSelectedSplineSegmentColor ( |
Specify selected spline component segment color in the editor |
|
void |
SetSplineLocalPoints ( |
Sets the spline to an array of local space points |
|
void |
SetSplinePoints ( |
Sets the spline to an array of points |
|
void |
SetSplinePointType ( |
Specify the type of a spline point |
|
void |
SetSplineWorldPoints ( |
Sets the spline to an array of world space points |
|
void |
SetTangentAtSplinePoint ( |
Specify the tangent at a given spline point |
|
void |
SetTangentColor ( |
Specify selected spline component segment color in the editor |
|
void |
SetTangentsAtSplinePoint ( |
Specify the tangents at a given spline point |
|
void |
SetUnselectedSplineSegmentColor ( |
Specify unselected spline component segment color in the editor |
|
void |
SetUpVectorAtSplinePoint ( |
Specify the up vector at a given spline point |
|
void |
SetWorldLocationAtSplinePoint ( |
Move an existing point to a new world location |
|
void |
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. |
|
bool |
GetIgnoreBoundsForEditorFocus() |
Whether or not the bounds of this component should be considered when focusing the editor camera to an actor with this component in it. |
|
void |
PushSelectionToProxy() |
Pushes new selection state to the render thread primitive proxy |
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 | ||
---|---|---|---|
|
void |
GetLifetimeReplicatedProps ( |
Returns properties that are replicated for the lifetime of the actor channel |
|
void |
PostEditChangeChainProperty ( |
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 ( |
Handles reading, writing, and reference collecting using FArchive. |
Name |
Description |
---|---|
DeselectedInEditorDelegate |
Delegate that's called when this component is deselected in the editor |
Name |
Description |
---|---|
DummyPointPosition |
The dummy value used for queries when there are no point in a spline |
DummyPointRotation |
|
DummyPointScale |
Name | Description | ||
---|---|---|---|
|
bool |
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 |