feat: update code

packages/core/src/2d/assembler/ISpriteAssembler.ts

@@ -2,7 +2,7 @@ import { Matrix, Vector2, Vector3 } from "@galacean/engine-math";
 import { ISpriteRenderer } from "./ISpriteRenderer";
 
 /**
- * @internal
+ * Interface for sprite assembler.
  */
 export interface ISpriteAssembler {
   resetData(renderer: ISpriteRenderer, vertexCount?: number): void;

packages/core/src/2d/assembler/ISpriteRenderer.ts

@@ -4,6 +4,9 @@ import { SubPrimitiveChunk } from "../../RenderPipeline/SubPrimitiveChunk";
 import { SpriteTileMode } from "../enums/SpriteTileMode";
 import { Sprite } from "../sprite";
 
+/**
+ * Interface for sprite renderer.
+ */
 export interface ISpriteRenderer {
   sprite: Sprite;
   color?: Color;

packages/core/src/2d/assembler/SimpleSpriteAssembler.ts

@@ -4,7 +4,7 @@ import { ISpriteAssembler } from "./ISpriteAssembler";
 import { ISpriteRenderer } from "./ISpriteRenderer";
 
 /**
- * @internal
+ * Assemble vertex data for the sprite renderer in simple mode.
  */
 @StaticInterfaceImplement<ISpriteAssembler>()
 export class SimpleSpriteAssembler {

packages/core/src/2d/assembler/SlicedSpriteAssembler.ts

@@ -4,7 +4,7 @@ import { ISpriteAssembler } from "./ISpriteAssembler";
 import { ISpriteRenderer } from "./ISpriteRenderer";
 
 /**
- * @internal
+ * Assemble vertex data for the sprite renderer in sliced mode.
  */
 @StaticInterfaceImplement<ISpriteAssembler>()
 export class SlicedSpriteAssembler {

packages/core/src/2d/assembler/TiledSpriteAssembler.ts

@@ -8,7 +8,7 @@ import { ISpriteRenderer } from "./ISpriteRenderer";
 import { SimpleSpriteAssembler } from "./SimpleSpriteAssembler";
 
 /**
- * @internal
+ * Assemble vertex data for the sprite renderer in tiled mode.
  */
 @StaticInterfaceImplement<ISpriteAssembler>()
 export class TiledSpriteAssembler {

packages/core/src/2d/enums/SpriteModifyFlags.ts

@@ -2,13 +2,22 @@
  * Sprite Property Dirty Flag.
  */
 export enum SpriteModifyFlags {
+  /** The texture of sprite changes. */
   texture = 0x1,
+  /** The size of sprite changes. */
   size = 0x2,
+  /** The rotation of sprite changes. */
   atlasRotate = 0x4,
+  /** The atlasRegion of sprite changes. */
   atlasRegion = 0x8,
+  /** The atlasRegionOffset of sprite changes. */
   atlasRegionOffset = 0x10,
+  /** The region of sprite changes. */
   region = 0x20,
+  /** The pivot of sprite changes. */
   pivot = 0x40,
+  /** The border of sprite changes. */
   border = 0x80,
+  /** The sprite destroyed. */
   destroy = 0x100
 }

packages/core/src/Camera.ts

@@ -298,7 +298,7 @@ export class Camera extends Component {
       } else {
         this.shaderData.disableMacro("CAMERA_ORTHOGRAPHIC");
       }
-      this._dispatchModify(CameraModifyFlags.CameraType);
+      this._dispatchModify(CameraModifyFlags.ProjectionType);
     }
   }
 
@@ -654,7 +654,7 @@ export class Camera extends Component {
       Logger.error("mipLevel only take effect in WebGL2.0");
     }
     let ignoreClearFlags: CameraClearFlags;
-    if (this._cameraType === CameraType.XRCamera && !this._renderTarget && !this.independentCanvasEnabled) {
+    if (this._cameraType !== CameraType.Normal && !this._renderTarget && !this.independentCanvasEnabled) {
       ignoreClearFlags = engine.xrManager._getCameraIgnoreClearFlags(this._cameraType);
     }
     this._renderPipeline.render(context, cubeFace, mipLevel, ignoreClearFlags);

packages/core/src/ComponentsManager.ts

@@ -1,9 +1,9 @@
-import { IUICanvas } from "@galacean/engine-design";
 import { Camera } from "./Camera";
 import { Component } from "./Component";
 import { Renderer } from "./Renderer";
 import { Script } from "./Script";
 import { Animator } from "./animation";
+import { IUICanvas } from "./ui/IUICanvas";
 import { DisorderedArray } from "./utils/DisorderedArray";
 
 /**

packages/core/src/Renderer.ts

@@ -6,7 +6,7 @@ import { DependentMode, dependentComponents } from "./ComponentsDependencies";
 import { Entity } from "./Entity";
 import { RenderContext } from "./RenderPipeline/RenderContext";
 import { SubRenderElement } from "./RenderPipeline/SubRenderElement";
-import { Transform } from "./Transform";
+import { Transform, TransformModifyFlags } from "./Transform";
 import { assignmentClone, deepClone, ignoreClone } from "./clone/CloneManager";
 import { IComponentCustomClone } from "./clone/ComponentCloner";
 import { SpriteMaskLayer } from "./enums/SpriteMaskLayer";
@@ -550,7 +550,7 @@ export class Renderer extends Component implements IComponentCustomClone {
   }
 
   @ignoreClone
-  protected _onTransformChanged(type: number): void {
+  protected _onTransformChanged(type: TransformModifyFlags): void {
     this._dirtyUpdateFlag |= RendererUpdateFlags.WorldPositionAndBounds;
   }
 }

packages/core/src/enums/CameraModifyFlags.ts

@@ -1,8 +1,17 @@
+/**
+ * The camera modify flags.
+ */
 export enum CameraModifyFlags {
-  CameraType = 0x1,
+  /** The types of camera projections changes. */
+  ProjectionType = 0x1,
+  /** The aspect ratio of the camera changes. */
   AspectRatio = 0x2,
+  /** The field of view of the camera changes. */
   FieldOfView = 0x4,
+  /** The orthographic size of the camera changes. */
   OrthographicSize = 0x8,
+  /** The camera becomes active in the scene. */
   EnableInScene = 0x10,
+  /** The camera becomes inactive in the scene. */
   DisableInScene = 0x20
 }

packages/core/src/enums/CameraType.ts

@@ -5,6 +5,5 @@ export enum CameraType {
   Normal = 0x0,
   XRCenterCamera = 0x1,
   XRLeftCamera = 0x2,
-  XRRightCamera = 0x4,
-  XRCamera = CameraType.XRCenterCamera | CameraType.XRLeftCamera | CameraType.XRRightCamera
+  XRRightCamera = 0x4
 }

packages/core/src/enums/EntityModifyFlags.ts

@@ -1,4 +1,9 @@
+/**
+ * The entity modify flags.
+ */
 export enum EntityModifyFlags {
+  /** The parent changes. */
   Parent = 0x1,
+  /** The sibling index changes. */
   SiblingIndex = 0x2
 }

packages/core/src/index.ts

@@ -12,7 +12,7 @@ export { Entity } from "./Entity";
 export { Component } from "./Component";
 export { Script } from "./Script";
 export { Renderer, RendererUpdateFlags } from "./Renderer";
-export { DependentMode, dependentComponents } from "./ComponentsDependencies";
+export { dependentComponents, DependentMode } from "./ComponentsDependencies";
 export { Camera } from "./Camera";
 export { Transform } from "./Transform";
 export { BoolUpdateFlag } from "./BoolUpdateFlag";
@@ -34,7 +34,6 @@ export * from "./base";
 
 export { Background } from "./Background";
 export { BackgroundMode } from "./enums/BackgroundMode";
-export { BackgroundTextureFillMode } from "./enums/BackgroundTextureFillMode";
 export { DepthTextureMode } from "./enums/DepthTextureMode";
 export { FogMode } from "./enums/FogMode";
 export { CameraClearFlags } from "./enums/CameraClearFlags";
@@ -45,6 +44,7 @@ export { MSAASamples } from "./enums/MSAASamples";
 export { ReplacementFailureStrategy } from "./enums/ReplacementFailureStrategy";
 export { Downsampling } from "./enums/Downsampling";
 export { ColorSpace } from "./enums/ColorSpace";
+export { BackgroundTextureFillMode } from "./enums/BackgroundTextureFillMode";
 export { SpriteMaskLayer } from "./enums/SpriteMaskLayer";
 export { XRManager } from "./xr/XRManager";
 export * from "./utils/index";

packages/core/src/ui/IUICanvas.ts

@@ -0,0 +1,14 @@
+import { Entity } from "../Entity";
+import { RenderContext } from "../RenderPipeline/RenderContext";
+import { RenderElement } from "../RenderPipeline/RenderElement";
+
+/**
+ * @internal
+ */
+export interface IUICanvas {
+  entity: Entity;
+  sortOrder: number;
+  _canvasIndex: number;
+  _renderElement: RenderElement;
+  _prepareRender(renderContext: RenderContext): void;
+}

packages/core/src/ui/UIUtils.ts

@@ -1,11 +1,11 @@
-import { IUICanvas } from "@galacean/engine-design";
 import { Matrix, Vector4 } from "@galacean/engine-math";
 import { Engine } from "../Engine";
 import { RenderQueue } from "../RenderPipeline";
 import { ContextRendererUpdateFlag } from "../RenderPipeline/RenderContext";
 import { VirtualCamera } from "../VirtualCamera";
 import { RenderQueueType } from "../shader";
 import { DisorderedArray } from "../utils/DisorderedArray";
+import { IUICanvas } from "./IUICanvas";
 
 export class UIUtils {
   private static _renderQueue: RenderQueue;

packages/design/src/index.ts

@@ -3,5 +3,4 @@ export * from "./input/index";
 export * from "./physics/index";
 export * from "./renderingHardwareInterface/index";
 export * from "./shader-lab/index";
-export * from "./ui/index";
 export * from "./xr/index";

packages/ui/src/component/UICanvas.ts

@@ -455,7 +455,7 @@ export class UICanvas extends Component implements IElement {
   private _onCameraModifyListener(flag: CameraModifyFlags): void {
     if (this._realRenderMode === CanvasRenderMode.ScreenSpaceCamera) {
       switch (flag) {
-        case CameraModifyFlags.CameraType:
+        case CameraModifyFlags.ProjectionType:
         case CameraModifyFlags.AspectRatio:
           this._adapterSizeInScreenSpace();
           break;

packages/ui/src/interface/IGroupAble.ts

@@ -13,5 +13,5 @@ export interface IGroupAble extends IElement {
 
   _getGroup(): UIGroup;
   _onGroupModify(flag: GroupModifyFlags, isPass?: boolean): void;
-  _groupListener: (flag: number) => void;
+  _groupListener(flag: number): void;
 }