Graphics 类型

继承于 RenderComponent

模块: cc 父模块: cc

索引

属性(properties)
  • lineWidth Number 当前线条宽度
  • lineJoin Graphics.LineJoin lineJoin 用来设置2个长度不为0的相连部分(线段,圆弧,曲线)如何连接在一起的属性。
  • lineCap Graphics.LineCap lineCap 指定如何绘制每一条线段末端。
  • strokeColor Color 线段颜色
  • fillColor Color 填充颜色
  • miterLimit Number 设置斜接面限制比例
  • srcBlendFactor macro.BlendFactor 指定原图的混合模式,这会克隆一个新的材质对象,注意这带来的
  • dstBlendFactor macro.BlendFactor 指定目标的混合模式
  • __eventTargets Array Register all related EventTargets,...
  • node Node 该组件被附加到的节点。
  • uuid String 组件的 uuid,用于编辑器。
  • _enabled Boolean
  • enabled Boolean 表示该组件自身是否启用。
  • enabledInHierarchy Boolean 表示该组件是否被启用并且所在的节点也处于激活状态。
  • _isOnLoadCalled Number 返回一个值用来判断 onLoad 是否被调用过,不等于 0 时调用过,等于 0 时未调用。
  • _name String
  • _objFlags Number
  • name String 该对象的名称。
  • isValid Boolean 表示该对象是否可用(被 destroy 后将不可用)。
方法
  • moveTo 移动路径起点到坐标(x, y)
  • lineTo 绘制直线路径
  • bezierCurveTo 绘制三次贝赛尔曲线路径
  • quadraticCurveTo 绘制二次贝赛尔曲线路径
  • arc 绘制圆弧路径。
  • ellipse 绘制椭圆路径。
  • circle 绘制圆形路径。
  • rect 绘制矩形路径。
  • roundRect 绘制圆角矩形路径。
  • fillRect 绘制填充矩形。
  • clear 擦除之前绘制的所有内容的方法。
  • close 将笔点返回到当前路径起始点的。
  • stroke 根据当前的画线样式,绘制当前或已经存在的路径。
  • fill 根据当前的画线样式,填充当前或已经存在的路径。
  • update 如果该组件启用,则每帧调用 update。
  • lateUpdate 如果该组件启用,则每帧调用 LateUpdate。
  • __preload __preload is called before every onLoad....
  • onLoad 当附加到一个激活的节点上或者其节点第一次激活时候调用。
  • start 如果该组件第一次启用,则在所有组件的 update 之前调用。
  • onEnable 当该组件被启用,并且它的节点也激活时。
  • onDisable 当该组件被禁用或节点变为无效时调用。
  • onDestroy 该方法为生命周期方法,父类未必会有实现。
  • onFocusInEditor
  • onLostFocusInEditor
  • resetInEditor 用来初始化组件或节点的一些属性,当该组件被第一次添加到节点上或用户点击了它的 Reset 菜单时调用。
  • addComponent 向节点添加一个组件类,你还可以通过传入脚本的名称来添加组件。
  • getComponent 获取节点上指定类型的组件,如果节点有附加指定类型的组件,则返回,如果没有则为空。
  • getComponents 返回节点上指定类型的所有组件。
  • getComponentInChildren 递归查找所有子节点中第一个匹配指定类型的组件。
  • getComponentsInChildren 递归查找自身或所有子节点中指定类型的组件
  • _getLocalBounds 以便编辑器的场景视图可以正确地执行点选测试。
  • onRestore onRestore 是用户在检查器菜单点击 Reset 时,对此组件执行撤消操作后调用的。
  • schedule 调度一个自定义的回调函数。
  • scheduleOnce 调度一个只运行一次的回调函数,可以指定 0 让回调函数在下一帧立即执行或者在一定的延时之后执行。
  • unschedule 取消调度一个自定义的回调函数。
  • unscheduleAllCallbacks 取消调度所有已调度的回调函数:定制的回调函数以及 'update' 回调函数。
  • destroy 销毁该对象,并释放所有它对其它对象的引用。
  • _destruct Clear all references in the instance....
  • _onPreDestroy Called before the object being destroyed.
  • _serialize The customized serialization for this object. (Editor Only)
  • _deserialize Init this object from the custom serialized data.

Details

属性(properties)

lineWidth

当前线条宽度

meta description
类型 Number
定义于 cocos2d/core/graphics/graphics.js:61
lineJoin

lineJoin 用来设置2个长度不为0的相连部分(线段,圆弧,曲线)如何连接在一起的属性。

meta description
类型 Graphics.LineJoin
定义于 cocos2d/core/graphics/graphics.js:79
lineCap

lineCap 指定如何绘制每一条线段末端。

meta description
类型 Graphics.LineCap
定义于 cocos2d/core/graphics/graphics.js:98
strokeColor

线段颜色

meta description
类型 Color
定义于 cocos2d/core/graphics/graphics.js:117
fillColor

填充颜色

meta description
类型 Color
定义于 cocos2d/core/graphics/graphics.js:134
miterLimit

设置斜接面限制比例

meta description
类型 Number
定义于 cocos2d/core/graphics/graphics.js:151
srcBlendFactor

指定原图的混合模式,这会克隆一个新的材质对象,注意这带来的

meta description
类型 macro.BlendFactor
定义于 cocos2d/core/components/CCRenderComponent.js:58
示例
sprite.srcBlendFactor = cc.macro.BlendFactor.ONE;
dstBlendFactor

指定目标的混合模式

meta description
类型 macro.BlendFactor
定义于 cocos2d/core/components/CCRenderComponent.js:80
示例
sprite.dstBlendFactor = cc.macro.BlendFactor.ONE;
__eventTargets

Register all related EventTargets, all event callbacks will be removed in _onPreDestroy

meta description
类型 Array
定义于 cocos2d/core/components/CCComponent.js:61
node

该组件被附加到的节点。组件总会附加到一个节点。

meta description
类型 Node
定义于 cocos2d/core/components/CCComponent.js:75
示例
cc.log(comp.node);
uuid

组件的 uuid,用于编辑器。

meta description
类型 String
定义于 cocos2d/core/components/CCComponent.js:106
示例
cc.log(comp.uuid);
_enabled
meta description
类型 Boolean
定义于 cocos2d/core/components/CCComponent.js:147
enabled

表示该组件自身是否启用。

meta description
类型 Boolean
定义于 cocos2d/core/components/CCComponent.js:154
示例
comp.enabled = true;
cc.log(comp.enabled);
enabledInHierarchy

表示该组件是否被启用并且所在的节点也处于激活状态。

meta description
类型 Boolean
定义于 cocos2d/core/components/CCComponent.js:185
示例
cc.log(comp.enabledInHierarchy);
_isOnLoadCalled

返回一个值用来判断 onLoad 是否被调用过,不等于 0 时调用过,等于 0 时未调用。

meta description
类型 Number
定义于 cocos2d/core/components/CCComponent.js:201
示例
cc.log(this._isOnLoadCalled > 0);
_name
meta description
类型 String
定义于 cocos2d/core/platform/CCObject.js:76
_objFlags
meta description
类型 Number
定义于 cocos2d/core/platform/CCObject.js:83
name

该对象的名称。

meta description
类型 String
定义于 cocos2d/core/platform/CCObject.js:243
示例
obj.name = "New Obj";
isValid

表示该对象是否可用(被 destroy 后将不可用)。
当一个对象的 destroy 调用以后,会在这一帧结束后才真正销毁。因此从下一帧开始 isValid 就会返回 false,而当前帧内 isValid 仍然会是 true。如果希望判断当前帧是否调用过 destroy,请使用 cc.isValid(obj, true),不过这往往是特殊的业务需求引起的,通常情况下不需要这样。

meta description
类型 Boolean
定义于 cocos2d/core/platform/CCObject.js:261
示例
var node = new cc.Node();
cc.log(node.isValid);    // true
node.destroy();
cc.log(node.isValid);    // true, still valid in this frame
// after a frame...
cc.log(node.isValid);    // false, destroyed in the end of last frame

方法

moveTo

移动路径起点到坐标(x, y)

meta description
定义于 cocos2d/core/graphics/graphics.js:212
参数列表
  • x Number The x axis of the coordinate for the end point.
  • y Number The y axis of the coordinate for the end point.
lineTo

绘制直线路径

meta description
定义于 cocos2d/core/graphics/graphics.js:227
参数列表
  • x Number The x axis of the coordinate for the end point.
  • y Number The y axis of the coordinate for the end point.
bezierCurveTo

绘制三次贝赛尔曲线路径

meta description
定义于 cocos2d/core/graphics/graphics.js:242
参数列表
  • c1x Number The x axis of the coordinate for the first control point.
  • c1y Number The y axis of the coordinate for first control point.
  • c2x Number The x axis of the coordinate for the second control point.
  • c2y Number The y axis of the coordinate for the second control point.
  • x Number The x axis of the coordinate for the end point.
  • y Number The y axis of the coordinate for the end point.
quadraticCurveTo

绘制二次贝赛尔曲线路径

meta description
定义于 cocos2d/core/graphics/graphics.js:257
参数列表
  • cx Number The x axis of the coordinate for the control point.
  • cy Number The y axis of the coordinate for the control point.
  • x Number The x axis of the coordinate for the end point.
  • y Number The y axis of the coordinate for the end point.
arc

绘制圆弧路径。圆弧路径的圆心在 (cx, cy) 位置,半径为 r ,根据 counterclockwise (默认为false)指定的方向从 startAngle 开始绘制,到 endAngle 结束。

meta description
定义于 cocos2d/core/graphics/graphics.js:270
参数列表
  • cx Number The x axis of the coordinate for the center point.
  • cy Number The y axis of the coordinate for the center point.
  • r Number The arc's radius.
  • startAngle Number The angle at which the arc starts, measured clockwise from the positive x axis and expressed in radians.
  • endAngle Number The angle at which the arc ends, measured clockwise from the positive x axis and expressed in radians.
  • counterclockwise Boolean An optional Boolean which, if true, causes the arc to be drawn counter-clockwise between the two angles. By default it is drawn clockwise.
ellipse

绘制椭圆路径。

meta description
定义于 cocos2d/core/graphics/graphics.js:285
参数列表
  • cx Number The x axis of the coordinate for the center point.
  • cy Number The y axis of the coordinate for the center point.
  • rx Number The ellipse's x-axis radius.
  • ry Number The ellipse's y-axis radius.
circle

绘制圆形路径。

meta description
定义于 cocos2d/core/graphics/graphics.js:298
参数列表
  • cx Number The x axis of the coordinate for the center point.
  • cy Number The y axis of the coordinate for the center point.
  • r Number The circle's radius.
rect

绘制矩形路径。

meta description
定义于 cocos2d/core/graphics/graphics.js:310
参数列表
  • x Number The x axis of the coordinate for the rectangle starting point.
  • y Number The y axis of the coordinate for the rectangle starting point.
  • w Number The rectangle's width.
  • h Number The rectangle's height.
roundRect

绘制圆角矩形路径。

meta description
定义于 cocos2d/core/graphics/graphics.js:323
参数列表
  • x Number The x axis of the coordinate for the rectangle starting point.
  • y Number The y axis of the coordinate for the rectangle starting point.
  • w Number The rectangles width.
  • h Number The rectangle's height.
  • r Number The radius of the rectangle.
fillRect

绘制填充矩形。

meta description
定义于 cocos2d/core/graphics/graphics.js:337
参数列表
  • x Number The x axis of the coordinate for the rectangle starting point.
  • y Number The y axis of the coordinate for the rectangle starting point.
  • w Number The rectangle's width.
  • h Number The rectangle's height.
clear

擦除之前绘制的所有内容的方法。

meta description
定义于 cocos2d/core/graphics/graphics.js:351
参数列表
  • clean Boolean Whether to clean the graphics inner cache.
close

将笔点返回到当前路径起始点的。它尝试从当前点到起始点绘制一条直线。

meta description
定义于 cocos2d/core/graphics/graphics.js:361
stroke

根据当前的画线样式,绘制当前或已经存在的路径。

meta description
定义于 cocos2d/core/graphics/graphics.js:370
fill

根据当前的画线样式,填充当前或已经存在的路径。

meta description
定义于 cocos2d/core/graphics/graphics.js:379
update

如果该组件启用,则每帧调用 update。
该方法为生命周期方法,父类未必会有实现。并且你只能在该方法内部调用父类的实现,不可在其它地方直接调用该方法。

meta description
定义于 cocos2d/core/components/CCComponent.js:222
参数列表
  • dt Number the delta time in seconds it took to complete the last frame
lateUpdate

如果该组件启用,则每帧调用 LateUpdate。
该方法为生命周期方法,父类未必会有实现。并且你只能在该方法内部调用父类的实现,不可在其它地方直接调用该方法。

meta description
定义于 cocos2d/core/components/CCComponent.js:233
__preload

__preload is called before every onLoad. It is used to initialize the builtin components internally, to avoid checking whether onLoad is called before every public method calls. This method should be removed if script priority is supported.

meta description
定义于 cocos2d/core/components/CCComponent.js:243
onLoad

当附加到一个激活的节点上或者其节点第一次激活时候调用。onLoad 总是会在任何 start 方法调用前执行,这能用于安排脚本的初始化顺序。
该方法为生命周期方法,父类未必会有实现。并且你只能在该方法内部调用父类的实现,不可在其它地方直接调用该方法。

meta description
定义于 cocos2d/core/components/CCComponent.js:254
start

如果该组件第一次启用,则在所有组件的 update 之前调用。通常用于需要在所有组件的 onLoad 初始化完毕后执行的逻辑。
该方法为生命周期方法,父类未必会有实现。并且你只能在该方法内部调用父类的实现,不可在其它地方直接调用该方法。

meta description
定义于 cocos2d/core/components/CCComponent.js:267
onEnable

当该组件被启用,并且它的节点也激活时。
该方法为生命周期方法,父类未必会有实现。并且你只能在该方法内部调用父类的实现,不可在其它地方直接调用该方法。

meta description
定义于 cocos2d/core/components/CCComponent.js:280
onDisable

当该组件被禁用或节点变为无效时调用。
该方法为生命周期方法,父类未必会有实现。并且你只能在该方法内部调用父类的实现,不可在其它地方直接调用该方法。

meta description
定义于 cocos2d/core/components/CCComponent.js:290
onDestroy

当该组件被销毁时调用
该方法为生命周期方法,父类未必会有实现。并且你只能在该方法内部调用父类的实现,不可在其它地方直接调用该方法。

meta description
定义于 cocos2d/core/components/CCComponent.js:300
onFocusInEditor
meta description
定义于 cocos2d/core/components/CCComponent.js:310
onLostFocusInEditor
meta description
定义于 cocos2d/core/components/CCComponent.js:315
resetInEditor

用来初始化组件或节点的一些属性,当该组件被第一次添加到节点上或用户点击了它的 Reset 菜单时调用。这个回调只会在编辑器下调用。

meta description
定义于 cocos2d/core/components/CCComponent.js:320
addComponent

向节点添加一个组件类,你还可以通过传入脚本的名称来添加组件。

meta description
返回 Component
定义于 cocos2d/core/components/CCComponent.js:330
参数列表
  • typeOrClassName Function | String the constructor or the class name of the component to add
示例
var sprite = node.addComponent(cc.Sprite);
var test = node.addComponent("Test");
getComponent

获取节点上指定类型的组件,如果节点有附加指定类型的组件,则返回,如果没有则为空。
传入参数也可以是脚本的名称。

meta description
返回 Component
定义于 cocos2d/core/components/CCComponent.js:348
参数列表
示例
// get sprite component.
var sprite = node.getComponent(cc.Sprite);
// get custom test calss.
var test = node.getComponent("Test");
getComponents

返回节点上指定类型的所有组件。

meta description
返回 Component[]
定义于 cocos2d/core/components/CCComponent.js:372
参数列表
示例
var sprites = node.getComponents(cc.Sprite);
var tests = node.getComponents("Test");
getComponentInChildren

递归查找所有子节点中第一个匹配指定类型的组件。

meta description
返回 Component
定义于 cocos2d/core/components/CCComponent.js:390
参数列表
示例
var sprite = node.getComponentInChildren(cc.Sprite);
var Test = node.getComponentInChildren("Test");
getComponentsInChildren

递归查找自身或所有子节点中指定类型的组件

meta description
返回 Component[]
定义于 cocos2d/core/components/CCComponent.js:408
参数列表
示例
var sprites = node.getComponentsInChildren(cc.Sprite);
var tests = node.getComponentsInChildren("Test");
_getLocalBounds

如果组件的包围盒与节点不同,您可以实现该方法以提供自定义的轴向对齐的包围盒(AABB), 以便编辑器的场景视图可以正确地执行点选测试。

meta description
定义于 cocos2d/core/components/CCComponent.js:428
参数列表
  • out_rect Rect the Rect to receive the bounding box
onRestore

onRestore 是用户在检查器菜单点击 Reset 时,对此组件执行撤消操作后调用的。

如果组件包含了“内部状态”(不在 CCClass 属性中定义的临时成员变量),那么你可能需要实现该方法。

编辑器执行撤销/重做操作时,将调用组件的 get set 来录制和还原组件的状态。 然而,在极端的情况下,它可能无法良好运作。
那么你就应该实现这个方法,手动根据组件的属性同步“内部状态”。 一旦你实现这个方法,当用户撤销或重做时,组件的所有 get set 都不会再被调用。 这意味着仅仅指定了默认值的属性将被编辑器记录和还原。

同样的,编辑可能无法在极端情况下正确地重置您的组件。
于是如果你需要支持组件重置菜单,你需要在该方法中手工同步组件属性到“内部状态”。
一旦你实现这个方法,组件的所有 get set 都不会在重置操作时被调用。 这意味着仅仅指定了默认值的属性将被编辑器重置。
此方法仅在编辑器下会被调用。

meta description
定义于 cocos2d/core/components/CCComponent.js:441
schedule

调度一个自定义的回调函数。
如果回调函数已调度,那么将不会重复调度它,只会更新时间间隔参数。

meta description
定义于 cocos2d/core/components/CCComponent.js:535
参数列表
  • callback function The callback function
  • interval Number Tick interval in seconds. 0 means tick every frame.
  • repeat Number The selector will be executed (repeat + 1) times, you can use cc.macro.REPEAT_FOREVER for tick infinitely.
  • delay Number The amount of time that the first tick will wait before execution.
示例
var timeCallback = function (dt) {
  cc.log("time: " + dt);
}
this.schedule(timeCallback, 1);
scheduleOnce

调度一个只运行一次的回调函数,可以指定 0 让回调函数在下一帧立即执行或者在一定的延时之后执行。

meta description
定义于 cocos2d/core/components/CCComponent.js:572
参数列表
  • callback function A function wrapped as a selector
  • delay Number The amount of time that the first tick will wait before execution.
示例
var timeCallback = function (dt) {
  cc.log("time: " + dt);
}
this.scheduleOnce(timeCallback, 2);
unschedule

取消调度一个自定义的回调函数。

meta description
定义于 cocos2d/core/components/CCComponent.js:589
参数列表
  • callback_fn function A function wrapped as a selector
示例
this.unschedule(_callback);
unscheduleAllCallbacks

取消调度所有已调度的回调函数:定制的回调函数以及 'update' 回调函数。动作不受此方法影响。

meta description
定义于 cocos2d/core/components/CCComponent.js:605
示例
this.unscheduleAllCallbacks();
destroy

销毁该对象,并释放所有它对其它对象的引用。
实际销毁操作会延迟到当前帧渲染前执行。从下一帧开始,该对象将不再可用。 您可以在访问对象之前使用 cc.isValid(obj) 来检查对象是否已被销毁。

meta description
返回 Boolean
定义于 cocos2d/core/platform/CCObject.js:296
示例
obj.destroy();
_destruct

Clear all references in the instance.

NOTE: this method will not clear the getter or setter functions which defined in the instance of CCObject. You can override the _destruct method if you need, for example: _destruct: function () { for (var key in this) { if (this.hasOwnProperty(key)) { switch (typeof this[key]) { case 'string': this[key] = ''; break; case 'object': case 'function': this[key] = null; break; } } }

meta description
定义于 cocos2d/core/platform/CCObject.js:430
_onPreDestroy

Called before the object being destroyed.

meta description
定义于 cocos2d/core/platform/CCObject.js:463
_serialize

The customized serialization for this object. (Editor Only)

meta description
返回 object
定义于 cocos2d/core/platform/CCObject.js:488
参数列表
_deserialize

Init this object from the custom serialized data.

meta description
定义于 cocos2d/core/platform/CCObject.js:498
参数列表
  • data Object the serialized json data
  • ctx _Deserializer

results matching ""

    No results matching ""