Class PaperGroupedSpriteComponent

A component that handles rendering and collision for many instances of one or more UPaperSprite assets.

Inheritance
System.Object
UObject
ActorComponent
SceneComponent
PrimitiveComponent
MeshComponent
PaperGroupedSpriteComponent
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 PaperGroupedSpriteComponent : MeshComponent
Remarks

@see UPrimitiveComponent, UPaperSprite

Properties

| Improve this Doc View Source

DefaultObject

Get UE4 Default Object for this Class

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

InstanceMaterials

Array of materials used by the instances

Declaration
public ObjectArrayField<MaterialInterface> InstanceMaterials { get; }
Property Value
Type Description
ObjectArrayField<MaterialInterface>
| 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

AddInstance(Transform, PaperSprite, Boolean, LinearColor)

Add an instance to this component. Transform can be given either in the local space of this component or world space.

Declaration
public int AddInstance(Transform Transform, PaperSprite Sprite, bool bWorldSpace, LinearColor Color)
Parameters
Type Name Description
Transform Transform
PaperSprite Sprite
System.Boolean bWorldSpace
LinearColor Color
Returns
Type Description
System.Int32
| Improve this Doc View Source

ClearInstances()

Clear all instances being rendered by this component

Declaration
public void ClearInstances()
| Improve this Doc View Source

GetInstanceCount()

Get the number of instances in this component

Declaration
public int GetInstanceCount()
Returns
Type Description
System.Int32
| Improve this Doc View Source

GetInstanceTransform(Int32, Boolean)

Get the transform for the instance specified. Instance is returned in local space of this component unless bWorldSpace is set. Returns True on success.

Declaration
public (Transform, bool) GetInstanceTransform(int InstanceIndex, bool bWorldSpace)
Parameters
Type Name Description
System.Int32 InstanceIndex
System.Boolean bWorldSpace
Returns
Type Description
System.ValueTuple<Transform, System.Boolean>
| Improve this Doc View Source

New(UObject, Name)

Spawn an object of this class

Declaration
public static PaperGroupedSpriteComponent New(UObject obj = null, Name name = default(Name))
Parameters
Type Name Description
UObject obj
Name name
Returns
Type Description
PaperGroupedSpriteComponent
| Improve this Doc View Source

RemoveInstance(Int32)

Remove the instance specified. Returns True on success.

Declaration
public bool RemoveInstance(int InstanceIndex)
Parameters
Type Name Description
System.Int32 InstanceIndex
Returns
Type Description
System.Boolean
| Improve this Doc View Source

SortInstancesAlongAxis(Vector)

Sort all instances by their world space position along the specified axis

Declaration
public void SortInstancesAlongAxis(Vector WorldSpaceSortAxis)
Parameters
Type Name Description
Vector WorldSpaceSortAxis
| Improve this Doc View Source

UpdateInstanceColor(Int32, LinearColor, Boolean)

Update the color for the instance specified. Returns True on success.

Declaration
public bool UpdateInstanceColor(int InstanceIndex, LinearColor NewInstanceColor, bool bMarkRenderStateDirty)
Parameters
Type Name Description
System.Int32 InstanceIndex
LinearColor NewInstanceColor
System.Boolean bMarkRenderStateDirty
Returns
Type Description
System.Boolean
| Improve this Doc View Source

UpdateInstanceTransform(Int32, Transform, Boolean, Boolean, Boolean)

Update the transform for the instance specified. Instance is given in local space of this component unless bWorldSpace is set. Returns True on success.

Declaration
public bool UpdateInstanceTransform(int InstanceIndex, Transform NewInstanceTransform, bool bWorldSpace, bool bMarkRenderStateDirty, bool bTeleport)
Parameters
Type Name Description
System.Int32 InstanceIndex
Transform NewInstanceTransform
System.Boolean bWorldSpace
System.Boolean bMarkRenderStateDirty
System.Boolean bTeleport
Returns
Type Description
System.Boolean

Operators

| Improve this Doc View Source

Implicit(IntPtr to PaperGroupedSpriteComponent)

Convert from IntPtr to UObject

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