The Rounded Rectangle object is an area that has nice rounded corners, as indicated by its
top-left corner point (x, y) and by its width and its height and its radius.
| Public methods | |
|---|---|
| public | clone(): PIXI.RoundedRectangle |
| public | contains(x: number, y: number): boolean |
| public | clone(): PIXI.RoundedRectangle |
| public | contains(x: number, y: number): boolean |
| Name | Type | Attribute | Description |
|---|---|---|---|
| x | number | public | |
| y | number | public | |
| width | number | public | |
| height | number | public | |
| radius | 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 | |
| radius | number | public | |
| type | number | public | The type of the object, mainly used to avoid |
Creates a clone of this Rounded Rectangle
PIXI.RoundedRectangle
Checks whether the x and y coordinates given are contained within this Rounded Rectangle
| Name | Type | Attribute | Description |
|---|---|---|---|
| x | The X coordinate of the point to test |
||
| y | The Y coordinate of the point to test |
Creates a clone of this Rounded Rectangle
PIXI.RoundedRectangle
Checks whether the x and y coordinates given are contained within this Rounded Rectangle
| Name | Type | Attribute | Description |
|---|---|---|---|
| x | The X coordinate of the point to test |
||
| y | The Y coordinate of the point to test |
{
"comment": "/**\n * The Rounded Rectangle object is an area that has nice rounded corners, as indicated by its\n * top-left corner point (x, y) and by its width and its height and its radius.\n *\n * @class\n * @memberof PIXI\n */",
"meta": {
"range": [
286,
3751
],
"filename": "RoundedRectangle.js",
"lineno": 12,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\math\\shapes",
"code": {
"id": "astnode100020291",
"name": "RoundedRectangle",
"type": "ClassDeclaration",
"paramnames": [
"x",
"y",
"width",
"height",
"radius"
]
}
},
"classdesc": "The Rounded Rectangle object is an area that has nice rounded corners, as indicated by its
top-left corner point (x, y) and by its width and its height and its radius.
",
"kind": "class",
"memberof": "PIXI",
"name": "RoundedRectangle",
"longname": "PIXI.RoundedRectangle",
"scope": "static",
"params": [
{
"type": {
"names": [
"number"
]
},
"optional": true,
"defaultvalue": 0,
"description": "The X coordinate of the upper-left corner of the rounded rectangle
",
"name": "x"
},
{
"type": {
"names": [
"number"
]
},
"optional": true,
"defaultvalue": 0,
"description": "The Y coordinate of the upper-left corner of the rounded rectangle
",
"name": "y"
},
{
"type": {
"names": [
"number"
]
},
"optional": true,
"defaultvalue": 0,
"description": "The overall width of this rounded rectangle
",
"name": "width"
},
{
"type": {
"names": [
"number"
]
},
"optional": true,
"defaultvalue": 0,
"description": "The overall height of this rounded rectangle
",
"name": "height"
},
{
"type": {
"names": [
"number"
]
},
"optional": true,
"defaultvalue": 20,
"description": "Controls the radius of the rounded corners
",
"name": "radius"
}
],
"___id": "T000002R001932",
"___s": true,
"$methods": [
{
"comment": "/**\n * Creates a clone of this Rounded Rectangle\n *\n * @return {PIXI.RoundedRectangle} a copy of the rounded rectangle\n */",
"meta": {
"range": [
1912,
2022
],
"filename": "RoundedRectangle.js",
"lineno": 69,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\math\\shapes",
"code": {
"id": "astnode100020351",
"name": "RoundedRectangle#clone",
"type": "MethodDefinition",
"paramnames": []
},
"vars": {
"": null
}
},
"description": "Creates a clone of this Rounded Rectangle
",
"returns": [
{
"type": {
"names": [
"PIXI.RoundedRectangle"
]
},
"description": "a copy of the rounded rectangle
"
}
],
"name": "clone",
"longname": "PIXI.RoundedRectangle#clone",
"kind": "function",
"memberof": "PIXI.RoundedRectangle",
"scope": "instance",
"params": [],
"___id": "T000002R001946",
"___s": true,
"skip": true,
"slug": "PIXI.RoundedRectangleclone",
"filepath": "core\\math\\shapes\\RoundedRectangle.js"
},
{
"comment": "/**\n * Checks whether the x and y coordinates given are contained within this Rounded Rectangle\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 coordinates are within this Rounded Rectangle\n */",
"meta": {
"range": [
2364,
3749
],
"filename": "RoundedRectangle.js",
"lineno": 81,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\math\\shapes",
"code": {
"id": "astnode100020373",
"name": "RoundedRectangle#contains",
"type": "MethodDefinition",
"paramnames": [
"x",
"y"
]
},
"vars": {
"": null
}
},
"description": "Checks whether the x and y coordinates given are contained within this Rounded Rectangle
",
"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 coordinates are within this Rounded Rectangle
"
}
],
"name": "contains",
"longname": "PIXI.RoundedRectangle#contains",
"kind": "function",
"memberof": "PIXI.RoundedRectangle",
"scope": "instance",
"___id": "T000002R001947",
"___s": true,
"skip": true,
"slug": "PIXI.RoundedRectanglecontains",
"filepath": "core\\math\\shapes\\RoundedRectangle.js"
},
{
"comment": "/**\n * Creates a clone of this Rounded Rectangle\n *\n * @return {PIXI.RoundedRectangle} a copy of the rounded rectangle\n */",
"meta": {
"range": [
1912,
2022
],
"filename": "RoundedRectangle.js",
"lineno": 69,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\math\\shapes",
"code": {
"id": "astnode100095030",
"name": "RoundedRectangle#clone",
"type": "MethodDefinition",
"paramnames": []
},
"vars": {
"": null
}
},
"description": "Creates a clone of this Rounded Rectangle
",
"returns": [
{
"type": {
"names": [
"PIXI.RoundedRectangle"
]
},
"description": "a copy of the rounded rectangle
"
}
],
"name": "clone",
"longname": "PIXI.RoundedRectangle#clone",
"kind": "function",
"memberof": "PIXI.RoundedRectangle",
"scope": "instance",
"params": [],
"___id": "T000002R008880",
"___s": true,
"skip": true,
"slug": "PIXI.RoundedRectangleclone",
"filepath": "core\\math\\shapes\\RoundedRectangle.js"
},
{
"comment": "/**\n * Checks whether the x and y coordinates given are contained within this Rounded Rectangle\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 coordinates are within this Rounded Rectangle\n */",
"meta": {
"range": [
2364,
3749
],
"filename": "RoundedRectangle.js",
"lineno": 81,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\math\\shapes",
"code": {
"id": "astnode100095052",
"name": "RoundedRectangle#contains",
"type": "MethodDefinition",
"paramnames": [
"x",
"y"
]
},
"vars": {
"": null
}
},
"description": "Checks whether the x and y coordinates given are contained within this Rounded Rectangle
",
"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 coordinates are within this Rounded Rectangle
"
}
],
"name": "contains",
"longname": "PIXI.RoundedRectangle#contains",
"kind": "function",
"memberof": "PIXI.RoundedRectangle",
"scope": "instance",
"___id": "T000002R008881",
"___s": true,
"skip": true,
"slug": "PIXI.RoundedRectanglecontains",
"filepath": "core\\math\\shapes\\RoundedRectangle.js"
}
],
"$attributes": [
{
"comment": "/**\n * @member {number} PIXI.RoundedRectangle#x\n * @default 0\n */",
"meta": {
"range": [
843,
932
],
"filename": "RoundedRectangle.js",
"lineno": 23,
"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.RoundedRectangle",
"longname": "PIXI.RoundedRectangle#x",
"scope": "instance",
"___id": "T000002R001934",
"___s": true,
"skip": true,
"slug": "PIXI.RoundedRectanglex",
"filepath": "core\\math\\shapes\\RoundedRectangle.js"
},
{
"comment": "/**\n * @member {number} PIXI.RoundedRectangle#y\n * @default 0\n */",
"meta": {
"range": [
962,
1051
],
"filename": "RoundedRectangle.js",
"lineno": 29,
"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.RoundedRectangle",
"longname": "PIXI.RoundedRectangle#y",
"scope": "instance",
"___id": "T000002R001936",
"___s": true,
"skip": true,
"slug": "PIXI.RoundedRectangley",
"filepath": "core\\math\\shapes\\RoundedRectangle.js"
},
{
"comment": "/**\n * @member {number} PIXI.RoundedRectangle#width\n * @default 0\n */",
"meta": {
"range": [
1081,
1174
],
"filename": "RoundedRectangle.js",
"lineno": 35,
"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.RoundedRectangle",
"longname": "PIXI.RoundedRectangle#width",
"scope": "instance",
"___id": "T000002R001938",
"___s": true,
"skip": true,
"slug": "PIXI.RoundedRectanglewidth",
"filepath": "core\\math\\shapes\\RoundedRectangle.js"
},
{
"comment": "/**\n * @member {number} PIXI.RoundedRectangle#height\n * @default 0\n */",
"meta": {
"range": [
1212,
1306
],
"filename": "RoundedRectangle.js",
"lineno": 41,
"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.RoundedRectangle",
"longname": "PIXI.RoundedRectangle#height",
"scope": "instance",
"___id": "T000002R001940",
"___s": true,
"skip": true,
"slug": "PIXI.RoundedRectangleheight",
"filepath": "core\\math\\shapes\\RoundedRectangle.js"
},
{
"comment": "/**\n * @member {number} PIXI.RoundedRectangle#radius\n * @default 20\n */",
"meta": {
"range": [
1346,
1441
],
"filename": "RoundedRectangle.js",
"lineno": 47,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\math\\shapes",
"code": {}
},
"kind": "member",
"name": "radius",
"type": {
"names": [
"number"
]
},
"defaultvalue": "20",
"memberof": "PIXI.RoundedRectangle",
"longname": "PIXI.RoundedRectangle#radius",
"scope": "instance",
"___id": "T000002R001942",
"___s": true,
"skip": true,
"slug": "PIXI.RoundedRectangleradius",
"filepath": "core\\math\\shapes\\RoundedRectangle.js"
},
{
"comment": "/**\n * The type of the object, mainly used to avoid `instanceof` checks\n *\n * @member {number} PIXI.RoundedRectangle#type\n * @readonly\n * @default PIXI.SHAPES.RREC\n * @see PIXI.SHAPES\n */",
"meta": {
"range": [
1481,
1724
],
"filename": "RoundedRectangle.js",
"lineno": 53,
"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.RREC",
"see": [
"PIXI.SHAPES"
],
"memberof": "PIXI.RoundedRectangle",
"longname": "PIXI.RoundedRectangle#type",
"scope": "instance",
"___id": "T000002R001944",
"___s": true,
"skip": true,
"slug": "PIXI.RoundedRectangletype",
"filepath": "core\\math\\shapes\\RoundedRectangle.js"
},
{
"comment": "/**\n * @member {number} PIXI.RoundedRectangle#x\n * @default 0\n */",
"meta": {
"range": [
843,
932
],
"filename": "RoundedRectangle.js",
"lineno": 23,
"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.RoundedRectangle",
"longname": "PIXI.RoundedRectangle#x",
"scope": "instance",
"___id": "T000002R008868",
"___s": true,
"skip": true,
"slug": "PIXI.RoundedRectanglex",
"filepath": "core\\math\\shapes\\RoundedRectangle.js"
},
{
"comment": "/**\n * @member {number} PIXI.RoundedRectangle#y\n * @default 0\n */",
"meta": {
"range": [
962,
1051
],
"filename": "RoundedRectangle.js",
"lineno": 29,
"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.RoundedRectangle",
"longname": "PIXI.RoundedRectangle#y",
"scope": "instance",
"___id": "T000002R008870",
"___s": true,
"skip": true,
"slug": "PIXI.RoundedRectangley",
"filepath": "core\\math\\shapes\\RoundedRectangle.js"
},
{
"comment": "/**\n * @member {number} PIXI.RoundedRectangle#width\n * @default 0\n */",
"meta": {
"range": [
1081,
1174
],
"filename": "RoundedRectangle.js",
"lineno": 35,
"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.RoundedRectangle",
"longname": "PIXI.RoundedRectangle#width",
"scope": "instance",
"___id": "T000002R008872",
"___s": true,
"skip": true,
"slug": "PIXI.RoundedRectanglewidth",
"filepath": "core\\math\\shapes\\RoundedRectangle.js"
},
{
"comment": "/**\n * @member {number} PIXI.RoundedRectangle#height\n * @default 0\n */",
"meta": {
"range": [
1212,
1306
],
"filename": "RoundedRectangle.js",
"lineno": 41,
"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.RoundedRectangle",
"longname": "PIXI.RoundedRectangle#height",
"scope": "instance",
"___id": "T000002R008874",
"___s": true,
"skip": true,
"slug": "PIXI.RoundedRectangleheight",
"filepath": "core\\math\\shapes\\RoundedRectangle.js"
},
{
"comment": "/**\n * @member {number} PIXI.RoundedRectangle#radius\n * @default 20\n */",
"meta": {
"range": [
1346,
1441
],
"filename": "RoundedRectangle.js",
"lineno": 47,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\math\\shapes",
"code": {}
},
"kind": "member",
"name": "radius",
"type": {
"names": [
"number"
]
},
"defaultvalue": "20",
"memberof": "PIXI.RoundedRectangle",
"longname": "PIXI.RoundedRectangle#radius",
"scope": "instance",
"___id": "T000002R008876",
"___s": true,
"skip": true,
"slug": "PIXI.RoundedRectangleradius",
"filepath": "core\\math\\shapes\\RoundedRectangle.js"
},
{
"comment": "/**\n * The type of the object, mainly used to avoid `instanceof` checks\n *\n * @member {number} PIXI.RoundedRectangle#type\n * @readonly\n * @default PIXI.SHAPES.RREC\n * @see PIXI.SHAPES\n */",
"meta": {
"range": [
1481,
1724
],
"filename": "RoundedRectangle.js",
"lineno": 53,
"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.RREC",
"see": [
"PIXI.SHAPES"
],
"memberof": "PIXI.RoundedRectangle",
"longname": "PIXI.RoundedRectangle#type",
"scope": "instance",
"___id": "T000002R008878",
"___s": true,
"skip": true,
"slug": "PIXI.RoundedRectangletype",
"filepath": "core\\math\\shapes\\RoundedRectangle.js"
}
],
"$staticmethods": [],
"$staticproperties": [],
"$augments": [],
"$augmentedBy": [],
"filepath": "core\\math\\shapes\\RoundedRectangle.js"
}