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 > Plugins > Paper2D > PAPER2UPaperTerrainComponent

Light Theme

Dark Theme

PAPER2UPaperTerrainComponent

The terrain visualization component for an associated spline component.

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UActorComponent

USceneComponent

UPrimitiveComponent

PAPER2UPaperTerrainComponent

References

Module	Paper2D
Header	/Engine/Plugins/2D/Paper2D/Source/Paper2D/Classes/PaperTerrainComponent.h
Include	#include "PaperTerrainComponent.h"

Syntax

[UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(BlueprintType, Experimental)
class PAPER2UPaperTerrainComponent : public UPrimitiveComponent

Remarks

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

Variables

	Name	Description
UPaperTerrainSp...	AssociatedSpline
bool	bClosedSpline
bool	bFilledSpline
UBodySetup *...	CachedBodySetup	Description of collision
float	CollisionThickness	The extrusion thickness of collision geometry when using a 3D collision domain
TArray< FPaperT...	GeneratedSpriteGeometry
int32	RandomSeed	Random seed used for choosing which spline meshes to use.
int32	ReparamStepsPerSegment	Number of steps per spline segment to place in the reparameterization table
float	SegmentOverlapAmount	The overlap amount between segments
TEnumAsByte< ES...	SpriteCollisionDomain	Collision domain (no collision, 2D (experimental), or 3D)
FLinearColor	TerrainColor	The color of the terrain (passed to the sprite material as a vertex color)
UPaperTerrainMa...	TerrainMaterial	The terrain material to apply to this component (set of rules for which sprites are used on different surfaces or the interior)

Constructors

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

Functions

	Name	Description
void	ConstrainSplinePointsToXZ()
void	GenerateCollisionDataFromPolygon ( const TArray< FVector2D >& SplineP..., const TArray< float >& TerrainOffs..., const TArray< FVector2D >& Triangu... )
void	GenerateFillRenderDataFromPolygon ( const UPaperSprite* NewSprite, FSpriteDrawCallRecord& FillDrawCal..., const FVector2D& TextureSize, const TArray< FVector2D >& Triangu... )
FTransform	GetTransformAtDistance ( float InDistance )
void	InsertConvexCollisionDataFromPolygon ( const TArray< FVector2D >& ClosedP... )
void	OnSplineEdited()
void	SetTerrainColor ( FLinearColor NewColor )	Set color of the terrain.
void	SpawnSegments ( const TArray< FTerrainSegment >& T..., bool bGenerateSegmentColliders )

Overridden from UPrimitiveComponent

		Name	Description
	FPrimitiveSc...	CreateSceneProxy()	Creates a proxy to represent the primitive to the scene manager in the rendering thread.
	UBodySetup &...	GetBodySetup()	Return the BodySetup to use for this PrimitiveComponent (single body case)

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.

Overridden from UActorComponent

	Name	Description
const UObjec...	AdditionalStatObject()	Give a readable name for this component, including asset name if applicable
void	OnRegister()	Called when a component is registered, after Scene is set, but before CreateRenderState_Concurrent or OnCreatePhysicsState are called.
void	OnUnregister()	Called when a component is unregistered.

Overridden from UObject

	Name	Description
void	PostEditChangeProperty ( FPropertyChangedEvent& PropertyCha... )	Called when a property on this object has been modified externally
void	PostLoad()	Do any object-specific cleanup required immediately after loading an object.
void	Serialize ( FArchive& Ar )	Handles reading, writing, and reference collecting using FArchive.

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss