Separate each engines' codes to different individual packages by dolow · Pull Request #39 · drecom/scene-graph

dolow · 2019-06-04T10:16:48Z

Summary

Separated engine specific codes to different module.

figure: workflow example / CocosCreator to PIXI.js

Added packages

scene-graph-pixi/runtime as @drecom/scene-graph-pixi-rt
scene-graph-three/runtime as @drecom/scene-graph-three-rt
scene-graph-unity/client as @drecom/scene-graph-unity-cli
scene-graph-cocos/client as @drecom/scene-graph-cocos-cli

Added CircleCI job for each new package

Removed engine things from scene-graph-mediator-rt,cli

Changed module loading method

Each engine implementation is loaded with require dynamically before this PR.
Ref:

scene-graph/packages/scene-graph-mediator/client/src/exporter/ExportManager.ts

Lines 24 to 38 in 4e15bb1

    
           public static getSceneExporterClass(runtimeId: string): SceneExporterConstructor | null { 
        
             const id = runtimeId.toLowerCase(); 
        
             if (RuntimeIdentifiers.COCOS_CREATOR_V1.indexOf(id) !== -1) { 
        
               return require('../exporter/scene/CocosCreator').default; 
        
             } 
        
             if (RuntimeIdentifiers.COCOS_CREATOR_V2.indexOf(id) !== -1) { 
        
               return require('../exporter/scene/CocosCreatorV2').default; 
        
             } 
        
             if (RuntimeIdentifiers.UNITY.indexOf(id) !== -1) { 
        
               return require('../exporter/scene/Unity').default; 
        
             } 
        
             return null; 
        
           }

After this, each module registers itself to ExportManager.

ExportManager.registerExporterClass(identifier, sceneExporter, assetExporter);

Because export process is expected to be kicked from some GUI in the future, GUI should know which engine is available ahead of process running.

Files to review

Because there are bunch of artifacts, reviewers need instruction which files should be reviewd.

packages/scene-graph-cocos/client/package.json
packages/scene-graph-cocos/client/src/*
packages/scene-graph-mediator/client/package.json
packages/scene-graph-mediator/client/src/*
packages/scene-graph-mediator/runtime/package.json
packages/scene-graph-mediator/runtime/src/*
packages/scene-graph-pixi/runtime/package.json
packages/scene-graph-pixi/runtime/src/*
packages/scene-graph-three/runtime/package.json
packages/scene-graph-three/runtime/src/*
packages/scene-graph-unity/client/package.json
packages/scene-graph-unity/client/src/*

Test

CircleCI (see below)
export cocos sample.fire scene
export cocos mask_sample.fire
import cocos sample.fire scene into pixi runtime w/animation
import cocos mask_sample.fire scene into pixi runtime

Todo

Rename scene-graph-cocos-animation/runtime to scene-graph-cocos-animation-pixi/runtime.
Change npm dependencies with relative path to proper npm package name with version.
I'm not going to do it in this PR.

dolow · 2019-06-04T10:18:16Z

+  }
+
+  if (args.listRuntimes) {
+    const runtimes = ExportManager.getRegisteredExporterRuntimes();


Function for debugging became a little new feature.

dolow · 2019-06-04T10:21:42Z

-import * as Zlib from 'runtime/three/Zlib';
-import NURBSCurve from 'runtime/three/NURBSCurve';
-import TgaLoader from 'runtime/three/loaders/TgaLoader';
+import ThreeLoader from '../interface/ThreeLoader';


To use THREE, refer ThreeLoader's threeRef static property instead of using imported three module, this is because to share the same three object among scripts.

dolow · 2019-06-04T10:36:28Z

+  "keywords": [],
+  "author": "Drecom Co.,Ltd.",
+  "devDependencies": {
+    "@drecom/scene-graph-mediator-cli": "file:../../scene-graph-mediator/client",


update package reference after npm release.

…odules directory

dolow · 2019-06-04T11:11:27Z


-    for (const [key, value] of resourceMap.entries()) {
-      const entity = value;
+    const it = resourceMap.entries();


Fixed TypeScript transpile error.
Iterator object can not be iterated with for...of.

takeshi-sakurai · 2019-06-11T08:48:13Z

    args = parseArgs();
  } catch (e) {
-    console.log(e);
-    console.log(CliHelptext);


There seems to be no opportunity for usage to be displayed.

commander shows instruction with --help option.

$ ./bin/cli.js --help

zprodev

LGTM

takeshi-sakurai

LGTM

Egliss

LGTM

dolow added 4 commits June 4, 2019 16:16

separated engine specific codes to different package

a470195

merged master

6e7965d

freezed sinon version, fixed main script path in package.json

9c6bb11

reomved test artifacts

0d94c88

dolow commented Jun 4, 2019

View reviewed changes

updated circle ci job

8a14985

dolow commented Jun 4, 2019

View reviewed changes

dolow added 4 commits June 4, 2019 19:46

updated circle ci jobs to proceed sequencially

c305104

fixed yaml format error

29dbdcf

prepared package-lock.json cause unexpected .staging folder in node_m…

58997b0

…odules directory

fixed ts transpile error

383a2d9

dolow commented Jun 4, 2019

View reviewed changes

dolow added 4 commits June 4, 2019 20:18

install file refered package deps's npm module before target module job

362f942

fixed generic argument

e6c3d26

ensure instantiated object existence

d52f784

updated artifacts, added cocos mask sample scene

dac2104

dolow requested review from Egliss and zprodev June 5, 2019 06:02

merged master

ea91d92

dolow requested a review from takeshi-sakurai June 11, 2019 07:38

takeshi-sakurai reviewed Jun 11, 2019

View reviewed changes

dolow mentioned this pull request Jun 11, 2019

RichText cocos to pixi #44

Merged

6 tasks

zprodev approved these changes Jun 12, 2019

View reviewed changes

takeshi-sakurai approved these changes Jun 13, 2019

View reviewed changes

Egliss approved these changes Jun 13, 2019

View reviewed changes

Egliss merged commit cfcdef0 into master Jun 13, 2019

dependabot-preview Bot mentioned this pull request Mar 13, 2020

[Security] Bump acorn from 5.7.3 to 5.7.4 #77

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Separate each engines' codes to different individual packages#39

Separate each engines' codes to different individual packages#39
Egliss merged 14 commits into
masterfrom
feature/separate_engines

dolow commented Jun 4, 2019 •

edited

Loading

Uh oh!

dolow Jun 4, 2019

Uh oh!

dolow Jun 4, 2019

Uh oh!

dolow Jun 4, 2019

Uh oh!

dolow Jun 4, 2019

Uh oh!

takeshi-sakurai Jun 11, 2019

Uh oh!

dolow Jun 12, 2019

Uh oh!

zprodev left a comment

Uh oh!

takeshi-sakurai left a comment

Uh oh!

Egliss left a comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

	public static getSceneExporterClass(runtimeId: string): SceneExporterConstructor \| null {
	const id = runtimeId.toLowerCase();

	if (RuntimeIdentifiers.COCOS_CREATOR_V1.indexOf(id) !== -1) {
	return require('../exporter/scene/CocosCreator').default;
	}
	if (RuntimeIdentifiers.COCOS_CREATOR_V2.indexOf(id) !== -1) {
	return require('../exporter/scene/CocosCreatorV2').default;
	}
	if (RuntimeIdentifiers.UNITY.indexOf(id) !== -1) {
	return require('../exporter/scene/Unity').default;
	}

	return null;
	}

Conversation

dolow commented Jun 4, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Added packages

Added CircleCI job for each new package

Removed engine things from scene-graph-mediator-rt,cli

Changed module loading method

Files to review

Test

Todo

Uh oh!

dolow Jun 4, 2019

Choose a reason for hiding this comment

Uh oh!

dolow Jun 4, 2019

Choose a reason for hiding this comment

Uh oh!

dolow Jun 4, 2019

Choose a reason for hiding this comment

Uh oh!

dolow Jun 4, 2019

Choose a reason for hiding this comment

Uh oh!

takeshi-sakurai Jun 11, 2019

Choose a reason for hiding this comment

Uh oh!

dolow Jun 12, 2019

Choose a reason for hiding this comment

Uh oh!

zprodev left a comment

Choose a reason for hiding this comment

Uh oh!

takeshi-sakurai left a comment

Choose a reason for hiding this comment

Uh oh!

Egliss left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

dolow commented Jun 4, 2019 •

edited

Loading