mtrl 0.8.0-next.11 → 0.8.0-next.12

package/dist/core/shapes/material.d.ts

@@ -7,15 +7,18 @@ export declare const materialShape: (name: MaterialShapeName) => RoundedPolygon;
 export interface RadialProfile {
     /** Radius at angle i * 2π / radii.length, clockwise from the positive x axis on a y-down canvas */
     radii: Float32Array;
+    /** The area centroid the radii are measured from */
     centerX: number;
     centerY: number;
     /** The largest radius, for fitting the shape into a circle */
     maxRadius: number;
 }
 /**
- * Samples the outline at `samples` angles. The shape must be star-shaped
- * around its bounds centre, which every Material shape is: each ray from the
- * centre crosses the outline once.
+ * Samples the outline at `samples` angles around the shape's area centroid.
+ * The centroid, not the bounds centre, is the pivot: a pentagon's mass sits
+ * below the middle of its box, and turning it about the box would make it
+ * orbit. The shape must be star-shaped around its centroid, which every
+ * Material shape is: each ray from the centre crosses the outline once.
  */
 export declare const radialProfile: (polygon: RoundedPolygon, samples?: number, stepsPerCubic?: number) => RadialProfile;
 export { polygonMaxRadius };