new Ellipse(x, y, width, height) → {Phaser.Ellipse}
Creates a Ellipse object. A curve on a plane surrounding two focal points.
Parameters:
| Name | Type | Argument | Default | Description |
|---|---|---|---|---|
x |
number |
<optional> |
0 | The X coordinate of the upper-left corner of the framing rectangle of this ellipse. |
y |
number |
<optional> |
0 | The Y coordinate of the upper-left corner of the framing rectangle of this ellipse. |
width |
number |
<optional> |
0 | The overall width of this ellipse. |
height |
number |
<optional> |
0 | The overall height of this ellipse. |
- Source:
Returns:
This Ellipse object
- Type
- Phaser.Ellipse
Members
-
bottom
-
The sum of the y and height properties. Changing the bottom property of an Ellipse doesn't adjust the y property, but does change the height.
- Source:
Properties:
Name Type Description bottomnumber Gets or sets the bottom of the ellipse.
-
empty
-
Determines whether or not this Ellipse object is empty. Will return a value of true if the Ellipse objects dimensions are less than or equal to 0; otherwise false. If set to true it will reset all of the Ellipse objects properties to 0. An Ellipse object is empty if its width or height is less than or equal to 0.
- Source:
Properties:
Name Type Description emptyboolean Gets or sets the empty state of the ellipse.
-
height
-
- Source:
Properties:
Name Type Description heightnumber The overall height of this ellipse.
-
left
-
The left coordinate of the Ellipse. The same as the X coordinate.
- Source:
-
right
-
The x coordinate of the rightmost point of the Ellipse. Changing the right property of an Ellipse object has no effect on the x property, but does adjust the width.
- Source:
Properties:
Name Type Description rightnumber Gets or sets the value of the rightmost point of the ellipse.
-
top
-
The top of the Ellipse. The same as its y property.
- Source:
Properties:
Name Type Description topnumber Gets or sets the top of the ellipse.
-
width
-
- Source:
Properties:
Name Type Description widthnumber The overall width of this ellipse.
-
x
-
- Source:
Properties:
Name Type Description xnumber The X coordinate of the upper-left corner of the framing rectangle of this ellipse.
-
y
-
- Source:
Properties:
Name Type Description ynumber The Y coordinate of the upper-left corner of the framing rectangle of this ellipse.
Methods
-
<static> contains(a, x, y) → {boolean}
-
Return true if the given x/y coordinates are within the Ellipse object.
Parameters:
Name Type Description aPhaser.Ellipse The Ellipse to be checked.
xnumber The X value of the coordinate to test.
ynumber The Y value of the coordinate to test.
- Source:
Returns:
True if the coordinates are within this ellipse, otherwise false.
- Type
- boolean
-
<static> getBounds() → {Phaser.Rectangle}
-
Returns the framing rectangle of the ellipse as a Phaser.Rectangle object.
- Source:
Returns:
The framing rectangle
- Type
- Phaser.Rectangle
-
clone(output) → {Phaser.Ellipse}
-
Returns a new Ellipse object with the same values for the x, y, width, and height properties as this Ellipse object.
Parameters:
Name Type Description outputPhaser.Ellipse Optional Ellipse object. If given the values will be set into the object, otherwise a brand new Ellipse object will be created and returned.
- Source:
Returns:
The cloned Ellipse object.
- Type
- Phaser.Ellipse
-
contains(x, y) → {boolean}
-
Return true if the given x/y coordinates are within this Ellipse object.
Parameters:
Name Type Description xnumber The X value of the coordinate to test.
ynumber The Y value of the coordinate to test.
- Source:
Returns:
True if the coordinates are within this ellipse, otherwise false.
- Type
- boolean
-
copyFrom(source) → {Phaser.Ellipse}
-
Copies the x, y, width and height properties from any given object to this Ellipse.
Parameters:
Name Type Description sourceany The object to copy from.
- Source:
Returns:
This Ellipse object.
- Type
- Phaser.Ellipse
-
copyTo(dest) → {Object}
-
Copies the x, y and diameter properties from this Circle to any given object.
Parameters:
Name Type Description destany The object to copy to.
- Source:
Returns:
This dest object.
- Type
- Object
-
setTo(x, y, width, height) → {Phaser.Ellipse}
-
Sets the members of the Ellipse to the specified values.
Parameters:
Name Type Description xnumber The X coordinate of the upper-left corner of the framing rectangle of this ellipse.
ynumber The Y coordinate of the upper-left corner of the framing rectangle of this ellipse.
widthnumber The overall width of this ellipse.
heightnumber The overall height of this ellipse.
- Source:
Returns:
This Ellipse object.
- Type
- Phaser.Ellipse
-
toString() → {string}
-
Returns a string representation of this object.
- Source:
Returns:
A string representation of the instance.
- Type
- string