超腾开源产品文档 | 了解我们的产品和服务

Shadow Editor Pro是一款基于Three.js的专业三维场景编辑器,采用Electron桌面应用架构。该文档介绍了其首个商业版本v0.0.1的核心信息。产品具备强大的3D编辑能力,支持创建、编辑和保存场景,并集成了丰富的功能模块,包括资源管理、灵活的材质系统、脚本编程、动画系统、物理引擎以及后期处理等。相比开源版本,Pro版在技术架构、渲染能力(支持WebGL2/WebGPU)、用户体验(如使用Monaco编辑器)和部署方式(无需额外数据库)上均有显著提升。它适用于建筑可视化、工业仿真、游戏开发、数据可视化等多种场景。文档提供了从快速入门、功能说明到高级应用的完整指南,并附有常见问题解答和技术支持途径。

相关文档

Shadow Editor Pro 快速入门
本文档详细介绍了 Shadow Editor Pro 3D编辑软件的安装与基础使用流程。首先说明了运行该软件所需的硬件与软件配置要求。随后提供了针对Windows用户的详细安装步骤,以及绿色版的使用方法。文档重点指导用户如何首次运行程序、检查环境,并通过创建一个包含旋转正方体的简单场景,逐步演示了添加几何体、调整视角、编写脚本、播放与保存场景等核心操作。此外,还汇总了基本的鼠标操作、键盘快捷键、视图切换和编辑模式,并简要说明了模型上传功能及常见问题解决方法。旨在帮助用户快速上手并完成第一个3D场景的创作。
Shadow Editor Pro 功能说明
本文档详细介绍了Shadow Editor Pro的核心功能与使用方法。主要内容包括资源管理、场景编辑、物体创建、材质编辑和脚本系统五大模块。资源管理涵盖场景、模型、贴图、材质、音频、动画、字体和截图的全流程操作,支持多种格式。场景编辑部分讲解了场景设置、物体编辑、撤销重做和控制器设置等基础编辑功能。物体创建介绍了内置几何体、文字、曲线、标注、帮助器和光源等丰富类型。材质编辑部分说明了各类材质特性及其属性调整。脚本系统基于Monaco编辑器,提供了JavaScript脚本编写框架和常用示例,支持通过代码实现交互与动态效果。该编辑器旨在为用户提供完整的3D场景创作与管理工具集。
Shadow Editor Pro 高级功能
本文档详细介绍了Shadow Editor Pro的高级功能,旨在帮助用户提升3D作品的创作水平。主要内容包括:后期处理系统,提供多种视觉效果(如残影、背景虚化、抗锯齿等)及其启用与组合方法;动画系统,支持补间、骨骼及MMD动画,并可通过脚本控制;物理引擎集成,可实现真实的碰撞与模拟;数据可视化功能,可将业务数据映射到3D模型,适用于智慧工厂等场景;虚拟现实(VR)支持,允许在VR设备中查看与交互;场景发布流程,可将作品导出为独立HTML应用并部署到Web服务器。此外,文档还涵盖了测量工具、录屏功能,并提供了性能优化建议与最佳实践,以指导用户高效组织场景、管理资源并优化工作流。
Shadow Editor Pro 常见问题
本文档汇总了Shadow Editor Pro使用过程中的常见问题及解决方案。主要涵盖安装运行、编辑保存、模型导入、性能优化、脚本动画及其他操作六大类问题。针对程序启动失败、场景保存异常、模型导入错误、渲染卡顿、脚本调试等具体问题,文档提供了详细的排查步骤和优化建议。同时推荐使用GLTF/GLB格式以获得最佳兼容性和性能,并给出了联系技术支持与进行多人协作的实用指导。文档旨在帮助用户快速定位并解决常见操作障碍,提升软件使用效率。
Shadow Editor Pro 附录
本文档详细介绍了Shadow Editor Pro的各项参考信息。主要内容包括:支持超过40种3D模型格式,其中GLTF/GLB为WebGL标准格式,推荐优先使用;支持多种贴图格式(如JPEG、PNG、HDR等)并提供了针对不同用途的格式选择建议;列出了完整的快捷键列表,涵盖文件操作、编辑、视图控制、工具切换等常用功能;提供了脚本API参考,包括全局对象、生命周期函数、事件处理及常用代码示例,方便用户通过JavaScript进行扩展和交互。此外,文档还包含了系统要求、更新日志和术语表等辅助信息。
本文档是Shadow Editor Pro的API参考手册,提供了完整的接口、数据类型和使用方法说明。文档明确了API的基础地址、版本、数据格式和字符编码等通用信息。所有请求遵循RESTful风格,响应采用统一的Result结构,并定义了BaseEntity和BaseFileEntity等通用数据实体。文档详细列出了前端架构、后端架构、3D资源管理、业务数据管理和公共接口等主要模块的目录结构。此外,还包含了错误代码对照表、系统支持的各种3D模型、贴图、音频、动画及字体文件格式,以及初始版本的功能概述。

相关文档

Shadow Editor Pro 前端架构文档
本文档详细介绍了Shadow Editor Pro前端代码的目录结构与各模块功能。项目基于Vue 3、TypeScript和Three.js构建,采用模块化设计。核心目录包括:api/封装所有服务端通信接口;command/实现命令模式以支持撤销/重做;components/提供可复用的Vue UI组件;controls/管理摄像机与视图控制;editor/作为编辑器核心,集成场景管理、资源面板、属性编辑等全套编辑功能;event/提供发布-订阅事件系统;helper/包含3D场景辅助工具;loader/支持超过40种3D模型格式的加载;object/负责3D对象的创建与管理;player/用于场景的播放与展示;render/处理渲染与后期效果;serialization/负责场景的序列化与反序列化;utils/提供各类工具函数。文档还概述了核心类(如Editor和Player)、事件系统、技术栈及开发规范,为开发者理解与扩展该3D编辑器前端代码提供了全面指导。
Shadow Editor Pro 后端架构文档
本文档详细介绍了Shadow Editor Pro后端代码的目录结构与核心模块功能。项目基于NestJS 10框架,使用TypeScript 5开发,运行于Node.js环境,采用文件存储作为数据库,并集成Electron作为桌面框架。文档系统阐述了Electron主进程、预加载脚本、NestJS服务启动及配置等核心文件的作用。重点说明了业务数据模块(data/)和3D资源模块(three/)的详细架构,包括各自的控制器、实体与服务层,用于管理设备、测量、场景、模型等多种数据的CRUD操作。此外,文档还涵盖了异常过滤器、拦截器、管道、工具函数等辅助模块,并明确了统一的API接口规范、文件存储方案、日志系统及安全性设计,为开发者提供了清晰的后端开发与维护指南。
Shadow Editor Pro 3D 资源接口
本文档详细介绍了3D内容管理系统的核心功能模块及其API接口。系统提供对3D场景的完整生命周期管理,包括创建、编辑、保存、加载、发布和导出等功能。同时,文档还涵盖了模型、材质、动画、音频、视频、贴图、字体、截图、缩略图和分类等各类资源的管理。每个模块均定义了标准的数据结构,并提供了对应的增删改查及上传API接口,例如获取列表、添加、更新、删除等操作。分类管理用于组织所有资源,摘要统计接口则提供全局资源概览。整体构成了一个功能全面、结构清晰的3D资源管理后端服务方案。
Shadow Editor Pro 业务数据接口
本文档介绍了一套用于数据可视化场景的业务数据接口,主要提供对设备、测量、属性、字典、站点等核心业务实体的管理功能。文档详细说明了每个模块的数据结构及其对应的增删改查API接口,包括设备管理、设备测量管理、测量管理、模型与设备/测量/属性的关联管理、属性管理、字典管理以及站点管理。所有接口均遵循统一的响应格式,支持逻辑删除,旨在为上层应用提供完整、标准化的数据操作服务,以支撑可视化系统的数据需求。
Shadow Editor Pro 公共接口
该产品文档详细介绍了公共API接口和Electron特定接口的功能与使用方法。公共接口主要涵盖文件访问、下载和上传三大基础功能,支持多种资源类型如模型、材质、动画、音频、视频、贴图、字体和截图等,并提供了具体的API路径、参数格式、支持的文件格式以及响应示例。Electron接口则为桌面应用提供了系统级功能,包括获取应用信息、打开系统对话框、获取应用路径、打开外部链接、窗口控制和全屏切换等。文档还明确了通用响应格式、错误代码、请求限制(包括文件大小和频率限制),并提供了JavaScript/TypeScript和cURL的调用示例,方便开发者集成和使用。