CylinderMesh

    Class representing a cylindrical PrimitiveMesh.

    CylinderMesh.swift:11
    class CylinderMesh

    Class representing a cylindrical PrimitiveMesh. This class can be used to create cones by setting either the topRadius or bottomRadius properties to 0.0.

    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.

    Type members

    Instance members

    • var bottomRadius: Double

      Bottom radius of the cylinder. If set to 0.0, the bottom faces will not be generated, resulting in a conic shape. See also capBottom.

    • var capBottom: Bool

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

    • var capTop: Bool

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

    • var height: Double

      Full height of the cylinder.

    • var radialSegments: Int32

      Number of radial segments on the cylinder. Higher values result in a more detailed cylinder/cone at the cost of performance.

    • var rings: Int32

      Number of edge rings along the height of the cylinder. Changing rings does not have any visual impact unless a shader or procedural mesh tool is used to alter the vertex data. Higher values result in more subdivisions, which can be used to create smoother-looking effects with shaders or procedural mesh tools (at the cost of performance). When not altering the vertex data using a shader or procedural mesh tool, rings should be kept to its default value.

    • var topRadius: Double

      Top radius of the cylinder. If set to 0.0, the top faces will not be generated, resulting in a conic shape. See also capTop.