Class RibbonTrailMesh
- Namespace
- Godot
- Assembly
- GodotSharp.dll
RibbonTrailMesh represents a straight ribbon-shaped mesh with variable width. The ribbon is composed of a number of flat or cross-shaped sections, each with the same SectionLength and number of SectionSegments. A Curve is sampled along the total length of the ribbon, meaning that the curve determines the size of the ribbon along its length.
This primitive mesh is usually used for particle trails.
public class RibbonTrailMesh : PrimitiveMesh, IDisposable
- Inheritance
-
RibbonTrailMesh
- Implements
- Inherited Members
Constructors
RibbonTrailMesh()
public RibbonTrailMesh()
Properties
Curve
Determines the size of the ribbon along its length. The size of a particular section segment is obtained by multiplying the baseline Size by the value of this curve at the given distance. For values smaller than 0
, the faces will be inverted.
public Curve Curve { get; set; }
Property Value
SectionLength
The length of a section of the ribbon.
public float SectionLength { get; set; }
Property Value
SectionSegments
The number of segments in a section. The Curve is sampled on each segment to determine its size. Higher values result in a more detailed ribbon at the cost of performance.
public int SectionSegments { get; set; }
Property Value
Sections
The total number of sections on the ribbon.
public int Sections { get; set; }
Property Value
Shape
Determines the shape of the ribbon.
public RibbonTrailMesh.ShapeEnum Shape { get; set; }
Property Value
Size
The baseline size of the ribbon. The size of a particular section segment is obtained by multiplying this size by the value of the Curve at the given distance.
public float Size { get; set; }
Property Value
Methods
HasGodotClassMethod(in godot_string_name)
Check if the type contains a method with the given name. This method is used by Godot to check if a method exists before invoking it. Do not call or override this method.
protected override bool HasGodotClassMethod(in godot_string_name method)
Parameters
method
godot_string_nameName of the method to check for.
Returns
HasGodotClassSignal(in godot_string_name)
Check if the type contains a signal with the given name. This method is used by Godot to check if a signal exists before raising it. Do not call or override this method.
protected override bool HasGodotClassSignal(in godot_string_name signal)
Parameters
signal
godot_string_nameName of the signal to check for.
Returns
InvokeGodotClassMethod(in godot_string_name, NativeVariantPtrArgs, out godot_variant)
Invokes the method with the given name, using the given arguments. This method is used by Godot to invoke methods from the engine side. Do not call or override this method.
protected override bool InvokeGodotClassMethod(in godot_string_name method, NativeVariantPtrArgs args, out godot_variant ret)
Parameters
method
godot_string_nameName of the method to invoke.
args
NativeVariantPtrArgsArguments to use with the invoked method.
ret
godot_variantValue returned by the invoked method.