Navigation
API > API/Plugins > API/Plugins/Niagara
Inheritance Hierarchy
- UObjectBase
- UObjectBaseUtility
- UObject
- UNiagaraMergeable
- UNiagaraRendererProperties
- UNiagaraMeshRendererProperties
References
| Module | Niagara |
| Header | /Engine/Plugins/FX/Niagara/Source/Niagara/Public/NiagaraMeshRendererProperties.h |
| Include | #include "NiagaraMeshRendererProperties.h" |
Syntax
UCLASS (EditInlineNew, Meta=(DisplayName="Mesh Renderer", SupportsStateless), MinimalAPI)
class UNiagaraMeshRendererProperties : public UNiagaraRendererProperties
Variables
| Type | Name | Description | |
|---|---|---|---|
| uint8: 1 = 1 | bCastShadows | When disabled the renderer will not cast shadows. | |
| uint32: 1 | bEnableCameraDistanceCulling | Enables frustum culling of individual mesh particles | |
| uint32: 1 | bEnableFrustumCulling | Enables frustum culling of individual mesh particles | |
| uint32: 1 | bEnableMeshFlipbook | When checked, will treat 'ParticleMesh' as the first frame of the flipbook, and will use the other mesh flipbook options to find the other frames | |
| uint32: 1 | bLockedAxisEnable | If true and in a non-default facing mode, will lock facing direction to an arbitrary plane of rotation | |
| uint32: 1 | bOverrideMaterials | Whether or not to use the OverrideMaterials array instead of the mesh's existing materials. | |
| uint32: 1 | bSortOnlyWhenTranslucent | If true, the particles are only sorted when using a translucent material. | |
| uint32: 1 | bSubImageBlend | If true, blends the sub-image UV lookup with its next adjacent member using the fractional part of the SubImageIndex float value as the linear interpolation factor. | |
| uint32: 1 | bUseHeterogeneousVolumes | Whether or not to render with heterogeneous volumes. | |
| FNiagaraVariableAttributeBinding | CameraOffsetBinding | Which attribute should we use for camera offset when rendering meshes? | |
| FNiagaraVariableAttributeBinding | ColorBinding | Which attribute should we use for color when generating instanced meshes? | |
| FNiagaraVariableAttributeBinding | CustomSortingBinding | Which attribute should we use custom sorting of particles in this emitter. | |
| FNiagaraVariableAttributeBinding | DynamicMaterial1Binding | Which attribute should we use for dynamic material parameters when generating instanced meshes? | |
| FNiagaraVariableAttributeBinding | DynamicMaterial2Binding | Which attribute should we use for dynamic material parameters when generating instanced meshes? | |
| FNiagaraVariableAttributeBinding | DynamicMaterial3Binding | Which attribute should we use for dynamic material parameters when generating instanced meshes? | |
| FNiagaraVariableAttributeBinding | DynamicMaterialBinding | Which attribute should we use for dynamic material parameters when generating instanced meshes? | |
| ENiagaraMeshFacingMode | FacingMode | Determines how the mesh orients itself relative to the camera. | |
| TObjectPtr< UStaticMesh > | FirstFlipbookFrame | The static mesh to use for the first frame of the flipbook. | |
| FString | FlipbookSuffixFormat | Provides the format of the suffix of the names of the static meshes when searching for flipbook frames. | |
| uint32 | FlipbookSuffixNumDigits | The number of digits to expect in the frame number of the flipbook page. | |
| ENiagaraRendererGpuTranslucentLatency | GpuTranslucentLatency | Gpu simulations run at different points in the frame depending on what features are used, i.e. depth buffer, distance fields, etc. | |
| FVector | LockedAxis | Arbitrary axis by which to lock facing rotations | |
| ENiagaraMeshLockedAxisSpace | LockedAxisSpace | Specifies what space the locked axis is in | |
| 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. | |
| uint32 | MaterialParamValidMask | ||
| FNiagaraVariableAttributeBinding | MaterialRandomBinding | Which attribute should we use for material randoms when generating instanced meshes? | |
| float | MaxCameraDistance | ||
| FVector | MeshBoundsScale | Scale factor applied to all of the meshes bounds. | |
| TArray< FNiagaraMeshRendererMeshProperties > | Meshes | The static mesh(es) to be instanced when rendering mesh particles. | |
| FNiagaraVariableAttributeBinding | MeshIndexBinding | Which attribute should we use to pick the element in the mesh array on the mesh renderer? | |
| FNiagaraVariableAttributeBinding | MeshOrientationBinding | Which attribute should we use for orienting meshes when generating instanced meshes? | |
| TArray< FNiagaraMeshMICOverride > | MICOverrideMaterials | ||
| float | MinCameraDistance | ||
| FNiagaraVariableAttributeBinding | NormalizedAgeBinding | Which attribute should we use for Normalized Age? | |
| uint32 | NumFlipbookFrames | The number of frames (static meshes) to be included in the flipbook. | |
| TArray< FNiagaraMeshMaterialOverride > | OverrideMaterials | The materials to be used instead of the StaticMesh's materials. | |
| FNiagaraVariableAttributeBinding | PositionBinding | Which attribute should we use for position when generating instanced meshes? | |
| FNiagaraVariableAttributeBinding | PrevCameraOffsetBinding | ||
| FNiagaraVariableAttributeBinding | PrevMeshOrientationBinding | ||
| FNiagaraVariableAttributeBinding | PrevPositionBinding | ||
| FNiagaraVariableAttributeBinding | PrevScaleBinding | ||
| FNiagaraVariableAttributeBinding | PrevVelocityBinding | ||
| FNiagaraRendererLayout | RendererLayoutWithCustomSorting | ||
| FNiagaraRendererLayout | RendererLayoutWithoutCustomSorting | ||
| uint32 | RendererVisibility | If a render visibility tag is present, particles whose tag matches this value will be visible in this renderer. | |
| FNiagaraVariableAttributeBinding | RendererVisibilityTagBinding | Which attribute should we use for the renderer visibility tag? | |
| FNiagaraVariableAttributeBinding | ScaleBinding | Which attribute should we use for scale when generating instanced meshes? | |
| ENiagaraSortMode | SortMode | Determines how we sort the particles prior to rendering. | |
| ENiagaraRendererSortPrecision | SortPrecision | Sort precision to use when sorting is active. | |
| ENiagaraRendererSourceDataMode | SourceMode | Whether or not to draw a single element for the Emitter or to draw the particles. | |
| FNiagaraVariableAttributeBinding | SubImageIndexBinding | Which attribute should we use for sprite sub-image indexing when generating sprites? | |
| FVector2D | SubImageSize | When using SubImage lookups for particles, this variable contains the number of columns in X and the number of rows in Y. | |
| FNiagaraVariableAttributeBinding | VelocityBinding | Which attribute should we use for velocity when generating instanced meshes? |
Constructors
| Type | Name | Description | |
|---|---|---|---|
Functions
| Type | Name | Description | |
|---|---|---|---|
| void | ApplyMaterialOverrides
(
const FNiagaraEmitterInstance* EmitterInstance, |
||
| bool | ChangeRequiresMeshListRebuild
(
const FProperty* Property |
||
| void | |||
| void | InitBindings () |
||
| void | The bindings depend on variables that are created during the NiagaraModule startup. | ||
| void | OnAssetReimported
(
UObject* |
||
| void | |||
| void | OnMeshPostBuild
(
UStaticMesh* |
||
| void | |||
| void | SetPreviousBindings
(
const FVersionedNiagaraEmitter& SrcEmitter, |
||
| void | UpdateMICs () |
Overridden from UNiagaraRendererProperties
| Type | Name | Description | |
|---|---|---|---|
| void | CacheFromCompiledData
(
const FNiagaraDataSetCompiledData* CompiledData |
||
| void | CollectPSOPrecacheData
(
const FNiagaraEmitterInstance* InEmitter, |
||
| FNiagaraBoundsCalculator * | |||
| FNiagaraRenderer * | CreateEmitterRenderer
(
ERHIFeatureLevel::Type FeatureLevel, |
||
| void | GetAdditionalVariables
(
TArray< FNiagaraVariableBase >& OutArray |
||
| FNiagaraVariable | GetBoundAttribute
(
const FNiagaraVariableAttributeBinding* Binding |
Returns the variable associated with the supplied binding if it should be bound given the current settings of the RendererProperties. | |
| TArray< FNiagaraVariable > | |||
| ENiagaraRendererSourceDataMode | |||
| const TArray< FNiagaraVariable > & | |||
| void | GetRendererFeedback
(
const FVersionedNiagaraEmitter& InEmitter, |
||
| void | GetRendererTooltipWidgets
(
const FNiagaraEmitterInstance* InEmitter, |
||
| void | GetRendererWidgets
(
const FNiagaraEmitterInstance* InEmitter, |
||
| void | GetStreamingMeshInfo
(
const FBoxSphereBounds& OwnerBounds, |
||
| void | GetUsedMaterials
(
const FNiagaraEmitterInstance* InEmitter, |
||
| const FVertexFactoryType * | |||
| 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, |
||
| bool |
Overridden from UObject
| Type | Name | Description | |
|---|---|---|---|
| void | BeginDestroy () |
Called before destroying the object. | |
| void | GetResourceSizeEx
(
FResourceSizeEx& CumulativeResourceSize |
Get the size of the object/resource for use in memory tools or to display to artists/LDs in the Editor This is the extended version which separates up the used memory into different memory regions (the actual definition of which may be platform specific). | |
| 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 | PreEditChange
(
FProperty* PropertyThatWillChange |
This is called when a property is about to be modified externally | |
| void | Handles reading, writing, and reference collecting using FArchive. |
Constants
| Name | Description |
|---|---|
| MeshRendererPropertiesToDeferredInit |
Deprecated Variables
| Type | Name | Description | |
|---|---|---|---|
| TArray< FNiagaraMaterialAttributeBinding > | MaterialParameterBindings_DEPRECATED |