topical media & game development

talk show tell print

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



  
  <!DOCTYPE html>
  <html lang="en">
          <head>
                  <meta charset="utf-8" />
                  <meta name="generator" content="JsDoc Toolkit" />
                  <title>tQuery.MD2Character | 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.MD2Character</span>
                                  </h1>
                                  
                                  <div class="intro">
                                          <p class="description summary">
                                                  
                                          </p>
                                                  
                                          
                                                  <ul class="summary">
                                                          
                                                          
                                                          
                                                                  <li>Defined in: <a href="../symbols/src/plugins_md2character_tquery.md2character.js.html">tquery.md2character.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.MD2Character.">
                                                          <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.MD2Character.html#constructor">tQuery.MD2Character</a></b>()
                                                                                  </div>
                                                                                  <div class="description">widely inspired from MD2Character.js from alteredq / http://alteredqualia.com/>
                                                                          </td>
                                                                  </tr>
                                                          </tbody>
                                                  </table>
                                          </div>
                                  </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.MD2Character."> <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">&nbsp;</td> <td class="nameDescription"> <div class="fixedFont"><b><a href="../symbols/tQuery.MD2Character.html#animation">animation</a></b>(animationName) </div> <div class="description">set the animation.</div> </td> </tr> <tr class='item1' > <td class="attributes">&nbsp;</td> <td class="nameDescription"> <div class="fixedFont"><b><a href="../symbols/tQuery.MD2Character.html#container">container</a></b>() </div> <div class="description"></div> </td> </tr> <tr class='item2' > <td class="attributes">&nbsp;</td> <td class="nameDescription"> <div class="fixedFont"><b><a href="../symbols/tQuery.MD2Character.html#destroy">destroy</a></b>() </div> <div class="description">Destructor</div> </td> </tr> <tr class='item3' > <td class="attributes">&nbsp;</td> <td class="nameDescription"> <div class="fixedFont"><b><a href="../symbols/tQuery.MD2Character.html#isLoaded">isLoaded</a></b>() </div> <div class="description"></div> </td> </tr> <tr class='item4' > <td class="attributes">&nbsp;</td> <td class="nameDescription"> <div class="fixedFont"><b><a href="../symbols/tQuery.MD2Character.html#load">load</a></b>(config) </div> <div class="description">Load the part of your characters</div> </td> </tr> <tr class='item5' > <td class="attributes">&nbsp;</td> <td class="nameDescription"> <div class="fixedFont"><b><a href="../symbols/tQuery.MD2Character.html#scale">scale</a></b>(value) </div> <div class="description">Getter/setter for the scale of the object</td> </tr> <tr class='item6' > <td class="attributes">&nbsp;</td> <td class="nameDescription"> <div class="fixedFont"><b><a href="../symbols/tQuery.MD2Character.html#setPlaybackRate">setPlaybackRate</a></b>(rate) </div> <div class="description"></div> </td> </tr> <tr class='item7' > <td class="attributes">&nbsp;</td> <td class="nameDescription"> <div class="fixedFont"><b><a href="../symbols/tQuery.MD2Character.html#setSkin">setSkin</a></b>(index) </div> <div class="description"></div> </td> </tr> <tr class='item8' > <td class="attributes">&nbsp;</td> <td class="nameDescription"> <div class="fixedFont"><b><a href="../symbols/tQuery.MD2Character.html#setWeapon">setWeapon</a></b>(index) </div> <div class="description">Set the weapons</div> </td> </tr> <tr class='item9' > <td class="attributes">&nbsp;</td> <td class="nameDescription"> <div class="fixedFont"><b><a href="../symbols/tQuery.MD2Character.html#setWireframe">setWireframe</a></b>(enable) </div> <div class="description"></div> </td> </tr> <tr class='item10' > <td class="attributes">&nbsp;</td> <td class="nameDescription"> <div class="fixedFont"><b><a href="../symbols/tQuery.MD2Character.html#update">update</a></b>(deltaSeconds) </div> <div class="description">Update the animation</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.MD2Character</b>() </div> <div class="description"> widely inspired from MD2Character.js from alteredq / http://alteredqualia.com/ > </div> </div> </section> <!-- # FIELD DETAILS --> <!-- # 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="animation"> <span class='lighter'> </span> <b>animation</b>(animationName) </div> <div class="description"> set the animation. TODO a setter/getter </div> <dl class="detailList params"> <dt class="heading">Parameters:</dt> <dt> <span class="light fixedFont">{string}</span> <b>animationName</b> </dt> <dd>the animation name to set</dd> </dl> <div class="hr"></div> </li> <li class='item1' > <div class="fixedFont heading" id="container"> <span class='lighter'> </span> <span class="light">{THREE.Object3D}</span> <b>container</b>() </div> <div class="description"> </div> <dl class="detailList nomargin"> <dt class="heading">Returns:</dt> <dd><span class="light fixedFont">{THREE.Object3D}</span> the object3D containing the object</dl> <div class="hr"></div> </li> <li class='item2' > <div class="fixedFont heading" id="destroy"> <span class='lighter'> </span> <b>destroy</b>() </div> <div class="description"> Destructor </div> <div class="hr"></div> </li> <li class='item3' > <div class="fixedFont heading" id="isLoaded"> <span class='lighter'> </span> <span class="light">{Boolean}</span> <b>isLoaded</b>() </div> <div class="description"> </div> <dl class="detailList nomargin"> <dt class="heading">Returns:</dt> <dd><span class="light fixedFont">{Boolean}</span> true if the character is loaded, false otherwise</dd> </dl> <div class="hr"></div> </li> <li class='item4' > <div class="fixedFont heading" id="load"> <span class='lighter'> </span> <b>load</b>(config) </div> <div class="description"> Load the part of your characters </div> <dl class="detailList params"> <dt class="heading">Parameters:</dt> <dt> <b>config</b> </dt> <dd></dd> </dl> <div class="hr"></div> </li> <li class='item5' > <div class="fixedFont heading" id="scale"> <span class='lighter'> </span> <b>scale</b>(value) </div> <div class="description"> Getter/setter for the scale of the object </div> <dl class="detailList params"> <dt class="heading">Parameters:</dt> <dt> <b>value</b> </dt> <dd></dd> </dl> <div class="hr"></div> </li> <li class='item6' > <div class="fixedFont heading" id="setPlaybackRate"> <span class='lighter'> </span> <b>setPlaybackRate</b>(rate) </div> <div class="description"> </div> <dl class="detailList params"> <dt class="heading">Parameters:</dt> <dt> <span class="light fixedFont">{number}</span> <b>rate</b> </dt> <dd>the rate to play the object</dl> <div class="hr"></div> </li> <li class='item7' > <div class="fixedFont heading" id="setSkin"> <span class='lighter'> </span> <b>setSkin</b>(index) </div> <div class="description"> </div> <dl class="detailList params"> <dt class="heading">Parameters:</dt> <dt> <span class="light fixedFont">{Number}</span> <b>index</b> </dt> <dd>set the index of the skin</dd> </dl> <div class="hr"></div> </li> <li class='item8' > <div class="fixedFont heading" id="setWeapon"> <span class='lighter'> </span> <b>setWeapon</b>(index) </div> <div class="description"> Set the weapons </div> <dl class="detailList params"> <dt class="heading">Parameters:</dt> <dt> <span class="light fixedFont">{Number}</span> <b>index</b> </dt> <dd>the index of the animations</dd> </dl> <div class="hr"></div> </li> <li class='item9' > <div class="fixedFont heading" id="setWireframe"> <span class='lighter'> </span> <b>setWireframe</b>(enable) </div> <div class="description"> </div> <dl class="detailList params"> <dt class="heading">Parameters:</dt> <dt> <span class="light fixedFont">{Boolean}</span> <b>enable</b> </dt> <dd>true to enable wireframe, false otherwise</dd> </dl> <div class="hr"></div> </li> <li class='item10' > <div class="fixedFont heading" id="update"> <span class='lighter'> </span> <b>update</b>(deltaSeconds) </div> <div class="description"> Update the animation </div> <dl class="detailList params"> <dt class="heading">Parameters:</dt> <dt> <span class="light fixedFont">{Number}</span> <b>deltaSeconds</b> </dt> <dd>nb seconds since the last update</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.