react-umg/src/ReactUMGReconcileTransaction.js

A React renderer for Unreal Motion Graphics With Unreal.js

'use strict';

var CallbackQueue = require('react-dom/lib/CallbackQueue');
var PooledClass = require('react/lib/PooledClass');
var Transaction = require('react-dom/lib/Transaction');
var ReactUpdateQueue = require('react-dom/lib/ReactUpdateQueue');

/**
 * Provides a `CallbackQueue` queue for collecting `onDOMReady` callbacks during
 * the performing of the transaction.
 */
var ON_UMG_READY_QUEUEING = {
  /**
   * Initializes the internal firmata `connected` queue.
   */
  initialize: function() {
    this.reactMountReady.reset();
  },

  /**
   * After Hardware is connected, invoke all registered `ready` callbacks.
   */
  close: function() {
    this.reactMountReady.notifyAll();
  },
};

/**
 * Executed within the scope of the `Transaction` instance. Consider these as
 * being member methods, but with an implied ordering while being isolated from
 * each other.
 */
var TRANSACTION_WRAPPERS = [ON_UMG_READY_QUEUEING];

function ReactUMGReconcileTransaction() {
  this.reinitializeTransaction();
  this.reactMountReady = CallbackQueue.getPooled(null);
}

const Mixin = {
  /**
   * @see Transaction
   * @abstract
   * @final
   * @return {array<object>} List of operation wrap procedures.
   */
  getTransactionWrappers: function() {
    return TRANSACTION_WRAPPERS;
  },

  /**
   * @return {object} The queue to collect `ready` callbacks with.
   */
  getReactMountReady: function() {
    return this.reactMountReady;
  },

  getUpdateQueue: function() {
    return ReactUpdateQueue;
  },

  /**
   * `PooledClass` looks for this, and will invoke this before allowing this
   * instance to be resused.
   */
  destructor: function() {
    CallbackQueue.release(this.reactMountReady);
    this.reactMountReady = null;
  },
};

Object.assign(
  ReactUMGReconcileTransaction.prototype,
  Transaction,
  ReactUMGReconcileTransaction,
  Mixin
);

PooledClass.addPoolingTo(ReactUMGReconcileTransaction);

module.exports = ReactUMGReconcileTransaction;