Table of Contents

Class TubeTrailMesh

Namespace
Godot
Assembly
GodotSharp.dll

TubeTrailMesh represents a straight tube-shaped mesh with variable width. The tube is composed of a number of cylindrical sections, each with the same SectionLength and number of SectionRings. A Curve is sampled along the total length of the tube, meaning that the curve determines the radius of the tube along its length.

This primitive mesh is usually used for particle trails.

public class TubeTrailMesh : PrimitiveMesh, IDisposable
Inheritance
TubeTrailMesh
Implements
Inherited Members

Constructors

TubeTrailMesh()

public TubeTrailMesh()

Properties

CapBottom

If true, generates a cap at the bottom of the tube. This can be set to false to speed up generation and rendering when the cap is never seen by the camera.

public bool CapBottom { get; set; }

Property Value

bool

CapTop

If true, generates a cap at the top of the tube. This can be set to false to speed up generation and rendering when the cap is never seen by the camera.

public bool CapTop { get; set; }

Property Value

bool

Curve

Determines the radius of the tube along its length. The radius of a particular section ring is obtained by multiplying the baseline Radius 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

Curve

RadialSteps

The number of sides on the tube. For example, a value of 5 means the tube will be pentagonal. Higher values result in a more detailed tube at the cost of performance.

public int RadialSteps { get; set; }

Property Value

int

Radius

The baseline radius of the tube. The radius of a particular section ring is obtained by multiplying this radius by the value of the Curve at the given distance.

public float Radius { get; set; }

Property Value

float

SectionLength

The length of a section of the tube.

public float SectionLength { get; set; }

Property Value

float

SectionRings

The number of rings in a section. The Curve is sampled on each ring to determine its radius. Higher values result in a more detailed tube at the cost of performance.

public int SectionRings { get; set; }

Property Value

int

Sections

The total number of sections on the tube.

public int Sections { get; set; }

Property Value

int

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_name

Name of the method to check for.

Returns

bool

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_name

Name of the signal to check for.

Returns

bool

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_name

Name of the method to invoke.

args NativeVariantPtrArgs

Arguments to use with the invoked method.

ret godot_variant

Value returned by the invoked method.

Returns

bool