1. Epic GamesDeveloper
  3. UNiagaraLightRendererProperties

UNiagaraLightRendererProperties

API > API/Plugins > API/Plugins/Niagara

Inheritance Hierarchy

References

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

Syntax

UCLASS (EditInlineNew, MinimalAPI, Meta=(DisplayName="Light Renderer"))  
class UNiagaraLightRendererProperties : public UNiagaraRendererProperties

Variables

  Type Name Description
Public variable UProperty Category, EditAnywhere uint32: 1 bAffectsTranslucency Whether lights from this renderer should affect translucency.
Public variable UProperty Category, EditAnywhere uint32: 1 bAlphaScalesBrightness When checked, will treat the alpha value of the particle's color as a multiplier of the light's brightness.
Public variable UProperty Category, EditAnywhere, Meta uint32: 1 bOverrideInverseExposureBlend When enabled we will override the project default setting with our local setting.
Public variable UProperty Category, EditAnywhere uint32: 1 bUseInverseSquaredFalloff Whether to use physically based inverse squared falloff from the light.
Public variable UProperty Category, EditAnywhere FVector3f ColorAdd A static color shift applied to each rendered light
Public variable UProperty Category, EditAnywhere FNiagaraVariableAttributeBinding ColorBinding Which attribute should we use for light color when generating lights?
Public variable FNiagaraDataSetAccessor< FLinearColor > ColorDataSetAccessor  
Public variable UProperty Category, EditAnywhere, Meta float DefaultExponent The exponent to use for all lights if no exponent binding was found
Public variable UProperty Category, EditAnywhere, Meta float DiffuseScale The diffuse scale to use for all lights if no binding was found
Public variable FNiagaraDataSetAccessor< float > DiffuseScaleAccessor  
Public variable UProperty Category, EditAnywhere FNiagaraVariableAttributeBinding DiffuseScaleBinding Which attribute should we use for the diffuse scale when generating lights?
Public variable FNiagaraDataSetAccessor< FNiagaraBool > EnabledDataSetAccessor  
Public variable FNiagaraDataSetAccessor< float > ExponentDataSetAccessor  
Public variable UProperty Category, EditAnywhere, AdvancedDisplay, Meta BlueprintReadOnly float InverseExposureBlend Blend Factor used to blend between Intensity and Intensity/Exposure.
Public variable UProperty Category, EditAnywhere, Meta FNiagaraVariableAttributeBinding LightExponentBinding Which attribute should we use for the light's exponent when inverse squared falloff is disabled?
Public variable UProperty Category, EditAnywhere FNiagaraVariableAttributeBinding LightRenderingEnabledBinding Which attribute should we use to check if light rendering should be enabled for a particle? This can be used to control the spawn-rate on a per-particle basis.
Public variable UProperty Category, EditAnywhere FNiagaraVariableAttributeBinding PositionBinding Which attribute should we use for position when generating lights?
Public variable FNiagaraDataSetAccessor< FNiagaraPosition > PositionDataSetAccessor  
Public variable UProperty Category, EditAnywhere FNiagaraVariableAttributeBinding RadiusBinding Which attribute should we use for light radius when generating lights?
Public variable FNiagaraDataSetAccessor< float > RadiusDataSetAccessor  
Public variable UProperty Category, EditAnywhere, Meta float RadiusScale A factor used to scale each particle light radius
Public variable UProperty Category, EditAnywhere int32 RendererVisibility If a render visibility tag is present, particles whose tag matches this value will be visible in this renderer.
Public variable FNiagaraDataSetAccessor< int32 > RendererVisibilityTagAccessor  
Public variable UProperty Category, EditAnywhere FNiagaraVariableAttributeBinding RendererVisibilityTagBinding Which attribute should we use for the renderer visibility tag?
Public variable FNiagaraDataSetAccessor< float > ScatteringDataSetAccessor  
Public variable UProperty Category, EditAnywhere ENiagaraRendererSourceDataMode SourceMode Whether or not to draw a single element for the Emitter or to draw the particles.
Public variable UProperty Category, EditAnywhere, Meta float SpecularScale The specular scale to use for all lights if no binding was found
Public variable FNiagaraDataSetAccessor< float > SpecularScaleAccessor  
Public variable UProperty Category, EditAnywhere FNiagaraVariableAttributeBinding SpecularScaleBinding Which attribute should we use for the specular scale when generating lights?
Public variable UProperty Category, EditAnywhere FNiagaraVariableAttributeBinding VolumetricScatteringBinding Which attribute should we use for the intensity of the volumetric scattering from this light? This scales the light's intensity and color.

Constructors

  Type Name Description
Public function    

Functions

  Type Name Description
Public function Static void The bindings depend on variables that are created during the NiagaraModule startup.

Overridden from UNiagaraRendererProperties

  Type Name Description
Public function Virtual void  
Public function Virtual FNiagaraBoundsCalculator *  
Public function Virtual FNiagaraRenderer *  
Public function Virtual Const ENiagaraRendererSourceDataMode  
Public function Virtual const TArray< FNiagaraVariable > &  
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 void

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

  
Public function Virtual Const bool  
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.
Public function Virtual void

UpdateSourceModeDerivates ( ENiagaraRendererSourceDataMode InSourceMode,
bool bFromPropertyEdit
)

  

Overridden from UObject

  Type Name Description
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.

Constants

Name Description
LightRendererPropertiesToDeferredInit  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page