update naming

bbp_ng/PROP_preferences.py

@@ -1,13 +1,20 @@
 import bpy
-import os
+import os, typing
+from . import UTIL_naming_convension
 
 class RawPreferences():
+    cBallanceTextureFolder: typing.ClassVar[str] = ""
+    cNoComponentCollection: typing.ClassVar[str] = ""
+    cDefaultNamingConvention: typing.ClassVar[int] = UTIL_naming_convension._EnumPropHelper.get_default_naming_identifier()
+
     mBallanceTextureFolder: str
     mNoComponentCollection: str
+    mDefaultNamingConvention: int
 
     def __init__(self, **kwargs):
         self.mBallanceTextureFolder = kwargs.get("mBallanceTextureFolder", "")
         self.mNoComponentCollection = kwargs.get("mNoComponentCollection", "")
+        self.mDefaultNamingConvention = kwargs.get('mDefaultNamingConvention', UTIL_naming_convension._EnumPropHelper.get_default_naming_identifier())
 
     def has_valid_blc_tex_folder(self) -> bool:
         return os.path.isdir(self.mBallanceTextureFolder)
@@ -18,12 +25,21 @@ class BBPPreferences(bpy.types.AddonPreferences):
     ballance_texture_folder: bpy.props.StringProperty(
         name = "Ballance Texture Folder",
         description = "The path to folder which will be used by this plugin to get external Ballance texture.",
-        subtype='DIR_PATH'
+        subtype='DIR_PATH',
+        default = RawPreferences.cBallanceTextureFolder,
     )
     
     no_component_collection: bpy.props.StringProperty(
         name = "No Component Collection",
         description = "(Import) The object which stored in this collectiion will not be saved as component. (Export) All forced no component objects will be stored in this collection",
+        default = RawPreferences.cNoComponentCollection,
+    )
+
+    default_naming_convention: bpy.props.EnumProperty(
+        name = "Default Naming Convention",
+        description = "The default naming convention when creating objects, import and export BM files.",
+        items = UTIL_naming_convension._EnumPropHelper.generate_items(),
+        default = UTIL_naming_convension._EnumPropHelper.to_selection(RawPreferences.cDefaultNamingConvention),
     )
     
     def draw(self, context):
@@ -35,6 +51,8 @@ class BBPPreferences(bpy.types.AddonPreferences):
         col.prop(self, "ballance_texture_folder", text = "")
         col.label(text = "No Component Collection")
         col.prop(self, "no_component_collection", text = "")
+        col.label(text = "Default Naming Convention")
+        col.prop(self, "default_naming_convention", text = "")
 
 def get_preferences() -> BBPPreferences:
     return bpy.context.preferences.addons[__package__].preferences
@@ -45,6 +63,7 @@ def get_raw_preferences() -> RawPreferences:
 
     rawdata.mBallanceTextureFolder = pref.ballance_texture_folder
     rawdata.mNoComponentCollection = pref.no_component_collection
+    rawdata.mDefaultNamingConvention = UTIL_naming_convension._EnumPropHelper.get_selection(pref.default_naming_convention)
 
     return rawdata
 

bbp_ng/UTIL_naming_convension.py

@@ -70,7 +70,7 @@ class _RenameErrorReporter():
 
 #region Naming Convention Used Types
 
-class _BallanceObjectType(enum.IntEnum):
+class BallanceObjectType(enum.IntEnum):
     COMPONENT = enum.auto()
 
     FLOOR = enum.auto()
@@ -88,8 +88,8 @@ class _BallanceObjectType(enum.IntEnum):
 
     DECORATION = enum.auto()
 
-class _BallanceObjectInfo():
+class BallanceObjectInfo():
-    mBasicType: _BallanceObjectType
+    mBasicType: BallanceObjectType
 
     ## Only available for COMPONENT basic type
     mComponentType: str | None
@@ -99,36 +99,36 @@ class _BallanceObjectInfo():
     #  In CHECKPOINT, RESETPOINT mode, the sector actually is the suffix number of these objects' name. So checkpoint starts with 1, not 0.
     mSector: int | None
 
-    def __init__(self, basic_type: _BallanceObjectType):
+    def __init__(self, basic_type: BallanceObjectType):
         self.mBasicType = basic_type
 
     @classmethod
     def create_from_component(cls, comp_type: str, sector: int):
-        inst = cls(_BallanceObjectType.COMPONENT)
+        inst = cls(BallanceObjectType.COMPONENT)
         inst.mComponentType = comp_type
         inst.mSector = sector
         return inst
     
     @classmethod
     def create_from_checkpoint(cls, sector: int):
-        inst = cls(_BallanceObjectType.CHECKPOINT)
+        inst = cls(BallanceObjectType.CHECKPOINT)
         inst.mSector = sector
         return inst
     @classmethod
     def create_from_resetpoint(cls, sector: int):
-        inst = cls(_BallanceObjectType.RESETPOINT)
+        inst = cls(BallanceObjectType.RESETPOINT)
         inst.mSector = sector
         return inst
 
     @classmethod
-    def create_from_others(cls, basic_type: _BallanceObjectType):
+    def create_from_others(cls, basic_type: BallanceObjectType):
         return cls(basic_type)
 
 class _NamingConventionProfile():
     _TNameFct = typing.Callable[[], str]
     _TDescFct = typing.Callable[[], str]
-    _TParseFct = typing.Callable[[bpy.types.Object, _RenameErrorReporter], _BallanceObjectInfo | None]
+    _TParseFct = typing.Callable[[bpy.types.Object, _RenameErrorReporter | None], BallanceObjectInfo | None]
-    _TSetFct = typing.Callable[[bpy.types.Object,_BallanceObjectInfo, _RenameErrorReporter], bool]
+    _TSetFct = typing.Callable[[bpy.types.Object,BallanceObjectInfo, _RenameErrorReporter | None], bool]
 
     mNameFct: _TNameFct
     mDescFct: _TDescFct
@@ -141,30 +141,17 @@ class _NamingConventionProfile():
         self.mParseFct = parse_fct
         self.mSetFct = set_fct
 
-    def __eq__(self, obj: object) -> bool:
-        if isinstance(obj, self.__class__):
-            if obj.mNameFct != self.mNameFct: return False
-            if obj.mDescFct != self.mDescFct: return False
-            if obj.mParseFct != self.mParseFct: return False
-            if obj.mSetFct != self.mSetFct: return False
-            return True
-        else:
-            return False
-
-    def __hash__(self) -> int:
-        return hash((self.mNameFct, self.mDescFct, self.mParseFct, self.mSetFct))
-
 #endregion
 
 #region Naming Convention Declaration
 
 class _VirtoolsGroupConvention():
     @staticmethod
-    def parse_from_object(obj: bpy.types.Object, reporter: _RenameErrorReporter) -> _BallanceObjectInfo | None:
+    def parse_from_object(obj: bpy.types.Object, reporter: _RenameErrorReporter | None) -> BallanceObjectInfo | None:
         return None
 
     @staticmethod
-    def set_to_object(obj: bpy.types.Object, info: _BallanceObjectInfo, reporter: _RenameErrorReporter) -> bool:
+    def set_to_object(obj: bpy.types.Object, info: BallanceObjectInfo, reporter: _RenameErrorReporter | None) -> bool:
         return False
 
     @staticmethod
@@ -178,11 +165,11 @@ class _VirtoolsGroupConvention():
 
 class _YYCToolchainConvention():
     @staticmethod
-    def parse_from_object(obj: bpy.types.Object, reporter: _RenameErrorReporter) -> _BallanceObjectInfo | None:
+    def parse_from_object(obj: bpy.types.Object, reporter: _RenameErrorReporter | None) -> BallanceObjectInfo | None:
         return None
 
     @staticmethod
-    def set_to_object(obj: bpy.types.Object, info: _BallanceObjectInfo, reporter: _RenameErrorReporter) -> bool:
+    def set_to_object(obj: bpy.types.Object, info: BallanceObjectInfo, reporter: _RenameErrorReporter | None) -> bool:
         return False
 
     @staticmethod
@@ -196,11 +183,11 @@ class _YYCToolchainConvention():
 
 class _ImengyuConvention():
     @staticmethod
-    def parse_from_object(obj: bpy.types.Object, reporter: _RenameErrorReporter) -> _BallanceObjectInfo | None:
+    def parse_from_object(obj: bpy.types.Object, reporter: _RenameErrorReporter | None) -> BallanceObjectInfo | None:
         return None
 
     @staticmethod
-    def set_to_object(obj: bpy.types.Object, info: _BallanceObjectInfo, reporter: _RenameErrorReporter) -> bool:
+    def set_to_object(obj: bpy.types.Object, info: BallanceObjectInfo, reporter: _RenameErrorReporter | None) -> bool:
         return False
 
     @staticmethod
@@ -216,20 +203,29 @@ class _ImengyuConvention():
 
 #region Nameing Convention Register
 
-## The native naming convention is 
-#  We treat it as naming convention because we want use a universal interface to process naming converting.
-#  So Virtools Group can no be seen as a naming convention, but we treat it like naming convention in code.
-#  The "native" mean this is 
-_g_NativeNamingConvention: _NamingConventionProfile = _VirtoolsGroupConvention.register()
-
 ## All available naming conventions
 #  Each naming convention should have a identifier for visiting them.
 #  The identifier is its index in this tuple.
-_g_NamingConventions: tuple[_NamingConventionProfile, ...] = (
+_g_NamingConventions: list[_NamingConventionProfile] = []
-    _VirtoolsGroupConvention.register(),
+def _register_naming_convention_with_index(profile: _NamingConventionProfile) -> int:
-    _YYCToolchainConvention.register(),
+    global _g_NamingConventions
-    _ImengyuConvention.register(),
+    ret: int = len(_g_NamingConventions)
-)
+    _g_NamingConventions.append(profile)
+    return ret
+
+# register native and default one and others
+# but only native one and default one need keep its index
+# 
+# The native naming convention is Virtools Group
+# We treat it as naming convention because we want use a universal interface to process naming converting.
+# So Virtools Group can no be seen as a naming convention, but we treat it like naming convention in code.
+# The "native" mean this is 
+# 
+# The default fallback naming convention is YYC toolchain
+# 
+_g_NativeNamingConventionIndex: int = _register_naming_convention_with_index(_VirtoolsGroupConvention.register())
+_g_DefaultNamingConventionIndex: int = _register_naming_convention_with_index(_YYCToolchainConvention.register())
+_register_naming_convention_with_index(_ImengyuConvention.register())
 
 class _EnumPropHelper():
     """
@@ -242,10 +238,9 @@ class _EnumPropHelper():
         # create a function to filter Virtools Group profile 
         # and return index at the same time
         def naming_convention_iter() -> typing.Iterator[tuple[int, _NamingConventionProfile]]:
-            for i in range(len(_g_NamingConventions)):
+            for idx, item in enumerate(_g_NamingConventions):
-                profile: _NamingConventionProfile = _g_NamingConventions[i]
+                if idx != _g_NativeNamingConventionIndex:
-                if profile != _g_NativeNamingConvention:
+                    yield (idx, item)
-                    yield (i, profile)
 
         # token, display name, descriptions, icon, index
         return tuple(
@@ -268,11 +263,21 @@ class _EnumPropHelper():
     
     @staticmethod
     def get_virtools_group_identifier() -> int:
-        return _g_NamingConventions.index(_g_NativeNamingConvention)
+        return _g_NativeNamingConventionIndex
+    
+    @staticmethod
+    def get_default_naming_identifier() -> int:
+        return _g_DefaultNamingConventionIndex
 
 #endregion
 
-def name_convention_core(src_ident: int, dst_ident: int, objs: typing.Iterable[bpy.types.Object]) -> None:
+def name_setter_core(ident: int, info: BallanceObjectInfo, obj: bpy.types.Object) -> None:
+    # get profile
+    profile: _NamingConventionProfile = _g_NamingConventions[ident]
+    # set name. don't care whether success.
+    profile.mSetFct(obj, info, None)
+
+def name_converting_core(src_ident: int, dst_ident: int, objs: typing.Iterable[bpy.types.Object]) -> None:
     # no convert needed
     if src_ident == dst_ident: return
 
@@ -298,7 +303,7 @@ def name_convention_core(src_ident: int, dst_ident: int, objs: typing.Iterable[b
         err_reporter.begin_object(obj)
         # parsing from src and set by dst
         # inc failed counter if failed
-        obj_info: _BallanceObjectInfo | None= src.mParseFct(obj, err_reporter)
+        obj_info: BallanceObjectInfo | None= src.mParseFct(obj, err_reporter)
         if obj_info is not None:
             ret: bool = dst.mSetFct(obj, obj_info, err_reporter)
             if not ret: failed_obj_counter += 1