PAPER2FSpriteGeometryCollection

Windows
MacOS
Linux

References

Module

Paper2D

Header

/Engine/Plugins/2D/Paper2D/Source/Paper2D/Classes/SpriteEditorOnlyTypes.h

Include

#include "SpriteEditorOnlyTypes.h"

Syntax

[USTRUCT](Programming/UnrealArchitecture/Reference/Structs)()
struct PAPER2FSpriteGeometryCollection

Variables

Name Description

Public variable UProperty Category, EditAnywhere, AdvancedDisplay

float

 

AlphaThreshold

Alpha threshold for a transparent pixel (range 0..1, anything equal or below this value will be considered unimportant)

Public variable UProperty Category, EditAnywhere, AdvancedDisplay

bool

 

bAvoidVertexMerging

Experimental: Hint to the triangulation routine that extra vertices should be preserved.

Public variable UProperty Category, EditAnywhere, AdvancedDisplay

float

 

DetailAmount

Amount to detail to consider when shrink-wrapping (range 0..1, 0 = low detail, 1 = high detail)

Public variable UProperty Category, EditAnywhere

TEnumAsByte< ES...

 

GeometryType

The geometry type (automatic / manual)

Public variable UProperty Category, EditAnywhere

int32

 

PixelsPerSubdivisionX

Size of a single subdivision (in pixels) in X (for Diced mode)

Public variable UProperty Category, EditAnywhere

int32

 

PixelsPerSubdivisionY

Size of a single subdivision (in pixels) in Y (for Diced mode)

Public variable UProperty Category, EditAnywhere, AdvancedDisplay

TArray< FSprite...

 

Shapes

List of shapes.

Public variable UProperty Category, EditAnywhere, AdvancedDisplay

float

 

SimplifyEpsilon

This is the threshold below which multiple vertices will be merged together when doing shrink-wrapping. Higher values result in fewer vertices.

Functions

Name Description

Public function

void

 

AddCircleShape

(
    FVector2D Position,
    FVector2D Size
)

Public function

void

 

AddRectangleShape

(
    FVector2D Position,
    FVector2D Size
)

Public function

bool

 

ConditionGeometry()

Conditions this geometry collection (turning Polygons back to Boxes if they meet the definition of a box, etc...) Returns true if something was modified

Public function

 

FSpriteGeometryCollection()

Public function

void

 

Reset()

Empties this geometry collection, resetting the GeometryType to TightBoundingBox.

Public function Const

void

 

Triangulate

(
    TArray< FVector2D >& Target,
    bool bIncludeBoxes
)

Takes all polygon shapes and generates a list of triangles from them.
Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss