For internal usage.
快速滑动翻页临界值。 当用户快速滑动时,会根据滑动开始和结束的距离与时间计算出一个速度值, 该值与此临界值相比较,如果大于临界值,则进行自动翻页。
回弹持续的时间,0 表示将立即反弹。
开启惯性后,在用户停止触摸后滚动多快停止,0表示永不停止,1表示立刻停止。
是否允许滚动内容超过边界,并在停止触摸后回弹。
是否开启滚动惯性。
该组件被附加到的节点。组件总会附加到一个节点。
滚动视图的事件回调函数
每个页面翻页时所需时间。单位:秒
返回一个值用来判断 onLoad 是否被调用过,不等于 0 时调用过,等于 0 时未调用。
表示该组件自身是否启用。
表示该组件自身是否启用。
表示该组件是否被启用并且所在的节点也处于激活状态。
页面视图指示器组件
页面视图指示器组件
表示该对象是否可用(被 destroy 后将不可用)。
当一个对象的 destroy
调用以后,会在这一帧结束后才真正销毁。
因此从下一帧开始 isValid
就会返回 false,而当前帧内 isValid
仍然会是 true。
如果希望判断当前帧是否调用过 destroy
,请使用 isValid(obj, true)
,不过这往往是特殊的业务需求引起的,通常情况下不需要这样。
设置 PageView PageTurning 事件的发送时机。
设置 PageView PageTurning 事件的发送时机。
滚动临界值,默认单位百分比,当拖拽超出该数值时,松开会自动滚动下一页,小于时则还原。
滚动临界值,默认单位百分比,当拖拽超出该数值时,松开会自动滚动下一页,小于时则还原。
组件的 uuid,用于编辑器。
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; } } }
如果组件的包围盒与节点不同,您可以实现该方法以提供自定义的轴向对齐的包围盒(AABB), 以便编辑器的场景视图可以正确地执行点选测试。
The rect to store the result bounding rect
向节点添加一个指定类型的组件类,你还可以通过传入脚本的名称来添加组件。
The class of component to be retrieved or to be created
向节点添加一个指定类型的组件类,你还可以通过传入脚本的名称来添加组件。
A string for the class name of the component
在当前页面视图的尾部插入一个新视图。
新视图。
获取节点上指定类型的组件,如果节点有附加指定类型的组件,则返回,如果没有则为空。
传入参数也可以是脚本的名称。
The class of component to be retrieved or to be created
获取节点上指定类型的组件,如果节点有附加指定类型的组件,则返回,如果没有则为空。
传入参数也可以是脚本的名称。
A string for the class name of the component
递归查找所有子节点中第一个匹配指定类型的组件。
The class of component to be retrieved
递归查找所有子节点中第一个匹配指定类型的组件。
A string for the class name of the component
返回节点上指定类型的所有组件。
The class of components to be retrieved
返回节点上指定类型的所有组件。
A string for the class name of the components
递归查找自身或所有子节点中指定类型的组件。
The class of components to be retrieved
递归查找自身或所有子节点中指定类型的组件。
A string for the class name of the components
获取当前视图内容的坐标点。
返回当前页面索引。
当前页面索引。
获取滚动视图最大可以滚动的偏移量。
返回视图中的所有页面。
输=视图所有页面。
获取滚动视图相对于左上角原点的当前滚动偏移。
将页面插入指定位置中。
新视图。
指定位置。
当前滚动视图是否在惯性滚动。
用户是否在拖拽当前滚动视图。
如果该组件启用,则每帧调用 LateUpdate。
该方法为生命周期方法,父类未必会有实现。并且你只能在该方法内部调用父类的实现,不可在其它地方直接调用该方法。
the delta time in seconds it took to complete the last frame
onRestore 是用户在检查器菜单点击 Reset 时,对此组件执行撤消操作后调用的。
如果组件包含了“内部状态”(不在 CCClass 属性中定义的临时成员变量),那么你可能需要实现该方法。
编辑器执行撤销/重做操作时,将调用组件的 get set 来录制和还原组件的状态。
然而,在极端的情况下,它可能无法良好运作。
那么你就应该实现这个方法,手动根据组件的属性同步“内部状态”。
一旦你实现这个方法,当用户撤销或重做时,组件的所有 get set 都不会再被调用。
这意味着仅仅指定了默认值的属性将被编辑器记录和还原。
同样的,编辑可能无法在极端情况下正确地重置您的组件。
于是如果你需要支持组件重置菜单,你需要在该方法中手工同步组件属性到“内部状态”。
一旦你实现这个方法,组件的所有 get set 都不会在重置操作时被调用。
这意味着仅仅指定了默认值的属性将被编辑器重置。
此方法仅在编辑器下会被调用。
移除所有页面。
移除指定页面。
指定页面。
移除指定下标的页面。
页面下标。
用来初始化组件或节点的一些属性,当该组件被第一次添加到节点上或用户点击了它的 Reset 菜单时调用。这个回调只会在编辑器下调用。
调度一个自定义的回调任务。
如果回调任务已调度,那么将不会重复调度它,只会更新时间间隔参数。
The callback function of the task
The time interval between each invocation
The repeat count of this task, the task will be invoked (repeat + 1) times, use macro.REPEAT_FOREVER to repeat a task forever
The delay time for the first invocation
调度一个只运行一次的回调任务,可以指定 0 让回调函数在下一帧立即执行或者在一定的延时之后执行。
The callback function of the task
The delay time for the first invocation
视图内容在规定时间内进行垂直方向和水平方向的滚动,并且滚动到指定百分比位置上。
在 new Vec2(0,0) and new Vec2(1,1) 上取差值的一个点。
滚动时间(s)。 如果超时,内容将立即跳到指定水平或垂直百分比位置。
滚动加速是否衰减,默认为 true。
视图内容将在规定时间内滚动到视图底部。
滚动时间(s)。 如果超时,内容将立即跳到底部边界。
滚动加速是否衰减,默认为 true。
视图内容将在规定时间内滚动到视图左下角。
滚动时间(s)。 如果超时,内容将立即跳到左下边界。
滚动加速是否衰减,默认为 true。
视图内容将在规定时间内滚动到视图右下角。
滚动时间(s)。 如果超时,内容将立即跳到右边下边界。
滚动加速是否衰减,默认为 true。
视图内容将在规定时间内滚动到视图左边。
滚动时间(s)。 如果超时,内容将立即跳到左边边界。
滚动加速是否衰减,默认为 true。
视图内容在规定时间内将滚动到 ScrollView 相对左上角原点的偏移位置, 如果 timeInSecond 参数不传,则立即滚动到指定偏移位置。
指定移动偏移量。
滚动时间(s)。 如果超时,内容将立即跳到指定偏移量处。
滚动加速是否衰减,默认为 true。
滚动到指定页面
index of page.
scrolling time.
视图内容在规定时间内将滚动到 ScrollView 水平方向的百分比位置上。
0 - 之间的百分比。
滚动时间(s)。 如果超时,内容将立即跳到指定水平百分比位置。
滚动加速是否衰减,默认为 true。
视图内容在规定时间内滚动到 ScrollView 垂直方向的百分比位置上。
0 - 1 之间的百分比。
滚动时间(s)。 如果超时,内容将立即跳到指定垂直百分比位置。
滚动加速是否衰减,默认为 true。
视图内容将在规定时间内滚动到视图右边。
滚动时间(s)。 如果超时,内容将立即跳到右边边界。
滚动加速是否衰减,默认为 true。
视图内容将在规定时间内滚动到视图顶部。
滚动时间(s)。 如果超时,内容将立即跳到顶部边界。
滚动加速是否衰减,默认为 true。
视图内容将在规定时间内滚动到视图左上角。
滚动时间(s)。 如果超时,内容将立即跳到左上边边界。
滚动加速是否衰减,默认为 true。
视图内容将在规定时间内滚动到视图右上角。
滚动时间(s)。 如果超时,内容将立即跳到右上边界。
滚动加速是否衰减,默认为 true。
设置当前视图内容的坐标点。
当前视图坐标点.
设置当前页面索引。
索引。
停止自动滚动, 调用此 API 可以让 ScrollView 立即停止滚动。
取消调度一个自定义的回调任务。
The callback function of the task
取消调度所有已调度的回调函数。
Generated using TypeDoc
页面视图组件