Class PaperSprite

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.

Inheritance
System.Object
UObject
PaperSprite
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
Namespace: UE4.Paper2D
Assembly: UE4DotNet.dll
Syntax
public class PaperSprite : UObject
Remarks

@see UPaperSpriteComponent

Properties

| Improve this Doc View Source

AdditionalSourceTextures

Additional source textures for other slots

Declaration
public ObjectArrayField<Texture> AdditionalSourceTextures { get; }
Property Value
Type Description
ObjectArrayField<Texture>
| Improve this Doc View Source

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)

Declaration
public MaterialInterface AlternateMaterial { get; }
Property Value
Type Description
MaterialInterface
| Improve this Doc View Source

AlternateMaterialSplitIndex

The point at which the alternate material takes over in the baked render data (or INDEX_NONE)

Declaration
public int AlternateMaterialSplitIndex { get; set; }
Property Value
Type Description
System.Int32
| Improve this Doc View Source

AtlasGroup

Spritesheet group that this sprite belongs to

Declaration
public PaperSpriteAtlas AtlasGroup { get; set; }
Property Value
Type Description
PaperSpriteAtlas
| Improve this Doc View Source

BakedSourceDimension

Dimensions within BakedSourceTexture (in pixels)

Declaration
public Vector2D BakedSourceDimension { get; set; }
Property Value
Type Description
Vector2D
| Improve this Doc View Source

BakedSourceTexture

Baked Source Texture

Declaration
public Texture2D BakedSourceTexture { get; set; }
Property Value
Type Description
Texture2D
| Improve this Doc View Source

BakedSourceUV

Position within BakedSourceTexture (in pixels)

Declaration
public Vector2D BakedSourceUV { get; set; }
Property Value
Type Description
Vector2D
| Improve this Doc View Source

BodySetup

Baked physics data.

Declaration
public BodySetup BodySetup { get; set; }
Property Value
Type Description
BodySetup
| Improve this Doc View Source

bRotatedInSourceImage

Declaration
public bool bRotatedInSourceImage { get; set; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

bSnapPivotToPixelGrid

Declaration
public bool bSnapPivotToPixelGrid { get; set; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

bTrimmedInSourceImage

Declaration
public bool bTrimmedInSourceImage { get; set; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

CollisionGeometry

Custom collision geometry polygons (in texture space)

Declaration
public SpriteGeometryCollection CollisionGeometry { get; set; }
Property Value
Type Description
SpriteGeometryCollection
| Improve this Doc View Source

CollisionThickness

The extrusion thickness of collision geometry when using a 3D collision domain

Declaration
public float CollisionThickness { get; set; }
Property Value
Type Description
System.Single
| Improve this Doc View Source

CustomPivotPoint

Custom pivot point (relative to the sprite rectangle)

Declaration
public Vector2D CustomPivotPoint { get; set; }
Property Value
Type Description
Vector2D
| Improve this Doc View Source

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)

Declaration
public MaterialInterface DefaultMaterial { get; }
Property Value
Type Description
MaterialInterface
| Improve this Doc View Source

DefaultObject

Get UE4 Default Object for this Class

Declaration
public static PaperSprite DefaultObject { get; }
Property Value
Type Description
PaperSprite
| Improve this Doc View Source

OriginInSourceImageBeforeTrimming

Origin within SourceImage, prior to atlasing

Declaration
public Vector2D OriginInSourceImageBeforeTrimming { get; set; }
Property Value
Type Description
Vector2D
| Improve this Doc View Source

PivotMode

Pivot mode

Declaration
public byte PivotMode { get; set; }
Property Value
Type Description
System.Byte
| Improve this Doc View Source

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)

Declaration
public float PixelsPerUnrealUnit { get; set; }
Property Value
Type Description
System.Single
| Improve this Doc View Source

RenderGeometry

Custom render geometry polygons (in texture space)

Declaration
public SpriteGeometryCollection RenderGeometry { get; set; }
Property Value
Type Description
SpriteGeometryCollection
| Improve this Doc View Source

SourceDimension

Dimensions within SourceTexture (in pixels)

Declaration
public Vector2D SourceDimension { get; set; }
Property Value
Type Description
Vector2D
| Improve this Doc View Source

SourceImageDimensionBeforeTrimming

Dimensions of SourceImage

Declaration
public Vector2D SourceImageDimensionBeforeTrimming { get; set; }
Property Value
Type Description
Vector2D
| Improve this Doc View Source

SourceTexture

The source texture that the sprite comes from

Declaration
public Texture2D SourceTexture { get; set; }
Property Value
Type Description
Texture2D
| Improve this Doc View Source

SourceTextureDimension

Dimension of the texture when this sprite was created

Declaration
public Vector2D SourceTextureDimension { get; set; }
Property Value
Type Description
Vector2D
Remarks

Used when the sprite is resized at some point

| Improve this Doc View Source

SourceUV

Position within SourceTexture (in pixels)

Declaration
public Vector2D SourceUV { get; set; }
Property Value
Type Description
Vector2D
| Improve this Doc View Source

SpriteCollisionDomain

Collision domain (no collision, 2D, or 3D)

Declaration
public byte SpriteCollisionDomain { get; set; }
Property Value
Type Description
System.Byte
| Improve this Doc View Source

StaticClass

Get UE4 Class

Declaration
public static Class StaticClass { get; }
Property Value
Type Description
Class

Methods

| Improve this Doc View Source

New(UObject, Name)

Spawn an object of this class

Declaration
public static PaperSprite New(UObject obj = null, Name name = default(Name))
Parameters
Type Name Description
UObject obj
Name name
Returns
Type Description
PaperSprite

Operators

| Improve this Doc View Source

Implicit(IntPtr to PaperSprite)

Convert from IntPtr to UObject

Declaration
public static implicit operator PaperSprite(IntPtr p)
Parameters
Type Name Description
System.IntPtr p
Returns
Type Description
PaperSprite