目录— 个文件
⌕
目录加载中…
…/module/component/RoundRectComponent.ts
1import { _decorator, assetManager, CCInteger, director, Director, Enum, NodeEventType, SpriteAtlas, SpriteFrame, UITransform, UIRenderer, Vec2 } from 'cc';
2import { EDITOR, JSB } from 'cc/env';
3enum SizeMode { CUSTOM, TRIMMED, RAW }
4const { ccclass, property } = _decorator;
5@ccclass('Corner')
6class Corner {
7 @property({ displayName: '↙ 左下' })
8 leftBottom: boolean = true;
9 @property({ displayName: '↘ 右下' })
10 rightBottom: boolean = true;
11 @property({ displayName: '↖ 左上' })
12 leftTop: boolean = true;
13 @property({ displayName: '↗ 右上' })
14 rightTop: boolean = true;
15 visible: boolean[] = null!;
16}
17/**
18 * 圆角矩形组件
19 * 支持合批
20 */
21@ccclass('RoundRectComponent')
22export class RoundRectComponent extends UIRenderer {
23 @property({ displayName: '图集', type: SpriteAtlas, readonly: true, editorOnly: true, serializable: false })
24 private atlas: SpriteAtlas = null!;
25 @property
26 private _spriteFrame: SpriteFrame = null!;
27 @property({ displayName: '纹理/图集帧', type: SpriteFrame })
28 get spriteFrame() { return this._spriteFrame; }
29 set spriteFrame(val) {
30 this._spriteFrame = val;
31 this.updateSpriteFrame();
32 this.updateUv();
33 this.markForUpdateRenderData();
34 }
35 @property
36 private _sizeMode: SizeMode = SizeMode.TRIMMED;
37 @property({ displayName: '尺寸模式', type: Enum(SizeMode) })
38 private get sizeMode() { return this._sizeMode; }
39 private set sizeMode(val) {
40 this._sizeMode = val;
41 this.updateSizeMode();
42 }
43 @property({ displayName: '顶点数 / 三角形数', readonly: true, editorOnly: true, serializable: false })
44 private vertexTriangle: Vec2 = new Vec2(0, 0);
45 @property
46 private _segment: number = 5;
47 @property({ displayName: '······线段数量', type: CCInteger })
48 private get segment() { return this._segment; }
49 private set segment(val) {
50 this._segment = Math.max(val, 1);
51 this.createData();
52 this.updateLocal();
53 this.updateUv();
54 this.updateColor();
55 this.markForUpdateRenderData();
56 }
57 @property
58 private _radius: number = 100;
59 @property({ displayName: '······圆角半径' })
60 private get radius() { return this._radius; }
61 private set radius(val) {
62 this._radius = Math.max(val, 0);
63 this.updateLocal();
64 this.updateUv();
65 this.markForUpdateRenderData();
66 }
67 @property
68 private _corner: Corner = new Corner();
69 @property({ displayName: '······圆角可见性' })
70 private get corner() { return this._corner; }
71 private set corner(val) {
72 this._corner = val;
73 this.updateCorner();
74 this.createData();
75 this.updateLocal();
76 this.updateUv();
77 this.updateColor();
78 this.markForUpdateRenderData();
79 }
80 private uiTrans: UITransform = null!; //当前节点的UITransform对象
81 private left: number = 0; //左边缘本地坐标
82 private bottom: number = 0; //下边缘本地坐标
83 private locals: number[][] = []; //顶点本地坐标
84 __preload(): void {
85 super.__preload();
86 this._assembler = { //定制assembler
87 updateColor: this.updateColor.bind(this),
88 updateRenderData: this.updateRenderData.bind(this),
89 fillBuffers: this.fillBuffer.bind(this),
90 };
91 this.uiTrans = this.node.getComponent(UITransform) ?? this.node.addComponent(UITransform);
92 this._useVertexOpacity = true;
93 (this as any)['updateMaterial']();
94 this.updateSpriteFrame();
95 this.updateCorner();
96 this.updateLocal();
97 }
98 onEnable(): void {
99 super.onEnable();
100 this.createData();
101 this.updateUv();
102 JSB ? director.once(Director.EVENT_AFTER_DRAW, this.updateColor, this) : this.updateColor();
103 this.node.on(NodeEventType.SIZE_CHANGED, this.onSizeChanged, this);
104 this.node.on(NodeEventType.ANCHOR_CHANGED, this.onAnchorChanged, this);
105 }
106 onDisable(): void {
107 super.onDisable();
108 this.node.off(NodeEventType.SIZE_CHANGED, this.onSizeChanged, this);
109 this.node.off(NodeEventType.ANCHOR_CHANGED, this.onAnchorChanged, this);
110 }
111 //修改节点尺寸后,更新顶点数据,并根据sizeMode设置图片宽高
112 private onSizeChanged(): void {
113 if (!this._spriteFrame) return;
114 this.updateLocal();
115 this.updateXy();
116 let cw = this.uiTrans.width, ch = this.uiTrans.height;
117 let size = this._spriteFrame['_originalSize'], rect = this._spriteFrame['_rect'];
118 switch (this._sizeMode) {
119 case SizeMode.TRIMMED: if (cw === rect.width && ch === rect.height) return; break;
120 case SizeMode.RAW: if (cw === size.width && ch === size.height) return; break;
121 }
122 this._sizeMode = SizeMode.CUSTOM;
123 }
124 private onAnchorChanged(): void {
125 this.updateLocal();
126 this.updateXy();
127 }
128 //可以传入单张图片Texture2D,或Atlas图集帧(支持合批,推荐)
129 private updateSpriteFrame(): void {
130 let spriteFrame = this._spriteFrame;
131 if (!spriteFrame) { this.atlas = null!; return; }
132 this._renderData && (this._renderData.textureDirty = true);
133 this.updateSizeMode();
134 if (EDITOR) {
135 if (!spriteFrame['_atlasUuid']) { this.atlas = null!; return; }
136 assetManager.loadAny(spriteFrame['_atlasUuid'], (err: Error, asset: SpriteAtlas) => {
137 if (err) { this.atlas = null!; return; }
138 this.atlas = asset;
139 });
140 }
141 }
142 private updateCorner(): void {
143 let corner = this._corner;
144 corner.visible = [corner.leftBottom, corner.rightBottom, corner.rightTop, corner.leftTop];
145 }
146 //设置顶点数和三角形数
147 private createData(): void {
148 let renderData = this._renderData = this.requestRenderData();
149 let vertexTriangle = [4, 2];
150 let cornerCnt = 0;
151 for (let i = 0, visible = this._corner.visible; i < 4; visible[i++] && ++cornerCnt);
152 vertexTriangle = [12 + (this._segment - 1) * cornerCnt, 6 + this._segment * cornerCnt];
153 renderData.dataLength = vertexTriangle[0];
154 renderData.resize(vertexTriangle[0], 3 * vertexTriangle[1]);
155 EDITOR && ([this.vertexTriangle.x, this.vertexTriangle.y] = vertexTriangle);
156 this.updateIndices();
157 }
158 //计算顶点索引
159 updateIndices(): void {
160 let renderData = this._renderData!;
161 let indices = new Uint16Array(renderData.chunk.indexCount);
162 const ROUND_IB = [0, 9, 11, 0, 11, 1, 2, 8, 10, 2, 4, 8, 3, 5, 7, 3, 7, 6];
163 for (let i = ROUND_IB.length - 1; i > -1; indices[i] = ROUND_IB[i--]);
164 for (let i = 0, offset = ROUND_IB.length, id = 36, visible = this._corner.visible; i < 4; ++i) {
165 if (!visible[i]) continue;
166 let o = 3 * i;
167 let a = o + 1;
168 let b = id / 3;
169 for (let j = 0, len = this._segment - 1; j < len; ++j) {
170 indices[offset++] = o;
171 indices[offset++] = a;
172 indices[offset++] = b;
173 a = b++;
174 id += 3;
175 }
176 indices[offset++] = o;
177 indices[offset++] = a;
178 indices[offset++] = o + 2;
179 }
180 JSB ? renderData.chunk.setIndexBuffer(indices) : (renderData.indices = indices);
181 }
182 //计算本地坐标
183 updateLocal(): void {
184 let ut = this.uiTrans, cw = ut.width, ch = ut.height, ax = ut.anchorX, ay = ut.anchorY;
185 let l = this.left = -cw * ax, b = this.bottom = -ch * ay, r = cw * (1 - ax), t = ch * (1 - ay);
186 let locals: number[][] = this.locals = [];
187 let radius = Math.min(this._radius, Math.min(cw, ch) / 2);
188 let lo = l + radius, bo = b + radius, ro = r - radius, to = t - radius;
189 let corner = this._corner;
190 locals[0] = [lo, corner.leftBottom ? bo : b];
191 locals[1] = [l, locals[0][1]];
192 locals[2] = [lo, b];
193 locals[3] = [ro, corner.rightBottom ? bo : b];
194 locals[4] = [ro, b];
195 locals[5] = [r, locals[3][1]];
196 locals[6] = [ro, corner.rightTop ? to : t];
197 locals[7] = [r, locals[6][1]];
198 locals[8] = [ro, t];
199 locals[9] = [lo, corner.leftTop ? to : t];
200 locals[10] = [lo, t];
201 locals[11] = [l, locals[9][1]];
202 let radian = Math.PI / (this._segment << 1);
203 let sin = Math.sin(radian), cos = Math.cos(radian);
204 for (let i = 0, offset = 12, visible = corner.visible; i < 4; ++i) {
205 if (!visible[i]) continue;
206 let id = i * 3;
207 let ox = locals[id][0], oy = locals[id][1];
208 let deltX = locals[id + 1][0] - ox, deltY = locals[id + 1][1] - oy;
209 for (let j = 0, len = this._segment - 1; j < len; ++j) {
210 locals[offset] = [ox + deltX * cos - deltY * sin, oy + deltY * cos + deltX * sin];
211 deltX = locals[offset][0] - ox;
212 deltY = locals[offset][1] - oy;
213 ++offset;
214 }
215 }
216 }
217 //根据本地坐标,计算XY坐标
218 updateXy(): void {
219 let renderData = this._renderData!, data = renderData.data, locals = this.locals;
220 for (let i = locals.length - 1; i > -1; --i) {
221 let local = this.locals[i];
222 data[i].x = local[0];
223 data[i].y = local[1];
224 }
225 !JSB && (renderData.vertDirty = true);
226 }
227 updateUv(): void {
228 let spriteFrame = this._spriteFrame;
229 if (!spriteFrame) return;
230 let uv = spriteFrame.uv;
231 if (!uv || uv.length < 6) return;
232 let renderData = this._renderData!, vb = renderData.chunk.vb, locals = this.locals;
233 let ut = this.uiTrans, cw = ut.width, ch = ut.height, l = this.left, b = this.bottom;
234 for (let i = 3, len = vb.length, step = renderData.floatStride, id = 0; i < len; i += step, ++id) {
235 let local = locals[id];
236 vb[i] = (local[0] - l) / cw;
237 vb[i + 1] = (local[1] - b) / ch;
238 }
239 if (spriteFrame['_rotated']) {
240 let uvL = uv[0], uvB = uv[1], uvW = uv[4] - uvL, uvH = uv[3] - uvB;
241 for (let i = 3, len = vb.length, step = renderData.floatStride; i < len; i += step) {
242 let tmp = vb[i];
243 vb[i] = uvL + vb[i + 1] * uvW;
244 vb[i + 1] = uvB + tmp * uvH;
245 }
246 } else {
247 let uvL = uv[0], uvB = uv[1], uvW = uv[2] - uvL, uvH = uv[5] - uvB;
248 for (let i = 3, len = vb.length, step = renderData.floatStride; i < len; i += step) {
249 vb[i] = uvL + vb[i] * uvW;
250 vb[i + 1] = uvB + vb[i + 1] * uvH;
251 }
252 }
253 }
254 //计算顶点颜色
255 updateColor(): void {
256 let renderData = this._renderData!, vb = renderData.chunk.vb, color = this._color;
257 let r = color.r / 255, g = color.g / 255, b = color.b / 255, a = color.a / 255;
258 for (let i = 5, len = vb.length, step = renderData.floatStride; i < len; i += step) {
259 vb[i] = r;
260 vb[i + 1] = g;
261 vb[i + 2] = b;
262 vb[i + 3] = a;
263 }
264 }
265 //根据尺寸模式,修改节点尺寸
266 updateSizeMode(): void {
267 if (!this._spriteFrame) return;
268 switch (this._sizeMode) {
269 case SizeMode.TRIMMED: this.uiTrans.setContentSize(this._spriteFrame['_rect'].size); break;
270 case SizeMode.RAW: this.uiTrans.setContentSize(this._spriteFrame['_originalSize']); break;
271 }
272 }
273 //调用markForUpdateRenderData后该函数会被动触发
274 updateRenderData(): void {
275 if (!this._renderData || !this._spriteFrame?.texture) return;
276 this.updateXy();
277 this._renderData.updateRenderData(this, this._spriteFrame);
278 }
279 protected _render(render: any): void {
280 render.commitComp(this, this._renderData, this._spriteFrame, this._assembler, null);
281 }
282 protected _canRender(): boolean {
283 return super._canRender() && !!(this._spriteFrame?.texture);
284 }
285 //Web平台,将renderData的数据提交给GPU渲染
286 //原生平台并不会执行该函数,引擎另外实现了渲染函数
287 fillBuffer(): void {
288 let renderData = this._renderData;
289 if (!renderData) return;
290 let chunk = renderData.chunk;
291 if (this.node.hasChangedFlags || renderData.vertDirty) {
292 let data = renderData.data, vb = renderData.chunk.vb, m = this.node.worldMatrix;
293 for (let step = renderData.floatStride, len = vb.length, i = 0, id = 0; i < len; i += step, ++id) {
294 let x = data[id].x, y = data[id].y, rhw = m.m03 * x + m.m07 * y + m.m15;
295 rhw = rhw ? 1 / rhw : 1;
296 vb[i] = (m.m00 * x + m.m04 * y + m.m12) * rhw;
297 vb[i + 1] = (m.m01 * x + m.m05 * y + m.m13) * rhw;
298 }
299 renderData.vertDirty = false;
300 }
301 let vid = chunk.vertexOffset;
302 let meshBuffer = chunk.meshBuffer;
303 let iData = meshBuffer.iData;
304 let indexOffset = meshBuffer.indexOffset;
305 let indices = renderData.indices!;
306 for (let i = 0; i < indices.length; iData[indexOffset++] = vid + indices[i++]);
307 meshBuffer.indexOffset += indices.length;
308 }
309}
讲解309 行
圆角绘制人工通读
RoundRectComponent.ts
继承 UIRenderer 为圆角矩形建立自定义装配器,按四角开关和线段数生成顶点、索引及图集 UV,保存本地坐标再随节点矩阵写入渲染缓存。生命周期注册尺寸锚点监听,原生与网页采用不同提交路径,并直接访问引擎内部字段,升级引擎时需核对。
先看 __preload 装配器接入,再顺着 createData、updateLocal、updateUv 到 fillBuffer。
特殊处理与易错点
- 渠道差异JSB 把索引交给 chunk,网页在 fillBuffer 写世界坐标与 mesh 索引。L287
- 特殊处理圆角半径被限制到宽高中较小值的一半,关闭某角不会取消其矩形主体。
- 时序原生启用后等 AFTER_DRAW 更新颜色,网页立即写色。
- 易错点直接使用 _rect、_originalSize、chunk 等引擎内部结构,不能视作稳定公共 API。
8属性left Bottom(boolean):该模块的运行态字段。
10属性right Bottom(boolean):该模块的运行态字段。
12属性left Top(boolean):该模块的运行态字段。
14属性right Top(boolean):该模块的运行态字段。
15属性visible(boolean[]):该模块的运行态字段。
21注释圆角矩形组件 支持合批
22注释Corner:圆角矩形组件 支持合批
24属性圆角矩形组件 支持合批
26属性sprite Frame(SpriteFrame):该模块的运行态字段。
27方法读取当前纹理帧,写入会更新尺寸纹理标记与映射。
36属性size Mode(SizeMode):该模块的运行态字段。
37方法读取当前尺寸模式,写入时按帧裁切或原图尺寸调整节点。
44属性vertex Triangle(Vec2):该模块的运行态字段。
46属性segment(number):该模块的运行态字段。
47方法读取圆角细分数量,写入至少一段并重建网格数据。
58属性radius(number):该模块的运行态字段。
59方法读取设定圆角半径,写入非负值后重算坐标与纹理。
68属性四角开关与按左下右下右上左上排列的派生数组。
69方法读取四角开关对象,写入时重建可见角数组与网格。
80属性界面 Trans(UITransform):该模块的运行态字段。
81属性left(number):该模块的运行态字段。
82属性bottom(number):该模块的运行态字段。
83属性按四角与细分数生成的本地二维顶点数组。
84方法接入自定义装配器并准备变换组件纹理与本地顶点。
98方法创建渲染数据更新纹理颜色并监听尺寸与锚点变化。
106方法调用渲染基类禁用流程并移除尺寸与锚点监听。
112方法尺寸改变后重算坐标并把不匹配帧尺寸的模式改自定义。
124方法锚点变化时重新计算本地顶点并写入渲染坐标。
129方法标记纹理变更调整尺寸并在编辑器查找所属图集。
142方法把四个圆角开关排列成生成顶点时使用的顺序数组。
147方法按细分数量和启用角数分配顶点索引容量并建索引。
159方法填入矩形主体与圆角扇形索引并按平台提交缓存。
183方法按尺寸锚点和受限半径构造矩形及圆弧本地顶点。
218方法将保存的本地顶点写入渲染数据并标记网页顶点脏。
227方法由顶点位置插值纹理坐标并处理旋转图集帧方向。
255方法把组件颜色归一化后写入所有顶点的颜色通道。
266方法按裁切或原图模式把目标帧尺寸写入节点变换组件。
274方法纹理存在时同步本地顶点并通知渲染数据更新材质。
279方法将当前组件渲染数据纹理帧和装配器提交给批处理器。
282方法在基类允许渲染且目标帧有纹理时开放绘制。
287方法网页端变换顶点至世界空间并追加带偏移的网格索引。