PLYLoader.js 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524
  1. import {
  2. BufferGeometry,
  3. FileLoader,
  4. Float32BufferAttribute,
  5. Loader,
  6. LoaderUtils
  7. } from "../../../build/three.module.js";
  8. /**
  9. * Description: A THREE loader for PLY ASCII files (known as the Polygon
  10. * File Format or the Stanford Triangle Format).
  11. *
  12. * Limitations: ASCII decoding assumes file is UTF-8.
  13. *
  14. * Usage:
  15. * var loader = new PLYLoader();
  16. * loader.load('./models/ply/ascii/dolphins.ply', function (geometry) {
  17. *
  18. * scene.add( new THREE.Mesh( geometry ) );
  19. *
  20. * } );
  21. *
  22. * If the PLY file uses non standard property names, they can be mapped while
  23. * loading. For example, the following maps the properties
  24. * “diffuse_(red|green|blue)” in the file to standard color names.
  25. *
  26. * loader.setPropertyNameMapping( {
  27. * diffuse_red: 'red',
  28. * diffuse_green: 'green',
  29. * diffuse_blue: 'blue'
  30. * } );
  31. *
  32. */
  33. var PLYLoader = function ( manager ) {
  34. Loader.call( this, manager );
  35. this.propertyNameMapping = {};
  36. };
  37. PLYLoader.prototype = Object.assign( Object.create( Loader.prototype ), {
  38. constructor: PLYLoader,
  39. load: function ( url, onLoad, onProgress, onError ) {
  40. var scope = this;
  41. var loader = new FileLoader( this.manager );
  42. loader.setPath( this.path );
  43. loader.setResponseType( 'arraybuffer' );
  44. loader.setRequestHeader( this.requestHeader );
  45. loader.load( url, function ( text ) {
  46. try {
  47. onLoad( scope.parse( text ) );
  48. } catch ( e ) {
  49. if ( onError ) {
  50. onError( e );
  51. } else {
  52. console.error( e );
  53. }
  54. scope.manager.itemError( url );
  55. }
  56. }, onProgress, onError );
  57. },
  58. setPropertyNameMapping: function ( mapping ) {
  59. this.propertyNameMapping = mapping;
  60. },
  61. parse: function ( data ) {
  62. function parseHeader( data ) {
  63. var patternHeader = /ply([\s\S]*)end_header\r?\n/;
  64. var headerText = '';
  65. var headerLength = 0;
  66. var result = patternHeader.exec( data );
  67. if ( result !== null ) {
  68. headerText = result[ 1 ];
  69. headerLength = result[ 0 ].length;
  70. }
  71. var header = {
  72. comments: [],
  73. elements: [],
  74. headerLength: headerLength
  75. };
  76. var lines = headerText.split( '\n' );
  77. var currentElement;
  78. var lineType, lineValues;
  79. function make_ply_element_property( propertValues, propertyNameMapping ) {
  80. var property = { type: propertValues[ 0 ] };
  81. if ( property.type === 'list' ) {
  82. property.name = propertValues[ 3 ];
  83. property.countType = propertValues[ 1 ];
  84. property.itemType = propertValues[ 2 ];
  85. } else {
  86. property.name = propertValues[ 1 ];
  87. }
  88. if ( property.name in propertyNameMapping ) {
  89. property.name = propertyNameMapping[ property.name ];
  90. }
  91. return property;
  92. }
  93. for ( var i = 0; i < lines.length; i ++ ) {
  94. var line = lines[ i ];
  95. line = line.trim();
  96. if ( line === '' ) continue;
  97. lineValues = line.split( /\s+/ );
  98. lineType = lineValues.shift();
  99. line = lineValues.join( ' ' );
  100. switch ( lineType ) {
  101. case 'format':
  102. header.format = lineValues[ 0 ];
  103. header.version = lineValues[ 1 ];
  104. break;
  105. case 'comment':
  106. header.comments.push( line );
  107. break;
  108. case 'element':
  109. if ( currentElement !== undefined ) {
  110. header.elements.push( currentElement );
  111. }
  112. currentElement = {};
  113. currentElement.name = lineValues[ 0 ];
  114. currentElement.count = parseInt( lineValues[ 1 ] );
  115. currentElement.properties = [];
  116. break;
  117. case 'property':
  118. currentElement.properties.push( make_ply_element_property( lineValues, scope.propertyNameMapping ) );
  119. break;
  120. default:
  121. console.log( 'unhandled', lineType, lineValues );
  122. }
  123. }
  124. if ( currentElement !== undefined ) {
  125. header.elements.push( currentElement );
  126. }
  127. return header;
  128. }
  129. function parseASCIINumber( n, type ) {
  130. switch ( type ) {
  131. case 'char': case 'uchar': case 'short': case 'ushort': case 'int': case 'uint':
  132. case 'int8': case 'uint8': case 'int16': case 'uint16': case 'int32': case 'uint32':
  133. return parseInt( n );
  134. case 'float': case 'double': case 'float32': case 'float64':
  135. return parseFloat( n );
  136. }
  137. }
  138. function parseASCIIElement( properties, line ) {
  139. var values = line.split( /\s+/ );
  140. var element = {};
  141. for ( var i = 0; i < properties.length; i ++ ) {
  142. if ( properties[ i ].type === 'list' ) {
  143. var list = [];
  144. var n = parseASCIINumber( values.shift(), properties[ i ].countType );
  145. for ( var j = 0; j < n; j ++ ) {
  146. list.push( parseASCIINumber( values.shift(), properties[ i ].itemType ) );
  147. }
  148. element[ properties[ i ].name ] = list;
  149. } else {
  150. element[ properties[ i ].name ] = parseASCIINumber( values.shift(), properties[ i ].type );
  151. }
  152. }
  153. return element;
  154. }
  155. function parseASCII( data, header ) {
  156. // PLY ascii format specification, as per http://en.wikipedia.org/wiki/PLY_(file_format)
  157. var buffer = {
  158. indices: [],
  159. vertices: [],
  160. normals: [],
  161. uvs: [],
  162. faceVertexUvs: [],
  163. colors: []
  164. };
  165. var result;
  166. var patternBody = /end_header\s([\s\S]*)$/;
  167. var body = '';
  168. if ( ( result = patternBody.exec( data ) ) !== null ) {
  169. body = result[ 1 ];
  170. }
  171. var lines = body.split( '\n' );
  172. var currentElement = 0;
  173. var currentElementCount = 0;
  174. for ( var i = 0; i < lines.length; i ++ ) {
  175. var line = lines[ i ];
  176. line = line.trim();
  177. if ( line === '' ) {
  178. continue;
  179. }
  180. if ( currentElementCount >= header.elements[ currentElement ].count ) {
  181. currentElement ++;
  182. currentElementCount = 0;
  183. }
  184. var element = parseASCIIElement( header.elements[ currentElement ].properties, line );
  185. handleElement( buffer, header.elements[ currentElement ].name, element );
  186. currentElementCount ++;
  187. }
  188. return postProcess( buffer );
  189. }
  190. function postProcess( buffer ) {
  191. var geometry = new BufferGeometry();
  192. // mandatory buffer data
  193. if ( buffer.indices.length > 0 ) {
  194. geometry.setIndex( buffer.indices );
  195. }
  196. geometry.setAttribute( 'position', new Float32BufferAttribute( buffer.vertices, 3 ) );
  197. // optional buffer data
  198. if ( buffer.normals.length > 0 ) {
  199. geometry.setAttribute( 'normal', new Float32BufferAttribute( buffer.normals, 3 ) );
  200. }
  201. if ( buffer.uvs.length > 0 ) {
  202. geometry.setAttribute( 'uv', new Float32BufferAttribute( buffer.uvs, 2 ) );
  203. }
  204. if ( buffer.colors.length > 0 ) {
  205. geometry.setAttribute( 'color', new Float32BufferAttribute( buffer.colors, 3 ) );
  206. }
  207. if ( buffer.faceVertexUvs.length > 0 ) {
  208. geometry = geometry.toNonIndexed();
  209. geometry.setAttribute( 'uv', new Float32BufferAttribute( buffer.faceVertexUvs, 2 ) );
  210. }
  211. geometry.computeBoundingSphere();
  212. return geometry;
  213. }
  214. function handleElement( buffer, elementName, element ) {
  215. if ( elementName === 'vertex' ) {
  216. buffer.vertices.push( element.x, element.y, element.z );
  217. if ( 'nx' in element && 'ny' in element && 'nz' in element ) {
  218. buffer.normals.push( element.nx, element.ny, element.nz );
  219. }
  220. if ( 's' in element && 't' in element ) {
  221. buffer.uvs.push( element.s, element.t );
  222. }
  223. if ( 'red' in element && 'green' in element && 'blue' in element ) {
  224. buffer.colors.push( element.red / 255.0, element.green / 255.0, element.blue / 255.0 );
  225. }
  226. } else if ( elementName === 'face' ) {
  227. var vertex_indices = element.vertex_indices || element.vertex_index; // issue #9338
  228. var texcoord = element.texcoord;
  229. if ( vertex_indices.length === 3 ) {
  230. buffer.indices.push( vertex_indices[ 0 ], vertex_indices[ 1 ], vertex_indices[ 2 ] );
  231. if ( texcoord && texcoord.length === 6 ) {
  232. buffer.faceVertexUvs.push( texcoord[ 0 ], texcoord[ 1 ] );
  233. buffer.faceVertexUvs.push( texcoord[ 2 ], texcoord[ 3 ] );
  234. buffer.faceVertexUvs.push( texcoord[ 4 ], texcoord[ 5 ] );
  235. }
  236. } else if ( vertex_indices.length === 4 ) {
  237. buffer.indices.push( vertex_indices[ 0 ], vertex_indices[ 1 ], vertex_indices[ 3 ] );
  238. buffer.indices.push( vertex_indices[ 1 ], vertex_indices[ 2 ], vertex_indices[ 3 ] );
  239. }
  240. }
  241. }
  242. function binaryRead( dataview, at, type, little_endian ) {
  243. switch ( type ) {
  244. // corespondences for non-specific length types here match rply:
  245. case 'int8': case 'char': return [ dataview.getInt8( at ), 1 ];
  246. case 'uint8': case 'uchar': return [ dataview.getUint8( at ), 1 ];
  247. case 'int16': case 'short': return [ dataview.getInt16( at, little_endian ), 2 ];
  248. case 'uint16': case 'ushort': return [ dataview.getUint16( at, little_endian ), 2 ];
  249. case 'int32': case 'int': return [ dataview.getInt32( at, little_endian ), 4 ];
  250. case 'uint32': case 'uint': return [ dataview.getUint32( at, little_endian ), 4 ];
  251. case 'float32': case 'float': return [ dataview.getFloat32( at, little_endian ), 4 ];
  252. case 'float64': case 'double': return [ dataview.getFloat64( at, little_endian ), 8 ];
  253. }
  254. }
  255. function binaryReadElement( dataview, at, properties, little_endian ) {
  256. var element = {};
  257. var result, read = 0;
  258. for ( var i = 0; i < properties.length; i ++ ) {
  259. if ( properties[ i ].type === 'list' ) {
  260. var list = [];
  261. result = binaryRead( dataview, at + read, properties[ i ].countType, little_endian );
  262. var n = result[ 0 ];
  263. read += result[ 1 ];
  264. for ( var j = 0; j < n; j ++ ) {
  265. result = binaryRead( dataview, at + read, properties[ i ].itemType, little_endian );
  266. list.push( result[ 0 ] );
  267. read += result[ 1 ];
  268. }
  269. element[ properties[ i ].name ] = list;
  270. } else {
  271. result = binaryRead( dataview, at + read, properties[ i ].type, little_endian );
  272. element[ properties[ i ].name ] = result[ 0 ];
  273. read += result[ 1 ];
  274. }
  275. }
  276. return [ element, read ];
  277. }
  278. function parseBinary( data, header ) {
  279. var buffer = {
  280. indices: [],
  281. vertices: [],
  282. normals: [],
  283. uvs: [],
  284. faceVertexUvs: [],
  285. colors: []
  286. };
  287. var little_endian = ( header.format === 'binary_little_endian' );
  288. var body = new DataView( data, header.headerLength );
  289. var result, loc = 0;
  290. for ( var currentElement = 0; currentElement < header.elements.length; currentElement ++ ) {
  291. for ( var currentElementCount = 0; currentElementCount < header.elements[ currentElement ].count; currentElementCount ++ ) {
  292. result = binaryReadElement( body, loc, header.elements[ currentElement ].properties, little_endian );
  293. loc += result[ 1 ];
  294. var element = result[ 0 ];
  295. handleElement( buffer, header.elements[ currentElement ].name, element );
  296. }
  297. }
  298. return postProcess( buffer );
  299. }
  300. //
  301. var geometry;
  302. var scope = this;
  303. if ( data instanceof ArrayBuffer ) {
  304. var text = LoaderUtils.decodeText( new Uint8Array( data ) );
  305. var header = parseHeader( text );
  306. geometry = header.format === 'ascii' ? parseASCII( text, header ) : parseBinary( data, header );
  307. } else {
  308. geometry = parseASCII( data, parseHeader( data ) );
  309. }
  310. return geometry;
  311. }
  312. } );
  313. export { PLYLoader };