Rectangle object is an area defined by its position, as indicated by its top-left corner
point (x, y) and by its width and its height.
| Public methods | |
|---|---|
| public | left(): void |
| public | right(): void |
| public | top(): void |
| public | bottom(): void |
| public static | EMPTY(): void |
| public | clone(): PIXI.Rectangle |
| public | copy(rectangle: PIXI.Rectangle): PIXI.Rectangle |
| public | contains(x: number, y: number): boolean |
| public | pad(paddingX: number, paddingY: number): void |
| public | fit(rectangle: PIXI.Rectangle): void |
| public | enlarge(rectangle: PIXI.Rectangle): void |
| public | left(): void |
| public | right(): void |
| public | top(): void |
| public | bottom(): void |
| public static | EMPTY(): void |
| public | clone(): PIXI.Rectangle |
| public | copy(rectangle: PIXI.Rectangle): PIXI.Rectangle |
| public | contains(x: number, y: number): boolean |
| public | pad(paddingX: number, paddingY: number): void |
| public | fit(rectangle: PIXI.Rectangle): void |
| public | enlarge(rectangle: PIXI.Rectangle): void |
| 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 |
returns the left edge of the rectangle
void
returns the right edge of the rectangle
void
returns the top edge of the rectangle
void
returns the bottom edge of the rectangle
void
A constant empty rectangle.
void
Creates a clone of this Rectangle
PIXI.Rectangle
Copies another rectangle to this one.
| Name | Type | Attribute | Description |
|---|---|---|---|
| rectangle | The rectangle to copy. |
PIXI.Rectangle
Checks whether the x and y coordinates given are contained within this Rectangle
| Name | Type | Attribute | Description |
|---|---|---|---|
| x | The X coordinate of the point to test |
||
| y | The Y coordinate of the point to test |
Pads the rectangle making it grow in all directions.
| Name | Type | Attribute | Description |
|---|---|---|---|
| paddingX | The horizontal padding amount. |
||
| paddingY | The vertical padding amount. |
void
Fits this rectangle around the passed one.
| Name | Type | Attribute | Description |
|---|---|---|---|
| rectangle | The rectangle to fit. |
void
Enlarges this rectangle to include the passed rectangle.
| Name | Type | Attribute | Description |
|---|---|---|---|
| rectangle | The rectangle to include. |
void
returns the left edge of the rectangle
void
returns the right edge of the rectangle
void
returns the top edge of the rectangle
void
returns the bottom edge of the rectangle
void
A constant empty rectangle.
void
Creates a clone of this Rectangle
PIXI.Rectangle
Copies another rectangle to this one.
| Name | Type | Attribute | Description |
|---|---|---|---|
| rectangle | The rectangle to copy. |
PIXI.Rectangle
Checks whether the x and y coordinates given are contained within this Rectangle
| Name | Type | Attribute | Description |
|---|---|---|---|
| x | The X coordinate of the point to test |
||
| y | The Y coordinate of the point to test |
Pads the rectangle making it grow in all directions.
| Name | Type | Attribute | Description |
|---|---|---|---|
| paddingX | The horizontal padding amount. |
||
| paddingY | The vertical padding amount. |
void
Fits this rectangle around the passed one.
| Name | Type | Attribute | Description |
|---|---|---|---|
| rectangle | The rectangle to fit. |
void
Enlarges this rectangle to include the passed rectangle.
| Name | Type | Attribute | Description |
|---|---|---|---|
| rectangle | The rectangle to include. |
void
{
"comment": "/**\n * Rectangle object is an area defined by its position, as indicated by its top-left corner\n * point (x, y) and by its width and its height.\n *\n * @class\n * @memberof PIXI\n */",
"meta": {
"range": [
246,
5556
],
"filename": "Rectangle.js",
"lineno": 12,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\math\\shapes",
"code": {
"id": "astnode100019748",
"name": "Rectangle",
"type": "ClassDeclaration",
"paramnames": [
"x",
"y",
"width",
"height"
]
}
},
"classdesc": "Rectangle object is an area defined by its position, as indicated by its top-left corner
point (x, y) and by its width and its height.
",
"kind": "class",
"memberof": "PIXI",
"name": "Rectangle",
"longname": "PIXI.Rectangle",
"scope": "static",
"params": [
{
"type": {
"names": [
"number"
]
},
"optional": true,
"defaultvalue": 0,
"description": "The X coordinate of the upper-left corner of the rectangle
",
"name": "x"
},
{
"type": {
"names": [
"number"
]
},
"optional": true,
"defaultvalue": 0,
"description": "The Y coordinate of the upper-left corner of the rectangle
",
"name": "y"
},
{
"type": {
"names": [
"number"
]
},
"optional": true,
"defaultvalue": 0,
"description": "The overall width of this rectangle
",
"name": "width"
},
{
"type": {
"names": [
"number"
]
},
"optional": true,
"defaultvalue": 0,
"description": "The overall height of this rectangle
",
"name": "height"
}
],
"___id": "T000002R001880",
"___s": true,
"$methods": [
{
"comment": "/**\n * returns the left edge of the rectangle\n *\n * @member {number}\n */",
"meta": {
"range": [
1520,
1565
],
"filename": "Rectangle.js",
"lineno": 62,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\math\\shapes",
"code": {
"id": "astnode100019799",
"name": "Rectangle#left",
"type": "MethodDefinition",
"paramnames": []
},
"vars": {
"": null
}
},
"description": "returns the left edge of the rectangle
",
"kind": "member",
"type": {
"names": [
"number"
]
},
"name": "left",
"longname": "PIXI.Rectangle#left",
"memberof": "PIXI.Rectangle",
"scope": "instance",
"params": [],
"___id": "T000002R001892",
"___s": true,
"skip": true,
"slug": "PIXI.Rectangleleft",
"filepath": "core\\math\\shapes\\Rectangle.js"
},
{
"comment": "/**\n * returns the right edge of the rectangle\n *\n * @member {number}\n */",
"meta": {
"range": [
1665,
1724
],
"filename": "Rectangle.js",
"lineno": 72,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\math\\shapes",
"code": {
"id": "astnode100019807",
"name": "Rectangle#right",
"type": "MethodDefinition",
"paramnames": []
},
"vars": {
"": null
}
},
"description": "returns the right edge of the rectangle
",
"kind": "member",
"type": {
"names": [
"number"
]
},
"name": "right",
"longname": "PIXI.Rectangle#right",
"memberof": "PIXI.Rectangle",
"scope": "instance",
"params": [],
"___id": "T000002R001893",
"___s": true,
"skip": true,
"slug": "PIXI.Rectangleright",
"filepath": "core\\math\\shapes\\Rectangle.js"
},
{
"comment": "/**\n * returns the top edge of the rectangle\n *\n * @member {number}\n */",
"meta": {
"range": [
1822,
1866
],
"filename": "Rectangle.js",
"lineno": 82,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\math\\shapes",
"code": {
"id": "astnode100019819",
"name": "Rectangle#top",
"type": "MethodDefinition",
"paramnames": []
},
"vars": {
"": null
}
},
"description": "returns the top edge of the rectangle
",
"kind": "member",
"type": {
"names": [
"number"
]
},
"name": "top",
"longname": "PIXI.Rectangle#top",
"memberof": "PIXI.Rectangle",
"scope": "instance",
"params": [],
"___id": "T000002R001894",
"___s": true,
"skip": true,
"slug": "PIXI.Rectangletop",
"filepath": "core\\math\\shapes\\Rectangle.js"
},
{
"comment": "/**\n * returns the bottom edge of the rectangle\n *\n * @member {number}\n */",
"meta": {
"range": [
1967,
2028
],
"filename": "Rectangle.js",
"lineno": 92,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\math\\shapes",
"code": {
"id": "astnode100019827",
"name": "Rectangle#bottom",
"type": "MethodDefinition",
"paramnames": []
},
"vars": {
"": null
}
},
"description": "returns the bottom edge of the rectangle
",
"kind": "member",
"type": {
"names": [
"number"
]
},
"name": "bottom",
"longname": "PIXI.Rectangle#bottom",
"memberof": "PIXI.Rectangle",
"scope": "instance",
"params": [],
"___id": "T000002R001895",
"___s": true,
"skip": true,
"slug": "PIXI.Rectanglebottom",
"filepath": "core\\math\\shapes\\Rectangle.js"
},
{
"comment": "/**\n * A constant empty rectangle.\n *\n * @static\n * @constant\n */",
"meta": {
"range": [
2124,
2196
],
"filename": "Rectangle.js",
"lineno": 103,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\math\\shapes",
"code": {
"id": "astnode100019839",
"name": "Rectangle.EMPTY",
"type": "MethodDefinition",
"paramnames": []
},
"vars": {
"": null
}
},
"description": "A constant empty rectangle.
",
"scope": "static",
"kind": "constant",
"name": "EMPTY",
"longname": "PIXI.Rectangle.EMPTY",
"memberof": "PIXI.Rectangle",
"params": [],
"___id": "T000002R001896",
"___s": true,
"skip": true,
"slug": "PIXI.Rectangle.EMPTY",
"filepath": "core\\math\\shapes\\Rectangle.js"
},
{
"comment": "/**\n * Creates a clone of this Rectangle\n *\n * @return {PIXI.Rectangle} a copy of the rectangle\n */",
"meta": {
"range": [
2322,
2412
],
"filename": "Rectangle.js",
"lineno": 113,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\math\\shapes",
"code": {
"id": "astnode100019850",
"name": "Rectangle#clone",
"type": "MethodDefinition",
"paramnames": []
},
"vars": {
"": null
}
},
"description": "Creates a clone of this Rectangle
",
"returns": [
{
"type": {
"names": [
"PIXI.Rectangle"
]
},
"description": "a copy of the rectangle
"
}
],
"name": "clone",
"longname": "PIXI.Rectangle#clone",
"kind": "function",
"memberof": "PIXI.Rectangle",
"scope": "instance",
"params": [],
"___id": "T000002R001897",
"___s": true,
"skip": true,
"slug": "PIXI.Rectangleclone",
"filepath": "core\\math\\shapes\\Rectangle.js"
},
{
"comment": "/**\n * Copies another rectangle to this one.\n *\n * @param {PIXI.Rectangle} rectangle - The rectangle to copy.\n * @return {PIXI.Rectangle} Returns itself.\n */",
"meta": {
"range": [
2600,
2787
],
"filename": "Rectangle.js",
"lineno": 124,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\math\\shapes",
"code": {
"id": "astnode100019869",
"name": "Rectangle#copy",
"type": "MethodDefinition",
"paramnames": [
"rectangle"
]
},
"vars": {
"": null
}
},
"description": "Copies another rectangle to this one.
",
"params": [
{
"type": {
"names": [
"PIXI.Rectangle"
]
},
"description": "The rectangle to copy.
",
"name": "rectangle"
}
],
"returns": [
{
"type": {
"names": [
"PIXI.Rectangle"
]
},
"description": "Returns itself.
"
}
],
"name": "copy",
"longname": "PIXI.Rectangle#copy",
"kind": "function",
"memberof": "PIXI.Rectangle",
"scope": "instance",
"___id": "T000002R001898",
"___s": true,
"skip": true,
"slug": "PIXI.Rectanglecopy",
"filepath": "core\\math\\shapes\\Rectangle.js"
},
{
"comment": "/**\n * Checks whether the x and y coordinates given are contained within this 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 Rectangle\n */",
"meta": {
"range": [
3113,
3444
],
"filename": "Rectangle.js",
"lineno": 141,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\math\\shapes",
"code": {
"id": "astnode100019908",
"name": "Rectangle#contains",
"type": "MethodDefinition",
"paramnames": [
"x",
"y"
]
},
"vars": {
"": null
}
},
"description": "Checks whether the x and y coordinates given are contained within this 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 Rectangle
"
}
],
"name": "contains",
"longname": "PIXI.Rectangle#contains",
"kind": "function",
"memberof": "PIXI.Rectangle",
"scope": "instance",
"___id": "T000002R001903",
"___s": true,
"skip": true,
"slug": "PIXI.Rectanglecontains",
"filepath": "core\\math\\shapes\\Rectangle.js"
},
{
"comment": "/**\n * Pads the rectangle making it grow in all directions.\n *\n * @param {number} paddingX - The horizontal padding amount.\n * @param {number} paddingY - The vertical padding amount.\n */",
"meta": {
"range": [
3661,
3927
],
"filename": "Rectangle.js",
"lineno": 165,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\math\\shapes",
"code": {
"id": "astnode100019967",
"name": "Rectangle#pad",
"type": "MethodDefinition",
"paramnames": [
"paddingX",
"paddingY"
]
},
"vars": {
"": null
}
},
"description": "Pads the rectangle making it grow in all directions.
",
"params": [
{
"type": {
"names": [
"number"
]
},
"description": "The horizontal padding amount.
",
"name": "paddingX"
},
{
"type": {
"names": [
"number"
]
},
"description": "The vertical padding amount.
",
"name": "paddingY"
}
],
"name": "pad",
"longname": "PIXI.Rectangle#pad",
"kind": "function",
"memberof": "PIXI.Rectangle",
"scope": "instance",
"___id": "T000002R001904",
"___s": true,
"skip": true,
"slug": "PIXI.Rectanglepad",
"filepath": "core\\math\\shapes\\Rectangle.js"
},
{
"comment": "/**\n * Fits this rectangle around the passed one.\n *\n * @param {PIXI.Rectangle} rectangle - The rectangle to fit.\n */",
"meta": {
"range": [
4071,
4994
],
"filename": "Rectangle.js",
"lineno": 182,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\math\\shapes",
"code": {
"id": "astnode100020018",
"name": "Rectangle#fit",
"type": "MethodDefinition",
"paramnames": [
"rectangle"
]
},
"vars": {
"": null
}
},
"description": "Fits this rectangle around the passed one.
",
"params": [
{
"type": {
"names": [
"PIXI.Rectangle"
]
},
"description": "The rectangle to fit.
",
"name": "rectangle"
}
],
"name": "fit",
"longname": "PIXI.Rectangle#fit",
"kind": "function",
"memberof": "PIXI.Rectangle",
"scope": "instance",
"___id": "T000002R001911",
"___s": true,
"skip": true,
"slug": "PIXI.Rectanglefit",
"filepath": "core\\math\\shapes\\Rectangle.js"
},
{
"comment": "/**\n * Enlarges this rectangle to include the passed rectangle.\n *\n * @param {PIXI.Rectangle} rectangle - The rectangle to include.\n */",
"meta": {
"range": [
5156,
5554
],
"filename": "Rectangle.js",
"lineno": 229,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\math\\shapes",
"code": {
"id": "astnode100020183",
"name": "Rectangle#enlarge",
"type": "MethodDefinition",
"paramnames": [
"rectangle"
]
},
"vars": {
"": null
}
},
"description": "Enlarges this rectangle to include the passed rectangle.
",
"params": [
{
"type": {
"names": [
"PIXI.Rectangle"
]
},
"description": "The rectangle to include.
",
"name": "rectangle"
}
],
"name": "enlarge",
"longname": "PIXI.Rectangle#enlarge",
"kind": "function",
"memberof": "PIXI.Rectangle",
"scope": "instance",
"___id": "T000002R001922",
"___s": true,
"skip": true,
"slug": "PIXI.Rectangleenlarge",
"filepath": "core\\math\\shapes\\Rectangle.js"
},
{
"comment": "/**\n * returns the left edge of the rectangle\n *\n * @member {number}\n */",
"meta": {
"range": [
1520,
1565
],
"filename": "Rectangle.js",
"lineno": 62,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\math\\shapes",
"code": {
"id": "astnode100094478",
"name": "Rectangle#left",
"type": "MethodDefinition",
"paramnames": []
},
"vars": {
"": null
}
},
"description": "returns the left edge of the rectangle
",
"kind": "member",
"type": {
"names": [
"number"
]
},
"name": "left",
"longname": "PIXI.Rectangle#left",
"memberof": "PIXI.Rectangle",
"scope": "instance",
"params": [],
"___id": "T000002R008826",
"___s": true,
"skip": true,
"slug": "PIXI.Rectangleleft",
"filepath": "core\\math\\shapes\\Rectangle.js"
},
{
"comment": "/**\n * returns the right edge of the rectangle\n *\n * @member {number}\n */",
"meta": {
"range": [
1665,
1724
],
"filename": "Rectangle.js",
"lineno": 72,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\math\\shapes",
"code": {
"id": "astnode100094486",
"name": "Rectangle#right",
"type": "MethodDefinition",
"paramnames": []
},
"vars": {
"": null
}
},
"description": "returns the right edge of the rectangle
",
"kind": "member",
"type": {
"names": [
"number"
]
},
"name": "right",
"longname": "PIXI.Rectangle#right",
"memberof": "PIXI.Rectangle",
"scope": "instance",
"params": [],
"___id": "T000002R008827",
"___s": true,
"skip": true,
"slug": "PIXI.Rectangleright",
"filepath": "core\\math\\shapes\\Rectangle.js"
},
{
"comment": "/**\n * returns the top edge of the rectangle\n *\n * @member {number}\n */",
"meta": {
"range": [
1822,
1866
],
"filename": "Rectangle.js",
"lineno": 82,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\math\\shapes",
"code": {
"id": "astnode100094498",
"name": "Rectangle#top",
"type": "MethodDefinition",
"paramnames": []
},
"vars": {
"": null
}
},
"description": "returns the top edge of the rectangle
",
"kind": "member",
"type": {
"names": [
"number"
]
},
"name": "top",
"longname": "PIXI.Rectangle#top",
"memberof": "PIXI.Rectangle",
"scope": "instance",
"params": [],
"___id": "T000002R008828",
"___s": true,
"skip": true,
"slug": "PIXI.Rectangletop",
"filepath": "core\\math\\shapes\\Rectangle.js"
},
{
"comment": "/**\n * returns the bottom edge of the rectangle\n *\n * @member {number}\n */",
"meta": {
"range": [
1967,
2028
],
"filename": "Rectangle.js",
"lineno": 92,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\math\\shapes",
"code": {
"id": "astnode100094506",
"name": "Rectangle#bottom",
"type": "MethodDefinition",
"paramnames": []
},
"vars": {
"": null
}
},
"description": "returns the bottom edge of the rectangle
",
"kind": "member",
"type": {
"names": [
"number"
]
},
"name": "bottom",
"longname": "PIXI.Rectangle#bottom",
"memberof": "PIXI.Rectangle",
"scope": "instance",
"params": [],
"___id": "T000002R008829",
"___s": true,
"skip": true,
"slug": "PIXI.Rectanglebottom",
"filepath": "core\\math\\shapes\\Rectangle.js"
},
{
"comment": "/**\n * A constant empty rectangle.\n *\n * @static\n * @constant\n */",
"meta": {
"range": [
2124,
2196
],
"filename": "Rectangle.js",
"lineno": 103,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\math\\shapes",
"code": {
"id": "astnode100094518",
"name": "Rectangle.EMPTY",
"type": "MethodDefinition",
"paramnames": []
},
"vars": {
"": null
}
},
"description": "A constant empty rectangle.
",
"scope": "static",
"kind": "constant",
"name": "EMPTY",
"longname": "PIXI.Rectangle.EMPTY",
"memberof": "PIXI.Rectangle",
"params": [],
"___id": "T000002R008830",
"___s": true,
"skip": true,
"slug": "PIXI.Rectangle.EMPTY",
"filepath": "core\\math\\shapes\\Rectangle.js"
},
{
"comment": "/**\n * Creates a clone of this Rectangle\n *\n * @return {PIXI.Rectangle} a copy of the rectangle\n */",
"meta": {
"range": [
2322,
2412
],
"filename": "Rectangle.js",
"lineno": 113,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\math\\shapes",
"code": {
"id": "astnode100094529",
"name": "Rectangle#clone",
"type": "MethodDefinition",
"paramnames": []
},
"vars": {
"": null
}
},
"description": "Creates a clone of this Rectangle
",
"returns": [
{
"type": {
"names": [
"PIXI.Rectangle"
]
},
"description": "a copy of the rectangle
"
}
],
"name": "clone",
"longname": "PIXI.Rectangle#clone",
"kind": "function",
"memberof": "PIXI.Rectangle",
"scope": "instance",
"params": [],
"___id": "T000002R008831",
"___s": true,
"skip": true,
"slug": "PIXI.Rectangleclone",
"filepath": "core\\math\\shapes\\Rectangle.js"
},
{
"comment": "/**\n * Copies another rectangle to this one.\n *\n * @param {PIXI.Rectangle} rectangle - The rectangle to copy.\n * @return {PIXI.Rectangle} Returns itself.\n */",
"meta": {
"range": [
2600,
2787
],
"filename": "Rectangle.js",
"lineno": 124,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\math\\shapes",
"code": {
"id": "astnode100094548",
"name": "Rectangle#copy",
"type": "MethodDefinition",
"paramnames": [
"rectangle"
]
},
"vars": {
"": null
}
},
"description": "Copies another rectangle to this one.
",
"params": [
{
"type": {
"names": [
"PIXI.Rectangle"
]
},
"description": "The rectangle to copy.
",
"name": "rectangle"
}
],
"returns": [
{
"type": {
"names": [
"PIXI.Rectangle"
]
},
"description": "Returns itself.
"
}
],
"name": "copy",
"longname": "PIXI.Rectangle#copy",
"kind": "function",
"memberof": "PIXI.Rectangle",
"scope": "instance",
"___id": "T000002R008832",
"___s": true,
"skip": true,
"slug": "PIXI.Rectanglecopy",
"filepath": "core\\math\\shapes\\Rectangle.js"
},
{
"comment": "/**\n * Checks whether the x and y coordinates given are contained within this 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 Rectangle\n */",
"meta": {
"range": [
3113,
3444
],
"filename": "Rectangle.js",
"lineno": 141,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\math\\shapes",
"code": {
"id": "astnode100094587",
"name": "Rectangle#contains",
"type": "MethodDefinition",
"paramnames": [
"x",
"y"
]
},
"vars": {
"": null
}
},
"description": "Checks whether the x and y coordinates given are contained within this 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 Rectangle
"
}
],
"name": "contains",
"longname": "PIXI.Rectangle#contains",
"kind": "function",
"memberof": "PIXI.Rectangle",
"scope": "instance",
"___id": "T000002R008837",
"___s": true,
"skip": true,
"slug": "PIXI.Rectanglecontains",
"filepath": "core\\math\\shapes\\Rectangle.js"
},
{
"comment": "/**\n * Pads the rectangle making it grow in all directions.\n *\n * @param {number} paddingX - The horizontal padding amount.\n * @param {number} paddingY - The vertical padding amount.\n */",
"meta": {
"range": [
3661,
3927
],
"filename": "Rectangle.js",
"lineno": 165,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\math\\shapes",
"code": {
"id": "astnode100094646",
"name": "Rectangle#pad",
"type": "MethodDefinition",
"paramnames": [
"paddingX",
"paddingY"
]
},
"vars": {
"": null
}
},
"description": "Pads the rectangle making it grow in all directions.
",
"params": [
{
"type": {
"names": [
"number"
]
},
"description": "The horizontal padding amount.
",
"name": "paddingX"
},
{
"type": {
"names": [
"number"
]
},
"description": "The vertical padding amount.
",
"name": "paddingY"
}
],
"name": "pad",
"longname": "PIXI.Rectangle#pad",
"kind": "function",
"memberof": "PIXI.Rectangle",
"scope": "instance",
"___id": "T000002R008838",
"___s": true,
"skip": true,
"slug": "PIXI.Rectanglepad",
"filepath": "core\\math\\shapes\\Rectangle.js"
},
{
"comment": "/**\n * Fits this rectangle around the passed one.\n *\n * @param {PIXI.Rectangle} rectangle - The rectangle to fit.\n */",
"meta": {
"range": [
4071,
4994
],
"filename": "Rectangle.js",
"lineno": 182,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\math\\shapes",
"code": {
"id": "astnode100094697",
"name": "Rectangle#fit",
"type": "MethodDefinition",
"paramnames": [
"rectangle"
]
},
"vars": {
"": null
}
},
"description": "Fits this rectangle around the passed one.
",
"params": [
{
"type": {
"names": [
"PIXI.Rectangle"
]
},
"description": "The rectangle to fit.
",
"name": "rectangle"
}
],
"name": "fit",
"longname": "PIXI.Rectangle#fit",
"kind": "function",
"memberof": "PIXI.Rectangle",
"scope": "instance",
"___id": "T000002R008845",
"___s": true,
"skip": true,
"slug": "PIXI.Rectanglefit",
"filepath": "core\\math\\shapes\\Rectangle.js"
},
{
"comment": "/**\n * Enlarges this rectangle to include the passed rectangle.\n *\n * @param {PIXI.Rectangle} rectangle - The rectangle to include.\n */",
"meta": {
"range": [
5156,
5554
],
"filename": "Rectangle.js",
"lineno": 229,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\math\\shapes",
"code": {
"id": "astnode100094862",
"name": "Rectangle#enlarge",
"type": "MethodDefinition",
"paramnames": [
"rectangle"
]
},
"vars": {
"": null
}
},
"description": "Enlarges this rectangle to include the passed rectangle.
",
"params": [
{
"type": {
"names": [
"PIXI.Rectangle"
]
},
"description": "The rectangle to include.
",
"name": "rectangle"
}
],
"name": "enlarge",
"longname": "PIXI.Rectangle#enlarge",
"kind": "function",
"memberof": "PIXI.Rectangle",
"scope": "instance",
"___id": "T000002R008856",
"___s": true,
"skip": true,
"slug": "PIXI.Rectangleenlarge",
"filepath": "core\\math\\shapes\\Rectangle.js"
}
],
"$attributes": [
{
"comment": "/**\n * @member {number} PIXI.Rectangle#x\n * @default 0\n */",
"meta": {
"range": [
671,
753
],
"filename": "Rectangle.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.Rectangle",
"longname": "PIXI.Rectangle#x",
"scope": "instance",
"___id": "T000002R001882",
"___s": true,
"skip": true,
"slug": "PIXI.Rectanglex",
"filepath": "core\\math\\shapes\\Rectangle.js"
},
{
"comment": "/**\n * @member {number} PIXI.Rectangle#y\n * @default 0\n */",
"meta": {
"range": [
783,
865
],
"filename": "Rectangle.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.Rectangle",
"longname": "PIXI.Rectangle#y",
"scope": "instance",
"___id": "T000002R001884",
"___s": true,
"skip": true,
"slug": "PIXI.Rectangley",
"filepath": "core\\math\\shapes\\Rectangle.js"
},
{
"comment": "/**\n * @member {number} PIXI.Rectangle#width\n * @default 0\n */",
"meta": {
"range": [
895,
981
],
"filename": "Rectangle.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.Rectangle",
"longname": "PIXI.Rectangle#width",
"scope": "instance",
"___id": "T000002R001886",
"___s": true,
"skip": true,
"slug": "PIXI.Rectanglewidth",
"filepath": "core\\math\\shapes\\Rectangle.js"
},
{
"comment": "/**\n * @member {number} PIXI.Rectangle#height\n * @default 0\n */",
"meta": {
"range": [
1019,
1106
],
"filename": "Rectangle.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.Rectangle",
"longname": "PIXI.Rectangle#height",
"scope": "instance",
"___id": "T000002R001888",
"___s": true,
"skip": true,
"slug": "PIXI.Rectangleheight",
"filepath": "core\\math\\shapes\\Rectangle.js"
},
{
"comment": "/**\n * The type of the object, mainly used to avoid `instanceof` checks\n *\n * @member {number} PIXI.Rectangle#type\n * @readOnly\n * @default PIXI.SHAPES.RECT\n * @see PIXI.SHAPES\n */",
"meta": {
"range": [
1146,
1382
],
"filename": "Rectangle.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.RECT",
"see": [
"PIXI.SHAPES"
],
"memberof": "PIXI.Rectangle",
"longname": "PIXI.Rectangle#type",
"scope": "instance",
"___id": "T000002R001890",
"___s": true,
"skip": true,
"slug": "PIXI.Rectangletype",
"filepath": "core\\math\\shapes\\Rectangle.js"
},
{
"comment": "/**\n * @member {number} PIXI.Rectangle#x\n * @default 0\n */",
"meta": {
"range": [
671,
753
],
"filename": "Rectangle.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.Rectangle",
"longname": "PIXI.Rectangle#x",
"scope": "instance",
"___id": "T000002R008816",
"___s": true,
"skip": true,
"slug": "PIXI.Rectanglex",
"filepath": "core\\math\\shapes\\Rectangle.js"
},
{
"comment": "/**\n * @member {number} PIXI.Rectangle#y\n * @default 0\n */",
"meta": {
"range": [
783,
865
],
"filename": "Rectangle.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.Rectangle",
"longname": "PIXI.Rectangle#y",
"scope": "instance",
"___id": "T000002R008818",
"___s": true,
"skip": true,
"slug": "PIXI.Rectangley",
"filepath": "core\\math\\shapes\\Rectangle.js"
},
{
"comment": "/**\n * @member {number} PIXI.Rectangle#width\n * @default 0\n */",
"meta": {
"range": [
895,
981
],
"filename": "Rectangle.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.Rectangle",
"longname": "PIXI.Rectangle#width",
"scope": "instance",
"___id": "T000002R008820",
"___s": true,
"skip": true,
"slug": "PIXI.Rectanglewidth",
"filepath": "core\\math\\shapes\\Rectangle.js"
},
{
"comment": "/**\n * @member {number} PIXI.Rectangle#height\n * @default 0\n */",
"meta": {
"range": [
1019,
1106
],
"filename": "Rectangle.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.Rectangle",
"longname": "PIXI.Rectangle#height",
"scope": "instance",
"___id": "T000002R008822",
"___s": true,
"skip": true,
"slug": "PIXI.Rectangleheight",
"filepath": "core\\math\\shapes\\Rectangle.js"
},
{
"comment": "/**\n * The type of the object, mainly used to avoid `instanceof` checks\n *\n * @member {number} PIXI.Rectangle#type\n * @readOnly\n * @default PIXI.SHAPES.RECT\n * @see PIXI.SHAPES\n */",
"meta": {
"range": [
1146,
1382
],
"filename": "Rectangle.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.RECT",
"see": [
"PIXI.SHAPES"
],
"memberof": "PIXI.Rectangle",
"longname": "PIXI.Rectangle#type",
"scope": "instance",
"___id": "T000002R008824",
"___s": true,
"skip": true,
"slug": "PIXI.Rectangletype",
"filepath": "core\\math\\shapes\\Rectangle.js"
}
],
"$staticmethods": [],
"$staticproperties": [],
"$augments": [],
"$augmentedBy": [],
"filepath": "core\\math\\shapes\\Rectangle.js"
}