403 lines
12 KiB
HTML
403 lines
12 KiB
HTML
<!DOCTYPE html>
|
|
<html lang="en">
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<title>src/pixi/display/DisplayObjectContainer.js - Pixi.JS</title>
|
|
<link rel="stylesheet" href="http://yui.yahooapis.com/3.8.0/build/cssgrids/cssgrids-min.css">
|
|
<link rel="stylesheet" href="../assets/vendor/prettify/prettify-min.css">
|
|
<link rel="stylesheet" href="../assets/css/main.css" id="site_styles">
|
|
<link rel="shortcut icon" type="image/png" href="../assets/favicon.png">
|
|
<script src="http://yui.yahooapis.com/combo?3.8.0/build/yui/yui-min.js"></script>
|
|
</head>
|
|
<body class="yui3-skin-sam">
|
|
|
|
<div id="doc">
|
|
<div id="hd" class="yui3-g header">
|
|
<div class="yui3-u-3-4">
|
|
|
|
<h1><img src="http://www.goodboydigital.com/pixijs/logo_small.png" title="Pixi.JS"></h1>
|
|
|
|
</div>
|
|
<div class="yui3-u-1-4 version">
|
|
<em>API Docs for: 1.3.0</em>
|
|
</div>
|
|
</div>
|
|
<div id="bd" class="yui3-g">
|
|
|
|
<div class="yui3-u-1-4">
|
|
<div id="docs-sidebar" class="sidebar apidocs">
|
|
<div id="api-list">
|
|
<h2 class="off-left">APIs</h2>
|
|
<div id="api-tabview" class="tabview">
|
|
<ul class="tabs">
|
|
<li><a href="#api-classes">Classes</a></li>
|
|
<li><a href="#api-modules">Modules</a></li>
|
|
</ul>
|
|
|
|
<div id="api-tabview-filter">
|
|
<input type="search" id="api-filter" placeholder="Type to filter APIs">
|
|
</div>
|
|
|
|
<div id="api-tabview-panel">
|
|
<ul id="api-classes" class="apis classes">
|
|
|
|
<li><a href="../classes/AssetLoader.html">AssetLoader</a></li>
|
|
|
|
<li><a href="../classes/BaseTexture.html">BaseTexture</a></li>
|
|
|
|
<li><a href="../classes/BitmapFontLoader.html">BitmapFontLoader</a></li>
|
|
|
|
<li><a href="../classes/BitmapText.html">BitmapText</a></li>
|
|
|
|
<li><a href="../classes/CanvasGraphics.html">CanvasGraphics</a></li>
|
|
|
|
<li><a href="../classes/CanvasRenderer.html">CanvasRenderer</a></li>
|
|
|
|
<li><a href="../classes/CustomRenderable.html">CustomRenderable</a></li>
|
|
|
|
<li><a href="../classes/DisplayObject.html">DisplayObject</a></li>
|
|
|
|
<li><a href="../classes/DisplayObjectContainer.html">DisplayObjectContainer</a></li>
|
|
|
|
<li><a href="../classes/Graphics.html">Graphics</a></li>
|
|
|
|
<li><a href="../classes/ImageLoader.html">ImageLoader</a></li>
|
|
|
|
<li><a href="../classes/InteractionData.html">InteractionData</a></li>
|
|
|
|
<li><a href="../classes/InteractionManager.html">InteractionManager</a></li>
|
|
|
|
<li><a href="../classes/JsonLoader.html">JsonLoader</a></li>
|
|
|
|
<li><a href="../classes/MovieClip.html">MovieClip</a></li>
|
|
|
|
<li><a href="../classes/Point.html">Point</a></li>
|
|
|
|
<li><a href="../classes/Polygon.html">Polygon</a></li>
|
|
|
|
<li><a href="../classes/Rectangle.html">Rectangle</a></li>
|
|
|
|
<li><a href="../classes/RenderTexture.html">RenderTexture</a></li>
|
|
|
|
<li><a href="../classes/Spine.html">Spine</a></li>
|
|
|
|
<li><a href="../classes/Sprite.html">Sprite</a></li>
|
|
|
|
<li><a href="../classes/SpriteSheetLoader.html">SpriteSheetLoader</a></li>
|
|
|
|
<li><a href="../classes/Stage.html">Stage</a></li>
|
|
|
|
<li><a href="../classes/Text.html">Text</a></li>
|
|
|
|
<li><a href="../classes/Texture.html">Texture</a></li>
|
|
|
|
<li><a href="../classes/TilingSprite.html">TilingSprite</a></li>
|
|
|
|
<li><a href="../classes/WebGLBatch.html">WebGLBatch</a></li>
|
|
|
|
<li><a href="../classes/WebGLRenderer.html">WebGLRenderer</a></li>
|
|
|
|
</ul>
|
|
|
|
<ul id="api-modules" class="apis modules">
|
|
|
|
<li><a href="../modules/PIXI.html">PIXI</a></li>
|
|
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="yui3-u-3-4">
|
|
<div id="api-options">
|
|
Show:
|
|
<label for="api-show-inherited">
|
|
<input type="checkbox" id="api-show-inherited" checked>
|
|
Inherited
|
|
</label>
|
|
|
|
<label for="api-show-protected">
|
|
<input type="checkbox" id="api-show-protected">
|
|
Protected
|
|
</label>
|
|
|
|
<label for="api-show-private">
|
|
<input type="checkbox" id="api-show-private">
|
|
Private
|
|
</label>
|
|
<label for="api-show-deprecated">
|
|
<input type="checkbox" id="api-show-deprecated">
|
|
Deprecated
|
|
</label>
|
|
|
|
</div>
|
|
|
|
|
|
<div class="apidocs">
|
|
<div id="docs-main">
|
|
<div class="content">
|
|
<h1 class="file-heading">File: src/pixi/display/DisplayObjectContainer.js</h1>
|
|
|
|
<div class="file">
|
|
<pre class="code prettyprint linenums">
|
|
/**
|
|
* @author Mat Groves http://matgroves.com/ @Doormat23
|
|
*/
|
|
|
|
|
|
/**
|
|
* A DisplayObjectContainer represents a collection of display objects. It is the base class of all display objects that act as a container for other objects.
|
|
* @class DisplayObjectContainer
|
|
* @extends DisplayObject
|
|
* @constructor
|
|
*/
|
|
PIXI.DisplayObjectContainer = function()
|
|
{
|
|
PIXI.DisplayObject.call( this );
|
|
|
|
/**
|
|
* [read-only] The of children of this container.
|
|
* @property children {Array}
|
|
*/
|
|
this.children = [];
|
|
//s
|
|
this.renderable = false;
|
|
}
|
|
|
|
// constructor
|
|
PIXI.DisplayObjectContainer.constructor = PIXI.DisplayObjectContainer;
|
|
PIXI.DisplayObjectContainer.prototype = Object.create( PIXI.DisplayObject.prototype );
|
|
|
|
//TODO make visible a getter setter
|
|
/*
|
|
Object.defineProperty(PIXI.DisplayObjectContainer.prototype, 'visible', {
|
|
get: function() {
|
|
return this._visible;
|
|
},
|
|
set: function(value) {
|
|
this._visible = value;
|
|
|
|
}
|
|
});*/
|
|
|
|
/**
|
|
* Adds a child to the container.
|
|
* @method addChild
|
|
* @param DisplayObject {DisplayObject}
|
|
*/
|
|
PIXI.DisplayObjectContainer.prototype.addChild = function(child)
|
|
{
|
|
if(child.parent != undefined)
|
|
{
|
|
child.parent.removeChild(child);
|
|
}
|
|
|
|
child.parent = this;
|
|
child.childIndex = this.children.length;
|
|
|
|
this.children.push(child);
|
|
|
|
if(this.stage)
|
|
{
|
|
this.stage.__addChild(child);
|
|
}
|
|
|
|
// need to remove any render groups..
|
|
if(this.__renderGroup)
|
|
{
|
|
// being used by a renderTexture.. if it exists then it must be from a render texture;
|
|
if(child.__renderGroup)child.__renderGroup.removeDisplayObjectAndChildren(child);
|
|
// add them to the new render group..
|
|
this.__renderGroup.addDisplayObjectAndChildren(child);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Adds a child to the container at a specified index. If the index is out of bounds an error will be thrown
|
|
* @method addChildAt
|
|
* @param DisplayObject {DisplayObject}
|
|
* @param index {Number}
|
|
*/
|
|
PIXI.DisplayObjectContainer.prototype.addChildAt = function(child, index)
|
|
{
|
|
if(index >= 0 && index <= this.children.length)
|
|
{
|
|
if(child.parent != undefined)
|
|
{
|
|
child.parent.removeChild(child);
|
|
}
|
|
|
|
if (index == this.children.length)
|
|
{
|
|
this.children.push(child);
|
|
}
|
|
else
|
|
{
|
|
this.children.splice(index, 0, child);
|
|
}
|
|
|
|
child.parent = this;
|
|
child.childIndex = index;
|
|
|
|
var length = this.children.length;
|
|
for (var i=index; i < length; i++)
|
|
{
|
|
this.children[i].childIndex = i;
|
|
}
|
|
|
|
if(this.stage)
|
|
{
|
|
this.stage.__addChild(child);
|
|
}
|
|
|
|
// need to remove any render groups..
|
|
if(this.__renderGroup)
|
|
{
|
|
// being used by a renderTexture.. if it exists then it must be from a render texture;
|
|
if(child.__renderGroup)child.__renderGroup.removeDisplayObjectAndChildren(child);
|
|
// add them to the new render group..
|
|
this.__renderGroup.addDisplayObjectAndChildren(child);
|
|
}
|
|
}
|
|
else
|
|
{
|
|
// error!
|
|
|
|
throw new Error(child + " The index "+ index +" supplied is out of bounds " + this.children.length);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Swaps the depth of 2 displayObjects
|
|
* @method swapChildren
|
|
* @param DisplayObject {DisplayObject}
|
|
* @param DisplayObject2 {DisplayObject}
|
|
*/
|
|
PIXI.DisplayObjectContainer.prototype.swapChildren = function(child, child2)
|
|
{
|
|
// TODO I already know this??
|
|
var index = this.children.indexOf( child );
|
|
var index2 = this.children.indexOf( child2 );
|
|
|
|
if ( index !== -1 && index2 !== -1 )
|
|
{
|
|
// cool
|
|
if(this.stage)
|
|
{
|
|
// this is to satisfy the webGL batching..
|
|
// TODO sure there is a nicer way to achieve this!
|
|
this.stage.__removeChild(child);
|
|
this.stage.__removeChild(child2);
|
|
|
|
this.stage.__addChild(child);
|
|
this.stage.__addChild(child2);
|
|
}
|
|
|
|
// swap the indexes..
|
|
child.childIndex = index2;
|
|
child2.childIndex = index;
|
|
// swap the positions..
|
|
this.children[index] = child2;
|
|
this.children[index2] = child;
|
|
|
|
}
|
|
else
|
|
{
|
|
throw new Error(child + " Both the supplied DisplayObjects must be a child of the caller " + this);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Returns the Child at the specified index
|
|
* @method getChildAt
|
|
* @param index {Number}
|
|
*/
|
|
PIXI.DisplayObjectContainer.prototype.getChildAt = function(index)
|
|
{
|
|
if(index >= 0 && index < this.children.length)
|
|
{
|
|
return this.children[index];
|
|
}
|
|
else
|
|
{
|
|
throw new Error(child + " Both the supplied DisplayObjects must be a child of the caller " + this);
|
|
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Removes a child from the container.
|
|
* @method removeChild
|
|
* @param DisplayObject {DisplayObject}
|
|
*/
|
|
PIXI.DisplayObjectContainer.prototype.removeChild = function(child)
|
|
{
|
|
var index = this.children.indexOf( child );
|
|
|
|
if ( index !== -1 )
|
|
{
|
|
if(this.stage)
|
|
{
|
|
this.stage.__removeChild(child);
|
|
}
|
|
|
|
// webGL trim
|
|
if(child.__renderGroup)
|
|
{
|
|
child.__renderGroup.removeDisplayObjectAndChildren(child);
|
|
}
|
|
|
|
// console.log(">" + child.__renderGroup)
|
|
child.parent = undefined;
|
|
|
|
this.children.splice( index, 1 );
|
|
|
|
// update in dexs!
|
|
for(var i=index,j=this.children.length; i<j; i++)
|
|
{
|
|
this.children[i].childIndex -= 1;
|
|
}
|
|
}
|
|
else
|
|
{
|
|
throw new Error(child + " The supplied DisplayObject must be a child of the caller " + this);
|
|
}
|
|
}
|
|
|
|
|
|
/**
|
|
* @private
|
|
*/
|
|
PIXI.DisplayObjectContainer.prototype.updateTransform = function()
|
|
{
|
|
if(!this.visible)return;
|
|
|
|
PIXI.DisplayObject.prototype.updateTransform.call( this );
|
|
|
|
for(var i=0,j=this.children.length; i<j; i++)
|
|
{
|
|
this.children[i].updateTransform();
|
|
}
|
|
}
|
|
|
|
</pre>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<script src="../assets/vendor/prettify/prettify-min.js"></script>
|
|
<script>prettyPrint();</script>
|
|
<script src="../assets/js/yui-prettify.js"></script>
|
|
<script src="../assets/../api.js"></script>
|
|
<script src="../assets/js/api-filter.js"></script>
|
|
<script src="../assets/js/api-list.js"></script>
|
|
<script src="../assets/js/api-search.js"></script>
|
|
<script src="../assets/js/apidocs.js"></script>
|
|
</body>
|
|
</html>
|