From 9c7673b2ab472adb740929574bdfd5056058ca31 Mon Sep 17 00:00:00 2001 From: VolTer Date: Sun, 30 Apr 2023 04:53:38 +0200 Subject: [PATCH] Add documentation for TubeTrailMesh and RibbonTrailMesh --- doc/classes/RibbonTrailMesh.xml | 13 +++++++++++++ doc/classes/TubeTrailMesh.xml | 11 +++++++++++ 2 files changed, 24 insertions(+) diff --git a/doc/classes/RibbonTrailMesh.xml b/doc/classes/RibbonTrailMesh.xml index db5c8d097c6..c0495703100 100644 --- a/doc/classes/RibbonTrailMesh.xml +++ b/doc/classes/RibbonTrailMesh.xml @@ -1,29 +1,42 @@ + Represents a straight ribbon-shaped [PrimitiveMesh] with variable width. + [RibbonTrailMesh] represents a straight ribbon-shaped mesh with variable width. The ribbon is composed of a number of flat or cross-shaped sections, each with the same [member section_length] and number of [member section_segments]. A [member curve] is sampled along the total length of the ribbon, meaning that the curve determines the size of the ribbon along its length. + This primitive mesh is usually used for particle trails. + $DOCS_URL/tutorials/3d/particles/trails.html + $DOCS_URL/tutorials/3d/particles/index.html + Determines the size of the ribbon along its length. The size of a particular section segment is obtained by multiplying the baseline [member size] by the value of this curve at the given distance. For values smaller than [code]0[/code], the faces will be inverted. + The length of a section of the ribbon. + The number of segments in a section. The [member curve] is sampled on each segment to determine its size. Higher values result in a more detailed ribbon at the cost of performance. + The total number of sections on the ribbon. + Determines the shape of the ribbon. + The baseline size of the ribbon. The size of a particular section segment is obtained by multiplying this size by the value of the [member curve] at the given distance. + Gives the mesh a single flat face. + Gives the mesh two perpendicular flat faces, making a cross shape. diff --git a/doc/classes/TubeTrailMesh.xml b/doc/classes/TubeTrailMesh.xml index aa238af782f..e6d446bd60e 100644 --- a/doc/classes/TubeTrailMesh.xml +++ b/doc/classes/TubeTrailMesh.xml @@ -1,10 +1,15 @@ + Represents a straight tube-shaped [PrimitiveMesh] with variable width. + [TubeTrailMesh] represents a straight tube-shaped mesh with variable width. The tube is composed of a number of cylindrical sections, each with the same [member section_length] and number of [member section_rings]. A [member curve] is sampled along the total length of the tube, meaning that the curve determines the radius of the tube along its length. + This primitive mesh is usually used for particle trails. + $DOCS_URL/tutorials/3d/particles/trails.html + $DOCS_URL/tutorials/3d/particles/index.html @@ -14,16 +19,22 @@ If [code]true[/code], generates a cap at the top of the tube. This can be set to [code]false[/code] to speed up generation and rendering when the cap is never seen by the camera. + Determines the radius of the tube along its length. The radius of a particular section ring is obtained by multiplying the baseline [member radius] by the value of this curve at the given distance. For values smaller than [code]0[/code], the faces will be inverted. + The number of sides on the tube. For example, a value of [code]5[/code] means the tube will be pentagonal. Higher values result in a more detailed tube at the cost of performance. + The baseline radius of the tube. The radius of a particular section ring is obtained by multiplying this radius by the value of the [member curve] at the given distance. + The length of a section of the tube. + The number of rings in a section. The [member curve] is sampled on each ring to determine its radius. Higher values result in a more detailed tube at the cost of performance. + The total number of sections on the tube.