import CONST from '../const';
import utils from '../utils';
/**
* A TextStyle Object decorates a Text Object. It can be shared between
* multiple Text objects. Changing the style will update all text objects using it.
*
* @class
* @memberof PIXI
* @param [style] {object} The style parameters
* @param [style.align='left'] {string} Alignment for multiline text ('left', 'center' or 'right'), does not affect single line text
* @param [style.breakWords=false] {boolean} Indicates if lines can be wrapped within words, it needs wordWrap to be set to true
* @param [style.dropShadow=false] {boolean} Set a drop shadow for the text
* @param [style.dropShadowAngle=Math.PI/6] {number} Set a angle of the drop shadow
* @param [style.dropShadowBlur=0] {number} Set a shadow blur radius
* @param [style.dropShadowColor='#000000'] {string} A fill style to be used on the dropshadow e.g 'red', '#00FF00'
* @param [style.dropShadowDistance=5] {number} Set a distance of the drop shadow
* @param [style.fill='black'] {string|string[]|number|number[]|CanvasGradient|CanvasPattern} A canvas fillstyle that will be used on the
* text e.g 'red', '#00FF00'. Can be an array to create a gradient eg ['#000000','#FFFFFF'] @see {@link https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/fillStyle|MDN}
* @param [style.fillGradientType=PIXI.TEXT_GRADIENT.LINEAR_VERTICAL] {number} If fills styles are supplied, this can change the type/direction of the gradient. See {@link PIXI.TEXT_GRADIENT} for possible values
* @param [style.fontFamily='Arial'] {string} The font family
* @param [style.fontSize=26] {number|string} The font size (as a number it converts to px, but as a string, equivalents are '26px','20pt','160%' or '1.6em')
* @param [style.fontStyle='normal'] {string} The font style ('normal', 'italic' or 'oblique')
* @param [style.fontVariant='normal'] {string} The font variant ('normal' or 'small-caps')
* @param [style.fontWeight='normal'] {string} The font weight ('normal', 'bold', 'bolder', 'lighter' and '100', '200', '300', '400', '500', '600', '700', 800' or '900')
* @param [style.letterSpacing=0] {number} The amount of spacing between letters, default is 0
* @param [style.lineHeight] {number} The line height, a number that represents the vertical space that a letter uses
* @param [style.lineJoin='miter'] {string} The lineJoin property sets the type of corner created, it can resolve
* spiked text issues. Default is 'miter' (creates a sharp corner).
* @param [style.miterLimit=10] {number} The miter limit to use when using the 'miter' lineJoin mode. This can reduce
* or increase the spikiness of rendered text.
* @param [style.padding=0] {number} Occasionally some fonts are cropped. Adding some padding will prevent this from
* happening by adding padding to all sides of the text.
* @param [style.stroke='black'] {string|number} A canvas fillstyle that will be used on the text stroke e.g 'blue', '#FCFF00'
* @param [style.strokeThickness=0] {number} A number that represents the thickness of the stroke. Default is 0 (no stroke)
* @param [style.textBaseline='alphabetic'] {string} The baseline of the text that is rendered.
* @param [style.wordWrap=false] {boolean} Indicates if word wrap should be used
* @param [style.wordWrapWidth=100] {number} The width at which text will wrap, it needs wordWrap to be set to true
*/
class TextStyle
{
constructor(style)
{
this.styleID = 0;
Object.assign(this, this._defaults, style);
}
/**
* Creates a new TextStyle object with the same values as this one.
* Note that the only the properties of the object are cloned.
*
* @return {PIXI.TextStyle} New cloned TextStyle object
*/
clone()
{
const clonedProperties = {};
for (const key in this._defaults)
{
clonedProperties[key] = this[key];
}
return new TextStyle(clonedProperties);
}
/**
* Resets all properties to the defaults specified in TextStyle.prototype._default
*/
reset()
{
Object.assign(this, this._defaults);
}
// Default settings. Explained in the constructor.
get _defaults()
{
return {
align: 'left',
breakWords: false,
dropShadow: false,
dropShadowAngle: Math.PI / 6,
dropShadowBlur: 0,
dropShadowColor: '#000000',
dropShadowDistance: 5,
fill: 'black',
fillGradientType: CONST.TEXT_GRADIENT.LINEAR_VERTICAL,
fontFamily: 'Arial',
fontSize: 26,
fontStyle: 'normal',
fontVariant: 'normal',
fontWeight: 'normal',
letterSpacing: 0,
lineHeight: 0,
lineJoin: 'miter',
miterLimit: 10,
padding: 0,
stroke: 'black',
strokeThickness: 0,
textBaseline: 'alphabetic',
wordWrap: false,
wordWrapWidth: 100
};
}
/**
* Create setters and getters for each of the style properties. Converts colors where necessary.
*/
get align()
{
return this._align;
}
set align(align)
{
if (this._align !== align)
{
this._align = align;
this.styleID++;
}
}
get breakWords()
{
return this._breakWords;
}
set breakWords(breakWords)
{
if (this._breakWords !== breakWords)
{
this._breakWords = breakWords;
this.styleID++;
}
}
get dropShadow()
{
return this._dropShadow;
}
set dropShadow(dropShadow)
{
if (this._dropShadow !== dropShadow)
{
this._dropShadow = dropShadow;
this.styleID++;
}
}
get dropShadowAngle()
{
return this._dropShadowAngle;
}
set dropShadowAngle(dropShadowAngle)
{
if (this._dropShadowAngle !== dropShadowAngle)
{
this._dropShadowAngle = dropShadowAngle;
this.styleID++;
}
}
get dropShadowBlur()
{
return this._dropShadowBlur;
}
set dropShadowBlur(dropShadowBlur)
{
if (this._dropShadowBlur !== dropShadowBlur)
{
this._dropShadowBlur = dropShadowBlur;
this.styleID++;
}
}
get dropShadowColor()
{
return this._dropShadowColor;
}
set dropShadowColor(dropShadowColor)
{
const outputColor = getColor(dropShadowColor);
if (this._dropShadowColor !== outputColor)
{
this._dropShadowColor = outputColor;
this.styleID++;
}
}
get dropShadowDistance()
{
return this._dropShadowDistance;
}
set dropShadowDistance(dropShadowDistance)
{
if (this._dropShadowDistance !== dropShadowDistance)
{
this._dropShadowDistance = dropShadowDistance;
this.styleID++;
}
}
get fill()
{
return this._fill;
}
set fill(fill)
{
const outputColor = getColor(fill);
if (this._fill !== outputColor)
{
this._fill = outputColor;
this.styleID++;
}
}
get fillGradientType()
{
return this._fillGradientType;
}
set fillGradientType(fillGradientType)
{
if (this._fillGradientType !== fillGradientType)
{
this._fillGradientType = fillGradientType;
this.styleID++;
}
}
get fontFamily()
{
return this._fontFamily;
}
set fontFamily(fontFamily)
{
if (this.fontFamily !== fontFamily)
{
this._fontFamily = fontFamily;
this.styleID++;
}
}
get fontSize()
{
return this._fontSize;
}
set fontSize(fontSize)
{
if (this._fontSize !== fontSize)
{
this._fontSize = fontSize;
this.styleID++;
}
}
get fontStyle()
{
return this._fontStyle;
}
set fontStyle(fontStyle)
{
if (this._fontStyle !== fontStyle)
{
this._fontStyle = fontStyle;
this.styleID++;
}
}
get fontVariant()
{
return this._fontVariant;
}
set fontVariant(fontVariant)
{
if (this._fontVariant !== fontVariant)
{
this._fontVariant = fontVariant;
this.styleID++;
}
}
get fontWeight()
{
return this._fontWeight;
}
set fontWeight(fontWeight)
{
if (this._fontWeight !== fontWeight)
{
this._fontWeight = fontWeight;
this.styleID++;
}
}
get letterSpacing()
{
return this._letterSpacing;
}
set letterSpacing(letterSpacing)
{
if (this._letterSpacing !== letterSpacing)
{
this._letterSpacing = letterSpacing;
this.styleID++;
}
}
get lineHeight()
{
return this._lineHeight;
}
set lineHeight(lineHeight)
{
if (this._lineHeight !== lineHeight)
{
this._lineHeight = lineHeight;
this.styleID++;
}
}
get lineJoin()
{
return this._lineJoin;
}
set lineJoin(lineJoin)
{
if (this._lineJoin !== lineJoin)
{
this._lineJoin = lineJoin;
this.styleID++;
}
}
get miterLimit()
{
return this._miterLimit;
}
set miterLimit(miterLimit)
{
if (this._miterLimit !== miterLimit)
{
this._miterLimit = miterLimit;
this.styleID++;
}
}
get padding()
{
return this._padding;
}
set padding(padding)
{
if (this._padding !== padding)
{
this._padding = padding;
this.styleID++;
}
}
get stroke()
{
return this._stroke;
}
set stroke(stroke)
{
const outputColor = getColor(stroke);
if (this._stroke !== outputColor)
{
this._stroke = outputColor;
this.styleID++;
}
}
get strokeThickness()
{
return this._strokeThickness;
}
set strokeThickness(strokeThickness)
{
if (this._strokeThickness !== strokeThickness)
{
this._strokeThickness = strokeThickness;
this.styleID++;
}
}
get textBaseline()
{
return this._textBaseline;
}
set textBaseline(textBaseline)
{
if (this._textBaseline !== textBaseline)
{
this._textBaseline = textBaseline;
this.styleID++;
}
}
get wordWrap()
{
return this._wordWrap;
}
set wordWrap(wordWrap)
{
if (this._wordWrap !== wordWrap)
{
this._wordWrap = wordWrap;
this.styleID++;
}
}
get wordWrapWidth()
{
return this._wordWrapWidth;
}
set wordWrapWidth(wordWrapWidth)
{
if (this._wordWrapWidth !== wordWrapWidth)
{
this._wordWrapWidth = wordWrapWidth;
this.styleID++;
}
}
}
/**
* Utility function to convert hexadecimal colors to strings, and simply return the color if it's a string.
*
* @return {string} The color as a string.
*/
function getColor(color)
{
if (typeof color === 'number')
{
return utils.hex2string(color);
}
else if (Array.isArray(color))
{
for (let i = 0; i < color.length; ++i)
{
if (typeof color[i] === 'number')
{
color[i] = utils.hex2string(color[i]);
}
}
}
return color;
}
export default TextStyle;
