doc: update document
This commit is contained in:
parent
f10c273067
commit
c448216496
@ -1,5 +1,8 @@
|
||||
# Add Floor
|
||||
|
||||
!!! info "Not latest version"
|
||||
This translated page is not the latest version because the modification of source page. Please see source page of the latest version.
|
||||
|
||||
## Start Generating
|
||||
|
||||
In the 3D view, click `Add - Floors` to expand the Add Floors menu. The menu is shown below.
|
||||
|
@ -1,5 +1,8 @@
|
||||
# Import and Export Virtools Document
|
||||
|
||||
!!! info "Not latest version"
|
||||
This translated page is not the latest version because the modification of source page. Please see source page of the latest version.
|
||||
|
||||
!!! warning "This is experimental content"
|
||||
Native importing and exporting of Virtools documents is experimental content for the BBP plugin, it may have many problems, see the [Report Issue](./report-bugs.md) section to learn more. When problems are encountered, please report them. the authors of the BBP plugin are not responsible for any consequences resulting from problems with the BBP plugin.
|
||||
|
||||
@ -21,7 +24,7 @@ The default values for the options in the Conflict Options section are the solut
|
||||
It is well known that Virtools uses a system-based multi-byte character encoding to process documents, and is therefore prone to what is known as garbling; Blender itself does not suffer from garbling, however, if we do not read a Virtools document with the correct encoding, the characters stored in it may still appear garbled when the Virtools document is imported into Blender. The Encodings property in the Virtools Params section specifies the encodings for reading Virtools documents. Multiple encodings can be specified, separated by a `;` (semicolon). Some common encodings are listed below:
|
||||
|
||||
* cp1252: Western European encoding used by Ballance.
|
||||
* gb2312: The default encoding for Chinese Windows system.
|
||||
* gbk: The default encoding for Chinese Windows system.
|
||||
|
||||
The encoding attribute is very important. If the wrong encoding is set, the names of the various objects imported into Blender will be unrecognizable, or will cause the program to make an error.
|
||||
|
||||
|
@ -1,5 +1,8 @@
|
||||
# Add Rail
|
||||
|
||||
!!! info "Not latest version"
|
||||
This translated page is not the latest version because the modification of source page. Please see source page of the latest version.
|
||||
|
||||
In the 3D view, click `Add - Rails` to expand the Add Rails menu. The menu is shown on the left side of the image below.
|
||||
|
||||
![](../imgs/rail-adder.png)
|
||||
|
@ -1,5 +1,8 @@
|
||||
# Report Issue
|
||||
|
||||
!!! info "Not latest version"
|
||||
This translated page is not the latest version because the modification of source page. Please see source page of the latest version.
|
||||
|
||||
## What Can Go Wrong
|
||||
|
||||
BBP is not perfect, and since BBP's Virtools file import/export module is written in C++, BBP is more prone to errors than other plugins, and the consequences of errors can be more serious (including but not limited to memory leaks, accidental deletion of user files, etc.).
|
||||
|
@ -1,5 +1,8 @@
|
||||
# Virtools Properties
|
||||
|
||||
!!! info "Not latest version"
|
||||
This translated page is not the latest version because the modification of source page. Please see source page of the latest version.
|
||||
|
||||
## Virtools Group
|
||||
|
||||
The BBP plugin adds a new property to every Blender object, called Virtools Group. has the same functionality as Group in Virtools. Select an object and the `Virtools Group` panel can be found in the `Object` properties panel.
|
||||
|
4
docs/docs/en/zzq-features.md
Normal file
4
docs/docs/en/zzq-features.md
Normal file
@ -0,0 +1,4 @@
|
||||
# ZZQ Features
|
||||
|
||||
!!! info "No Translation"
|
||||
This page has not been translated. Please see source page of this page.
|
BIN
docs/docs/imgs/virtools-light.png
Normal file
BIN
docs/docs/imgs/virtools-light.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 49 KiB |
@ -23,6 +23,12 @@
|
||||
|
||||
最后它指示我们需要配置这个路面哪些面需要显示。需要注意的是,Top和Bottom指的是沿高度方向(Z轴)的顶面和底面,而Front,Back,Left,Right则是以头顶朝向-X轴,眼睛朝向-Z轴俯视状态下的前后左右。您可能注意到这6个面按钮中间有一个透视的六面体,实际上这六个面的选项的位置与这个透视六面体的六个面的位置是一一对应的。
|
||||
|
||||
## 额外变换
|
||||
|
||||
在BME配置对话框的底部,您总是可以找到一个被称为额外变换的区域。在这个区域中,有额外移动和额外旋转两个选项可以配置。这些字段主要是为了可视化服务的。
|
||||
|
||||
在说明这些字段的实际作用前,你需要知道,BME创建的路面总是以当前3D游标的位置进行创建的,即3D游标在哪里,新创建的路面就在哪里。这主要是为了可视化来考虑到,用户可以先将3D游标移动到想要添加路面的位置,再添加对应的BME结构,便可以在调整参数的时候即时预览到结果。有时候你的3D游标的位置不是那么的准确,又或者最终生成的结构需要一定的旋转才是你期望的,此时就可以利用额外变换字段,为最终生成的结构,增加相对于3D游标的额外的移动和旋转,使之处于正确的位置,这样就可以在调整参数的时候实时预览到结果了。
|
||||
|
||||
## 小贴士
|
||||
|
||||
每个路面类型,其配置的条目数是不同的,因此对于不同路面类型,需要根据配置的提示文本来了解对应配置具体是做什么的。一些路面类型所需要设置的条目可能很多,另一些则根本没有配置条目。
|
||||
|
@ -9,7 +9,7 @@
|
||||
|
||||
### 冲突解决选项
|
||||
|
||||
Conflict Options(冲突解决选项)章节指示了当导入器遇到物体名称重复的情况时,该如何处理。分为4个等级,分别针对Object(物体),Mesh(网格),Material(材质),Texture(贴图)。处理方式则有2种:Rename(重命名)和Use Current(使用当前)。选择重命名后,当遇到重复名称时,将会自动为其添加名称后缀使其名称唯一化。而选择使用当前,则会忽略从文件中导入此项,转而使用Blender文档中已经存在的同名的项目。
|
||||
Conflict Options(冲突解决选项)章节指示了当导入器遇到物体名称重复的情况时,该如何处理。分为4个等级,分别针对Object(物体),Light(灯光),Mesh(网格),Material(材质),Texture(贴图)。处理方式则有2种:Rename(重命名)和Use Current(使用当前)。选择重命名后,当遇到重复名称时,将会自动为其添加名称后缀使其名称唯一化。而选择使用当前,则会忽略从文件中导入此项,转而使用Blender文档中已经存在的同名的项目。
|
||||
|
||||
!!! info "与Virtools冲突解决的不同"
|
||||
相比较于在Virtools的冲突解决对话框,BBP插件提供的冲突解决选项不支持替换功能,同时其粒度也不支持精细到单个实例,只能针对一整个类型进行设定。因此你无法单独为每一个冲突的实例设置不同的冲突解决方案。但目前这种设置已经能满足绝大对数的使用场景了。
|
||||
@ -18,10 +18,10 @@ Conflict Options(冲突解决选项)章节指示了当导入器遇到物体
|
||||
|
||||
### Virtools参数
|
||||
|
||||
众所周知,Virtools使用基于系统的多字节字符编码来处理文档,因而很容易出现所谓乱码问题。Blender本身不会出现乱码问题,然而如果我们不能以正确的编码读取Virtools文档,则当Virtools文档被导入Blender时,其中存储的字符仍然可能会呈现乱码状态。Virtools Params(Virtools参数)章节的Encodings(编码)属性用于指定读取Virtools文档的编码。可以指定多个编码,多个编码之间用`;`(分号)分隔。下面列出一些常用的编码:
|
||||
众所周知,Virtools使用基于系统的多字节字符编码来处理文档,因而很容易出现所谓乱码问题。Blender本身不会出现乱码问题,然而如果我们不能以正确的编码读取Virtools文档,则当Virtools文档被导入Blender时,其中存储的字符仍然可能会呈现乱码状态。Virtools Params(Virtools参数)章节的Encodings(编码)属性用于指定读取Virtools文档的编码。可以指定多个编码,越靠上的编码越优先使用,当无法解码时才会使用下一级编码。下面列出一些常用的编码:
|
||||
|
||||
* cp1252:Ballance所用的西欧编码
|
||||
* gb2312:中文Windows系统默认编码
|
||||
* gbk:中文Windows系统默认编码
|
||||
|
||||
编码属性非常重要,如果设置了错误的编码,导入Blender的各类物体的名称会出现不可认知的情况,又或者会导致程序出错。
|
||||
|
||||
|
@ -60,6 +60,8 @@
|
||||
|
||||
圆弧轨的Steps(步数),步数表示这个圆弧轨的分段数,数字越大,圆弧轨看起来越平滑,相对的,顶点也会更多,对存储空间和渲染的要求也越高,因此需要选择一个合理的数值。
|
||||
|
||||
圆弧轨的Flip(翻转)选项可以让你在指定的轴向上翻转(也可以视为镜像)生成的结构,三个轴上的翻转选项可以满足所有对应手性结构的生成。
|
||||
|
||||
圆弧轨同样支持双轨单轨选择,可以创建单轨圆弧轨和双轨圆弧轨。也支持封盖属性。
|
||||
|
||||
### Spiral Rail
|
||||
@ -70,7 +72,7 @@
|
||||
|
||||
螺旋轨也需要设置Steps(步数)属性,含义与圆弧轨一致。但需要注意的是步数指的是每一个迭代内的步数个数,并不是总体的步数。因此调整迭代属性的时候,不需要再调整步数属性。
|
||||
|
||||
螺旋轨也有封盖属性。
|
||||
螺旋轨也有封盖属性和翻转属性。
|
||||
|
||||
### Side Spiral Rail
|
||||
|
||||
@ -78,4 +80,10 @@
|
||||
|
||||
侧边螺旋轨没有螺距属性,因为侧边螺旋轨在设计上,相邻的旋进是共用一条边的,因此螺距是固定的。
|
||||
|
||||
侧边螺旋轨设定中的Radius(半径),Iterations(迭代)和Steps(步数)属性,含义均与螺旋轨一致。侧边螺旋轨也有封盖属性。
|
||||
侧边螺旋轨设定中的Radius(半径),Iterations(迭代)和Steps(步数)属性,含义均与螺旋轨一致。
|
||||
|
||||
侧边螺旋轨也有封盖属性和翻转属性。
|
||||
|
||||
## 额外变换
|
||||
|
||||
在添加直线钢轨和曲线钢轨的时候,你总可以设置一个被称为额外变换的属性。其效果与添加路面中的额外变换字段一致,都是为可视化服务的。
|
||||
|
@ -12,7 +12,7 @@ BBP不是完美的,由于BBP的Virtools文件导入导出模块是由C++编写
|
||||
|
||||
## 哪部分出错了
|
||||
|
||||
对于BBP插件而言,如果你在Python异常输出中观察到类似于`BMap operation failed`的字样,或者在`<插件安装位置>/PyBMap`文件夹下观察到了`IronPad.log`文件,则说明BBP插件的由C++编写的BMap部分出错了,**你需要立即保存你当前的Blender文档,并退出Blender。** 因为此时插件已处于非正常状态,你不应继续任何操作。
|
||||
对于BBP插件而言,如果你在Python异常输出中观察到类似于`BMap operation failed`的字样,或者在`%LOCALAPPDATA%/CrashDumps`文件夹(`%LOCALAPPDATA%`是一个Windows环境变量,如果你不清楚它是什么,你可以简单地将该地址直接粘贴到Windows文件资源管理器中,Windows文件资源管理器会自动为你导航到正确位置)下观察到了`blender.exe.<xxx>.log`文件(其中`<xxx>`是一串数字),则说明BBP插件的由C++编写的BMap部分出错了,**你需要立即保存你当前的Blender文档,并退出Blender。** 因为此时插件已处于非正常状态,你不应继续任何操作。
|
||||
|
||||
如果并没有上述情况,那么这就只是普通的Python代码执行错误,不需要过度担心,但错误仍然是致命的,建议做完所有必要的操作后退出Blender并报告错误。
|
||||
|
||||
@ -26,4 +26,4 @@ BBP不是完美的,由于BBP的Virtools文件导入导出模块是由C++编写
|
||||
|
||||
首先你需要详细描述你是如何引发这个错误的,这个错误有什么结果。如果可以上传导致错误的文档,请尽量上传(如果不方便公开发布,可以通过邮件等私有渠道发送给作者)。
|
||||
|
||||
你还需要提供Blender控制台中输出的Python堆栈报告(使用`Window - Toggle System Console`打开控制台)。如果你的错误是BMap部分的错误,你还需要提供`<插件安装位置>/PyBMap`文件夹下的`IronPad.log`和`IronPad.dmp`文件以方便开发者定位错误。
|
||||
你还需要提供Blender控制台中输出的Python堆栈报告(使用`Window - Toggle System Console`打开控制台)。如果你的错误是BMap部分的错误,你还需要提供BMap模块输出的错误日志文件`blender.exe.<xxx>.log`和内存转储文件`blender.exe.<xxx>.dmp`(`<xxx>`同理为一串数字),这些文件同样可在`%LOCALAPPDATA%/CrashDumps`文件夹中找到。
|
||||
|
@ -10,6 +10,8 @@ BBP插件为每一个Blender物体添加了新的属性,被称为Virtools Grou
|
||||
|
||||
BBP还在Blender的其它菜单提供了对Virtools组的访问,具体内容请参阅[按组操作](./group-operations.md)。
|
||||
|
||||
需要注意的是,Virtools组仅对网格物体生效,当你在其它物体上打开Virtools组面板时,你会在面板中看到一条警告消息,提示你Virtools组在该物体上无效。在非网格物体上设置的Virtools组数据尽管会被Blender承认和存储,但不会在导出时保存到Virtools文件中。
|
||||
|
||||
## Virtools材质
|
||||
|
||||
插件为每一个Blender材质添加了新的属性,被称为Virtools Material。它在Virtools材质与Blender材质之间架起沟通的桥梁。转到`Material`属性面板,选择一个材质,即可以找到`Virtools Material`面板。
|
||||
@ -57,3 +59,11 @@ BBP插件为所有Blender网格添加了新的属性,称为Virtools Mesh。转
|
||||
![](../imgs/virtools-mesh.png)
|
||||
|
||||
Virtools网格目前只是作为兼容来使用的。其只有Lit Mode一个属性可以设置。多数早期地图由于不知道如何正确设置材质,导致路面发黑,所以经常将Lit Mode设置为Prelit以让路面正常显示。此属性是为了兼容这种设计而存在的,用户通常无需设置此选项。
|
||||
|
||||
## Virtools灯光
|
||||
|
||||
BBP插件为所有Blender灯光添加了新的属性,称为Virtools Light。转到`Data`属性面板,即可以找到`Virtools Light`面板。
|
||||
|
||||
![](../imgs/virtools-light.png)
|
||||
|
||||
与Virtools材质类似,Virtools的灯光系统与Blender的灯光系统差距较大,Virtools灯光相当于一个桥梁,它可以准确地反映Virtools的设置,使得其可以完美地存储于Blender文件中,并在导入导出时提供必要的数据。同时该面板并提供一个应用按钮,用以将Virtools灯光设置应用到Blender灯光中。
|
||||
|
9
docs/docs/zh-cn/zzq-features.md
Normal file
9
docs/docs/zh-cn/zzq-features.md
Normal file
@ -0,0 +1,9 @@
|
||||
# ZZQ功能
|
||||
|
||||
本插件在制作过程中得到了来自ZZQ的许多建议,这些建议所产生的功能比较杂乱,因此在一个单独的页面中一起描述。
|
||||
|
||||
## 窥视并转换为网格
|
||||
|
||||
窥视并转换为网格,其全称为:窥视并复制曲线倒角物体的Virtools归组信息后再转换为网格。你可以选中一些物体后右键,在物体上下文菜单中找到这一功能。
|
||||
|
||||
该功能正如其名,其将选中的物体转换为网格,如果选中的物体是曲线,且设置了倒角物体,则将倒角物体的归组信息赋予当前曲线(覆盖曲线当前归组设置)。如果选中的物体不是曲线,或者是曲线但没有倒角物体,那么该功能与执行转换为网格无异。该功能在放样建模时极为有用,因为只需要为截面物体进行正确的归组,然后再使用此功能将曲线转换为网格,就可以确保放样后的物体归组正确。
|
@ -20,6 +20,7 @@ nav:
|
||||
- 'Add Floor': 'en/bme-adder.md'
|
||||
- 'Add Rail': 'en/rail-adder.md'
|
||||
- 'Add Component': 'en/component-adder.md'
|
||||
- 'ZZQ Features': 'en/zzq-features.md'
|
||||
- 'Compile and Distribute Plugin': 'en/compile-distribute-plugin.md'
|
||||
- 'Report Issue': 'en/report-bugs.md'
|
||||
- 'Technical Information': 'en/tech-infos.md'
|
||||
@ -37,6 +38,7 @@ nav:
|
||||
- '添加路面': 'zh-cn/bme-adder.md'
|
||||
- '添加钢轨': 'zh-cn/rail-adder.md'
|
||||
- '添加机关': 'zh-cn/component-adder.md'
|
||||
- 'ZZQ功能': 'zh-cn/zzq-features.md'
|
||||
- '编译与分发插件': 'zh-cn/compile-distribute-plugin.md'
|
||||
- '报告问题': 'zh-cn/report-bugs.md'
|
||||
- '技术信息': 'zh-cn/tech-infos.md'
|
||||
|
Loading…
Reference in New Issue
Block a user