123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110 |
- <!DOCTYPE html>
- <html lang="en">
- <head>
- <meta charset="utf-8" />
- <base href="../../../" />
- <script src="page.js"></script>
- <link type="text/css" rel="stylesheet" href="page.css" />
- </head>
- <body>
- [page:Loader] →
- <h1>[name]</h1>
- <p class="desc">A loader for loading a `.pdb` resource.<br>
- The [link:http://en.wikipedia.org/wiki/Protein_Data_Bank_(file_format) Protein Data Bank] file format is a textual file describing the three-dimensional structures of molecules.
- </p>
- <h2>Import</h2>
- <p>
- [name] is an add-on, and must be imported explicitly.
- See [link:#manual/introduction/Installation Installation / Addons].
- </p>
- <code>
- import { PDBLoader } from 'three/addons/loaders/PDBLoader.js';
- </code>
- <h2>Code Example</h2>
- <code>
- // instantiate a loader
- const loader = new PDBLoader();
- // load a PDB resource
- loader.load(
- // resource URL
- 'models/pdb/caffeine.pdb',
- // called when the resource is loaded
- function ( pdb ) {
- const geometryAtoms = pdb.geometryAtoms;
- const geometryBonds = pdb.geometryBonds;
- const json = pdb.json;
- console.log( 'This molecule has ' + json.atoms.length + ' atoms' );
- },
- // called when loading is in progresses
- function ( xhr ) {
- console.log( ( xhr.loaded / xhr.total * 100 ) + '% loaded' );
- },
- // called when loading has errors
- function ( error ) {
- console.log( 'An error happened' );
- }
- );
- </code>
- <h2>Examples</h2>
- <p>
- [example:webgl_loader_pdb]
- </p>
- <h2>Constructor</h2>
- <h3>[name]( [param:LoadingManager manager] )</h3>
- <p>
- [page:LoadingManager manager] — The [page:LoadingManager loadingManager] for the loader to use. Default is [page:LoadingManager THREE.DefaultLoadingManager].
- </p>
- <p>
- Creates a new [name].
- </p>
- <h2>Properties</h2>
- <p>See the base [page:Loader] class for common properties.</p>
- <h2>Methods</h2>
- <p>See the base [page:Loader] class for common methods.</p>
- <h3>[method:undefined load]( [param:String url], [param:Function onLoad], [param:Function onProgress], [param:Function onError] )</h3>
- <p>
- [page:String url] — A string containing the path/URL of the `.pdb` file.<br />
- [page:Function onLoad] — (optional) A function to be called after loading is successfully completed. The function receives the object having the following properties. [page:BufferGeometry geometryAtoms], [page:BufferGeometry geometryBonds] and the [page:Object JSON] structure.<br />
- [page:Function onProgress] — (optional) A function to be called while the loading is in progress. The argument will be the XMLHttpRequest instance, which contains [page:Integer total] and [page:Integer loaded] bytes. If the server does not set the Content-Length header; .[page:Integer total] will be 0.<br />
- [page:Function onError] — (optional) A function to be called if an error occurs during loading. The function receives the error as an argument.<br />
- </p>
- <p>
- Begin loading from url and call onLoad with the parsed response content.
- </p>
- <h3>[method:Object parse]( [param:String text] )</h3>
- <p>
- [page:String text] — The textual `pdb` structure to parse.
- </p>
- <p>
- Parse a `pdb` text and return a `JSON` structure.<br />
- </p>
- <h2>Source</h2>
- <p>
- [link:https://github.com/mrdoob/three.js/blob/master/examples/jsm/loaders/PDBLoader.js examples/jsm/loaders/PDBLoader.js]
- </p>
- </body>
- </html>
|