@eva/plugin-renderer-render 2.0.1-beta.27 → 2.0.1-beta.28

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -28,19 +28,79 @@ function __decorate(decorators, target, key, desc) {
28
28
  return c > 3 && r && Object.defineProperty(target, key, r), r;
29
29
  }
30
30
 
31
+ /**
32
+ * 渲染属性组件
33
+ *
34
+ * Render 组件控制游戏对象的渲染相关属性,如可见性、透明度、层级等。
35
+ * 这些属性影响对象的显示效果和渲染顺序,
36
+ * 适用于需要控制显示状态、淡入淡出、层级排序等场景。
37
+ *
38
+ * 主要属性:
39
+ * - visible - 控制对象是否可见
40
+ * - alpha - 控制对象透明度(0-1)
41
+ * - zIndex - 控制对象渲染层级
42
+ * - sortableChildren - 是否对子对象按 zIndex 排序
43
+ *
44
+ * @example
45
+ * ```typescript
46
+ * // 创建带渲染属性的对象
47
+ * const sprite = new GameObject('sprite');
48
+ * sprite.addComponent(new Img({ resource: 'player' }));
49
+ * sprite.addComponent(new Render({
50
+ * visible: true,
51
+ * alpha: 1,
52
+ * zIndex: 10
53
+ * }));
54
+ *
55
+ * // 控制可见性
56
+ * const render = sprite.getComponent('Render');
57
+ * render.visible = false; // 隐藏对象
58
+ *
59
+ * // 淡入淡出效果
60
+ * let alpha = 1;
61
+ * setInterval(() => {
62
+ * alpha -= 0.01;
63
+ * if (alpha <= 0) alpha = 1;
64
+ * render.alpha = alpha;
65
+ * }, 16);
66
+ *
67
+ * // 设置渲染层级
68
+ * render.zIndex = 100; // 越大越靠前
69
+ *
70
+ * // 启用子对象排序
71
+ * const container = new GameObject('container');
72
+ * container.addComponent(new Render({
73
+ * sortableChildren: true // 子对象将按 zIndex 排序
74
+ * }));
75
+ * ```
76
+ */
31
77
  class Render$2 extends eva_js.Component {
32
78
  constructor() {
33
79
  super(...arguments);
80
+ /** 排序脏标记 */
34
81
  this.sortDirty = false;
82
+ /** 是否可见 */
35
83
  this.visible = true;
84
+ /** 透明度(0-1,0 为完全透明,1 为完全不透明) */
36
85
  this.alpha = 1;
86
+ /** 渲染层级(数值越大越靠前) */
37
87
  this.zIndex = 0;
88
+ /** 是否对子对象按 zIndex 排序 */
38
89
  this.sortableChildren = false;
39
90
  }
91
+ /**
92
+ * 初始化组件
93
+ * @param obj - 初始化参数
94
+ * @param obj.visible - 是否可见
95
+ * @param obj.alpha - 透明度
96
+ * @param obj.zIndex - 渲染层级
97
+ * @param obj.sortableChildren - 是否对子对象排序
98
+ */
40
99
  init(obj) {
41
100
  obj && Object.assign(this, obj);
42
101
  }
43
102
  }
103
+ /** 组件名称 */
44
104
  Render$2.componentName = 'Render';
45
105
  __decorate([
46
106
  inspectorDecorator.type('boolean')
@@ -6,13 +6,73 @@ import { Renderer } from '@eva/plugin-renderer';
6
6
  import { RendererManager } from '@eva/plugin-renderer';
7
7
  import { RendererSystem } from '@eva/plugin-renderer';
8
8
 
9
+ /**
10
+ * 渲染属性组件
11
+ *
12
+ * Render 组件控制游戏对象的渲染相关属性,如可见性、透明度、层级等。
13
+ * 这些属性影响对象的显示效果和渲染顺序,
14
+ * 适用于需要控制显示状态、淡入淡出、层级排序等场景。
15
+ *
16
+ * 主要属性:
17
+ * - visible - 控制对象是否可见
18
+ * - alpha - 控制对象透明度(0-1)
19
+ * - zIndex - 控制对象渲染层级
20
+ * - sortableChildren - 是否对子对象按 zIndex 排序
21
+ *
22
+ * @example
23
+ * ```typescript
24
+ * // 创建带渲染属性的对象
25
+ * const sprite = new GameObject('sprite');
26
+ * sprite.addComponent(new Img({ resource: 'player' }));
27
+ * sprite.addComponent(new Render({
28
+ * visible: true,
29
+ * alpha: 1,
30
+ * zIndex: 10
31
+ * }));
32
+ *
33
+ * // 控制可见性
34
+ * const render = sprite.getComponent('Render');
35
+ * render.visible = false; // 隐藏对象
36
+ *
37
+ * // 淡入淡出效果
38
+ * let alpha = 1;
39
+ * setInterval(() => {
40
+ * alpha -= 0.01;
41
+ * if (alpha <= 0) alpha = 1;
42
+ * render.alpha = alpha;
43
+ * }, 16);
44
+ *
45
+ * // 设置渲染层级
46
+ * render.zIndex = 100; // 越大越靠前
47
+ *
48
+ * // 启用子对象排序
49
+ * const container = new GameObject('container');
50
+ * container.addComponent(new Render({
51
+ * sortableChildren: true // 子对象将按 zIndex 排序
52
+ * }));
53
+ * ```
54
+ */
9
55
  export declare class Render extends Component<RenderParams> {
56
+ /** 组件名称 */
10
57
  static componentName: string;
58
+ /** 排序脏标记 */
11
59
  sortDirty: boolean;
60
+ /** 是否可见 */
12
61
  visible: boolean;
62
+ /** 透明度(0-1,0 为完全透明,1 为完全不透明) */
13
63
  alpha: number;
64
+ /** 渲染层级(数值越大越靠前) */
14
65
  zIndex: number;
66
+ /** 是否对子对象按 zIndex 排序 */
15
67
  sortableChildren: boolean;
68
+ /**
69
+ * 初始化组件
70
+ * @param obj - 初始化参数
71
+ * @param obj.visible - 是否可见
72
+ * @param obj.alpha - 透明度
73
+ * @param obj.zIndex - 渲染层级
74
+ * @param obj.sortableChildren - 是否对子对象排序
75
+ */
16
76
  init(obj?: RenderParams): void;
17
77
  }
18
78
 
@@ -24,19 +24,79 @@ function __decorate(decorators, target, key, desc) {
24
24
  return c > 3 && r && Object.defineProperty(target, key, r), r;
25
25
  }
26
26
 
27
+ /**
28
+ * 渲染属性组件
29
+ *
30
+ * Render 组件控制游戏对象的渲染相关属性,如可见性、透明度、层级等。
31
+ * 这些属性影响对象的显示效果和渲染顺序,
32
+ * 适用于需要控制显示状态、淡入淡出、层级排序等场景。
33
+ *
34
+ * 主要属性:
35
+ * - visible - 控制对象是否可见
36
+ * - alpha - 控制对象透明度(0-1)
37
+ * - zIndex - 控制对象渲染层级
38
+ * - sortableChildren - 是否对子对象按 zIndex 排序
39
+ *
40
+ * @example
41
+ * ```typescript
42
+ * // 创建带渲染属性的对象
43
+ * const sprite = new GameObject('sprite');
44
+ * sprite.addComponent(new Img({ resource: 'player' }));
45
+ * sprite.addComponent(new Render({
46
+ * visible: true,
47
+ * alpha: 1,
48
+ * zIndex: 10
49
+ * }));
50
+ *
51
+ * // 控制可见性
52
+ * const render = sprite.getComponent('Render');
53
+ * render.visible = false; // 隐藏对象
54
+ *
55
+ * // 淡入淡出效果
56
+ * let alpha = 1;
57
+ * setInterval(() => {
58
+ * alpha -= 0.01;
59
+ * if (alpha <= 0) alpha = 1;
60
+ * render.alpha = alpha;
61
+ * }, 16);
62
+ *
63
+ * // 设置渲染层级
64
+ * render.zIndex = 100; // 越大越靠前
65
+ *
66
+ * // 启用子对象排序
67
+ * const container = new GameObject('container');
68
+ * container.addComponent(new Render({
69
+ * sortableChildren: true // 子对象将按 zIndex 排序
70
+ * }));
71
+ * ```
72
+ */
27
73
  class Render$2 extends Component {
28
74
  constructor() {
29
75
  super(...arguments);
76
+ /** 排序脏标记 */
30
77
  this.sortDirty = false;
78
+ /** 是否可见 */
31
79
  this.visible = true;
80
+ /** 透明度(0-1,0 为完全透明,1 为完全不透明) */
32
81
  this.alpha = 1;
82
+ /** 渲染层级(数值越大越靠前) */
33
83
  this.zIndex = 0;
84
+ /** 是否对子对象按 zIndex 排序 */
34
85
  this.sortableChildren = false;
35
86
  }
87
+ /**
88
+ * 初始化组件
89
+ * @param obj - 初始化参数
90
+ * @param obj.visible - 是否可见
91
+ * @param obj.alpha - 透明度
92
+ * @param obj.zIndex - 渲染层级
93
+ * @param obj.sortableChildren - 是否对子对象排序
94
+ */
36
95
  init(obj) {
37
96
  obj && Object.assign(this, obj);
38
97
  }
39
98
  }
99
+ /** 组件名称 */
40
100
  Render$2.componentName = 'Render';
41
101
  __decorate([
42
102
  type('boolean')
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@eva/plugin-renderer-render",
3
- "version": "2.0.1-beta.27",
3
+ "version": "2.0.1-beta.28",
4
4
  "description": "@eva/plugin-renderer-render",
5
5
  "main": "index.js",
6
6
  "module": "dist/plugin-renderer-render.esm.js",
@@ -19,9 +19,9 @@
19
19
  "homepage": "https://eva.js.org",
20
20
  "dependencies": {
21
21
  "@eva/inspector-decorator": "^0.0.5",
22
- "@eva/plugin-renderer": "2.0.1-beta.27",
23
- "@eva/renderer-adapter": "2.0.1-beta.27",
24
- "@eva/eva.js": "2.0.1-beta.27",
22
+ "@eva/plugin-renderer": "2.0.1-beta.28",
23
+ "@eva/renderer-adapter": "2.0.1-beta.28",
24
+ "@eva/eva.js": "2.0.1-beta.28",
25
25
  "pixi.js": "^8.8.1"
26
26
  }
27
27
  }