3d-css-scene 中文文档教程

发布于 4年前 浏览 23 项目主页 更新于 3年前

3d-css-scene

灵感来自 Keith Clark 的 CSS 3D Engine

Installation

使用 npm:

npm i --save 3d-css-scene

您可能会喜欢像 WebpackBabel 导入和使用 3d-css-scene 确保您的 ECMAScript 代码与旧浏览器兼容。

在你的 whatever.js 文件中导入 3d-css-scene 并添加一个房间:

// Load the main object. Constructor will instantiate the camera and allow for objects creation.
import { Scene } from '3d-css-scene'
// Load required css styling for the scene.
import '3d-css-scene/dist/app.css'

// Instantiate the Scene object
const scene = new Scene()

// Add a room to your scene
const room = scene.createRoom('room', 3600, 1080, 3000)
room.translateZ(-200)
room.update()

场景允许通过专用函数实例化主要对象和创建以下对象,其中 className 是一个 string 并且每个 scaleX|Y|Z 都是一个 number

  • Room with scene.createRoom(className, scaleX, scaleY, scaleZ)
  • Plane with scene.createPlane(className, scaleX, scaleY)
  • Box with scene.createBox(className, scaleX, scaleY, scaleZ)
  • Avatar with scene.createAvatar(className, scaleX, scaleY)

Development

Run this project

安装依赖

npm install

项运行开发服务器

npm start

要在本地测试此库,您必须首先将此库公开到您的节点安装目录。 这将安装所有依赖项并最终输出符号链接消息。

npm link

/your-node-path/node/v12.18.1/lib/node_modules/3d-css-scene-test -> /path-to-this-project/3d-css-scene

然后,导航到另一个 npm 项目,您应该将依赖项链接到该库。 将出现另一个符号链接消息

npm link 3d-css-scene

/path-to-this-project/3d-css-test-app/node_modules/3d-css-scene -> /your-node-path/node/v12.18.1/lib/node_modules/3d-css-scene -> /path-to-3d-css-scene-project/3d-css-scene

这应该足以在另一个项目中测试此依赖项。 您可以选择将 3d-css-scene 添加到 package.json 中的依赖项中。 npm link 3d-css-scene 命令将覆盖来自 npm 注册表的包。

该库以 dist 模式导出,以获得更好的性能并避免在导入时出现 babel 语法问题。 每当您对此库进行更改时,您都希望看到它们反映在您的项目中。 然后您可以运行以下命令,以在任何给定时间重建库:

npm run build:watch

无论何时更改文件,更改都应反映在链接到该库的任何项目中。

3d-css-scene

Inspired by Keith Clark's CSS 3D Engine

Installation

Using npm:

npm i --save 3d-css-scene

You may enjoy tools like Webpack and Babel to import and use the 3d-css-scene making sure your ECMAScript code remains compatible with older browsers.

Importing 3d-css-scene in you whatever.js file and adding a room:

// Load the main object. Constructor will instantiate the camera and allow for objects creation.
import { Scene } from '3d-css-scene'
// Load required css styling for the scene.
import '3d-css-scene/dist/app.css'

// Instantiate the Scene object
const scene = new Scene()

// Add a room to your scene
const room = scene.createRoom('room', 3600, 1080, 3000)
room.translateZ(-200)
room.update()

Scene allows the instanciation of the main object and the creation of the following objects, via dedicated functions, where className is a string and every scaleX|Y|Z is a number:

  • Room with scene.createRoom(className, scaleX, scaleY, scaleZ)
  • Plane with scene.createPlane(className, scaleX, scaleY)
  • Box with scene.createBox(className, scaleX, scaleY, scaleZ)
  • Avatar with scene.createAvatar(className, scaleX, scaleY)

Development

Run this project

Install dependencies

npm install

Run the development server

npm start

To locally test this library you must first expose this library to your node installation directory. This wil install all dependencies and finally output a symlink message.

npm link

/your-node-path/node/v12.18.1/lib/node_modules/3d-css-scene-test -> /path-to-this-project/3d-css-scene

Then, navigate to another npm project you should link your dependencies to this library. Another symlink message will appear

npm link 3d-css-scene

/path-to-this-project/3d-css-test-app/node_modules/3d-css-scene -> /your-node-path/node/v12.18.1/lib/node_modules/3d-css-scene -> /path-to-3d-css-scene-project/3d-css-scene

This should be enough to test this dependency within another project. You can optionally add 3d-css-scene to your dependencies in package.json. The npm link 3d-css-scene command would override the package from the npm registry.

This library is exported in it's dist mode for better performance and avoid babel syntax problemas when importing. Any time you make changes to this library you'd want to see them reflected in your project. Then you can run the following, to rebuild the library at any given time:

npm run build:watch

Changes should be reflected in any project linked to this library, whenever you change a file.

    我们使用 Cookies 和其他技术来定制您的体验包括您的登录状态等。通过阅读我们的 隐私政策 了解更多相关信息。 单击 接受 或继续使用网站,即表示您同意使用 Cookies 和您的相关数据。
    原文