The Ellipse object can be used to specify a hit area for displayObjects
| Public methods | |
|---|---|
| public | clone(): PIXI.Ellipse |
| public | contains(x: number, y: number): boolean |
| public | getBounds(): PIXI.Rectangle |
| public | clone(): PIXI.Ellipse |
| public | contains(x: number, y: number): boolean |
| public | getBounds(): PIXI.Rectangle |
| Name | Type | Attribute | Description |
|---|---|---|---|
| x | number | public | |
| y | number | public | |
| width | number | public | |
| height | number | public | |
| type | number | public | The type of the object, mainly used to avoid |
| x | number | public | |
| y | number | public | |
| width | number | public | |
| height | number | public | |
| type | number | public | The type of the object, mainly used to avoid |
Creates a clone of this Ellipse instance
PIXI.Ellipse
Checks whether the x and y coordinates given are contained within this ellipse
| Name | Type | Attribute | Description |
|---|---|---|---|
| x | The X coordinate of the point to test |
||
| y | The Y coordinate of the point to test |
Returns the framing rectangle of the ellipse as a Rectangle object
PIXI.Rectangle
Creates a clone of this Ellipse instance
PIXI.Ellipse
Checks whether the x and y coordinates given are contained within this ellipse
| Name | Type | Attribute | Description |
|---|---|---|---|
| x | The X coordinate of the point to test |
||
| y | The Y coordinate of the point to test |
Returns the framing rectangle of the ellipse as a Rectangle object
PIXI.Rectangle
{
"comment": "/**\n * The Ellipse object can be used to specify a hit area for displayObjects\n *\n * @class\n * @memberof PIXI\n */",
"meta": {
"range": [
215,
2526
],
"filename": "Ellipse.js",
"lineno": 12,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\math\\shapes",
"code": {
"id": "astnode100019307",
"name": "Ellipse",
"type": "ClassDeclaration",
"paramnames": [
"x",
"y",
"width",
"height"
]
}
},
"classdesc": "The Ellipse object can be used to specify a hit area for displayObjects
",
"kind": "class",
"memberof": "PIXI",
"name": "Ellipse",
"longname": "PIXI.Ellipse",
"scope": "static",
"params": [
{
"type": {
"names": [
"number"
]
},
"optional": true,
"defaultvalue": 0,
"description": "The X coordinate of the center of this circle
",
"name": "x"
},
{
"type": {
"names": [
"number"
]
},
"optional": true,
"defaultvalue": 0,
"description": "The Y coordinate of the center of this circle
",
"name": "y"
},
{
"type": {
"names": [
"number"
]
},
"optional": true,
"defaultvalue": 0,
"description": "The half width of this ellipse
",
"name": "width"
},
{
"type": {
"names": [
"number"
]
},
"optional": true,
"defaultvalue": 0,
"description": "The half height of this ellipse
",
"name": "height"
}
],
"___id": "T000002R001832",
"___s": true,
"$methods": [
{
"comment": "/**\n * Creates a clone of this Ellipse instance\n *\n * @return {PIXI.Ellipse} a copy of the ellipse\n */",
"meta": {
"range": [
1471,
1559
],
"filename": "Ellipse.js",
"lineno": 62,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\math\\shapes",
"code": {
"id": "astnode100019358",
"name": "Ellipse#clone",
"type": "MethodDefinition",
"paramnames": []
},
"vars": {
"": null
}
},
"description": "Creates a clone of this Ellipse instance
",
"returns": [
{
"type": {
"names": [
"PIXI.Ellipse"
]
},
"description": "a copy of the ellipse
"
}
],
"name": "clone",
"longname": "PIXI.Ellipse#clone",
"kind": "function",
"memberof": "PIXI.Ellipse",
"scope": "instance",
"params": [],
"___id": "T000002R001844",
"___s": true,
"skip": true,
"slug": "PIXI.Ellipseclone",
"filepath": "core\\math\\shapes\\Ellipse.js"
},
{
"comment": "/**\n * Checks whether the x and y coordinates given are contained within this ellipse\n *\n * @param {number} x - The X coordinate of the point to test\n * @param {number} y - The Y coordinate of the point to test\n * @return {boolean} Whether the x/y coords are within this ellipse\n */",
"meta": {
"range": [
1876,
2246
],
"filename": "Ellipse.js",
"lineno": 74,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\math\\shapes",
"code": {
"id": "astnode100019377",
"name": "Ellipse#contains",
"type": "MethodDefinition",
"paramnames": [
"x",
"y"
]
},
"vars": {
"": null
}
},
"description": "Checks whether the x and y coordinates given are contained within this ellipse
",
"params": [
{
"type": {
"names": [
"number"
]
},
"description": "The X coordinate of the point to test
",
"name": "x"
},
{
"type": {
"names": [
"number"
]
},
"description": "The Y coordinate of the point to test
",
"name": "y"
}
],
"returns": [
{
"type": {
"names": [
"boolean"
]
},
"description": "Whether the x/y coords are within this ellipse
"
}
],
"name": "contains",
"longname": "PIXI.Ellipse#contains",
"kind": "function",
"memberof": "PIXI.Ellipse",
"scope": "instance",
"___id": "T000002R001845",
"___s": true,
"skip": true,
"slug": "PIXI.Ellipsecontains",
"filepath": "core\\math\\shapes\\Ellipse.js"
},
{
"comment": "/**\n * Returns the framing rectangle of the ellipse as a Rectangle object\n *\n * @return {PIXI.Rectangle} the framing rectangle\n */",
"meta": {
"range": [
2403,
2524
],
"filename": "Ellipse.js",
"lineno": 96,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\math\\shapes",
"code": {
"id": "astnode100019436",
"name": "Ellipse#getBounds",
"type": "MethodDefinition",
"paramnames": []
},
"vars": {
"": null
}
},
"description": "Returns the framing rectangle of the ellipse as a Rectangle object
",
"returns": [
{
"type": {
"names": [
"PIXI.Rectangle"
]
},
"description": "the framing rectangle
"
}
],
"name": "getBounds",
"longname": "PIXI.Ellipse#getBounds",
"kind": "function",
"memberof": "PIXI.Ellipse",
"scope": "instance",
"params": [],
"___id": "T000002R001850",
"___s": true,
"skip": true,
"slug": "PIXI.EllipsegetBounds",
"filepath": "core\\math\\shapes\\Ellipse.js"
},
{
"comment": "/**\n * Creates a clone of this Ellipse instance\n *\n * @return {PIXI.Ellipse} a copy of the ellipse\n */",
"meta": {
"range": [
1471,
1559
],
"filename": "Ellipse.js",
"lineno": 62,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\math\\shapes",
"code": {
"id": "astnode100094037",
"name": "Ellipse#clone",
"type": "MethodDefinition",
"paramnames": []
},
"vars": {
"": null
}
},
"description": "Creates a clone of this Ellipse instance
",
"returns": [
{
"type": {
"names": [
"PIXI.Ellipse"
]
},
"description": "a copy of the ellipse
"
}
],
"name": "clone",
"longname": "PIXI.Ellipse#clone",
"kind": "function",
"memberof": "PIXI.Ellipse",
"scope": "instance",
"params": [],
"___id": "T000002R008778",
"___s": true,
"skip": true,
"slug": "PIXI.Ellipseclone",
"filepath": "core\\math\\shapes\\Ellipse.js"
},
{
"comment": "/**\n * Checks whether the x and y coordinates given are contained within this ellipse\n *\n * @param {number} x - The X coordinate of the point to test\n * @param {number} y - The Y coordinate of the point to test\n * @return {boolean} Whether the x/y coords are within this ellipse\n */",
"meta": {
"range": [
1876,
2246
],
"filename": "Ellipse.js",
"lineno": 74,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\math\\shapes",
"code": {
"id": "astnode100094056",
"name": "Ellipse#contains",
"type": "MethodDefinition",
"paramnames": [
"x",
"y"
]
},
"vars": {
"": null
}
},
"description": "Checks whether the x and y coordinates given are contained within this ellipse
",
"params": [
{
"type": {
"names": [
"number"
]
},
"description": "The X coordinate of the point to test
",
"name": "x"
},
{
"type": {
"names": [
"number"
]
},
"description": "The Y coordinate of the point to test
",
"name": "y"
}
],
"returns": [
{
"type": {
"names": [
"boolean"
]
},
"description": "Whether the x/y coords are within this ellipse
"
}
],
"name": "contains",
"longname": "PIXI.Ellipse#contains",
"kind": "function",
"memberof": "PIXI.Ellipse",
"scope": "instance",
"___id": "T000002R008779",
"___s": true,
"skip": true,
"slug": "PIXI.Ellipsecontains",
"filepath": "core\\math\\shapes\\Ellipse.js"
},
{
"comment": "/**\n * Returns the framing rectangle of the ellipse as a Rectangle object\n *\n * @return {PIXI.Rectangle} the framing rectangle\n */",
"meta": {
"range": [
2403,
2524
],
"filename": "Ellipse.js",
"lineno": 96,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\math\\shapes",
"code": {
"id": "astnode100094115",
"name": "Ellipse#getBounds",
"type": "MethodDefinition",
"paramnames": []
},
"vars": {
"": null
}
},
"description": "Returns the framing rectangle of the ellipse as a Rectangle object
",
"returns": [
{
"type": {
"names": [
"PIXI.Rectangle"
]
},
"description": "the framing rectangle
"
}
],
"name": "getBounds",
"longname": "PIXI.Ellipse#getBounds",
"kind": "function",
"memberof": "PIXI.Ellipse",
"scope": "instance",
"params": [],
"___id": "T000002R008784",
"___s": true,
"skip": true,
"slug": "PIXI.EllipsegetBounds",
"filepath": "core\\math\\shapes\\Ellipse.js"
}
],
"$attributes": [
{
"comment": "/**\n * @member {number} PIXI.Ellipse#x\n * @default 0\n */",
"meta": {
"range": [
602,
682
],
"filename": "Ellipse.js",
"lineno": 22,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\math\\shapes",
"code": {}
},
"kind": "member",
"name": "x",
"type": {
"names": [
"number"
]
},
"defaultvalue": "0",
"memberof": "PIXI.Ellipse",
"longname": "PIXI.Ellipse#x",
"scope": "instance",
"___id": "T000002R001834",
"___s": true,
"skip": true,
"slug": "PIXI.Ellipsex",
"filepath": "core\\math\\shapes\\Ellipse.js"
},
{
"comment": "/**\n * @member {number} PIXI.Ellipse#y\n * @default 0\n */",
"meta": {
"range": [
712,
792
],
"filename": "Ellipse.js",
"lineno": 28,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\math\\shapes",
"code": {}
},
"kind": "member",
"name": "y",
"type": {
"names": [
"number"
]
},
"defaultvalue": "0",
"memberof": "PIXI.Ellipse",
"longname": "PIXI.Ellipse#y",
"scope": "instance",
"___id": "T000002R001836",
"___s": true,
"skip": true,
"slug": "PIXI.Ellipsey",
"filepath": "core\\math\\shapes\\Ellipse.js"
},
{
"comment": "/**\n * @member {number} PIXI.Ellipse#width\n * @default 0\n */",
"meta": {
"range": [
822,
906
],
"filename": "Ellipse.js",
"lineno": 34,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\math\\shapes",
"code": {}
},
"kind": "member",
"name": "width",
"type": {
"names": [
"number"
]
},
"defaultvalue": "0",
"memberof": "PIXI.Ellipse",
"longname": "PIXI.Ellipse#width",
"scope": "instance",
"___id": "T000002R001838",
"___s": true,
"skip": true,
"slug": "PIXI.Ellipsewidth",
"filepath": "core\\math\\shapes\\Ellipse.js"
},
{
"comment": "/**\n * @member {number} PIXI.Ellipse#height\n * @default 0\n */",
"meta": {
"range": [
944,
1029
],
"filename": "Ellipse.js",
"lineno": 40,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\math\\shapes",
"code": {}
},
"kind": "member",
"name": "height",
"type": {
"names": [
"number"
]
},
"defaultvalue": "0",
"memberof": "PIXI.Ellipse",
"longname": "PIXI.Ellipse#height",
"scope": "instance",
"___id": "T000002R001840",
"___s": true,
"skip": true,
"slug": "PIXI.Ellipseheight",
"filepath": "core\\math\\shapes\\Ellipse.js"
},
{
"comment": "/**\n * The type of the object, mainly used to avoid `instanceof` checks\n *\n * @member {number} PIXI.Ellipse#type\n * @readOnly\n * @default PIXI.SHAPES.ELIP\n * @see PIXI.SHAPES\n */",
"meta": {
"range": [
1069,
1303
],
"filename": "Ellipse.js",
"lineno": 46,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\math\\shapes",
"code": {}
},
"description": "The type of the object, mainly used to avoid instanceof checks
",
"kind": "member",
"name": "type",
"type": {
"names": [
"number"
]
},
"readonly": true,
"defaultvalue": "PIXI.SHAPES.ELIP",
"see": [
"PIXI.SHAPES"
],
"memberof": "PIXI.Ellipse",
"longname": "PIXI.Ellipse#type",
"scope": "instance",
"___id": "T000002R001842",
"___s": true,
"skip": true,
"slug": "PIXI.Ellipsetype",
"filepath": "core\\math\\shapes\\Ellipse.js"
},
{
"comment": "/**\n * @member {number} PIXI.Ellipse#x\n * @default 0\n */",
"meta": {
"range": [
602,
682
],
"filename": "Ellipse.js",
"lineno": 22,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\math\\shapes",
"code": {}
},
"kind": "member",
"name": "x",
"type": {
"names": [
"number"
]
},
"defaultvalue": "0",
"memberof": "PIXI.Ellipse",
"longname": "PIXI.Ellipse#x",
"scope": "instance",
"___id": "T000002R008768",
"___s": true,
"skip": true,
"slug": "PIXI.Ellipsex",
"filepath": "core\\math\\shapes\\Ellipse.js"
},
{
"comment": "/**\n * @member {number} PIXI.Ellipse#y\n * @default 0\n */",
"meta": {
"range": [
712,
792
],
"filename": "Ellipse.js",
"lineno": 28,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\math\\shapes",
"code": {}
},
"kind": "member",
"name": "y",
"type": {
"names": [
"number"
]
},
"defaultvalue": "0",
"memberof": "PIXI.Ellipse",
"longname": "PIXI.Ellipse#y",
"scope": "instance",
"___id": "T000002R008770",
"___s": true,
"skip": true,
"slug": "PIXI.Ellipsey",
"filepath": "core\\math\\shapes\\Ellipse.js"
},
{
"comment": "/**\n * @member {number} PIXI.Ellipse#width\n * @default 0\n */",
"meta": {
"range": [
822,
906
],
"filename": "Ellipse.js",
"lineno": 34,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\math\\shapes",
"code": {}
},
"kind": "member",
"name": "width",
"type": {
"names": [
"number"
]
},
"defaultvalue": "0",
"memberof": "PIXI.Ellipse",
"longname": "PIXI.Ellipse#width",
"scope": "instance",
"___id": "T000002R008772",
"___s": true,
"skip": true,
"slug": "PIXI.Ellipsewidth",
"filepath": "core\\math\\shapes\\Ellipse.js"
},
{
"comment": "/**\n * @member {number} PIXI.Ellipse#height\n * @default 0\n */",
"meta": {
"range": [
944,
1029
],
"filename": "Ellipse.js",
"lineno": 40,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\math\\shapes",
"code": {}
},
"kind": "member",
"name": "height",
"type": {
"names": [
"number"
]
},
"defaultvalue": "0",
"memberof": "PIXI.Ellipse",
"longname": "PIXI.Ellipse#height",
"scope": "instance",
"___id": "T000002R008774",
"___s": true,
"skip": true,
"slug": "PIXI.Ellipseheight",
"filepath": "core\\math\\shapes\\Ellipse.js"
},
{
"comment": "/**\n * The type of the object, mainly used to avoid `instanceof` checks\n *\n * @member {number} PIXI.Ellipse#type\n * @readOnly\n * @default PIXI.SHAPES.ELIP\n * @see PIXI.SHAPES\n */",
"meta": {
"range": [
1069,
1303
],
"filename": "Ellipse.js",
"lineno": 46,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\math\\shapes",
"code": {}
},
"description": "The type of the object, mainly used to avoid instanceof checks
",
"kind": "member",
"name": "type",
"type": {
"names": [
"number"
]
},
"readonly": true,
"defaultvalue": "PIXI.SHAPES.ELIP",
"see": [
"PIXI.SHAPES"
],
"memberof": "PIXI.Ellipse",
"longname": "PIXI.Ellipse#type",
"scope": "instance",
"___id": "T000002R008776",
"___s": true,
"skip": true,
"slug": "PIXI.Ellipsetype",
"filepath": "core\\math\\shapes\\Ellipse.js"
}
],
"$staticmethods": [],
"$staticproperties": [],
"$augments": [],
"$augmentedBy": [],
"filepath": "core\\math\\shapes\\Ellipse.js"
}