1. Epic GamesDeveloper
  3. UNiagaraRibbonRendererProperties

UNiagaraRibbonRendererProperties

API > API/Plugins > API/Plugins/Niagara

Inheritance Hierarchy

References

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

Syntax

UCLASS&40;EditInlineNew, Meta&61;&40;DisplayName&61;"Ribbon Renderer"&41;, MinimalAPI&41;  
class UNiagaraRibbonRendererProperties : public UNiagaraRendererProperties

Variables

  Type Name Description
Public variable UProperty Category, EditAnywhere, Meta uint8: 1 bEnableAccurateGeometry Disables two-sided forced rendering (Will still respect material settings) MultiPlane will double geometry count to have triangles facing both sides.
Public variable bool bGpuRibbonLinkIsFloat  
Public variable UProperty uint8: 1 bLinkOrderUseUniqueID  
Public variable UProperty Category, EditAnywhere, Meta uint8: 1 bScreenSpaceTessellation If checked, use the ribbon's screen space percentage to adaptively adjust the tessellation factor.
Public variable UProperty Category, EditAnywhere, Meta uint8: 1 bUseConstantFactor If checked, use the above constant factor.
Public variable UProperty Category, EditAnywhere uint8: 1 bUseGPUInit Whether we use the CPU or GPU to generate ribbon geometry for CPU systems.
Public variable UProperty Category, EditAnywhere uint8: 1 bUseMaterialBackfaceCulling When enabled the ribbons renderer will not override how backface culling works depending on shape type, but instad use the material culling mode
Public variable UProperty Category, EditAnywhere FNiagaraVariableAttributeBinding ColorBinding Which attribute should we use for color when generating ribbons?
Public variable UProperty Category, EditAnywhere, Meta float CurveTension Defines the curve tension, or how long the curve's tangents are.
Public variable UProperty Category, EditAnywhere, Meta TArray< FNiagaraRibbonShapeCustomVertex > CustomVertices Vertices for a cross section of the ribbon in custom shape mode.
Public variable bool DistanceFromStartIsBound  
Public variable UProperty Category, EditAnywhere ENiagaraRibbonDrawDirection DrawDirection If true, the particles are only sorted when using a translucent material.
Public variable UProperty Category, EditAnywhere FNiagaraVariableAttributeBinding DynamicMaterial1Binding Which attribute should we use for dynamic material parameters when generating ribbons?
Public variable UProperty Category, EditAnywhere FNiagaraVariableAttributeBinding DynamicMaterial2Binding Which attribute should we use for dynamic material parameters when generating ribbons?
Public variable UProperty Category, EditAnywhere FNiagaraVariableAttributeBinding DynamicMaterial3Binding Which attribute should we use for dynamic material parameters when generating ribbons?
Public variable UProperty Category, EditAnywhere FNiagaraVariableAttributeBinding DynamicMaterialBinding Which attribute should we use for dynamic material parameters when generating ribbons?
Public variable FNiagaraDataSetAccessor< FVector3f > FacingDataSetAccessor  
Public variable UProperty Category, EditAnywhere, Meta ENiagaraRibbonFacingMode FacingMode  
Public variable uint32 GpuRibbonLinkOrderOffset  
Public variable UProperty Category, EditAnywhere TObjectPtr< UMaterialInterface > Material  
Public variable FNiagaraDataSetAccessor< FVector4f > MaterialParam0DataSetAccessor  
Public variable FNiagaraDataSetAccessor< FVector4f > MaterialParam1DataSetAccessor  
Public variable FNiagaraDataSetAccessor< FVector4f > MaterialParam2DataSetAccessor  
Public variable FNiagaraDataSetAccessor< FVector4f > MaterialParam3DataSetAccessor  
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 MaterialRandom when generating ribbons?
Public variable UProperty Category, EditAnywhere FNiagaraUserParameterBinding MaterialUserParamBinding Use the UMaterialInterface bound to this user variable if it is set to a valid value.
Public variable UProperty Category, EditAnywhere int32 MaxNumRibbons  
Public variable UProperty Transient TObjectPtr< UMaterialInstanceConstant > MICMaterial  
Public variable UProperty Category, EditAnywhere, Meta int32 MultiPlaneCount Number of planes in multiplane shape.
Public variable FNiagaraDataSetAccessor< float > NormalizedAgeAccessor  
Public variable UProperty Category, EditAnywhere FNiagaraVariableAttributeBinding NormalizedAgeBinding Which attribute should we use for normalized age when generating ribbons?
Public variable UProperty Category, EditAnywhere FNiagaraVariableAttributeBinding PositionBinding Which attribute should we use for position when generating ribbons?
Public variable FNiagaraDataSetAccessor< FNiagaraPosition > PositionDataSetAccessor  
Public variable UProperty Transient FNiagaraVariableAttributeBinding PrevPositionBinding Implicit binding for previous position
Public variable UProperty Transient FNiagaraVariableAttributeBinding PrevRibbonFacingBinding Implicit binding for previous ribbon facing
Public variable UProperty Transient FNiagaraVariableAttributeBinding PrevRibbonTwistBinding Implicit binding for previous ribbon twist
Public variable UProperty Transient FNiagaraVariableAttributeBinding PrevRibbonWidthBinding Implicit binding for previous ribbon width
Public variable FNiagaraRendererLayout RendererLayout  
Public variable UProperty Category, EditAnywhere FNiagaraVariableAttributeBinding RibbonFacingBinding Which attribute should we use for ribbon facing when generating ribbons?
Public variable FNiagaraDataSetAccessor< FNiagaraID > RibbonFullIDDataSetAccessor  
Public variable UProperty Category, EditAnywhere FNiagaraVariableAttributeBinding RibbonIdBinding Which attribute should we use for ribbon id when generating ribbons?
Public variable FNiagaraDataSetAccessor< int32 > RibbonIdDataSetAccessor  
Public variable UProperty Category, EditAnywhere FNiagaraVariableAttributeBinding RibbonLinkOrderBinding Which attribute should we use for RibbonLinkOrder when generating ribbons?
Public variable FNiagaraDataSetAccessor< float > RibbonLinkOrderFloatAccessor  
Public variable FNiagaraDataSetAccessor< int32 > RibbonLinkOrderInt32Accessor  
Public variable UProperty Category, EditAnywhere FNiagaraVariableAttributeBinding RibbonTwistBinding Which attribute should we use for ribbon twist when generating ribbons?
Public variable UProperty Category, EditAnywhere FNiagaraVariableAttributeBinding RibbonUVDistance Which attribute should we use for ribbon distance traveled for use in UV operations when generating ribbons?
Public variable UProperty Category, EditAnywhere FNiagaraVariableAttributeBinding RibbonWidthBinding Which attribute should we use for ribbon width when generating ribbons?
Public variable UProperty Category, EditAnywhere ENiagaraRibbonShapeMode Shape Shape of the ribbon, from flat plane, multiplane, 3d tube, and custom shapes.
Public variable FNiagaraDataSetAccessor< float > SizeDataSetAccessor  
Public variable UProperty Category, EditAnywhere, Meta float TessellationAngle Defines the angle in degrees at which tessellation occurs.
Public variable UProperty Category, EditAnywhere, Meta int32 TessellationFactor Custom tessellation factor. Ranges from 1 to 16. Greater values increase amount of tessellation.
Public variable UProperty Category, EditAnywhere, Meta ENiagaraRibbonTessellationMode TessellationMode Defines the tessellation mode allowing custom tessellation parameters or disabling tessellation entirely.
Public variable UProperty Category, EditAnywhere, Meta int32 TubeSubdivisions Number of vertices/faces in a tube.
Public variable FNiagaraDataSetAccessor< float > TwistDataSetAccessor  
Public variable UProperty Category, EditAnywhere FNiagaraVariableAttributeBinding U0OverrideBinding Which attribute should we use for UV0 U when generating ribbons?
Public variable bool U0OverrideIsBound  
Public variable UProperty Category, EditAnywhere FNiagaraVariableAttributeBinding U1OverrideBinding Which attribute should we use for UV1 U when generating ribbons?
Public variable bool U1OverrideIsBound  
Public variable UProperty Category, EditAnywhere, Meta FNiagaraRibbonUVSettings UV0Settings  
Public variable UProperty Category, EditAnywhere, Meta FNiagaraRibbonUVSettings UV1Settings  
Public variable UProperty Category, EditAnywhere FNiagaraVariableAttributeBinding V0RangeOverrideBinding Which attribute should we use for UV0 V when generating ribbons?
Public variable UProperty Category, EditAnywhere FNiagaraVariableAttributeBinding V1RangeOverrideBinding Which attribute should we use for UV1 V when generating ribbons?
Public variable UProperty Category, EditAnywhere FNiagaraVariableAttributeBinding VelocityBinding Which attribute should we use for velocity when generating ribbons?
Public variable UProperty Category, EditAnywhere, Meta int32 WidthSegmentationCount Tessellation factor to apply to the width of the ribbon.

Constructors

  Type Name Description
Public function    

Functions

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

Overridden from UNiagaraRendererProperties

  Type Name Description
Public function Virtual void  
Public function Virtual void  
Public function Virtual FNiagaraBoundsCalculator *  
Public function Virtual FNiagaraRenderer *  
Public function Virtual Const void  
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 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

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

  
Public function Virtual Const const FVertexFactoryType *  
Public function Virtual Const bool  
Public function Virtual Const bool  
Public function Virtual Const bool

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

  
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
)

  

Overridden from UObject

  Type Name Description
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 Handles reading, writing, and reference collecting using FArchive.

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