javascript
/
three.js
mirror of https://github.com/tazdij/three.js.git


			
				
					
						
						
							12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697
							<!DOCTYPE html>
<html lang="en">
	<head>
		<meta charset="utf-8" />
		<base href="../../" />
		<script src="list.js"></script>
		<script src="page.js"></script>
		<link type="text/css" rel="stylesheet" href="page.css" />
	</head>
	<body>
		<h1>[name]</h1>

		<div class="desc">
		Class for loading a font in JSON format. Returns a [page:Font Font], which is an
		array of [page:Shape Shape]s representing the font.
		This uses the [page:FileLoader] internally for loading files. <br /><br />

		You can convert fonts online using [link:https://gero3.github.io/facetype.js/ facetype.js]
		</div>

		<h2>Examples</h2>

		<div>
		[example:webgl_geometry_text_shapes geometry / text / shapes ]<br/>
		[example:webgl_geometry_text geometry / text ]<br />
		[example:webgl_geometry_text_pnltri geometry / text / pnltri]<br />
		</div>

		<code>
		var loader = new THREE.FontLoader();
		var font = loader.load(
			// resource URL
			'fonts/helvetiker_bold.typeface.json'
			// Function when resource is loaded
			function ( font ) {
				// do something with the font
				scene.add( font );
			},
			// Function called when download progresses
			function ( xhr ) {
				console.log( (xhr.loaded / xhr.total * 100) + '% loaded' );
			},
			// Function called when download errors
			function ( xhr ) {
				console.log( 'An error happened' );
			}
		);
		</code>

		<h2>Constructor</h2>

		<h3>[name]( [page:LoadingManager manager] )</h3>
		<div>
		[page:LoadingManager manager] — The [page:LoadingManager loadingManager] for the loader to use. Default is [page:LoadingManager THREE.DefaultLoadingManager].<br /><br />
		Creates a new [name].
		</div>

		<h2>Properties</h2>

		<h3>[property:LoadingManager manager]</h3>
		<div>
			The [page:LoadingManager loadingManager] the loader is using. Default is [page:DefaultLoadingManager].
		</div>

		<h3>[property:String path]</h3>
		<div>The base path from which fonts will be loaded. See [page:.setPath]. Default is *undefined*.</div>

		<h2>Methods</h2>

		<h3>[method:null load]( [page:String url], [page:Function onLoad], [page:Function onProgress], [page:Function onError] )</h3>
		<div>
		[page:String url] — the path or URL to the file. This can also be a
			[link:https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/Data_URIs Data URI].<br />
		[page:Function onLoad] — Will be called when load completes. The argument will be the loaded [page:Texture texture].<br />
		[page:Function onProgress] — Will be called while load progresses. The argument will be the XMLHttpRequest instance, which contains .[page:Integer total] and .[page:Integer loaded] bytes.<br />
		[page:Function onError] — Will be called when load errors.<br /><br />

		Begin loading from url and pass the loaded [page:Texture texture] to onLoad.
		</div>

		<h3>[method:Font parse]( [page:Object json] )</h3>
		<div>
		[page:Object json] — The <em>JSON</em> structure to parse.<br /><br />
		Parse a <em>JSON</em> structure and return a [page:Font].
		</div>

		<h3>[method:FontLoader setPath]( [page:String path] )</h3>
		<div>
			Set the base path or URL from which to load fonts. This can be useful if
			you are loading many fonts from the same directory.
		</div>

		<h2>Source</h2>

		[link:https://github.com/mrdoob/three.js/blob/master/src/[path].js src/[path].js]
	</body>
</html>