Skip to content

T
three.js

Ablesons / three.js
与 Fork 源项目一致

从无法访问的项目Fork

通知 2
Star 0
Fork 0
T
three.js

体验新版 GitCode，发现更多精彩内容 >>

提交 5b98771a 编写于 作者: V Vincent Lark
浏览文件
操作

new docs for some loaders

上级 040d1621
隐藏空白更改
内联 并排
Showing with 423 addition and 1 deletion
docs/api/loaders/OBJMTLLoader.html 0 → 100644
浏览文件 @ 5b98771a
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8" />
<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">A loader for loading a <em>.obj</em> and its <em>.mtl</em> together.</div>
<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].
</div>
<div>
Creates a new [name].
</div>
<h2>Properties</h2>
<h2>Methods</h2>
<h3>[method:null load]( [page:String objUrl], [page:String mtlUrl], [page:Function onLoad], [page:Function onProgress], [page:Function onError] )</h3>
<div>
[page:String objUrl] — required. URL to the <em>.obj</em> resource<br />
[page:String mtlUrl] — required. URL to the <em>.mtl</em> resource<br />
[page:Function onLoad] — Will be called when both resources load complete. The argument will be the loaded [page:Object3D].<br />
[page:Function onProgress] — Will be called while both load progress. The argument will be the XmlHttpRequest instance, that contain .[page:int total] and .[page:int loaded] bytes.<br />
[page:Function onError] — Will be called when load errors.<br />
</div>
<div>
Begin loading from urls and call onLoad with the parsed response content.
</div>
<h3>[method:Object3D parse]( [page:String text], [page:Function mtllibCallback] )</h3>
<div>
[page:String text] — required. The textual <em>obj</em> structure to parse.<br/>
[page:Function mtllibCallback] — optional. Callback to handle <em>mtllib</em> declaration.<br/>
</div>
<div>
Parse an <em>obj</em> text structure and return an [page:Object3D].<br />
Found objects are converted to [page:Mesh] with a [page:BufferGeometry] and materials are converted to [page:MeshLambertMaterial].
</div>
<h2>Example</h2>
<code>
// instantiate a loader
var loader = new THREE.OBJMTLLoader();
// load an obj / mtl resource pair
loader.load(
// OBJ resource URL
'obj/male02/male02.obj',
// MTL resource URL
'obj/male02/male02_dds.mtl',
// Function when both resources are loaded
function ( object ) {
scene.add( object );
},
// Function called when downloads progress
function ( xhr ) {
console.log( (xhr.loaded / xhr.total * 100) + '% loaded' );
},
// Function called when downloads error
function ( xhr ) {
console.log( 'An error happened' );
}
);
</code>
[example:webgl_loader_obj_mtl]
<h2>Source</h2>
[link:https://github.com/mrdoob/three.js/blob/master/examples/js/loaders/OBJMTLLoader.js examples/js/loaders/OBJMTLLoader.js]
</body>
</html>
docs/api/loaders/PDBLoader.html 0 → 100644
浏览文件 @ 5b98771a
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8" />
<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">A loader for loading a <em>.pdb</em> resource.<br />
The <a href="http://en.wikipedia.org/wiki/Protein_Data_Bank_(file_format)">Protein Data Bank file format</a> is a textual file format describing the three-dimensional structures of molecules.</div>
<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].
</div>
<div>
Creates a new [name].
</div>
<h2>Properties</h2>
<h2>Methods</h2>
<h3>[method:null load]( [page:String url], [page:Function onLoad], [page:Function onProgress], [page:Function onError] )</h3>
<div>
[page:String url] — required. URL to the <em>.pdb</em> file<br />
[page:Function onLoad] — Will be called when load completes. The arguments will be an [page:Geometry geometryAtoms], [page:Geometry geometryBonds] and the [page:Object JSON] structure.<br />
[page:Function onProgress] — Will be called while load progresses. The argument will be the XmlHttpRequest instance, that contain .[page:Integer total] and .[page:Integer loaded] bytes.<br />
[page:Function onError] — Will be called when load errors.<br />
</div>
<div>
Begin loading from url and call onLoad with the parsed response content.
</div>
<h3>[method:Object parsePDB]( [page:String text] )</h3>
<div>
[page:String text] — The textual <em>pdb</em> structure to parse.
</div>
<div>
Parse a <em>pdb</em> text and return a <em>JSON</em> structure.<br />
</div>
<h3>[method:null createModel]( [page:Object json], [page:Function callback] )</h3>
<div>
[page:Object json] — The <em>(JSON) pdb</em> structure to parse.<br />
[page:Function callback] — Will be called when parse completes, with three arguments: [page:Geometry geometryAtoms], [page:Geometry geometryBonds] and the original [page:Object json].<br />
</div>
<div>
Parse a <em>(JSON) pdb</em> structure and return two [page:Geometry]: one for atoms, one for bonds.<br />
</div>
<h2>Example</h2>
<code>
// instantiate a loader
var loader = new THREE.PDBLoader();
// load a PDB resource
loader.load(
// resource URL
'models/molecules/caffeine.pdb',
// Function when resource is loaded
function ( geometryAtoms, geometryBonds, json ) {
console.log( 'This molecule has ' + json.atoms.length + ' atoms' );
},
// 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>
[example:webgl_loader_pdb]
<h2>Source</h2>
[link:https://github.com/mrdoob/three.js/blob/master/examples/js/loaders/PDBLoader.js examples/js/loaders/PDBLoader.js]
</body>
</html>
docs/api/loaders/SVGLoader.html 0 → 100644
浏览文件 @ 5b98771a
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8" />
<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">A loader for loading an <em>.svg</em> resource.</div>
<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].
</div>
<div>
Creates a new [name].
</div>
<h2>Properties</h2>
<h2>Methods</h2>
<h3>[method:null load]( [page:String url], [page:Function onLoad], [page:Function onProgress], [page:Function onError] )</h3>
<div>
[page:String url] — required<br />
[page:Function onLoad] — Will be called when load completes. The argument will be the loaded [page:SVGDocument].<br />
[page:Function onProgress] — Will be called while load progresses. The argument will be the XmlHttpRequest instance, that contain .[page:int total] and .[page:int loaded] bytes.<br />
[page:Function onError] — Will be called when load errors.<br />
</div>
<div>
Begin loading from url and call onLoad with the response content.
</div>
<h2>Source</h2>
[link:https://github.com/mrdoob/three.js/blob/master/examples/js/loaders/SVGLoader.js examples/js/loaders/SVGLoader.js]
</body>
</html>
docs/api/loaders/SceneLoader.html 0 → 100644
浏览文件 @ 5b98771a
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8" />
<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">A loader for loading a [page:Scene] from a <em>JSON</em> resource.</div>
<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].
</div>
<div>
Creates a new [name].
</div>
<h2>Properties</h2>
<h2>Methods</h2>
<h3>[method:null load]( [page:String url], [page:Function onLoad], [page:Function onProgress], [page:Function onError] )</h3>
<div>
[page:String url] — required<br />
[page:Function onLoad] — Will be called when load completes. The argument will be an [page:Object] containing the loaded components.<br />
[page:Function onProgress] — Will be called while load progresses. The argument will be the XmlHttpRequest instance, that contain .[page:int total] and .[page:int loaded] bytes.<br />
[page:Function onError] — Will be called when load errors.<br />
</div>
<div>
Begin loading from url and call onLoad with the parsed scene.
</div>
<h3>[method:Object parse]( [page:Object json], [page:Function callbackFinished], [page:String url] )</h3>
<div>
[page:Object json] — The <em>JSON</em> structure to parse.<br />
[page:Function callbackFinished] — Will be called when parse completes.<br />
[page:String url] — Will be used as base for assets' relative URLs.<br />
</div>
<div>
Parse a <em>JSON</em> scene description and return a new [page:Object] with fully instantiated Three.js objects.
</div>
<h3>[method:null setCrossOrigin]( [page:String value] )</h3>
<div>
[page:String value] — The crossOrigin string to implement CORS for loading the url from a different domain that allows CORS.
</div>
<h3>[method:null addGeometryHandler]( [page:String typeID], [page:Function loaderClass] )</h3>
<div>
[page:String typeID] — The type to handle.<br />
[page:Function loaderClass] — The handler class.<br />
</div>
<div>
Add an handler for a specific geometry type.
</div>
<h3>[method:null addHierarchyHandler]( [page:String typeID], [page:Function loaderClass] )</h3>
<div>
[page:String typeID] — The type to handle.<br />
[page:Function loaderClass] — The handler class.<br />
</div>
<div>
Add an handler for a specific object type.
</div>
<h2>Example</h2>
<code>
// instantiate a loader
var loader = new THREE.SceneLoader();
// Handle STL geometries
loader.addGeometryHandler( "stl", THREE.STLLoader );
// Handle OBJ objects
loader.addHierarchyHandler( "obj", THREE.OBJLoader );
// load a JSON resource
loader.load(
// resource URL
'scenes/test_scene.js',
// Function when resource is loaded
function ( result ) {
scene.add( result.scene );
},
// 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>
[example:webgl_loader_scene]
<h2>Source</h2>
[link:https://github.com/mrdoob/three.js/blob/master/examples/js/loaders/SceneLoader.js examples/js/loaders/SceneLoader.js]
</body>
</html>
docs/api/loaders/TGALoader.html 0 → 100644
浏览文件 @ 5b98771a
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8" />
<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 <em>.tga</em> [page:DataTexture texture].</div>
<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].
</div>
<div>
Creates a new [name].
</div>
<h2>Methods</h2>
<h3>[method:DataTexture load]( [page:String url], [page:Function onLoad], [page:Function onProgress], [page:Function onError] )</h3>
<div>
[page:String url] — required<br />
[page:Function onLoad] — Will be called when load completes. The argument will be the loaded [page:DataTexture].<br />
[page:Function onProgress] — Will be called while load progresses. The argument will be the XmlHttpRequest instance, that contain .[page:Integer total] and .[page:Integer loaded] bytes.<br />
[page:Function onError] — Will be called when load errors.<br />
</div>
<div>
Begin loading from url and pass the loaded [page:DataTexture texture] to onLoad. The [page:DataTexture texture] is also directly returned for immediate use (but may not be fully loaded).
</div>
<h2>Example</h2>
<code>
// instantiate a loader
var loader = new THREE.TGALoader();
// load a resource
var texture = loader.load(
// resource URL
'textures/crate_grey8.tga'
// Function when resource is loaded
function ( texture ) {
console.log( 'Texture is loaded' );
},
// 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' );
}
);
var material = new THREE.MeshPhongMaterial( {
color: 0xffffff,
map: texture
} );
</code>
[example:webgl_materials_texture_tga]
<h2>Source</h2>
[link:https://github.com/mrdoob/three.js/blob/master/examples/js/loaders/TGALoader.js examples/js/loaders/TGALoader.js]
</body>
</html>
docs/list.js
浏览文件 @ 5b98771a
......@@ -54,10 +54,15 @@ var list = {
[ "Loader", "api/loaders/Loader" ],
[ "LoadingManager", "api/loaders/LoadingManager" ],
[ "MaterialLoader", "api/loaders/MaterialLoader" ],
[ "OBJLoader", "api/loaders/OBJLoader" ],
[ "MTLLoader", "api/loaders/MTLLoader" ],
[ "OBJLoader", "api/loaders/OBJLoader" ],
[ "OBJMTLLoader", "api/loaders/OBJMTLLoader" ],
[ "ObjectLoader", "api/loaders/ObjectLoader" ],
[ "PDBLoader", "api/loaders/PDBLoader" ],
[ "SVGLoader", "api/loaders/SVGLoader" ],
[ "SceneLoader", "api/loaders/SceneLoader" ],
[ "TextureLoader", "api/loaders/TextureLoader" ],
[ "TGALoader", "api/loaders/TGALoader" ],
[ "XHRLoader", "api/loaders/XHRLoader" ]
],
......
Markdown is supported
0% 或 .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑！
想要评论请 注册 或