RibbonTrailMesh

    Represents a straight ribbon-shaped PrimitiveMesh with variable width.

    RibbonTrailMesh.swift:14
    class RibbonTrailMesh

    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.

    Superclasses

    • class PrimitiveMesh

      Base class for all primitive meshes. Handles applying a Material to a primitive mesh.

    Citizens in SwiftGodot

    Conformances

    • protocol CustomStringConvertible

      A type with a customized textual representation.

    • protocol Equatable

      A type that can be compared for value equality.

    • protocol Hashable

      A type that can be hashed into a Hasher to produce an integer hash value.

    • protocol Identifiable<ID>

      A class of types whose instances hold the value of an entity with stable identity.

    • protocol VariantRepresentable

      Types that conform to VariantRepresentable can be stored directly in Variant with no conversion. These include all of the Variant types from Godot (for example GString, Rect, Plane), Godot objects (those that subclass SwiftGodot.Object) as well as the built-in Swift types UInt8, Int64 and Double.

    • protocol VariantStorable

      Types that conform to VariantStorable can be stored in a Variant and can be extracted back out of a Variant.

    Types

    Type members

    Instance members

    • var curve: 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.

    • var sectionLength: Double

      The length of a section of the ribbon.

    • var sectionSegments: Int32

      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.

    • var sections: Int32

      The total number of sections on the ribbon.

    • var shape: RibbonTrailMesh.Shape

      Determines the shape of the ribbon.

    • var size: Double

      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.