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 > PAPER2UPaperSprite

Light Theme

Dark Theme

PAPER2UPaperSprite

Sprite Asset

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

PAPER2UPaperSprite

References

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

Syntax

[UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(BlueprintType, Meta=(DisplayThumbnail="true"))
class PAPER2UPaperSprite :
    public UObject,
    public IInterface_CollisionDataProvider,
    public ISlateTextureAtlasInterface

Remarks

Sprite Asset

Stores the data necessary to render a single 2D sprite (from a region of a texture) Can also contain collision shapes for the sprite.

Variables

	Name	Description
TArray< UTextur...	AdditionalSourceTextures	Additional source textures for other slots.
UMaterialInterf...	AlternateMaterial	The alternate material to use on a sprite instance if not overridden (this is only used for Diced render geometry, and will be the opaque material in that case, slot 1)
int32	AlternateMaterialSplitIndex	The point at which the alternate material takes over in the baked render data (or INDEX_NONE)
UPaperSpriteAtl...	AtlasGroup	Spritesheet group that this sprite belongs to.
TArray< FVector...	BakedRenderData	Baked render data (triangle vertices, stored as XY UV tuples) XY is the XZ position in world space, relative to the pivot UV is normalized (0..1) There should always be a multiple of three elements in this array
FVector2D	BakedSourceDimension	Dimensions within BakedSourceTexture (in pixels)
UTexture2D *...	BakedSourceTexture
FVector2D	BakedSourceUV	Position within BakedSourceTexture (in pixels)
UBodySetup *...	BodySetup	Baked physics data.
bool	bRotatedInSourceImage	This texture is rotated in the atlas.
bool	bSnapPivotToPixelGrid	Should the pivot be snapped to a pixel boundary?
bool	bTrimmedInSourceImage	This texture is trimmed, consider the values above.
FSpriteGeometry...	CollisionGeometry	Custom collision geometry polygons (in texture space)
float	CollisionThickness	The extrusion thickness of collision geometry when using a 3D collision domain.
FVector2D	CustomPivotPoint	Custom pivot point (relative to the sprite rectangle)
UMaterialInterf...	DefaultMaterial	The material to use on a sprite instance if not overridden (this is the default material when only one is being used, and is the translucent/masked material for Diced render geometry, slot 0)
FVector2D	OriginInSourceImageBeforeTrimming	Origin within SourceImage, prior to atlasing.
TEnumAsByte< ES...	PivotMode	Pivot mode.
float	PixelsPerUnrealUnit	The scaling factor between pixels and Unreal units (cm) (e.g., 0.64 would make a 64 pixel wide sprite take up 100 cm)
TSoftObjectPtr<...	PreviousAtlasGroup	The previous spritesheet group this belonged to To make sure we remove ourselves from it if changed or nulled out
FSpriteGeometry...	RenderGeometry	Custom render geometry polygons (in texture space)
TArray< FPaperS...	Sockets	List of sockets on this sprite.
FVector2D	SourceDimension	Dimensions within SourceTexture (in pixels)
FVector2D	SourceImageDimensionBeforeTrimming	Dimensions of SourceImage.
TSoftObjectPtr<...	SourceTexture	The source texture that the sprite comes from.
UTexture2D *...	SourceTextureCacheNeverSerialized
FVector2D	SourceTextureDimension	Dimension of the texture when this sprite was created Used when the sprite is resized at some point
FVector2D	SourceUV	Position within SourceTexture (in pixels)
TEnumAsByte< ES...	SpriteCollisionDomain	Collision domain (no collision, 2D, or 3D)

Constructors

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

Functions

	Name	Description
void	BuildGeometryFromContours ( FSpriteGeometryCollection& GeomOwn... )
FVector	ConvertPivotSpaceToTextureSpace ( FVector Input )
FVector2D	ConvertPivotSpaceToTextureSpace ( FVector2D Input )
FVector2D	ConvertTextureSpaceToPivotSpace ( FVector2D Input )
FVector	ConvertTextureSpaceToPivotSpace ( FVector Input )
FVector	ConvertTextureSpaceToWorldSpace ( const FVector2D& SourcePoint )	World space WRT the sprite editor only
FVector2D	ConvertWorldSpaceDeltaToTextureSpace ( const FVector& WorldDelta, bool bIgnoreRotation )
FVector2D	ConvertWorldSpaceToTextureSpace ( const FVector& WorldPoint )
void	CreatePolygonFromBoundingBox ( FSpriteGeometryCollection& GeomOwn..., bool bUseTightBounds )
void	ExtractRectsFromTexture ( UTexture2D* Texture, TArray< FIntRect >& OutRects )
void	ExtractSourceRegionFromTexturePoint ( const FVector2D& Point )
void	FindContours ( const FIntPoint& ScanPos, const FIntPoint& ScanSize, float AlphaThreshold, float Detail, UTexture2D* Texture, TArray< TArray< FIntPoint > >& Out... )
FPaperSprite...	FindSocket ( FName SocketName )	Search for a socket (.
void	FindTextureBoundingBox ( float AlphaThreshold, FVector2D& OutBoxPosition, FVector2D& OutBoxSize )	Evaluates the SourceUV/SourceDimensons rectangle, finding the tightest bounds that still include all pixels with alpha above AlphaThreshold.
UMaterialInt...	GetAlternateMaterial()	Return the alternate material for this sprite.
const UPaper...	GetAtlasGroup()
void	GetBakedAdditionalSourceTextures ( FAdditionalSpriteTextureArray& Out... )	Returns the list of additional source textures this should be rendered with.
UTexture2D &...	GetBakedTexture()	Returns the texture this should be rendered with.
float	GetCollisionThickness()	Returns the extrusion thickness of collision geometry when using a 3D collision domain.
UMaterialInt...	GetDefaultMaterial()	Return the default material for this sprite.
UMaterialInt...	GetMaterial ( int32 MaterialIndex )	Returns either the default material (index 0) or alternate material (index 1)
int32	GetNumMaterials()	Returns the number of materials (1 or 2, depending on if there is alternate geometry)
FVector2D	GetOriginInSourceImageBeforeTrimming()	Returns the Origin within SourceImage, prior to atlasing.
ESpritePivot...	GetPivotMode ( FVector2D& OutCustomTextureSpacePi... )
FVector2D	GetPivotPosition()	Returns the current pivot position in texture space.
FTransform	GetPivotToWorld()
float	GetPixelsPerUnrealUnit()	Return the scaling factor between pixels and Unreal units (cm)
FVector2D	GetRawPivotPosition()	Returns the raw pivot position (ignoring pixel snapping)
FBoxSphereBo...	GetRenderBounds()	Returns the render bounds of this sprite.
FVector2D	GetSourceImageDimensionBeforeTrimming()	Returns the Dimensions of SourceImage prior to trimming.
FVector2D	GetSourceSize()
UTexture2D &...	GetSourceTexture()
FVector2D	GetSourceUV()
ESpriteColli...	GetSpriteCollisionDomain()	Returns the collision domain (no collision, 2D, or 3D)
float	GetUnrealUnitsPerPixel()	Return the scaling factor between Unreal units (cm) and pixels.
bool	HasAnySockets()	Returns true if the sprite has any sockets.
void	InitializeSprite ( const FSpriteAssetInitParameters& ..., bool bRebuildData )	Reinitializes this sprite (.
bool	IsRotatedInSourceImage()	This texture is rotated in the atlas.
bool	IsTrimmedInSourceImage()	Returns true if this sprite is trimmed from the original texture, meaning that the source image dimensions and origin in the source image may not be the same as the final results for the sprite (empty alpha=0 pixels were trimmed from the exterior region)
bool	NeedRescaleSpriteData()	Rescale properties to handle source texture size change.
void	OnObjectReimported ( UTexture2D* InObject )	Called when an object is re-imported in the editor.
void	QuerySupportedSockets ( TArray< FComponentSocketDescription... )	Returns a list of all of the sockets.
void	RebuildCollisionData()
void	RebuildData()	This is a generic "rebuild all" function that calls RebuildCollisionData() and then RebuildRenderData().
void	RebuildRenderData()
void	RefreshBakedData()
void	RemoveSocket ( FName SocketName )	Removes the specified socket.
void	RescaleSpriteData ( UTexture2D* Texture )	Rescale properties to handle source texture size change.
void	SetPivotMode ( ESpritePivotMode::Type PivotMode, FVector2D CustomTextureSpacePivot, bool bRebuildData )
void	SetRotated ( bool bRotated, bool bRebuildData )
void	SetTrim ( bool bTrimmed, const FVector2D& OriginInSourceIma..., const FVector2D& SourceImageDimens..., bool bRebuildData )
void	ValidateSocketNames()	Make sure all socket names are valid All duplicate / empty names will be made unique

Overridden from UObject

	Name	Description
void	GetAssetRegistryTags ( TArray< FAssetRegistryTag >& OutTa... )	Gathers a list of asset registry searchable tags which are name/value pairs with some type information This only needs to be implemented for asset objects
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.

Overridden from IInterface_CollisionDataProvider

		Name	Description
	bool	ContainsPhysicsTriMeshData ( bool InUseAllTriData )	Interface for checking if the implementing objects contains triangle mesh collision data
	bool	GetPhysicsTriMeshData ( FTriMeshCollisionData* Collisi..., bool InUseAllTriData )	Interface for retrieving triangle mesh collision data from the implementing object

Overridden from ISlateTextureAtlasInterface

		Name	Description
	FSlateAtlasD...	GetSlateAtlasData()	Gets the atlas data to use when rendering with slate.