gitadmin
/
three.js
mirror of https://github.com/mrdoob/three.js.git


			
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595
							<!DOCTYPE html>
<html lang="en">
	<head>
		<meta charset="utf-8">
		<title>three.js docs</title>
		<meta name="viewport" content="width=device-width, user-scalable=no, minimum-scale=1.0, maximum-scale=1.0">
		<link rel="shortcut icon" href="../files/favicon_white.ico" media="(prefers-color-scheme: dark)"/>
		<link rel="shortcut icon" href="../files/favicon.ico" media="(prefers-color-scheme: light)" />
		<link rel="stylesheet" type="text/css" href="../files/main.css">
		<!-- console sandbox -->
		<script type="module">
			import * as THREE from '../build/three.module.js';
			window.THREE = THREE;
		</script>
	</head>
	<body>
		<div id="panel">

			<div id="header">
				<h1><a href="https://threejs.org">three.js</a></h1>

				<div id="sections">
					<span class="selected">docs</span>
					<a href="../examples/#webgl_animation_keyframes">examples</a>
				</div>

				<div id="expandButton"></div>
			</div>

			<div id="panelScrim"></div>

			<div id="contentWrapper">
				<div id="inputWrapper">
					<input placeholder="" type="text" id="filterInput" autocorrect="off" autocapitalize="off" spellcheck="false" />
					<div id="clearSearchButton"></div>
					<select id="language">
						<option value="en">en</option>
						<option value="ar">ar</option>
						<option value="ko">한국어</option>
						<option value="zh">中文</option>
						<option value="ja">日本語</option>
						<option value="it">it</option>
						<option value="pt-br">pt-br</option>
						<option value="fr">fr</option>
						<option value="ru">ru</option>
					</select>
				</div>
				<div id="content"></div>
			</div>

		</div>

		<iframe name="viewer"></iframe>

		<script>

		const panel = document.getElementById( 'panel' );
		const content = document.getElementById( 'content' );
		const expandButton = document.getElementById( 'expandButton' );
		const clearSearchButton = document.getElementById( 'clearSearchButton' );
		const panelScrim = document.getElementById( 'panelScrim' );
		const filterInput = document.getElementById( 'filterInput' );
		let iframe = document.querySelector( 'iframe' );

		const sectionLink = document.querySelector( '#sections > a' );
		const sectionDefaultHref = sectionLink.href;

		const pageProperties = {};
		const titles = {};
		const categoryElements = [];

		let navigation;

		init();

		async function init() {

			const list = await ( await fetch( 'list.json' ) ).json();

			// *BufferGeometry to *Geometry

			if ( /Instanced/.exec( window.location.hash ) === null && /([\w]+)BufferGeometry$/.exec( window.location.hash ) ) {

				window.location.hash = window.location.hash.replace( 'BufferGeometry', 'Geometry' );

			}

			const hash = window.location.hash.substring( 1 );

			// Localisation

			let language = 'en';

			if ( /^(api|manual|examples)/.test( hash ) ) {

				const hashLanguage = /^(api|manual|examples)\/(en|ar|ko|zh|ja|it|pt-br|fr|ru)\//.exec( hash );

				if ( hashLanguage === null ) {

					// Route old non-localised api links

					window.location.hash = hash.replace( /^(api|manual|examples)/, '$1/en' );

				} else {

					language = hashLanguage[ 2 ];

				}

			}

			const languageSelect = document.getElementById( 'language' );
			languageSelect.value = language;
			languageSelect.addEventListener( 'change', function () {

				setLanguage( this.value );

			} );

			function setLanguage( value ) {

				language = value;

				createNavigation( list, language );
				updateFilter();
				autoChangeUrlLanguage( language );

			}

			// Functionality for hamburger button (on small devices)

			expandButton.onclick = function ( event ) {

				event.preventDefault();
				panel.classList.toggle( 'open' );

			};

			panelScrim.onclick = function ( event ) {

				event.preventDefault();
				panel.classList.toggle( 'open' );

			};


			// Functionality for search/filter input field

			filterInput.onfocus = function () {

				panel.classList.add( 'searchFocused' );

			};

			filterInput.onblur = function () {

				if ( filterInput.value === '' ) {

					panel.classList.remove( 'searchFocused' );

				}

			};

			filterInput.oninput = function () {

				updateFilter();

			};

			clearSearchButton.onclick = function () {

				filterInput.value = '';
				updateFilter();
				filterInput.focus();

			};

			// Activate content and title change on browser navigation

			window.onpopstate = createNewIframe;

			// Create the navigation panel and configure the iframe

			createNavigation( list, language );
			createNewIframe();

			// Handle search query

			filterInput.value = extractQuery();

			if ( filterInput.value !== '' ) {

				panel.classList.add( 'searchFocused' );

				updateFilter();

			} else {

				updateLink( '' );

			}

		}

		// Navigation Panel

		function createLink( pageName, pageURL ) {

			const link = document.createElement( 'a' );
			link.href = pageURL + '.html';
			link.textContent = pageName;
			link.setAttribute( 'target', 'viewer' );
			link.addEventListener( 'click', function ( event ) {

				if ( event.button !== 0 || event.ctrlKey || event.altKey || event.metaKey ) return;

				window.location.hash = pageURL;
				panel.classList.remove( 'open' );


				content.querySelectorAll( 'a' ).forEach( function ( item ) {

					item.classList.remove( 'selected' );

				} );

				link.classList.add( 'selected' );

			} );

			return link;

		}

		function createNavigation( list, language ) {

			if ( navigation !== undefined ) {

				content.removeChild( navigation );

			}

			// Create the navigation panel using data from list.js

			navigation = document.createElement( 'div' );
			content.appendChild( navigation );

			if ( language === 'ar' ) {

				navigation.style.direction = 'rtl';

			}

			const localList = list[ language ];
			const selectedPage = window.location.hash.substring( 1 );

			for ( const section in localList ) {

				// Create sections

				const categories = localList[ section ];

				const sectionHead = document.createElement( 'h2' );
				sectionHead.textContent = section;
				navigation.appendChild( sectionHead );

				for ( const category in categories ) {

					// Create categories

					const pages = categories[ category ];

					const categoryContainer = document.createElement( 'div' );
					navigation.appendChild( categoryContainer );

					const categoryHead = document.createElement( 'h3' );
					categoryHead.textContent = category;
					categoryContainer.appendChild( categoryHead );

					const categoryContent = document.createElement( 'ul' );
					categoryContainer.appendChild( categoryContent );

					for ( const pageName in pages ) {

						// Create page links

						const pageURL = pages[ pageName ];

						// Localisation

						const listElement = document.createElement( 'li' );
						categoryContent.appendChild( listElement );

						const linkElement = createLink( pageName, pageURL );
						listElement.appendChild( linkElement );

						// select current page

						if ( pageURL === selectedPage ) {

							linkElement.classList.add( 'selected' );

						}

						// Gather the main properties for the current subpage

						pageProperties[ pageName ] = {
							section: section,
							category: category,
							pageURL: pageURL,
							linkElement: linkElement
						};

						// Gather the document titles (used for easy access on browser navigation)

						titles[ pageURL ] = pageName;

					}

					// Gather the category elements for easy access on filtering

					categoryElements.push( categoryContent );

				}

			}

		}

		// Auto change language url. If a reader open a document in English, when they click "zh", the document they read will auto change into Chinese version

		function autoChangeUrlLanguage( language ) {

			const hash = location.hash;
			if ( hash === '' ) return;
			const docType = hash.slice( 0, hash.indexOf( '/' ) + 1 );
			let docLink = hash.slice( hash.indexOf( '/' ) + 1 );
			docLink = docLink.slice( docLink.indexOf( '/' ) );
			location.href = docType + language + docLink;

		}

		// Filtering

		function extractQuery() {

			const search = window.location.search;

			if ( search.indexOf( '?q=' ) !== - 1 ) {

				return decodeURI( search.slice( 3 ) );

			}

			return '';

		}

		function escapeRegExp( string ) {

			string = string.replace( /[.*+?^${}()|[\]\\]/g, '\\$&' ); // https://stackoverflow.com/a/6969486/5250847

			return '(?=.*' + string.split( ' ' ).join( ')(?=.*' ) + ')'; // match all words, in any order

		}

		function updateFilter() {

			let v = filterInput.value.trim();
			v = v.replace( /\s+/gi, ' ' ); // replace multiple whitespaces with a single one

			if ( v !== '' ) {

				window.history.replaceState( {}, '', '?q=' + v + window.location.hash );

			} else {

				window.history.replaceState( {}, '', window.location.pathname + window.location.hash );

			}

			//

			const regExp = new RegExp( escapeRegExp( v ), 'gi' );

			for ( let pageName in pageProperties ) {

				const linkElement = pageProperties[ pageName ].linkElement;
				const categoryClassList = linkElement.parentElement.classList;
				const filterResults = pageName.match( regExp );

				if ( filterResults !== null && filterResults.length > 0 ) {

					pageName = pageName.replaceAll( regExp, '<b>$&</b>' );

					categoryClassList.remove( 'hidden' );
					linkElement.innerHTML = pageName;

				} else {

					// Hide all non-matching page names

					categoryClassList.add( 'hidden' );

				}

			}

			displayFilteredPanel();

			updateLink( v );

		}

		function updateLink( search ) {

			// update examples link

			if ( search ) {

				const link = sectionLink.href.split( /[?#]/ )[ 0 ];
				sectionLink.href = `${link}?q=${search}`;

			} else {

				sectionLink.href = sectionDefaultHref;

			}

		}

		function displayFilteredPanel() {

			// Show/hide categories depending on their content
			// First check if at least one page in this category is not hidden

			categoryElements.forEach( function ( category ) {

				const pages = category.children;
				const pagesLength = pages.length;
				const sectionClassList = category.parentElement.classList;

				let hideCategory = true;

				for ( let i = 0; i < pagesLength; i ++ ) {

					const pageClassList = pages[ i ].classList;

					if ( ! pageClassList.contains( 'hidden' ) ) {

						hideCategory = false;

					}

				}

				// If and only if all page names are hidden, hide the whole category

				if ( hideCategory ) {

					sectionClassList.add( 'hidden' );

				} else {

					sectionClassList.remove( 'hidden' );

				}

			} );

		}

		// Routing

		function setUrlFragment( pageName ) { // eslint-disable-line no-unused-vars

			// Handle navigation from the subpages (iframes):
			// First separate the member (if existing) from the page name,
			// then identify the subpage's URL and set it as URL fragment (re-adding the member)

			const pageURL = getPageURL( pageName );

			if ( pageURL ) {

				window.location.hash = pageURL;

				createNewIframe();

			}

		}

		function getPageURL( pageName ) {

			const splitPageName = decomposePageName( pageName, '.', '.' );

			const currentProperties = pageProperties[ splitPageName[ 0 ] ];

			if ( currentProperties ) {

				return currentProperties.pageURL + splitPageName[ 1 ];
		
			} else {

				return null;
		
			}

		}

		function createNewIframe() {

			// Change the content displayed in the iframe
			// First separate the member part of the fragment (if existing)

			const hash = window.location.hash.substring( 1 );
			const splitHash = decomposePageName( hash, '.', '#' );

			// Creating a new Iframe instead of assigning a new src is
			// a cross-browser solution to allow normal browser navigation;
			// - only assigning a new src would result in two history states each time.

			// Note: iframe.contentWindow.location.replace(hash) should work, too,
			// but it doesn't work in Edge with links from the subpages!

			let subtitle;

			const oldIframe = iframe;
			iframe = oldIframe.cloneNode();

			if ( hash && titles[ splitHash[ 0 ] ] ) {

				iframe.src = splitHash[ 0 ] + '.html' + splitHash[ 1 ];
				subtitle = titles[ splitHash[ 0 ] ] + splitHash[ 1 ] + ' – ';
				iframe.style.display = 'unset';

			} else {

				iframe.src = '';
				subtitle = '';
				iframe.style.display = 'none';

			}

			document.body.replaceChild( iframe, oldIframe );
			document.title = subtitle + 'three.js docs';

		}

		function decomposePageName( pageName, oldDelimiter, newDelimiter ) {

			// Helper function for separating the member (if existing) from the pageName
			// For example: 'Geometry.morphTarget' can be converted to
			// ['Geometry', '.morphTarget'] or ['Geometry', '#morphTarget']
			// Note: According RFC 3986 no '#' allowed inside of an URL fragment!

			let parts = [];

			const dotIndex = pageName.indexOf( oldDelimiter );

			if ( dotIndex !== - 1 ) {

				parts = pageName.split( oldDelimiter );
				parts[ 1 ] = newDelimiter + parts[ 1 ];

			} else {

				parts[ 0 ] = pageName;
				parts[ 1 ] = '';

			}

			return parts;

		}

		//

		console.log( [
			'    __     __',
			' __/ __\\  / __\\__   ____   _____   _____',
			'/ __/  /\\/ /  /___\\/ ____\\/ _____\\/ _____\\',
			'\\/_   __/ /   _   / /  __/ / __  / / __  /_   __   _____',
			'/ /  / / /  / /  / /  / / /  ___/ /  ___/\\ _\\/ __\\/ _____\\',
			'\\/__/  \\/__/\\/__/\\/__/  \\/_____/\\/_____/\\/__/ /  / /  ___/',
			'                                         / __/  /  \\__  \\',
			'                                         \\/____/\\/_____/'
		].join( '\n' ) );

		</script>

	</body>

</html>