/**
* @license
* Copyright The Closure Library Authors.
* SPDX-License-Identifier: Apache-2.0
*/
/**
* @fileoverview Graphics surface type.
*/
// TODO(user): We're trying to migrate all ES5 subclasses of Closure
// Library to ES6. In ES6 this cannot be referenced before super is called. This
// file has at least one this before a super call (in ES5) and cannot be
// automatically upgraded to ES6 as a result. Please fix this if you have a
// chance. Note: This can sometimes be caused by not calling the super
// constructor at all. You can run the conversion tool yourself to see what it
// does on this file: blaze run //javascript/refactoring/es6_classes:convert.
goog.provide('goog.graphics.ext.Graphics');
goog.require('goog.events');
goog.require('goog.events.EventType');
goog.require('goog.graphics');
goog.require('goog.graphics.ext.Group');
goog.requireType('goog.dom.DomHelper');
goog.requireType('goog.graphics.AbstractGraphics');
goog.requireType('goog.math.Coordinate');
goog.requireType('goog.math.Size');
/**
* Wrapper for a graphics surface.
* @param {string|number} width The width in pixels. Strings
* expressing percentages of parent with (e.g. '80%') are also accepted.
* @param {string|number} height The height in pixels. Strings
* expressing percentages of parent with (e.g. '80%') are also accepted.
* @param {?number=} opt_coordWidth The coordinate width - if
* omitted or null, defaults to same as width.
* @param {?number=} opt_coordHeight The coordinate height. - if
* omitted or null, defaults to same as height.
* @param {goog.dom.DomHelper=} opt_domHelper The DOM helper object for the
* document we want to render in.
* @param {boolean=} opt_isSimple Flag used to indicate the graphics object will
* be drawn to in a single pass, and the fastest implementation for this
* scenario should be favored. NOTE: Setting to true may result in
* degradation of text support.
* @constructor
* @extends {goog.graphics.ext.Group}
* @final
*/
goog.graphics.ext.Graphics = function(
width, height, opt_coordWidth, opt_coordHeight, opt_domHelper,
opt_isSimple) {
'use strict';
const surface = opt_isSimple ?
goog.graphics.createSimpleGraphics(
width, height, opt_coordWidth, opt_coordHeight, opt_domHelper) :
goog.graphics.createGraphics(
width, height, opt_coordWidth, opt_coordHeight, opt_domHelper);
this.implementation_ = surface;
goog.graphics.ext.Group.call(this, null, surface.getCanvasElement());
goog.events.listen(
surface, goog.events.EventType.RESIZE, this.updateChildren, false, this);
};
goog.inherits(goog.graphics.ext.Graphics, goog.graphics.ext.Group);
/**
* The root level graphics implementation.
* @type {goog.graphics.AbstractGraphics}
* @private
*/
goog.graphics.ext.Graphics.prototype.implementation_;
/**
* @return {goog.graphics.AbstractGraphics} The graphics implementation layer.
*/
goog.graphics.ext.Graphics.prototype.getImplementation = function() {
'use strict';
return this.implementation_;
};
/**
* Changes the coordinate size.
* @param {number} coordWidth The coordinate width.
* @param {number} coordHeight The coordinate height.
*/
goog.graphics.ext.Graphics.prototype.setCoordSize = function(
coordWidth, coordHeight) {
'use strict';
this.implementation_.setCoordSize(coordWidth, coordHeight);
goog.graphics.ext.Graphics.superClass_.setSize.call(
this, coordWidth, coordHeight);
};
/**
* @return {goog.math.Size} The coordinate size.
*/
goog.graphics.ext.Graphics.prototype.getCoordSize = function() {
'use strict';
return this.implementation_.getCoordSize();
};
/**
* Changes the coordinate system position.
* @param {number} left The coordinate system left bound.
* @param {number} top The coordinate system top bound.
*/
goog.graphics.ext.Graphics.prototype.setCoordOrigin = function(left, top) {
'use strict';
this.implementation_.setCoordOrigin(left, top);
};
/**
* @return {!goog.math.Coordinate} The coordinate system position.
*/
goog.graphics.ext.Graphics.prototype.getCoordOrigin = function() {
'use strict';
return this.implementation_.getCoordOrigin();
};
/**
* Change the size of the canvas.
* @param {number} pixelWidth The width in pixels.
* @param {number} pixelHeight The height in pixels.
*/
goog.graphics.ext.Graphics.prototype.setPixelSize = function(
pixelWidth, pixelHeight) {
'use strict';
this.implementation_.setSize(pixelWidth, pixelHeight);
const coordSize = this.getCoordSize();
goog.graphics.ext.Graphics.superClass_.setSize.call(
this, coordSize.width, coordSize.height);
};
/**
* @return {goog.math.Size?} Returns the number of pixels spanned by the
* surface, or null if the size could not be computed due to the size being
* specified in percentage points and the component not being in the
* document.
*/
goog.graphics.ext.Graphics.prototype.getPixelSize = function() {
'use strict';
return this.implementation_.getPixelSize();
};
/**
* @return {number} The coordinate width of the canvas.
* @override
*/
goog.graphics.ext.Graphics.prototype.getWidth = function() {
'use strict';
return this.implementation_.getCoordSize().width;
};
/**
* @return {number} The coordinate width of the canvas.
* @override
*/
goog.graphics.ext.Graphics.prototype.getHeight = function() {
'use strict';
return this.implementation_.getCoordSize().height;
};
/**
* @return {number} Returns the number of pixels per unit in the x direction.
* @override
*/
goog.graphics.ext.Graphics.prototype.getPixelScaleX = function() {
'use strict';
return this.implementation_.getPixelScaleX();
};
/**
* @return {number} Returns the number of pixels per unit in the y direction.
* @override
*/
goog.graphics.ext.Graphics.prototype.getPixelScaleY = function() {
'use strict';
return this.implementation_.getPixelScaleY();
};
/**
* @return {Element} The root element of the graphics surface.
*/
goog.graphics.ext.Graphics.prototype.getElement = function() {
'use strict';
return this.implementation_.getElement();
};
/**
* Renders the underlying graphics.
*
* @param {Element} parentElement Parent element to render the component into.
*/
goog.graphics.ext.Graphics.prototype.render = function(parentElement) {
'use strict';
this.implementation_.render(parentElement);
};
/**
* Never transform a surface.
* @override
*/
goog.graphics.ext.Graphics.prototype.transform = goog.nullFunction;
/**
* Called from the parent class, this method resets any pre-computed positions
* and sizes.
* @protected
* @override
*/
goog.graphics.ext.Graphics.prototype.redraw = function() {
'use strict';
this.transformChildren();
};