ANiagaraPreviewGrid

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

References

Module

Niagara

Header

/Engine/Plugins/FX/Niagara/Source/Niagara/Public/NiagaraPreviewGrid.h

Include

#include "NiagaraPreviewGrid.h"

Syntax

UCLASS()
class ANiagaraPreviewGrid : public AActor

Variables

Name Description

Public variable UProperty Category, EditAnywhere instanced

TObjectPtr< UNi...

 

PreviewAxisX

Object controlling behavior varying on the X axis.

Public variable UProperty Category, EditAnywhere instanced

TObjectPtr< UNi...

 

PreviewAxisY

Object controlling behavior varying on the Y axis.

Public variable UProperty Category, EditAnywhere

TSubclassOf< AN...

 

PreviewClass

Class used to for previews in this grid.

Public variable UProperty Category, EditAnywhere

ENiagaraPreview...

 

ResetMode

Public variable UProperty Category, EditAnywhere

float

 

SpacingX

TODO: Have the preview actor/class define the size of the preview to make spacing eaiser.

Public variable UProperty Category, EditAnywhere

float

 

SpacingY

The default spacing between previews if the axis does not override it.

Public variable UProperty Category, EditAnywhere

TObjectPtr< UNi...

 

System

Constructors

Name Description

Public function

ANiagaraPreviewGrid

(
    const FObjectInitializer& ObjectIn...
)

Functions

Name Description

Public function UFunction BlueprintCallable, Category

void

 

ActivatePreviews

(
    bool bReset
)

Public function UFunction BlueprintCallable, Category

void

 

DeactivatePreviews()

Public function UFunction BlueprintCallable, Category

void

 

GetPreviews

(
    TArray< UNiagaraComponent* >&...
)

Public function UFunction BlueprintCallable, Category

void

 

SetPaused

(
    bool bPaused
)

Overridden from AActor

Name Description

Public function Virtual Const

bool

 

ShouldTickIfViewportsOnly()

If true, actor is ticked even if TickType==LEVELTICK_ViewportsOnly

Public function Virtual

void

 

TickActor

(
    float DeltaTime,
    enum ELevelTick TickType,
    FActorTickFunction& ThisTickFuncti...
)

Dispatches the once-per frame Tick() function for this actor

Overridden from UObject

Name Description

Public function Virtual

void

 

BeginDestroy()

Called before destroying the object.

Public function Virtual

void

 

PostEditChangeProperty

(
    FPropertyChangedEvent& PropertyCha...
)

Called when a property on this object has been modified externally

Public function Virtual

void

 

PostLoad()

Do any object-specific cleanup required immediately after loading an object.