Skip to content

Commit 9572703

Browse files
authored
Merge pull request #2 from oasis-engine/temp/add-clone-doc
organize folder
2 parents 2d0ebe7 + 3d5aaf9 commit 9572703

19 files changed

+27
-30
lines changed

GITBOOK.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ $ gitbook serve
1919
[CuboidGeometry]({{book.api}}classes/core.cuboidgeometry.html)
2020
2121
// docs
22-
[资源加载]({{book.docs}}structure/resource-manager.html)
22+
[资源加载]({{book.docs}}resource/resource-manager.html)
2323
```
2424

2525
## Build

SUMMARY.md

+17-20
Original file line numberDiff line numberDiff line change
@@ -4,30 +4,27 @@
44
* 新手上路
55
* [绘制一个立方体](abc/cube.md)
66
* [绘制一个 3D 模型](abc/model.md)
7-
* 基础结构
7+
* 核心
88
* [引擎](structure/engine.md)
99
* [场景](structure/scene.md)
1010
* [实体](structure/entity.md)
1111
* [克隆](structure/entity-clone.md)
12-
* [脚本组件](structure/script.md)
13-
* [资源管理与加载](structure/resource-manager.md)
12+
* 组件
13+
* [变换系统](component/transform.md)
14+
* [相机](component/camera.md)
15+
* [灯光](component/light.md)
16+
* [几何体渲染器](component/geometry-renderer.md)
17+
* [常用几何体](component/basic-geometry.md)
18+
* [脚本组件](component/script.md)
19+
* [骨骼动画](component/skeletal-animation.md)
20+
* [粒子动画](component/particle-system.md)
21+
* [碰撞检测](component/collision.md)
22+
* [射线投射](component/ray.md)
1423
* 资源系统
15-
* [纹理资源](resource-system/texture.md)
16-
* 渲染系统
17-
* [相机](render-system/camera.md)
18-
* [灯光](render-system/light.md)
19-
* [几何体渲染器](render-system/geometry-renderer.md)
20-
* [常用几何体](render-system/basic-geometry.md)
21-
* 变换系统
22-
* [变换系统](transform-system/transform.md)
23-
* 动画系统
24-
* [骨骼动画](animation-system/skeletal-animation.md)
25-
* [粒子动画](animation-system/particle-system.md)
24+
* [资源管理与加载](resource/resource-manager.md)
25+
* [纹理资源](resource/texture.md)
2626
* 工具库
2727
* [数学库](tools/math.md)
28-
* 碰撞系统
29-
* [射线投射](collision-system/ray.md)
30-
* [碰撞检测](collision-system/collision.md)
31-
* 交互系统
32-
* [控制器](interaction-system/controls.md)
33-
* [帧缓冲拾取](interaction-system/framebuffer-picker.md)
28+
* 二方组件
29+
* [控制器](second-party-component/controls.md)
30+
* [帧缓冲拾取](second-party-component/framebuffer-picker.md)
File renamed without changes.
File renamed without changes.

collision-system/collision.md renamed to component/collision.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313
| [SphereCollider]({{book.api}}classes/core.aspherecollider.html) | 球型碰撞体 |
1414

1515

16-
给物体添加碰撞体的方法请参考[射线投射]({{book.docs}}collision-system/ray.html)
16+
给物体添加碰撞体的方法请参考[射线投射]({{book.docs}}component/ray.html)
1717

1818
## 使用方法
1919

File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.

animation-system/skeletal-animation.md renamed to component/skeletal-animation.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# 骨骼动画
22

3-
Oasis 3D 中的骨骼动画通过 glTF 模型(相关教程请参考[资源加载]({{book.docs}}structure/resource-manager.html))的动画组件([Animation]({{book.api}}classes/core.animationclip.html))获得,动画组件中包含多个动画片段([AnimationClip]({{book.api}}classes/core.animation.html)),动画组件可以控制动画片段的播放。
3+
Oasis 3D 中的骨骼动画通过 glTF 模型(相关教程请参考[资源加载]({{book.docs}}resource/resource-manager.html))的动画组件([Animation]({{book.api}}classes/core.animationclip.html))获得,动画组件中包含多个动画片段([AnimationClip]({{book.api}}classes/core.animation.html)),动画组件可以控制动画片段的播放。
44

55
```typescript
66
// 在脚本组件中使用
File renamed without changes.

structure/resource-manager.md renamed to resource/resource-manager.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
3D 资源一般与 Engine 挂钩,我们使用挂载在 Engine 实例中的 [ResourceManager]({{book.api}}classes/core.engine.html#resourcemanager) 管理与加载资源。
44

5-
推荐用[脚本组件]({{book.docs}}structure/script.html)的方式加载资源。[load]({{book.api}}classes/core.resourcemanager.html#load) 方法即可传入 url,也可以传入 [loadItem]({{book.api}}modules/core.html#loaditem),也可以传入数组表示批量加载。
5+
推荐用[脚本组件]({{book.docs}}component/script.html)的方式加载资源。[load]({{book.api}}classes/core.resourcemanager.html#load) 方法即可传入 url,也可以传入 [loadItem]({{book.api}}modules/core.html#loaditem),也可以传入数组表示批量加载。
66

77
```typescript
88
export class ResourceScript extends Script {
@@ -71,7 +71,7 @@ engine.resourceManager.gc();
7171

7272
### 1. Texture2D
7373

74-
> 更多纹理相关文档可查阅[纹理资源]({{book.docs}}resource-system/texture.html)
74+
> 更多纹理相关文档可查阅[纹理资源]({{book.docs}}resource/texture.html)
7575
7676
```typescript
7777
const texture2D = await this.engine.resourceManager.load("test.png");
@@ -83,7 +83,7 @@ this.engine.resourceManager.load({url: "test", type: AssetType.Texture2D});
8383

8484

8585
### 2. TextureCube
86-
> 更多纹理相关文档可查阅[纹理资源]({{book.docs}}resource-system/texture.html)
86+
> 更多纹理相关文档可查阅[纹理资源]({{book.docs}}resource/texture.html)
8787
8888
```typescript
8989
const textureCube = await this.engine.resourceManager
@@ -104,7 +104,7 @@ const textureCube = await this.engine.resourceManager
104104

105105

106106
### 3. 压缩纹理
107-
> 更多压缩纹理相关文档可查阅[压缩纹理]({{book.api}}resource-system/texture.html#压缩纹理)
107+
> 更多压缩纹理相关文档可查阅[压缩纹理]({{book.api}}resource/texture.html#压缩纹理)
108108
109109
```typescript
110110
const compressedTexture2D = await this.engine.resourceManager.load("test.ktx");
File renamed without changes.
File renamed without changes.

structure/engine.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# 引擎
22

3-
Engine 在 Oasis 引擎中扮演着总控制器的角色,他能够控制画布(支持跨平台)的一切行为,包括[资源管理]({{book.docs}}structure/resource-manager.html)[场景管理]({{book.docs}}structure/scene.html)、执行/暂停/继续、垂直同步等功能。
3+
Engine 在 Oasis 引擎中扮演着总控制器的角色,他能够控制画布(支持跨平台)的一切行为,包括[资源管理]({{book.docs}}resource/resource-manager.html)[场景管理]({{book.docs}}structure/scene.html)、执行/暂停/继续、垂直同步等功能。
44

55

66
## 初始化

structure/entity.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ directLight.intensity = 1;
3535

3636
### 访问实体和组件
3737

38-
[脚本]({{book.docs}}structure/script.html)能够响应玩家输入,能够修改、创建和销毁实体或组件,实现各种各样的游戏逻辑。要实现这些效果,你需要先在脚本中获得你要修改的实体或组件。这里我们将简单的介绍常用的实体操作:
38+
[脚本]({{book.docs}}component/script.html)能够响应玩家输入,能够修改、创建和销毁实体或组件,实现各种各样的游戏逻辑。要实现这些效果,你需要先在脚本中获得你要修改的实体或组件。这里我们将简单的介绍常用的实体操作:
3939

4040
#### 获得组件所在的实体
4141
我们可以在脚本的任意生命周期内获得它所绑定的实体如:

tools/math.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# 数学库
22

3-
在一个渲染场景中,我们经常会对物体进行平移、旋转、缩放等操作(这些操作我们统一称为 [变换]({{book.docs}}transform-system/transform.html) ),从而达到我们想要的互动效果。而这些变换的计算,我们一般都是通过向量、四元数、矩阵等来实现的,为此我们提供一个数学库来完成 *向量**四元数**矩阵* 等相关运算。
3+
在一个渲染场景中,我们经常会对物体进行平移、旋转、缩放等操作(这些操作我们统一称为 [变换]({{book.docs}}component/transform.html) ),从而达到我们想要的互动效果。而这些变换的计算,我们一般都是通过向量、四元数、矩阵等来实现的,为此我们提供一个数学库来完成 *向量**四元数**矩阵* 等相关运算。
44

55
| 类型 | 解释 |
66
| :--- | :--- |

0 commit comments

Comments
 (0)