Navigation
API > API/Plugins > API/Plugins/Niagara
| Name | ANiagaraPreviewGrid |
| Type | class |
| Header File | /Engine/Plugins/FX/Niagara/Source/Niagara/Public/NiagaraPreviewGrid.h |
| Include Path | #include "NiagaraPreviewGrid.h" |
Syntax
UCLASS ()
class ANiagaraPreviewGrid : public AActor
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → AActor → ANiagaraPreviewGrid
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
ANiagaraPreviewGrid
(
const FObjectInitializer& ObjectInitializer |
NiagaraPreviewGrid.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| PreviewAxisX | TObjectPtr< UNiagaraPreviewAxis > | Object controlling behavior varying on the X axis. | NiagaraPreviewGrid.h |
|
| PreviewAxisY | TObjectPtr< UNiagaraPreviewAxis > | Object controlling behavior varying on the Y axis. | NiagaraPreviewGrid.h |
|
| PreviewClass | TSubclassOf< ANiagaraPreviewBase > | Class used to for previews in this grid. | NiagaraPreviewGrid.h |
|
| ResetMode | ENiagaraPreviewGridResetMode | NiagaraPreviewGrid.h |
|
|
| SpacingX | float | TODO: Have the preview actor/class define the size of the preview to make spacing eaiser. | NiagaraPreviewGrid.h |
|
| SpacingY | float | The default spacing between previews if the axis does not override it. | NiagaraPreviewGrid.h |
|
| System | TObjectPtr< UNiagaraSystem > | NiagaraPreviewGrid.h |
|
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| ArrowComponent | TObjectPtr< class UArrowComponent > | Reference to arrow visualization component. | NiagaraPreviewGrid.h | |
| bPreviewActive | uint32 | NiagaraPreviewGrid.h | ||
| bPreviewDirty | uint32 | NiagaraPreviewGrid.h | ||
| NumX | int32 | NiagaraPreviewGrid.h |
|
|
| NumY | int32 | NiagaraPreviewGrid.h |
|
|
| PreviewComponents | TArray< TObjectPtr< UChildActorComponent > > | NiagaraPreviewGrid.h |
|
|
| SpriteComponent | TObjectPtr< class UBillboardComponent > | Reference to sprite visualization component. | NiagaraPreviewGrid.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void ActivatePreviews
(
bool bReset |
NiagaraPreviewGrid.h |
|
|
void DeactivatePreviews() |
NiagaraPreviewGrid.h |
|
|
void GetPreviews
(
TArray< UNiagaraComponent* >& OutPreviews |
NiagaraPreviewGrid.h |
|
|
void SetPaused
(
bool bPaused |
NiagaraPreviewGrid.h |
|
Overridden from AActor
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual bool ShouldTickIfViewportsOnly() |
NiagaraPreviewGrid.h | ||
virtual void TickActor
(
float DeltaTime, |
NiagaraPreviewGrid.h |
Overridden from UObject
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void BeginDestroy() |
NiagaraPreviewGrid.h | ||
virtual void PostEditChangeProperty
(
FPropertyChangedEvent& PropertyChangedEvent |
NiagaraPreviewGrid.h | ||
virtual void PostLoad() |
NiagaraPreviewGrid.h |