phaser/resources/docgen/output/Phaser.Ellipse.json

{"class":{"name":"Phaser.Ellipse","extends":"","static":false,"constructor":true,"parameters":[{"name":"x","type":["number"],"help":"The X coordinate of the upper-left corner of the framing rectangle of this ellipse.","optional":true,"default":"0"},{"name":"y","type":["number"],"help":"The Y coordinate of the upper-left corner of the framing rectangle of this ellipse.","optional":true,"default":"0"},{"name":"width","type":["number"],"help":"The overall width of this ellipse.","optional":true,"default":"0"},{"name":"height","type":["number"],"help":"The overall height of this ellipse.","optional":true,"default":"0"}],"help":"Creates a Ellipse object. A curve on a plane surrounding two focal points."},"consts":[],"methods":{"public":[{"name":"clone","static":false,"returns":{"types":["Phaser.Ellipse"],"help":"The cloned Ellipse object."},"help":"Returns a new Ellipse object with the same values for the x, y, width, and height properties as this Ellipse object.","line":117,"public":true,"protected":false,"private":false,"parameters":[{"name":"output","type":["Phaser.Ellipse"],"help":"Optional Ellipse object. If given the values will be set into the object, otherwise a brand new Ellipse object will be created and returned.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"contains","static":false,"returns":{"types":["boolean"],"help":"True if the coordinates are within this ellipse, otherwise false."},"help":"Return true if the given x\/y coordinates are within the Ellipse object.","line":275,"public":true,"protected":false,"private":false,"parameters":[{"name":"a","type":["Phaser.Ellipse"],"help":"The Ellipse to be checked.","optional":false,"default":null},{"name":"x","type":["number"],"help":"The X value of the coordinate to test.","optional":false,"default":null},{"name":"y","type":["number"],"help":"The Y value of the coordinate to test.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"copyFrom","static":false,"returns":{"types":["Phaser.Ellipse"],"help":"This Ellipse object."},"help":"Copies the x, y, width and height properties from any given object to this Ellipse.","line":88,"public":true,"protected":false,"private":false,"parameters":[{"name":"source","type":["any"],"help":"The object to copy from.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"copyTo","static":false,"returns":{"types":["object"],"help":"This dest object."},"help":"Copies the x, y, width and height properties from this Ellipse to any given object.","line":100,"public":true,"protected":false,"private":false,"parameters":[{"name":"dest","type":["any"],"help":"The object to copy to.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"getBounds","static":false,"returns":{"types":["Phaser.Rectangle"],"help":"The framing rectangle"},"help":"Returns the framing rectangle of the ellipse as a Phaser.Rectangle object.","line":299,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"setTo","static":false,"returns":{"types":["Phaser.Ellipse"],"help":"This Ellipse object."},"help":"Sets the members of the Ellipse to the specified values.","line":60,"public":true,"protected":false,"private":false,"parameters":[{"name":"x","type":["number"],"help":"The X coordinate of the upper-left corner of the framing rectangle of this ellipse.","optional":false,"default":null},{"name":"y","type":["number"],"help":"The Y coordinate of the upper-left corner of the framing rectangle of this ellipse.","optional":false,"default":null},{"name":"width","type":["number"],"help":"The overall width of this ellipse.","optional":false,"default":null},{"name":"height","type":["number"],"help":"The overall height of this ellipse.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"toString","static":false,"returns":{"types":["string"],"help":"A string representation of the instance."},"help":"Returns a string representation of this object.","line":150,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""}],"protected":[],"private":[],"static":[]},"properties":{"public":[{"name":"bottom","type":["number"],"help":"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.","inlineHelp":"Gets or sets the bottom of the ellipse.","line":224,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"empty","type":["boolean"],"help":"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.\\nIf 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.","inlineHelp":"Gets or sets the empty state of the ellipse.","line":250,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"height","type":["number"],"help":"","inlineHelp":"The overall height of this ellipse.","line":45,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"right","type":["number"],"help":"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.","inlineHelp":"Gets or sets the value of the rightmost point of the ellipse.","line":182,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"top","type":["number"],"help":"The top of the Ellipse. The same as its y property.","inlineHelp":"Gets or sets the top of the ellipse.","line":207,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"width","type":["number"],"help":"","inlineHelp":"The overall width of this ellipse.","line":40,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"x","type":["number"],"help":"","inlineHelp":"The X coordinate of the upper-left corner of the framing rectangle of this ellipse.","line":30,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"y","type":["number"],"help":"","inlineHelp":"The Y coordinate of the upper-left corner of the framing rectangle of this ellipse.","line":35,"default":null,"public":true,"protected":false,"private":false,"readOnly":false}],"protected":[],"private":[]}}