|
12 | 12 | <![endif]-->
|
13 | 13 | <link type="text/css" rel="stylesheet" href="styles/sunlight.default.css">
|
14 | 14 | <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
|
| 15 | + <link rel="shortcut icon" href="../img/favicon.ico" type="image/x-icon"> |
15 | 16 |
|
16 | 17 |
|
17 | 18 | <link type="text/css" rel="stylesheet" href="styles/site.cosmo.css">
|
@@ -384,7 +385,7 @@ <h6>Properties</h6>
|
384 | 385 |
|
385 | 386 | <tr>
|
386 | 387 |
|
387 |
| - <td class="name"><code>_refreshInterval</code></td> |
| 388 | + <td class="name"><code>refreshInterval</code></td> |
388 | 389 |
|
389 | 390 |
|
390 | 391 | <td class="type">
|
@@ -455,7 +456,7 @@ <h6>Properties</h6>
|
455 | 456 |
|
456 | 457 | <dt class="tag-source">Source:</dt>
|
457 | 458 | <dd class="tag-source"><ul class="dummy"><li>
|
458 |
| - <a href="jquery.scrollmagic.js.html">jquery.scrollmagic.js</a>, <a href="jquery.scrollmagic.js.html#sunlight-1-line-55">line 55</a> |
| 459 | + <a href="jquery.scrollmagic.js.html">jquery.scrollmagic.js</a>, <a href="jquery.scrollmagic.js.html#sunlight-1-line-71">line 71</a> |
459 | 460 | </li></ul></dd>
|
460 | 461 |
|
461 | 462 |
|
@@ -600,7 +601,7 @@ <h5>Parameters:</h5>
|
600 | 601 |
|
601 | 602 | <dt class="tag-source">Source:</dt>
|
602 | 603 | <dd class="tag-source"><ul class="dummy"><li>
|
603 |
| - <a href="jquery.scrollmagic.js.html">jquery.scrollmagic.js</a>, <a href="jquery.scrollmagic.js.html#sunlight-1-line-263">line 263</a> |
| 604 | + <a href="jquery.scrollmagic.js.html">jquery.scrollmagic.js</a>, <a href="jquery.scrollmagic.js.html#sunlight-1-line-275">line 275</a> |
604 | 605 | </li></ul></dd>
|
605 | 606 |
|
606 | 607 |
|
@@ -759,7 +760,7 @@ <h5>Parameters:</h5>
|
759 | 760 |
|
760 | 761 | <dt class="tag-source">Source:</dt>
|
761 | 762 | <dd class="tag-source"><ul class="dummy"><li>
|
762 |
| - <a href="jquery.scrollmagic.js.html">jquery.scrollmagic.js</a>, <a href="jquery.scrollmagic.js.html#sunlight-1-line-599">line 599</a> |
| 763 | + <a href="jquery.scrollmagic.js.html">jquery.scrollmagic.js</a>, <a href="jquery.scrollmagic.js.html#sunlight-1-line-611">line 611</a> |
763 | 764 | </li></ul></dd>
|
764 | 765 |
|
765 | 766 |
|
@@ -901,7 +902,7 @@ <h5>Parameters:</h5>
|
901 | 902 |
|
902 | 903 | <dt class="tag-source">Source:</dt>
|
903 | 904 | <dd class="tag-source"><ul class="dummy"><li>
|
904 |
| - <a href="jquery.scrollmagic.js.html">jquery.scrollmagic.js</a>, <a href="jquery.scrollmagic.js.html#sunlight-1-line-306">line 306</a> |
| 905 | + <a href="jquery.scrollmagic.js.html">jquery.scrollmagic.js</a>, <a href="jquery.scrollmagic.js.html#sunlight-1-line-318">line 318</a> |
905 | 906 | </li></ul></dd>
|
906 | 907 |
|
907 | 908 |
|
@@ -1061,7 +1062,7 @@ <h5>Parameters:</h5>
|
1061 | 1062 |
|
1062 | 1063 | <dt class="tag-source">Source:</dt>
|
1063 | 1064 | <dd class="tag-source"><ul class="dummy"><li>
|
1064 |
| - <a href="jquery.scrollmagic.js.html">jquery.scrollmagic.js</a>, <a href="jquery.scrollmagic.js.html#sunlight-1-line-425">line 425</a> |
| 1065 | + <a href="jquery.scrollmagic.js.html">jquery.scrollmagic.js</a>, <a href="jquery.scrollmagic.js.html#sunlight-1-line-437">line 437</a> |
1065 | 1066 | </li></ul></dd>
|
1066 | 1067 |
|
1067 | 1068 |
|
@@ -1189,7 +1190,7 @@ <h5>Parameters:</h5>
|
1189 | 1190 | </td>
|
1190 | 1191 |
|
1191 | 1192 |
|
1192 |
| - <td class="description last"><p>If <code>true</code> the update will be instant, if <code>false</code> it will wait until next tweenmax tick (better performance)</p></td> |
| 1193 | + <td class="description last"><p>If <code>true</code> the update will be instant, if <code>false</code> it will wait until next update cycle (better performance)</p></td> |
1193 | 1194 | </tr>
|
1194 | 1195 |
|
1195 | 1196 |
|
@@ -1221,7 +1222,7 @@ <h5>Parameters:</h5>
|
1221 | 1222 |
|
1222 | 1223 | <dt class="tag-source">Source:</dt>
|
1223 | 1224 | <dd class="tag-source"><ul class="dummy"><li>
|
1224 |
| - <a href="jquery.scrollmagic.js.html">jquery.scrollmagic.js</a>, <a href="jquery.scrollmagic.js.html#sunlight-1-line-385">line 385</a> |
| 1225 | + <a href="jquery.scrollmagic.js.html">jquery.scrollmagic.js</a>, <a href="jquery.scrollmagic.js.html#sunlight-1-line-397">line 397</a> |
1225 | 1226 | </li></ul></dd>
|
1226 | 1227 |
|
1227 | 1228 |
|
@@ -1261,7 +1262,7 @@ <h5>Returns:</h5>
|
1261 | 1262 |
|
1262 | 1263 | <h5>Example</h5>
|
1263 | 1264 |
|
1264 |
| - <pre class="sunlight-highlight-javascript">// update the controller on next tick (saves performance)controller.update();// update the controller immediatelycontroller.update(true);</pre> |
| 1265 | + <pre class="sunlight-highlight-javascript">// update the controller on next cycle (saves performance due to elimination of redundant updates)controller.update();// update the controller immediatelycontroller.update(true);</pre> |
1265 | 1266 |
|
1266 | 1267 |
|
1267 | 1268 |
|
@@ -1383,7 +1384,7 @@ <h5>Parameters:</h5>
|
1383 | 1384 | </td>
|
1384 | 1385 |
|
1385 | 1386 |
|
1386 |
| - <td class="description last"><p>If <code>true</code> the update will be instant, if <code>false</code> it will wait until next tweenmax tick.<br> This is useful when changing multiple properties of the scene - this way it will only be updated once all new properties are set (onTick).</p></td> |
| 1387 | + <td class="description last"><p>If <code>true</code> the update will be instant, if <code>false</code> it will wait until next update cycle.<br> This is useful when changing multiple properties of the scene - this way it will only be updated once all new properties are set (updateScenes).</p></td> |
1387 | 1388 | </tr>
|
1388 | 1389 |
|
1389 | 1390 |
|
@@ -1415,7 +1416,7 @@ <h5>Parameters:</h5>
|
1415 | 1416 |
|
1416 | 1417 | <dt class="tag-source">Source:</dt>
|
1417 | 1418 | <dd class="tag-source"><ul class="dummy"><li>
|
1418 |
| - <a href="jquery.scrollmagic.js.html">jquery.scrollmagic.js</a>, <a href="jquery.scrollmagic.js.html#sunlight-1-line-345">line 345</a> |
| 1419 | + <a href="jquery.scrollmagic.js.html">jquery.scrollmagic.js</a>, <a href="jquery.scrollmagic.js.html#sunlight-1-line-357">line 357</a> |
1419 | 1420 | </li></ul></dd>
|
1420 | 1421 |
|
1421 | 1422 |
|
@@ -1455,7 +1456,7 @@ <h5>Returns:</h5>
|
1455 | 1456 |
|
1456 | 1457 | <h5>Example</h5>
|
1457 | 1458 |
|
1458 |
| - <pre class="sunlight-highlight-javascript">// update a specific scene on next tickcontroller.updateScene(scene);// update a specific scene immediatelycontroller.updateScene(scene, true);// update multiple scenes scene on next tickcontroller.updateScene([scene1, scene2, scene3]);</pre> |
| 1459 | + <pre class="sunlight-highlight-javascript">// update a specific scene on next cyclecontroller.updateScene(scene);// update a specific scene immediatelycontroller.updateScene(scene, true);// update multiple scenes scene on next cyclecontroller.updateScene([scene1, scene2, scene3]);</pre> |
1459 | 1460 |
|
1460 | 1461 |
|
1461 | 1462 |
|
@@ -1570,7 +1571,7 @@ <h5>Parameters:</h5>
|
1570 | 1571 |
|
1571 | 1572 | <dt class="tag-source">Source:</dt>
|
1572 | 1573 | <dd class="tag-source"><ul class="dummy"><li>
|
1573 |
| - <a href="jquery.scrollmagic.js.html">jquery.scrollmagic.js</a>, <a href="jquery.scrollmagic.js.html#sunlight-1-line-575">line 575</a> |
| 1574 | + <a href="jquery.scrollmagic.js.html">jquery.scrollmagic.js</a>, <a href="jquery.scrollmagic.js.html#sunlight-1-line-587">line 587</a> |
1574 | 1575 | </li></ul></dd>
|
1575 | 1576 |
|
1576 | 1577 |
|
@@ -1724,7 +1725,7 @@ <h5>Parameters:</h5>
|
1724 | 1725 |
|
1725 | 1726 | <dt class="tag-source">Source:</dt>
|
1726 | 1727 | <dd class="tag-source"><ul class="dummy"><li>
|
1727 |
| - <a href="jquery.scrollmagic.js.html">jquery.scrollmagic.js</a>, <a href="jquery.scrollmagic.js.html#sunlight-1-line-551">line 551</a> |
| 1728 | + <a href="jquery.scrollmagic.js.html">jquery.scrollmagic.js</a>, <a href="jquery.scrollmagic.js.html#sunlight-1-line-563">line 563</a> |
1728 | 1729 | </li></ul></dd>
|
1729 | 1730 |
|
1730 | 1731 |
|
@@ -1785,7 +1786,7 @@ <h4 class="name" id="scrollPos"><span class="type-signature"></span>scrollPos<sp
|
1785 | 1786 |
|
1786 | 1787 | <div class="description">
|
1787 | 1788 | <p><strong>Get</strong> the current scrollPosition or <strong>Set</strong> a new method to calculate it.<br>-> <strong>GET</strong>:
|
1788 |
| -When used as a getter this function will return the current scroll position.<br>To get a cached value use ScrollMagic.info("scrollPos"), which will be updated on tick to save on performance.<br>For vertical controllers it will return the top scroll offset and for horizontal applications it will return the left offset.</p> |
| 1789 | +When used as a getter this function will return the current scroll position.<br>To get a cached value use ScrollMagic.info("scrollPos"), which will be updated in the update cycle.<br>For vertical controllers it will return the top scroll offset and for horizontal applications it will return the left offset.</p> |
1789 | 1790 | <p>-> <strong>SET</strong>:
|
1790 | 1791 | When used as a setter this method prodes a way to permanently overwrite the controller's scroll position calculation.<br>A typical usecase is when the scroll position is not reflected by the containers scrollTop or scrollLeft values, but for example by the inner offset of a child container.<br>Moving a child container inside a parent is a commonly used method for several scrolling frameworks, including iScroll.<br>By providing an alternate calculation function you can make sure ScrollMagic receives the correct scroll position.<br>Please also bear in mind that your function should return y values for vertical scrolls an x for horizontals.</p>
|
1791 | 1792 | <p>To change the current scroll position please use <code>ScrollMagic.scrollTo()</code>.</p>
|
@@ -1882,7 +1883,7 @@ <h5>Parameters:</h5>
|
1882 | 1883 |
|
1883 | 1884 | <dt class="tag-source">Source:</dt>
|
1884 | 1885 | <dd class="tag-source"><ul class="dummy"><li>
|
1885 |
| - <a href="jquery.scrollmagic.js.html">jquery.scrollmagic.js</a>, <a href="jquery.scrollmagic.js.html#sunlight-1-line-485">line 485</a> |
| 1886 | + <a href="jquery.scrollmagic.js.html">jquery.scrollmagic.js</a>, <a href="jquery.scrollmagic.js.html#sunlight-1-line-497">line 497</a> |
1886 | 1887 | </li></ul></dd>
|
1887 | 1888 |
|
1888 | 1889 |
|
@@ -2048,7 +2049,7 @@ <h5>Parameters:</h5>
|
2048 | 2049 |
|
2049 | 2050 | <dt class="tag-source">Source:</dt>
|
2050 | 2051 | <dd class="tag-source"><ul class="dummy"><li>
|
2051 |
| - <a href="jquery.scrollmagic.js.html">jquery.scrollmagic.js</a>, <a href="jquery.scrollmagic.js.html#sunlight-1-line-518">line 518</a> |
| 2052 | + <a href="jquery.scrollmagic.js.html">jquery.scrollmagic.js</a>, <a href="jquery.scrollmagic.js.html#sunlight-1-line-530">line 530</a> |
2052 | 2053 | </li></ul></dd>
|
2053 | 2054 |
|
2054 | 2055 |
|
|
0 commit comments