pencil.js
Version:
Nice modular interactive 2D drawing library.
69 lines (68 loc) • 1.93 kB
TypeScript
/**
* @module Star
*/
/**
* Star class
* <br><img src="./media/examples/star.png" alt="star demo"/>
* @class
* @extends {module:RegularPolygon}
*/
export default class Star {
/**
* @inheritDoc
* @param {Object} definition - Star definition
* @return {Star}
*/
static from(definition: any): Star;
/**
* Star constructor
* @param {PositionDefinition} positionDefinition - Center of the star
* @param {Number} [nbBranches=5] - Number of branches to create (can't be less than 2)
* @param {Number} outerRadius - Distance of branches from center
* @param {Number} [bevelRatio=0.5] - Ratio between branches length and bevel between them
* @param {ComponentOptions} [options] - Drawing options
*/
constructor(positionDefinition: PositionDefinition, nbBranches?: number, outerRadius: number, bevelRatio?: number, options?: ComponentOptions);
/**
* Change the outer radius
* @param {Number} radius - New radius value
*/
set radius(radius: number);
/**
* Get the outer radius
* @return {Number}
*/
get radius(): number;
/**
* Change the number of branches
* @param {Number} nbBranches - New number of branches
*/
set nbBranches(nbBranches: number);
/**
* Get the number of branches
* @return {Number}
*/
get nbBranches(): number;
points: import("@pencil.js/position").default[];
/**
* Change the bevel ratio
* @param {Number} bevelRatio - New bevel ratio value
*/
set bevelRatio(bevelRatio: number);
/**
* Get the bevel ratio
* @return {Number}
*/
get bevelRatio(): number;
/**
* Compute the position for the points from the internal properties
*/
rebuild(): void;
/**
* @inheritDoc
*/
toJSON(): any;
[bevelRatioKey]: number;
}
declare const bevelRatioKey: unique symbol;
export {};