Merge pull request #11767 from mike-000/patch-13
Improve documentation of geometry rotation
This commit is contained in:
@@ -227,7 +227,7 @@ class Circle extends SimpleGeometry {
|
|||||||
/**
|
/**
|
||||||
* Rotate the geometry around a given coordinate. This modifies the geometry
|
* Rotate the geometry around a given coordinate. This modifies the geometry
|
||||||
* coordinates in place.
|
* coordinates in place.
|
||||||
* @param {number} angle Rotation angle in radians.
|
* @param {number} angle Rotation angle in counter-clockwise radians.
|
||||||
* @param {import("../coordinate.js").Coordinate} anchor The rotation center.
|
* @param {import("../coordinate.js").Coordinate} anchor The rotation center.
|
||||||
* @api
|
* @api
|
||||||
*/
|
*/
|
||||||
|
|||||||
@@ -470,7 +470,7 @@ export function fromExtent(extent) {
|
|||||||
* @param {import("./Circle.js").default} circle Circle geometry.
|
* @param {import("./Circle.js").default} circle Circle geometry.
|
||||||
* @param {number=} opt_sides Number of sides of the polygon. Default is 32.
|
* @param {number=} opt_sides Number of sides of the polygon. Default is 32.
|
||||||
* @param {number=} opt_angle Start angle for the first vertex of the polygon in
|
* @param {number=} opt_angle Start angle for the first vertex of the polygon in
|
||||||
* radians. Default is 0.
|
* counter-clockwise radians. 0 means East. Default is 0.
|
||||||
* @return {Polygon} Polygon geometry.
|
* @return {Polygon} Polygon geometry.
|
||||||
* @api
|
* @api
|
||||||
*/
|
*/
|
||||||
@@ -500,7 +500,7 @@ export function fromCircle(circle, opt_sides, opt_angle) {
|
|||||||
* @param {import("../coordinate.js").Coordinate} center Center of the regular polygon.
|
* @param {import("../coordinate.js").Coordinate} center Center of the regular polygon.
|
||||||
* @param {number} radius Radius of the regular polygon.
|
* @param {number} radius Radius of the regular polygon.
|
||||||
* @param {number=} opt_angle Start angle for the first vertex of the polygon in
|
* @param {number=} opt_angle Start angle for the first vertex of the polygon in
|
||||||
* radians. Default is 0.
|
* counter-clockwise radians. 0 means East. Default is 0.
|
||||||
*/
|
*/
|
||||||
export function makeRegular(polygon, center, radius, opt_angle) {
|
export function makeRegular(polygon, center, radius, opt_angle) {
|
||||||
const flatCoordinates = polygon.getFlatCoordinates();
|
const flatCoordinates = polygon.getFlatCoordinates();
|
||||||
|
|||||||
@@ -217,7 +217,7 @@ class SimpleGeometry extends Geometry {
|
|||||||
/**
|
/**
|
||||||
* Rotate the geometry around a given coordinate. This modifies the geometry
|
* Rotate the geometry around a given coordinate. This modifies the geometry
|
||||||
* coordinates in place.
|
* coordinates in place.
|
||||||
* @param {number} angle Rotation angle in radians.
|
* @param {number} angle Rotation angle in counter-clockwise radians.
|
||||||
* @param {import("../coordinate.js").Coordinate} anchor The rotation center.
|
* @param {import("../coordinate.js").Coordinate} anchor The rotation center.
|
||||||
* @api
|
* @api
|
||||||
*/
|
*/
|
||||||
|
|||||||
Reference in New Issue
Block a user