pixi.js/docs/classes/Stage.html
2013-02-20 19:05:51 +00:00

1144 lines
24 KiB
HTML

<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>Stage - The Foo API</title>
<link rel="stylesheet" href="http:&#x2F;&#x2F;yui.yahooapis.com&#x2F;3.8.0pr2&#x2F;build&#x2F;cssgrids&#x2F;cssgrids-min.css">
<link rel="stylesheet" href="..&#x2F;assets/vendor/prettify/prettify-min.css">
<link rel="stylesheet" href="..&#x2F;assets/css/main.css" id="site_styles">
<link rel="shortcut icon" type="image/png" href="..&#x2F;assets/favicon.png">
<script src="http:&#x2F;&#x2F;yui.yahooapis.com&#x2F;combo?3.8.0pr2&#x2F;build&#x2F;yui&#x2F;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="..&#x2F;assets/css/logo.png" title="The Foo API"></h1>
</div>
<div class="yui3-u-1-4 version">
<em>API Docs for: 1.2.1</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="..&#x2F;classes/AssetLoader.html">AssetLoader</a></li>
<li><a href="..&#x2F;classes/BaseTexture.html">BaseTexture</a></li>
<li><a href="..&#x2F;classes/CanvasRenderer.html">CanvasRenderer</a></li>
<li><a href="..&#x2F;classes/DisplayObject.html">DisplayObject</a></li>
<li><a href="..&#x2F;classes/DisplayObjectContainer.html">DisplayObjectContainer</a></li>
<li><a href="..&#x2F;classes/MovieClip.html">MovieClip</a></li>
<li><a href="..&#x2F;classes/Point.html">Point</a></li>
<li><a href="..&#x2F;classes/Rectangle.html">Rectangle</a></li>
<li><a href="..&#x2F;classes/Sprite.html">Sprite</a></li>
<li><a href="..&#x2F;classes/SpriteSheetLoader.html">SpriteSheetLoader</a></li>
<li><a href="..&#x2F;classes/Stage.html">Stage</a></li>
<li><a href="..&#x2F;classes/Texture.html">Texture</a></li>
<li><a href="..&#x2F;classes/WebGLBatch.html">WebGLBatch</a></li>
<li><a href="..&#x2F;classes/WebGLRenderer.html">WebGLRenderer</a></li>
</ul>
<ul id="api-modules" class="apis modules">
<li><a href="..&#x2F;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>Stage Class</h1>
<div class="box meta">
<div class="extends">
Extends <a href="../classes/DisplayObjectContainer.html" class="crosslink">DisplayObjectContainer</a>
</div>
<div class="foundat">
Defined in: <a href="..&#x2F;files&#x2F;pixi_Stage.js.html#l5"><code>pixi&#x2F;Stage.js:5</code></a>
</div>
Module: <a href="../modules/PIXI.html">PIXI</a>
</div>
<div class="box intro">
<p>A Stage represents the root of the display tree. Everything connected to the stage is rendered</p>
</div>
<div class="constructor">
<h2>Constructor</h2>
<div id="method_Stage" class="method item">
<h3 class="name"><code>Stage</code></h3>
<span class="paren">()</span>
<div class="meta">
<p>
Defined in
<a href="..&#x2F;files&#x2F;pixi_Stage.js.html#l5"><code>pixi&#x2F;Stage.js:5</code></a>
</p>
</div>
<div class="description">
</div>
</div>
</div>
<div id="classdocs" class="tabview">
<ul class="api-class-tabs">
<li class="api-class-tab index"><a href="#index">Index</a></li>
<li class="api-class-tab methods"><a href="#methods">Methods</a></li>
<li class="api-class-tab properties"><a href="#properties">Properties</a></li>
</ul>
<div>
<div id="index" class="api-class-tabpanel index">
<h2 class="off-left">Item Index</h2>
<div class="index-section methods">
<h3>Methods</h3>
<ul class="index-list methods extends">
<li class="index-item method">
<a href="#method___addChild">__addChild</a>
</li>
<li class="index-item method">
<a href="#method___removeChild">__removeChild</a>
</li>
<li class="index-item method inherited">
<a href="#method_addChild">addChild</a>
</li>
<li class="index-item method inherited">
<a href="#method_addChildAt">addChildAt</a>
</li>
<li class="index-item method inherited">
<a href="#method_removeChild">removeChild</a>
</li>
<li class="index-item method">
<a href="#method_updateTransform">updateTransform</a>
</li>
</ul>
</div>
<div class="index-section properties">
<h3>Properties</h3>
<ul class="index-list properties extends">
<li class="index-item property inherited">
<a href="#property_alpha">alpha</a>
</li>
<li class="index-item property inherited">
<a href="#property_children">children</a>
</li>
<li class="index-item property inherited">
<a href="#property_parent">parent</a>
</li>
<li class="index-item property inherited">
<a href="#property_position">position</a>
</li>
<li class="index-item property inherited">
<a href="#property_rotation">rotation</a>
</li>
<li class="index-item property inherited">
<a href="#property_scale">scale</a>
</li>
<li class="index-item property inherited">
<a href="#property_stage">stage</a>
</li>
<li class="index-item property inherited">
<a href="#property_visible">visible</a>
</li>
</ul>
</div>
</div>
<div id="methods" class="api-class-tabpanel">
<h2 class="off-left">Methods</h2>
<div id="method___addChild" class="method item">
<h3 class="name"><code>__addChild</code></h3>
<span class="paren">()</span>
<div class="meta">
<p>
Defined in
<a href="..&#x2F;files&#x2F;pixi_Stage.js.html#l44"><code>pixi&#x2F;Stage.js:44</code></a>
</p>
</div>
<div class="description">
</div>
</div>
<div id="method___removeChild" class="method item">
<h3 class="name"><code>__removeChild</code></h3>
<span class="paren">()</span>
<div class="meta">
<p>
Defined in
<a href="..&#x2F;files&#x2F;pixi_Stage.js.html#l63"><code>pixi&#x2F;Stage.js:63</code></a>
</p>
</div>
<div class="description">
</div>
</div>
<div id="method_addChild" class="method item inherited">
<h3 class="name"><code>addChild</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>DisplayObject</code>
</li>
</ul><span class="paren">)</span>
</div>
<div class="meta">
<p>Inherited from
<a href="..&#x2F;classes&#x2F;DisplayObjectContainer.html#method_addChild">DisplayObjectContainer</a>:
<a href="..&#x2F;files&#x2F;pixi_DisplayObjectContainer.js.html#l29"><code>pixi&#x2F;DisplayObjectContainer.js:29</code></a>
</p>
</div>
<div class="description">
<p>Adds a child to the container.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">DisplayObject</code>
<span class="type"><a href="../classes/DisplayObject.html" class="crosslink">DisplayObject</a></span>
<div class="param-description">
</div>
</li>
</ul>
</div>
</div>
<div id="method_addChildAt" class="method item inherited">
<h3 class="name"><code>addChildAt</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>DisplayObject</code>
</li>
<li class="arg">
<code>index</code>
</li>
</ul><span class="paren">)</span>
</div>
<div class="meta">
<p>Inherited from
<a href="..&#x2F;classes&#x2F;DisplayObjectContainer.html#method_addChildAt">DisplayObjectContainer</a>:
<a href="..&#x2F;files&#x2F;pixi_DisplayObjectContainer.js.html#l51"><code>pixi&#x2F;DisplayObjectContainer.js:51</code></a>
</p>
</div>
<div class="description">
<p>Adds a child to the container at a specified index. If the index is out of bounds an error will be thrown</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">DisplayObject</code>
<span class="type"><a href="../classes/DisplayObject.html" class="crosslink">DisplayObject</a></span>
<div class="param-description">
</div>
</li>
<li class="param">
<code class="param-name">index</code>
<span class="type">Number</span>
<div class="param-description">
</div>
</li>
</ul>
</div>
</div>
<div id="method_removeChild" class="method item inherited">
<h3 class="name"><code>removeChild</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>DisplayObject</code>
</li>
</ul><span class="paren">)</span>
</div>
<div class="meta">
<p>Inherited from
<a href="..&#x2F;classes&#x2F;DisplayObjectContainer.html#method_removeChild">DisplayObjectContainer</a>:
<a href="..&#x2F;files&#x2F;pixi_DisplayObjectContainer.js.html#l97"><code>pixi&#x2F;DisplayObjectContainer.js:97</code></a>
</p>
</div>
<div class="description">
<p>Removes a child from the container.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">DisplayObject</code>
<span class="type"><a href="../classes/DisplayObject.html" class="crosslink">DisplayObject</a></span>
<div class="param-description">
</div>
</li>
</ul>
</div>
</div>
<div id="method_updateTransform" class="method item">
<h3 class="name"><code>updateTransform</code></h3>
<span class="paren">()</span>
<div class="meta">
<p>
Defined in
<a href="..&#x2F;files&#x2F;pixi_Stage.js.html#l26"><code>pixi&#x2F;Stage.js:26</code></a>
</p>
</div>
<div class="description">
</div>
</div>
</div>
<div id="properties" class="api-class-tabpanel">
<h2 class="off-left">Properties</h2>
<div id="property_alpha" class="property item inherited">
<h3 class="name"><code>alpha</code></h3>
<span class="type">Number</span>
<div class="meta">
<p>Inherited from
<a href="..&#x2F;classes&#x2F;DisplayObject.html#property_alpha">DisplayObject</a>:
<a href="..&#x2F;files&#x2F;pixi_DisplayObject.js.html#l33"><code>pixi&#x2F;DisplayObject.js:33</code></a>
</p>
</div>
<div class="description">
<p>The opacity of the object.</p>
</div>
</div>
<div id="property_children" class="property item inherited">
<h3 class="name"><code>children</code></h3>
<span class="type">Array</span>
<div class="meta">
<p>Inherited from
<a href="..&#x2F;classes&#x2F;DisplayObjectContainer.html#property_children">DisplayObjectContainer</a>:
<a href="..&#x2F;files&#x2F;pixi_DisplayObjectContainer.js.html#l16"><code>pixi&#x2F;DisplayObjectContainer.js:16</code></a>
</p>
</div>
<div class="description">
<p>[read-only] The of children of this container.</p>
</div>
</div>
<div id="property_parent" class="property item inherited">
<h3 class="name"><code>parent</code></h3>
<span class="type"><a href="../classes/DisplayObjectContainer.html" class="crosslink">DisplayObjectContainer</a></span>
<div class="meta">
<p>Inherited from
<a href="..&#x2F;classes&#x2F;DisplayObject.html#property_parent">DisplayObject</a>:
<a href="..&#x2F;files&#x2F;pixi_DisplayObject.js.html#l48"><code>pixi&#x2F;DisplayObject.js:48</code></a>
</p>
</div>
<div class="description">
<p>[read-only] The display object container that contains this display object.</p>
</div>
</div>
<div id="property_position" class="property item inherited">
<h3 class="name"><code>position</code></h3>
<span class="type"><a href="../classes/Point.html" class="crosslink">Point</a></span>
<div class="meta">
<p>Inherited from
<a href="..&#x2F;classes&#x2F;DisplayObject.html#property_position">DisplayObject</a>:
<a href="..&#x2F;files&#x2F;pixi_DisplayObject.js.html#l12"><code>pixi&#x2F;DisplayObject.js:12</code></a>
</p>
</div>
<div class="description">
<p>The coordinate of the object relative to the local coordinates of the parent.</p>
</div>
</div>
<div id="property_rotation" class="property item inherited">
<h3 class="name"><code>rotation</code></h3>
<span class="type">Number</span>
<div class="meta">
<p>Inherited from
<a href="..&#x2F;classes&#x2F;DisplayObject.html#property_rotation">DisplayObject</a>:
<a href="..&#x2F;files&#x2F;pixi_DisplayObject.js.html#l26"><code>pixi&#x2F;DisplayObject.js:26</code></a>
</p>
</div>
<div class="description">
<p>The rotation of the object in radians.</p>
</div>
</div>
<div id="property_scale" class="property item inherited">
<h3 class="name"><code>scale</code></h3>
<span class="type"><a href="../classes/Point.html" class="crosslink">Point</a></span>
<div class="meta">
<p>Inherited from
<a href="..&#x2F;classes&#x2F;DisplayObject.html#property_scale">DisplayObject</a>:
<a href="..&#x2F;files&#x2F;pixi_DisplayObject.js.html#l19"><code>pixi&#x2F;DisplayObject.js:19</code></a>
</p>
</div>
<div class="description">
<p>The scale factor of the object.</p>
</div>
</div>
<div id="property_stage" class="property item inherited">
<h3 class="name"><code>stage</code></h3>
<span class="type"><a href="../classes/Stage.html" class="crosslink">Stage</a></span>
<div class="meta">
<p>Inherited from
<a href="..&#x2F;classes&#x2F;DisplayObject.html#property_stage">DisplayObject</a>:
<a href="..&#x2F;files&#x2F;pixi_DisplayObject.js.html#l55"><code>pixi&#x2F;DisplayObject.js:55</code></a>
</p>
</div>
<div class="description">
<p>[read-only] The stage the display object is connected to, or undefined if it is not connected to the stage.</p>
</div>
</div>
<div id="property_visible" class="property item inherited">
<h3 class="name"><code>visible</code></h3>
<span class="type">Boolean</span>
<div class="meta">
<p>Inherited from
<a href="..&#x2F;classes&#x2F;DisplayObject.html#property_visible">DisplayObject</a>:
<a href="..&#x2F;files&#x2F;pixi_DisplayObject.js.html#l40"><code>pixi&#x2F;DisplayObject.js:40</code></a>
</p>
</div>
<div class="description">
<p>The visibility of the object.</p>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
<script src="..&#x2F;assets/vendor/prettify/prettify-min.js"></script>
<script>prettyPrint();</script>
<script src="..&#x2F;assets/js/yui-prettify.js"></script>
<script src="..&#x2F;assets/../api.js"></script>
<script src="..&#x2F;assets/js/api-filter.js"></script>
<script src="..&#x2F;assets/js/api-list.js"></script>
<script src="..&#x2F;assets/js/api-search.js"></script>
<script src="..&#x2F;assets/js/apidocs.js"></script>
</body>
</html>