1. Epic GamesDeveloper
  3. UPaperGroupedSpriteComponent

UPaperGroupedSpriteComponent

A component that handles rendering and collision for many instances of one or more [UPaperSprite](API\Plugins\Paper2D\UPaperSprite) assets.

API > API/Plugins > API/Plugins/Paper2D

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

   
Name UPaperGroupedSpriteComponent
Type class
Header File /Engine/Plugins/2D/Paper2D/Source/Paper2D/Classes/PaperGroupedSpriteComponent.h
Include Path #include "PaperGroupedSpriteComponent.h"

Syntax

UCLASS (MinimalAPI, ShowCategories=(Mobility), ClassGroup=Paper2D,  
       Meta=(BlueprintSpawnableComponent), EarlyAccessPreview)  
class UPaperGroupedSpriteComponent : public UMeshComponent

Inheritance Hierarchy

Implements Interfaces

Constructors

Name Remarks Include Path Unreal Specifiers

UPaperGroupedSpriteComponent ( const FObjectInitializer& ObjectInitializer
)

   PaperGroupedSpriteComponent.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

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

 Add an instance to this component. PaperGroupedSpriteComponent.h
  • BlueprintCallable
  • Category="Components|Sprite"

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

   PaperGroupedSpriteComponent.h  

virtual void ClearInstances()

 Clear all instances being rendered by this component PaperGroupedSpriteComponent.h
  • BlueprintCallable
  • Category="Components|Sprite"

bool ContainsSprite ( UPaperSprite* SpriteAsset
) const

 Returns true if this component references the specified sprite asset. PaperGroupedSpriteComponent.h  

int32 GetInstanceCount()

 Get the number of instances in this component PaperGroupedSpriteComponent.h
  • BlueprintCallable
  • Category="Components|Sprite"

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

 Get the transform for the instance specified. PaperGroupedSpriteComponent.h
  • BlueprintCallable
  • Category="Components|Sprite"

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

 Handles request from navigation system to gather instance transforms in a specific area box PaperGroupedSpriteComponent.h  

const TArray< FSpriteInstanceData > & GetPerInstanceSpriteData()

   PaperGroupedSpriteComponent.h  

void GetReferencedSpriteAssets ( TArray< UObject* >& InOutObjects
) const

 Adds all referenced sprite assets to the specified list. PaperGroupedSpriteComponent.h  

virtual bool RemoveInstance ( int32 InstanceIndex
)

 Remove the instance specified. Returns True on success. PaperGroupedSpriteComponent.h
  • BlueprintCallable
  • Category="Components|Sprite"

void SortInstancesAlongAxis ( FVector WorldSpaceSortAxis
)

 Sort all instances by their world space position along the specified axis PaperGroupedSpriteComponent.h
  • BlueprintCallable
  • Category="Components|Sprite"

virtual bool UpdateInstanceColor ( int32 InstanceIndex,
FLinearColor NewInstanceColor,
bool bMarkRenderStateDirty
)

 Update the color for the instance specified. Returns True on success. PaperGroupedSpriteComponent.h
  • BlueprintCallable
  • Category="Components|Sprite"

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

 Update the transform for the instance specified. PaperGroupedSpriteComponent.h
  • BlueprintCallable
  • Category="Components|Sprite"

Overridden from UPrimitiveComponent

Name Remarks Include Path Unreal Specifiers

virtual bool CanEditSimulatePhysics()

   PaperGroupedSpriteComponent.h  

virtual FPrimitiveSceneProxy * CreateSceneProxy()

   PaperGroupedSpriteComponent.h  

virtual UMaterialInterface * GetMaterial ( int32 MaterialIndex
) const

   PaperGroupedSpriteComponent.h  

virtual int32 GetNumMaterials()

   PaperGroupedSpriteComponent.h  

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

   PaperGroupedSpriteComponent.h  

Overridden from USceneComponent

Name Remarks Include Path Unreal Specifiers

virtual FBoxSphereBounds CalcBounds ( const FTransform& BoundTransform
) const

   PaperGroupedSpriteComponent.h  

virtual void OnUpdateTransform ( EUpdateTransformFlags UpdateTransformFlags,
ETeleportType Teleport
)

   PaperGroupedSpriteComponent.h  

Overridden from UActorComponent

Name Remarks Include Path Unreal Specifiers

virtual const UObject * AdditionalStatObject()

   PaperGroupedSpriteComponent.h  

virtual void CheckForErrors()

   PaperGroupedSpriteComponent.h  

virtual bool ShouldCreatePhysicsState()

   PaperGroupedSpriteComponent.h  

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual void PostEditChangeChainProperty ( FPropertyChangedChainEvent& PropertyChangedEvent
)

   PaperGroupedSpriteComponent.h  

virtual void PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

   PaperGroupedSpriteComponent.h  

virtual void PostEditUndo()

   PaperGroupedSpriteComponent.h  

Overridden from INavRelevantInterface

Name Remarks Include Path Unreal Specifiers

virtual bool DoCustomNavigableGeometryExport ( FNavigableGeometryExport& GeomExport
) const

   PaperGroupedSpriteComponent.h  

virtual void GetNavigationData ( FNavigationRelevantData& Data
) const

   PaperGroupedSpriteComponent.h  

Protected

Name Remarks Include Path Unreal Specifiers

void ClearAllInstanceBodies()

 Terminate all body instances owned by this component PaperGroupedSpriteComponent.h  

void CreateAllInstanceBodies()

 Creates body instances for all instances owned by this component PaperGroupedSpriteComponent.h  

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

 Creates a body instance for the specified instance data if that sprite has defined collision PaperGroupedSpriteComponent.h  

void RebuildInstances()

 Invalidates the render and collision state PaperGroupedSpriteComponent.h  

void RebuildMaterialList()

 Creates the material list from the instances PaperGroupedSpriteComponent.h  

void ReleasePerInstanceRenderData()

 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 PaperGroupedSpriteComponent.h  

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 PaperGroupedSpriteComponent.h  

int32 UpdateMaterialList ( UPaperSprite* Sprite,
UMaterialInterface* MaterialOverride
)

 Adds to the material list from a single sprite PaperGroupedSpriteComponent.h  

Overridden from UActorComponent

Name Remarks Include Path Unreal Specifiers

virtual void OnCreatePhysicsState()

   PaperGroupedSpriteComponent.h  

virtual void OnDestroyPhysicsState()

   PaperGroupedSpriteComponent.h  

See Also

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page