From 5ed985db18488115ac1fff5d7e2bf876f3387923 Mon Sep 17 00:00:00 2001 From: liabru Date: Sat, 18 Mar 2023 13:49:56 +0000 Subject: [PATCH] added docs for `body.chamfer` property, closes #1059 --- src/body/Body.js | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/src/body/Body.js b/src/body/Body.js index 5e51075..c190145 100644 --- a/src/body/Body.js +++ b/src/body/Body.js @@ -1437,4 +1437,17 @@ var Axes = require('../geometry/Axes'); * @type bounds */ + /** + * Temporarily may hold parameters to be passed to `Vertices.chamfer` where supported by external functions. + * + * See `Vertices.chamfer` for possible parameters this object may hold. + * + * Currently only functions inside `Matter.Bodies` provide a utility using this property as a vertices pre-processing option. + * + * Alternatively consider using `Vertices.chamfer` directly on vertices before passing them to a body creation function. + * + * @property chamfer + * @type object|null|undefined + */ + })();