LUTCubeLoader.js 4.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190
  1. import {
  2. ClampToEdgeWrapping,
  3. Data3DTexture,
  4. FileLoader,
  5. LinearFilter,
  6. Loader,
  7. UnsignedByteType,
  8. Vector3,
  9. } from 'three';
  10. /**
  11. * A loader for the Cube LUT format.
  12. *
  13. * References:
  14. * - [Cube LUT Specification]{@link https://web.archive.org/web/20220220033515/https://wwwimages2.adobe.com/content/dam/acom/en/products/speedgrade/cc/pdfs/cube-lut-specification-1.0.pdf}
  15. *
  16. * ```js
  17. * const loader = new LUTCubeLoader();
  18. * const map = loader.loadAsync( 'luts/Bourbon 64.CUBE' );
  19. * ```
  20. *
  21. * @augments Loader
  22. * @three_import import { LUTCubeLoader } from 'three/addons/loaders/LUTCubeLoader.js';
  23. */
  24. export class LUTCubeLoader extends Loader {
  25. /**
  26. * Constructs a new Cube LUT loader.
  27. *
  28. * @param {LoadingManager} [manager] - The loading manager.
  29. */
  30. constructor( manager ) {
  31. super( manager );
  32. /**
  33. * The texture type.
  34. *
  35. * @type {(UnsignedByteType|FloatType)}
  36. * @default UnsignedByteType
  37. */
  38. this.type = UnsignedByteType;
  39. }
  40. /**
  41. * Sets the texture type.
  42. *
  43. * @param {(UnsignedByteType|FloatType)} type - The texture type to set.
  44. * @return {LUTCubeLoader} A reference to this loader.
  45. */
  46. setType( type ) {
  47. this.type = type;
  48. return this;
  49. }
  50. /**
  51. * Starts loading from the given URL and passes the loaded Cube LUT asset
  52. * to the `onLoad()` callback.
  53. *
  54. * @param {string} url - The path/URL of the file to be loaded. This can also be a data URI.
  55. * @param {function({title:string,size:number,domainMin:Vector3,domainMax:Vector3,texture3D:Data3DTexture})} onLoad - Executed when the loading process has been finished.
  56. * @param {onProgressCallback} onProgress - Executed while the loading is in progress.
  57. * @param {onErrorCallback} onError - Executed when errors occur.
  58. */
  59. load( url, onLoad, onProgress, onError ) {
  60. const loader = new FileLoader( this.manager );
  61. loader.setPath( this.path );
  62. loader.setResponseType( 'text' );
  63. loader.load( url, text => {
  64. try {
  65. onLoad( this.parse( text ) );
  66. } catch ( e ) {
  67. if ( onError ) {
  68. onError( e );
  69. } else {
  70. console.error( e );
  71. }
  72. this.manager.itemError( url );
  73. }
  74. }, onProgress, onError );
  75. }
  76. /**
  77. * Parses the given Cube LUT data and returns the resulting 3D data texture.
  78. *
  79. * @param {string} input - The raw Cube LUT data as a string.
  80. * @return {{title:string,size:number,domainMin:Vector3,domainMax:Vector3,texture3D:Data3DTexture}} The parsed Cube LUT.
  81. */
  82. parse( input ) {
  83. const regExpTitle = /TITLE +"([^"]*)"/;
  84. const regExpSize = /LUT_3D_SIZE +(\d+)/;
  85. const regExpDomainMin = /DOMAIN_MIN +([\d.]+) +([\d.]+) +([\d.]+)/;
  86. const regExpDomainMax = /DOMAIN_MAX +([\d.]+) +([\d.]+) +([\d.]+)/;
  87. const regExpDataPoints = /^([\d.e+-]+) +([\d.e+-]+) +([\d.e+-]+) *$/gm;
  88. let result = regExpTitle.exec( input );
  89. const title = ( result !== null ) ? result[ 1 ] : null;
  90. result = regExpSize.exec( input );
  91. if ( result === null ) {
  92. throw new Error( 'LUTCubeLoader: Missing LUT_3D_SIZE information' );
  93. }
  94. const size = Number( result[ 1 ] );
  95. const length = size ** 3 * 4;
  96. const data = this.type === UnsignedByteType ? new Uint8Array( length ) : new Float32Array( length );
  97. const domainMin = new Vector3( 0, 0, 0 );
  98. const domainMax = new Vector3( 1, 1, 1 );
  99. result = regExpDomainMin.exec( input );
  100. if ( result !== null ) {
  101. domainMin.set( Number( result[ 1 ] ), Number( result[ 2 ] ), Number( result[ 3 ] ) );
  102. }
  103. result = regExpDomainMax.exec( input );
  104. if ( result !== null ) {
  105. domainMax.set( Number( result[ 1 ] ), Number( result[ 2 ] ), Number( result[ 3 ] ) );
  106. }
  107. if ( domainMin.x > domainMax.x || domainMin.y > domainMax.y || domainMin.z > domainMax.z ) {
  108. throw new Error( 'LUTCubeLoader: Invalid input domain' );
  109. }
  110. const scale = this.type === UnsignedByteType ? 255 : 1;
  111. let i = 0;
  112. while ( ( result = regExpDataPoints.exec( input ) ) !== null ) {
  113. data[ i ++ ] = Number( result[ 1 ] ) * scale;
  114. data[ i ++ ] = Number( result[ 2 ] ) * scale;
  115. data[ i ++ ] = Number( result[ 3 ] ) * scale;
  116. data[ i ++ ] = scale;
  117. }
  118. const texture3D = new Data3DTexture();
  119. texture3D.image.data = data;
  120. texture3D.image.width = size;
  121. texture3D.image.height = size;
  122. texture3D.image.depth = size;
  123. texture3D.type = this.type;
  124. texture3D.magFilter = LinearFilter;
  125. texture3D.minFilter = LinearFilter;
  126. texture3D.wrapS = ClampToEdgeWrapping;
  127. texture3D.wrapT = ClampToEdgeWrapping;
  128. texture3D.wrapR = ClampToEdgeWrapping;
  129. texture3D.generateMipmaps = false;
  130. texture3D.needsUpdate = true;
  131. return {
  132. title,
  133. size,
  134. domainMin,
  135. domainMax,
  136. texture3D,
  137. };
  138. }
  139. }