Catalog npm
Back to packageRELEASE DETAILS

2.0.56

npm

3d-core

A TypeScript library to build 3d park map

Published3 Sept 2024
Direct dependencies30
Transitive dependenciesNot calculated

README

Current package documentation

项目技术选型

Three.js TypeScript Axios Less JsonServer

项目对接方法

import * as ThreeParkMap from '3d-park-map';

// 实例化
const threeParkMap = new ThreeParkMap()

// 初始化,config可以不传,有默认配置
threeParkMap.init(config)

// data是车场信息数据json,绘制3d车场
threeParkMap.draw(data)

项目开发流程

安装

yarn install

启动

开发环境

yarn start

启动mock服务

yarn mock

同时开启mock服务和开发服务

yarn serve

dll构建

yarn build:dll

生产构建(先运行dll构建)

yarn build

开发环境构建(先运行dll构建, 生成stats.json文件,上传webpack官网进行性能分析)

yarn dev-build

项目结构

|-- job
    |-- .eslintrc.json
    |-- .gitignore
    |-- README.md
    |-- package-lock.json
    |-- package.json
    |-- tsconfig.json
    |-- yarn-error.log
    |-- yarn.lock
    |-- config
    |   |-- common.js
    |   |-- dev.js
    |   |-- prod.js
    |   |-- webpack.config.js
    |   |-- webpack.dll.js
    |-- mock
    |   |-- db.json
    |-- public
    |   |-- index.html
    |   |-- dll
    |   |   |-- three.dll.js
    |   |   |-- three.dll.js.LICENSE.txt
    |   |   |-- three.manifest.json
    |   |-- static
    |       |-- fonts
    |       |   |-- helvetiker_regular.typeface.json
    |       |-- img
    |-- src
    |   |-- index.ts
    |   |-- components
    |   |   |-- cube.ts
    |   |   |-- index.ts
    |   |   |-- sphere.ts
    |   |-- config
    |   |   |-- enum.ts
    |   |-- core
    |   |   |-- base.ts
    |   |   |-- threeParkMap.ts
    |   |-- util
    |   |   |-- decoration.ts
    |   |   |-- storage.ts
    |   |-- view
    |       |-- index.ts
    |       |-- example
    |           |-- menu.ts
    |           |-- template
    |               |-- cameraConf.ts
    |               |-- menu.ts
    |-- typings
        |-- base.d.ts
        |-- index.d.ts
        |-- components
        |   |-- index.d.ts
        |-- core
        |   |-- threeParkMap.d.ts
        |-- util
        |   |-- storage.d.ts
        |-- view
            |-- menu.d.ts


项目结构说明

src下是所有核心代码文件

  1. 其中封装的所有基础模块,组件,放在components下,cube.ts和sphere.ts作为例子,所有模块需要继承抽象类Base,并且init方法作为绘制方法入口,在index.ts下导出所有模块,这样开发界面右侧的模块列表下就会读到模块(模块的name属性),点击渲染当前模块内容。
  |-- src
    |   |-- index.ts
    |   |-- components
    |   |   |-- cube.ts
    |   |   |-- index.ts
    |   |   |-- sphere.ts
    |   |-- config
    |   |   |-- enum.ts
    |   |-- core
    |   |   |-- base.ts
    |   |   |-- threeParkMap.ts
    |   |-- util
    |   |   |-- decoration.ts
    |   |   |-- storage.ts
    |   |-- view
    |       |-- index.ts
    |       |-- example
    |           |-- menu.ts
    |           |-- template
    |               |-- cameraConf.ts
    |               |-- menu.ts
  1. view下是视图文件,原则上本库是第三方库,不涉及具体视图,这里视图是开发时候用的界面,方便开发调试
  2. util下是所有工具类,工具方法
  3. config下是配置信息,常量,枚举等
  4. core是核心类比如 threeParkMap以及项目核心流程代码

typings下是ts声明文件,尽量保持和src下一样的结构

mock下db.json是开发时候需要假数据时生成假数据的文件

一些说明

工具方法

装饰器

  1. @log 装饰器实现对方法参数的打印,需要了解哪个方法的传参内容,加上此装饰器(参数是区分打印结果用的一段任意文本)

Downloads & popularity

Awaiting observations

No metric observations yet

Download counts and popularity will appear here as the collector receives them.

Declared dependencies 30

Native requirements
30 direct targetsNot calculated transitive count
Package / targetRequirementRelationship
axios
Environment
{
  "local_name": "axios",
  "alias": false,
  "peer_metadata": null
}
^0.21.1runtime
three
Environment
{
  "local_name": "three",
  "alias": false,
  "peer_metadata": null
}
0.142.0runtime
three.meshline
Environment
{
  "local_name": "three.meshline",
  "alias": false,
  "peer_metadata": null
}
^1.4.0runtime
@eastdesire/jscolor
Environment
{
  "local_name": "@eastdesire/jscolor",
  "alias": false,
  "peer_metadata": null
}
^2.4.5runtime
@amap/amap-jsapi-loader
Environment
{
  "local_name": "@amap/amap-jsapi-loader",
  "alias": false,
  "peer_metadata": null
}
^1.0.1runtime
less
Environment
{
  "local_name": "less",
  "alias": false,
  "peer_metadata": null
}
^4.1.1development
eslint
Environment
{
  "local_name": "eslint",
  "alias": false,
  "peer_metadata": null
}
^7.32.0development
webpack
Environment
{
  "local_name": "webpack",
  "alias": false,
  "peer_metadata": null
}
^5.50.0development
cross-env
Environment
{
  "local_name": "cross-env",
  "alias": false,
  "peer_metadata": null
}
^7.0.3development
ts-loader
Environment
{
  "local_name": "ts-loader",
  "alias": false,
  "peer_metadata": null
}
^9.2.5development
css-loader
Environment
{
  "local_name": "css-loader",
  "alias": false,
  "peer_metadata": null
}
^6.2.0development
typescript
Environment
{
  "local_name": "typescript",
  "alias": false,
  "peer_metadata": null
}
^4.3.5development
url-loader
Environment
{
  "local_name": "url-loader",
  "alias": false,
  "peer_metadata": null
}
^4.1.1development
@babel/core
Environment
{
  "local_name": "@babel/core",
  "alias": false,
  "peer_metadata": null
}
^7.15.0development
file-loader
Environment
{
  "local_name": "file-loader",
  "alias": false,
  "peer_metadata": null
}
^6.2.0development
json-server
Environment
{
  "local_name": "json-server",
  "alias": false,
  "peer_metadata": null
}
^0.16.3development
less-loader
Environment
{
  "local_name": "less-loader",
  "alias": false,
  "peer_metadata": null
}
^10.0.1development
webpack-cli
Environment
{
  "local_name": "webpack-cli",
  "alias": false,
  "peer_metadata": null
}
^4.8.0development
@types/three
Environment
{
  "local_name": "@types/three",
  "alias": false,
  "peer_metadata": null
}
^0.131.1development
babel-loader
Environment
{
  "local_name": "babel-loader",
  "alias": false,
  "peer_metadata": null
}
^8.2.2development
concurrently
Environment
{
  "local_name": "concurrently",
  "alias": false,
  "peer_metadata": null
}
^6.2.1development
style-loader
Environment
{
  "local_name": "style-loader",
  "alias": false,
  "peer_metadata": null
}
^3.2.1development
webpack-merge
Environment
{
  "local_name": "webpack-merge",
  "alias": false,
  "peer_metadata": null
}
^5.8.0development
@babel/preset-env
Environment
{
  "local_name": "@babel/preset-env",
  "alias": false,
  "peer_metadata": null
}
^7.15.0development
webpack-dev-server
Environment
{
  "local_name": "webpack-dev-server",
  "alias": false,
  "peer_metadata": null
}
^3.11.2development
html-webpack-plugin
Environment
{
  "local_name": "html-webpack-plugin",
  "alias": false,
  "peer_metadata": null
}
^5.3.2development
clean-webpack-plugin
Environment
{
  "local_name": "clean-webpack-plugin",
  "alias": false,
  "peer_metadata": null
}
^4.0.0-alpha.0development
@typescript-eslint/parser
Environment
{
  "local_name": "@typescript-eslint/parser",
  "alias": false,
  "peer_metadata": null
}
^4.29.2development
add-asset-html-webpack-plugin
Environment
{
  "local_name": "add-asset-html-webpack-plugin",
  "alias": false,
  "peer_metadata": null
}
^3.2.0development
@typescript-eslint/eslint-plugin
Environment
{
  "local_name": "@typescript-eslint/eslint-plugin",
  "alias": false,
  "peer_metadata": null
}
^4.29.2development

Distribution files

1 collected
Distribution 1

Source distribution

Source file
Checksums from source
{
  "shasum": "a1da6973ca7dccf259cff87d2b873683813fb288",
  "tarball": "https://registry.npmjs.org/3d-core/-/3d-core-2.0.56.tgz",
  "fileCount": 3,
  "integrity": "sha512-Pqo81U0uQv1Zy72E0uhx5zx8tbnmANYl/miu2N/KCSWa46c1eZtj5J70azMuGkWdE3xsQc4uHN5y0Ct5Fa7Bbg==",
  "signatures": [
    {
      "sig": "MEYCIQCV9lbH+gH4jc97AUNR29ORwu4qJsgG5no3KIoeeM1c9AIhAOxirPwd+BD/CDrUM5LgAKGoBnvCn9K+/oYWhZsHJAgF",
      "keyid": "SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"
    }
  ],
  "unpackedSize": 2246953
}

Metadata history

Meaningful changes
Current collected state Current

Observed since 20 Oct, 19:34 UTC

No superseded metadata states collected. Unchanged observations do not create new revisions.

Record identity

package_version:89b1b6816f91c0eddc2ae89b7016ba10ccd364201edd8bc89e904583899cfa83

Other collected versions

2.0.6312 Sept2.0.6212 Sept2.0.612 Apr2.0.601 Apr2.0.5916 Dec2.0.5816 DecView all collected versions →