Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Runtime > Engine > Components > USplineMeshComponent

Light Theme

Dark Theme

USplineMeshComponent

A Spline Mesh Component is a derivation of a Static Mesh Component which can be deformed using a spline.

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UActorComponent

USceneComponent

UPrimitiveComponent

UMeshComponent

UStaticMeshComponent

USplineMeshComponent

References

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

Syntax

class USplineMeshComponent :
public UStaticMeshComponent,
public IInterface_CollisionDataProvider

Remarks

A Spline Mesh Component is a derivation of a Static Mesh Component which can be deformed using a spline. Only a start and end position (and tangent) can be specified.

Variables

	Name	Description
uint8: 1	bAllowSplineEditingPerInstance	If true, spline keys may be edited per instance in the level viewport.
uint8: 1	bMeshDirty	Indicates that the mesh needs updating.
UBodySetup *...	BodySetup	Physics data.
uint8: 1	bSelected
uint8: 1	bSmoothInterpRollScale	If true, will use smooth interpolation (ease in/out) for Scale, Roll, and Offset along this section of spline.
FGuid	CachedMeshBodySetupGuid	Used to automatically trigger rebuild of collision data.
TEnumAsByte< ES...	ForwardAxis	Chooses the forward axis for the spline mesh orientation
float	SplineBoundaryMax	Maximum coordinate along the spline forward axis which corresponds to end of spline.
float	SplineBoundaryMin	Minimum coordinate along the spline forward axis which corresponds to start of spline.
FSplineMeshPara...	SplineParams	Spline that is used to deform mesh
FVector	SplineUpDir	Axis (in component space) that is used to determine X axis for co-ordinates along spline
float	VirtualTextureMainPassMaxDrawDistance	The max draw distance to use in the main pass when also rendering to a runtime virtual texture.

Constructors

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

Functions

	Name	Description
void	ApplyComponentInstanceData ( FSplineMeshInstanceData* Compo... )
FTransform	CalcSliceTransform ( const float DistanceAlong )	Calculates the spline transform, including roll, scale, and offset along the spline at a specified distance
FTransform	CalcSliceTransformAtSplineOffset ( const float Alpha )	Calculates the spline transform, including roll, scale, and offset along the spline at a specified alpha interpolation parameter along the spline : This is mirrored to Lightmass::CalcSliceTransform() and LocalVertexShader.usf.
void	CalculateScaleZAndMinZ ( float& OutScaleZ, float& OutMinZ )	Determines the mesh proxy values for SplineMeshScaleZ and SplineMeshMinZ
void	DestroyBodySetup()	Destroys the body setup, used to clear collision if the mesh goes missing.
FVector	GetAxisMask ( ESplineMeshAxis::Type InAxis )	Returns a vector which, when componentwise-multiplied by another vector, will zero all the components not corresponding to the supplied ESplineMeshAxis
const float ...	GetAxisValue ( const FVector& InVector, ESplineMeshAxis::Type InAxis )
float &	GetAxisValue ( FVector& InVector, ESplineMeshAxis::Type InAxis )
float	GetBoundaryMax()	Get the boundary max
float	GetBoundaryMin()	Get the boundary min
FVector2D	GetEndOffset()	Get the end offset
FVector	GetEndPosition()	Get the end position of spline in local space
float	GetEndRoll()	Get the end roll
FVector2D	GetEndScale()	Get the end scaling
FVector	GetEndTangent()	Get the end tangent vector of spline in local space
ESplineMeshA...	GetForwardAxis()	Get the forward axis
FVector	GetSplineUpDir()	Get the spline up direction
FVector2D	GetStartOffset()	Get the start offset
FVector	GetStartPosition()	Get the start position of spline in local space
float	GetStartRoll()	Get the start roll
FVector2D	GetStartScale()	Get the start scaling
FVector	GetStartTangent()	Get the start tangent vector of spline in local space
void	RecreateCollision()	Builds collision for the spline mesh (if collision is enabled)
void	SetBoundaryMax ( float InBoundaryMax, bool bUpdateMesh )	Set the boundary max
void	SetBoundaryMin ( float InBoundaryMin, bool bUpdateMesh )	Set the boundary min
void	SetEndOffset ( FVector2D EndOffset, bool bUpdateMesh )	Set the end offset
void	SetEndPosition ( FVector EndPos, bool bUpdateMesh )	Set the end position of spline in local space
void	SetEndRoll ( float EndRoll, bool bUpdateMesh )	Set the end roll
void	SetEndScale ( FVector2D EndScale, bool bUpdateMesh )	Set the end scaling
void	SetEndTangent ( FVector EndTangent, bool bUpdateMesh )	Set the end tangent vector of spline in local space
void	SetForwardAxis ( ESplineMeshAxis::Type InForwardAxis, bool bUpdateMesh )	Set the forward axis
void	SetSplineUpDir ( const FVector& InSplineUpDir, bool bUpdateMesh )	Set the spline up direction
void	SetStartAndEnd ( FVector StartPos, FVector StartTangent, FVector EndPos, FVector EndTangent, bool bUpdateMesh )	Set the start and end, position and tangent, all in local space
void	SetStartOffset ( FVector2D StartOffset, bool bUpdateMesh )	Set the start offset
void	SetStartPosition ( FVector StartPos, bool bUpdateMesh )	Set the start position of spline in local space
void	SetStartRoll ( float StartRoll, bool bUpdateMesh )	Set the start roll
void	SetStartScale ( FVector2D StartScale, bool bUpdateMesh )	Set the start scaling
void	SetStartTangent ( FVector StartTangent, bool bUpdateMesh )	Set the start tangent vector of spline in local space
void	UpdateMesh()	Update the collision and render state on the spline mesh following changes to its geometry
void	UpdateMesh_Concurrent()	Same as UpdateMesh, but does not wait until the end of frame and can be used in non-game threads
void	UpdateRenderStateAndCollision()	Called to notify render thread and possibly collision of a change in spline params or mesh

Overridden from UStaticMeshComponent

		Name	Description
	FStaticMeshS...	AllocateStaticLightingMesh ( int32 LODIndex, const TArray< ULightComponent*... )	Allocates an implementation of FStaticLightingMesh that will handle static lighting for this component
	float	GetTextureStreamingTransformScale()	Get the scale comming form the component, when computing StreamingTexture data.

Overridden from UPrimitiveComponent

	Name	Description
FPrimitiveSc...	CreateSceneProxy()	Creates a proxy to represent the primitive to the scene manager in the rendering thread.
bool	DoCustomNavigableGeometryExport ( FNavigableGeometryExport& GeomExpo... )	Collects custom navigable geometry of component.
UBodySetup &...	GetBodySetup()	Return the BodySetup to use for this PrimitiveComponent (single body case)
float	GetVirtualTextureMainPassMaxDrawDistance()	Get the max draw distance to use in the main pass when also rendering to a runtime virtual texture.
bool	ShouldRenderSelected()	Return true if the owner is selected and this component is selectable

Overridden from USceneComponent

		Name	Description
	FBoxSphereBo...	CalcBounds ( const FTransform& LocalToWorld )	Calculate the bounds of the component. Default behavior is a bounding box/sphere of zero size.
	FTransform	GetSocketTransform ( FName InSocketName, ERelativeTransformSpace TransformSp... )	Get world-space socket transform.

Overridden from UActorComponent

		Name	Description
	TStructOnSco...	GetComponentInstanceData()	Called before we throw away components during RerunConstructionScripts, to cache any data we wish to persist across that operation
	void	OnCreatePhysicsState()	Used to create any physics engine information for this component

Overridden from UObject

	Name	Description
bool	Modify ( bool bAlwaysMarkDirty )	Note that the object will be modified.
void	PostEditChangeProperty ( FPropertyChangedEvent& PropertyCha... )	Called when a property on this object has been modified externally
void	Serialize ( FArchive& Ar )	Handles reading, writing, and reference collecting using FArchive.

Overridden from IInterface_CollisionDataProvider

	Name	Description
bool	ContainsPhysicsTriMeshData ( bool InUseAllTriData )	Interface for checking if the implementing objects contains triangle mesh collision data
void	GetMeshId ( FString& OutMeshId )	An optional string identifying the mesh data.
bool	GetPhysicsTriMeshData ( FTriMeshCollisionData* Collisi..., bool InUseAllTriData )	Interface for retrieving triangle mesh collision data from the implementing object
bool	WantsNegXTriMesh()	Do we want to create a negative version of this mesh

Deprecated Functions

		Name	Description
	void	MarkSplineParamsDirty()	This method has been renamed to UpdateRenderStateAndCollision, but use of UpdateMesh is preferred