PLYLoader.js 11 KB

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