Files
EVEngine/docs/usr/modules/model3d.md
T
西风逍遥游 cc576c264a feat(model3d): material/texture API + auto-assembly renderer
ModelData gains material accessors (base color, metallic/roughness, opacity, two-sided), texture queries by type name (base_color/diffuse/normals/height/...), and embedded texture decode to RGBA8 ImageData. New model3d::buildRenderable(s) helpers assemble Renderable3D from a decoded model (node transform baked, material/PBR/textures applied), bound to Squirrel as Model3D::createRenderable.

Normals for assets missing authored normals now default to smooth generation: CMake applies an idempotent configure-time patch to medialoader switching aiProcess_GenNormals -> aiProcess_GenSmoothNormals.
2026-08-19 04:12:54 +08:00

4.2 KiB
Raw Blame History

3D 模型模块

脚本入口: eve.Model3D()

通过 medialoader/Assimp 载入模型数据,再交给图形模块渲染。

基本用法

local models = eve.Model3D();
local mesh = models.newModelDataFromFile("models/hero.glb");

读取材质并装配渲染对象

ModelData 可以直接读取材质参数(base color、metallic/roughness、贴图路径与内嵌贴图), 然后交给 createRenderable 一键装配成可渲染的 Renderable3D:

local models = eve.Model3D();
local md = models.newModelDataFromFile("models/hero.glb");

// 材质查询(texture 类型名:base_color / diffuse / normals / height / emissive / ...)
local mi = md.getMaterialIndex(0);               // mesh 0 使用的材质槽
local r = md.getMaterialBaseColorR(mi);          // 基色(glTF BASE_COLOR,OBJ 回退 DIFFUSE)
local metallic = md.getMaterialMetallicFactor(mi);
local roughness = md.getMaterialRoughnessFactor(mi);
local path = md.getMaterialTexturePath(mi, "base_color");  // 外部路径或 "*N"(内嵌)

// 装配:节点变换烘焙进顶点,材质/贴图自动应用
local renderable = models.createRenderable(gfx, md, 0);

内嵌贴图(glTF/FBX 内嵌 PNG/JPEG)用 getEmbeddedTextureCount() 查询, getEmbeddedTextureImageData(idx) 解码为 ImageData(调用方负责释放)。

对象关系与调用时机

Model3D 只负责加载 ModelData;ModelData 包含 mesh/material 数据和统计信息。GPU mesh、材质实例、摄像机与实际 draw 属于 Graphics。

目标导向指南

载入并检查模型

用 newModelDataFromFile(path) 载入 glTF/FBX/OBJ 等支持格式;先读取 mesh/material/face/vertex 数量并检查法线、UV,失败时显示占位模型。资源应在初始化或加载阶段创建。

提交模型渲染

将 ModelData 转换为 Graphics 所需 mesh/renderable,设置材质、变换和光照标志,再在渲染阶段调用 3D 渲染入口。模型数据可复用,实例只保存不同变换。

常见问题

  • 在 render 中载入模型:I/O 和解析必须在加载阶段。
  • 模型无 normals 仍启用光照:先检查 hasNormals()。
  • 每个实例重复加载同一文件:共享 ModelData 和 GPU 资源。

API 快查

下列方法名来自当前 Squirrel 绑定;同一模块创建的辅助对象(例如 World、Body、Source)的方法也列在这里。

  • empty()、getFaceCount()、getMaterialCount()、getMeshCount()、getName()、getVertexCount()、hasNormals()、hasTexCoords()
  • 材质:getMaterialIndex()、getMaterialName()、getMaterialBaseColorR/G/B/A()、getMaterialMetallicFactor()、getMaterialRoughnessFactor()、getMaterialOpacity()、getMaterialTwoSided()、getMaterialTextureSlotCount()、getMaterialTexturePath()、getMaterialTextureEmbeddedIndex()
  • 内嵌贴图:getEmbeddedTextureCount()、getEmbeddedTextureName()、getEmbeddedTextureWidth()、getEmbeddedTextureHeight()、getEmbeddedTextureImageData()
  • 蒙皮:hasBones()、getBoneCount()、getBoneName()、getInverseBindMatrixElement()、getBoneWeightCount()、getBoneWeightVertex()、getBoneWeightValue()
  • 动画剪辑:getAnimationCount()、getAnimationName()
  • newModelData()、newModelDataFromFile()、createRenderable()

createRenderable(gfx, modelData, meshIndex) 内部等价于 C++ 的 model3d::buildRenderable(节点世界变换烘焙进顶点,材质 tint / metallic / roughness 与 albedo、normal、height 贴图自动应用,内嵌/外部贴图均可解析)。

注意:Squirrel 绑定按完整参数个数校验,getMaterialTexturePath / getMaterialTextureEmbeddedIndex 需要显式传 slot(默认 0)。

使用要点

  • 模块对象和它创建的资源对象应保存在全局或实体状态中,不要在每帧重复创建。
  • 带 update(dt) 的系统应在 eve_update 调用;绘制方法应在 eve_render 调用。
  • 参数约束、默认值和返回类型以对应模块头文件及 addFunc 绑定为准;本文 API 快查与当前源码同步生成。

源码: src/modules/model3d/ 相关测试: 在 test/ 中搜索 model3d。