Add component denpendent decorator (#796)

packages/core/src/Camera.ts

@@ -3,7 +3,7 @@ import { Logger } from "./base";
 import { BoolUpdateFlag } from "./BoolUpdateFlag";
 import { deepClone, ignoreClone } from "./clone/CloneManager";
 import { Component } from "./Component";
-import { dependencies } from "./ComponentsDependencies";
+import { dependentComponents } from "./ComponentsDependencies";
 import { Entity } from "./Entity";
 import { CameraClearFlags } from "./enums/CameraClearFlags";
 import { Layer } from "./Layer";
@@ -16,7 +16,6 @@ import { ShaderMacroCollection } from "./shader/ShaderMacroCollection";
 import { TextureCubeFace } from "./texture/enums/TextureCubeFace";
 import { RenderTarget } from "./texture/RenderTarget";
 import { Transform } from "./Transform";
-import { UpdateFlag } from "./UpdateFlag";
 
 class MathTemp {
   static tempVec4 = new Vector4();
@@ -26,8 +25,9 @@ class MathTemp {
 
 /**
  * Camera component, as the entrance to the three-dimensional world.
+ * @decorator `@dependentComponents(Transform)`
  */
-@dependencies(Transform)
+@dependentComponents(Transform)
 export class Camera extends Component {
   private static _viewMatrixProperty = Shader.getPropertyByName("u_viewMat");
   private static _projectionMatrixProperty = Shader.getPropertyByName("u_projMat");
@@ -314,8 +314,7 @@ export class Camera extends Component {
   }
 
   /**
-   * Create the Camera component.
-   * @param entity - Entity
+   * @internal
    */
   constructor(entity: Entity) {
     super(entity);

packages/core/src/ComponentsDependencies.ts

@@ -14,25 +14,24 @@ export class ComponentsDependencies {
   private static _invDependenciesMap = new Map<ComponentConstructor, ComponentConstructor[]>();
 
   /**
-   * Register component dependencies.
-   * @param currentComponent - The component you want to be register.
-   * @param dependentComponent - The component's dependencies.
+   * @internal
    */
-  static register(currentComponent: ComponentConstructor, dependentComponent: ComponentConstructor) {
+  static _register(currentComponent: ComponentConstructor, dependentComponent: ComponentConstructor): void {
     this._addDependency(currentComponent, dependentComponent, this._dependenciesMap);
     this._addDependency(dependentComponent, currentComponent, this._invDependenciesMap);
   }
 
   /**
    * @internal
    */
-  static _addCheck(entity: Entity, type: ComponentConstructor) {
+  static _addCheck(entity: Entity, type: ComponentConstructor): void {
     // Check if there are dependent components.
-    const dependencies = ComponentsDependencies._dependenciesMap.get(type);
-    if (dependencies) {
-      for (let i = 0, len = dependencies.length; i < len; i++) {
-        if (!entity.getComponent(dependencies[i])) {
-          throw `you should add ${dependencies[i]} before adding ${type}`;
+    const dependentComponents = ComponentsDependencies._dependenciesMap.get(type);
+    if (dependentComponents) {
+      for (let i = 0, n = dependentComponents.length; i < n; i++) {
+        const dependentComponent = dependentComponents[i];
+        if (!entity.getComponent(dependentComponent)) {
+          entity.addComponent(dependentComponent);
         }
       }
     }
@@ -41,7 +40,7 @@ export class ComponentsDependencies {
   /**
    * @internal
    */
-  static _removeCheck(entity: Entity, type: ComponentConstructor) {
+  static _removeCheck(entity: Entity, type: ComponentConstructor): void {
     const invDependencies = ComponentsDependencies._invDependenciesMap.get(type);
     if (invDependencies) {
       for (let i = 0, len = invDependencies.length; i < len; i++) {
@@ -55,8 +54,8 @@ export class ComponentsDependencies {
   private static _addDependency(
     currentComponent: ComponentConstructor,
     dependentComponent: ComponentConstructor,
-    map: Map<any, any>
-  ) {
+    map: Map<ComponentConstructor, ComponentConstructor[]>
+  ): void {
     let components = map.get(currentComponent);
     if (!components) {
       components = [];
@@ -70,8 +69,12 @@ export class ComponentsDependencies {
   private constructor() {}
 }
 
-export function dependencies(...componentClass: ComponentConstructor[]) {
+/**
+ * Dependent components, automatically added if they do not exist.
+ * @param components -  Dependent components
+ */
+export function dependentComponents(...components: ComponentConstructor[]) {
   return function <T extends ComponentConstructor>(target: T): void {
-    componentClass.forEach((component) => ComponentsDependencies.register(target, component));
+    components.forEach((component) => ComponentsDependencies._register(target, component));
   };
 }

packages/core/src/Renderer.ts

@@ -3,19 +3,22 @@ import { BoolUpdateFlag } from "./BoolUpdateFlag";
 import { Camera } from "./Camera";
 import { deepClone, ignoreClone, shallowClone } from "./clone/CloneManager";
 import { Component } from "./Component";
+import { dependentComponents } from "./ComponentsDependencies";
 import { Entity } from "./Entity";
 import { Material } from "./material/Material";
 import { RenderContext } from "./RenderPipeline/RenderContext";
 import { Shader } from "./shader";
 import { ShaderDataGroup } from "./shader/enums/ShaderDataGroup";
 import { ShaderData } from "./shader/ShaderData";
 import { ShaderMacroCollection } from "./shader/ShaderMacroCollection";
-import { UpdateFlag } from "./UpdateFlag";
+import { Transform } from "./Transform";
 
 /**
  * Renderable component.
+ * @decorator `@dependentComponents(Transform)`
  */
-export abstract class Renderer extends Component {
+@dependentComponents(Transform)
+export class Renderer extends Component {
   private static _localMatrixProperty = Shader.getPropertyByName("u_localMat");
   private static _worldMatrixProperty = Shader.getPropertyByName("u_modelMat");
   private static _mvMatrixProperty = Shader.getPropertyByName("u_MVMat");
@@ -286,7 +289,9 @@ export abstract class Renderer extends Component {
   /**
    * @internal
    */
-  abstract _render(camera: Camera): void;
+  _render(camera: Camera): void {
+    throw "not implement";
+  }
 
   /**
    * @internal

packages/core/src/Transform.ts

@@ -292,6 +292,9 @@ export class Transform extends Component {
     this._setDirtyFlagFalse(TransformFlag.WorldMatrix);
   }
 
+  /**
+   * @internal
+   */
   constructor(entity: Entity) {
     super(entity);
 

packages/core/src/fog/Fog.ts

@@ -23,6 +23,9 @@ export class Fog extends Component {
 
   private _color: Color = new Color(1, 0, 0, 1);
 
+  /**
+   * @internal
+   */
   constructor(entity: Entity) {
     super(entity);
     this.color = this._color;

packages/core/src/index.ts

@@ -11,7 +11,7 @@ export { Entity } from "./Entity";
 export { Component } from "./Component";
 export { Script } from "./Script";
 export { Renderer } from "./Renderer";
-export { dependencies } from "./ComponentsDependencies";
+export { dependentComponents } from "./ComponentsDependencies";
 export { Camera } from "./Camera";
 export { Transform } from "./Transform";
 export { UpdateFlag } from "./UpdateFlag";

packages/core/src/mesh/MeshRenderer.ts

@@ -8,7 +8,6 @@ import { Entity } from "../Entity";
 import { Mesh } from "../graphic/Mesh";
 import { Renderer } from "../Renderer";
 import { Shader } from "../shader/Shader";
-import { UpdateFlag } from "../UpdateFlag";
 
 /**
  * MeshRenderer Component.

packages/core/src/physics/Collider.ts

@@ -1,15 +1,18 @@
-import { Component } from "../Component";
-import { ignoreClone } from "../clone/CloneManager";
 import { ICollider } from "@oasis-engine/design";
-import { ColliderShape } from "./shape/ColliderShape";
-import { UpdateFlag } from "../UpdateFlag";
-import { Entity } from "../Entity";
 import { BoolUpdateFlag } from "../BoolUpdateFlag";
+import { ignoreClone } from "../clone/CloneManager";
+import { Component } from "../Component";
+import { dependentComponents } from "../ComponentsDependencies";
+import { Entity } from "../Entity";
+import { Transform } from "../Transform";
+import { ColliderShape } from "./shape/ColliderShape";
 
 /**
- * Abstract class for collider shapes.
+ * Base class for all colliders.
+ * @decorator `@dependentComponents(Transform)`
  */
-export abstract class Collider extends Component {
+@dependentComponents(Transform)
+export class Collider extends Component {
   /** @internal */
   @ignoreClone
   _index: number = -1;
@@ -27,7 +30,10 @@ export abstract class Collider extends Component {
     return this._shapes;
   }
 
-  protected constructor(entity: Entity) {
+  /**
+   * @internal
+   */
+  constructor(entity: Entity) {
     super(entity);
     this._updateFlag = this.entity.transform.registerWorldChangeFlag();
   }

packages/core/src/physics/DynamicCollider.ts

@@ -1,8 +1,8 @@
 import { IDynamicCollider } from "@oasis-engine/design";
+import { Quaternion, Vector3 } from "@oasis-engine/math";
 import { Entity } from "../Entity";
 import { Collider } from "./Collider";
 import { PhysicsManager } from "./PhysicsManager";
-import { Vector3, Quaternion } from "@oasis-engine/math";
 
 /**
  * A dynamic collider can act with self-defined movement or physical force.
@@ -199,6 +199,9 @@ export class DynamicCollider extends Collider {
     (<IDynamicCollider>this._nativeCollider).setCollisionDetectionMode(value);
   }
 
+  /**
+   * @internal
+   */
   constructor(entity: Entity) {
     super(entity);
     const { transform } = this.entity;

packages/core/src/physics/StaticCollider.ts

@@ -7,6 +7,9 @@ import { PhysicsManager } from "./PhysicsManager";
  * @remarks Mostly used for object which always stays at the same place and never moves around.
  */
 export class StaticCollider extends Collider {
+  /**
+   * @internal
+   */
   constructor(entity: Entity) {
     super(entity);
     const { transform } = this.entity;