index.html 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446
  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4. <meta charset="utf-8">
  5. <title>three.js / documentation</title>
  6. <meta name="viewport" content="width=device-width, user-scalable=no, minimum-scale=1.0, maximum-scale=1.0">
  7. <link type="text/css" rel="stylesheet" href="index.css">
  8. </head>
  9. <body>
  10. <div id="panel" class="collapsed">
  11. <h1><a href="http://threejs.org">three.js</a> / docs</h1>
  12. <a id="expandButton" href="#">
  13. <span></span>
  14. <span></span>
  15. <span></span>
  16. </a>
  17. <div class="filterBlock" >
  18. <input type="text" id="filterInput" placeholder="Type to filter">
  19. <a href="#" id="clearFilterButton">x</a>
  20. </div>
  21. <div id="content"></div>
  22. </div>
  23. <iframe></iframe>
  24. <script src="list.js"></script>
  25. <script>
  26. var panel = document.getElementById( 'panel' );
  27. var content = document.getElementById( 'content' );
  28. var clearFilterButton = document.getElementById( 'clearFilterButton' );
  29. var expandButton = document.getElementById( 'expandButton' );
  30. var filterInput = document.getElementById( 'filterInput' );
  31. var iframe = document.querySelector( 'iframe' );
  32. var pageProperties = {};
  33. var titles = {};
  34. var categoryElements = [];
  35. // ----------------------------------------------------------------------------
  36. // Initialization
  37. // ----------------------------------------------------------------------------
  38. // Functionality for hamburger button (on small devices)
  39. expandButton.onclick = function ( event ) {
  40. event.preventDefault();
  41. panel.classList.toggle( 'collapsed' );
  42. };
  43. // Functionality for search/filter input field
  44. filterInput.oninput = function ( event ) {
  45. updateFilter();
  46. };
  47. // Functionality for filter clear button
  48. clearFilterButton.onclick = function ( event ) {
  49. event.preventDefault();
  50. filterInput.value = '';
  51. updateFilter();
  52. };
  53. // Activate content and title change on browser navigation
  54. window.onpopstate = createNewIframe;
  55. // Create the navigation panel and configure the iframe
  56. createNavigation();
  57. createNewIframe();
  58. // ----------------------------------------------------------------------------
  59. // Navigation Panel
  60. // ----------------------------------------------------------------------------
  61. function createNavigation () {
  62. // Create the navigation panel using data from list.js
  63. var navigation = createAndAppendDOMElement( { type: 'div', parent: content } );
  64. for ( var section in list ) {
  65. // Create sections
  66. var categories = list[ section ];
  67. var sectionHead = createAndAppendDOMElement( { type: 'h2', parent: navigation, content: section } )
  68. for ( var category in categories ) {
  69. // Create categories
  70. var pages = categories[ category ];
  71. var categoryContainer = createAndAppendDOMElement( { type: 'div', parent: navigation } );
  72. var categoryHead = createAndAppendDOMElement( { type: 'h3', parent: categoryContainer, content: category } );
  73. var categoryContent = createAndAppendDOMElement( { type: 'ul', parent: categoryContainer } );
  74. for ( var pageName in pages ) {
  75. // Create page links
  76. var pageURL = pages[ pageName ];
  77. var listElement = createAndAppendDOMElement( { type: 'li', parent: categoryContent } );
  78. var linkElement = createAndAppendDOMElement( { type: 'a', parent: listElement, content: pageName } );
  79. // The href attribute is only used for the option to create a new tab by right click
  80. linkElement.setAttribute( 'href', '#' + pageURL );
  81. addClickHandlers( linkElement, pageURL );
  82. // Gather the main properties for the current subpage
  83. pageProperties[ pageName ] = {
  84. section: section,
  85. category: category,
  86. pageURL: pageURL,
  87. linkElement: linkElement
  88. };
  89. // Gather the document titles (used for easy access on browser navigation)
  90. titles[ pageURL ] = pageName;
  91. }
  92. // Gather the category elements for easy access on filtering
  93. categoryElements.push( categoryContent );
  94. }
  95. }
  96. };
  97. function createAndAppendDOMElement( properties ) {
  98. // Helper function for creating and appending new DOM elements
  99. var newElement = document.createElement( properties.type );
  100. properties.parent.appendChild( newElement );
  101. if ( properties.content ) {
  102. newElement.textContent = properties.content;
  103. }
  104. return newElement;
  105. }
  106. function addClickHandlers ( linkElement, pageURL ) {
  107. // Helper function for adding ClickHandlers to the page links
  108. linkElement.onclick = function ( event ) {
  109. event.preventDefault();
  110. window.location.hash = pageURL;
  111. createNewIframe();
  112. panel.classList.add( 'collapsed' );
  113. };
  114. };
  115. // ----------------------------------------------------------------------------
  116. // Query Strings (optional)
  117. // ----------------------------------------------------------------------------
  118. // (uncomment the following lines and the first line in updateFilter(), if you want query strings):
  119. // filterInput.value = extractFromQueryString();
  120. // updateFilter();
  121. //
  122. //
  123. // function extractFromQueryString() {
  124. //
  125. // var queryString = window.location.search;
  126. //
  127. // if ( queryString.indexOf( '?q=' ) === -1 ) return '';
  128. //
  129. // return queryString.substr( 3 );
  130. //
  131. // }
  132. //
  133. // function updateQueryString() {
  134. //
  135. // var searchString = filterInput.value;
  136. // var query = '';
  137. //
  138. // if (searchString !== '') {
  139. //
  140. // query = '?q=' + searchString;
  141. //
  142. // }
  143. //
  144. // window.history.replaceState( {} , '', window.location.pathname + query + window.location.hash );
  145. //
  146. // }
  147. // ----------------------------------------------------------------------------
  148. // Filtering
  149. // ----------------------------------------------------------------------------
  150. function updateFilter() {
  151. // (uncomment the following line and the "Query strings" section, if you want query strings):
  152. // updateQueryString();
  153. var regExp = new RegExp( filterInput.value, 'gi' );
  154. for ( var pageName in pageProperties ) {
  155. var linkElement = pageProperties[ pageName ].linkElement;
  156. var categoryClassList = linkElement.parentElement.classList;
  157. var filterResults = pageName.match( regExp );
  158. if ( filterResults && filterResults.length > 0 ) {
  159. // Accentuate matching characters
  160. for ( var i = 0; i < filterResults.length; i++ ) {
  161. var result = filterResults[ i ];
  162. if ( result !== '' ) {
  163. pageName = pageName.replace( result, '<b>' + result + '</b>' );
  164. }
  165. }
  166. categoryClassList.remove( 'hidden' );
  167. linkElement.innerHTML = pageName;
  168. } else {
  169. // Hide all non-matching page names
  170. categoryClassList.add( 'hidden' );
  171. }
  172. }
  173. displayFilteredPanel();
  174. }
  175. function displayFilteredPanel() {
  176. // Show/hide categories depending on their content
  177. // First check if at least one page in this category is not hidden
  178. categoryElements.forEach( function ( category ) {
  179. var pages = category.children;
  180. var pagesLength = pages.length;
  181. var sectionClassList = category.parentElement.classList;
  182. var hideCategory = true;
  183. for ( var i = 0; i < pagesLength; i ++ ) {
  184. var pageClassList = pages[ i ].classList;
  185. if ( ! pageClassList.contains( 'hidden' ) ) {
  186. hideCategory = false;
  187. }
  188. }
  189. // If and only if all page names are hidden, hide the whole category
  190. if ( hideCategory ) {
  191. sectionClassList.add( 'hidden' );
  192. } else {
  193. sectionClassList.remove( 'hidden' );
  194. }
  195. } );
  196. }
  197. // ----------------------------------------------------------------------------
  198. // Routing
  199. // ----------------------------------------------------------------------------
  200. function setUrlFragment( pageName ) {
  201. // Handle navigation from the subpages (iframes):
  202. // First separate the memeber (if existing) from the page name,
  203. // then identify the subpage's URL and set it as URL fragment (re-adding the member)
  204. var splitPageName = decomposePageName( pageName, '.', '.' );
  205. var currentProperties = pageProperties[ splitPageName[ 0 ] ];
  206. if ( currentProperties ) {
  207. window.location.hash = currentProperties.pageURL + splitPageName[ 1 ];
  208. createNewIframe();
  209. }
  210. }
  211. function createNewIframe() {
  212. // Change the content displayed in the iframe
  213. // First separate the member part of the fragment (if existing)
  214. var hash = window.location.hash.substring( 1 );
  215. var splitHash = decomposePageName( hash, '.', '#' );
  216. // Creating a new Iframe instead of assigning a new src is
  217. // a cross-browser solution to allow normal browser navigation;
  218. // - only assigning a new src would result in two history states each time.
  219. // Note: iframe.contentWindow.location.replace(hash) should work, too,
  220. // but it doesn't work in Edge with links from the subpages!
  221. var oldIframe;
  222. var subtitle;
  223. oldIframe = iframe;
  224. iframe = oldIframe.cloneNode();
  225. if(hash) {
  226. iframe.src = splitHash[ 0 ] + '.html' + splitHash[ 1 ];
  227. subtitle = ' - ' + titles[ splitHash[ 0 ] ] + splitHash[ 1 ];
  228. } else {
  229. iframe.src = '';
  230. subtitle = '';
  231. }
  232. document.body.replaceChild( iframe, oldIframe );
  233. document.title = 'three.js docs' + subtitle;
  234. }
  235. function decomposePageName ( pageName, oldDelimiter, newDelimiter ) {
  236. // Helper function for separating the member (if existing) from the pageName
  237. // For example: 'Geometry.morphTarget' can be converted to
  238. // ['Geometry', '.morphTarget'] or ['Geometry', '#morphTarget']
  239. // Note: According RFC 3986 no '#' allowed inside of an URL fragment!
  240. var parts = [];
  241. var dotIndex = pageName.indexOf( oldDelimiter );
  242. if ( dotIndex !== -1 ) {
  243. parts = pageName.split( oldDelimiter );
  244. parts[ 1 ] = newDelimiter + parts[ 1 ];
  245. } else {
  246. parts[ 0 ] = pageName;
  247. parts[ 1 ] = '';
  248. }
  249. return parts;
  250. }
  251. // ----------------------------------------------------------------------------
  252. // ASCII Art ;-)
  253. // ----------------------------------------------------------------------------
  254. console.log([
  255. ' __ __',
  256. ' __/ __\\ / __\\__ ____ _____ _____',
  257. '/ __/ /\\/ / /___\\/ ____\\/ _____\\/ _____\\',
  258. '\\/_ __/ / _ / / __/ / __ / / __ /_ __ _____',
  259. '/ / / / / / / / / / / / ___/ / ___/\\ _\\/ __\\/ _____\\',
  260. '\\/__/ \\/__/\\/__/\\/__/ \\/_____/\\/_____/\\/__/ / / / ___/',
  261. ' / __/ / \\__ \\',
  262. ' \\/____/\\/_____/'
  263. ].join('\n'));
  264. </script>
  265. <script src="../build/three.min.js"></script> <!-- console sandbox -->
  266. </body>
  267. </html>