G1R AngelScript
Scripting reference for the Gothic 1 Remake
Loading...
Searching...
No Matches
UNiagaraRibbonRendererProperties Class Reference

Public Member Functions

Functions
void SetbUseMaterialBackfaceCulling (bool Value)
 When enabled the ribbons renderer will not override how backface culling works depending on shape type, but instad use the material culling mode.
void SetbUseGeometryNormals (bool Value)
 When enabled the ribbons normals will follow the shape of the geometry rather than being aligned to screen / custom facing.
void SetbUseGPUInit (bool Value)
 Whether we use the CPU or GPU to generate ribbon geometry for CPU systems. GPU systems will always use a fully GPU initialization pipeline, Will fall back to CPU init when GPU init isn't available.
void SetbUseConstantFactor (bool Value)
 If checked, use the above constant factor. Otherwise, adaptively select the tessellation factor based on the below parameters.
void SetbScreenSpaceTessellation (bool Value)
 If checked, use the ribbon's screen space percentage to adaptively adjust the tessellation factor.
void SetbCastShadows (bool Value)
 When disabled the renderer will not cast shadows. The component controls if shadows are enabled, this flag allows you to disable the renderer casting shadows.
void SetbEnableAccurateGeometry (bool Value)
 Disables two-sided forced rendering (Will still respect material settings) MultiPlane will double geometry count to have triangles facing both sides. With this off MultiPlane will switch normal direction to face view. 3D Ribbons will render like normal meshes with backface culling enabled.

Static Public Member Functions

Static Functions
static UClass StaticClass ()
Static Public Member Functions inherited from UNiagaraRendererProperties
static UClass StaticClass ()

Public Attributes

Bindings
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.
Ribbon Rendering
FNiagaraRibbonUVSettings UV0Settings
FNiagaraRibbonUVSettings UV1Settings
ENiagaraRibbonFacingMode FacingMode
int MaxNumRibbons
FNiagaraUserParameterBinding MaterialUserParamBinding
 Use the UMaterialInterface bound to this user variable if it is set to a valid value. If this is bound to a valid value and Material is also set, UserParamBinding wins.
UMaterialInterface Material
 UNiagaraRendererProperties Interface END.
Ribbon Shape
ENiagaraRibbonShapeMode Shape
 Shape of the ribbon, from flat plane, multiplane, 3d tube, and custom shapes.
int WidthSegmentationCount
 Tessellation factor to apply to the width of the ribbon. Ranges from 1 to 16. Greater values increase amount of tessellation.
int MultiPlaneCount
 Number of planes in multiplane shape. Evenly distributed from 0-90 or 0-180 degrees off camera facing depending on setting.
int TubeSubdivisions
 Number of vertices/faces in a tube.
TArray< FNiagaraRibbonShapeCustomVertex > CustomVertices
 Vertices for a cross section of the ribbon in custom shape mode.
Ribbon Tessellation
float32 CurveTension
 Defines the curve tension, or how long the curve's tangents are. Ranges from 0 to 1. The higher the value, the sharper the curve becomes.
int TessellationFactor
 Custom tessellation factor. Ranges from 1 to 16. Greater values increase amount of tessellation.
float32 TessellationAngle
 Defines the angle in degrees at which tessellation occurs. Ranges from 1 to 180. Smaller values increase amount of tessellation. If set to 0, use the maximum tessellation set above.
ENiagaraRibbonTessellationMode TessellationMode
 Defines the tessellation mode allowing custom tessellation parameters or disabling tessellation entirely.
Sorting
ENiagaraRibbonDrawDirection DrawDirection
 Controls the order the ribbon segments will be rendered.
Public Attributes inherited from UNiagaraRendererProperties
int SortOrderHint
 By default, emitters are drawn in the order that they are added to the system. This value will allow you to control the order in a more fine-grained manner. Materials of the same type (i.e. Transparent) will draw in order from lowest to highest within the system. The default value is 0.
ENiagaraRendererMotionVectorSetting MotionVectorSetting
 Hint about how to generate motion (velocity) vectors for this renderer.
bool bAllowInCullProxies
FNiagaraPlatformSet Platforms
 Platforms on which this renderer is enabled.

Member Function Documentation

◆ SetbCastShadows()

void SetbCastShadows ( bool Value)

When disabled the renderer will not cast shadows. The component controls if shadows are enabled, this flag allows you to disable the renderer casting shadows.

◆ SetbEnableAccurateGeometry()

void SetbEnableAccurateGeometry ( bool Value)

Disables two-sided forced rendering (Will still respect material settings) MultiPlane will double geometry count to have triangles facing both sides. With this off MultiPlane will switch normal direction to face view. 3D Ribbons will render like normal meshes with backface culling enabled.

◆ SetbScreenSpaceTessellation()

void SetbScreenSpaceTessellation ( bool Value)

If checked, use the ribbon's screen space percentage to adaptively adjust the tessellation factor.

◆ SetbUseConstantFactor()

void SetbUseConstantFactor ( bool Value)

If checked, use the above constant factor. Otherwise, adaptively select the tessellation factor based on the below parameters.

◆ SetbUseGeometryNormals()

void SetbUseGeometryNormals ( bool Value)

When enabled the ribbons normals will follow the shape of the geometry rather than being aligned to screen / custom facing.

◆ SetbUseGPUInit()

void SetbUseGPUInit ( bool Value)

Whether we use the CPU or GPU to generate ribbon geometry for CPU systems. GPU systems will always use a fully GPU initialization pipeline, Will fall back to CPU init when GPU init isn't available.

◆ SetbUseMaterialBackfaceCulling()

void SetbUseMaterialBackfaceCulling ( bool Value)

When enabled the ribbons renderer will not override how backface culling works depending on shape type, but instad use the material culling mode.

◆ StaticClass()

UClass StaticClass ( )
static

Member Data Documentation

◆ CurveTension

float32 CurveTension

Defines the curve tension, or how long the curve's tangents are. Ranges from 0 to 1. The higher the value, the sharper the curve becomes.

◆ CustomVertices

Vertices for a cross section of the ribbon in custom shape mode.

◆ DrawDirection

Controls the order the ribbon segments will be rendered.

◆ FacingMode

◆ Material

◆ 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.

◆ MaterialUserParamBinding

FNiagaraUserParameterBinding MaterialUserParamBinding

Use the UMaterialInterface bound to this user variable if it is set to a valid value. If this is bound to a valid value and Material is also set, UserParamBinding wins.

◆ MaxNumRibbons

int MaxNumRibbons

◆ MultiPlaneCount

int MultiPlaneCount

Number of planes in multiplane shape. Evenly distributed from 0-90 or 0-180 degrees off camera facing depending on setting.

◆ Shape

Shape of the ribbon, from flat plane, multiplane, 3d tube, and custom shapes.

◆ TessellationAngle

float32 TessellationAngle

Defines the angle in degrees at which tessellation occurs. Ranges from 1 to 180. Smaller values increase amount of tessellation. If set to 0, use the maximum tessellation set above.

◆ TessellationFactor

int TessellationFactor

Custom tessellation factor. Ranges from 1 to 16. Greater values increase amount of tessellation.

◆ TessellationMode

Defines the tessellation mode allowing custom tessellation parameters or disabling tessellation entirely.

◆ TubeSubdivisions

int TubeSubdivisions

Number of vertices/faces in a tube.

◆ UV0Settings

◆ UV1Settings

◆ WidthSegmentationCount

int WidthSegmentationCount

Tessellation factor to apply to the width of the ribbon. Ranges from 1 to 16. Greater values increase amount of tessellation.