expose lit mode interface in CKMesh.

- provide lit mode and wrap mode getter and setter in CKMesh. - add lost flags setter in CKMesh. - show lit mode and wrap mode data in Unvirt. - add interface for lit mode in BMap, because some old Ballance map use lit mode to light objects. - expose a raw c callback when creating bmap to allow user decide how the log output by themselves. - change python bindings for BMap interface changes.
2023-11-15 21:47:58 +08:00
parent c55e334ead
commit d8b7ace53d
14 changed files with 173 additions and 8 deletions
--- a/BMapBindings/PyBMap/PyBMap/bmap.py
+++ b/BMapBindings/PyBMap/PyBMap/bmap.py
@ -32,6 +32,8 @@ bm_bool_p = ctypes.POINTER(bm_bool)
 bm_void_p = ctypes.c_void_p
 bm_void_pp = ctypes.POINTER(ctypes.c_void_p)

+bm_callback = ctypes.CFUNCTYPE(None, bm_CKSTRING)
+
 class bm_VxVector2(ctypes.Structure):
    _fields_ = [
        ('x', bm_CKFLOAT),
@ -104,19 +106,21 @@ BMDispose = _create_bmap_func('BMDispose', [])
 #  @param file_name[in] Type: LibCmo::CKSTRING. 
 #  @param temp_folder[in] Type: LibCmo::CKSTRING. 
 #  @param texture_folder[in] Type: LibCmo::CKSTRING. 
+#  @param raw_callback[in] Type: BMap::NakedOutputCallback. 
 #  @param encoding_count[in] Type: LibCmo::CKDWORD. 
 #  @param encodings[in] Type: LibCmo::CKSTRING*. 
 #  @param out_file[out] Type: BMap::BMFile*. Use ctypes.byref(data) pass it. 
 #  @return True if no error, otherwise False.
-BMFile_Load = _create_bmap_func('BMFile_Load', [bm_CKSTRING, bm_CKSTRING, bm_CKSTRING, bm_CKDWORD, bm_CKSTRING_p, bm_void_pp])
+BMFile_Load = _create_bmap_func('BMFile_Load', [bm_CKSTRING, bm_CKSTRING, bm_CKSTRING, bm_callback, bm_CKDWORD, bm_CKSTRING_p, bm_void_pp])
 ## BMFile_Create
 #  @param temp_folder[in] Type: LibCmo::CKSTRING. 
 #  @param texture_folder[in] Type: LibCmo::CKSTRING. 
+#  @param raw_callback[in] Type: BMap::NakedOutputCallback. 
 #  @param encoding_count[in] Type: LibCmo::CKDWORD. 
 #  @param encodings[in] Type: LibCmo::CKSTRING*. 
 #  @param out_file[out] Type: BMap::BMFile*. Use ctypes.byref(data) pass it. 
 #  @return True if no error, otherwise False.
-BMFile_Create = _create_bmap_func('BMFile_Create', [bm_CKSTRING, bm_CKSTRING, bm_CKDWORD, bm_CKSTRING_p, bm_void_pp])
+BMFile_Create = _create_bmap_func('BMFile_Create', [bm_CKSTRING, bm_CKSTRING, bm_callback, bm_CKDWORD, bm_CKSTRING_p, bm_void_pp])
 ## BMFile_Save
 #  @param map_file[in] Type: BMap::BMFile*. 
 #  @param file_name[in] Type: LibCmo::CKSTRING. 
@ -635,6 +639,18 @@ BMMaterial_GetZFunc = _create_bmap_func('BMMaterial_GetZFunc', [bm_void_p, bm_CK
 #  @param val[in] Type: LibCmo::VxMath::VXCMPFUNC. 
 #  @return True if no error, otherwise False.
 BMMaterial_SetZFunc = _create_bmap_func('BMMaterial_SetZFunc', [bm_void_p, bm_CKID, bm_enum])
+## BMMesh_GetLitMode
+#  @param bmfile[in] Type: BMap::BMFile*. The pointer to corresponding BMFile.
+#  @param objid[in] Type: LibCmo::CK2::CK_ID. The CKID of object you accessing.
+#  @param out_mode[out] Type: LibCmo::VxMath::VXMESH_LITMODE. Use ctypes.byref(data) pass it. 
+#  @return True if no error, otherwise False.
+BMMesh_GetLitMode = _create_bmap_func('BMMesh_GetLitMode', [bm_void_p, bm_CKID, bm_enum_p])
+## BMMesh_SetLitMode
+#  @param bmfile[in] Type: BMap::BMFile*. The pointer to corresponding BMFile.
+#  @param objid[in] Type: LibCmo::CK2::CK_ID. The CKID of object you accessing.
+#  @param mode[in] Type: LibCmo::VxMath::VXMESH_LITMODE. 
+#  @return True if no error, otherwise False.
+BMMesh_SetLitMode = _create_bmap_func('BMMesh_SetLitMode', [bm_void_p, bm_CKID, bm_enum])
 ## BMMesh_GetVertexCount
 #  @param bmfile[in] Type: BMap::BMFile*. The pointer to corresponding BMFile.
 #  @param objid[in] Type: LibCmo::CK2::CK_ID. The CKID of object you accessing.
--- a/BMapBindings/PyBMap/PyBMap/bmap_wrapper.py
+++ b/BMapBindings/PyBMap/PyBMap/bmap_wrapper.py
@ -7,6 +7,17 @@ g_InvalidPtr: bmap.bm_void_p = bmap.bm_void_p(0)
 g_InvalidCKID: int = 0
 g_BMapEncoding: str = "utf-8"

+def python_callback(strl: bytes):
+    """
+    The Python type callback for BMFile.
+    Simply add a prefix when output.
+    Need a convertion before passing to BMFile.
+    """
+    # the passing value is bytes, not bmap.bm_CKSTRING.
+    # i think Python do a auto convertion here.
+    if strl is not None:
+        print(f'[PyBMap] {strl.decode(g_BMapEncoding)}')
+
 class _AbstractPointer():
    __mRawPointer: int

@ -398,6 +409,16 @@ class BMMaterial(BMObject):
        bmap.BMMaterial_SetZFunc(self._get_pointer(), self._get_ckid(), data)

 class BMMesh(BMObject):
+
+    def get_lit_mode(self) -> virtools_types.VXMESH_LITMODE:
+        mode: bmap.bm_enum = bmap.bm_enum()
+        bmap.BMMesh_GetLitMode(self._get_pointer(), self._get_ckid(), ctypes.byref(mode))
+        return virtools_types.VXMESH_LITMODE(mode.value)
+    
+    def set_lit_mode(self, mode: virtools_types.VXMESH_LITMODE) -> None:
+        mode: bmap.bm_enum = bmap.bm_enum(mode.value)
+        bmap.BMMesh_SetLitMode(self._get_pointer(), self._get_ckid(), mode)
+
    def get_vertex_count(self) -> int:
        count: bmap.bm_CKDWORD = bmap.bm_CKDWORD()
        bmap.BMMesh_GetVertexCount(self._get_pointer(), self._get_ckid(), ctypes.byref(count))
@ -569,6 +590,7 @@ class BMFileReader(_AbstractPointer):
        file_name: bmap.bm_CKSTRING = bmap.bm_CKSTRING(file_name_.encode(g_BMapEncoding))
        temp_folder: bmap.bm_CKSTRING = bmap.bm_CKSTRING(temp_folder_.encode(g_BMapEncoding))
        texture_folder: bmap.bm_CKSTRING = bmap.bm_CKSTRING(texture_folder_.encode(g_BMapEncoding))
+        raw_callback: bmap.bm_callback = bmap.bm_callback(python_callback)
        encoding_count: bmap.bm_CKDWORD = bmap.bm_CKDWORD(len(encodings_))
        encodings: ctypes.Array = (bmap.bm_CKSTRING * len(encodings_))(
            *(strl.encode(g_BMapEncoding) for strl in encodings_)
@ -576,7 +598,8 @@ class BMFileReader(_AbstractPointer):
        out_file: bmap.bm_void_p = bmap.bm_void_p()
        # exec
        bmap.BMFile_Load(
-            file_name, temp_folder, texture_folder, encoding_count, encodings,
+            file_name, temp_folder, texture_folder, raw_callback,
+            encoding_count, encodings,
            ctypes.byref(out_file)
        )
        # init self
@ -666,6 +689,7 @@ class BMFileWriter(_AbstractPointer):
        # create param
        temp_folder: bmap.bm_CKSTRING = bmap.bm_CKSTRING(temp_folder_.encode(g_BMapEncoding))
        texture_folder: bmap.bm_CKSTRING = bmap.bm_CKSTRING(texture_folder_.encode(g_BMapEncoding))
+        raw_callback: bmap.bm_callback = bmap.bm_callback(python_callback)
        encoding_count: bmap.bm_CKDWORD = bmap.bm_CKDWORD(len(encodings_))
        encodings: ctypes.Array = (bmap.bm_CKSTRING * len(encodings_))(
            *(strl.encode(g_BMapEncoding) for strl in encodings_)
@ -673,7 +697,8 @@ class BMFileWriter(_AbstractPointer):
        out_file: bmap.bm_void_p = bmap.bm_void_p()
        # exec
        bmap.BMFile_Create(
-            temp_folder, texture_folder, encoding_count, encodings,
+            temp_folder, texture_folder, raw_callback,
+            encoding_count, encodings,
            ctypes.byref(out_file)
        )
        # init self
--- a/BMapBindings/PyBMap/PyBMap/virtools_types.py
+++ b/BMapBindings/PyBMap/PyBMap/virtools_types.py
@ -304,3 +304,15 @@ class VXCMPFUNC(enum.IntEnum):
    VXCMP_NOTEQUAL = 6  ##< Accept if value if different than current value.
    VXCMP_GREATEREQUAL = 7  ##< Accept if value if greater or equal current value.
    VXCMP_ALWAYS = 8  ##< Always accept the test.
+    
+class VXMESH_LITMODE(enum.IntEnum):
+    """!
+    {filename:VXMESH_LITMODE}
+    Summary: Mesh lighting options
+    
+    Remarks:
+    + The VXMESH_LITMODE is used by CKMesh::SetLitMode to specify how lighting is done.
+    See Also: CKMaterial,CKMesh
+    """
+    VX_PRELITMESH = 0    ##< Lighting use color information store with vertices 
+    VX_LITMESH = 1    ##< Lighting is done by renderer using normals and face material information.