CylinderMesh

Inherits: PrimitiveMesh < Mesh < Resource < RefCounted < Object

Class representing a cylindrical PrimitiveMesh.

Description

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

Properties

float

bottom_radius

0.5

bool

cap_bottom

true

bool

cap_top

true

float

height

2.0

int

radial_segments

64

int

rings

4

float

top_radius

0.5

Property Descriptions

Default

0.5

Setter

set_bottom_radius(value)

Getter

get_bottom_radius()

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


Default

true

Setter

set_cap_bottom(value)

Getter

is_cap_bottom()

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

Note: If bottom_radius is 0.0, cap generation is always skipped even if cap_bottom is true.


Default

true

Setter

set_cap_top(value)

Getter

is_cap_top()

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

Note: If top_radius is 0.0, cap generation is always skipped even if cap_top is true.


Default

2.0

Setter

set_height(value)

Getter

get_height()

Full height of the cylinder.


  • int radial_segments

Default

64

Setter

set_radial_segments(value)

Getter

get_radial_segments()

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


Default

4

Setter

set_rings(value)

Getter

get_rings()

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.


Default

0.5

Setter

set_top_radius(value)

Getter

get_top_radius()

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