1. Epic GamesDeveloper
  3. UNiagaraRendererProperties

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.

API > API/Plugins > API/Plugins/Niagara

Inheritance Hierarchy

References

   
Module Niagara
Header /Engine/Plugins/FX/Niagara/Source/Niagara/Public/NiagaraRendererProperties.h
Include #include "NiagaraRendererProperties.h"

Syntax

UCLASS (Abstract, MinimalAPI)  
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

  Type Name Description
Protected variable TArray< const FNiagaraVariableAttributeBinding * > AttributeBindings  
Public variable UProperty Category, EditAnywhere bool bAllowInCullProxies  
Public variable UProperty bool bIsEnabled  
Public variable UProperty Category, EditAnywhere ENiagaraRendererMotionVectorSetting MotionVectorSetting Hint about how to generate motion (velocity) vectors for this renderer.
Protected variable FOnPropertiesChanged OnPropertiesChangedDelegate  
Public variable UProperty FGuid OuterEmitterVersion  
Public variable UProperty Category, EditAnywhere, Meta FNiagaraPlatformSet Platforms Platforms on which this renderer is enabled.
Public variable UProperty Category, EditAnywhere FNiagaraVariableAttributeBinding RendererEnabledBinding Binding to control if the renderer is enabled or disabled.
Public variable UProperty Category, EditAnywhere int32 SortOrderHint By default, emitters are drawn in the order that they are added to the system.

Constructors

  Type Name Description
Public function    

Functions

  Type Name Description
Protected function Const bool

BuildMaterialStaticParameterSet ( const FNiagaraRendererMaterialParameters& MaterialParameters,
const UMaterialInterface* Material,
FStaticParameterSet& StaticParameterSet
)

 Generates the static parameter set for the parent emitter
Public function Virtual void  
Protected function Static void Utility function that can be used to fix up old vec3 bindings into position bindings.
Public function Virtual Const void  
Public function Const void

CollectPSOPrecacheData ( FNiagaraEmitterInstance* EmitterInstance,
FMaterialInterfacePSOPrecacheParamsList& MaterialInterfacePSOPrecacheParamsList
)

 Collect PSO precache data using the optional emitter instance
Public function Const uint32

ComputeMaxUsedComponents ( const FNiagaraDataSetCompiledData* CompiledDataSetData
)

  
Public function Virtual FNiagaraBoundsCalculator *  
Public function Virtual FNiagaraRenderer *  
Public function Virtual void

FixMaterial ( UMaterial* Material
)

  
Public function void

ForEachPlatformSet ( TAction Func
)

  
Public function Virtual Const void  
Public function Virtual Const void

GetAssetTagsForContext ( const UObject* InAsset,
FGuid AssetVersion,
const TArray< const UNiagaraRendererProperties* >& InProperties,
TMap< FName, uint32 >& NumericKeys,
TMap< FName, FString >& StringKeys
)

 Method to add asset tags that are specific to this renderer.
Public function Const const TArray< const FNiagaraVariableAttributeBinding * > &  
Public function Virtual Const FNiagaraVariable 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< FNiagaraVariable >  
Public function Virtual Const ENiagaraRendererSourceDataMode  
Protected function Const int32

GetDynamicParameterChannelMask ( const FVersionedNiagaraEmitterData* EmitterData,
FName BindingName,
int32 DefaultChannelMask
)

  
Protected function Const int32

GetDynamicParameterCombinedChannelMask ( FName Parameter0Name,
FName Parameter1Name,
FName Parameter2Name,
FName Parameter3Name
)

  
Public function Const FVersionedNiagaraEmitterData *  
Public function Virtual Const bool  
Public function Virtual Const bool  
Public function Virtual Const float  
Public function Virtual const TArray< FNiagaraVariable > &  
Public function Const FVersionedNiagaraEmitter  
Public function Virtual Const void  
Public function Virtual Const void

GetRendererFeedback ( const FVersionedNiagaraEmitter& InEmitter,
TArray< FText >& OutErrors,
TArray< FText >& OutWarnings,
TArray< FText >& OutInfo
)

  
Public function Virtual Const void

GetRendererTooltipWidgets ( const FNiagaraEmitterInstance* InEmitter,
TArray< TSharedPtr< SWidget > >& OutWidgets,
TSharedPtr< FAssetThumbnailPool > InThumbnailPool
)

  
Public function Virtual Const void

GetRendererWidgets ( const FNiagaraEmitterInstance* InEmitter,
TArray< TSharedPtr< SWidget > >& OutWidgets,
TSharedPtr< FAssetThumbnailPool > InThumbnailPool
)

  
Public function Virtual const TArray< FNiagaraVariable > &  
Public function Virtual Const const FSlateBrush * The icon to display in the niagara stack widget under the renderer section.
Public function Virtual Const void

GetStreamingMeshInfo ( const FBoxSphereBounds& OwnerBounds,
const FNiagaraEmitterInstance* InEmitter,
TArray< FStreamingRenderAssetPrimitiveInfo >& OutStreamingRenderAssets
)

  
Public function Virtual Const void

GetUsedMaterials ( const FNiagaraEmitterInstance* InEmitter,
TArray< UMaterialInterface* >& OutMaterials
)

  
Public function Virtual Const const FVertexFactoryType *  
Public function Virtual Const FText The text to display in the niagara stack widget under the renderer section.
Protected function void

InitParticleDataSetAccessor ( TAccessorType& Accessor,
const FNiagaraDataSetCompiledData* CompiledData,
const FNiagaraVariableAttributeBinding& Binding
)

  
Public function Virtual Const bool  
Public function Static bool Is the Gpu translucent data going to be this frame, this can be restricted by things like feature level.
Public function Virtual bool

IsMaterialValidForRenderer ( UMaterial* Material,
FText& InvalidMessage
)

  
Public function Virtual Const bool  
Public function Static bool  
Public function Virtual Const bool

IsSupportedVariableForBinding ( const FNiagaraVariableBase& InSourceForBinding,
const FName& InTargetBindingName
)

  
Public function Virtual Const bool  
Public function Const bool  
Public function Virtual Const bool When true, the renderer will be opted in to get its OnSystemComplete_GameThread overload called
Public function Virtual Const bool When true, the renderer will be opted in to get its PostSystemTick_GameThread overload called
Public function FOnPropertiesChanged &  
Public function Virtual bool 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  
Public function Virtual void

RemoveVariable ( const FNiagaraVariableBase& OldVariable,
const FVersionedNiagaraEmitter& InEmitter
)

  
Public function Virtual void

RenameEmitter ( const FName& InOldName,
const UNiagaraEmitter* InRenamedEmitter
)

 Internal handling of any emitter variable renames.
Public function Virtual void

RenameVariable ( const FNiagaraVariableBase& OldVariable,
const FNiagaraVariableBase& NewVariable,
const FVersionedNiagaraEmitter& InEmitter
)

  
Public function Virtual void

SetIsEnabled ( bool bInIsEnabled
)

  
Public function Static bool Should the Gpu translucent data be this frame or not?
Public function Const UNiagaraRendererProperties *  
Protected function void

UpdateMaterialParametersMIC ( const FNiagaraRendererMaterialParameters& MaterialParameters,
TObjectPtr< UMaterialInterface >& InOutMaterial,
TObjectPtr< UMaterialInstanceConstant >& InOutMIC
)

 Utility function to updates MICs.
Protected function void

UpdateMaterialParametersMIC ( const FNiagaraRendererMaterialParameters& MaterialParameters,
TArrayView< UMaterialInterface* > Materials,
TArray< TObjectPtr< UMaterialInstanceConstant > >& InOutMICs
)

  
Protected function bool

UpdateMaterialStaticParameters ( const FNiagaraRendererMaterialParameters& MaterialParameters,
UMaterialInstanceConstant* MIC
)

 Update MIC Static Parameters.
Protected function Virtual void

UpdateSourceModeDerivates ( ENiagaraRendererSourceDataMode InSourceMode,
bool bFromPropertyEdit
)

  
Public function Virtual Const bool  

Overridden from UObject

  Type Name Description
Public function Virtual Const bool

NeedsLoadForTargetPlatform ( const ITargetPlatform* TargetPlatform
)

 Called during saving to determine the load flags to save with the object.
Public function Virtual void

PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

 Called when a property on this object has been modified externally
Public function Virtual void Called after the C++ constructor and after the properties have been initialized, including those loaded from config.
Public function Virtual void Do any object-specific cleanup required immediately after loading an object.

Classes

  Type Name Description
Public struct FPSOPrecacheParams Collect all the data required for PSO precaching  

Typedefs

Name Description
FOnPropertiesChanged  
FPSOPrecacheParamsList  

Deprecated Variables

  Type Name Description
Protected variable UProperty bool bMotionBlurEnabled_DEPRECATED  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page