index.html 12 KB

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