码迷,mamicode.com
首页 > 其他好文 > 详细

Blender 之 Splash 代码分析

时间:2016-01-17 23:01:53      阅读:260      评论:0      收藏:0      [点我收藏+]

标签:

  注:以下内容基于 Blender 2.7x 版本工程,其它低版本可能有改动。

  Blender启动完成时,会出现一个画面,英文叫Splash。默认是打开的,可以在设置里关闭。在文件菜单里点击用户首选项(快捷键Ctrl + Alt + U),在弹出的窗口第一个Tab页面,也就是界面(Interface)的右下角,有一个选项 Show Splash,默认打了勾,关闭然后最下一行的 Save User Settings。这样,下次启动的时候就不会出现Splash。

  假设你已经下载好了blender工程代码,下面通过Splash讲解C语言Operator的实现,前一篇是关于Python的Operator。

 

datatoc

  Splash资源所在的文件夹是 blender/release/datafiles/ ,一起的还有各种图标、字体、SVG矢量图、画笔以及matcap效果图。
  source/blender/editors/datafiles/CMakeLists.txt 会调用 data_to_c_simple 函数从图片格式转换成C代码(其实就是长度加二进制数据),blender 需要在源代码路径外编译(out of source build) ,对应生成在 blender-build/release/datafiles/ 。
data_to_c_simple(../../../../release/datafiles/splash.png SRC)
  data_to_c_simple 函数(cmake的宏)定义在 build_files/cmake/macros.cmake
  data_to_c 需要提供file_from、file_to参数,data_to_c_simple 则仅提供 file_from 参数,file_to 的值为 ${file_from}.c。
  调用的命令是 datatoc 其工程在 source/blender/datatoc/ 。

  该 CMakeLists.txt 的最后一句指明生成 bf_editor_datafiles.lib
blender_add_lib(bf_editor_datafiles "${SRC}" "${INC}" "${INC_SYS}")

bf_editor_datafiles.vcxproj -> blender-build/lib/Debug/bf_editor_datafiles.lib


  blender/source/blenderplayer/CMakeLists.txt
  bf_editor_datafiles 被包含在 BLENDER_SORTED_LIBS 里,blender.exe blenderplayer.exe 会依赖这些工程库。
target_link_libraries(blenderplayer ${BLENDER_SORTED_LIBS})
target_link_libraries(blender ${BLENDER_SORTED_LIBS})

  这些图片资源最终转换成C数组数据链接到.exe文件里。
好处是:如果缺少相关资源(写错名字、用了中文字符、或者图片格式误写),编译期就会报错;如果仅仅是替换掉一张图片的话,错误只能在运行时被发现,导致出错。
坏处是:不仅仅是换掉图片资源就好了的,还需要重新编译。这让一些想把splash换成自己作品的艺术家望而却步。

 

main函数

  Blender.sln 解决方案包含多个工程,cmake工具会额外生成 ALL_BUILD / INSTALL / PACKAGE / RUN_TESTS / ZERO_CHECK 等几个工程。其中,ALL_BUILD与INSTALL相当于makefile里面的make与install命令。
  编译完成,在运行的时候,需要将启动工程从 ALL_BUILD 修改成 blender,否则会提示 Unable to start program ‘build\x64\Debug\ALL_BUILD‘ 拒绝访问。(在blender工程上鼠标右键后,选择 Set as StartUp Project 即可)

  一切的一切,要从main函数开始……
  main函数在 blender 工程里的 source/creator/creator.c ,初始化子系统(图像、修改器、画笔、Python、节点、材质等)、处理命令行参数、进入消息循环WM_main()或者退出循环在后台运行(-b参数可以指定在后台渲染)。
BLI_argsAdd(ba, 1, "-b", "--background", "\n\tRun in background (often used for UI-less rendering)", background_mode, NULL);

  所有有UI的应用程序会有消息循环机制。Blender 的是在 WM_main(C);
  WM_main 的实现在 source/blender/windowmanager/intern/wm.c ,很简单的几行代码。

void WM_main(bContext *C)
{
    while (1) {
        
        /* get events from ghost, handle window events, add to window queues */
        wm_window_process_events(C); 
        
        /* per window, all events to the window, screen, area and region handlers */
        wm_event_do_handlers(C);
        
        /* events have left notes about changes, we handle and cache it */
        wm_event_do_notifiers(C);
        
        /* execute cached changes draw */
        wm_draw_update(C);
    }
}

在 WM_main(C); 一行的上面是关于splash的,

if(!G.file_loaded)
    WM_init_splash(C);

  Blender 有两个重要的数据结构 Global G; 和 UserDef U; ,见名知意。
  Global 的字段 file_loaded 是 bool 类型的,但是字符串全局搜索到的是赋值为整形1,其实就是true。
source/blender/windowmanager/intern/wm_operators.c: G.file_loaded = 1; /* prevents splash to show */
  file_loaded 为 true 则阻止加载splash,否则启动时加载splash。

 

Splash

  关于 splash 的代码,就在 WM_init_splash(C); 这一行了。
  WM是WindowManager的缩写,C语言缺少 C++ 的 namespace 概念,这样附带模块命名以防冲突。
  来看看代码中有关splash的地方,Blender一个很常见的概念是Operator。
source/blender/windowmanager/intern/wm_init_exit.c

void WM_init_splash(bContext *C)
{
    if ((U.uiflag & USER_SPLASH_DISABLE) == 0) {
        wmWindowManager *wm = CTX_wm_manager(C);
        wmWindow *prevwin = CTX_wm_window(C);
    
        if (wm->windows.first) {
            CTX_wm_window_set(C, wm->windows.first);
            WM_operator_name_call(C, "WM_OT_splash", WM_OP_INVOKE_DEFAULT, NULL);
            CTX_wm_window_set(C, prevwin);
        }
    }
}

  U.uiflag的比特位差不多用光了,又开了uiflag2。其中,USER_SPLASH_DISABLE 对应上面用户偏好里的 Show Splash。
  bContext 是很重要的数据结构,通过指针传递,函数定义在 source/blender/blenkernel/intern/context.c,很多地方都引用了它,应该定义在 .h 文件里的。

  给变量取好名字,更方便读代码。WM_operator_name_call 见名知意,根据Operator的名字来调用函数,比如上面就是想调用 "WM_OT_splash" 函数。

int WM_operator_name_call(bContext *C, const char *opstring, short context, PointerRNA *properties)
{
    wmOperatorType *ot = WM_operatortype_find(opstring, 0);
    if (ot) {
        return WM_operator_name_call_ptr(C, ot, context, properties);
    }

    return 0;
}

  在 blender/source/blender/windowmanager/intern/wm_operators.c 你可以看到关于 Operator 的各种操作,通过函数 WM_operatortype_append 可以添加新的 Operator,由于有很多 Operator,Blender 用自己的哈希表 GHash *global_ops_hash 管理,WM_OT_splash 是在 WM_init() 初始化时添加的。

/* called on initialize WM_init() */
void wm_operatortype_init(void)
{
    /* reserve size is set based on blender default setup */
    global_ops_hash = BLI_ghash_str_new_ex("wm_operatortype_init gh", 2048);
    
    ...
    WM_operatortype_append(WM_OT_splash);
    ...
}

调用的栈是这样的
int main(int argc, const char **argv)
  WM_init(C, argc, (const char **)argv);
    wm_operatortype_init();
      WM_operatortype_append(WM_OT_splash);

  WM_OT_splash,WM是Operator的种类,_OT_ 是 Operator Type,构成Operator ID名称的一部分,该函数填充 wmOperatorType 里的字段。

static void WM_OT_splash(wmOperatorType *ot)
{
    ot->name = "Splash Screen";
    ot->idname = "WM_OT_splash";
    ot->description = "Open the splash screen with release info";
    
    ot->invoke = wm_splash_invoke;
    ot->poll = WM_operator_winactive;
}

 

  前一篇讲到过 name、idname、description。struct wmOperatorType 也给了注释。name 会在UI上显示出来的。idname 名字应该和函数名字一致,这里可以用 __func__ 宏的。description 是提示信息,鼠标放在上面会显示出来。
  poll回调函数用来测试该Operator是否可以在当前环境(context)执行。我发现有些人在读代码的时候,对变量或函数的取名不在意。poll是轮询的意思,通过名称就能猜到要完成的功能。有关函数WM_operator_poll
  invoke 就是函数调用了。

  因为是static函数,所以只需要在本文件内搜索调用处,其他文件是不能调用的。这也算是一种搜索技巧。

static int wm_splash_invoke(bContext *C, wmOperator *UNUSED(op), const wmEvent *UNUSED(event))
{
    UI_popup_block_invoke(C, wm_block_create_splash, NULL);
    
    return OPERATOR_FINISHED;
}

  C返回 OPERATOR_FINISHED 的状态,对应 Python 返回 {"FINISHED"}。
  接着就是 wm_block_create_splash 函数了,画出Splash的地方,Splash上面的跳转链接也写在这个函数里。
// blender/source/blender/windowmanager/intern/wm_operators.c

技术分享
static uiBlock *wm_block_create_splash(bContext *C, ARegion *ar, void *UNUSED(arg))
{
    ...
    
#ifndef WITH_HEADLESS
    extern char datatoc_splash_png[];
    extern int datatoc_splash_png_size;

    extern char datatoc_splash_2x_png[];
    extern int datatoc_splash_2x_png_size;
    ImBuf *ibuf;
#else
    ImBuf *ibuf = NULL;
#endif
    ...
    
}
splash.png

  WITH_HEADLESS 名字看不懂,CMakeLists.txt 里解释说是不带图形界面的编译(渲染农场,服务端模式),默认是关闭的。
  这里引用到了 splash.png 的图,工程datatoc用来将splash.png图片资源转换成长度datatoc_splash_png_size 和二进制的dump datatoc_splash_png,上面讲过。

  有关函数wm_operator_invoke,在 source/blender/windowmanager/intern/wm_event_system.c,调用栈是这样的:
int main(int argc, const char **argv)
  WM_main(C);
    WM_init_splash(C);
      WM_operator_name_call(C, "WM_OT_splash", WM_OP_INVOKE_DEFAULT, NULL);
        WM_operator_name_call_ptr(C, ot, context, properties);
          wm_operator_call_internal(C, ot, properties, NULL, context, false);
            wm_operator_invoke(C, ot, event, properties, reports, poll_only);

技术分享
static int wm_operator_invoke(
        bContext *C, wmOperatorType *ot, wmEvent *event,
        PointerRNA *properties, ReportList *reports, const bool poll_only)
{
    ...
    
    if (op->type->invoke && event) {
        wm_region_mouse_co(C, event);

        if (op->type->flag & OPTYPE_UNDO)
            wm->op_undo_depth++;

        retval = op->type->invoke(C, op, event);
        OPERATOR_RETVAL_CHECK(retval);

        if (op->type->flag & OPTYPE_UNDO && CTX_wm_manager(C) == wm)
            wm->op_undo_depth--;
    }
    else if (op->type->exec) {
        if (op->type->flag & OPTYPE_UNDO)
            wm->op_undo_depth++;

        retval = op->type->exec(C, op);
        OPERATOR_RETVAL_CHECK(retval);

        if (op->type->flag & OPTYPE_UNDO && CTX_wm_manager(C) == wm)
            wm->op_undo_depth--;
    }
    else {
        /* debug, important to leave a while, should never happen */
        printf("%s: invalid operator call ‘%s‘\n", __func__, ot->idname);
    }

    ...
}
wm_operator_invoke

 

  invoke和exec是函数指针,要二选一填充,否则就是非法的Operator调用。上面的Splash Operator用的是invoke,它们的函数原型是:
int (*exec)(struct bContext *, struct wmOperator *);
int (*invoke)(struct bContext *, struct wmOperator *, const struct wmEvent *);

  invoke 比 exec 多出一个 struct wmEvent* 参数,返回类型是int,其实是下面的无名enum类型。
  调用exec或invoke后,都会 OPERATOR_RETVAL_CHECK(ret) 测试一下返回值。
  invoke比exec多出的一句是:wm_region_mouse_co(C, event);

技术分享
/* operator type return flags: exec(), invoke() modal(), return values */
enum {
    OPERATOR_RUNNING_MODAL  = (1 << 0),
    OPERATOR_CANCELLED      = (1 << 1),
    OPERATOR_FINISHED       = (1 << 2),
    /* add this flag if the event should pass through */
    OPERATOR_PASS_THROUGH   = (1 << 3),
    /* in case operator got executed outside WM code... like via fileselect */
    OPERATOR_HANDLED        = (1 << 4),
    /* used for operators that act indirectly (eg. popup menu)
     * note: this isn‘t great design (using operators to trigger UI) avoid where possible. */
    OPERATOR_INTERFACE      = (1 << 5),
};

#define OPERATOR_FLAGS_ALL ( \
    OPERATOR_RUNNING_MODAL |     OPERATOR_CANCELLED |     OPERATOR_FINISHED |     OPERATOR_PASS_THROUGH |     OPERATOR_HANDLED |     OPERATOR_INTERFACE |     0)

/* sanity checks for debug mode only */
#define OPERATOR_RETVAL_CHECK(ret) (void)ret, BLI_assert(ret != 0 && (ret & OPERATOR_FLAGS_ALL) == ret)
OPERATOR_RETVAL_CHECK

  Blender的用户偏好设置是可以保存在.blend文件里的,这是关于Splash的。
source/blender/makesrna/intern/rna_userdef.c
  prop = RNA_def_property(srna, "show_splash", PROP_BOOLEAN, PROP_NONE);
  RNA_def_property_boolean_negative_sdna(prop, NULL, "uiflag", USER_SPLASH_DISABLE);
  RNA_def_property_ui_text(prop, "Show Splash", "Display splash screen on startup");

source/blender/makesdna/DNA_userdef_types.h
  USER_SPLASH_DISABLE = (1 << 27),

 

Blender 之 Splash 代码分析

标签:

原文地址:http://www.cnblogs.com/Martinium/p/blender_splash.html

(0)
(0)
   
举报
评论 一句话评论(0
登录后才能评论!
© 2014 mamicode.com 版权所有  联系我们:gaon5@hotmail.com
迷上了代码!