diff options
| author | Rémi Verschelde <remi@verschelde.fr> | 2021-06-23 19:58:18 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-06-23 19:58:18 +0200 |
| commit | 9ace46a7d292e768a108cb5ad2acf88dbc57e8a6 (patch) | |
| tree | 24a92b8b760e98a02ab7585c8a8fc32b67cd6923 /doc | |
| parent | 3cb153f746a41be897200b0a99d7fc87d4064f50 (diff) | |
| parent | b4ed84ba2bed1c06b1648581da68b5394835bb79 (diff) | |
Merge pull request #49864 from Calinou/cylindermesh-allow-zero-radius
Allow a top and bottom radius equal to 0 in CylinderMesh
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/classes/CylinderMesh.xml | 10 |
1 files changed, 5 insertions, 5 deletions
diff --git a/doc/classes/CylinderMesh.xml b/doc/classes/CylinderMesh.xml index 3a81e98c3a..827fb5c10c 100644 --- a/doc/classes/CylinderMesh.xml +++ b/doc/classes/CylinderMesh.xml @@ -4,7 +4,7 @@ Class representing a cylindrical [PrimitiveMesh]. </brief_description> <description> - Class representing a cylindrical [PrimitiveMesh]. This class can be used to create cones by setting either the [member top_radius] or [member bottom_radius] properties to 0.0. + Class representing a cylindrical [PrimitiveMesh]. This class can be used to create cones by setting either the [member top_radius] or [member bottom_radius] properties to [code]0.0[/code]. </description> <tutorials> </tutorials> @@ -12,19 +12,19 @@ </methods> <members> <member name="bottom_radius" type="float" setter="set_bottom_radius" getter="get_bottom_radius" default="1.0"> - Bottom radius of the cylinder. + Bottom radius of the cylinder. If set to [code]0.0[/code], the bottom faces will not be generated, resulting in a conic shape. </member> <member name="height" type="float" setter="set_height" getter="get_height" default="2.0"> Full height of the cylinder. </member> <member name="radial_segments" type="int" setter="set_radial_segments" getter="get_radial_segments" default="64"> - Number of radial segments on the cylinder. + Number of radial segments on the cylinder. Higher values result in a more detailed cylinder/cone at the cost of performance. </member> <member name="rings" type="int" setter="set_rings" getter="get_rings" default="4"> - Number of edge rings along the height of the cylinder. + Number of edge rings along the height of the cylinder. Changing [member 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, [member rings] should be kept to its default value. </member> <member name="top_radius" type="float" setter="set_top_radius" getter="get_top_radius" default="1.0"> - Top radius of the cylinder. + Top radius of the cylinder. If set to [code]0.0[/code], the top faces will not be generated, resulting in a conic shape. </member> </members> <constants> |