API Docs for: 2.2.1
Show:

File: pixi/geom/Ellipse.hx

  1. package pixi.geom;
  2. @:native("PIXI.Ellipse")
  3. extern class Ellipse {
  4. /**
  5. * The Ellipse object can be used to specify a hit area for displayObjects
  6. *
  7. * @class Ellipse
  8. * @constructor
  9. * @param x {Float} The X coordinate of the center of the ellipse
  10. * @param y {Float} The Y coordinate of the center of the ellipse
  11. * @param width {Float} The half width of this ellipse
  12. * @param height {Float} The half height of this ellipse
  13. */
  14. function new(x:Float, y:Float, width:Float, height:Float):Void;
  15. /**
  16. * Creates a clone of this Ellipse instance
  17. *
  18. * @method clone
  19. * @return {Ellipse} a copy of the ellipse
  20. */
  21. function clone():Ellipse;
  22. /**
  23. * Checks whether the x and y coordinates passed to this function are contained within this ellipse
  24. *
  25. * @method contains
  26. * @param x {Float} The X coordinate of the point to test
  27. * @param y {Float} The Y coordinate of the point to test
  28. * @return {Bool} Whether the x/y coords are within this ellipse
  29. */
  30. function contains(x:Float, y:Float):Bool;
  31. /**
  32. * Returns the framing rectangle of the circle as a PIXI.Rectangle object
  33. *
  34. * @method getBounds
  35. * @return {Rectangle} the framing rectangle
  36. */
  37. function getBounds():Rectangle;
  38. /**
  39. * @property x
  40. * @type Float
  41. * @default 0
  42. */
  43. var x:Float;
  44. /**
  45. * @property y
  46. * @type Float
  47. * @default 0
  48. */
  49. var y:Float;
  50. /**
  51. * @property width
  52. * @type Float
  53. * @default 0
  54. */
  55. var width:Float;
  56. /**
  57. * @property height
  58. * @type Float
  59. * @default 0
  60. */
  61. var height:Float;
  62. }