Source: extern/tsr.js

  1. import register from "../util/register.js";
  3. import * as m_mat4 from "../libs/gl_matrix/mat4.js";
  4. import * as m_tsr from "../intern/tsr.js";
  6. /** 
  7.  * {@link TSR} (translation, scale, rotation} utility routines.
  8.  * @module tsr
  9.  * @see https://www.blend4web.com/doc/en/objects.html#moving-via-tsr-vectors
  10.  */
  11. function TSR(ns, exports) {
  13. /**
  14.  * Create a new identity TSR vector.
  15.  * @method module:tsr.create
  16.  * @returns {TSR} New TSR vector
  17.  */
  18. exports.create = m_tsr.create;
  20. /**
  21.  * Create a new TSR vector from given values.
  22.  * @method module:tsr.from_values
  23.  * @param {number} x X translation.
  24.  * @param {number} y Y translation.
  25.  * @param {number} z Z translation.
  26.  * @param {number} s Scale.
  27.  * @param {number} qx X quaternion rotation.
  28.  * @param {number} qy Y quaternion rotation.
  29.  * @param {number} qz Z quaternion rotation.
  30.  * @param {number} qw W quaternion rotation.
  31.  * @returns {TSR} New TSR vector
  32.  */
  33. exports.from_values = m_tsr.from_values;
  35. /**
  36.  * Copy one TSR vector to another.
  37.  * @method module:tsr.copy
  38.  * @param {TSR} tsr Source TSR vector
  39.  * @param {TSR} tsr2 Destination TSR vector
  40.  */
  41. exports.copy = m_tsr.copy;
  43. /**
  44.  * Set TSR to identity.
  45.  * @method module:tsr.identity
  46.  * @param {TSR} tsr TSR vector
  47.  */
  48. exports.identity = m_tsr.identity;
  50. /**
  51.  * Set TSR from separate trans, scale and quat.
  52.  * @method module:tsr.set_sep
  53.  * @param {Vec3} trans Translation vector
  54.  * @param {number} scale Scale
  55.  * @param {Quat} quat Rotation quaternion
  56.  * @param {TSR} [dest] Destination TSR vector
  57.  * @returns {TSR} dest Destination TSR vector
  58.  */
  59. exports.set_sep = m_tsr.set_sep;
  60. function set_sep(trans, scale, quat, dest) {
  61.     if (!dest)
  62.         dest = m_tsr.create();
  64.     set_sep(trans, scale, quat, dest);
  66.     return dest;
  67. }
  69. /**
  70.  * Set TSR translation.
  71.  * @method module:tsr.set_trans
  72.  * @param {Vec3} trans Translation vector
  73.  * @param {TSR} dest Destination TSR vector
  74.  */
  75. exports.set_trans = m_tsr.set_trans;
  76. /**
  77.  * Set TSR scale.
  78.  * @method module:tsr.set_scale
  79.  * @param {number} scale Scale
  80.  * @param {TSR} dest Destination TSR vector
  81.  */
  82. exports.set_scale = m_tsr.set_scale;
  83. /**
  84.  * Set TSR translation and scale from vec4.
  85.  * @method module:tsr.set_transcale
  86.  * @param {Vec4} transcale Translation+Scale vector
  87.  * @param {TSR} dest Destination TSR vector
  88.  */
  89. exports.set_transcale = m_tsr.set_transcale ;
  90. /**
  91.  * Set TSR quaternion.
  92.  * @method module:tsr.set_quat
  93.  * @param {Quat} quat Rotation quaternion
  94.  * @param {TSR} dest Destination TSR vector
  95.  */
  96. exports.set_quat = m_tsr.set_quat;
  98. /**
  99.  * Get ArrayBufferView from translation part of TSR.
  100.  * @method module:tsr.get_trans_view
  101.  * @param {TSR} tsr TSR vector
  102.  * @returns {Vec3} Translation part of TSR
  103.  */
  104. exports.get_trans_view = m_tsr.get_trans_view;
  105. /**
  106.  * Get TSR scale.
  107.  * @method module:tsr.get_scale
  108.  * @returns {number} Scale
  109.  */
  110. exports.get_scale = m_tsr.get_scale;
  111. /**
  112.  * Get ArrayBufferView from quaternion part of TSR.
  113.  * @method module:tsr.get_quat_view
  114.  * @returns {Quat} Quaternion part of TSR
  115.  */
  116. exports.get_quat_view = m_tsr.get_quat_view;
  118. /**
  119.  * Calculates the inverse of TSR.
  120.  * @method module:tsr.invert
  121.  * @param {TSR} tsr TSR vector
  122.  * @param {TSR} dest Destination TSR vector
  123.  * @returns {TSR} Destination TSR vector
  124.  */
  125. exports.invert = m_tsr.invert;
  128. /**
  129.  * Create mat4 from TSR.
  130.  * Not optimized.
  131.  * @method module:tsr.to_mat4
  132.  * @param {TSR} tsr TSR vector.
  133.  * @param {?Mat4} [dest=mat4.create()] Destination matrix.
  134.  * @returns {Mat4} Destination matrix.
  135.  */
  136. exports.to_mat4 = function(tsr, dest) {
  137.     if (!dest)
  138.         dest = m_mat4.create();
  140.     m_tsr.to_mat4(tsr, dest);
  141.     return dest;
  142. }
  144. /**
  145.  * Set TSR from mat4.
  146.  * Not optimized.
  147.  * @method module:tsr.from_mat4
  148.  * @param {Mat4} mat Matrix.
  149.  * @param {TSR} dest Destination TSR vector.
  150.  * @returns {TSR} Destination TSR vector.
  151.  */
  152. exports.from_mat4 = m_tsr.from_mat4;
  154. /**
  155.  * Multiply two TSRs.
  156.  * @method module:tsr.multiply
  157.  * @param {TSR} tsr First TSR vector
  158.  * @param {TSR} tsr2 Second TSR vector
  159.  * @param {TSR} dest Destination TSR vector
  160.  * @returns {TSR} Destination TSR vector
  161.  */
  162. exports.multiply = m_tsr.multiply;
  164. /**
  165.  * Transform vec3 by TSR.
  166.  * @method module:tsr.transform_vec3
  167.  * @param {Vec3} trans Vector to transform
  168.  * @param {TSR} tsr TSR vector
  169.  * @param {Vec3} dest Destination vector
  170.  */
  171. exports.transform_vec3 = m_tsr.transform_vec3;
  173. /**
  174.  * Transform vec3 by inverse TSR.
  175.  * @method module:tsr.transform_vec3_inv
  176.  * @param {Vec3} trans Vector to transform
  177.  * @param {TSR} tsr TSR vector
  178.  * @param {Vec3} dest Destination vector
  179.  */
  180. exports.transform_vec3_inv = m_tsr.transform_vec3_inv;
  182. /**
  183.  * Transform vec3 vectors by TSR.
  184.  * optional destination offset in values (not vectors, not bytes)
  185.  * @method module:tsr.transform_vectors
  186.  * @param {Float32Array} vectors Array of vectors to transform
  187.  * @param {TSR} tsr TSR vector
  188.  * @param {Float32Array} new_vectors Destination array of vectors
  189.  * @param {number} [dest_offset=0] Offset in new_vectors array
  190.  * @returns {Float32Array} Destination array of vectors
  191.  */
  192. exports.transform_vectors = m_tsr.transform_vectors;
  193. /**
  194.  * Transform directional vec3 vectors by TSR.
  195.  * optional destination offset in values (not vectors, not bytes)
  196.  * @method module:tsr.transform_dir_vectors
  197.  * @param {Float32Array} vectors Array of vectors to transform
  198.  * @param {TSR} tsr TSR vector
  199.  * @param {Float32Array} new_vectors Destination array of vectors
  200.  * @param {number} [dest_offset=0] Offset in new_vectors array
  201.  * @returns {Float32Array} Destination array of vectors
  202.  */
  203. exports.transform_dir_vectors = m_tsr.transform_dir_vectors;
  204. /**
  205.  * Transform directional vec3 by TSR.
  206.  * @method module:tsr.transform_dir_vec3
  207.  * @param {Vec3} trans Vector to transform
  208.  * @param {TSR} tsr TSR vector
  209.  * @param {Vec3} dest Destination vector
  210.  */
  211. exports.transform_dir_vec3 = m_tsr.transform_dir_vec3;
  213. /**
  214.  * Transform 4 comp tangent vectors by matrix.
  215.  * optional destination offset in values (not vectors, not bytes)
  216.  * @method module:tsr.transform_tangents
  217.  * @param {Float32Array} vectors Array of vectors to transform
  218.  * @param {TSR} tsr TSR vector
  219.  * @param {Float32Array} new_vectors Destination array of vectors
  220.  * @param {number} [dest_offset=0] Offset in new_vectors array
  221.  * @returns {Float32Array} Destination array of vectors
  222.  */
  223. exports.transform_tangents = m_tsr.transform_tangents;
  225. /**
  226.  * Perform TSR translation by given vec3.
  227.  * @method module:tsr.translate
  228.  * @param {TSR} tsr TSR vector
  229.  * @param {Vec3} trans Translation vector
  230.  * @param {TSR} dest Destination TSR vector
  231.  * @returns {TSR} Destination TSR vector
  232.  */
  233. exports.translate = m_tsr.translate;
  235. /**
  236.  * Perform interpolation between two TSR vectors.
  237.  * @method module:tsr.interpolate
  238.  * @param {TSR} tsr First TSR vector
  239.  * @param {TSR} tsr2 Second TSR vector
  240.  * @param {number} factor Interpolation factor
  241.  * @param {TSR} dest Destination TSR vector
  242.  * @returns {TSR} Destination TSR vector
  243.  */
  244. exports.interpolate = function(tsr, tsr2, factor, dest) {
  245.     if (!dest)
  246.         dest = m_tsr.create();
  248.     m_tsr.interpolate(tsr, tsr2, factor, dest);
  250.     return dest;
  251. }
  253. }
  255. var tsr_factory = register("tsr", TSR);
  257. export default tsr_factory;