Navigation
Unreal Engine C++ API Reference > Plugins > Paper2D
Inheritance Hierarchy
- UMeshComponent
- PAPER2UPaperGroupedSpriteComponent
References
Module | Paper2D |
Header | /Engine/Plugins/2D/Paper2D/Source/Paper2D/Classes/PaperGroupedSpriteComponent.h |
Include | #include "PaperGroupedSpriteComponent.h" |
Syntax
UCLASS (ShowCategories=(Mobility), ClassGroup=Paper2D, Meta=(BlueprintSpawnableComponent),
EarlyAccessPreview)
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 | |
---|---|---|---|
![]() |
friend | FGroupedSpriteSceneProxy | |
![]() |
TArray< FBodyInstance * > | InstanceBodies | Physics representation of the instance bodies |
![]() ![]() |
TArray< TObjectPtr< UMaterialInterface > > | InstanceMaterials | Array of materials used by the instances |
![]() ![]() ![]() ![]() |
TArray< FSpriteInstanceData > | PerInstanceSpriteData | Array of instances |
Constructors
Type | Name | Description | |
---|---|---|---|
![]() |
PAPER2UPaperGroupedSpriteComponent
(
const FObjectInitializer& ObjectInitializer |
Functions
Type | Name | Description | |
---|---|---|---|
![]() ![]() ![]() |
int32 | AddInstance
(
const FTransform& Transform, |
Add an instance to this component. |
![]() ![]() |
int32 | AddInstanceWithMaterial
(
const FTransform& Transform, |
|
![]() ![]() ![]() |
const UObject * | ||
![]() ![]() ![]() |
FBoxSphereBounds | CalcBounds
(
const FTransform& BoundTransform |
|
![]() ![]() |
bool | ||
![]() ![]() |
void | ||
![]() |
void | Terminate all body instances owned by this component | |
![]() ![]() ![]() ![]() |
void | Clear all instances being rendered by this component | |
![]() ![]() |
bool | ContainsSprite
(
UPaperSprite* SpriteAsset |
Returns true if this component references the specified sprite asset. |
![]() |
void | Creates body instances for all instances owned by this component | |
![]() ![]() |
FPrimitiveSceneProxy * | ||
![]() ![]() ![]() |
bool | DoCustomNavigableGeometryExport
(
FNavigableGeometryExport& GeomExport |
|
![]() ![]() ![]() ![]() |
int32 | Get the number of instances in this component | |
![]() ![]() ![]() ![]() |
bool | GetInstanceTransform
(
int32 InstanceIndex, |
Get the transform for the instance specified. |
![]() ![]() ![]() |
UMaterialInterface * | GetMaterial
(
int32 MaterialIndex |
|
![]() ![]() ![]() |
void | GetNavigationData
(
FNavigationRelevantData& Data |
|
![]() ![]() |
void | GetNavigationPerInstanceTransforms
(
const FBox& AreaBox, |
Handles request from navigation system to gather instance transforms in a specific area box |
![]() ![]() ![]() |
int32 | ||
![]() ![]() |
const TArray< FSpriteInstanceData > & | ||
![]() ![]() |
void | GetReferencedSpriteAssets
(
TArray< UObject* >& InOutObjects |
Adds all referenced sprite assets to the specified list. |
![]() ![]() |
void | GetUsedTextures
(
TArray< UTexture* >& OutTextures, |
|
![]() |
FBodyInstance * | InitInstanceBody
(
int32 InstanceIndex, |
Creates a body instance for the specified instance data if that sprite has defined collision |
![]() ![]() |
void | ||
![]() ![]() |
void | ||
![]() ![]() |
void | OnUpdateTransform
(
EUpdateTransformFlags UpdateTransformFlags, |
|
![]() ![]() |
void | PostEditChangeChainProperty
(
FPropertyChangedChainEvent& PropertyChangedEvent |
|
![]() ![]() |
void | PostEditChangeProperty
(
FPropertyChangedEvent& PropertyChangedEvent |
|
![]() ![]() |
void | PostEditUndo () |
|
![]() |
void | Invalidates the render and collision state | |
![]() |
void | Creates the material list from the instances | |
![]() |
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 | |
![]() ![]() ![]() ![]() |
bool | RemoveInstance
(
int32 InstanceIndex |
Remove the instance specified. Returns True on success. |
![]() |
void | SetupNewInstanceData
(
FSpriteInstanceData& InOutNewInstanceData, |
Sets up new instance data to sensible defaults, creates physics counterparts if possible |
![]() ![]() ![]() |
bool | ||
![]() ![]() ![]() |
void | SortInstancesAlongAxis
(
FVector WorldSpaceSortAxis |
Sort all instances by their world space position along the specified axis |
![]() ![]() ![]() ![]() |
bool | UpdateInstanceColor
(
int32 InstanceIndex, |
Update the color for the instance specified. Returns True on success. |
![]() ![]() ![]() ![]() |
bool | UpdateInstanceTransform
(
int32 InstanceIndex, |
Update the transform for the instance specified. |
![]() |
int32 | UpdateMaterialList
(
UPaperSprite* Sprite, |
Adds to the material list from a single sprite |
See Also
UPrimitiveComponent
UPaperSprite