teldufalsari/visionforge
1
0
Fork 0
forked from kscience/visionforge
Code Pull Requests Activity

Add documentation for parameters

Browse Source
This commit is contained in:
Igor Dunaev 2023-10-08 17:09:18 +03:00
parent 8749c0bda7
commit 15b7dbd057
1 changed files with 14 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
visionforge-solid/src/commonMain/kotlin/space/kscience/visionforge/solid/CutTube.kt
View File

@ -132,6 +132,20 @@ public class CutTube(
}
/**
* Create a cut tube - a hollow cylinder (or a segment) cut with two planes. The axis of the cylinder
* is the Z axis. Each section is define by a center and a normal vector. The centers of the two sections
* are the points (0, 0, height / 2) and (0, 0, -height / 2).
*
* @param outerRadius outer radius of the tube
* @param innerRadius inner radius if the tube
* @param height height (length) of the tube. Essentially this is the length of the Z axis segment,
* contained between the top and bottom sections of the tube
* @param startAngle start angle of the segment (if this is a segment)
* @param angle angular magnitude of the segment
* @param topNormal normal vector of the top section
* @param bottomNormal normal vector of the bottom section
*/
@VisionBuilder
public inline fun MutableVisionContainer<Solid>.cutTube(
outerRadius: Number,