virtualx-engine/doc/classes/CylinderMesh.xml

<?xml version="1.0" encoding="UTF-8" ?>
<class name="CylinderMesh" inherits="PrimitiveMesh" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
	<brief_description>
		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 [code]0.0[/code].
	</description>
	<tutorials>
	</tutorials>
	<members>
		<member name="bottom_radius" type="float" setter="set_bottom_radius" getter="get_bottom_radius" default="0.5">
			Bottom radius of the cylinder. If set to [code]0.0[/code], the bottom faces will not be generated, resulting in a conic shape. See also [member cap_bottom].
		</member>
		<member name="cap_bottom" type="bool" setter="set_cap_bottom" getter="is_cap_bottom" default="true">
			If [code]true[/code], generates a cap at the bottom of the cylinder. This can be set to [code]false[/code] to speed up generation and rendering when the cap is never seen by the camera. See also [member bottom_radius].
			[b]Note:[/b] If [member bottom_radius] is [code]0.0[/code], cap generation is always skipped even if [member cap_bottom] is [code]true[/code].
		</member>
		<member name="cap_top" type="bool" setter="set_cap_top" getter="is_cap_top" default="true">
			If [code]true[/code], generates a cap at the top of the cylinder. This can be set to [code]false[/code] to speed up generation and rendering when the cap is never seen by the camera. See also [member top_radius].
			[b]Note:[/b] If [member top_radius] is [code]0.0[/code], cap generation is always skipped even if [member cap_top] is [code]true[/code].
		</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. 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. 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="0.5">
			Top radius of the cylinder. If set to [code]0.0[/code], the top faces will not be generated, resulting in a conic shape. See also [member cap_top].
		</member>
	</members>
</class>