CurveModifier.js 8.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325
  1. // Original src: https://github.com/zz85/threejs-path-flow
  2. const CHANNELS = 4;
  3. const TEXTURE_WIDTH = 1024;
  4. const TEXTURE_HEIGHT = 4;
  5. import {
  6. DataTexture,
  7. RGBAFormat,
  8. FloatType,
  9. RepeatWrapping,
  10. Mesh,
  11. InstancedMesh,
  12. NearestFilter,
  13. DynamicDrawUsage,
  14. Matrix4
  15. } from 'three';
  16. /**
  17. * Make a new DataTexture to store the descriptions of the curves.
  18. *
  19. * @param { number } numberOfCurves the number of curves needed to be described by this texture.
  20. */
  21. export function initSplineTexture( numberOfCurves = 1 ) {
  22. const dataArray = new Float32Array( TEXTURE_WIDTH * TEXTURE_HEIGHT * numberOfCurves * CHANNELS );
  23. const dataTexture = new DataTexture(
  24. dataArray,
  25. TEXTURE_WIDTH,
  26. TEXTURE_HEIGHT * numberOfCurves,
  27. RGBAFormat,
  28. FloatType
  29. );
  30. dataTexture.wrapS = RepeatWrapping;
  31. dataTexture.wrapY = RepeatWrapping;
  32. dataTexture.magFilter = NearestFilter;
  33. dataTexture.needsUpdate = true;
  34. return dataTexture;
  35. }
  36. /**
  37. * Write the curve description to the data texture
  38. *
  39. * @param { DataTexture } texture The DataTexture to write to
  40. * @param { Curve } splineCurve The curve to describe
  41. * @param { number } offset Which curve slot to write to
  42. */
  43. export function updateSplineTexture( texture, splineCurve, offset = 0 ) {
  44. const numberOfPoints = Math.floor( TEXTURE_WIDTH * ( TEXTURE_HEIGHT / 4 ) );
  45. splineCurve.arcLengthDivisions = numberOfPoints / 2;
  46. splineCurve.updateArcLengths();
  47. const points = splineCurve.getSpacedPoints( numberOfPoints );
  48. const frenetFrames = splineCurve.computeFrenetFrames( numberOfPoints, true );
  49. for ( let i = 0; i < numberOfPoints; i ++ ) {
  50. const rowOffset = Math.floor( i / TEXTURE_WIDTH );
  51. const rowIndex = i % TEXTURE_WIDTH;
  52. let pt = points[ i ];
  53. setTextureValue( texture, rowIndex, pt.x, pt.y, pt.z, 0 + rowOffset + ( TEXTURE_HEIGHT * offset ) );
  54. pt = frenetFrames.tangents[ i ];
  55. setTextureValue( texture, rowIndex, pt.x, pt.y, pt.z, 1 + rowOffset + ( TEXTURE_HEIGHT * offset ) );
  56. pt = frenetFrames.normals[ i ];
  57. setTextureValue( texture, rowIndex, pt.x, pt.y, pt.z, 2 + rowOffset + ( TEXTURE_HEIGHT * offset ) );
  58. pt = frenetFrames.binormals[ i ];
  59. setTextureValue( texture, rowIndex, pt.x, pt.y, pt.z, 3 + rowOffset + ( TEXTURE_HEIGHT * offset ) );
  60. }
  61. texture.needsUpdate = true;
  62. }
  63. function setTextureValue( texture, index, x, y, z, o ) {
  64. const image = texture.image;
  65. const { data } = image;
  66. const i = CHANNELS * TEXTURE_WIDTH * o; // Row Offset
  67. data[ index * CHANNELS + i + 0 ] = x;
  68. data[ index * CHANNELS + i + 1 ] = y;
  69. data[ index * CHANNELS + i + 2 ] = z;
  70. data[ index * CHANNELS + i + 3 ] = 1;
  71. }
  72. /**
  73. * Create a new set of uniforms for describing the curve modifier
  74. *
  75. * @param { DataTexture } Texture which holds the curve description
  76. */
  77. export function getUniforms( splineTexture ) {
  78. const uniforms = {
  79. spineTexture: { value: splineTexture },
  80. pathOffset: { type: 'f', value: 0 }, // time of path curve
  81. pathSegment: { type: 'f', value: 1 }, // fractional length of path
  82. spineOffset: { type: 'f', value: 161 },
  83. spineLength: { type: 'f', value: 400 },
  84. flow: { type: 'i', value: 1 },
  85. };
  86. return uniforms;
  87. }
  88. export function modifyShader( material, uniforms, numberOfCurves = 1 ) {
  89. if ( material.__ok ) return;
  90. material.__ok = true;
  91. material.onBeforeCompile = ( shader ) => {
  92. if ( shader.__modified ) return;
  93. shader.__modified = true;
  94. Object.assign( shader.uniforms, uniforms );
  95. const vertexShader = `
  96. uniform sampler2D spineTexture;
  97. uniform float pathOffset;
  98. uniform float pathSegment;
  99. uniform float spineOffset;
  100. uniform float spineLength;
  101. uniform int flow;
  102. float textureLayers = ${TEXTURE_HEIGHT * numberOfCurves}.;
  103. float textureStacks = ${TEXTURE_HEIGHT / 4}.;
  104. ${shader.vertexShader}
  105. `
  106. // chunk import moved in front of modified shader below
  107. .replace( '#include <beginnormal_vertex>', '' )
  108. // vec3 transformedNormal declaration overriden below
  109. .replace( '#include <defaultnormal_vertex>', '' )
  110. // vec3 transformed declaration overriden below
  111. .replace( '#include <begin_vertex>', '' )
  112. // shader override
  113. .replace(
  114. /void\s*main\s*\(\)\s*\{/,
  115. `
  116. void main() {
  117. #include <beginnormal_vertex>
  118. vec4 worldPos = modelMatrix * vec4(position, 1.);
  119. bool bend = flow > 0;
  120. float xWeight = bend ? 0. : 1.;
  121. #ifdef USE_INSTANCING
  122. float pathOffsetFromInstanceMatrix = instanceMatrix[3][2];
  123. float spineLengthFromInstanceMatrix = instanceMatrix[3][0];
  124. float spinePortion = bend ? (worldPos.x + spineOffset) / spineLengthFromInstanceMatrix : 0.;
  125. float mt = (spinePortion * pathSegment + pathOffset + pathOffsetFromInstanceMatrix)*textureStacks;
  126. #else
  127. float spinePortion = bend ? (worldPos.x + spineOffset) / spineLength : 0.;
  128. float mt = (spinePortion * pathSegment + pathOffset)*textureStacks;
  129. #endif
  130. mt = mod(mt, textureStacks);
  131. float rowOffset = floor(mt);
  132. #ifdef USE_INSTANCING
  133. rowOffset += instanceMatrix[3][1] * ${TEXTURE_HEIGHT}.;
  134. #endif
  135. vec3 spinePos = texture2D(spineTexture, vec2(mt, (0. + rowOffset + 0.5) / textureLayers)).xyz;
  136. vec3 a = texture2D(spineTexture, vec2(mt, (1. + rowOffset + 0.5) / textureLayers)).xyz;
  137. vec3 b = texture2D(spineTexture, vec2(mt, (2. + rowOffset + 0.5) / textureLayers)).xyz;
  138. vec3 c = texture2D(spineTexture, vec2(mt, (3. + rowOffset + 0.5) / textureLayers)).xyz;
  139. mat3 basis = mat3(a, b, c);
  140. vec3 transformed = basis
  141. * vec3(worldPos.x * xWeight, worldPos.y * 1., worldPos.z * 1.)
  142. + spinePos;
  143. vec3 transformedNormal = normalMatrix * (basis * objectNormal);
  144. ` ).replace(
  145. '#include <project_vertex>',
  146. `vec4 mvPosition = modelViewMatrix * vec4( transformed, 1.0 );
  147. gl_Position = projectionMatrix * mvPosition;`
  148. );
  149. shader.vertexShader = vertexShader;
  150. };
  151. }
  152. /**
  153. * A helper class for making meshes bend aroudn curves
  154. */
  155. export class Flow {
  156. /**
  157. * @param {Mesh} mesh The mesh to clone and modify to bend around the curve
  158. * @param {number} numberOfCurves The amount of space that should preallocated for additional curves
  159. */
  160. constructor( mesh, numberOfCurves = 1 ) {
  161. const obj3D = mesh.clone();
  162. const splineTexure = initSplineTexture( numberOfCurves );
  163. const uniforms = getUniforms( splineTexure );
  164. obj3D.traverse( function ( child ) {
  165. if (
  166. child instanceof Mesh ||
  167. child instanceof InstancedMesh
  168. ) {
  169. child.material = child.material.clone();
  170. modifyShader( child.material, uniforms, numberOfCurves );
  171. }
  172. } );
  173. this.curveArray = new Array( numberOfCurves );
  174. this.curveLengthArray = new Array( numberOfCurves );
  175. this.object3D = obj3D;
  176. this.splineTexure = splineTexure;
  177. this.uniforms = uniforms;
  178. }
  179. updateCurve( index, curve ) {
  180. if ( index >= this.curveArray.length ) throw Error( 'Index out of range for Flow' );
  181. const curveLength = curve.getLength();
  182. this.uniforms.spineLength.value = curveLength;
  183. this.curveLengthArray[ index ] = curveLength;
  184. this.curveArray[ index ] = curve;
  185. updateSplineTexture( this.splineTexure, curve, index );
  186. }
  187. moveAlongCurve( amount ) {
  188. this.uniforms.pathOffset.value += amount;
  189. }
  190. }
  191. const matrix = new Matrix4();
  192. /**
  193. * A helper class for creating instanced versions of flow, where the instances are placed on the curve.
  194. */
  195. export class InstancedFlow extends Flow {
  196. /**
  197. *
  198. * @param {number} count The number of instanced elements
  199. * @param {number} curveCount The number of curves to preallocate for
  200. * @param {Geometry} geometry The geometry to use for the instanced mesh
  201. * @param {Material} material The material to use for the instanced mesh
  202. */
  203. constructor( count, curveCount, geometry, material ) {
  204. const mesh = new InstancedMesh(
  205. geometry,
  206. material,
  207. count
  208. );
  209. mesh.instanceMatrix.setUsage( DynamicDrawUsage );
  210. super( mesh, curveCount );
  211. this.offsets = new Array( count ).fill( 0 );
  212. this.whichCurve = new Array( count ).fill( 0 );
  213. }
  214. /**
  215. * The extra information about which curve and curve position is stored in the translation components of the matrix for the instanced objects
  216. * This writes that information to the matrix and marks it as needing update.
  217. *
  218. * @param {number} index of the instanced element to update
  219. */
  220. writeChanges( index ) {
  221. matrix.makeTranslation(
  222. this.curveLengthArray[ this.whichCurve[ index ] ],
  223. this.whichCurve[ index ],
  224. this.offsets[ index ]
  225. );
  226. this.object3D.setMatrixAt( index, matrix );
  227. this.object3D.instanceMatrix.needsUpdate = true;
  228. }
  229. /**
  230. * Move an individual element along the curve by a specific amount
  231. *
  232. * @param {number} index Which element to update
  233. * @param {number} offset Move by how much
  234. */
  235. moveIndividualAlongCurve( index, offset ) {
  236. this.offsets[ index ] += offset;
  237. this.writeChanges( index );
  238. }
  239. /**
  240. * Select which curve to use for an element
  241. *
  242. * @param {number} index the index of the instanced element to update
  243. * @param {number} curveNo the index of the curve it should use
  244. */
  245. setCurve( index, curveNo ) {
  246. if ( isNaN( curveNo ) ) throw Error( 'curve index being set is Not a Number (NaN)' );
  247. this.whichCurve[ index ] = curveNo;
  248. this.writeChanges( index );
  249. }
  250. }