program.md

MineCursor项目编程指引

项目结构

• assets
  • default_themes 内置的指针主题
  • icons 对话框、菜单图标
  • sources 默认素材库
  • file_type_add.reg 注册指针主题文件类型
  • file_type_remove.reg 移除指针主题文件类型
  • icon.ico MineCursor图标 - ICO位图
  • icon.kra MineCursor图标 - Krita文档
  • icon.png MineCursor图标 - PNG位图
  • NULL.png 一个简单的NULL字样的图像
• lib
  • cursor
    • inst_ini_gen.py 鼠标主题自动安装脚本生成器
    • setter.py 定义鼠标类型枚举、用于设置系统指针
    • writer.py 用于写入指针文件(.cur/.ani)
  • datas
    • base_struct.py 定义公用数据结构
    • data_dir.py 管理数据存储文件夹的创建
    • project.py 定义数据结构 - 指针项目及其元素
    • source.py 定义素材库指示结构、管理素材库
    • theme.py 定义数据结构 - 指针项目及其元素
  • tools
    • gen_theme_preview.py 快速生成主题的动态透明预览视频
    • replace_source.py 快速迁移旧的素材库到新的素材库
  • clipboard.py 定义剪切板
  • config.py 管理工具的配置及其文件
  • data.py 导向datas文件夹里的各个脚本定义的结构
  • [dialog_fix.py(lib/dialog.py)] 提供一个简易的函数使Dialog在关闭时自动销毁
  • dpi.py 提供系统缩放检测与分辨率换算
  • image_pil2wx.py 提供从PIL.Image.Image转化到wx.Image的函数
  • info.py 定义项目信息（版本、更新日志）
  • log.py 日志库
  • perf.py 提供性能分析类
  • render.py 负责渲染鼠标指针项目
  • resources.py 主题管理器+带素材库的主题包的导入支持
  • round_corner.py PIL的圆角处理
  • source_cvt.py 从(zip/jar/文件夹)转成统一的素材库格式
  • t_struct.py 重定向至datas/base_struct.py
  • ui_interface.py 提供UI类与功能类的初始化重定向
• readme_assets README.md里用到的资源
• ui 各个组件的UI类
  • cursor_editor.py 项目编辑器
  • element_add_dialog.py 元素添加对话框
  • public_list_ctrl.py 公用列表框(主题选择器\项目列表)
  • select.py 提供一个选择所有的列表项的函数
  • theme_creator.py 主题合成器
  • theme_editor.py 主窗口
• ui_ctl 各个组件的逻辑类 (简单的组件会混合UI与逻辑)
  • cursor_editor_widgets 项目编辑器的各个组件&窗口
    • element_canvas.py 预览窗口
    • element_list_ctrl.py 元素列表
    • events.py 自定义事件
    • info_editor.py 项目\元素信息编辑器
    • mask_editor.py 遮罩编辑器
    • rate_editor.py 帧率编辑器
    • source_info_editor.py 源信息编辑器
    • step_editor.py 渲染步骤编辑器
  • element_sources 各种元素类型的新建页面
    • asset_source.py MC贴图
    • image_source.py 位图
    • project_source.py 子项目
    • rect.py 矩形
    • source_assets_manager.py 负责加载MC素材库的树状结构
    • temp_source.py 模板(子项目)
  • about_dialog.py 关于对话框
  • cursor_editor.py 项目编辑器
  • element_add_dialog.py 元素添加对话框
  • public_list_ctrl.py 公用列表框的逻辑(主题选择器\项目列表)
  • settings.py MineCursor的设置
  • source_editor.py 管理素材库
  • theme_creator.py 主题合成器
  • theme_editor.py 主窗口
• widget
  • adv_progress_dialog.py 高级双行进度对话框
  • center_text.py 居中文本
  • data_dialog.py 数据对话框
  • data_entry.py 数据输入框
  • ect_menu.py 快速创建与绑定的菜单(绑定像过ETC一样快)
  • editable_listctrl.py 可编辑的列表框
  • font.py 管理缓存与生成不同字号的字体
  • label_entry.py 带有前缀文本提示的对话框
  • no_tab_notebook.py 没有标签的翻页控件
  • widget_pad.py 无需wx.Sizer的控件放置
  • win_icon.py 为窗口设置各种大小的图标
• [main.py] 程序入口

图形化界面编写指南

本项目采用了控件布局与控件逻辑分离的方式 一个控件的功能类会继承这个控件的逻辑类

这是普通UI组件的初始化顺序

ui_class函数()会寻找所有调用栈中与传入类重名但没有UI后缀的类, 并返回该类

实际上是为了UI类在被非UI类初始化时可以把UI类中的UI类替换为对应的非UI类（有点绕

graph LR
    CursorEditor --> CursorEditorUI
    CursorEditorUI --> ui_ElementListCtrlUI["ui_class(ElementListCtrlUI) = ElementListCtrl"] --> ElementListCtrlUI
    CursorEditorUI --> ui_ElementCanvasUI["ui_class(ElementCanvasUI) = ElementCanvas"] --> ElementCanvasUI
    CursorEditorUI --> ui_InfoEditorUI["ui_class(InfoEditorUI) = InfoEditor"] --> InfoEditorUI

Loading

而theme_editor.py与theme_creator.py有些不同，它们共用几个列表组件

graph LR
    ThemeEditor --> ThemeEditorUI
    ThemeEditorUI --> ThemeSelectorUI["ui_class(ThemeSelectorUI) = ThemeSelector"] --> PublicThemeSelector
    ThemeEditorUI --> ThemeCursorListUI["ui_class(ThemeCursorListUI) = ThemeCursorList"] --> PublicThemeCursorList
    CursorsSelector --> CursorsSelectorUI
    CursorsSelectorUI --> ui_PublicThemeSelectorUI["ui_class(PublicThemeSelectorUI) = PublicThemeSelector"] --> PublicThemeSelectorUI
    CursorsSelectorUI --> ui_SourceThemeCursorListUI["ui_class(SourceThemeCursorListUI) = SourceThemeCursorList"] --> SourceThemeCursorListUI ---> PublicThemeCursorList
    CursorsSelectorUI --> ui_NewThemeCursorListUI["ui_class(NewThemeCursorListUI) = NewThemeCursorList"] --> NewThemeCursorListUI --> PublicThemeCursorList

Loading