1. Epic GamesDeveloper
  3. ULandscapeSplinesComponent

ULandscapeSplinesComponent

[ULandscapeSplinesComponent](API\Runtime\Landscape\ULandscapeSplinesComponent).

Unreal Engine C++ API Reference > Runtime > Landscape

Inheritance Hierarchy

References

   
Module Landscape
Header /Engine/Source/Runtime/Landscape/Classes/LandscapeSplinesComponent.h
Include #include "LandscapeSplinesComponent.h"

Syntax

class ULandscapeSplinesComponent : public UPrimitiveComponent

Remarks

ULandscapeSplinesComponent.

Variables

  Type Name Description
Public variable uint32: 1 bShowSplineEditorMesh Whether we are in-editor and showing spline editor meshes
Protected variable TArray< TObjectPtr< ULandscapeSplineControlPoint > > ControlPoints  
Public variable TObjectPtr< UTexture2D > ControlPointSprite Sprite used to draw control points
Protected variable TArray< TObjectPtr< UMeshComponent > > CookedForeignMeshComponents References to components owned by landscape splines in other levels for cooked build (uncooked keeps references via ForeignWorldSplineDataMap)
Protected variable TMap< TSoftObjectPtr< UWorld >, FForeignWorldSplineData > ForeignWorldSplineDataMap Serialized.
Protected variable TMap< UMeshComponent *, TLazyObjectPtr< UObject > > MeshComponentForeignOwnersMap  
Protected variable TMap< UMeshComponent *, UObject * > MeshComponentLocalOwnersMap Transient - rebuilt on load.
Protected variable TArray< TObjectPtr< ULandscapeSplineSegment > > Segments  
Public variable FColor SplineColor Color to use to draw the splines
Public variable TObjectPtr< UStaticMesh > SplineEditorMesh Mesh used to draw splines that have no mesh
Public variable float SplineResolution Resolution of the spline, in distance per point

Constructors

  Type Name Description
Public function  

ULandscapeSplinesComponent ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Public function Virtual void  
Public function Virtual void  
Public function void  
Public function void  
Public function void Converts points along the landscape spline into points on a spline component Works best with landscape splines that contain no intersections or splits
Public function Virtual void  
Public function Virtual void  
Public function void  
Public function void Iterates throug a copy of the ControlPoints list.
Public function void  
Public function TArray< ULandscapeSplinesComponent * > Gathers and returns all currently existing
Public function Const const TArray< TObjectPtr< ULandscapeSplineControlPoint > > &  
Public function TArray< TObjectPtr< ULandscapeSplineControlPoint > > &  
Public function Virtual UControlPointMeshComponent *  
Public function Virtual TArray< USplineMeshComponent * >  
Public function Virtual UObject *

GetOwnerForMeshComponent ( const UMeshComponent* SplineMeshComponent
)

  
Public function TArray< TObjectPtr< ULandscapeSplineSegment > > &  
Public function Const const TArray< TObjectPtr< ULandscapeSplineSegment > > &  
Public function TArray< USplineMeshComponent * > Get a list of spline mesh components representing this landscape spline (Editor only)
Public function ILandscapeSplineInterface *  
Public function ULandscapeSplinesComponent *

GetStreamingSplinesComponentByLocation ( const FVector& LocalLocation,
bool bCreate
)

 Returns a suitable ULandscapeSplinesComponent to place streaming meshes into, given a location falls back to "this" if it can't find another suitable, so never returns nullptr
Public function ULandscapeSplinesComponent *

GetStreamingSplinesComponentForLevel ( ULevel* Level,
bool bCreate
)

 Returns the matching ULandscapeSplinesComponent for a given level, can return null
Public function Const bool  
Public function Const bool

IsUsingEditorMesh ( const USplineMeshComponent* SplineMeshComponent
)

  
Public function Const bool  
Public function bool

ModifySplines ( bool bAlwaysMarkDirty
)

  
Public function Virtual void

RebuildAllSplines ( bool bBuildCollision
)

 Rebuilds all spline points and meshes for all spline control points and segments in this splines component
Public function Virtual void  
Public function Virtual void  
Public function Virtual void  
Public function void  
Public function Virtual void

ShowSplineEditorMesh ( bool bShow
)

  
Public function Virtual void  
Public function Virtual void  

Overridden from UPrimitiveComponent

  Type Name Description
Public function Virtual FPrimitiveSceneProxy * Creates a proxy to represent the primitive to the scene manager in the rendering thread.

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.

Overridden from UActorComponent

  Type Name Description
Public function Virtual void Function that gets called from within Map_Check to allow this actor component to check itself for any potential errors and register them with map check dialog.
Public function Virtual void Called when a component is registered, after Scene is set, but before CreateRenderState_Concurrent or OnCreatePhysicsState are called.

Overridden from UObject

  Type Name Description
Public function Virtual void

PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

 Called when a property on this object has been modified externally
Public function Virtual void Called after applying a transaction to the object.
Public function Virtual void Do any object-specific cleanup required immediately after loading an object.
Public function Virtual void Handles reading, writing, and reference collecting using FArchive.

Deprecated Functions

  Type Name Description
Public function void This function was needed for forcing the SplineEditorMesh to be loaded when a commandlet is running, but commandlets are not prevented from loading it anymore so it has become useless

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page