virtualx-engine/doc/classes/PlaneMesh.xml

71 lines
1.9 KiB
XML
Raw Normal View History

<?xml version="1.0" encoding="UTF-8" ?>
<class name="PlaneMesh" inherits="PrimitiveMesh" category="Core" version="3.0-alpha">
<brief_description>
Class representing a planar [PrimitiveMesh].
</brief_description>
<description>
Class representing a planar [PrimitiveMesh]. This flat mesh does not have a thickness.
</description>
<tutorials>
</tutorials>
<demos>
</demos>
<methods>
<method name="get_size" qualifiers="const">
<return type="Vector2">
</return>
<description>
</description>
</method>
<method name="get_subdivide_depth" qualifiers="const">
<return type="int">
</return>
<description>
</description>
</method>
<method name="get_subdivide_width" qualifiers="const">
<return type="int">
</return>
<description>
</description>
</method>
<method name="set_size">
<return type="void">
</return>
<argument index="0" name="size" type="Vector2">
</argument>
<description>
</description>
</method>
<method name="set_subdivide_depth">
<return type="void">
</return>
<argument index="0" name="subdivide" type="int">
</argument>
<description>
</description>
</method>
<method name="set_subdivide_width">
<return type="void">
</return>
<argument index="0" name="subdivide" type="int">
</argument>
<description>
</description>
</method>
</methods>
<members>
<member name="size" type="Vector2" setter="set_size" getter="get_size">
Size of the generated plane. Defaults to (2.0, 2.0).
</member>
<member name="subdivide_depth" type="int" setter="set_subdivide_depth" getter="get_subdivide_depth">
Number of subdivision along the z-axis. Defaults to 0.
</member>
<member name="subdivide_width" type="int" setter="set_subdivide_width" getter="get_subdivide_width">
Number of subdivision along the x-axis. Defaults to 0.
</member>
</members>
<constants>
</constants>
</class>