1. Epic GamesDeveloper
  3. UPaperTerrainComponent

UPaperTerrainComponent

The terrain visualization component for an associated spline component.

API > API/Plugins > API/Plugins/Paper2D

The terrain visualization component for an associated spline component. This takes a 2D terrain material and instances sprite geometry along the spline path.

   
Name UPaperTerrainComponent
Type class
Header File /Engine/Plugins/2D/Paper2D/Source/Paper2D/Classes/PaperTerrainComponent.h
Include Path #include "PaperTerrainComponent.h"

Syntax

UCLASS (MinimalAPI, BlueprintType, Experimental)  
class UPaperTerrainComponent : public UPrimitiveComponent

Inheritance Hierarchy

Implements Interfaces

Constructors

Name Remarks Include Path Unreal Specifiers

UPaperTerrainComponent ( const FObjectInitializer& ObjectInitializer
)

   PaperTerrainComponent.h  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
AssociatedSpline TObjectPtr< class UPaperTerrainSplineComponent >   PaperTerrainComponent.h  
bClosedSpline bool   PaperTerrainComponent.h
  • Category=Sprite
  • EditAnywhere
  • BlueprintReadOnly
bFilledSpline bool   PaperTerrainComponent.h
  • Category=Sprite
  • EditAnywhere
  • BlueprintReadOnly
  • Meta=(EditCondition="bClosedSpline")
RandomSeed int32 Random seed used for choosing which spline meshes to use. PaperTerrainComponent.h
  • Category=Sprite
  • EditAnywhere
SegmentOverlapAmount float The overlap amount between segments PaperTerrainComponent.h
  • Category=Sprite
  • EditAnywhere
TerrainMaterial TObjectPtr< class UPaperTerrainMaterial > The terrain material to apply to this component (set of rules for which sprites are used on different surfaces or the interior) PaperTerrainComponent.h
  • Category=Sprite
  • EditAnywhere
  • BlueprintReadOnly

Functions

Public

Name Remarks Include Path Unreal Specifiers

void SetTerrainColor ( FLinearColor NewColor
)

 Set color of the terrain. PaperTerrainComponent.h
  • BlueprintCallable
  • Category="Sprite"

Overridden from UPrimitiveComponent

Name Remarks Include Path Unreal Specifiers

virtual FPrimitiveSceneProxy * CreateSceneProxy()

   PaperTerrainComponent.h  

virtual UBodySetup * GetBodySetup()

   PaperTerrainComponent.h  

Overridden from USceneComponent

Name Remarks Include Path Unreal Specifiers

virtual FBoxSphereBounds CalcBounds ( const FTransform& LocalToWorld
) const

   PaperTerrainComponent.h  

Overridden from UActorComponent

Name Remarks Include Path Unreal Specifiers

virtual const UObject * AdditionalStatObject()

   PaperTerrainComponent.h  

virtual void OnRegister()

   PaperTerrainComponent.h  

virtual void OnUnregister()

   PaperTerrainComponent.h  

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual void PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

   PaperTerrainComponent.h  

virtual void PostLoad()

   PaperTerrainComponent.h  

virtual void Serialize ( FArchive& Ar
)

   PaperTerrainComponent.h  

Protected

Name Remarks Include Path Unreal Specifiers

void ConstrainSplinePointsToXZ()

   PaperTerrainComponent.h  

void GenerateCollisionDataFromPolygon ( const TArray< FVector2D >& SplinePolyVertices2D,
const TArray< float >& TerrainOffsets,
const TArray< FVector2D >& TriangulatedPolygonVertices
)

   PaperTerrainComponent.h  

void GenerateFillRenderDataFromPolygon ( const UPaperSprite* NewSprite,
FSpriteDrawCallRecord& FillDrawCall,
const FVector2D& TextureSize,
const TArray< FVector2D >& TriangulatedPolygonVertices
)

   PaperTerrainComponent.h  

FTransform GetTransformAtDistance ( float InDistance
) const

   PaperTerrainComponent.h  

void InsertConvexCollisionDataFromPolygon ( const TArray< FVector2D >& ClosedPolyVertices2D
)

   PaperTerrainComponent.h  

void OnSplineEdited()

   PaperTerrainComponent.h  

void SpawnSegments ( const TArray< FTerrainSegment >& TerrainSegments,
bool bGenerateSegmentColliders
)

   PaperTerrainComponent.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page