增加 Primitive 特性

[cloudwu]

今天我增加了一个预制几何体的特性，取代之前在 ant.entity|entity 中的 api 。见 #166

之前的

world:create_entity {
	policy = {
		"ant.render|simplerender",
	},
	data = {
		scene 		= {
			s = {250, 1, 250},
		},
		material 	= "/pkg/ant.resources/materials/mesh_shadow.material",
		visible     = true,
		mesh_result        = ientity.plane_mesh(),
	}
}

就可以写成

world:create_entity {
	policy = {
		"ant.render|render",
	},
	data = {
		scene 		= {
			s = {250, 1, 250},
		},
		material 	= "/pkg/ant.resources/materials/mesh_shadow.material",
		visible     = true,
		mesh        = "plane.primitive",
	}
}

这里的 mesh 之前是填写 vfs 路径。目前 .primitive 后缀被扩展为调用一段代码生成 mesh 。可以传参数，参数编码在字符串中。比如箭头可以写成 ""arrow(0.3).primitive" 。

我希望未来支持更多的几何体，比如立方体、球、等等。有没有人愿意做这个事情？可以直接提 pr 。

[constly]

过两天放假我来尝试加下~

[cloudwu]

球面网格建议用 Icosphere ，即用 20 面体逼近。算法参考：

• https://danielsieger.com/blog/2021/03/27/generating-spheres.html
• https://blog.codingnow.com/2021/10/cube_sphere.html

生成函数应提供一个参数即大致的总三角形数，再由总面数换算成 Icosphere 算法参数（这样的接口参数方便换成其它生成算法）。

如果是圆柱体，也使用总三角形数做参数，换算成底面的圆的分段数。

[cloudwu]

分支已合并，可以直接对 master 提 pr 。

[constly]

以前我还想过戴森球那个球形地图是怎么做的，这次正好借这个机会尝试一翻~

[cloudwu]

戴森球用的 uvsphere ，这会导致赤道到两级不均匀。我认为，如果是逻辑上给球面规划网格，像戴森球那样摆机器铺传送带的话，用 cube sphere 最好（我记得无人深空就是这么干的）。戴森球我玩的时候真的是逼死强迫症。

但这里是为了让球面的三角形更均匀，所以建议用 icosphere 。

[constly]

这个 "arrow(0.3).primitive" 怎么使用呢，我这样使用：

world:create_entity {
	policy = {
		"ant.render|render",
	},
	data = {
		scene 		= {
			s = {1, 1, 1},	-- 缩放
			t = {0, 1, 0},	-- 位置
		},
		material 	= "/pkg/ant.resources/materials/mesh_shadow.material",
		visible     = true,
		mesh        = "arrow(0.3).primitive",
	}
}

会报错:

[2024-06-07 12:38:53.49][ERROR]( ant.window|window ) Layout: a_texcoord0, is not declared or not equal to varyings defined
stack traceback:
        ( service:6 )
        G:/ant/ant/pkg/ant.render/render_system/render_system.lua:199: in upvalue 'check_varyings'
        G:/ant/ant/pkg/ant.render/render_system/render_system.lua:216: in local 'f'
        G:/ant/ant/pkg/ant.world/main.lua:476: in field '_pipeline_entity_init'
        G:/ant/ant/pkg/ant.world/main.lua:61: in method '_flush_entity_queue'
        G:/ant/ant/pkg/ant.world/entity_system.lua:63: in local 'func'
        G:/ant/ant/pkg/ant.world/main.lua:379: in upvalue 'update_func'
        G:/ant/ant/pkg/ant.world/main.lua:404: in field '_pipeline_update'
        G:/ant/ant/pkg/ant.world/main.lua:588: in method 'pipeline_update'
        G:/ant/ant/pkg/ant.window/service/window.lua:76: in upvalue 'f'

[cloudwu]

arrow 只支持颜色，不能绑贴图。这里还需要统一一下。我只是随手翻译了原来 ant.entity 的代码。

https://github.com/ejoy/ant/blob/master/test/features/pkg/ant.test.features/test/shadow_test.lua#L122

[constly]

我目前还在尝试绘制cube，有一些基础问题想请教下：

1. 在使用"plane.primitive"时，如何在material中指定其贴图，以及如何在运行时修改贴图呢

2. 在绘制cube时，如果cube也要支持贴图，我能用“Triangle Strip”方式绘制吗（由于我还没搞明白怎么设置贴图，所以无法测试）。但如果用Strip方式，我发现必须得在material中指定 PT: TRISTRIP ，这可能与其他primitive的材质参数不一样，用Triangle List的方式应该更通用一些。总之我现在不太清楚应该用Triangle List，还是用Triangle Strip来绘制cube。这两种方式的区别在于我传的ibdata不一样，Strip方式传的数据要少一些。

[cloudwu]

指定贴图的问题：

首先需要定义一个有贴图的材质，我暂时没在引擎 ant.resources下找到合适的已经定义好的材质适合 primitive 用。试了 text_plane.material 和 texquad.material 都画不出来，这个需要 @junjie020 确认一下为啥？接下来是不是应该在 ant.resources 下增加一个专门绘制 primitive 的材质比较好？

所以，我稍微改了一下 mesh_shadow.material 这个文件，增加了贴图属性 s_basecolor：

fx:
  shader_type: PBR
  setting:
    lighting: on
    cast_shadow: off
    receive_shadow: on
  varyings:
    a_position: vec3
    a_normal: vec3
    a_texcoord0: vec2
    v_texcoord0: vec2
    v_posWS: "vec3 TEXCOORD1"
    v_normal: "vec3 TEXCOORD2"
properties:
  s_basecolor:
    stage: 0
    texture: /pkg/ant.resources/textures/black.texture  # 默认贴图
  u_pbr_factor: {0.2, 0.8, 0, 1}  #metallic, roughness, alpha_cutoff, occlusion strength
  u_emissive_factor: {0, 0, 0, 0}
  u_basecolor_factor: {0.8, 0.8, 0.8, 1.0}
state:
  ALPHA_REF: 0
  CULL: CCW
  DEPTH_TEST: GREATER
  MSAA: true
  WRITE_MASK: RGBAZ

然后就可以这样用了：

world:create_entity {
	policy = {
		"ant.render|render",
	},
	data = {
		scene 	= { s = {10, 1, 10}  },
		material 	= "/asset/plane.material",   -- 上面这个材质
		visible     = true,
		mesh        = "plane.primitive",
		on_ready = function (e)
			-- 更换默认贴图
			local tex = assetmgr.resource "/pkg/ant.resources/textures/color_text.texture"
			imaterial.set_property(e, "s_basecolor", tex.id)
		end,
	},
}

我觉得 primitive 应该使用 Triangle List ，因为像 cube 这样的六面体，六个面可能不应该共用顶点。因为不同面虽然空间上共用了顶点，但这些顶点在不同面上的法向量是不同的 。cube 的数据可以参考 bgfx 的例子：https://github.com/bkaradzic/bgfx/blob/master/examples/21-deferred/deferred.cpp#L91-L117

[constly]

非常感谢，我等会试试！

[constly]

接下来是不是应该在 ant.resources 下增加一个专门绘制 primitive 的材质比较好？

我觉得可能得考虑多种情况，比如应该有这样一个材质：在绘制纯色的primitive的对象时，边缘处应该有明显的明暗变化。
下图我使用的meshcolor.material，就看起来不对劲。

[cloudwu]

meshcolor 绘制的是纯色，而且也没有配置法向量：

fs_code: "void CUSTOM_FS(Varyings varyings, out FSOutput fsoutput){ fsoutput.color = u_color; }"

fs 直接输出了 u_color ，没有经过任何光照计算。

你可以直接用 mesh_shadow.material ，它是标准的 pbr 材质。其中 u_basecolor_factor 可以用来叠加颜色。

imaterial.set_property(e, "u_basecolor_factor", math3d.vector( 1,0,0,1 )) -- 设置成红色

[cloudwu]

如果你想先用 prefab 测试，可以试试：

world:create_instance {
	prefab = "/pkg/ant.resources.binary/meshes/base/cube.glb/mesh.prefab",
	on_ready = function (e)
		local entity<close> = world:entity(e.tag.Cube[1])
		imaterial.set_property(entity, "u_basecolor_factor", math3d.vector( 1,0,0,1 )) -- 红色
	end
}

[constly]

我发现我用代码创建的cube mesh 与 cube.glb 这种有点不一样，我估计是我设置的顶点法向量不对。我先把球绘制出来再看这些问题~

[cloudwu]

它们用的 shader 不同。我刚才也试了一下程序填一个 cube 的数据，渲染出来暗面偏黑，看起来没有受环境光的影响。这个需要 @junjie020 确认一下。

[constly]

我暂时绘制了一版球，以下三角面数依次是20/80/320/1480，使用的Icosphere算法

为了让球的阴影表现正确，我是不是应该给每个面指定法向量呢？我目前暂时只知道可以给顶点指定法向量，像这样：

local vb = {
	-0.5, 	0.5, 	0.5, 	0, 1, 0,	--left top
	0.5, 	0.5, 	0.5, 	0, 1, 0,	--right top
	-0.5, 	-0.5, 	0.5, 	0, 1, 0,	--left bottom
	0.5, 	-0.5, 	0.5, 	0, 1, 0,	--right bottom
}
vb = {
	start = 0,
	num = numv,
	declname = "p3|n3",
	handle = bgfx.create_vertex_buffer(vb, layout.handle),
}

#169 (reply in thread)
上面这里是如何指定cube的法向量的呢

[cloudwu]

阴影和法线无关，阴影需要在创建 entity 时加上 cast_shadow = true 。（写在 visible = true 下面即可）

法线决定了光照。球和 cube 不一样，球的面不可以把同个顶点分成多份。cube 要分开是因为：cube 需要棱角分明，每个面的法线是独立的。这里要填的是顶点的法向量，每个面的四个顶点的法向量就是面的法向量。球是反过来，需要光滑，所以当几个面共一个顶点时，这个顶点时法向量是唯一的，不是所在面的法向量（理论上，每个点所在的是一个无限小的面）。

球面顶点的法线非常容易计算：如果球心是坐标原点，半径为 1 ，那么法向量就等于它的空间位置。因为那正好就是法向量，且正好归一化了。

[cloudwu]

我先提交了一个 cube 的 primitive 供参考 90aca3c

不过材质的光照看起来有点问题，没有受环境光影响，导致暗面是纯黑的。这个等 @junjie020 看。不过我觉得数据是对的。

btw, primitive 这个模块还需要进一步整理。比如把不同的几何体分开到不同文件中。我觉得应该专门定义一个材质加到引擎里用，不必支持贴图（也就不需要构造纹理 uv ），但可以支持更好支持颜色及 PBR 的其它参数。

[constly]

OK，回复得实在太详细了，点赞！我晚上试试~

[cloudwu]

primitive 光照不正常的问题已初步定位。是因为：

https://github.com/ejoy/ant/blob/master/pkg/ant.render/ibl/ibl.lua#L325

idl 是在 entity_ready 阶段初始化。但 texture 加载是异步的。如果没有新的 entity 加载，这个 stage 就不会被调用。这样，就无法处理 ibl 贴图加载完毕的代码。

这里有点设计问题，需要再考虑一下如何修正。

[cloudwu]

现在已经正常了。

[constly]

我这里球的表现也正常了