Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Plugins > Niagara > UNiagaraRibbonRendererProperties

Light Theme

Dark Theme

UNiagaraRibbonRendererProperties

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UNiagaraMergeable

UNiagaraRendererProperties

UNiagaraRibbonRendererProperties

References

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

Syntax

[UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(EditInlineNew, Meta=(DisplayName="Ribbon Renderer"))
class UNiagaraRibbonRendererProperties : public UNiagaraRendererProperties

Variables

	Name	Description
bool	bScreenSpaceTessellation	If checked, use the ribbon's screen space percentage to adaptively adjust the tessellation factor.
bool	bSortKeyDataSetAccessorIsAge
bool	bUseConstantFactor	If checked, use the above constant factor.
FNiagaraVariabl...	ColorBinding	Which attribute should we use for color when generating ribbons?
float	CurveTension	Defines the curve tension, or how long the curve's tangents are.
TArray< FNiagar...	CustomVertices	Vertices for a cross section of the ribbon in custom shape mode.
bool	DistanceFromStartIsBound
ENiagaraRibbonD...	DrawDirection	If true, the particles are only sorted when using a translucent material.
FNiagaraVariabl...	DynamicMaterial1Binding	Which attribute should we use for dynamic material parameters when generating ribbons?
FNiagaraVariabl...	DynamicMaterial2Binding	Which attribute should we use for dynamic material parameters when generating ribbons?
FNiagaraVariabl...	DynamicMaterial3Binding	Which attribute should we use for dynamic material parameters when generating ribbons?
FNiagaraVariabl...	DynamicMaterialBinding	Which attribute should we use for dynamic material parameters when generating ribbons?
FNiagaraDataSet...	FacingDataSetAccessor
ENiagaraRibbonF...	FacingMode
UMaterialInterf...	Material
FNiagaraDataSet...	MaterialParam0DataSetAccessor
FNiagaraDataSet...	MaterialParam1DataSetAccessor
FNiagaraDataSet...	MaterialParam2DataSetAccessor
FNiagaraDataSet...	MaterialParam3DataSetAccessor
TArray< FNiagar...	MaterialParameterBindings	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
FNiagaraVariabl...	MaterialRandomBinding	Which attribute should we use for MaterialRandom when generating ribbons?
FNiagaraUserPar...	MaterialUserParamBinding	Use the UMaterialInterface bound to this user variable if it is set to a valid value.
int32	MultiPlaneCount	Number of planes in multiplane shape.
FNiagaraDataSet...	NormalizedAgeAccessor
FNiagaraVariabl...	NormalizedAgeBinding	Which attribute should we use for normalized age when generating ribbons?
FNiagaraVariabl...	PositionBinding	Which attribute should we use for position when generating ribbons?
FNiagaraDataSet...	PositionDataSetAccessor
FNiagaraRendere...	RendererLayout
FNiagaraVariabl...	RibbonFacingBinding	Which attribute should we use for ribbon facing when generating ribbons?
FNiagaraDataSet...	RibbonFullIDDataSetAccessor
FNiagaraVariabl...	RibbonIdBinding	Which attribute should we use for ribbon id when generating ribbons?
FNiagaraDataSet...	RibbonIdDataSetAccessor
FNiagaraVariabl...	RibbonLinkOrderBinding	Which attribute should we use for RibbonLinkOrder when generating ribbons?
FNiagaraVariabl...	RibbonTwistBinding	Which attribute should we use for ribbon twist when generating ribbons?
FNiagaraVariabl...	RibbonUVDistance	Which attribute should we use for ribbon distance traveled for use in UV operations when generating ribbons?
FNiagaraVariabl...	RibbonWidthBinding	Which attribute should we use for ribbon width when generating ribbons?
ENiagaraRibbonS...	Shape	Shape of the ribbon, from flat plane, multiplane, 3d tube, and custom shapes.
FNiagaraDataSet...	SizeDataSetAccessor
FNiagaraDataSet...	SortKeyDataSetAccessor
float	TessellationAngle	Defines the angle in degrees at which tessellation occurs.
int32	TessellationFactor	Custom tessellation factor. Ranges from 1 to 16. Greater values increase amount of tessellation.
ENiagaraRibbonT...	TessellationMode	Defines the tessellation mode allowing custom tessellation parameters or disabling tessellation entirely.
int32	TubeSubdivisions	Number of vertices/faces in a tube.
FNiagaraDataSet...	TwistDataSetAccessor
FNiagaraVariabl...	U0OverrideBinding	Which attribute should we use for UV0 U when generating ribbons?
bool	U0OverrideIsBound
FNiagaraVariabl...	U1OverrideBinding	Which attribute should we use for UV1 U when generating ribbons?
bool	U1OverrideIsBound
FNiagaraRibbonU...	UV0Settings
FNiagaraRibbonU...	UV1Settings
FNiagaraVariabl...	V0RangeOverrideBinding	Which attribute should we use for UV0 V when generating ribbons?
FNiagaraVariabl...	V1RangeOverrideBinding	Which attribute should we use for UV1 V when generating ribbons?
FNiagaraVariabl...	VelocityBinding	Which attribute should we use for velocity when generating ribbons?
int32	WidthSegmentationCount	Tessellation factor to apply to the width of the ribbon.

Constructors

	Name	Description
	UNiagaraRibbonRendererProperties()

Functions

		Name	Description
	void	InitBindings()
	void	InitCDOPropertiesAfterModuleStartup()	The bindings depend on variables that are created during the NiagaraModule startup.

Overridden from UNiagaraRendererProperties

	Name	Description
void	CacheFromCompiledData ( const FNiagaraDataSetCompiledData&... )
FNiagaraBoun...	CreateBoundsCalculator()
FNiagaraRend...	CreateEmitterRenderer ( ERHIFeatureLevel::Type FeatureLevel, const FNiagaraEmitterInstance..., const UNiagaraComponent InCom... )
void	FixMaterial ( UMaterial* Material )
const TArray...	GetOptionalAttributes()
void	GetRendererFeedback ( const UNiagaraEmitter* InEmitt..., TArray< FText >& OutErrors, TArray< FText >& OutWarnings, TArray< FText >& OutInfo )
void	GetRendererTooltipWidgets ( const FNiagaraEmitterInstance*..., TArray< TSharedPtr< SWidget >>& Ou..., TSharedPtr< FAssetThumbnailPool > I... )
void	GetRendererWidgets ( const FNiagaraEmitterInstance*..., TArray< TSharedPtr< SWidget >>& Ou..., TSharedPtr< FAssetThumbnailPool > I... )
void	GetUsedMaterials ( const FNiagaraEmitterInstance..., TArray< UMaterialInterface > ... )
bool	IsMaterialValidForRenderer ( UMaterial* Material, FText& InvalidMessage )
bool	IsSimTargetSupported ( ENiagaraSimTarget InSimTarget )
bool	IsSupportedVariableForBinding ( const FNiagaraVariableBase& InSour..., const FName& InTargetBindingName )
bool	NeedsMIDsForMaterials()
bool	PopulateRequiredBindings ( FNiagaraParameterStore& InParamete... )	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& OldVar..., const UNiagaraEmitter* InEmitt... )
void	RenameVariable ( const FNiagaraVariableBase& OldVar..., const FNiagaraVariableBase& NewVar..., const UNiagaraEmitter* InEmitt... )
void	UpdateSourceModeDerivates ( ENiagaraRendererSourceDataMode InSo..., bool bFromPropertyEdit )

Overridden from UObject

	Name	Description
bool	CanEditChange ( const FProperty* InProperty )	Called by the editor to query whether a property of this object is allowed to be modified.
void	PostEditChangeProperty ( FPropertyChangedEvent& PropertyCha... )	Called when a property on this object has been modified externally
void	PostInitProperties()	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.

Constants

Name	Description
RibbonRendererPropertiesToDeferredInit

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss