Navigation
API > API/Plugins > API/Plugins/Niagara
Inheritance Hierarchy
- UObjectBase
- UObjectBaseUtility
- UObject
- UNiagaraMergeable
- UNiagaraRendererProperties
- UNiagaraDecalRendererProperties
References
| Module | Niagara |
| Header | /Engine/Plugins/FX/Niagara/Source/Niagara/Public/NiagaraDecalRendererProperties.h |
| Include | #include "NiagaraDecalRendererProperties.h" |
Syntax
UCLASS (EditInlineNew, MinimalAPI, Meta=(DisplayName="Decal Renderer"))
class UNiagaraDecalRendererProperties : public UNiagaraRendererProperties
Variables
| Type | Name | Description | |
|---|---|---|---|
| FNiagaraVariableAttributeBinding | DecalColorBinding | Color binding for the decal, value can be queried using the Decal Color material node. | |
| FNiagaraDataSetAccessor< FLinearColor > | DecalColorDataSetAccessor | ||
| FNiagaraVariableAttributeBinding | DecalFadeBinding | Fade binding for the decal, value can be queried using the Decal Lifetime Opacity material node. | |
| FNiagaraDataSetAccessor< float > | DecalFadeDataSetAccessor | ||
| FNiagaraVariableAttributeBinding | DecalOrientationBinding | Orientation binding for the decal. | |
| FNiagaraDataSetAccessor< FQuat4f > | DecalOrientationDataSetAccessor | ||
| float | DecalScreenSizeFade | When the decal is smaller than this screen size fade out the decal, can be used to reduce the amount of small decals drawn. | |
| FNiagaraVariableAttributeBinding | DecalSizeBinding | Size binding for the decal. | |
| FNiagaraDataSetAccessor< FVector3f > | DecalSizeDataSetAccessor | ||
| FNiagaraVariableAttributeBinding | DecalSortOrderBinding | Sort Order binding for the decal, used to ensure decals to not flicker when overlapping. | |
| FNiagaraDataSetAccessor< int32 > | DecalSortOrderDataSetAccessor | ||
| FNiagaraDataSetAccessor< FNiagaraBool > | DecalVisibleAccessor | ||
| FNiagaraVariableAttributeBinding | DecalVisibleBinding | Should the decal be visibile or not, works in conjunction with RendererVisibilityTagBinding to determine visibility. | |
| TObjectPtr< UMaterialInterface > | Material | What material to use for the decal. | |
| FNiagaraParameterBinding | MaterialParameterBinding | Binding to material. | |
| FNiagaraRendererMaterialParameters | MaterialParameters | If this array has entries, we will create a MaterialInstanceDynamic per Emitter instance from Material and set the Material parameters using the Niagara simulation variables listed. | |
| TObjectPtr< UMaterialInstanceConstant > | MICMaterial | ||
| FNiagaraVariableAttributeBinding | PositionBinding | Position binding for the decals, should be center of the decal | |
| FNiagaraDataSetAccessor< FNiagaraPosition > | PositionDataSetAccessor | ||
| int32 | RendererVisibility | If a render visibility tag is present, particles whose tag matches this value will be visible in this renderer. | |
| FNiagaraDataSetAccessor< int32 > | RendererVisibilityTagAccessor | ||
| FNiagaraVariableAttributeBinding | RendererVisibilityTagBinding | Visibility tag binding, when valid the returned values is compated with RendererVisibility. | |
| ENiagaraRendererSourceDataMode | SourceMode | Whether or not to draw a single element for the Emitter or to draw the particles. |
Constructors
| Type | Name | Description | |
|---|---|---|---|
Functions
| Type | Name | Description | |
|---|---|---|---|
| const float | |||
| const FVector3f | |||
| const int32 | |||
| const FNiagaraBool | |||
| const FQuat4f | |||
| UMaterialInterface * | GetMaterial
(
const FNiagaraEmitterInstance* InEmitter |
||
| void | |||
| void | UpdateMICs () |
Overridden from UNiagaraRendererProperties
| Type | Name | Description | |
|---|---|---|---|
| void | CacheFromCompiledData
(
const FNiagaraDataSetCompiledData* CompiledData |
||
| FNiagaraBoundsCalculator * | |||
| FNiagaraRenderer * | CreateEmitterRenderer
(
ERHIFeatureLevel::Type FeatureLevel, |
||
| TArray< FNiagaraVariable > | |||
| ENiagaraRendererSourceDataMode | |||
| const TArray< FNiagaraVariable > & | |||
| void | GetRendererFeedback
(
const FVersionedNiagaraEmitter& InEmitter, |
||
| void | GetRendererTooltipWidgets
(
const FNiagaraEmitterInstance* InEmitter, |
||
| void | GetRendererWidgets
(
const FNiagaraEmitterInstance* InEmitter, |
||
| const FSlateBrush * | GetStackIcon () |
The icon to display in the niagara stack widget under the renderer section. | |
| void | GetUsedMaterials
(
const FNiagaraEmitterInstance* InEmitter, |
||
| bool | IsSimTargetSupported
(
ENiagaraSimTarget InSimTarget |
||
| bool | |||
| bool | PopulateRequiredBindings
(
FNiagaraParameterStore& InParameterStore |
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. | |
| void | RemoveVariable
(
const FNiagaraVariableBase& OldVariable, |
||
| void | RenameVariable
(
const FNiagaraVariableBase& OldVariable, |
||
| void | UpdateSourceModeDerivates
(
ENiagaraRendererSourceDataMode InSourceMode, |
Overridden from UObject
| Type | Name | Description | |
|---|---|---|---|
| void | PostEditChangeProperty
(
FPropertyChangedEvent& PropertyChangedEvent |
Called when a property on this object has been modified externally | |
| void | Called after the C++ constructor and after the properties have been initialized, including those loaded from config. | ||
| void | PostLoad () |
Do any object-specific cleanup required immediately after loading an object. | |
| void | Handles reading, writing, and reference collecting using FArchive. |