Ycc Engine API文档

Class: ScrollerRect

Ycc .UI. ScrollerRect

new Ycc.UI.ScrollerRect(option)

Ycc.UI.ScrollerRect.class.js, line 24

滚动区域UI 此UI只能为顶级UI

Name Type Description

option

object

所有可配置的配置项

Name	Type	Description
`rect`	Ycc.Math.Rect	容纳区。
`selfRender`	Boolean	是否自身实时渲染
`contentW`	number	滚动内容的宽
`contentH`	number	滚动内容的高

Extends

Ycc.UI.Polygon

Members

anchorXnumber

UI对象的锚点坐标。相对坐标。相对于rect的x 锚点坐标主要用于图形的旋转、平移、缩放

anchorYnumber

UI对象的锚点坐标。相对坐标。相对于rect的y 锚点坐标主要用于图形的旋转、平移、缩放

baseUIYcc.UI

基础绘图UI

belongToYcc.Layer

UI所属的图层

contentHnumber

滚动内容的高

contentWnumber

滚动内容的宽

coordinatesnull

多边形点坐标的数组，为保证图形能够闭合，起点和终点必须相等

ctxnull

绘图环境

ctxCachenull

缓存的绘图环境

disableTypeObject

被禁用的事件类型。key为type，val为boolean

dpinumber

设备像素比

enableSwipeboolean

是否禁用滑动事件

fillboolean

是否填充

fillStylestring

颜色

ghostboolean

此区域默认为幽灵

idnumber

UI的唯一ID

isDrawIndexboolean

是否绘制点的下标

isShowRotateBeforeUIboolean

是否显示缩放之前的位置

lineWidthnumber

线条宽度

listenersObject

所有的监听器。key为type，val为listener数组。

namestring

UI实例的名字

noneZeroModenumber

光线投射模式 1-升级模式 2-普通模式

onclickfunction

点击的监听。默认为null

oncomputeendfunction

计算属性后的hook

oncomputestartfunction

计算属性前的hook

ondragendfunction

拖拽结束的监听。默认为null

ondraggingfunction

拖拽的监听。默认为null

ondragstartfunction

拖拽开始的监听。默认为null

onmousedownfunction

鼠标按下的监听。默认为null

onmousemovefunction

鼠标移动的监听。默认为null

onmouseoutfunction

鼠标移出的监听。默认为null

onmouseoverfunction

鼠标移入的监听。默认为null

onmouseupfunction

鼠标抬起的监听。默认为null

onrenderendfunction

渲染后的hook

onrenderstartfunction

渲染前的hook

ontapfunction

点击事件的监听。默认为null

ontouchendfunction

触摸结束的监听。默认为null

ontouchmovefunction

触摸移动的监听。默认为null

ontouchstartfunction

触摸开始的监听。默认为null

opacitynumber

透明度

rectYcc.Math.Rect

UI的绘图区域

rectBgColorstring

容纳区的背景色

rectBorderColorstring

容纳区边框颜色

rectBorderWidthnumber

容纳区的边框宽度

rotationnumber

相对于锚点的旋转角度

selfRenderboolean

是否自身实时渲染，启用后，会实时重绘整个画布

showboolean

是否显示

stopAllEventboolean

只会阻止当前UI事件的触发，不会阻止其下面子元素事件的触发

stopEventBubbleUpboolean

不阻止事件传递

stopTypeObject

被阻止的事件类型。key为type，val为boolean

strokeStylestring

线条颜色

swipeAccelerationnumber

滑动事件加速度

swipeFrameCountnumber

滑动事件持续的帧数

swipeInitSpeednumber

滑动事件初始速度满足公式 s = (swipeInitSpeed - swipeFrameCount)*swipeFrameCount

userDatanull

用户自定义的数据

readonlyxnumber

位置x

readonlyynumber

位置y

yccClass

构造器的引用，Ycc中的每个类都有此属性

Methods

addChild(ui) Ycc.UI.ScrollerRect.class.js, line 154

重载基类方法

Name	Type	Description
`ui`

inherited addListener(type, listener) Ycc.Listener.class.js, line 234

添加某个类型的监听器

Name	Type	Description
`type`	string
`listener`	function

inherited clone(){Ycc.UI} Ycc.UI.Base.class.js, line 650

克隆ui

Returns:

Type	Description
Ycc.UI

inherited containDot(dot, noneZeroMode){boolean} Ycc.UI.Polygon.class.js, line 233

重载基类的包含某个点的函数，用于点击事件等的响应两种方法：方法一：经过该点的水平射线与多边形的焦点数，即Ray-casting Algorithm 方法二：某个点始终位于多边形逆时针向量的左侧、或者顺时针方向的右侧即可判断，算法名忘记了此方法采用方法一，并假设该射线平行于x轴，方向为x轴正方向

Name	Type	Description
`dot`	Ycc.Math.Dot	需要判断的点，绝对坐标
`noneZeroMode`	Number	是否noneZeroMode 1--启用 2--关闭默认启用从这个点引出一根“射线”，与多边形的任意若干条边相交，计数初始化为0，若相交处被多边形的边从左到右切过，计数+1，若相交处被多边形的边从右到左切过，计数-1，最后检查计数，如果是0，点在多边形外，如果非0，点在多边形内

Returns:

Type	Description
boolean

inherited disableEvent(type) Ycc.Listener.class.js, line 291

禁止某个事件触发

Name	Type	Description
`type`

inherited extend(option){Ycc.UI} Ycc.UI.Base.class.js, line 635

合并参数，只会合并对象中已存在的key

Name	Type	Description
`option`

Returns:

Type	Description
Ycc.UI

inherited getAbsolutePositionRect(){Ycc.Math.Rect} Ycc.UI.Polygon.class.js, line 174

获取能容纳当前UI的最小方形区域

Returns:

Type	Description
Ycc.Math.Rect

inherited getDeepLevel() Ycc.UI.Base.class.js, line 757

获取当前UI在树结构中的深度

inherited getMaxContentInWidth(content, width){string} Ycc.UI.Base.class.js, line 613

给定宽度，获取能容纳的最长单行字符串

Name	Type	Description
`content`	string	文本内容
`width`	number	指定宽度

Returns:

Type	Description
string

inherited init(layer) Ycc.UI.Base.class.js, line 252

在某个图层中初始化UI

Name	Type	Description
`layer`	Layer	图层

inherited isOutOfRect(rect) Ycc.UI.Base.class.js, line 407

判断当前区域在某个区域外

Name	Type	Description
`rect`	Ycc.Math.Rect

inherited isOutOfStage(){boolean} Ycc.UI.Base.class.js, line 393

判断ui是否存在于舞台之外，渲染时可以不予渲染在compute之后使用，判断更准确

Returns:

Type	Description
boolean

inherited removeChild(ui) Ycc.UI.Base.class.js, line 365

删除子ui

Name	Type	Description
`ui`

inherited removeListener(type, listener) Ycc.Listener.class.js, line 276

移除某个类型的监听器

Name	Type	Description
`type`
`listener`

inherited removeSelf() Ycc.UI.Base.class.js, line 343

删除自身。若子类包含多个UI，需要重载

render() Ycc.UI.ScrollerRect.class.js, line 140

绘制

inherited renderPath(ctx) Ycc.UI.Polygon.class.js, line 117

根据coordinates绘制路径只绘制路径，不填充、不描边继承的子类若不是多边形，需要重载此方法
开启离屏canvas后，此过程只会发生在离屏canvas中

Name	Type	Description
`ctx`		离屏canvas的绘图环境

inherited renderRectBgColor(absoluteRect) Ycc.UI.Base.class.js, line 286

渲染容纳区rect的背景色
开启离屏canvas后，此过程只会发生在离屏canvas中

Name	Type	Description
`absoluteRect`	Ycc.Math.Rect	容纳区的绝对位置

inherited renderRectBorder(absoluteRect) Ycc.UI.Base.class.js, line 311

渲染容纳区rect的边框
开启离屏canvas后，此过程只会发生在离屏canvas中

Name	Type	Description
`absoluteRect`	Ycc.Math.Rect	容纳区的绝对位置

inherited resumeEvent(type) Ycc.Listener.class.js, line 299

恢复某个事件的触发

Name	Type	Description
`type`

inherited scaleAndRotate() Ycc.UI.Base.class.js, line 377

坐标系的缩放和旋转。先缩放、再旋转。

TODO

子类渲染前需要调用此方法
多边形替换rect后，此方法废弃，不再调用

inherited stop(type) Ycc.Listener.class.js, line 246

阻止某个事件类型继续传递

Name	Type	Description
`type`

inherited transformByRotate(dot){Ycc.Math.Dot} Ycc.UI.Base.class.js, line 766

根据当前的锚点、旋转角度获取某个点的转换之后的坐标

Name	Type	Description
`dot`	Ycc.Math.Dot \| Array.<Ycc.Math.Dot>	需要转换的点，该点为相对坐标，相对于当前UI的父级

Returns:

Type	Description
Ycc.Math.Dot	转换后的点，该点为绝对坐标

inherited transformToAbsolute(dotOrArr){Ycc.Math.Dot|Array.<Ycc.Math.Dot>} Ycc.UI.Base.class.js, line 700

根据图层坐标和UI位置坐标，将某个点的相对坐标（相对于UI的父级），转换为舞台的绝对坐标

Name	Type	Description
`dotOrArr`	Ycc.Math.Dot \| Array.<Ycc.Math.Dot>

Returns:

Type	Description
Ycc.Math.Dot \| Array.<Ycc.Math.Dot>

inherited transformToLocal(dotOrArr){Ycc.Math.Dot|Array.<Ycc.Math.Dot>} Ycc.UI.Base.class.js, line 722

根据图层坐标和UI位置坐标，将某个点的绝对坐标，转换为相对于UI父级的相对坐标

Name	Type	Description
`dotOrArr`	Ycc.Math.Dot \| Array.<Ycc.Math.Dot>

Returns:

Type	Description
Ycc.Math.Dot \| Array.<Ycc.Math.Dot>

inherited triggerListener(type, data) Ycc.Listener.class.js, line 255

触发某一类型的监听器

Name	Type	Description
`type`
`data`

inherited triggerUIEventBubbleUp(type, x, y, originEvent){Array.<Ycc.UI>} Ycc.UI.Base.class.js, line 832

冒泡触发UI的事件

Name	Type	Description
`type`
`x`
`y`
`originEvent`		ycc事件所对应的原始事件

Returns:

Type	Description
Array.<Ycc.UI>	返回已触发事件的UI列表

Ycc Engine v0.0.7 API文档

Class: ScrollerRect

new Ycc.UI.ScrollerRect(option)

Extends

Members

anchorXnumber

anchorYnumber

baseUIYcc.UI

belongToYcc.Layer

contentHnumber

contentWnumber

coordinatesnull

ctxnull

ctxCachenull

disableTypeObject

dpinumber

enableSwipeboolean

fillboolean

fillStylestring

ghostboolean

idnumber

isDrawIndexboolean

isShowRotateBeforeUIboolean

lineWidthnumber

listenersObject

namestring

noneZeroModenumber

onclickfunction

oncomputeendfunction

oncomputestartfunction

ondragendfunction

ondraggingfunction

ondragstartfunction

onmousedownfunction

onmousemovefunction

onmouseoutfunction

onmouseoverfunction

onmouseupfunction

onrenderendfunction

onrenderstartfunction

ontapfunction

ontouchendfunction

ontouchmovefunction

ontouchstartfunction

opacitynumber

rectYcc.Math.Rect

rectBgColorstring

rectBorderColorstring

rectBorderWidthnumber

rotationnumber

selfRenderboolean

showboolean

stopAllEventboolean

stopEventBubbleUpboolean

stopTypeObject

strokeStylestring

swipeAccelerationnumber

swipeFrameCountnumber

swipeInitSpeednumber

userDatanull

readonlyxnumber

readonlyynumber

yccClass

Methods

addChild(ui)

inherited addListener(type, listener)

inherited clone(){Ycc.UI}

Returns:

inherited containDot(dot, noneZeroMode){boolean}

Returns:

inherited disableEvent(type)

inherited extend(option){Ycc.UI}

Returns:

inherited getAbsolutePositionRect(){Ycc.Math.Rect}

Returns:

inherited getDeepLevel()

inherited getMaxContentInWidth(content, width){string}

Returns:

inherited init(layer)

inherited isOutOfRect(rect)