Move olx.style.RegularShapeOptions to ol/style/RegularShape

This commit is contained in:
Michael Kuenzli
2018-04-17 16:40:02 +02:00
parent 73fcdf5392
commit 2d620e5537
2 changed files with 25 additions and 117 deletions

View File

@@ -49,122 +49,6 @@ olx.render.State.prototype.resolution;
olx.render.State.prototype.rotation; olx.render.State.prototype.rotation;
/**
* Specify radius for regular polygons, or radius1 and radius2 for stars.
* @typedef {{fill: (module:ol/style/Fill~Fill|undefined),
* points: number,
* radius: (number|undefined),
* radius1: (number|undefined),
* radius2: (number|undefined),
* angle: (number|undefined),
* snapToPixel: (boolean|undefined),
* stroke: (module:ol/style/Stroke~Stroke|undefined),
* rotation: (number|undefined),
* rotateWithView: (boolean|undefined),
* atlasManager: (module:ol/style/AtlasManager~AtlasManager|undefined)}}
*/
olx.style.RegularShapeOptions;
/**
* Fill style.
* @type {module:ol/style/Fill~Fill|undefined}
* @api
*/
olx.style.RegularShapeOptions.prototype.fill;
/**
* Number of points for stars and regular polygons. In case of a polygon, the
* number of points is the number of sides.
* @type {number}
* @api
*/
olx.style.RegularShapeOptions.prototype.points;
/**
* Radius of a regular polygon.
* @type {number|undefined}
* @api
*/
olx.style.RegularShapeOptions.prototype.radius;
/**
* Outer radius of a star.
* @type {number|undefined}
* @api
*/
olx.style.RegularShapeOptions.prototype.radius1;
/**
* Inner radius of a star.
* @type {number|undefined}
* @api
*/
olx.style.RegularShapeOptions.prototype.radius2;
/**
* Shape's angle in radians. A value of 0 will have one of the shape's point
* facing up.
* Default value is 0.
* @type {number|undefined}
* @api
*/
olx.style.RegularShapeOptions.prototype.angle;
/**
* If `true` integral numbers of pixels are used as the X and Y pixel
* coordinate when drawing the shape in the output canvas. If `false`
* fractional numbers may be used. Using `true` allows for "sharp"
* rendering (no blur), while using `false` allows for "accurate"
* rendering. Note that accuracy is important if the shape's
* position is animated. Without it, the shape may jitter noticeably.
* Default value is `true`.
* @type {boolean|undefined}
* @api
*/
olx.style.RegularShapeOptions.prototype.snapToPixel;
/**
* Stroke style.
* @type {module:ol/style/Stroke~Stroke|undefined}
* @api
*/
olx.style.RegularShapeOptions.prototype.stroke;
/**
* Rotation in radians (positive rotation clockwise). Default is `0`.
* @type {number|undefined}
* @api
*/
olx.style.RegularShapeOptions.prototype.rotation;
/**
* Whether to rotate the shape with the view. Default is `false`.
* @type {boolean|undefined}
* @api
*/
olx.style.RegularShapeOptions.prototype.rotateWithView;
/**
* The atlas manager to use for this symbol. When using WebGL it is
* recommended to use an atlas manager to avoid texture switching.
* If an atlas manager is given, the symbol is added to an atlas.
* By default no atlas manager is used.
* @type {module:ol/style/AtlasManager~AtlasManager|undefined}
*/
olx.style.RegularShapeOptions.prototype.atlasManager;
/** /**
* @typedef {{font: (string|undefined), * @typedef {{font: (string|undefined),
* maxAngle: (number|undefined), * maxAngle: (number|undefined),

View File

@@ -9,6 +9,30 @@ import ImageState from '../ImageState.js';
import {defaultStrokeStyle, defaultFillStyle, defaultLineCap, defaultLineWidth, defaultLineJoin, defaultMiterLimit} from '../render/canvas.js'; import {defaultStrokeStyle, defaultFillStyle, defaultLineCap, defaultLineWidth, defaultLineJoin, defaultMiterLimit} from '../render/canvas.js';
import ImageStyle from '../style/Image.js'; import ImageStyle from '../style/Image.js';
/**
* Specify radius for regular polygons, or radius1 and radius2 for stars.
* @typedef {Object} Options
* @property {module:ol/style/Fill~Fill} [fill] Fill style.
* @property {number} points Number of points for stars and regular polygons. In case of a polygon, the number of points
* is the number of sides.
* @property {number} [radius] Radius of a regular polygon.
* @property {number} [radius1] Outer radius of a star.
* @property {number} [radius2] Inner radius of a star.
* @property {number} [angle=0] Shape's angle in radians. A value of 0 will have one of the shape's point facing up.
* @property {boolean} [snapToPixel=true] If `true` integral numbers of pixels are used as the X and Y pixel coordinate
* when drawing the shape in the output canvas. If `false` fractional numbers may be used. Using `true` allows for
* "sharp" rendering (no blur), while using `false` allows for "accurate" rendering. Note that accuracy is important if
* the shape's position is animated. Without it, the shape may jitter noticeably.
* @property {module:ol/style/Stroke~Stroke} [stroke] Stroke style.
* @property {number} [rotation=0] Rotation in radians (positive rotation clockwise).
* @property {boolean} [rotateWithView=false] Whether to rotate the shape with the view.
* @property {module:ol/style/AtlasManager~AtlasManager} [atlasManager] The atlas manager to use for this symbol. When
* using WebGL it is recommended to use an atlas manager to avoid texture switching. If an atlas manager is given, the
* symbol is added to an atlas. By default no atlas manager is used.
*/
/** /**
* @classdesc * @classdesc
* Set regular shape style for vector features. The resulting shape will be * Set regular shape style for vector features. The resulting shape will be
@@ -16,7 +40,7 @@ import ImageStyle from '../style/Image.js';
* `radius2` are provided. * `radius2` are provided.
* *
* @constructor * @constructor
* @param {olx.style.RegularShapeOptions} options Options. * @param {module:ol/style/RegularShape~Options} options Options.
* @extends {module:ol/style/Image~ImageStyle} * @extends {module:ol/style/Image~ImageStyle}
* @api * @api
*/ */