virtualx-engine/doc/classes/CapsuleMesh.xml

31 lines
1.2 KiB
XML
Raw Normal View History

<?xml version="1.0" encoding="UTF-8" ?>
<class name="CapsuleMesh" inherits="PrimitiveMesh" version="3.5" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
<brief_description>
Class representing a capsule-shaped [PrimitiveMesh].
</brief_description>
<description>
Class representing a capsule-shaped [PrimitiveMesh].
</description>
<tutorials>
</tutorials>
<methods>
</methods>
<members>
<member name="mid_height" type="float" setter="set_mid_height" getter="get_mid_height" default="1.0">
Height of the middle cylindrical part of the capsule (without the hemispherical ends).
[b]Note:[/b] The capsule's total height is equal to [member mid_height] + 2 * [member radius].
</member>
<member name="radial_segments" type="int" setter="set_radial_segments" getter="get_radial_segments" default="64">
Number of radial segments on the capsule mesh.
</member>
<member name="radius" type="float" setter="set_radius" getter="get_radius" default="1.0">
Radius of the capsule mesh.
</member>
<member name="rings" type="int" setter="set_rings" getter="get_rings" default="8">
Number of rings along the height of the capsule.
</member>
</members>
<constants>
</constants>
</class>