1. Epic GamesDeveloper
  3. PAPER2UPaperGroupedSpriteComponent

PAPER2UPaperGroupedSpriteComponent

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

API > API/Plugins > API/Plugins/Paper2D

Inheritance Hierarchy

References

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

Syntax

UCLASS&40;ShowCategories&61;&40;Mobility&41;, ClassGroup&61;Paper2D, Meta&61;&40;BlueprintSpawnableComponent&41;,  
       EarlyAccessPreview&41;  
class PAPER2UPaperGroupedSpriteComponent : public UMeshComponent

Remarks

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

Variables

  Type Name Description
Protected variable friend FGroupedSpriteSceneProxy  
Protected variable TArray< FBodyInstance * > InstanceBodies Physics representation of the instance bodies
Protected variable UProperty TArray< TObjectPtr< UMaterialInterface > > InstanceMaterials Array of materials used by the instances
Protected variable UProperty Category, EditAnywhere, Meta displayname TArray< FSpriteInstanceData > PerInstanceSpriteData Array of instances

Constructors

  Type Name Description
Public function    

Functions

  Type Name Description
Public function UFunction BlueprintCallable, Category int32

AddInstance ( const FTransform& Transform,
UPaperSprite* Sprite,
bool bWorldSpace,
FLinearColor Color
)

 Add an instance to this component.
Public function Virtual int32

AddInstanceWithMaterial ( const FTransform& Transform,
UPaperSprite* Sprite,
UMaterialInterface* MaterialOverride,
bool bWorldSpace,
FLinearColor Color
)

  
Protected function void Terminate all body instances owned by this component
Public function Virtual UFunction BlueprintCallable, Category void Clear all instances being rendered by this component
Public function Const bool

ContainsSprite ( UPaperSprite* SpriteAsset
)

 Returns true if this component references the specified sprite asset.
Protected function void Creates body instances for all instances owned by this component
Public function Const UFunction BlueprintCallable, Category int32 Get the number of instances in this component
Public function Const UFunction BlueprintCallable, Category bool

GetInstanceTransform ( int32 InstanceIndex,
FTransform& OutInstanceTransform,
bool bWorldSpace
)

 Get the transform for the instance specified.
Public function Const void

GetNavigationPerInstanceTransforms ( const FBox& AreaBox,
TArray< FTransform >& OutInstanceTransforms
)

 Handles request from navigation system to gather instance transforms in a specific area box
Public function Const const TArray< FSpriteInstanceData > &  
Public function Const void

GetReferencedSpriteAssets ( TArray< UObject* >& InOutObjects
)

 Adds all referenced sprite assets to the specified list.
Protected function FBodyInstance *

InitInstanceBody ( int32 InstanceIndex,
const FSpriteInstanceData& InstanceData,
FPhysScene* PhysScene
)

 Creates a body instance for the specified instance data if that sprite has defined collision
Protected function void Invalidates the render and collision state
Protected function void Creates the material list from the instances
Protected function void Transfers ownership of instance render data to a render thread instance render data will be released in scene proxy dtor or on render thread task
Public function Virtual UFunction BlueprintCallable, Category bool

RemoveInstance ( int32 InstanceIndex
)

 Remove the instance specified. Returns True on success.
Protected function void

SetupNewInstanceData ( FSpriteInstanceData& InOutNewInstanceData,
int32 InInstanceIndex,
const FTransform& InInstanceTransform,
UPaperSprite* InSprite,
UMaterialInterface* MaterialOverride,
const FColor& InColor
)

 Sets up new instance data to sensible defaults, creates physics counterparts if possible
Public function UFunction BlueprintCallable, Category void

SortInstancesAlongAxis ( FVector WorldSpaceSortAxis
)

 Sort all instances by their world space position along the specified axis
Public function Virtual UFunction BlueprintCallable, Category bool

UpdateInstanceColor ( int32 InstanceIndex,
FLinearColor NewInstanceColor,
bool bMarkRenderStateDirty
)

 Update the color for the instance specified. Returns True on success.
Public function Virtual UFunction BlueprintCallable, Category bool

UpdateInstanceTransform ( int32 InstanceIndex,
const FTransform& NewInstanceTransform,
bool bWorldSpace,
bool bMarkRenderStateDirty,
bool bTeleport
)

 Update the transform for the instance specified.
Protected function int32

UpdateMaterialList ( UPaperSprite* Sprite,
UMaterialInterface* MaterialOverride
)

 Adds to the material list from a single sprite

Overridden from UPrimitiveComponent

  Type Name Description
Public function Virtual bool Determines whether or not the simulate physics setting can be edited interactively on this component
Public function Virtual FPrimitiveSceneProxy * Creates a proxy to represent the primitive to the scene manager in the rendering thread.
Public function Virtual Const bool Collects custom navigable geometry of component.
Public function Virtual Const UMaterialInterface *

GetMaterial ( int32 ElementIndex
)

 Returns the material used by the element at the specified index
Public function Virtual Const int32 Return number of material elements in this primitive
Public function Virtual void

GetUsedTextures ( TArray< UTexture* >& OutTextures,
EMaterialQualityLevel::Type QualityLevel
)

 Returns the material textures used to render this primitive for the given platform.

Overridden from USceneComponent

  Type Name Description
Public function Virtual Const FBoxSphereBounds

CalcBounds ( const FTransform& LocalToWorld
)

 Calculate the bounds of the component. Default behavior is a bounding box/sphere of zero size.
Public function Virtual void

OnUpdateTransform ( EUpdateTransformFlags UpdateTransformFlags,
ETeleportType Teleport
)

 Native callback when this component is moved

Overridden from UActorComponent

  Type Name Description
Public function Virtual Const const UObject * Give a readable name for this component, including asset name if applicable
Public function Virtual void Function that gets called from within Map_Check to allow this actor component to check itself for any potential errors and register them with map check dialog.
Protected function Virtual void Used to create any physics engine information for this component
Protected function Virtual void Used to shut down and physics engine structure for this component
Public function Virtual Const bool Return true if CreatePhysicsState() should be called.

Overridden from UObject

  Type Name Description
Public function Virtual void This alternate version of PostEditChange is called when properties inside structs are modified.
Public function Virtual void

PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

 Called when a property on this object has been modified externally
Public function Virtual void Called after applying a transaction to the object.

Overridden from INavRelevantInterface

  Type Name Description
Public function Virtual Const void Prepare navigation modifiers

See Also

UPrimitiveComponent

UPaperSprite

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page