virtualx-engine/doc/classes/SphereMesh.xml
Hugo Locurcio b087538119
Add an XML schema for documentation
This makes it easier to spot syntax errors when editing the
class reference. The schema is referenced locally so validation
can still work offline.

Each class XML's schema conformance is also checked on GitHub Actions.
2022-03-16 23:01:02 +01:00

33 lines
1.3 KiB
XML

<?xml version="1.0" encoding="UTF-8" ?>
<class name="SphereMesh" inherits="PrimitiveMesh" version="3.5" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
<brief_description>
Class representing a spherical [PrimitiveMesh].
</brief_description>
<description>
Class representing a spherical [PrimitiveMesh].
</description>
<tutorials>
</tutorials>
<methods>
</methods>
<members>
<member name="height" type="float" setter="set_height" getter="get_height" default="2.0">
Full height of the sphere.
</member>
<member name="is_hemisphere" type="bool" setter="set_is_hemisphere" getter="get_is_hemisphere" default="false">
If [code]true[/code], a hemisphere is created rather than a full sphere.
[b]Note:[/b] To get a regular hemisphere, the height and radius of the sphere must be equal.
</member>
<member name="radial_segments" type="int" setter="set_radial_segments" getter="get_radial_segments" default="64">
Number of radial segments on the sphere.
</member>
<member name="radius" type="float" setter="set_radius" getter="get_radius" default="1.0">
Radius of sphere.
</member>
<member name="rings" type="int" setter="set_rings" getter="get_rings" default="32">
Number of segments along the height of the sphere.
</member>
</members>
<constants>
</constants>
</class>