Files
cocos4/cocos2d/core/components/CCLabelOutline.js
T
2016-05-17 12:13:30 +08:00

115 lines
3.8 KiB
JavaScript

/****************************************************************************
Copyright (c) 2013-2016 Chukong Technologies Inc.
http://www.cocos.com
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated engine source code (the "Software"), a limited,
worldwide, royalty-free, non-assignable, revocable and non-exclusive license
to use Cocos Creator solely to develop games on your target platforms. You shall
not use Cocos Creator software for developing other software or tools that's
used for developing games. You are not granted to publish, distribute,
sublicense, and/or sell copies of Cocos Creator.
The software or tools in this License Agreement are licensed, not sold.
Chukong Aipu reserves all rights not expressly granted to you.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
****************************************************************************/
/**
* !#en Outline effect used to change the display, only used for TTF font
* !#zh 描边效果组件,用于字体描边,只能用于系统字体
* @class LabelOutline
* @extends Component
* @example
* // Create a new node and add label components.
* var node = new cc.Node("New Label");
* var label = node.addComponent(cc.Label);
* var outline = node.addComponent(cc.LabelOutline);
* node.parent = this.node;
*/
var LabelOutline = cc.Class({
name: 'cc.LabelOutline', extends: require('./CCComponent'),
editor: CC_EDITOR && {
menu: 'i18n:MAIN_MENU.component.renderers/LabelOutline',
executeInEditMode: true,
requireComponent: cc.Label,
},
ctor: function() {
this._labelSGNode = null;
},
properties: {
/**
* !#en Change the outline color
* !#zh 改变描边的颜色
* @property color
* @type {Color}
* @example
* outline.color = new cc.Color(0.5, 0.3, 0.7, 1.0);;
*/
_color: cc.color(255,255,255,255),
_width: 1,
color: {
get: function() {
return this._color;
},
set:function(value) {
this._color = cc.color(value);
if(this._labelSGNode) {
this._labelSGNode.setOutlineColor(cc.color(this._color));
}
}
},
/**
* !#en Change the outline width
* !#zh 改变描边的宽度
* @property width
* @type {Number}
* @example
* outline.width = 3;
*/
width: {
get: function() {
return this._width;
},
set: function(value) {
this._width = value;
if(this._labelSGNode) {
this._labelSGNode.setOutlineWidth(value);
}
}
},
},
onEnable: function () {
var label = this.node.getComponent('cc.Label');
var sgNode = this._labelSGNode = label && label._sgNode;
if(this._labelSGNode) {
sgNode.setOutlined(true);
sgNode.setOutlineColor(cc.color(this._color));
sgNode.setOutlineWidth(this._width);
}
},
onDisable: function () {
if(this._labelSGNode) {
this._labelSGNode.setOutlined(false);
}
this._labelSGNode = null;
},
});
cc.LabelOutline = module.exports = LabelOutline;