mirror of
https://github.com/Relintai/pandemonium_engine_docs.git
synced 2025-01-21 15:07:22 +01:00
104 lines
3.8 KiB
ReStructuredText
104 lines
3.8 KiB
ReStructuredText
:github_url: hide
|
|
|
|
.. Generated automatically by doc/tools/make_rst.py in Godot's source tree.
|
|
.. DO NOT EDIT THIS FILE, but the CapsuleMesh.xml source instead.
|
|
.. The source is found in doc/classes or modules/<name>/doc_classes.
|
|
|
|
.. _class_CapsuleMesh:
|
|
|
|
CapsuleMesh
|
|
===========
|
|
|
|
**Inherits:** :ref:`PrimitiveMesh<class_PrimitiveMesh>` **<** :ref:`Mesh<class_Mesh>` **<** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
|
|
|
|
Class representing a capsule-shaped :ref:`PrimitiveMesh<class_PrimitiveMesh>`.
|
|
|
|
Description
|
|
-----------
|
|
|
|
Class representing a capsule-shaped :ref:`PrimitiveMesh<class_PrimitiveMesh>`.
|
|
|
|
Properties
|
|
----------
|
|
|
|
+---------------------------+--------------------------------------------------------------------+---------+
|
|
| :ref:`float<class_float>` | :ref:`mid_height<class_CapsuleMesh_property_mid_height>` | ``1.0`` |
|
|
+---------------------------+--------------------------------------------------------------------+---------+
|
|
| :ref:`int<class_int>` | :ref:`radial_segments<class_CapsuleMesh_property_radial_segments>` | ``64`` |
|
|
+---------------------------+--------------------------------------------------------------------+---------+
|
|
| :ref:`float<class_float>` | :ref:`radius<class_CapsuleMesh_property_radius>` | ``1.0`` |
|
|
+---------------------------+--------------------------------------------------------------------+---------+
|
|
| :ref:`int<class_int>` | :ref:`rings<class_CapsuleMesh_property_rings>` | ``8`` |
|
|
+---------------------------+--------------------------------------------------------------------+---------+
|
|
|
|
Property Descriptions
|
|
---------------------
|
|
|
|
.. _class_CapsuleMesh_property_mid_height:
|
|
|
|
- :ref:`float<class_float>` **mid_height**
|
|
|
|
+-----------+-----------------------+
|
|
| *Default* | ``1.0`` |
|
|
+-----------+-----------------------+
|
|
| *Setter* | set_mid_height(value) |
|
|
+-----------+-----------------------+
|
|
| *Getter* | get_mid_height() |
|
|
+-----------+-----------------------+
|
|
|
|
Height of the middle cylindrical part of the capsule (without the hemispherical ends).
|
|
|
|
**Note:** The capsule's total height is equal to :ref:`mid_height<class_CapsuleMesh_property_mid_height>` + 2 \* :ref:`radius<class_CapsuleMesh_property_radius>`.
|
|
|
|
----
|
|
|
|
.. _class_CapsuleMesh_property_radial_segments:
|
|
|
|
- :ref:`int<class_int>` **radial_segments**
|
|
|
|
+-----------+----------------------------+
|
|
| *Default* | ``64`` |
|
|
+-----------+----------------------------+
|
|
| *Setter* | set_radial_segments(value) |
|
|
+-----------+----------------------------+
|
|
| *Getter* | get_radial_segments() |
|
|
+-----------+----------------------------+
|
|
|
|
Number of radial segments on the capsule mesh.
|
|
|
|
----
|
|
|
|
.. _class_CapsuleMesh_property_radius:
|
|
|
|
- :ref:`float<class_float>` **radius**
|
|
|
|
+-----------+-------------------+
|
|
| *Default* | ``1.0`` |
|
|
+-----------+-------------------+
|
|
| *Setter* | set_radius(value) |
|
|
+-----------+-------------------+
|
|
| *Getter* | get_radius() |
|
|
+-----------+-------------------+
|
|
|
|
Radius of the capsule mesh.
|
|
|
|
----
|
|
|
|
.. _class_CapsuleMesh_property_rings:
|
|
|
|
- :ref:`int<class_int>` **rings**
|
|
|
|
+-----------+------------------+
|
|
| *Default* | ``8`` |
|
|
+-----------+------------------+
|
|
| *Setter* | set_rings(value) |
|
|
+-----------+------------------+
|
|
| *Getter* | get_rings() |
|
|
+-----------+------------------+
|
|
|
|
Number of rings along the height of the capsule.
|
|
|
|
.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
|
|
.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
|
|
.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
|