1. Epic GamesDeveloper
  3. PAPER2UPaperTerrainComponent

PAPER2UPaperTerrainComponent

The terrain visualization component for an associated spline component.

API > API/Plugins > API/Plugins/Paper2D

Inheritance Hierarchy

References

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

Syntax

UCLASS&40;BlueprintType, Experimental&41;  
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

  Type Name Description
Public variable UProperty TObjectPtr< class UPaperTerrainSplineComponent > AssociatedSpline  
Public variable UProperty Category, EditAnywhere BlueprintReadOnly bool bClosedSpline  
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadOnly bool bFilledSpline  
Protected variable UProperty Transient duplicatetransient TObjectPtr< class UBodySetup > CachedBodySetup Description of collision
Protected variable UProperty Category, EditAnywhere float CollisionThickness The extrusion thickness of collision geometry when using a 3D collision domain
Protected variable TArray< FPaperTerrainSpriteGeometry > GeneratedSpriteGeometry  
Public variable UProperty Category, EditAnywhere int32 RandomSeed Random seed used for choosing which spline meshes to use.
Protected variable UProperty Category, EditAnywhere, AdvancedDisplay, Meta int32 ReparamStepsPerSegment Number of steps per spline segment to place in the reparameterization table
Public variable UProperty Category, EditAnywhere float SegmentOverlapAmount The overlap amount between segments
Protected variable UProperty Category, EditAnywhere TEnumAsByte< ESpriteCollisionMode::Type > SpriteCollisionDomain Collision domain (no collision, 2D (experimental), or 3D)
Protected variable UProperty Category, Interp BlueprintReadOnly FLinearColor TerrainColor The color of the terrain (passed to the sprite material as a vertex color)
Public variable UProperty Category, EditAnywhere BlueprintReadOnly TObjectPtr< class UPaperTerrainMaterial > TerrainMaterial The terrain material to apply to this component (set of rules for which sprites are used on different surfaces or the interior)

Constructors

  Type Name Description
Public function  

PAPER2UPaperTerrainComponent ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Protected function void  
Protected function void

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

  
Protected function void

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

  
Protected function Const FTransform

GetTransformAtDistance ( float InDistance
)

  
Protected function void

InsertConvexCollisionDataFromPolygon ( const TArray< FVector2D >& ClosedPolyVertices2D
)

  
Protected function void  
Public function UFunction BlueprintCallable, Category void Set color of the terrain.
Protected function void

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

  

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.
Public function Virtual UBodySetup * Return the BodySetup to use for this PrimitiveComponent (single body case)

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 Const const UObject * Give a readable name for this component, including asset name if applicable
Public function Virtual void Called when a component is registered, after Scene is set, but before CreateRenderState_Concurrent or OnCreatePhysicsState are called.
Public function Virtual void Called when a component is unregistered.

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 Do any object-specific cleanup required immediately after loading an object.
Public function Virtual void Handles reading, writing, and reference collecting using FArchive.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page