topical media & game development

talk show tell print

mobile-query-three-docs-symbols-tQuery.htm / htm



  
  <!DOCTYPE html>
  <html lang="en">
          <head>
                  <meta charset="utf-8" />
                  <meta name="generator" content="JsDoc Toolkit" />
                  <title>tQuery | tQuery library</title>
  
                  <meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1.0" />
                  <meta name="mobileoptimized" content="0" />
          
                  <link rel="stylesheet" href="../css/all.css" media="all" />
                  <link rel="stylesheet" href="../css/handheld.css" media="only screen and (max-width: 660px)" />
                  <link rel="stylesheet" href="../css/handheld.css" media="handheld" />
                  <link rel="stylesheet" href="../css/screen.css" media="screen and (min-width: 661px)" />
  
                  <script src="../javascript/all.js"></script>
                  <!--[if lt IE 9]>
                          <script src="../javascript/html5.js"></script>
                  <![endif]-->
          </head>
  
          <body>
  
  <div class="index">
          <div class="menu">
                  <div class="indexLinks">
                          <a href="../index.html">Classes</a>
                          <a href="../files.html">Files</a>
                  </div>
          
                  <h2 class="heading1">Classes</h2>
                  
                  <input type="text" name="classFilter" class="classFilter" id="ClassFilter" placeholder="Filter"></input>
                  
                  <nav>
                          <ul class="classList" id="ClassList">
                                  
                                          <li><a href="../symbols/tQuery.html">tQuery</a></li>
                                  
                                          <li><a href="../symbols/tQuery.Animation.html">tQuery<span class='break'> </span>.<span class='break'> </span>Animation</a></li>
                                  
                                          <li><a href="../symbols/tQuery.Animations.html">tQuery<span class='break'> </span>.<span class='break'> </span>Animations</a></li>
                                  
                                          <li><a href="../symbols/tQuery.createAnimations.html">tQuery<span class='break'> </span>.<span class='break'> </span>createAnimations</a></li>
                                  
                                          <li><a href="../symbols/tQuery.Geometry.html">tQuery<span class='break'> </span>.<span class='break'> </span>Geometry</a></li>
                                  
                                          <li><a href="../symbols/tQuery.Light.html">tQuery<span class='break'> </span>.<span class='break'> </span>Light</a></li>
                                  
                                          <li><a href="../symbols/tQuery.Loop.html">tQuery<span class='break'> </span>.<span class='break'> </span>Loop</a></li>
                                  
                                          <li><a href="../symbols/tQuery.Material.html">tQuery<span class='break'> </span>.<span class='break'> </span>Material</a></li>
                                  
                                          <li><a href="../symbols/tQuery.MD2Character.html">tQuery<span class='break'> </span>.<span class='break'> </span>MD2Character</a></li>
                                  
                                          <li><a href="../symbols/tQuery.Mesh.html">tQuery<span class='break'> </span>.<span class='break'> </span>Mesh</a></li>
                                  
                                          <li><a href="../symbols/tQuery.Node.html">tQuery<span class='break'> </span>.<span class='break'> </span>Node</a></li>
                                  
                                          <li><a href="../symbols/tQuery.Object3D.html">tQuery<span class='break'> </span>.<span class='break'> </span>Object3D</a></li>
                                  
                                          <li><a href="../symbols/tQuery.RatamahattaMD2Character.html">tQuery<span class='break'> </span>.<span class='break'> </span>RatamahattaMD2Character</a></li>
                                  
                                          <li><a href="../symbols/tQuery.Spritesheet.html">tQuery<span class='break'> </span>.<span class='break'> </span>Spritesheet</a></li>
                                  
                                          <li><a href="../symbols/tQuery.World.html">tQuery<span class='break'> </span>.<span class='break'> </span>World</a></li>
                                  
                          </ul>
                  </nav>
          </div>
          <div class="fineprint" style="clear:both">
                  <footer>
                          
                          Documentation generator: <a href="http://code.google.com/p/jsdoc-toolkit/" target="_blank">JsDoc Toolkit</a> 2.4.0<br />
                          Template: <a href="http://www.thebrightlines.com/2010/05/06/new-template-for-jsdoctoolkit-codeview/" target="_blank">Codeview</a> 1.2<br />
                          Generated on:
                          <time datetime='2012-9-23' pubdate>2012-9-23 18:39</time>
                  </footer>
          </div>
  </div>
  
  <div class="index indexStatic"></div>
  
  <div class="content">
          <div class="innerContent">
                  <article>
                          <header>
                                  <h1 class="classTitle">
                                          
                                          Class <span>tQuery</span>
                                  </h1>
                                  
                                  <div class="intro">
                                          <p class="description summary">
                                                  root class
                                          </p>
                                                  
                                          
                                                  <ul class="summary">
                                                          
                                                          
                                                          
                                                                  <li>Defined in: <a href="../symbols/src/js_tquery.core.js.html">tquery.core.js</a></li>
                                                          
                                                          
                                                  </ul>
                                          
                                  </div>
                          </header>
                          
                          
                                  <section>
                                          <div class="props">
                                                  <table class="summaryTable" cellspacing="0" summary="A summary of the constructor documented in the class tQuery.">
                                                          <caption class="sectionTitle">Class Summary</caption>
                                                          <thead>
                                                                  <tr>
                                                                          <th scope="col">Constructor Attributes</th>
                                                                          <th scope="col">Constructor Name and Description</th>
                                                                  </tr>
                                                          </thead>
                                                          <tbody>
                                                                  <tr>
                                                                          <td class="attributes">&nbsp;</td>
                                                                          <td class="nameDescription" >
                                                                                  <div class="fixedFont">
                                                                                          <b><a href="../symbols/tQuery.html#constructor">tQuery</a></b>(object, rootnode)
                                                                                  </div>
                                                                                  <div class="description">Create a tQuery element</div>
                                                                          </td>
                                                                  </tr>
                                                          </tbody>
                                                  </table>
                                          </div>
                                  </section>
                          
                          
                          
                                  
                                  <section>
                                          
                                                  <nav>
                                                          <div class="props">
                                                                  <table class="summaryTable" cellspacing="0" summary="A summary of the fields documented in the class tQuery.">
                                                                          <caption class="sectionTitle">Field Summary</caption>
                                                                          
                                                                          <thead>
                                                                                  <tr>
                                                                                          <th scope="col">Field Attributes</th>
                                                                                          <th scope="col">Field Name and Description</th>
                                                                                  </tr>
                                                                          </thead>
                                                                          
                                                                          <tbody>
                                                                                  
                                                                                          <tr>
                                                                                                  <td class="attributes">&lt;static&gt; &nbsp;</td>
                                                                                                  <td class="nameDescription">
                                                                                                          <div class="fixedFont">
                                                                                                          tQuery.<b><a href="../symbols/tQuery.html#.defaultObject3DMaterial">defaultObject3DMaterial</a></b>
                                                                                                          </div>
                                                                                                          <div class="description">contains the default material to use when create tQuery.Object3D</div>
                                                                                                  </td>
                                                                                          </tr>
                                                                                  
                                                                                          <tr>
                                                                                                  <td class="attributes">&lt;static&gt; &nbsp;</td>
                                                                                                  <td class="nameDescription">
                                                                                                          <div class="fixedFont">
                                                                                                          tQuery.<b><a href="../symbols/tQuery.html#.now">now</a></b>
                                                                                                          </div>
                                                                                                          <div class="description">precise version of Date.now() -
  It provide submillisecond precision based on window.performance.now() when 
  available, fall back on Date.now()
  see http://updates.html5rocks.com/2012/05/requestAnimationFrame-API-now-with-sub-millisecond-precision>
                                                                                                  </td>
                                                                                          </tr>
                                                                                  
                                                                                          <tr>
                                                                                                  <td class="attributes">&lt;static&gt; &nbsp;</td>
                                                                                                  <td class="nameDescription">
                                                                                                          <div class="fixedFont">
                                                                                                          tQuery.<b><a href="../symbols/tQuery.html#.VERSION">VERSION</a></b>
                                                                                                          </div>
                                                                                                          <div class="description">The version of tQuery</div>
                                                                                                  </td>
                                                                                          </tr>
                                                                                  
                                                                          </tbody>
                                                                  </table>
                                                          </div>
                                                  </nav>
                                          
                                          
                                          
                                  </section>
                          
          <!--
  
# METHODS SUMMARY --> <section> <div class="props"> <h2 class="sectionTitle">Method Summary</h2> <nav> <table class="summaryTable" id="MethodsList" cellspacing="0" summary="A summary of the methods documented in the class tQuery."> <thead> <tr> <th scope="col">Method Attributes</th> <th scope="col">Method Name and Description</th> </tr> </thead> <tbody> <tr class='item0' > <td class="attributes">&lt;static&gt; &nbsp;</td> <td class="nameDescription"> <div class="fixedFont">tQuery.<b><a href="../symbols/tQuery.html#.data">data</a></b>(object, key, value, mustNotExist) </div> <div class="description">generic getter/setter</div> </td> </tr> <tr class='item1' > <td class="attributes">&lt;static&gt; &nbsp;</td> <td class="nameDescription"> <div class="fixedFont">tQuery.<b><a href="../symbols/tQuery.html#.each">each</a></b>(arr, callback) </div> <div class="description">loop over a Array.</div> </td> </tr> <tr class='item2' > <td class="attributes">&lt;static&gt; &nbsp;</td> <td class="nameDescription"> <div class="fixedFont">tQuery.<b><a href="../symbols/tQuery.html#.extend">extend</a></b>(obj, base, deep) </div> <div class="description">extend function.</div> </td> </tr> <tr class='item3' > <td class="attributes">&lt;static&gt; &nbsp;</td> <td class="nameDescription"> <div class="fixedFont">tQuery.<b><a href="../symbols/tQuery.html#.Flow">Flow</a></b>() </div> <div class="description">Flow control - from github.com/jeromeetienne/gowiththeflow.js</div> </td> </tr> <tr class='item4' > <td class="attributes">&lt;static&gt; &nbsp;</td> <td class="nameDescription"> <div class="fixedFont">tQuery.<b><a href="../symbols/tQuery.html#.inherit">inherit</a></b>(childClass, parentClass) </div> <div class="description">Make a child Class inherit from the parent class.</div> </td> </tr> <tr class='item5' > <td class="attributes">&lt;static&gt; &nbsp;</td> <td class="nameDescription"> <div class="fixedFont">tQuery.<b><a href="../symbols/tQuery.html#.MicroeventMixin">MicroeventMixin</a></b>(destObj) </div> <div class="description">microevents.js - github.com/jeromeetienne/microevent.js</div> </td> </tr> <tr class='item6' > <td class="attributes">&lt;static&gt; &nbsp;</td> <td class="nameDescription"> <div class="fixedFont">tQuery.<b><a href="../symbols/tQuery.html#.removeData">removeData</a></b>(mustExist, key, mustExist) </div> <div class="description">Same as jQuery.removeData()</div> </td> </tr> </tbody> </table> </nav> </div> </section> <!-- # EVENTS SUMMARY --> <!-- # CONSTRUCTOR DETAILS --> <section> <div class="details props"> <div class="innerProps"> <h2 class="sectionTitle" id="constructor"> Class Detail </h2> <div class="fixedFont"> <b>tQuery</b>(object, rootnode) </div> <div class="description"> Create a tQuery element </div> <dl class="detailList params"> <dt class="heading">Parameters:</dt> <dt> <b>object</dt> <dd></dd> <dt> <span class="light fixedFont">{THREE.Object3D}</span> <b>rootnode</b> </dt> <dd></dd> </dl> <dl class="detailList nomargin"> <dt class="heading">Returns:</dt> <dd><span class="light fixedFont">{tQuery.*}</span> the tQuery object created </dl> </div> </div> </section> <!-- # FIELD DETAILS --> <section> <div class="details props"> <div class="innerProps"> <h2 class="sectionTitle"> Field Detail </h2> <div class="fixedFont heading" id=".defaultObject3DMaterial"> <span class='lighter'> &lt;static&gt; </span> <span class="light">tQuery.</span><b>defaultObject3DMaterial</b> </div> <div class="description"> contains the default material to use when create tQuery.Object3D <br /> <i>Defined in: </i> <a href="../symbols/src/js_tquery.core.create.js.html">tquery.core.create.js</a>. </div> <div class="hr"></div> <div class="fixedFont heading" id=".now"> <span class='lighter'> &lt;static&gt; </span> <span class="light">tQuery.</span><b>now</b> </div> <div class="description"> precise version of Date.now() - It provide submillisecond precision based on window.performance.now() when available, fall back on Date.now() see http://updates.html5rocks.com/2012/05/requestAnimationFrame-API-now-with-sub-millisecond-precision > <div class="hr"></div> <div class="fixedFont heading" id=".VERSION"> <span class='lighter'> &lt;static&gt; </span> <span class="light">tQuery.</span><b>VERSION</b> </div> <div class="description"> The version of tQuery </div> </div> </div> </section> <!-- # METHOD DETAILS --> <section> <div class="details props"> <div class="innerProps"> <h2 class="sectionTitle"> Method Detail </h2> <ul class="methodDetail" id="MethodDetail"> <li class='item0' > <div class="fixedFont heading" id=".data"> <span class='lighter'> &lt;static&gt; </span> <span class="light">{*}</span> <span class="light">tQuery.</span><b>data</b>(object, key, value, mustNotExist) </div> <div class="description"> generic getter/setter </div> <dl class="detailList params"> <dt class="heading">Parameters:</dt> <dt> <span class="light fixedFont">{Object}</span> <b>object</dt> <dd>the object in which store the data</dd> <dt> <span class="light fixedFont">{String}</span> <b>key</b> </dt> <dd>the key/name of the data to get/set</dd> <dt> <span class="light fixedFont">{*}</span> <b>value</b> </dt> <dd>the value to set (optional)</dd> <dt> <span class="light fixedFont">{Boolean}</span> <b>mustNotExist</b> </dt> <dd>if true, ensure that the key doesnt already exist, optional default to false</dd> </dl> <dl class="detailList nomargin"> <dt class="heading">Returns:</dt> <dd><span class="light fixedFont">{*}</span> return the value stored in this object for this key</dd> </dl> <div class="hr"></div> </li> <li class='item1' > <div class="fixedFont heading" id=".each"> <span class='lighter'> &lt;static&gt; </span> <span class="light">{Boolean}</span> <span class="light">tQuery.</span><b>each</b>(arr, callback) </div> <div class="description"> loop over a Array. </div> <dl class="detailList params"> <dt class="heading">Parameters:</dt> <dt> <span class="light fixedFont">{Array}</span> <b>arr</b> </dt> <dd>the array to traverse.</dd> <dt> <span class="light fixedFont">{Function}</span> <b>callback</b> </dt> <dd>the function to notify. function(element){ }. loop interrupted if it returns false</dd> </dl> <dl class="detailList nomargin"> <dt class="heading">Returns:</dt> <dd><span class="light fixedFont">{Boolean}</span> return true if completed, false if interrupted</dd> </dl> <div class="hr"></div> </li> <li class='item2' > <div class="fixedFont heading" id=".extend"> <span class='lighter'> &lt;static&gt; </span> <span class="light">tQuery.</span><b>extend</b>(obj, base, deep) </div> <div class="description"> extend function. mainly aimed at handling default values - jme: im not sure at all it is the proper one. http://jsapi.info/_/extend similar to jquery one but much smaller </div> <dl class="detailList params"> <dt class="heading">Parameters:</dt> <dt> <b>obj</b> </dt> <dd></dd> <dt> <b>base</b> </dt> <dd></dd> <dt> <b>deep</b> </dt> <dd></dd> </dl> <div class="hr"></div> </li> <li class='item3' > <div class="fixedFont heading" id=".Flow"> <span class='lighter'> &lt;static&gt; </span> <span class="light">tQuery.</span><b>Flow</b>() </div> <div class="description"> Flow control - from github.com/jeromeetienne/gowiththeflow.js </div> <div class="hr"></div> </li> <li class='item4' > <div class="fixedFont heading" id=".inherit"> <span class='lighter'> &lt;static&gt; </span> <span class="light">tQuery.</span><b>inherit</b>(childClass, parentClass) </div> <div class="description"> Make a child Class inherit from the parent class. </div> <dl class="detailList params"> <dt class="heading">Parameters:</dt> <dt> <span class="light fixedFont">{Object}</span> <b>childClass</b> </dt> <dd>the child class which gonna inherit</dd> <dt> <span class="light fixedFont">{Object}</span> <b>parentClass</b> </dt> <dd>the class which gonna be inherited</dd> </dl> <div class="hr"></div> </li> <li class='item5' > <div class="fixedFont heading" id=".MicroeventMixin"> <span class='lighter'> &lt;static&gt; </span> <span class="light">tQuery.</span><b>MicroeventMixin</b>(destObj) </div> <div class="description"> microevents.js - github.com/jeromeetienne/microevent.js </div> <dl class="detailList params"> <dt class="heading">Parameters:</dt> <dt> <b>destObj</b> </dt> <dd></dd> </dl> <div class="hr"></div> </li> <li class='item6' > <div class="fixedFont heading" id=".removeData"> <span class='lighter'> &lt;static&gt; </span> <span class="light">tQuery.</span><b>removeData</b>(mustExist, key, mustExist) </div> <div class="description"> Same as jQuery.removeData() </div> <dl class="detailList params"> <dt class="heading">Parameters:</dt> <dt> <span class="light fixedFont">{Boolean}</span> <b>mustExist</b> </dt> <dd>if true, ensure the key does exist, default to false</dd> <dt> <b>key</b> </dt> <dd></dd> <dt> <b>mustExist</b> </dt> <dd></dd> </dl> </li> </ul> </div> </div> </section> <!-- # EVENT DETAILS --> </article> </div> </div>

                  <script type="text/javascript">
                          wbos.CssTools.MediaQueryFallBack.LoadCss('../css/screen.css', '../css/handheld.css', 660)
                          codeview.classFilter.Init()
                  </script>
          </body>
  </html>
  
  


(C) Æliens 04/09/2009

You may not copy or print any of this material without explicit permission of the author or the publisher. In case of other copyright issues, contact the author.