The base class for all objects that are rendered on the screen.
This is an abstract class and should not be used on its own rather it should be extended.
Public methods | |
---|---|
private | _tempDisplayObjectParent(): void |
public | updateTransform(): void |
public | _recursivePostUpdateTransform(): void |
public | getBounds(skipUpdate: boolean, rect: PIXI.Rectangle): PIXI.Rectangle |
public | getLocalBounds(rect: PIXI.Rectangle): PIXI.Rectangle |
public | toGlobal(position: PIXI.Point, point: PIXI.Point, skipUpdate: boolean): PIXI.Point |
public | toLocal(position: PIXI.Point, from: PIXI.DisplayObject, point: PIXI.Point, skipUpdate: boolean): PIXI.Point |
public | renderWebGL(renderer: PIXI.WebGLRenderer): void |
public | renderCanvas(renderer: PIXI.CanvasRenderer): void |
public | setParent(container: PIXI.Container): PIXI.Container |
public | setTransform(x: number, y: number, scaleX: number, scaleY: number, rotation: number, skewX: number, skewY: number, pivotX: number, pivotY: number): PIXI.DisplayObject |
public | destroy(): void |
public | x(): void |
public | y(): void |
public | worldTransform(): void |
public | localTransform(): void |
public | position(): void |
public | scale(): void |
public | pivot(): void |
public | skew(): void |
public | rotation(): void |
public | worldVisible(): void |
public | mask(): void |
public | filters(): void |
private | _tempDisplayObjectParent(): void |
public | updateTransform(): void |
public | _recursivePostUpdateTransform(): void |
public | getBounds(skipUpdate: boolean, rect: PIXI.Rectangle): PIXI.Rectangle |
public | getLocalBounds(rect: PIXI.Rectangle): PIXI.Rectangle |
public | toGlobal(position: PIXI.Point, point: PIXI.Point, skipUpdate: boolean): PIXI.Point |
public | toLocal(position: PIXI.Point, from: PIXI.DisplayObject, point: PIXI.Point, skipUpdate: boolean): PIXI.Point |
public | renderWebGL(renderer: PIXI.WebGLRenderer): void |
public | renderCanvas(renderer: PIXI.CanvasRenderer): void |
public | setParent(container: PIXI.Container): PIXI.Container |
public | setTransform(x: number, y: number, scaleX: number, scaleY: number, rotation: number, skewX: number, skewY: number, pivotX: number, pivotY: number): PIXI.DisplayObject |
public | destroy(): void |
public | x(): void |
public | y(): void |
public | worldTransform(): void |
public | localTransform(): void |
public | position(): void |
public | scale(): void |
public | pivot(): void |
public | skew(): void |
public | rotation(): void |
public | worldVisible(): void |
public | mask(): void |
public | filters(): void |
Name | Type | Attribute | Description |
---|---|---|---|
transform | PIXI.TransformBase | public | World transform and local transform of this object. |
alpha | number | public | The opacity of the object. |
visible | boolean | public | The visibility of the object. If false the object will not be drawn, and Only affects recursive calls from parent. You can ask for bounds or call updateTransform manually |
renderable | boolean | public | Can this object be rendered, if false the object will not be drawn but the updateTransform Only affects recursive calls from parent. You can ask for bounds manually |
parent | PIXI.Container | public | The display object container that contains this display object. |
worldAlpha | number | public | The multiplied alpha of the displayObject |
filterArea | PIXI.Rectangle | public | The area the filter is applied to. This is used as more of an optimisation Also works as an interaction mask |
_bounds | PIXI.Rectangle | private | The bounds object, this is used to calculate and store the bounds of the displayObject |
_mask | PIXI.Graphics PIXI.Sprite | private | The original, cached mask of the object |
_destroyed | boolean | private | If the object has been destroyed via destroy(). If true, it should not be used. |
cacheAsBitmap | boolean | public | Set this to true if you want this display object to be cached as a bitmap. IMPORTANT GOTCHA - make sure that all your textures are preloaded BEFORE setting this property to true |
transform | PIXI.TransformBase | public | World transform and local transform of this object. |
alpha | number | public | The opacity of the object. |
visible | boolean | public | The visibility of the object. If false the object will not be drawn, and Only affects recursive calls from parent. You can ask for bounds or call updateTransform manually |
renderable | boolean | public | Can this object be rendered, if false the object will not be drawn but the updateTransform Only affects recursive calls from parent. You can ask for bounds manually |
parent | PIXI.Container | public | The display object container that contains this display object. |
worldAlpha | number | public | The multiplied alpha of the displayObject |
filterArea | PIXI.Rectangle | public | The area the filter is applied to. This is used as more of an optimisation Also works as an interaction mask |
_bounds | PIXI.Rectangle | private | The bounds object, this is used to calculate and store the bounds of the displayObject |
_mask | PIXI.Graphics PIXI.Sprite | private | The original, cached mask of the object |
_destroyed | boolean | private | If the object has been destroyed via destroy(). If true, it should not be used. |
cacheAsBitmap | boolean | public | Set this to true if you want this display object to be cached as a bitmap. IMPORTANT GOTCHA - make sure that all your textures are preloaded BEFORE setting this property to true |
void
Updates the object transform for rendering
TODO - Optimization pass!
void
recursively updates transform of all objects from the root to this one
internal function for toLocal()
void
Retrieves the bounds of the displayObject as a rectangle object.
Name | Type | Attribute | Description |
---|---|---|---|
skipUpdate | setting to true will stop the transforms of the scene graph from |
||
rect | Optional rectangle to store the result of the bounds calculation |
PIXI.Rectangle
Retrieves the local bounds of the displayObject as a rectangle object
Name | Type | Attribute | Description |
---|---|---|---|
rect | Optional rectangle to store the result of the bounds calculation |
PIXI.Rectangle
Calculates the global position of the display object
Name | Type | Attribute | Description |
---|---|---|---|
position | The world origin to calculate from |
||
point | A Point object in which to store the value, optional |
||
skipUpdate | Should we skip the update transform. |
PIXI.Point
Calculates the local position of the display object relative to another point
Name | Type | Attribute | Description |
---|---|---|---|
position | The world origin to calculate from |
||
from | The DisplayObject to calculate the global position from |
||
point | A Point object in which to store the value, optional |
||
skipUpdate | Should we skip the update transform |
PIXI.Point
Renders the object using the WebGL renderer
Name | Type | Attribute | Description |
---|---|---|---|
renderer | The renderer |
void
Renders the object using the Canvas renderer
Name | Type | Attribute | Description |
---|---|---|---|
renderer | The renderer |
void
Set the parent Container of this DisplayObject
Name | Type | Attribute | Description |
---|---|---|---|
container | The Container to add this DisplayObject to |
PIXI.Container
Convenience function to set the position, scale, skew and pivot at once.
Name | Type | Attribute | Description |
---|---|---|---|
x | The X position |
||
y | The Y position |
||
scaleX | The X scale value |
||
scaleY | The Y scale value |
||
rotation | The rotation |
||
skewX | The X skew value |
||
skewY | The Y skew value |
||
pivotX | The X pivot value |
||
pivotY | The Y pivot value |
PIXI.DisplayObject
Base destroy method for generic display objects. This will automatically
remove the display object from its parent Container as well as remove
all current event listeners and internal references. Do not use a DisplayObject
after calling destroy
.
void
The position of the displayObject on the x axis relative to the local coordinates of the parent.
An alias to position.x
void
The position of the displayObject on the y axis relative to the local coordinates of the parent.
An alias to position.y
void
Current transform of the object based on world (parent) factors
void
Current transform of the object based on local factors: position, scale, other stuff
void
The coordinate of the object relative to the local coordinates of the parent.
Assignment by value since pixi-v4.
void
The scale factor of the object.
Assignment by value since pixi-v4.
void
The pivot point of the displayObject that it rotates around
Assignment by value since pixi-v4.
void
The skew factor for the object in radians.
Assignment by value since pixi-v4.
void
The rotation of the object in radians.
void
Indicates if the object is globally visible.
void
Sets a mask for the displayObject. A mask is an object that limits the visibility of an
object to the shape of the mask applied to it. In PIXI a regular mask must be a
PIXI.Graphics or a PIXI.Sprite object. This allows for much faster masking in canvas as it
utilises shape clipping. To remove a mask, set this property to null.
void
Sets the filters for the displayObject.
void
void
Updates the object transform for rendering
TODO - Optimization pass!
void
recursively updates transform of all objects from the root to this one
internal function for toLocal()
void
Retrieves the bounds of the displayObject as a rectangle object.
Name | Type | Attribute | Description |
---|---|---|---|
skipUpdate | setting to true will stop the transforms of the scene graph from |
||
rect | Optional rectangle to store the result of the bounds calculation |
PIXI.Rectangle
Retrieves the local bounds of the displayObject as a rectangle object
Name | Type | Attribute | Description |
---|---|---|---|
rect | Optional rectangle to store the result of the bounds calculation |
PIXI.Rectangle
Calculates the global position of the display object
Name | Type | Attribute | Description |
---|---|---|---|
position | The world origin to calculate from |
||
point | A Point object in which to store the value, optional |
||
skipUpdate | Should we skip the update transform. |
PIXI.Point
Calculates the local position of the display object relative to another point
Name | Type | Attribute | Description |
---|---|---|---|
position | The world origin to calculate from |
||
from | The DisplayObject to calculate the global position from |
||
point | A Point object in which to store the value, optional |
||
skipUpdate | Should we skip the update transform |
PIXI.Point
Renders the object using the WebGL renderer
Name | Type | Attribute | Description |
---|---|---|---|
renderer | The renderer |
void
Renders the object using the Canvas renderer
Name | Type | Attribute | Description |
---|---|---|---|
renderer | The renderer |
void
Set the parent Container of this DisplayObject
Name | Type | Attribute | Description |
---|---|---|---|
container | The Container to add this DisplayObject to |
PIXI.Container
Convenience function to set the position, scale, skew and pivot at once.
Name | Type | Attribute | Description |
---|---|---|---|
x | The X position |
||
y | The Y position |
||
scaleX | The X scale value |
||
scaleY | The Y scale value |
||
rotation | The rotation |
||
skewX | The X skew value |
||
skewY | The Y skew value |
||
pivotX | The X pivot value |
||
pivotY | The Y pivot value |
PIXI.DisplayObject
Base destroy method for generic display objects. This will automatically
remove the display object from its parent Container as well as remove
all current event listeners and internal references. Do not use a DisplayObject
after calling destroy
.
void
The position of the displayObject on the x axis relative to the local coordinates of the parent.
An alias to position.x
void
The position of the displayObject on the y axis relative to the local coordinates of the parent.
An alias to position.y
void
Current transform of the object based on world (parent) factors
void
Current transform of the object based on local factors: position, scale, other stuff
void
The coordinate of the object relative to the local coordinates of the parent.
Assignment by value since pixi-v4.
void
The scale factor of the object.
Assignment by value since pixi-v4.
void
The pivot point of the displayObject that it rotates around
Assignment by value since pixi-v4.
void
The skew factor for the object in radians.
Assignment by value since pixi-v4.
void
The rotation of the object in radians.
void
Indicates if the object is globally visible.
void
Sets a mask for the displayObject. A mask is an object that limits the visibility of an
object to the shape of the mask applied to it. In PIXI a regular mask must be a
PIXI.Graphics or a PIXI.Sprite object. This allows for much faster masking in canvas as it
utilises shape clipping. To remove a mask, set this property to null.
void
Sets the filters for the displayObject.
void
Updates the object transform for rendering
\nTODO - Optimization pass!
", "name": "updateTransform", "longname": "PIXI.DisplayObject#updateTransform", "kind": "function", "memberof": "PIXI.DisplayObject", "scope": "instance", "params": [], "___id": "T000002R007481", "___s": true, "skip": true, "slug": "PIXI.DisplayObjectupdateTransform", "filepath": "core\\display\\DisplayObject.js" }, { "comment": "/**\n * recursively updates transform of all objects from the root to this one\n * internal function for toLocal()\n */", "meta": { "range": [ 4681, 5011 ], "filename": "DisplayObject.js", "lineno": 161, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\display", "code": { "id": "astnode100079824", "name": "DisplayObject#_recursivePostUpdateTransform", "type": "MethodDefinition", "paramnames": [] }, "vars": { "": null } }, "description": "recursively updates transform of all objects from the root to this one
internal function for toLocal()
Retrieves the bounds of the displayObject as a rectangle object.
", "params": [ { "type": { "names": [ "boolean" ] }, "description": "setting to true will stop the transforms of the scene graph from
being updated. This means the calculation returned MAY be out of date BUT will give you a
nice performance boost
Optional rectangle to store the result of the bounds calculation
", "name": "rect" } ], "returns": [ { "type": { "names": [ "PIXI.Rectangle" ] }, "description": "the rectangular bounding area
" } ], "name": "getBounds", "longname": "PIXI.DisplayObject#getBounds", "kind": "function", "memberof": "PIXI.DisplayObject", "scope": "instance", "___id": "T000002R007484", "___s": true, "skip": true, "slug": "PIXI.DisplayObjectgetBounds", "filepath": "core\\display\\DisplayObject.js" }, { "comment": "/**\n * Retrieves the local bounds of the displayObject as a rectangle object\n *\n * @param {PIXI.Rectangle} [rect] - Optional rectangle to store the result of the bounds calculation\n * @return {PIXI.Rectangle} the rectangular bounding area\n */", "meta": { "range": [ 6549, 7118 ], "filename": "DisplayObject.js", "lineno": 224, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\display", "code": { "id": "astnode100079956", "name": "DisplayObject#getLocalBounds", "type": "MethodDefinition", "paramnames": [ "rect" ] }, "vars": { "": null } }, "description": "Retrieves the local bounds of the displayObject as a rectangle object
", "params": [ { "type": { "names": [ "PIXI.Rectangle" ] }, "optional": true, "description": "Optional rectangle to store the result of the bounds calculation
", "name": "rect" } ], "returns": [ { "type": { "names": [ "PIXI.Rectangle" ] }, "description": "the rectangular bounding area
" } ], "name": "getLocalBounds", "longname": "PIXI.DisplayObject#getLocalBounds", "kind": "function", "memberof": "PIXI.DisplayObject", "scope": "instance", "___id": "T000002R007489", "___s": true, "skip": true, "slug": "PIXI.DisplayObjectgetLocalBounds", "filepath": "core\\display\\DisplayObject.js" }, { "comment": "/**\n * Calculates the global position of the display object\n *\n * @param {PIXI.Point} position - The world origin to calculate from\n * @param {PIXI.Point} [point] - A Point object in which to store the value, optional\n * (otherwise will create a new Point)\n * @param {boolean} [skipUpdate=false] - Should we skip the update transform.\n * @return {PIXI.Point} A point object representing the position of this object\n */", "meta": { "range": [ 7580, 8444 ], "filename": "DisplayObject.js", "lineno": 259, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\display", "code": { "id": "astnode100080035", "name": "DisplayObject#toGlobal", "type": "MethodDefinition", "paramnames": [ "position", "point", "skipUpdate" ] }, "vars": { "": null } }, "description": "Calculates the global position of the display object
", "params": [ { "type": { "names": [ "PIXI.Point" ] }, "description": "The world origin to calculate from
", "name": "position" }, { "type": { "names": [ "PIXI.Point" ] }, "optional": true, "description": "A Point object in which to store the value, optional
(otherwise will create a new Point)
Should we skip the update transform.
", "name": "skipUpdate" } ], "returns": [ { "type": { "names": [ "PIXI.Point" ] }, "description": "A point object representing the position of this object
" } ], "name": "toGlobal", "longname": "PIXI.DisplayObject#toGlobal", "kind": "function", "memberof": "PIXI.DisplayObject", "scope": "instance", "___id": "T000002R007499", "___s": true, "skip": true, "slug": "PIXI.DisplayObjecttoGlobal", "filepath": "core\\display\\DisplayObject.js" }, { "comment": "/**\n * Calculates the local position of the display object relative to another point\n *\n * @param {PIXI.Point} position - The world origin to calculate from\n * @param {PIXI.DisplayObject} [from] - The DisplayObject to calculate the global position from\n * @param {PIXI.Point} [point] - A Point object in which to store the value, optional\n * (otherwise will create a new Point)\n * @param {boolean} [skipUpdate=false] - Should we skip the update transform\n * @return {PIXI.Point} A point object representing the position of this object\n */", "meta": { "range": [ 9030, 10001 ], "filename": "DisplayObject.js", "lineno": 294, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\display", "code": { "id": "astnode100080093", "name": "DisplayObject#toLocal", "type": "MethodDefinition", "paramnames": [ "position", "from", "point", "skipUpdate" ] }, "vars": { "": null } }, "description": "Calculates the local position of the display object relative to another point
", "params": [ { "type": { "names": [ "PIXI.Point" ] }, "description": "The world origin to calculate from
", "name": "position" }, { "type": { "names": [ "PIXI.DisplayObject" ] }, "optional": true, "description": "The DisplayObject to calculate the global position from
", "name": "from" }, { "type": { "names": [ "PIXI.Point" ] }, "optional": true, "description": "A Point object in which to store the value, optional
(otherwise will create a new Point)
Should we skip the update transform
", "name": "skipUpdate" } ], "returns": [ { "type": { "names": [ "PIXI.Point" ] }, "description": "A point object representing the position of this object
" } ], "name": "toLocal", "longname": "PIXI.DisplayObject#toLocal", "kind": "function", "memberof": "PIXI.DisplayObject", "scope": "instance", "___id": "T000002R007502", "___s": true, "skip": true, "slug": "PIXI.DisplayObjecttoLocal", "filepath": "core\\display\\DisplayObject.js" }, { "comment": "/**\n * Renders the object using the WebGL renderer\n *\n * @param {PIXI.WebGLRenderer} renderer - The renderer\n */", "meta": { "range": [ 10140, 10233 ], "filename": "DisplayObject.js", "lineno": 329, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\display", "code": { "id": "astnode100080163", "name": "DisplayObject#renderWebGL", "type": "MethodDefinition", "paramnames": [ "renderer" ] }, "vars": { "": null } }, "description": "Renders the object using the WebGL renderer
", "params": [ { "type": { "names": [ "PIXI.WebGLRenderer" ] }, "description": "The renderer
", "name": "renderer" } ], "name": "renderWebGL", "longname": "PIXI.DisplayObject#renderWebGL", "kind": "function", "memberof": "PIXI.DisplayObject", "scope": "instance", "___id": "T000002R007506", "___s": true, "skip": true, "slug": "PIXI.DisplayObjectrenderWebGL", "filepath": "core\\display\\DisplayObject.js" }, { "comment": "/**\n * Renders the object using the Canvas renderer\n *\n * @param {PIXI.CanvasRenderer} renderer - The renderer\n */", "meta": { "range": [ 10374, 10468 ], "filename": "DisplayObject.js", "lineno": 339, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\display", "code": { "id": "astnode100080168", "name": "DisplayObject#renderCanvas", "type": "MethodDefinition", "paramnames": [ "renderer" ] }, "vars": { "": null } }, "description": "Renders the object using the Canvas renderer
", "params": [ { "type": { "names": [ "PIXI.CanvasRenderer" ] }, "description": "The renderer
", "name": "renderer" } ], "name": "renderCanvas", "longname": "PIXI.DisplayObject#renderCanvas", "kind": "function", "memberof": "PIXI.DisplayObject", "scope": "instance", "___id": "T000002R007507", "___s": true, "skip": true, "slug": "PIXI.DisplayObjectrenderCanvas", "filepath": "core\\display\\DisplayObject.js" }, { "comment": "/**\n * Set the parent Container of this DisplayObject\n *\n * @param {PIXI.Container} container - The Container to add this DisplayObject to\n * @return {PIXI.Container} The Container that this DisplayObject was added to\n */", "meta": { "range": [ 10720, 10953 ], "filename": "DisplayObject.js", "lineno": 350, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\display", "code": { "id": "astnode100080173", "name": "DisplayObject#setParent", "type": "MethodDefinition", "paramnames": [ "container" ] }, "vars": { "": null } }, "description": "Set the parent Container of this DisplayObject
", "params": [ { "type": { "names": [ "PIXI.Container" ] }, "description": "The Container to add this DisplayObject to
", "name": "container" } ], "returns": [ { "type": { "names": [ "PIXI.Container" ] }, "description": "The Container that this DisplayObject was added to
" } ], "name": "setParent", "longname": "PIXI.DisplayObject#setParent", "kind": "function", "memberof": "PIXI.DisplayObject", "scope": "instance", "___id": "T000002R007508", "___s": true, "skip": true, "slug": "PIXI.DisplayObjectsetParent", "filepath": "core\\display\\DisplayObject.js" }, { "comment": "/**\n * Convenience function to set the position, scale, skew and pivot at once.\n *\n * @param {number} [x=0] - The X position\n * @param {number} [y=0] - The Y position\n * @param {number} [scaleX=1] - The X scale value\n * @param {number} [scaleY=1] - The Y scale value\n * @param {number} [rotation=0] - The rotation\n * @param {number} [skewX=0] - The X skew value\n * @param {number} [skewY=0] - The Y skew value\n * @param {number} [pivotX=0] - The X pivot value\n * @param {number} [pivotY=0] - The Y pivot value\n * @return {PIXI.DisplayObject} The DisplayObject instance\n */", "meta": { "range": [ 11588, 12034 ], "filename": "DisplayObject.js", "lineno": 376, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\display", "code": { "id": "astnode100080199", "name": "DisplayObject#setTransform", "type": "MethodDefinition", "paramnames": [ "x", "y", "scaleX", "scaleY", "rotation", "skewX", "skewY", "pivotX", "pivotY" ] }, "vars": { "": null } }, "description": "Convenience function to set the position, scale, skew and pivot at once.
", "params": [ { "type": { "names": [ "number" ] }, "optional": true, "defaultvalue": 0, "description": "The X position
", "name": "x" }, { "type": { "names": [ "number" ] }, "optional": true, "defaultvalue": 0, "description": "The Y position
", "name": "y" }, { "type": { "names": [ "number" ] }, "optional": true, "defaultvalue": 1, "description": "The X scale value
", "name": "scaleX" }, { "type": { "names": [ "number" ] }, "optional": true, "defaultvalue": 1, "description": "The Y scale value
", "name": "scaleY" }, { "type": { "names": [ "number" ] }, "optional": true, "defaultvalue": 0, "description": "The rotation
", "name": "rotation" }, { "type": { "names": [ "number" ] }, "optional": true, "defaultvalue": 0, "description": "The X skew value
", "name": "skewX" }, { "type": { "names": [ "number" ] }, "optional": true, "defaultvalue": 0, "description": "The Y skew value
", "name": "skewY" }, { "type": { "names": [ "number" ] }, "optional": true, "defaultvalue": 0, "description": "The X pivot value
", "name": "pivotX" }, { "type": { "names": [ "number" ] }, "optional": true, "defaultvalue": 0, "description": "The Y pivot value
", "name": "pivotY" } ], "returns": [ { "type": { "names": [ "PIXI.DisplayObject" ] }, "description": "The DisplayObject instance
" } ], "name": "setTransform", "longname": "PIXI.DisplayObject#setTransform", "kind": "function", "memberof": "PIXI.DisplayObject", "scope": "instance", "___id": "T000002R007509", "___s": true, "skip": true, "slug": "PIXI.DisplayObjectsetTransform", "filepath": "core\\display\\DisplayObject.js" }, { "comment": "/**\n * Base destroy method for generic display objects. This will automatically\n * remove the display object from its parent Container as well as remove\n * all current event listeners and internal references. Do not use a DisplayObject\n * after calling `destroy`.\n *\n */", "meta": { "range": [ 12339, 12779 ], "filename": "DisplayObject.js", "lineno": 398, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\display", "code": { "id": "astnode100080310", "name": "DisplayObject#destroy", "type": "MethodDefinition", "paramnames": [] }, "vars": { "": null } }, "description": "Base destroy method for generic display objects. This will automatically
remove the display object from its parent Container as well as remove
all current event listeners and internal references. Do not use a DisplayObject
after calling destroy
.
The position of the displayObject on the x axis relative to the local coordinates of the parent.
An alias to position.x
The position of the displayObject on the y axis relative to the local coordinates of the parent.
An alias to position.y
Current transform of the object based on world (parent) factors
", "kind": "member", "type": { "names": [ "PIXI.Matrix" ] }, "readonly": true, "name": "worldTransform", "longname": "PIXI.DisplayObject#worldTransform", "memberof": "PIXI.DisplayObject", "scope": "instance", "params": [], "___id": "T000002R007535", "___s": true, "skip": true, "slug": "PIXI.DisplayObjectworldTransform", "filepath": "core\\display\\DisplayObject.js" }, { "comment": "/**\n * Current transform of the object based on local factors: position, scale, other stuff\n *\n * @member {PIXI.Matrix}\n * @readonly\n */", "meta": { "range": [ 13866, 13944 ], "filename": "DisplayObject.js", "lineno": 470, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\display", "code": { "id": "astnode100080446", "name": "DisplayObject#localTransform", "type": "MethodDefinition", "paramnames": [] }, "vars": { "": null } }, "description": "Current transform of the object based on local factors: position, scale, other stuff
", "kind": "member", "type": { "names": [ "PIXI.Matrix" ] }, "readonly": true, "name": "localTransform", "longname": "PIXI.DisplayObject#localTransform", "memberof": "PIXI.DisplayObject", "scope": "instance", "params": [], "___id": "T000002R007536", "___s": true, "skip": true, "slug": "PIXI.DisplayObjectlocalTransform", "filepath": "core\\display\\DisplayObject.js" }, { "comment": "/**\n * The coordinate of the object relative to the local coordinates of the parent.\n * Assignment by value since pixi-v4.\n *\n * @member {PIXI.Point|PIXI.ObservablePoint}\n */", "meta": { "range": [ 14149, 14215 ], "filename": "DisplayObject.js", "lineno": 481, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\display", "code": { "id": "astnode100080456", "name": "DisplayObject#position", "type": "MethodDefinition", "paramnames": [] }, "vars": { "": null } }, "description": "The coordinate of the object relative to the local coordinates of the parent.
Assignment by value since pixi-v4.
The scale factor of the object.
Assignment by value since pixi-v4.
The pivot point of the displayObject that it rotates around
Assignment by value since pixi-v4.
The skew factor for the object in radians.
Assignment by value since pixi-v4.
The rotation of the object in radians.
", "kind": "member", "type": { "names": [ "number" ] }, "name": "rotation", "longname": "PIXI.DisplayObject#rotation", "memberof": "PIXI.DisplayObject", "scope": "instance", "params": [], "___id": "T000002R007545", "___s": true, "skip": true, "slug": "PIXI.DisplayObjectrotation", "filepath": "core\\display\\DisplayObject.js" }, { "comment": "/**\n * Indicates if the object is globally visible.\n *\n * @member {boolean}\n * @readonly\n */", "meta": { "range": [ 15757, 16002 ], "filename": "DisplayObject.js", "lineno": 560, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\display", "code": { "id": "astnode100080579", "name": "DisplayObject#worldVisible", "type": "MethodDefinition", "paramnames": [] }, "vars": { "": null } }, "description": "Indicates if the object is globally visible.
", "kind": "member", "type": { "names": [ "boolean" ] }, "readonly": true, "name": "worldVisible", "longname": "PIXI.DisplayObject#worldVisible", "memberof": "PIXI.DisplayObject", "scope": "instance", "params": [], "___id": "T000002R007548", "___s": true, "skip": true, "slug": "PIXI.DisplayObjectworldVisible", "filepath": "core\\display\\DisplayObject.js" }, { "comment": "/**\n * Sets a mask for the displayObject. A mask is an object that limits the visibility of an\n * object to the shape of the mask applied to it. In PIXI a regular mask must be a\n * PIXI.Graphics or a PIXI.Sprite object. This allows for much faster masking in canvas as it\n * utilises shape clipping. To remove a mask, set this property to null.\n *\n * @todo For the moment, PIXI.CanvasRenderer doesn't support PIXI.Sprite as mask.\n *\n * @member {PIXI.Graphics|PIXI.Sprite}\n */", "meta": { "range": [ 16524, 16573 ], "filename": "DisplayObject.js", "lineno": 587, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\display", "code": { "id": "astnode100080606", "name": "DisplayObject#mask", "type": "MethodDefinition", "paramnames": [] }, "vars": { "": null } }, "description": "Sets a mask for the displayObject. A mask is an object that limits the visibility of an
object to the shape of the mask applied to it. In PIXI a regular mask must be a
PIXI.Graphics or a PIXI.Sprite object. This allows for much faster masking in canvas as it
utilises shape clipping. To remove a mask, set this property to null.
Sets the filters for the displayObject.
\nWorld transform and local transform of this object.
This will become read-only later, please do not assign anything there unless you know what are you doing
The opacity of the object.
", "kind": "member", "name": "alpha", "type": { "names": [ "number" ] }, "memberof": "PIXI.DisplayObject", "longname": "PIXI.DisplayObject#alpha", "scope": "instance", "___id": "T000002R000521", "___s": true, "skip": true, "slug": "PIXI.DisplayObjectalpha", "filepath": "core\\display\\DisplayObject.js" }, { "comment": "/**\n * The visibility of the object. If false the object will not be drawn, and\n * the updateTransform function will not be called.\n *\n * Only affects recursive calls from parent. You can ask for bounds or call updateTransform manually\n *\n * @member {boolean} PIXI.DisplayObject#visible\n */", "meta": { "range": [ 1439, 1785 ], "filename": "DisplayObject.js", "lineno": 50, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\display", "code": {} }, "description": "The visibility of the object. If false the object will not be drawn, and
the updateTransform function will not be called.
Only affects recursive calls from parent. You can ask for bounds or call updateTransform manually
", "kind": "member", "name": "visible", "type": { "names": [ "boolean" ] }, "memberof": "PIXI.DisplayObject", "longname": "PIXI.DisplayObject#visible", "scope": "instance", "___id": "T000002R000523", "___s": true, "skip": true, "slug": "PIXI.DisplayObjectvisible", "filepath": "core\\display\\DisplayObject.js" }, { "comment": "/**\n * Can this object be rendered, if false the object will not be drawn but the updateTransform\n * methods will still be called.\n *\n * Only affects recursive calls from parent. You can ask for bounds manually\n *\n * @member {boolean} PIXI.DisplayObject#renderable\n */", "meta": { "range": [ 1824, 2148 ], "filename": "DisplayObject.js", "lineno": 60, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\display", "code": {} }, "description": "Can this object be rendered, if false the object will not be drawn but the updateTransform
methods will still be called.
Only affects recursive calls from parent. You can ask for bounds manually
", "kind": "member", "name": "renderable", "type": { "names": [ "boolean" ] }, "memberof": "PIXI.DisplayObject", "longname": "PIXI.DisplayObject#renderable", "scope": "instance", "___id": "T000002R000525", "___s": true, "skip": true, "slug": "PIXI.DisplayObjectrenderable", "filepath": "core\\display\\DisplayObject.js" }, { "comment": "/**\n * The display object container that contains this display object.\n *\n * @member {PIXI.Container} PIXI.DisplayObject#parent\n * @readonly\n */", "meta": { "range": [ 2190, 2374 ], "filename": "DisplayObject.js", "lineno": 70, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\display", "code": {} }, "description": "The display object container that contains this display object.
", "kind": "member", "name": "parent", "type": { "names": [ "PIXI.Container" ] }, "readonly": true, "memberof": "PIXI.DisplayObject", "longname": "PIXI.DisplayObject#parent", "scope": "instance", "___id": "T000002R000527", "___s": true, "skip": true, "slug": "PIXI.DisplayObjectparent", "filepath": "core\\display\\DisplayObject.js" }, { "comment": "/**\n * The multiplied alpha of the displayObject\n *\n * @member {number} PIXI.DisplayObject#worldAlpha\n * @readonly\n */", "meta": { "range": [ 2412, 2570 ], "filename": "DisplayObject.js", "lineno": 78, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\display", "code": {} }, "description": "The multiplied alpha of the displayObject
", "kind": "member", "name": "worldAlpha", "type": { "names": [ "number" ] }, "readonly": true, "memberof": "PIXI.DisplayObject", "longname": "PIXI.DisplayObject#worldAlpha", "scope": "instance", "___id": "T000002R000529", "___s": true, "skip": true, "slug": "PIXI.DisplayObjectworldAlpha", "filepath": "core\\display\\DisplayObject.js" }, { "comment": "/**\n * The area the filter is applied to. This is used as more of an optimisation\n * rather than figuring out the dimensions of the displayObject each frame you can set this rectangle\n *\n * Also works as an interaction mask\n *\n * @member {PIXI.Rectangle} PIXI.DisplayObject#filterArea\n */", "meta": { "range": [ 2609, 2953 ], "filename": "DisplayObject.js", "lineno": 86, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\display", "code": {} }, "description": "The area the filter is applied to. This is used as more of an optimisation
rather than figuring out the dimensions of the displayObject each frame you can set this rectangle
Also works as an interaction mask
", "kind": "member", "name": "filterArea", "type": { "names": [ "PIXI.Rectangle" ] }, "memberof": "PIXI.DisplayObject", "longname": "PIXI.DisplayObject#filterArea", "scope": "instance", "___id": "T000002R000531", "___s": true, "skip": true, "slug": "PIXI.DisplayObjectfilterArea", "filepath": "core\\display\\DisplayObject.js" }, { "comment": "/**\n * The bounds object, this is used to calculate and store the bounds of the displayObject\n *\n * @member {PIXI.Rectangle} PIXI.DisplayObject#_bounds\n * @private\n */", "meta": { "range": [ 3063, 3270 ], "filename": "DisplayObject.js", "lineno": 99, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\display", "code": {} }, "description": "The bounds object, this is used to calculate and store the bounds of the displayObject
", "kind": "member", "name": "_bounds", "type": { "names": [ "PIXI.Rectangle" ] }, "access": "private", "memberof": "PIXI.DisplayObject", "longname": "PIXI.DisplayObject#_bounds", "scope": "instance", "___id": "T000002R000535", "___s": true, "skip": true, "slug": "PIXI.DisplayObject_bounds", "filepath": "core\\display\\DisplayObject.js" }, { "comment": "/**\n * The original, cached mask of the object\n *\n * @member {PIXI.Graphics|PIXI.Sprite} PIXI.DisplayObject#_mask\n * @private\n */", "meta": { "range": [ 3449, 3618 ], "filename": "DisplayObject.js", "lineno": 111, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\display", "code": {} }, "description": "The original, cached mask of the object
", "kind": "member", "name": "_mask", "type": { "names": [ "PIXI.Graphics", "PIXI.Sprite" ] }, "access": "private", "memberof": "PIXI.DisplayObject", "longname": "PIXI.DisplayObject#_mask", "scope": "instance", "___id": "T000002R000541", "___s": true, "skip": true, "slug": "PIXI.DisplayObject_mask", "filepath": "core\\display\\DisplayObject.js" }, { "comment": "/**\n * If the object has been destroyed via destroy(). If true, it should not be used.\n *\n * @member {boolean} PIXI.DisplayObject#_destroyed\n * @private\n * @readonly\n */", "meta": { "range": [ 3655, 3872 ], "filename": "DisplayObject.js", "lineno": 119, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\display", "code": {} }, "description": "If the object has been destroyed via destroy(). If true, it should not be used.
", "kind": "member", "name": "_destroyed", "type": { "names": [ "boolean" ] }, "access": "private", "readonly": true, "memberof": "PIXI.DisplayObject", "longname": "PIXI.DisplayObject#_destroyed", "scope": "instance", "___id": "T000002R000543", "___s": true, "skip": true, "slug": "PIXI.DisplayObject_destroyed", "filepath": "core\\display\\DisplayObject.js" }, { "comment": "/**\n * Set this to true if you want this display object to be cached as a bitmap.\n * This basically takes a snap shot of the display object as it is at that moment. It can\n * provide a performance benefit for complex static displayObjects.\n * To remove simply set this property to 'false'\n *\n * IMPORTANT GOTCHA - make sure that all your textures are preloaded BEFORE setting this property to true\n * as it will take a snapshot of what is currently there. If the textures have not loaded then they will not appear.\n *\n * @member {boolean}\n * @memberof PIXI.DisplayObject#\n */", "meta": { "range": [ 1587, 3623 ], "filename": "cacheAsBitmap.js", "lineno": 50, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\extras", "code": { "id": "astnode100053521", "name": "cacheAsBitmap", "type": "ObjectExpression", "value": "{\"get\":\"\",\"set\":\"\"}" } }, "description": "Set this to true if you want this display object to be cached as a bitmap.
This basically takes a snap shot of the display object as it is at that moment. It can
provide a performance benefit for complex static displayObjects.
To remove simply set this property to 'false'
IMPORTANT GOTCHA - make sure that all your textures are preloaded BEFORE setting this property to true
as it will take a snapshot of what is currently there. If the textures have not loaded then they will not appear.
World transform and local transform of this object.
This will become read-only later, please do not assign anything there unless you know what are you doing
The opacity of the object.
", "kind": "member", "name": "alpha", "type": { "names": [ "number" ] }, "memberof": "PIXI.DisplayObject", "longname": "PIXI.DisplayObject#alpha", "scope": "instance", "___id": "T000002R007455", "___s": true, "skip": true, "slug": "PIXI.DisplayObjectalpha", "filepath": "core\\display\\DisplayObject.js" }, { "comment": "/**\n * The visibility of the object. If false the object will not be drawn, and\n * the updateTransform function will not be called.\n *\n * Only affects recursive calls from parent. You can ask for bounds or call updateTransform manually\n *\n * @member {boolean} PIXI.DisplayObject#visible\n */", "meta": { "range": [ 1439, 1785 ], "filename": "DisplayObject.js", "lineno": 50, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\display", "code": {} }, "description": "The visibility of the object. If false the object will not be drawn, and
the updateTransform function will not be called.
Only affects recursive calls from parent. You can ask for bounds or call updateTransform manually
", "kind": "member", "name": "visible", "type": { "names": [ "boolean" ] }, "memberof": "PIXI.DisplayObject", "longname": "PIXI.DisplayObject#visible", "scope": "instance", "___id": "T000002R007457", "___s": true, "skip": true, "slug": "PIXI.DisplayObjectvisible", "filepath": "core\\display\\DisplayObject.js" }, { "comment": "/**\n * Can this object be rendered, if false the object will not be drawn but the updateTransform\n * methods will still be called.\n *\n * Only affects recursive calls from parent. You can ask for bounds manually\n *\n * @member {boolean} PIXI.DisplayObject#renderable\n */", "meta": { "range": [ 1824, 2148 ], "filename": "DisplayObject.js", "lineno": 60, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\display", "code": {} }, "description": "Can this object be rendered, if false the object will not be drawn but the updateTransform
methods will still be called.
Only affects recursive calls from parent. You can ask for bounds manually
", "kind": "member", "name": "renderable", "type": { "names": [ "boolean" ] }, "memberof": "PIXI.DisplayObject", "longname": "PIXI.DisplayObject#renderable", "scope": "instance", "___id": "T000002R007459", "___s": true, "skip": true, "slug": "PIXI.DisplayObjectrenderable", "filepath": "core\\display\\DisplayObject.js" }, { "comment": "/**\n * The display object container that contains this display object.\n *\n * @member {PIXI.Container} PIXI.DisplayObject#parent\n * @readonly\n */", "meta": { "range": [ 2190, 2374 ], "filename": "DisplayObject.js", "lineno": 70, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\display", "code": {} }, "description": "The display object container that contains this display object.
", "kind": "member", "name": "parent", "type": { "names": [ "PIXI.Container" ] }, "readonly": true, "memberof": "PIXI.DisplayObject", "longname": "PIXI.DisplayObject#parent", "scope": "instance", "___id": "T000002R007461", "___s": true, "skip": true, "slug": "PIXI.DisplayObjectparent", "filepath": "core\\display\\DisplayObject.js" }, { "comment": "/**\n * The multiplied alpha of the displayObject\n *\n * @member {number} PIXI.DisplayObject#worldAlpha\n * @readonly\n */", "meta": { "range": [ 2412, 2570 ], "filename": "DisplayObject.js", "lineno": 78, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\display", "code": {} }, "description": "The multiplied alpha of the displayObject
", "kind": "member", "name": "worldAlpha", "type": { "names": [ "number" ] }, "readonly": true, "memberof": "PIXI.DisplayObject", "longname": "PIXI.DisplayObject#worldAlpha", "scope": "instance", "___id": "T000002R007463", "___s": true, "skip": true, "slug": "PIXI.DisplayObjectworldAlpha", "filepath": "core\\display\\DisplayObject.js" }, { "comment": "/**\n * The area the filter is applied to. This is used as more of an optimisation\n * rather than figuring out the dimensions of the displayObject each frame you can set this rectangle\n *\n * Also works as an interaction mask\n *\n * @member {PIXI.Rectangle} PIXI.DisplayObject#filterArea\n */", "meta": { "range": [ 2609, 2953 ], "filename": "DisplayObject.js", "lineno": 86, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\display", "code": {} }, "description": "The area the filter is applied to. This is used as more of an optimisation
rather than figuring out the dimensions of the displayObject each frame you can set this rectangle
Also works as an interaction mask
", "kind": "member", "name": "filterArea", "type": { "names": [ "PIXI.Rectangle" ] }, "memberof": "PIXI.DisplayObject", "longname": "PIXI.DisplayObject#filterArea", "scope": "instance", "___id": "T000002R007465", "___s": true, "skip": true, "slug": "PIXI.DisplayObjectfilterArea", "filepath": "core\\display\\DisplayObject.js" }, { "comment": "/**\n * The bounds object, this is used to calculate and store the bounds of the displayObject\n *\n * @member {PIXI.Rectangle} PIXI.DisplayObject#_bounds\n * @private\n */", "meta": { "range": [ 3063, 3270 ], "filename": "DisplayObject.js", "lineno": 99, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\display", "code": {} }, "description": "The bounds object, this is used to calculate and store the bounds of the displayObject
", "kind": "member", "name": "_bounds", "type": { "names": [ "PIXI.Rectangle" ] }, "access": "private", "memberof": "PIXI.DisplayObject", "longname": "PIXI.DisplayObject#_bounds", "scope": "instance", "___id": "T000002R007469", "___s": true, "skip": true, "slug": "PIXI.DisplayObject_bounds", "filepath": "core\\display\\DisplayObject.js" }, { "comment": "/**\n * The original, cached mask of the object\n *\n * @member {PIXI.Graphics|PIXI.Sprite} PIXI.DisplayObject#_mask\n * @private\n */", "meta": { "range": [ 3449, 3618 ], "filename": "DisplayObject.js", "lineno": 111, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\display", "code": {} }, "description": "The original, cached mask of the object
", "kind": "member", "name": "_mask", "type": { "names": [ "PIXI.Graphics", "PIXI.Sprite" ] }, "access": "private", "memberof": "PIXI.DisplayObject", "longname": "PIXI.DisplayObject#_mask", "scope": "instance", "___id": "T000002R007475", "___s": true, "skip": true, "slug": "PIXI.DisplayObject_mask", "filepath": "core\\display\\DisplayObject.js" }, { "comment": "/**\n * If the object has been destroyed via destroy(). If true, it should not be used.\n *\n * @member {boolean} PIXI.DisplayObject#_destroyed\n * @private\n * @readonly\n */", "meta": { "range": [ 3655, 3872 ], "filename": "DisplayObject.js", "lineno": 119, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\display", "code": {} }, "description": "If the object has been destroyed via destroy(). If true, it should not be used.
", "kind": "member", "name": "_destroyed", "type": { "names": [ "boolean" ] }, "access": "private", "readonly": true, "memberof": "PIXI.DisplayObject", "longname": "PIXI.DisplayObject#_destroyed", "scope": "instance", "___id": "T000002R007477", "___s": true, "skip": true, "slug": "PIXI.DisplayObject_destroyed", "filepath": "core\\display\\DisplayObject.js" }, { "comment": "/**\n * Set this to true if you want this display object to be cached as a bitmap.\n * This basically takes a snap shot of the display object as it is at that moment. It can\n * provide a performance benefit for complex static displayObjects.\n * To remove simply set this property to 'false'\n *\n * IMPORTANT GOTCHA - make sure that all your textures are preloaded BEFORE setting this property to true\n * as it will take a snapshot of what is currently there. If the textures have not loaded then they will not appear.\n *\n * @member {boolean}\n * @memberof PIXI.DisplayObject#\n */", "meta": { "range": [ 1587, 3623 ], "filename": "cacheAsBitmap.js", "lineno": 50, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\extras", "code": { "id": "astnode100128200", "name": "cacheAsBitmap", "type": "ObjectExpression", "value": "{\"get\":\"\",\"set\":\"\"}" } }, "description": "Set this to true if you want this display object to be cached as a bitmap.
This basically takes a snap shot of the display object as it is at that moment. It can
provide a performance benefit for complex static displayObjects.
To remove simply set this property to 'false'
IMPORTANT GOTCHA - make sure that all your textures are preloaded BEFORE setting this property to true
as it will take a snapshot of what is currently there. If the textures have not loaded then they will not appear.