1. Epic GamesDeveloper
  3. USplineMeshComponent

USplineMeshComponent

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

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

Inheritance Hierarchy

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

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

Constructors

  Type Name Description
Public function  

USplineMeshComponent ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Public function void  
Public function Const FTransform

CalcSliceTransform ( const float DistanceAlong
)

 Calculates the spline transform, including roll, scale, and offset along the spline at a specified distance
Public function Const 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.
Public function Const FSplineMeshShaderParams Generates FSplineMeshShaderParams for the current state of the component
Public function void Destroys the body setup, used to clear collision if the mesh goes missing.
Public function Static FVector Returns a vector which, when componentwise-multiplied by another vector, will zero all the components not corresponding to the supplied ESplineMeshAxis
Public function Static double &

GetAxisValueRef ( FVector3d& InVector,
ESplineMeshAxis::Type InAxis
)

  
Public function Static const double &

GetAxisValueRef ( const FVector3d& InVector,
ESplineMeshAxis::Type InAxis
)

  
Public function Static const float &

GetAxisValueRef ( const FVector3f& InVector,
ESplineMeshAxis::Type InAxis
)

  
Public function Static float &

GetAxisValueRef ( FVector3f& InVector,
ESplineMeshAxis::Type InAxis
)

  
Public function Const bool Getter for bNeverNeedsCookedCollisionData
Public function Const float Get the boundary max
Public function Const float Get the boundary min
Public function Const FVector2D Get the end offset
Public function Const FVector Get the end position of spline in local space
Public function Const float Get the end roll, in radians
Public function Const FVector2D Get the end scaling
Public function Const FVector Get the end tangent vector of spline in local space
Public function Const ESplineMeshAxis::Type Get the forward axis
Public function Const FVector Get the spline up direction
Public function Const FVector2D Get the start offset
Public function Const FVector Get the start position of spline in local space
Public function Const float Get the start roll, in radians
Public function Const FVector2D Get the start scaling
Public function Const FVector Get the start tangent vector of spline in local space
Public function void Builds collision for the spline mesh (if collision is enabled)
Public function void Setter for bNeverNeedsCookedCollisionData
Public function void

SetBoundaryMax ( float InBoundaryMax,
bool bUpdateMesh
)

 Set the boundary max
Public function void

SetBoundaryMin ( float InBoundaryMin,
bool bUpdateMesh
)

 Set the boundary min
Public function void

SetEndOffset ( FVector2D EndOffset,
bool bUpdateMesh
)

 Set the end offset
Public function void

SetEndPosition ( FVector EndPos,
bool bUpdateMesh
)

 Set the end position of spline in local space
Public function void

SetEndRoll ( float EndRoll,
bool bUpdateMesh
)

 Set the end roll, in radians
Public function void

SetEndRollDegrees ( float EndRollDegrees,
bool bUpdateMesh
)

 Set the end roll in degrees
Public function void

SetEndScale ( FVector2D EndScale,
bool bUpdateMesh
)

 Set the end scaling
Public function void

SetEndTangent ( FVector EndTangent,
bool bUpdateMesh
)

 Set the end tangent vector of spline in local space
Public function void

SetForwardAxis ( ESplineMeshAxis::Type InForwardAxis,
bool bUpdateMesh
)

 Set the forward axis
Public function void

SetSplineUpDir ( const FVector& InSplineUpDir,
bool bUpdateMesh
)

 Set the spline up direction
Public function void

SetStartAndEnd ( FVector StartPos,
FVector StartTangent,
FVector EndPos,
FVector EndTangent,
bool bUpdateMesh
)

 Set the start and end, position and tangent, all in local space
Public function void

SetStartOffset ( FVector2D StartOffset,
bool bUpdateMesh
)

 Set the start offset
Public function void

SetStartPosition ( FVector StartPos,
bool bUpdateMesh
)

 Set the start position of spline in local space
Public function void

SetStartRoll ( float StartRoll,
bool bUpdateMesh
)

 Set the start roll, in radians
Public function void

SetStartRollDegrees ( float StartRollDegrees,
bool bUpdateMesh
)

 Set the start roll in degrees
Public function void

SetStartScale ( FVector2D StartScale,
bool bUpdateMesh
)

 Set the start scaling
Public function void

SetStartTangent ( FVector StartTangent,
bool bUpdateMesh
)

 Set the start tangent vector of spline in local space
Public function void Update the collision and render state on the spline mesh following changes to its geometry
Public function void Same as UpdateMesh, but does not wait until the end of frame and can be used in non-game threads
Public function void Called to notify render thread and possibly collision of a change in spline params or mesh

Overridden from UStaticMeshComponent

  Type Name Description
Public function Virtual FStaticMeshStaticLightingMesh *

AllocateStaticLightingMesh ( int32 LODIndex,
const TArray< ULightComponent* >& InRelevantLights
)

 Allocates an implementation of FStaticLightingMesh that will handle static lighting for this component
Protected function Virtual FPrimitiveSceneProxy *

CreateStaticMeshSceneProxy ( Nanite::FMaterialAudit& NaniteMaterials,
bool bCreateNanite
)

 Overload this in child implementations that wish to extend Static Mesh or Nanite scene proxy implementations.
Public function Virtual Const float Get the scale comming form the component, when computing StreamingTexture data.

Overridden from UPrimitiveComponent

  Type Name Description
Public function Virtual void

CollectPSOPrecacheData ( const FPSOPrecacheParams& BasePrecachePSOParams,
FComponentPSOPrecacheParamsList& OutParams
)

 Collect all the PSO precache data used by the static mesh component
Public function Virtual Const bool Collects custom navigable geometry of component.
Public function Virtual UBodySetup * Return the BodySetup to use for this PrimitiveComponent (single body case)
Public function Virtual Const float Get the max draw distance to use in the main pass when also rendering to a runtime virtual texture.
Public function Virtual Const bool Return true if the owner is selected and this component is selectable

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.
Public function Virtual Const FTransform

GetSocketTransform ( FName InSocketName,
ERelativeTransformSpace TransformSpace
)

 Get world-space socket transform.

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
Protected function Virtual void Used to create any physics engine information for this component

Overridden from UObject

  Type Name Description
Public function Virtual Const bool Returns whether this component is an editor-only object or not
Public function Virtual bool

Modify ( bool bAlwaysMarkDirty
)

 Note that the object will be modified.
Public function Virtual void

PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

 Called when a property on this object has been modified externally
Public function Virtual void Handles reading, writing, and reference collecting using FArchive.

Overridden from IInterface_CollisionDataProvider

  Type Name Description
Public function Virtual Const bool

ContainsPhysicsTriMeshData ( bool InUseAllTriData
)

 Interface for checking if the implementing objects contains triangle mesh collision data
Public function Virtual void

GetMeshId ( FString& OutMeshId
)

 An optional string identifying the mesh data.
Public function Virtual bool

GetPhysicsTriMeshData ( FTriMeshCollisionData* CollisionData,
bool InUseAllTriData
)

 Interface for retrieving triangle mesh collision data from the implementing object
Public function Virtual Const bool

GetTriMeshSizeEstimates ( FTriMeshCollisionDataEstimates& OutTriMeshEstimates,
bool bInUseAllTriData
)

 Returns an estimate of how much data would be retrieved by GetPhysicsTriMeshData.
Public function Virtual bool Do we want to create a negative version of this mesh

Deprecated Functions

  Type Name Description
Public function Static float &

GetAxisValue ( FVector3f& InVector,
ESplineMeshAxis::Type InAxis
)

 Use GetAxisValueRef() instead.
Public function Static const float &

GetAxisValue ( const FVector3f& InVector,
ESplineMeshAxis::Type InAxis
)

 Use GetAxisValueRef() instead.
Public function Static double &

GetAxisValue ( FVector3d& InVector,
ESplineMeshAxis::Type InAxis
)

 Use GetAxisValueRef() instead.
Public function Static const double &

GetAxisValue ( const FVector3d& InVector,
ESplineMeshAxis::Type InAxis
)

 Use GetAxisValueRef() instead.

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