22. examples和文档(辅助开发)
# 查询案例examples和文档(辅助开发)
有些时候你想了解threejs某个类(对象)的语法,或者某个对象属性和方法的语法,这时候你可以查询threejs官方文件包提供的案例examples、文档docs。
three.js-文件包
...
└───docs——Three.js API文档文件
│───index.html——打开该文件,本地离线方式预览threejs文档
└───examples——大量的3D案例,是你平时开发参考学习的最佳资源
│───.html——各种3D案例
...
# 案例examples
案例examples文件里面提供了很多3D案例,平时学习你可以参考里面的小案例去学习。
通过关键词全文检索案例examples,比如vscode代码编辑器,在左侧找到threejs文件包的examples目录,右键,点击在文件中查找,输入一个关键词就可以查找,比如输入类名gui、OrbitControls、.lookAt()...,通过关键字找到对应的.html文件,你就可以参考里面的代码了。
# 文档搜索
关于文档的使用,前面也说过,这里再给大家再给大家介绍更多文档使用技巧。
通过threejs中文网 (opens new window)(webgl3d.cn)分享一个文档链接,可以直接跳转到threejs官网提供的中文文档。
# 文档搜索API
文档左上角提供了一个输入框,可以快速查看某个API,如果你不记得完整名字,也可以通过threejs API部分名字查询。
# 搜索方法或属性
进入threejs API页面,有的类属性或方法比较多,滚动页面查询比较麻烦的话,如果你想查询某个方法或属性,可以Ctrl+F调用谷歌浏览器的当前网页关键字查询功能,找到特定的API的方法或属性,比如找到类PerspectiveCamera
,搜索该类的.fov、.aspect、.updateProjectionMatrix()等属性或方法。
# 【扩展】查看src目录下源码或者examples/jms目录下源码
如果你通过案例examples、文档docs还不能更加清晰的了解某个属性或方法的含义,可以查看threejs封装的源码,当然对于threejs新手或编程基础不好的学员,不太推荐。