cubeHoverRotate.js

/**
 * Represents a 3D Cube with interactive features.
 *
 * @class Cube
 * @param {HTMLElement} cube - The HTML element representing the cube.
 */
class Cube {
  constructor (cube) {

    /**  @member {HTMLElement} - The HTML element representing the cube.*/
    this.main = cube

    /**  @member {number} - `timeoutID` used to `cancelTimeout()` delayed rotation */
    this.willRotate = 0

    /**  @member {number} - `timeoutID` used to `cancelTimeout()` delayed rotation */
    this.transitionDuration = this.getTransitionDuration ()

    // ----------------- Events ----------------- \\
    this.main.addEventListener (
      'animationcancel',
      () => {
      // console.log('animationcancel');
        this.setDefaultTransform () // 3. Starts transition which reverses the .rotate animation
      },
    )
    if (mobileAndTabletCheck ()) {
      console.log ('mobile')
      this.main.addEventListener (
        'click',
        (event) => {
          // eslint-disable-next-line @stylistic/js/no-extra-parens
          if (!(this.main.classList.contains ('active'))) {
            event.preventDefault ()
            this.stop ()
            this.main.classList.add ('active')
          }
        },
      )

      document.addEventListener (
        'click',
        (event) => {
          const {target} = event
          console.log (
            event,
            target,
          )
          // eslint-disable-next-line @stylistic/js/no-extra-parens
          if (!(isDescendant (
            this.main,
            event.target,
          ))) {
            this.main.classList.remove ('active')
            this.rotate ({'relatedTarget': null})
          }
        },
      )
    } else {
      this.main.addEventListener (
        'mouseover',
        ({target}) => {
          this.stop ()
          target.classList.add ('select')
        },
      )

      this.main.addEventListener (
        'mouseout',
        (event) => {
          this.rotate (event)
          event.target.classList.remove ('select')
        },
      )
    }
  }

  /**
   * Rotates the cube based on the mouse out event.
   *
   * @param {HTMLElement} event.relatedTarget - The element the mouse is moving to.
   */
  rotate = ({'relatedTarget': movedTo}) => {
    console.log ('mouse out')
    console.log (movedTo)

    this.willRotate = setTimeout (
      () => {
      // if cursor was moved out of window or on element which is not part of cube
        if (movedTo === null || !movedTo.classList.contains ('face')) {
        // console.log('rotate');
        // console.log(this.main.style);
          this.main.style.transform = '' // set transform to default value
          this.main.classList.add ('rotate') // start rotate animation
        }
      },
      this.transitionDuration,
    )
  }

  /**
   * Stops the cube's rotation based on its current state.
   * If the cube is currently rotating, it freezes the rotation at its current animation state.
   * If the cube is not rotating but a rotation is scheduled,
   * it cancels that scheduled rotation.
   *
   * @returns {void} This method does not return a value.
   */
  stop = () => {
    if (this.isRotating ()) {
      console.log ('this Is Rotating')
      this.freezeRotation ()
    } else {
      console.log ('th is not Rotating')
      this.cancelScheduledRotation ()
    }
  }

  /**
   * Freezes the cube's rotation at its current animation state.
   *
   * This method sets the cube's transform style to its current computed value,
   * effectively stopping the rotation animation at its current position.
   * After freezing the rotation, the method removes the 'rotate' class from the cube's class list,
   * which cancels the ongoing animation.
   *
   * @returns {String}  Transform style at which animation stopped.
   */
  freezeRotation () {
    // 1. set transform to current computed value to stop at current animation state
    const stopAt = this.getComputedTransform ()
    this.main.style.transform = this.getComputedTransform ()

    // 2. cancel animation
    this.main.classList.remove ('rotate')
    return stopAt
  }

  /**
   * Cancels any scheduled rotation of the cube.
   *
   * This method checks if there's a pending rotation (scheduled by setTimeout)
   * and cancels it if it exists. It also resets the willRotate flag.
   *
   * @returns {void} This method does not return a value.
   */
  cancelScheduledRotation () {
    if (this.willRotate) {
      clearTimeout (this.willRotate)
      this.willRotate = 0
    }
  }

  /**
   * Checks if the cube is currently rotating.
   *
   * @returns {boolean} - True if the cube is rotating, false otherwise.
   */
  isRotating () {
    return this.main.classList.contains ('rotate')
  }

  /**
   * Retrieves the current computed transform value of the cube.
   *
   * @returns {string} - The current computed transform value.
   */
  getComputedTransform () {
    return window.getComputedStyle (this.main).transform
  }

  /**
   * Resets the cube's transform style to its default value.
   *
   * This method clears any existing transform styles applied to the cube,
   * effectively resetting it to its original position and orientation.
   *
   * @returns {void} This method does not return a value.
   */
  setDefaultTransform () {
    this.main.style.transform = ''
  }

  /**
   * Retrieves the transition duration of the cube's rotate animation.
   *
   * @returns {number} - The transition duration in milliseconds.
   */
  getTransitionDuration () {
    return getTransitionDuration (this.main)
  }
}

/**
 * Calculates the transition duration of an element in milliseconds.
 *
 * @param {HTMLElement} element - The HTML element to check for transition duration.
 * @returns {number} The transition duration in milliseconds.
 */
function getTransitionDuration (element) {
  // This returns a string representing the duration, typically in seconds (e.g., "0.5s").
  const durationString =
    window.getComputedStyle (element)['transition-duration']

  // If the element does not have a transition-duration, it returns 0.
  if (durationString === '') return 0

  // Convert the string duration to milliseconds by removing the "s" suffix and multiplying by 1000.
  const timeout = durationString.slice (
    0,
    durationString.length - 1,
  ) * 1000
  return timeout
}

// eslint-disable-next-line no-unused-vars
const cube = new Cube (document.querySelector ('.cube'))

/**
 * Detects whether the current user is using a mobile or tablet device
 * based on the user agent string.
 *
 * This function uses a comprehensive regular expression to match a wide range
 * of mobile and tablet user agents including iOS, Android, BlackBerry, Kindle,
 * and various legacy and obscure devices.
 *
 * @returns {boolean} True if the user is on a mobile or tablet device, false otherwise.
 */
function mobileAndTabletCheck () {
  const agent = navigator.userAgent || navigator.vendor || window.opera

  // eslint-disable-next-line no-useless-escape
  const isMobile = (/(android|bb\d+|meego).+mobile|avantgo|bada\/|blackberry|blazer|compal|elaine|fennec|hiptop|iemobile|ip(hone|od)|iris|kindle|lge |maemo|midp|mmp|mobile.+firefox|netfront|opera m(ob|in)i|palm( os)?|phone|p(ixi|re)\/|plucker|pocket|psp|series(4|6)0|symbian|treo|up\.(browser|link)|vodafone|wap|windows ce|xda|xiino|android|ipad|playbook|silk/i).test (agent) || (/1207|6310|6590|3gso|4thp|50[1-6]i|770s|802s|a wa|abac|ac(er|oo|s\-)|ai(ko|rn)|al(av|ca|co)|amoi|an(ex|ny|yw)|aptu|ar(ch|go)|as(te|us)|attw|au(di|\-m|r |s )|avan|be(ck|ll|nq)|bi(lb|rd)|bl(ac|az)|br(e|v)w|bumb|bw\-(n|u)|c55\/|capi|ccwa|cdm\-|cell|chtm|cldc|cmd\-|co(mp|nd)|craw|da(it|ll|ng)|dbte|dc\-s|devi|dica|dmob|do(c|p)o|ds(12|\-d)|el(49|ai)|em(l2|ul)|er(ic|k0)|esl8|ez([4-7]0|os|wa|ze)|fetc|fly(\-|_)|g1 u|g560|gene|gf\-5|g\-mo|go(\.w|od)|gr(ad|un)|haie|hcit|hd\-(m|p|t)|hei\-|hi(pt|ta)|hp( i|ip)|hs\-c|ht(c(\-| |_|a|g|p|s|t)|tp)|hu(aw|tc)|i\-(20|go|ma)|i230|iac( |\-|\/)|ibro|idea|ig01|ikom|im1k|inno|ipaq|iris|ja(t|v)a|jbro|jemu|jigs|kddi|keji|kgt( |\/)|klon|kpt |kwc\-|kyo(c|k)|le(no|xi)|lg( g|\/(k|l|u)|50|54|\-[a-w])|libw|lynx|m1\-w|m3ga|m50\/|ma(te|ui|xo)|mc(01|21|ca)|m\-cr|me(rc|ri)|mi(o8|oa|ts)|mmef|mo(01|02|bi|de|do|t(\-| |o|v)|zz)|mt(50|p1|v )|mwbp|mywa|n10[0-2]|n20[2-3]|n30(0|2)|n50(0|2|5)|n7(0(0|1)|10)|ne((c|m)\-|on|tf|wf|wg|wt)|nok(6|i)|nzph|o2im|op(ti|wv)|oran|owg1|p800|pan(a|d|t)|pdxg|pg(13|\-([1-8]|c))|phil|pire|pl(ay|uc)|pn\-2|po(ck|rt|se)|prox|psio|pt\-g|qa\-a|qc(07|12|21|32|60|\-[2-7]|i\-)|qtek|r380|r600|raks|rim9|ro(ve|zo)|s55\/|sa(ge|ma|mm|ms|ny|va)|sc(01|h\-|oo|p\-)|sdk\/|se(c(\-|0|1)|47|mc|nd|ri)|sgh\-|shar|sie(\-|m)|sk\-0|sl(45|id)|sm(al|ar|b3|it|t5)|so(ft|ny)|sp(01|h\-|v\-|v )|sy(01|mb)|t2(18|50)|t6(00|10|18)|ta(gt|lk)|tcl\-|tdg\-|tel(i|m)|tim\-|t\-mo|to(pl|sh)|ts(70|m\-|m3|m5)|tx\-9|up(\.b|g1|si)|utst|v400|v750|veri|vi(rg|te)|vk(40|5[0-3]|\-v)|vm40|voda|vulc|vx(52|53|60|61|70|80|81|83|85|98)|w3c(\-| )|webc|whit|wi(g |nc|nw)|wmlb|wonu|x700|yas\-|your|zeto|zte\-/i).test (agent.substr (
    0,
    4,
  ))

  return isMobile
}

/**
 * Checks whether a given DOM element is a descendant of another DOM element.
 *
 * @param {HTMLElement} potentialParent - The element to test as the potential ancestor.
 * @param {HTMLElement} potentialChild - The element to test as the potential descendant.
 * @returns {boolean} True if `potentialChild` is a descendant of `potentialParent`, otherwise false.
 */
function isDescendant (potentialParent, potentialChild) {
  if (!potentialParent || !potentialChild) return false
  return potentialParent.contains (potentialChild)
}