BlenderTools项目深度解析：Send2UE扩展功能开发指南-优快云博客

本文链接：https://blog.youkuaiyun.com/gitblog_00990/article/details/148755963

BlenderTools项目深度解析：Send2UE扩展功能开发指南

BlenderTools Blender addons that improve the game development workflow between Blender and Unreal. 项目地址: https://gitcode.com/gh_mirrors/bl/BlenderTools

前言

在3D内容创作流程中，Blender与Unreal Engine的协同工作已成为行业标准。EpicGamesExt/BlenderTools项目中的Send2UE功能模块极大地简化了这一流程，而其扩展系统则为开发者提供了强大的定制能力。本文将深入解析Send2UE扩展系统的技术细节，帮助开发者掌握自定义扩展的开发方法。

扩展系统概述

Send2UE扩展系统是一个基于Python的插件架构，它允许开发者在不修改核心代码的情况下，通过编写扩展类来增强工具功能。这种设计遵循了开闭原则，使系统保持高度可扩展性。

核心特点

模块化设计：每个扩展都是独立的Python类
生命周期钩子：可在操作流程的关键节点注入自定义逻辑
属性系统：支持自定义属性的持久化存储
UI集成：可扩展工具界面，添加自定义控件

扩展开发基础

基本结构

每个扩展必须继承自ExtensionBase基类，并至少定义name类属性：

from send2ue.core.extension import ExtensionBase

class MyExtension(ExtensionBase):
    name = 'my_extension'  # 必须定义，作为扩展的唯一标识

扩展类型

Send2UE支持三种主要扩展类型：

任务(Tasks)：在操作流程特定阶段执行的逻辑
属性(Properties)：可持久化的配置参数
绘制(Draws)：自定义UI界面元素

任务系统详解

任务系统是扩展功能的核心，它允许开发者在Send2UE操作流程的各个阶段注入自定义逻辑。

任务类型与执行顺序

预操作阶段：
- filter_objects: 过滤收集到的骨架和网格对象
- pre_operation: 操作开始前的全局设置
- pre_validations: 操作前的验证逻辑
资源处理阶段：
- pre_mesh_export/post_mesh_export: 网格导出前后处理
- pre_animation_export/post_animation_export: 动画导出前后处理
导入阶段：
- pre_import/post_import: 资源导入Unreal前后的处理
后操作阶段：
- post_operation: 操作完成后的清理工作
- post_validations: 最终验证

典型任务示例

def pre_mesh_export(self, asset_data, properties):
    """
    网格导出前的自定义处理
    :param asset_data: 包含资源信息的字典
    :param properties: 场景属性组
    """
    # 修改导出路径
    asset_data['asset_folder'] = '/Game/custom_folder/'
    self.update_asset_data(asset_data)

属性系统开发

扩展可以定义自己的属性，这些属性会自动集成到Blender的属性系统中。

属性定义方法

class MyExtension(ExtensionBase):
    name = 'my_extension'
    
    # 定义字符串属性
    export_prefix: bpy.props.StringProperty(
        name="Export Prefix",
        default="custom_",
        description="Prefix for exported assets"
    )
    
    # 定义布尔属性
    enable_feature: bpy.props.BoolProperty(
        name="Enable Feature",
        default=False
    )

属性访问方式

在扩展内部：self.property_name
全局访问：bpy.context.scene.send2ue.extensions.extension_name.property_name

UI集成开发

扩展可以自定义UI界面，将属性暴露给用户进行配置。

绘制方法示例

def draw_export(self, dialog, layout, properties):
    """在导出标签页添加自定义UI"""
    box = layout.box()
    box.label(text="Custom Export Settings")
    row = box.row()
    row.prop(self, 'export_prefix')
    row.prop(self, 'enable_feature')

高级功能：RPC通信

Send2UE提供了与Unreal Editor的RPC通信能力，允许扩展直接调用Unreal引擎功能。

RPC使用示例

from send2ue.dependencies.unreal import remote_unreal_decorator

@remote_unreal_decorator
def create_unreal_material(asset_path):
    import unreal
    return unreal.AssetToolsHelpers.get_asset_tools().create_asset(
        asset_path, '/Game', unreal.Material, unreal.MaterialFactoryNew()
    )

class MaterialExtension(ExtensionBase):
    name = 'material_creator'
    
    def post_import(self, asset_data, properties):
        if asset_data['_asset_type'] == 'MESH':
            mat_path = f"{asset_data['asset_path']}_Material"
            create_unreal_material(mat_path)

实际应用案例

案例1：自动LOD生成

class AutoLodExtension(ExtensionBase):
    name = 'auto_lod'
    
    lod_levels: bpy.props.IntProperty(default=3, min=1, max=5)
    
    def draw_export(self, dialog, layout, properties):
        layout.prop(self, 'lod_levels')
    
    def pre_mesh_export(self, asset_data, properties):
        if not asset_data['lods']:
            asset_data['lods'] = []
            for i in range(1, self.lod_levels):
                asset_data['lods'].append({
                    'percentage': 100/(2**i),
                    'export': True
                })
        self.update_asset_data(asset_data)

案例2：命名规范化

class NamingExtension(ExtensionBase):
    name = 'naming_convention'
    
    use_prefix: bpy.props.BoolProperty(default=True)
    prefix: bpy.props.StringProperty(default="CHAR_")
    
    def filter_objects(self, armature_objects, mesh_objects):
        if self.use_prefix:
            for obj in mesh_objects:
                if not obj.name.startswith(self.prefix):
                    obj.name = f"{self.prefix}{obj.name}"
        return armature_objects, mesh_objects