42 lines
1.2 KiB
TypeScript
42 lines
1.2 KiB
TypeScript
/**
|
|
* Two Pi.
|
|
* @static
|
|
* @member {number}
|
|
* @memberof maths
|
|
*/
|
|
export declare const PI_2: number;
|
|
/**
|
|
* Conversion factor for converting radians to degrees.
|
|
* @static
|
|
* @member {number} RAD_TO_DEG
|
|
* @memberof maths
|
|
*/
|
|
export declare const RAD_TO_DEG: number;
|
|
/**
|
|
* Conversion factor for converting degrees to radians.
|
|
* @static
|
|
* @member {number}
|
|
* @memberof maths
|
|
*/
|
|
export declare const DEG_TO_RAD: number;
|
|
/**
|
|
* Constants that identify shapes, mainly to prevent `instanceof` calls.
|
|
* @memberof maths
|
|
*/
|
|
export type SHAPE_PRIMITIVE = 'polygon' | 'rectangle' | 'circle' | 'ellipse' | 'triangle' | 'roundedRectangle';
|
|
/**
|
|
* The `maths` folder contains utility classes and functions for mathematical operations used throughout the project.
|
|
* This includes constants such as conversion factors for radians and degrees, as well as shapes such as polygons,
|
|
* rectangles, circles, ellipses, triangles, and rounded rectangles.
|
|
* ```js
|
|
* import { RAD_TO_DEG, Circle } from 'pixi.js';
|
|
*
|
|
* // Convert 180 degrees to radians
|
|
* const radians = 180 * RAD_TO_DEG;
|
|
*
|
|
* // test if a point is inside a circle
|
|
* const isPointInCircle = new Circle(0, 0, 10).contains(0, 0); // true
|
|
* ```
|
|
* @namespace maths
|
|
*/
|