From a971288bb0d64158147526ff49fc250aecdaba28 Mon Sep 17 00:00:00 2001
From: Bastiaan Olij <mux213@gmail.com>
Date: Tue, 3 Jul 2018 21:21:36 +1000
Subject: Added path_local and path_continious_u properties to CSGPolygon

---
 modules/csg/doc_classes/CSGPolygon.xml | 27 +++++++++++++++++++++++++++
 1 file changed, 27 insertions(+)

(limited to 'modules/csg/doc_classes')

diff --git a/modules/csg/doc_classes/CSGPolygon.xml b/modules/csg/doc_classes/CSGPolygon.xml
index 379c512d6a..1e6dec8085 100644
--- a/modules/csg/doc_classes/CSGPolygon.xml
+++ b/modules/csg/doc_classes/CSGPolygon.xml
@@ -1,8 +1,10 @@
 <?xml version="1.0" encoding="UTF-8" ?>
 <class name="CSGPolygon" inherits="CSGPrimitive" category="Core" version="3.1">
 	<brief_description>
+		Extrudes a 2D polygon shape to create a 3D mesh
 	</brief_description>
 	<description>
+		This node takes a 2D polygon shape and extrudes it to create a 3D mesh.
 	</description>
 	<tutorials>
 	</tutorials>
@@ -12,38 +14,63 @@
 	</methods>
 	<members>
 		<member name="depth" type="float" setter="set_depth" getter="get_depth">
+			Extrusion depth when [member mode] is [constant MODE_DEPTH]
 		</member>
 		<member name="material" type="Material" setter="set_material" getter="get_material">
+			Material to use for the resulting mesh
 		</member>
 		<member name="mode" type="int" setter="set_mode" getter="get_mode" enum="CSGPolygon.Mode">
+			Extrusion mode
 		</member>
 		<member name="path_interval" type="float" setter="set_path_interval" getter="get_path_interval">
+			Interval at which a new extrusion slice is added along the path when [member mode] is [constant MODE_PATH]
 		</member>
 		<member name="path_node" type="NodePath" setter="set_path_node" getter="get_path_node">
+			The [Shape] object containing the path along which we extrude when [member mode] is [constant MODE_PATH]
 		</member>
 		<member name="path_rotation" type="int" setter="set_path_rotation" getter="get_path_rotation" enum="CSGPolygon.PathRotation">
+			The method by which each slice is rotated along the path when [member mode] is [constant MODE_PATH]
+		</member>
+		<member name="path_local" type="bool" setter="set_path_local" getter="is_path_local">
+			If false we extrude centered on our path, if true we extrude in relation to the position of our CSGPolygon when [member mode] is [constant MODE_PATH]
+		</member>
+		<member name="path_continuous_u" type="bool" setter="set_path_continuous_u" getter="is_path_continuous_u">
+			If true the u component of our uv will continuously increase in unison with the distance traveled along our path when [member mode] is [constant MODE_PATH]
+		</member>
+		<member name="path_joined" type="bool" setter="set_path_joined" getter="is_path_joined">
+			If true the start and end of our path are joined together ensuring there is no seam when [member mode] is [constant MODE_PATH]
 		</member>
 		<member name="polygon" type="PoolVector2Array" setter="set_polygon" getter="get_polygon">
+			Point array that defines the shape that we'll extrude
 		</member>
 		<member name="smooth_faces" type="bool" setter="set_smooth_faces" getter="get_smooth_faces">
+			Generates smooth normals so smooth shading is applied to our mesh
 		</member>
 		<member name="spin_degrees" type="float" setter="set_spin_degrees" getter="get_spin_degrees">
+			Degrees to rotate our extrusion for each slice when [member mode] is [constant MODE_SPIN]
 		</member>
 		<member name="spin_sides" type="int" setter="set_spin_sides" getter="get_spin_sides">
+			Number of extrusion when [member mode] is [constant MODE_SPIN]
 		</member>
 	</members>
 	<constants>
 		<constant name="MODE_DEPTH" value="0" enum="Mode">
+			Shape is extruded to [member depth]
 		</constant>
 		<constant name="MODE_SPIN" value="1" enum="Mode">
+			Shape is extruded by rotating it around an axis
 		</constant>
 		<constant name="MODE_PATH" value="2" enum="Mode">
+			Shape is extruded along a path set by a [Shape] set in [member path_node]
 		</constant>
 		<constant name="PATH_ROTATION_POLYGON" value="0" enum="PathRotation">
+			Slice is not rotated
 		</constant>
 		<constant name="PATH_ROTATION_PATH" value="1" enum="PathRotation">
+			Slice is rotated around the up vector of the path
 		</constant>
 		<constant name="PATH_ROTATION_PATH_FOLLOW" value="2" enum="PathRotation">
+			Slice is rotate to match the path exactly
 		</constant>
 	</constants>
 </class>
-- 
cgit v1.2.3