1. Epic GamesDeveloper
  3. UNiagaraMeshRendererProperties

UNiagaraMeshRendererProperties

API > API/Plugins > API/Plugins/Niagara

Inheritance Hierarchy

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
Public variable UProperty Category, EditAnywhere uint8: 1 = 1 bCastShadows When disabled the renderer will not cast shadows.
Public variable UProperty Category, EditAnywhere uint32: 1 bEnableCameraDistanceCulling Enables frustum culling of individual mesh particles
Public variable UProperty Category, EditAnywhere uint32: 1 bEnableFrustumCulling Enables frustum culling of individual mesh particles
Public variable UProperty Category, EditAnywhere, Meta 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
Public variable UProperty Category, EditAnywhere uint32: 1 bLockedAxisEnable If true and in a non-default facing mode, will lock facing direction to an arbitrary plane of rotation
Public variable UProperty Category, EditAnywhere displayname uint32: 1 bOverrideMaterials Whether or not to use the OverrideMaterials array instead of the mesh's existing materials.
Public variable UProperty Category, EditAnywhere, Meta uint32: 1 bSortOnlyWhenTranslucent If true, the particles are only sorted when using a translucent material.
Public variable UProperty Category, EditAnywhere, Meta 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.
Public variable UProperty Category, EditAnywhere uint32: 1 bUseHeterogeneousVolumes Whether or not to render with heterogeneous volumes.
Public variable UProperty Category, EditAnywhere FNiagaraVariableAttributeBinding CameraOffsetBinding Which attribute should we use for camera offset when rendering meshes?
Public variable UProperty Category, EditAnywhere FNiagaraVariableAttributeBinding ColorBinding Which attribute should we use for color when generating instanced meshes?
Public variable UProperty Category, EditAnywhere FNiagaraVariableAttributeBinding CustomSortingBinding Which attribute should we use custom sorting of particles in this emitter.
Public variable UProperty Category, EditAnywhere FNiagaraVariableAttributeBinding DynamicMaterial1Binding Which attribute should we use for dynamic material parameters when generating instanced meshes?
Public variable UProperty Category, EditAnywhere FNiagaraVariableAttributeBinding DynamicMaterial2Binding Which attribute should we use for dynamic material parameters when generating instanced meshes?
Public variable UProperty Category, EditAnywhere FNiagaraVariableAttributeBinding DynamicMaterial3Binding Which attribute should we use for dynamic material parameters when generating instanced meshes?
Public variable UProperty Category, EditAnywhere FNiagaraVariableAttributeBinding DynamicMaterialBinding Which attribute should we use for dynamic material parameters when generating instanced meshes?
Public variable UProperty Category, EditAnywhere ENiagaraMeshFacingMode FacingMode Determines how the mesh orients itself relative to the camera.
Public variable UProperty Category, EditAnywhere, Meta TObjectPtr< UStaticMesh > FirstFlipbookFrame The static mesh to use for the first frame of the flipbook.
Public variable UProperty Category, EditAnywhere, Meta FString FlipbookSuffixFormat Provides the format of the suffix of the names of the static meshes when searching for flipbook frames.
Public variable UProperty Category, EditAnywhere, Meta uint32 FlipbookSuffixNumDigits The number of digits to expect in the frame number of the flipbook page.
Public variable UProperty Category, EditAnywhere, AdvancedDisplay ENiagaraRendererGpuTranslucentLatency GpuTranslucentLatency Gpu simulations run at different points in the frame depending on what features are used, i.e. depth buffer, distance fields, etc.
Public variable UProperty Category, EditAnywhere, Meta FVector LockedAxis Arbitrary axis by which to lock facing rotations
Public variable UProperty Category, EditAnywhere, Meta ENiagaraMeshLockedAxisSpace LockedAxisSpace Specifies what space the locked axis is in
Public variable UProperty Category, EditAnywhere 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.
Public variable UProperty uint32 MaterialParamValidMask  
Public variable UProperty Category, EditAnywhere FNiagaraVariableAttributeBinding MaterialRandomBinding Which attribute should we use for material randoms when generating instanced meshes?
Public variable UProperty Category, EditAnywhere, Meta float MaxCameraDistance  
Public variable UProperty Category, EditAnywhere, AdvancedDisplay FVector MeshBoundsScale Scale factor applied to all of the meshes bounds.
Public variable UProperty Category, EditAnywhere, Meta TArray< FNiagaraMeshRendererMeshProperties > Meshes The static mesh(es) to be instanced when rendering mesh particles.
Public variable UProperty Category, EditAnywhere FNiagaraVariableAttributeBinding MeshIndexBinding Which attribute should we use to pick the element in the mesh array on the mesh renderer?
Public variable UProperty Category, EditAnywhere FNiagaraVariableAttributeBinding MeshOrientationBinding Which attribute should we use for orienting meshes when generating instanced meshes?
Public variable UProperty TArray< FNiagaraMeshMICOverride > MICOverrideMaterials  
Public variable UProperty Category, EditAnywhere, Meta float MinCameraDistance  
Public variable UProperty Category, EditAnywhere FNiagaraVariableAttributeBinding NormalizedAgeBinding Which attribute should we use for Normalized Age?
Public variable UProperty Category, EditAnywhere, Meta uint32 NumFlipbookFrames The number of frames (static meshes) to be included in the flipbook.
Public variable UProperty Category, EditAnywhere, Meta TArray< FNiagaraMeshMaterialOverride > OverrideMaterials The materials to be used instead of the StaticMesh's materials.
Public variable UProperty Category, EditAnywhere FNiagaraVariableAttributeBinding PositionBinding Which attribute should we use for position when generating instanced meshes?
Public variable UProperty Transient FNiagaraVariableAttributeBinding PrevCameraOffsetBinding  
Public variable UProperty Transient FNiagaraVariableAttributeBinding PrevMeshOrientationBinding  
Public variable UProperty Transient FNiagaraVariableAttributeBinding PrevPositionBinding  
Public variable UProperty Transient FNiagaraVariableAttributeBinding PrevScaleBinding  
Public variable UProperty Transient FNiagaraVariableAttributeBinding PrevVelocityBinding  
Public variable FNiagaraRendererLayout RendererLayoutWithCustomSorting  
Public variable FNiagaraRendererLayout RendererLayoutWithoutCustomSorting  
Public variable UProperty Category, EditAnywhere uint32 RendererVisibility If a render visibility tag is present, particles whose tag matches this value will be visible in this renderer.
Public variable UProperty Category, EditAnywhere FNiagaraVariableAttributeBinding RendererVisibilityTagBinding Which attribute should we use for the renderer visibility tag?
Public variable UProperty Category, EditAnywhere FNiagaraVariableAttributeBinding ScaleBinding Which attribute should we use for scale when generating instanced meshes?
Public variable UProperty Category, EditAnywhere ENiagaraSortMode SortMode Determines how we sort the particles prior to rendering.
Public variable UProperty Category, EditAnywhere, Meta ENiagaraRendererSortPrecision SortPrecision Sort precision to use when sorting is active.
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 FNiagaraVariableAttributeBinding SubImageIndexBinding Which attribute should we use for sprite sub-image indexing when generating sprites?
Public variable UProperty Category, EditAnywhere FVector2D SubImageSize When using SubImage lookups for particles, this variable contains the number of columns in X and the number of rows in Y.
Public variable UProperty Category, EditAnywhere FNiagaraVariableAttributeBinding VelocityBinding Which attribute should we use for velocity when generating instanced meshes?

Constructors

  Type Name Description
Public function    

Functions

  Type Name Description
Public function Const void

ApplyMaterialOverrides ( const FNiagaraEmitterInstance* EmitterInstance,
TArray< UMaterialInterface* >& InOutMaterials
)

  
Protected function bool  
Public function void  
Protected function void  
Public function Static void The bindings depend on variables that are created during the NiagaraModule startup.
Public function void  
Public function void  
Public function void

OnMeshPostBuild ( UStaticMesh*
)

  
Protected function void  
Protected function void  
Public function void  

Overridden from UNiagaraRendererProperties

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

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 bool  
Protected 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

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

  
Public function Virtual void

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

  
Protected function Virtual void

UpdateSourceModeDerivates ( ENiagaraRendererSourceDataMode InSourceMode,
bool bFromPropertyEdit
)

  
Public function Virtual Const bool  

Overridden from UObject

  Type Name Description
Public function Virtual void Called before destroying the object.
Public function Virtual 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).
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.
Public function Virtual void

PreEditChange ( FProperty* PropertyThatWillChange
)

 This is called when a property is about to be modified externally
Public function Virtual void Handles reading, writing, and reference collecting using FArchive.

Constants

Name Description
MeshRendererPropertiesToDeferredInit  

Deprecated Variables

  Type Name Description
Public variable UProperty TArray< FNiagaraMaterialAttributeBinding > MaterialParameterBindings_DEPRECATED  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page