UNiagaraRendererProperties

Emitter properties base class Each EmitterRenderer derives from this with its own class, and returns it in GetProperties; a copy of those specific properties is stored on [UNiagaraEmitter](API\Plugins\Niagara\UNiagaraEmitter) (on the System) for serialization and handed back to the System renderer on load.

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

References

Module

Niagara

Header

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

Include

#include "NiagaraRendererProperties.h"

Syntax

UCLASS(Abstract)
class UNiagaraRendererProperties : public UNiagaraMergeable

Remarks

Emitter properties base class Each EmitterRenderer derives from this with its own class, and returns it in GetProperties; a copy of those specific properties is stored on UNiagaraEmitter (on the System) for serialization and handed back to the System renderer on load.

Variables

Name Description

Protected variable

TArray< const F...

 

AttributeBindings

Public variable UProperty Category, EditAnywhere

bool

 

bAllowInCullProxies

Public variable UProperty

bool

 

bIsEnabled

Public variable UProperty Category, EditAnywhere

ENiagaraRendere...

 

MotionVectorSetting

Hint about how to generate motion (velocity) vectors for this renderer.

Public variable UProperty Category, EditAnywhere

FNiagaraPlatfor...

 

Platforms

Platforms on which this renderer is enabled.

Public variable UProperty Category, EditAnywhere

FNiagaraVariabl...

 

RendererEnabledBinding

Optional bool binding to dynamically enable / disable the renderer.

Public variable UProperty Category, EditAnywhere

int32

 

SortOrderHint

By default, emitters are drawn in the order that they are added to the system.

Constructors

Name Description

Public function

UNiagaraRendererProperties()

Functions

Name Description

Public function Virtual

void

 

CacheFromCompiledData

(
    const FNiagaraDataSetCompiledData&...
)

Public function Const

uint32

 

ComputeMaxUsedComponents

(
    const FNiagaraDataSetCompiledData&...
)

Public function Virtual

FNiagaraBoun...

 

CreateBoundsCalculator()

Public function Virtual

FNiagaraRend...

 

CreateEmitterRenderer

(
    ERHIFeatureLevel::Type FeatureLevel,
    const FNiagaraEmitterInstance*...,
    const FNiagaraSystemInstanceControl...
)

Public function Virtual

void

 

FixMaterial

(
    UMaterial* Material
)

Public function Virtual Const

void

 

GetAdditionalVariables

(
    TArray< FNiagaraVariableBase >& Ou...
)

Public function Virtual Const

void

 

GetAssetTagsForContext

(
    const UObject* InAsset,
    const TArray< const UNiagaraRendere...,
    TMap< FName, uint32 >& NumericKeys,
    TMap< FName, FString >& StringKeys
)

Method to add asset tags that are specific to this renderer.

Public function Const

const TArray...

 

GetAttributeBindings()

Protected function Virtual Const

FNiagaraVari...

 

GetBoundAttribute

(
    const FNiagaraVariableAttributeBind...
)

Returns the variable associated with the supplied binding if it should be bound given the current settings of the RendererProperties.

Public function Virtual Const

TArray< FNia...

 

GetBoundAttributes()

Public function Virtual Const

ENiagaraRend...

 

GetCurrentSourceMode()

Public function Virtual Const

bool

 

GetIsActive()

Public function Virtual Const

bool

 

GetIsEnabled()

Public function Virtual

const TArray...

 

GetOptionalAttributes()

Public function Virtual Const

void

 

GetRendererFeedback

(
    const UNiagaraEmitter* InEmitt...,
    TArray< FText >& OutErrors,
    TArray< FText >& OutWarnings,
    TArray< FText >& OutInfo
)

Public function Virtual Const

void

 

GetRendererFeedback

(
    UNiagaraEmitter* InEmitter,
    TArray< FNiagaraRendererFeedback > ...,
    TArray< FNiagaraRendererFeedback > ...,
    TArray< FNiagaraRendererFeedback > ...
)

Public function Virtual Const

void

 

GetRendererTooltipWidgets

(
    const FNiagaraEmitterInstance*...,
    TArray< TSharedPtr< SWidget >>& Ou...,
    TSharedPtr< FAssetThumbnailPool > I...
)

Public function Virtual Const

void

 

GetRendererWidgets

(
    const FNiagaraEmitterInstance*...,
    TArray< TSharedPtr< SWidget >>& Ou...,
    TSharedPtr< FAssetThumbnailPool > I...
)

Public function Virtual

const TArray...

 

GetRequiredAttributes()

Public function Virtual Const

const FSlate...

 

GetStackIcon()

The icon to display in the niagara stack widget under the renderer section.

Public function Virtual Const

void

 

GetUsedMaterials

(
    const FNiagaraEmitterInstance*...,
    TArray< UMaterialInterface* > ...
)

Public function Virtual Const

FText

 

GetWidgetDisplayName()

The text to display in the niagara stack widget under the renderer section.

Public function Virtual

bool

 

IsMaterialValidForRenderer

(
    UMaterial* Material,
    FText& InvalidMessage
)

Public function Virtual Const

bool

 

IsSimTargetSupported

(
    ENiagaraSimTarget InSimTarget
)

Public function Virtual Const

bool

 

IsSupportedVariableForBinding

(
    const FNiagaraVariableBase& InSour...,
    const FName& InTargetBindingName
)

Public function Virtual Const

bool

 

NeedsMIDsForMaterials()

Public function Const

bool

 

NeedsPreciseMotionVectors()

Public function Virtual Const

bool

 

NeedsSystemCompletion()

When true, the renderer will be opted in to get its OnSystemComplete_GameThread overload called

Public function Virtual Const

bool

 

NeedsSystemPostTick()

When true, the renderer will be opted in to get its PostSystemTick_GameThread overload called

Public function Virtual

bool

 

PopulateRequiredBindings

(
    FNiagaraParameterStore& InParamete...
)

In the case that we need parameters bound in that aren't Particle variables, these should be set up here so that the data is appropriately populated after the simulation.

Protected function Virtual

void

 

PostLoadBindings

(
    ENiagaraRendererSourceDataMode InSo...
)

Public function Virtual

void

 

RemoveVariable

(
    const FNiagaraVariableBase& OldVar...,
    const UNiagaraEmitter* InEmitt...
)

Public function Virtual

void

 

RenameEmitter

(
    const FName& InOldName,
    const UNiagaraEmitter* InRenam...
)

Internal handling of any emitter variable renames.

Public function Virtual

void

 

RenameVariable

(
    const FNiagaraVariableBase& OldVar...,
    const FNiagaraVariableBase& NewVar...,
    const UNiagaraEmitter* InEmitt...
)

Public function Virtual

void

 

SetIsEnabled

(
    bool bInIsEnabled
)

Public function Const

UNiagaraRend...

 

StaticDuplicateWithNewMergeId

(
    UObject* InOuter
)

Protected function Virtual

void

 

UpdateSourceModeDerivates

(
    ENiagaraRendererSourceDataMode InSo...,
    bool bFromPropertyEdit
)

Overridden from UObject

Name Description

Public function Virtual Const

bool

 

NeedsLoadForTargetPlatform

(
    const ITargetPlatform* TargetP...
)

Called during saving to determine the load flags to save with the object.

Public function Virtual

void

 

PostEditChangeProperty

(
    FPropertyChangedEvent& PropertyCha...
)

Called when a property on this object has been modified externally

Public function Virtual

void

 

PostInitProperties()

Called after the C++ constructor and after the properties have been initialized, including those loaded from config.

Public function Virtual

void

 

PostLoad()

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

Deprecated Variables

Name Description

Protected variable UProperty

bool

 

bMotionBlurEnabled_DEPRECATED