Class SplineMeshComponent
A Spline Mesh Component is a derivation of a Static Mesh Component which can be deformed using a spline.
Inheritance
System.Object
SplineMeshComponent
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
Namespace: UE4.Engine
Assembly: UE4DotNet.dll
Syntax
public class SplineMeshComponent : StaticMeshComponentRemarks
Only a start and end position (and tangent) can be specified. @see https://docs.unrealengine.com/latest/INT/Resources/ContentExamples/Blueprint_Splines
Properties
| Improve this Doc View SourcebAllowSplineEditingPerInstance
Declaration
public bool bAllowSplineEditingPerInstance { get; set; }Property Value
| Type | Description |
|---|---|
| System.Boolean |
bMeshDirty
Declaration
public bool bMeshDirty { get; set; }Property Value
| Type | Description |
|---|---|
| System.Boolean |
BodySetup
Physics data.
Declaration
public BodySetup BodySetup { get; set; }Property Value
| Type | Description |
|---|---|
| BodySetup |
bSelected
Declaration
public bool bSelected { get; set; }Property Value
| Type | Description |
|---|---|
| System.Boolean |
bSmoothInterpRollScale
Declaration
public bool bSmoothInterpRollScale { get; set; }Property Value
| Type | Description |
|---|---|
| System.Boolean |
CachedMeshBodySetupGuid
Used to automatically trigger rebuild of collision data
Declaration
public FGuid CachedMeshBodySetupGuid { get; set; }Property Value
| Type | Description |
|---|---|
| FGuid |
DefaultObject
Get UE4 Default Object for this Class
Declaration
public static SplineMeshComponent DefaultObject { get; }Property Value
| Type | Description |
|---|---|
| SplineMeshComponent |
ForwardAxis
Chooses the forward axis for the spline mesh orientation
Declaration
public byte ForwardAxis { get; set; }Property Value
| Type | Description |
|---|---|
| System.Byte |
SplineBoundaryMax
Maximum coordinate along the spline forward axis which corresponds to end of spline. If set to 0.0, will use bounding box to determine bounds
Declaration
public float SplineBoundaryMax { get; set; }Property Value
| Type | Description |
|---|---|
| System.Single |
SplineBoundaryMin
Minimum coordinate along the spline forward axis which corresponds to start of spline. If set to 0.0, will use bounding box to determine bounds
Declaration
public float SplineBoundaryMin { get; set; }Property Value
| Type | Description |
|---|---|
| System.Single |
SplineParams
Spline that is used to deform mesh
Declaration
public SplineMeshParams SplineParams { get; set; }Property Value
| Type | Description |
|---|---|
| SplineMeshParams |
SplineUpDir
Axis (in component space) that is used to determine X axis for co-ordinates along spline
Declaration
public Vector SplineUpDir { get; set; }Property Value
| Type | Description |
|---|---|
| Vector |
StaticClass
Get UE4 Class
Declaration
public static Class StaticClass { get; }Property Value
| Type | Description |
|---|---|
| Class |
Methods
| Improve this Doc View SourceGetBoundaryMax()
Get the boundary max
Declaration
public float GetBoundaryMax()Returns
| Type | Description |
|---|---|
| System.Single |
GetBoundaryMin()
Get the boundary min
Declaration
public float GetBoundaryMin()Returns
| Type | Description |
|---|---|
| System.Single |
GetEndOffset()
Get the end offset
Declaration
public Vector2D GetEndOffset()Returns
| Type | Description |
|---|---|
| Vector2D |
GetEndPosition()
Get the end position of spline in local space
Declaration
public Vector GetEndPosition()Returns
| Type | Description |
|---|---|
| Vector |
GetEndRoll()
Get the end roll
Declaration
public float GetEndRoll()Returns
| Type | Description |
|---|---|
| System.Single |
GetEndScale()
Get the end scaling
Declaration
public Vector2D GetEndScale()Returns
| Type | Description |
|---|---|
| Vector2D |
GetEndTangent()
Get the end tangent vector of spline in local space
Declaration
public Vector GetEndTangent()Returns
| Type | Description |
|---|---|
| Vector |
GetForwardAxis()
Get the forward axis
Declaration
public byte GetForwardAxis()Returns
| Type | Description |
|---|---|
| System.Byte |
GetSplineUpDir()
Get the spline up direction
Declaration
public Vector GetSplineUpDir()Returns
| Type | Description |
|---|---|
| Vector |
GetStartOffset()
Get the start offset
Declaration
public Vector2D GetStartOffset()Returns
| Type | Description |
|---|---|
| Vector2D |
GetStartPosition()
Get the start position of spline in local space
Declaration
public Vector GetStartPosition()Returns
| Type | Description |
|---|---|
| Vector |
GetStartRoll()
Get the start roll
Declaration
public float GetStartRoll()Returns
| Type | Description |
|---|---|
| System.Single |
GetStartScale()
Get the start scaling
Declaration
public Vector2D GetStartScale()Returns
| Type | Description |
|---|---|
| Vector2D |
GetStartTangent()
Get the start tangent vector of spline in local space
Declaration
public Vector GetStartTangent()Returns
| Type | Description |
|---|---|
| Vector |
New(UObject, Name)
Spawn an object of this class
Declaration
public static SplineMeshComponent New(UObject obj = null, Name name = default(Name))Parameters
| Type | Name | Description |
|---|---|---|
| UObject | obj | |
| Name | name |
Returns
| Type | Description |
|---|---|
| SplineMeshComponent |
SetBoundaryMax(Single, Boolean)
Set the boundary max
Declaration
public void SetBoundaryMax(float InBoundaryMax, bool bUpdateMesh)Parameters
| Type | Name | Description |
|---|---|---|
| System.Single | InBoundaryMax | |
| System.Boolean | bUpdateMesh |
SetBoundaryMin(Single, Boolean)
Set the boundary min
Declaration
public void SetBoundaryMin(float InBoundaryMin, bool bUpdateMesh)Parameters
| Type | Name | Description |
|---|---|---|
| System.Single | InBoundaryMin | |
| System.Boolean | bUpdateMesh |
SetEndOffset(Vector2D, Boolean)
Set the end offset
Declaration
public void SetEndOffset(Vector2D EndOffset, bool bUpdateMesh)Parameters
| Type | Name | Description |
|---|---|---|
| Vector2D | EndOffset | |
| System.Boolean | bUpdateMesh |
SetEndPosition(Vector, Boolean)
Set the end position of spline in local space
Declaration
public void SetEndPosition(Vector EndPos, bool bUpdateMesh)Parameters
| Type | Name | Description |
|---|---|---|
| Vector | EndPos | |
| System.Boolean | bUpdateMesh |
SetEndRoll(Single, Boolean)
Set the end roll
Declaration
public void SetEndRoll(float EndRoll, bool bUpdateMesh)Parameters
| Type | Name | Description |
|---|---|---|
| System.Single | EndRoll | |
| System.Boolean | bUpdateMesh |
SetEndScale(Vector2D, Boolean)
Set the end scaling
Declaration
public void SetEndScale(Vector2D EndScale, bool bUpdateMesh)Parameters
| Type | Name | Description |
|---|---|---|
| Vector2D | EndScale | |
| System.Boolean | bUpdateMesh |
SetEndTangent(Vector, Boolean)
Set the end tangent vector of spline in local space
Declaration
public void SetEndTangent(Vector EndTangent, bool bUpdateMesh)Parameters
| Type | Name | Description |
|---|---|---|
| Vector | EndTangent | |
| System.Boolean | bUpdateMesh |
SetForwardAxis(Byte, Boolean)
Set the forward axis
Declaration
public void SetForwardAxis(byte InForwardAxis, bool bUpdateMesh)Parameters
| Type | Name | Description |
|---|---|---|
| System.Byte | InForwardAxis | |
| System.Boolean | bUpdateMesh |
SetSplineUpDir(Vector, Boolean)
Set the spline up direction
Declaration
public void SetSplineUpDir(Vector InSplineUpDir, bool bUpdateMesh)Parameters
| Type | Name | Description |
|---|---|---|
| Vector | InSplineUpDir | |
| System.Boolean | bUpdateMesh |
SetStartAndEnd(Vector, Vector, Vector, Vector, Boolean)
Set the start and end, position and tangent, all in local space
Declaration
public void SetStartAndEnd(Vector StartPos, Vector StartTangent, Vector EndPos, Vector EndTangent, bool bUpdateMesh)Parameters
| Type | Name | Description |
|---|---|---|
| Vector | StartPos | |
| Vector | StartTangent | |
| Vector | EndPos | |
| Vector | EndTangent | |
| System.Boolean | bUpdateMesh |
SetStartOffset(Vector2D, Boolean)
Set the start offset
Declaration
public void SetStartOffset(Vector2D StartOffset, bool bUpdateMesh)Parameters
| Type | Name | Description |
|---|---|---|
| Vector2D | StartOffset | |
| System.Boolean | bUpdateMesh |
SetStartPosition(Vector, Boolean)
Set the start position of spline in local space
Declaration
public void SetStartPosition(Vector StartPos, bool bUpdateMesh)Parameters
| Type | Name | Description |
|---|---|---|
| Vector | StartPos | |
| System.Boolean | bUpdateMesh |
SetStartRoll(Single, Boolean)
Set the start roll
Declaration
public void SetStartRoll(float StartRoll, bool bUpdateMesh)Parameters
| Type | Name | Description |
|---|---|---|
| System.Single | StartRoll | |
| System.Boolean | bUpdateMesh |
SetStartScale(Vector2D, Boolean)
Set the start scaling
Declaration
public void SetStartScale(Vector2D StartScale, bool bUpdateMesh)Parameters
| Type | Name | Description |
|---|---|---|
| Vector2D | StartScale | |
| System.Boolean | bUpdateMesh |
SetStartTangent(Vector, Boolean)
Set the start tangent vector of spline in local space
Declaration
public void SetStartTangent(Vector StartTangent, bool bUpdateMesh)Parameters
| Type | Name | Description |
|---|---|---|
| Vector | StartTangent | |
| System.Boolean | bUpdateMesh |
UpdateMesh()
Update the collision and render state on the spline mesh following changes to its geometry
Declaration
public void UpdateMesh()Operators
| Improve this Doc View SourceImplicit(IntPtr to SplineMeshComponent)
Convert from IntPtr to UObject
Declaration
public static implicit operator SplineMeshComponent(IntPtr p)Parameters
| Type | Name | Description |
|---|---|---|
| System.IntPtr | p |
Returns
| Type | Description |
|---|---|
| SplineMeshComponent |