mirror of
https://github.com/google/blockly.git
synced 2026-01-10 18:37:09 +01:00
97 lines
2.6 KiB
JavaScript
97 lines
2.6 KiB
JavaScript
/**
|
|
* @license
|
|
* Copyright 2019 Google LLC
|
|
* SPDX-License-Identifier: Apache-2.0
|
|
*/
|
|
|
|
/**
|
|
* @fileoverview Namespace for block rendering functionality.
|
|
* @author fenichel@google.com (Rachel Fenichel)
|
|
*/
|
|
'use strict';
|
|
|
|
/**
|
|
* The top level namespace for block rendering.
|
|
* @namespace Blockly.blockRendering
|
|
*/
|
|
goog.provide('Blockly.blockRendering');
|
|
|
|
goog.require('Blockly.utils.object');
|
|
|
|
|
|
/**
|
|
* The set of all registered renderers, keyed by their name.
|
|
* @type {!Object<string, !Function>}
|
|
* @private
|
|
*/
|
|
Blockly.blockRendering.rendererMap_ = {};
|
|
|
|
/**
|
|
* Whether or not the debugger is turned on.
|
|
* @type {boolean}
|
|
* @package
|
|
*/
|
|
Blockly.blockRendering.useDebugger = false;
|
|
|
|
/**
|
|
* Registers a new renderer.
|
|
* @param {string} name The name of the renderer.
|
|
* @param {!Function} rendererClass The new renderer class
|
|
* to register.
|
|
* @throws {Error} if a renderer with the same name has already been registered.
|
|
*/
|
|
Blockly.blockRendering.register = function(name, rendererClass) {
|
|
if (Blockly.blockRendering.rendererMap_[name]) {
|
|
throw Error('Renderer has already been registered.');
|
|
}
|
|
Blockly.blockRendering.rendererMap_[name] = rendererClass;
|
|
};
|
|
|
|
/**
|
|
* Unregisters the renderer registered with the given name.
|
|
* @param {string} name The name of the renderer.
|
|
*/
|
|
Blockly.blockRendering.unregister = function(name) {
|
|
if (Blockly.blockRendering.rendererMap_[name]) {
|
|
delete Blockly.blockRendering.rendererMap_[name];
|
|
} else {
|
|
console.warn('No renderer mapping for name "' + name +
|
|
'" found to unregister');
|
|
}
|
|
};
|
|
|
|
/**
|
|
* Turn on the blocks debugger.
|
|
* @package
|
|
*/
|
|
Blockly.blockRendering.startDebugger = function() {
|
|
Blockly.blockRendering.useDebugger = true;
|
|
};
|
|
|
|
/**
|
|
* Turn off the blocks debugger.
|
|
* @package
|
|
*/
|
|
Blockly.blockRendering.stopDebugger = function() {
|
|
Blockly.blockRendering.useDebugger = false;
|
|
};
|
|
|
|
/**
|
|
* Initialize anything needed for rendering (constants, etc).
|
|
* @param {!string} name Name of the renderer to initialize.
|
|
* @param {!Blockly.Theme} theme The workspace theme object.
|
|
* @param {Object=} opt_rendererOverrides Rendering constant overrides.
|
|
* @return {!Blockly.blockRendering.Renderer} The new instance of a renderer.
|
|
* Already initialized.
|
|
* @package
|
|
*/
|
|
Blockly.blockRendering.init = function(name, theme, opt_rendererOverrides) {
|
|
if (!Blockly.blockRendering.rendererMap_[name]) {
|
|
throw Error('Renderer not registered: ', name);
|
|
}
|
|
var renderer = (/** @type {!Blockly.blockRendering.Renderer} */ (
|
|
new Blockly.blockRendering.rendererMap_[name](name)));
|
|
renderer.init(theme, opt_rendererOverrides);
|
|
return renderer;
|
|
};
|