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

Light Theme

Dark Theme

PAPER2FSpriteGeometryShape

A single piece of geometry (e.g., a polygon which may be convex or concave, a box, or a circle)

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 PAPER2FSpriteGeometryShape

Remarks

A single piece of geometry (e.g., a polygon which may be convex or concave, a box, or a circle)

Variables

	Name	Description
bool	bNegativeWinding	For Polygon geometry, this tells us if the winding should be negative (CW) regardless of the order in Vertices.
FVector2D	BoxPosition	Center of the box or circle, acts as the pivot point for polygons (but may not be at the center of them)
FVector2D	BoxSize	Size of the box or major/minor dimensions of the circle.
float	Rotation	Rotation of the shape (in degrees)
ESpriteShapeTyp...	ShapeType	The type of this piece of geometry.
TArray< FVector...	Vertices	Vertices for the polygon (valid for Box and Polygon, but empty for Circle)

Functions

	Name	Description
FVector2D	ConvertShapeSpaceToTextureSpace ( const FVector2D& ShapeSpacePoint )
FVector2D	ConvertTextureSpaceToShapeSpace ( const FVector2D& TextureSpacePoint )
	FSpriteGeometryShape()
FVector2D	GetPolygonCentroid()	Returns the polygon centroid in texture space.
void	GetTextureSpaceVertices ( TArray< FVector2D >& InOutVertices )
bool	IsShapeValid()	Is this shape valid (e.g., at least 3 vertices for a polygon)?
void	SetNewPivot ( const FVector2D& NewPosInTextureSp... )	Sets a new pivot and adjusts all vertices to be relative to it.

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

Take our survey

Dismiss