shapes/custom: javadoc

apps/src/main/java/com/github/stephengold/shapes/custom/CustomCone.java

@@ -121,8 +121,8 @@ public float getRadius() {
     // CustomConvexShape methods
 
     /**
-     * Test whether the specified scale factors can be applied to this shape.
-     * For a cone, scaling must preserve the circular cross section.
+     * Test whether the specified scale factors can be applied to the shape. For
+     * a cone, scaling must preserve the circular cross section.
      *
      * @param scale the desired scale factor for each local axis (may be null,
      * unaffected)

apps/src/main/java/com/github/stephengold/shapes/custom/CustomCylinder.java

@@ -137,8 +137,10 @@ public float getRadius() {
     // CustomConvexShape methods
 
     /**
-     * Test whether the specified scale factors can be applied to this shape.
-     * For a cylinder, scaling must preserve the circular cross section.
+     * Test whether the specified scale factors can be applied to the shape. For
+     * a cylinder, scaling must preserve the circular cross section.
+     *
+     * TODO allow general scaling
      *
      * @param scale the desired scale factor for each local axis (may be null,
      * unaffected)

apps/src/main/java/com/github/stephengold/shapes/custom/CustomFrustum.java

@@ -143,8 +143,8 @@ public float getB() {
     // CustomConvexShape methods
 
     /**
-     * Test whether the specified scale factors can be applied to this shape.
-     * For a conical frustum, scaling must preserve the circular cross section.
+     * Test whether the specified scale factors can be applied to the shape. For
+     * a conical frustum, scaling must preserve the circular cross section.
      *
      * @param scale the desired scale factor for each local axis (may be null,
      * unaffected)

apps/src/main/java/com/github/stephengold/shapes/custom/CustomHalfCylinder.java

@@ -130,9 +130,8 @@ public float getRadius() {
     // CustomConvexShape methods
 
     /**
-     * Test whether the specified scale factors can be applied to this shape.
-     * For a half cylinder, scaling must preserve the semicircular cross
-     * section.
+     * Test whether the specified scale factors can be applied to the shape. For
+     * a half cylinder, scaling must preserve the semicircular cross section.
      *
      * @param scale the desired scale factor for each local axis (may be null,
      * unaffected)

apps/src/main/java/com/github/stephengold/shapes/custom/CustomHemisphere.java

@@ -102,8 +102,8 @@ public float getRadius() {
     // CustomConvexShape methods
 
     /**
-     * Test whether the specified scale factors can be applied to this shape.
-     * For a hemisphere, scaling must be uniform.
+     * Test whether the specified scale factors can be applied to the shape. For
+     * a hemisphere, scaling must be uniform.
      *
      * @param scale the desired scale factor for each local axis (may be null,
      * unaffected)

apps/src/main/java/com/github/stephengold/shapes/custom/CustomLemon.java

@@ -120,8 +120,8 @@ public float getRadius() {
     // CustomConvexShape methods
 
     /**
-     * Test whether the specified scale factors can be applied to this shape.
-     * For this shape, scaling must preserve the circular cross section.
+     * Test whether the specified scale factors can be applied to the shape. For
+     * this shape, scaling must preserve the circular cross section.
      *
      * @param scale the desired scale factor for each local axis (may be null,
      * unaffected)

apps/src/main/java/com/github/stephengold/shapes/custom/CustomParaboloid.java

@@ -37,8 +37,8 @@ OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 
 /**
  * A collision shape for a elliptic paraboloid with a circular cap and uniform
- * density. By convention, the vertex lies on the -Y axis, and the center of the
- * cap lies on the +Y axis.
+ * density. By convention, the vertex lies on the local -Y axis, and the center
+ * of the cap lies on the local +Y axis.
  * <p>
  * This is an imprecise shape; margin always expands the shape.
  *
@@ -125,8 +125,8 @@ public float getRadius() {
     // CustomConvexShape methods
 
     /**
-     * Test whether the specified scale factors can be applied to this shape.
-     * For this shape, scaling must preserve the circular cross section.
+     * Test whether the specified scale factors can be applied to the shape. For
+     * this shape, scaling must preserve the circular cross section.
      *
      * @param scale the desired scale factor for each local axis (may be null,
      * unaffected)

apps/src/main/java/com/github/stephengold/shapes/custom/CustomSegment.java

@@ -183,8 +183,8 @@ public float yMin() {
     // CustomConvexShape methods
 
     /**
-     * Test whether the specified scale factors can be applied to this shape.
-     * For a spherical segment, scaling must be uniform.
+     * Test whether the specified scale factors can be applied to the shape. For
+     * a spherical segment, scaling must be uniform.
      *
      * @param scale the desired scale factor for each local axis (may be null,
      * unaffected)