1. Epic GamesDeveloper
  3. UNiagaraRibbonRendererProperties

UNiagaraRibbonRendererProperties

API > API/Plugins > API/Plugins/Niagara

   
Name UNiagaraRibbonRendererProperties
Type class
Header File /Engine/Plugins/FX/Niagara/Source/Niagara/Public/NiagaraRibbonRendererProperties.h
Include Path #include "NiagaraRibbonRendererProperties.h"

Syntax

UCLASS (EditInlineNew, Meta=(DisplayName="Ribbon Renderer", SupportsStateless), MinimalAPI)  
class UNiagaraRibbonRendererProperties : public UNiagaraRendererProperties

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

UNiagaraRibbonRendererProperties()

   NiagaraRibbonRendererProperties.h  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
bCastShadows uint8 When disabled the renderer will not cast shadows. NiagaraRibbonRendererProperties.h
  • EditAnywhere
  • Category="Rendering"
bEnableAccurateGeometry uint8 Disables two-sided forced rendering (Will still respect material settings) MultiPlane will double geometry count to have triangles facing both sides. NiagaraRibbonRendererProperties.h
  • EditAnywhere
  • Category="Ribbon Shape"
  • Meta=(EditCondition="Shape != ENiagaraRibbonShapeMode::Plane", EditConditionHides)
bGpuRibbonLinkIsFloat bool   NiagaraRibbonRendererProperties.h  
bIncludeInHitProxy uint8 When disabled the mesh batches do not contribute to the hit proxy, i.e. they are not part of editor selection. NiagaraRibbonRendererProperties.h
  • EditAnywhere
  • Category="Rendering"
bLinkOrderUseUniqueID uint8   NiagaraRibbonRendererProperties.h  
bScreenSpaceTessellation uint8 If checked, use the ribbon's screen space percentage to adaptively adjust the tessellation factor. NiagaraRibbonRendererProperties.h
  • EditAnywhere
  • Category="Ribbon Tessellation"
  • Meta=(DisplayName="Screen Space", EditCondition="TessellationMode == ENiagaraRibbonTessellationMode::Custom && !bUseConstantFactor", EditConditionHides, DisplayAfter="TessellationAngle")
bUseConstantFactor uint8 If checked, use the above constant factor. NiagaraRibbonRendererProperties.h
  • EditAnywhere
  • Category="Ribbon Tessellation"
  • Meta=(EditCondition="TessellationMode == ENiagaraRibbonTessellationMode::Custom", EditConditionHides, DisplayAfter="TessellationFactor")
bUseGeometryNormals uint8 When enabled the ribbons normals will follow the shape of the geometry rather than being aligned to screen / custom facing. NiagaraRibbonRendererProperties.h
  • EditAnywhere
  • Category="Ribbon Shape"
  • Meta=(EditCondition="Shape == ENiagaraRibbonShapeMode::Plane", EditConditionHides)
bUseGPUInit uint8 Whether we use the CPU or GPU to generate ribbon geometry for CPU systems. NiagaraRibbonRendererProperties.h
  • EditAnywhere
  • Category="Ribbon Rendering"
bUseMaterialBackfaceCulling uint8 When enabled the ribbons renderer will not override how backface culling works depending on shape type, but instad use the material culling mode NiagaraRibbonRendererProperties.h
  • EditAnywhere
  • Category="Ribbon Shape"
ColorBinding FNiagaraVariableAttributeBinding Which attribute should we use for color when generating ribbons? NiagaraRibbonRendererProperties.h
  • EditAnywhere
  • Category="Bindings"
CurveTension float Defines the curve tension, or how long the curve's tangents are. NiagaraRibbonRendererProperties.h
  • EditAnywhere
  • Category="Ribbon Tessellation"
  • Meta=(EditCondition="TessellationMode != ENiagaraRibbonTessellationMode::Disabled", EditConditionHides, ClampMin="0", ClampMax="0.99")
CustomVertices TArray< FNiagaraRibbonShapeCustomVertex > Vertices for a cross section of the ribbon in custom shape mode. NiagaraRibbonRendererProperties.h
  • EditAnywhere
  • Category="Ribbon Shape"
  • Meta=(EditCondition="Shape == ENiagaraRibbonShapeMode::Custom", EditConditionHides)
DistanceFromStartIsBound bool   NiagaraRibbonRendererProperties.h  
DrawDirection ENiagaraRibbonDrawDirection Controls the order the ribbon segments will be rendered. NiagaraRibbonRendererProperties.h
  • EditAnywhere
  • Category="Sorting"
DynamicMaterial1Binding FNiagaraVariableAttributeBinding Which attribute should we use for dynamic material parameters when generating ribbons? NiagaraRibbonRendererProperties.h
  • EditAnywhere
  • Category="Bindings"
DynamicMaterial2Binding FNiagaraVariableAttributeBinding Which attribute should we use for dynamic material parameters when generating ribbons? NiagaraRibbonRendererProperties.h
  • EditAnywhere
  • Category="Bindings"
DynamicMaterial3Binding FNiagaraVariableAttributeBinding Which attribute should we use for dynamic material parameters when generating ribbons? NiagaraRibbonRendererProperties.h
  • EditAnywhere
  • Category="Bindings"
DynamicMaterialBinding FNiagaraVariableAttributeBinding Which attribute should we use for dynamic material parameters when generating ribbons? NiagaraRibbonRendererProperties.h
  • EditAnywhere
  • Category="Bindings"
FacingDataSetAccessor FNiagaraDataSetAccessor< FVector3f >   NiagaraRibbonRendererProperties.h  
FacingMode ENiagaraRibbonFacingMode   NiagaraRibbonRendererProperties.h
  • EditAnywhere
  • Category="Ribbon Rendering"
  • Meta=(DisplayAfter="MaterialUserParamBinding")
GpuRibbonLinkOrderOffset uint32   NiagaraRibbonRendererProperties.h  
Material TObjectPtr< UMaterialInterface >   NiagaraRibbonRendererProperties.h
  • EditAnywhere
  • Category="Ribbon Rendering"
MaterialParam0DataSetAccessor FNiagaraDataSetAccessor< FVector4f >   NiagaraRibbonRendererProperties.h  
MaterialParam1DataSetAccessor FNiagaraDataSetAccessor< FVector4f >   NiagaraRibbonRendererProperties.h  
MaterialParam2DataSetAccessor FNiagaraDataSetAccessor< FVector4f >   NiagaraRibbonRendererProperties.h  
MaterialParam3DataSetAccessor FNiagaraDataSetAccessor< FVector4f >   NiagaraRibbonRendererProperties.h  
MaterialParameters FNiagaraRendererMaterialParameters 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. NiagaraRibbonRendererProperties.h
  • EditAnywhere
  • Category="Bindings"
MaterialParamValidMask uint32   NiagaraRibbonRendererProperties.h  
MaterialRandomBinding FNiagaraVariableAttributeBinding Which attribute should we use for MaterialRandom when generating ribbons? NiagaraRibbonRendererProperties.h
  • EditAnywhere
  • Category="Bindings"
MaterialUserParamBinding FNiagaraUserParameterBinding Use the UMaterialInterface bound to this user variable if it is set to a valid value. NiagaraRibbonRendererProperties.h
  • EditAnywhere
  • Category="Ribbon Rendering"
MaxNumRibbons int32   NiagaraRibbonRendererProperties.h
  • EditAnywhere
  • Category="Ribbon Rendering"
MICMaterial TObjectPtr< UMaterialInstanceConstant >   NiagaraRibbonRendererProperties.h
  • Transient
MultiPlaneCount int32 Number of planes in multiplane shape. NiagaraRibbonRendererProperties.h
  • EditAnywhere
  • Category="Ribbon Shape"
  • Meta=(EditCondition="Shape == ENiagaraRibbonShapeMode::MultiPlane", ClampMin="2", ClampMax="8", EditConditionHides)
NormalizedAgeAccessor FNiagaraDataSetAccessor< float >   NiagaraRibbonRendererProperties.h  
NormalizedAgeBinding FNiagaraVariableAttributeBinding Which attribute should we use for normalized age when generating ribbons? NiagaraRibbonRendererProperties.h
  • EditAnywhere
  • Category="Bindings"
PositionBinding FNiagaraVariableAttributeBinding Which attribute should we use for position when generating ribbons? NiagaraRibbonRendererProperties.h
  • EditAnywhere
  • Category="Bindings"
PositionDataSetAccessor FNiagaraDataSetAccessor< FNiagaraPosition >   NiagaraRibbonRendererProperties.h  
PrevPositionBinding FNiagaraVariableAttributeBinding Implicit binding for previous position NiagaraRibbonRendererProperties.h
  • Transient
PrevRibbonFacingBinding FNiagaraVariableAttributeBinding Implicit binding for previous ribbon facing NiagaraRibbonRendererProperties.h
  • Transient
PrevRibbonTwistBinding FNiagaraVariableAttributeBinding Implicit binding for previous ribbon twist NiagaraRibbonRendererProperties.h
  • Transient
PrevRibbonWidthBinding FNiagaraVariableAttributeBinding Implicit binding for previous ribbon width NiagaraRibbonRendererProperties.h
  • Transient
RendererLayout FNiagaraRendererLayout   NiagaraRibbonRendererProperties.h  
RibbonFacingBinding FNiagaraVariableAttributeBinding Which attribute should we use for ribbon facing when generating ribbons? NiagaraRibbonRendererProperties.h
  • EditAnywhere
  • Category="Bindings"
RibbonFullIDDataSetAccessor FNiagaraDataSetAccessor< FNiagaraID >   NiagaraRibbonRendererProperties.h  
RibbonIdBinding FNiagaraVariableAttributeBinding Which attribute should we use for ribbon id when generating ribbons? NiagaraRibbonRendererProperties.h
  • EditAnywhere
  • Category="Bindings"
RibbonIdDataSetAccessor FNiagaraDataSetAccessor< int32 >   NiagaraRibbonRendererProperties.h  
RibbonLinkOrderBinding FNiagaraVariableAttributeBinding Which attribute should we use for RibbonLinkOrder when generating ribbons? NiagaraRibbonRendererProperties.h
  • EditAnywhere
  • Category="Bindings"
RibbonLinkOrderFloatAccessor FNiagaraDataSetAccessor< float >   NiagaraRibbonRendererProperties.h  
RibbonLinkOrderInt32Accessor FNiagaraDataSetAccessor< int32 >   NiagaraRibbonRendererProperties.h  
RibbonTwistBinding FNiagaraVariableAttributeBinding Which attribute should we use for ribbon twist when generating ribbons? NiagaraRibbonRendererProperties.h
  • EditAnywhere
  • Category="Bindings"
RibbonUVDistance FNiagaraVariableAttributeBinding Which attribute should we use for ribbon distance traveled for use in UV operations when generating ribbons? NiagaraRibbonRendererProperties.h
  • EditAnywhere
  • Category="Bindings"
RibbonWidthBinding FNiagaraVariableAttributeBinding Which attribute should we use for ribbon width when generating ribbons? NiagaraRibbonRendererProperties.h
  • EditAnywhere
  • Category="Bindings"
Shape ENiagaraRibbonShapeMode Shape of the ribbon, from flat plane, multiplane, 3d tube, and custom shapes. NiagaraRibbonRendererProperties.h
  • EditAnywhere
  • Category="Ribbon Shape"
SizeDataSetAccessor FNiagaraDataSetAccessor< float >   NiagaraRibbonRendererProperties.h  
TessellationAngle float Defines the angle in degrees at which tessellation occurs. NiagaraRibbonRendererProperties.h
  • EditAnywhere
  • Category="Ribbon Tessellation"
  • Meta=(EditCondition="TessellationMode == ENiagaraRibbonTessellationMode::Custom && !bUseConstantFactor", ClampMin="0", ClampMax="180", UIMin="1", UIMax="180", EditConditionHides)
TessellationFactor int32 Custom tessellation factor. Ranges from 1 to 16. Greater values increase amount of tessellation. NiagaraRibbonRendererProperties.h
  • EditAnywhere
  • Category="Ribbon Tessellation"
  • Meta=(DisplayName="Max Tessellation Factor", EditCondition="TessellationMode == ENiagaraRibbonTessellationMode::Custom", EditConditionHides, ClampMin="1", ClampMax="16")
TessellationMode ENiagaraRibbonTessellationMode Defines the tessellation mode allowing custom tessellation parameters or disabling tessellation entirely. NiagaraRibbonRendererProperties.h
  • EditAnywhere
  • Category="Ribbon Tessellation"
  • Meta=(DisplayName="Mode")
TubeSubdivisions int32 Number of vertices/faces in a tube. NiagaraRibbonRendererProperties.h
  • EditAnywhere
  • Category="Ribbon Shape"
  • Meta=(EditCondition="Shape == ENiagaraRibbonShapeMode::Tube", ClampMin="3", ClampMax="16", EditConditionHides)
TwistDataSetAccessor FNiagaraDataSetAccessor< float >   NiagaraRibbonRendererProperties.h  
U0OverrideBinding FNiagaraVariableAttributeBinding Which attribute should we use for UV0 U when generating ribbons? NiagaraRibbonRendererProperties.h
  • EditAnywhere
  • Category="Bindings"
U0OverrideIsBound bool   NiagaraRibbonRendererProperties.h  
U1OverrideBinding FNiagaraVariableAttributeBinding Which attribute should we use for UV1 U when generating ribbons? NiagaraRibbonRendererProperties.h
  • EditAnywhere
  • Category="Bindings"
U1OverrideIsBound bool   NiagaraRibbonRendererProperties.h  
UV0Settings FNiagaraRibbonUVSettings   NiagaraRibbonRendererProperties.h
  • EditAnywhere
  • Category="Ribbon Rendering"
  • Meta=(DisplayName="UV0 Settings")
UV1Settings FNiagaraRibbonUVSettings   NiagaraRibbonRendererProperties.h
  • EditAnywhere
  • Category="Ribbon Rendering"
  • Meta=(DisplayName="UV1 Settings")
V0RangeOverrideBinding FNiagaraVariableAttributeBinding Which attribute should we use for UV0 V when generating ribbons? NiagaraRibbonRendererProperties.h
  • EditAnywhere
  • Category="Bindings"
V1RangeOverrideBinding FNiagaraVariableAttributeBinding Which attribute should we use for UV1 V when generating ribbons? NiagaraRibbonRendererProperties.h
  • EditAnywhere
  • Category="Bindings"
VelocityBinding FNiagaraVariableAttributeBinding Which attribute should we use for velocity when generating ribbons? NiagaraRibbonRendererProperties.h
  • EditAnywhere
  • Category="Bindings"
WidthSegmentationCount int32 Tessellation factor to apply to the width of the ribbon. NiagaraRibbonRendererProperties.h
  • EditAnywhere
  • Category="Ribbon Shape"
  • Meta=(EditCondition="Shape == ENiagaraRibbonShapeMode::Plane || Shape == ENiagaraRibbonShapeMode::MultiPlane", ClampMin="1", ClampMax="16", EditConditionHides)

Functions

Public

Overridden from UNiagaraRendererProperties

Name Remarks Include Path Unreal Specifiers

virtual void CacheFromCompiledData ( const FNiagaraDataSetCompiledData* CompiledData
)

   NiagaraRibbonRendererProperties.h  

virtual void CollectPSOPrecacheData ( const FNiagaraEmitterInstance* InEmitter,
FPSOPrecacheParamsList& OutParams
) const

   NiagaraRibbonRendererProperties.h  

virtual FNiagaraBoundsCalculator * CreateBoundsCalculator()

   NiagaraRibbonRendererProperties.h  

virtual FNiagaraRenderer * CreateEmitterRenderer ( ERHIFeatureLevel::Type FeatureLevel,
const FNiagaraEmitterInstance* Emitter,
const FNiagaraSystemInstanceController& InController
)

   NiagaraRibbonRendererProperties.h  

virtual void GetAdditionalVariables ( TArray< FNiagaraVariableBase >& OutArray
) const

   NiagaraRibbonRendererProperties.h  

virtual FNiagaraVariable GetBoundAttribute ( const FNiagaraVariableAttributeBinding* Binding
) const

 Returns the variable associated with the supplied binding if it should be bound given the current settings of the RendererProperties. NiagaraRibbonRendererProperties.h  

virtual TArray< FNiagaraVariable > GetBoundAttributes()

   NiagaraRibbonRendererProperties.h  

virtual const TArray< FNiagaraVariable > & GetOptionalAttributes()

   NiagaraRibbonRendererProperties.h  

virtual void GetRendererFeedback ( const FVersionedNiagaraEmitter& InEmitter,
TArray< FNiagaraRendererFeedback >& OutErrors,
TArray< FNiagaraRendererFeedback >& OutWarnings,
TArray< FNiagaraRendererFeedback >& OutInfo
) const

   NiagaraRibbonRendererProperties.h  

virtual void GetRendererMaterialUsageFeedback ( TArray< FNiagaraRendererFeedback >& OutFeedback
) const

 Provides feedback on any material usage issues, i.e. incompatable material assignment or missing usage flags Automaticaly called from GetRendererFeedback where OutFeedback results in Errors NiagaraRibbonRendererProperties.h  

virtual void GetRendererTooltipWidgets ( const FNiagaraEmitterInstance* InEmitter,
TArray< TSharedPtr< SWidget > >& OutWidgets,
TSharedPtr< FAssetThumbnailPool > InThumbnailPool
) const

   NiagaraRibbonRendererProperties.h  

virtual void GetRendererWidgets ( const FNiagaraEmitterInstance* InEmitter,
TArray< TSharedPtr< SWidget > >& OutWidgets,
TSharedPtr< FAssetThumbnailPool > InThumbnailPool
) const

   NiagaraRibbonRendererProperties.h  

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

   NiagaraRibbonRendererProperties.h  

virtual const FVertexFactoryType * GetVertexFactoryType()

   NiagaraRibbonRendererProperties.h  

virtual bool IsBackfaceCullingDisabled()

   NiagaraRibbonRendererProperties.h  

virtual bool IsSimTargetSupported ( ENiagaraSimTarget InSimTarget
) const

   NiagaraRibbonRendererProperties.h  

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

   NiagaraRibbonRendererProperties.h  

virtual 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. NiagaraRibbonRendererProperties.h  

virtual void RemoveVariable ( const FNiagaraVariableBase& OldVariable,
const FVersionedNiagaraEmitterBase& InEmitter
)

   NiagaraRibbonRendererProperties.h  

virtual void RenameVariable ( const FNiagaraVariableBase& OldVariable,
const FNiagaraVariableBase& NewVariable,
const FVersionedNiagaraEmitterBase& InEmitter
)

   NiagaraRibbonRendererProperties.h  

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual void GetResourceSizeEx ( FResourceSizeEx& CumulativeResourceSize
)

   NiagaraRibbonRendererProperties.h  

virtual void PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

   NiagaraRibbonRendererProperties.h  

virtual void PostInitProperties()

   NiagaraRibbonRendererProperties.h  

virtual void PostLoad()

   NiagaraRibbonRendererProperties.h  

virtual void Serialize ( FStructuredArchive::FRecord Record
)

   NiagaraRibbonRendererProperties.h  

Protected

Name Remarks Include Path Unreal Specifiers

void InitBindings()

   NiagaraRibbonRendererProperties.h  

void SetPreviousBindings ( const FVersionedNiagaraEmitterBase& SrcEmitter
)

   NiagaraRibbonRendererProperties.h  

void UpdateMICs()

   NiagaraRibbonRendererProperties.h  

Overridden from UNiagaraRendererProperties

Name Remarks Include Path Unreal Specifiers

virtual bool NeedsMIDsForMaterials()

   NiagaraRibbonRendererProperties.h  

virtual void UpdateSourceModeDerivates ( ENiagaraRendererSourceDataMode InSourceMode,
bool bFromPropertyEdit
)

   NiagaraRibbonRendererProperties.h  

Static

Name Remarks Include Path Unreal Specifiers
The bindings depend on variables that are created during the NiagaraModule startup. NiagaraRibbonRendererProperties.h  

Deprecated Variables

Name Type Remarks Include Path Unreal Specifiers
MaterialParameterBindings_DEPRECATED TArray< FNiagaraMaterialAttributeBinding >   NiagaraRibbonRendererProperties.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page