Blender V5.3
bpy_app_handlers.cc File Reference
#include "BLI_utildefines.hh"
#include <Python.h>
#include "../generic/python_compat.hh"
#include "BKE_callbacks.hh"
#include "RNA_access.hh"
#include "bpy_app_handlers.hh"
#include "bpy_rna.hh"
#include "BPY_extern.hh"

Go to the source code of this file.

Namespaces

namespace  blender
 BMesh Iterators.

Macros

#define FILEPATH_SAVE_ARG
#define PYDOC_FILEPATH_SAVE_TYPE   "\n\n:type: list[Callable[[str], None]]"
#define FILEPATH_LOAD_ARG
#define PYDOC_FILEPATH_LOAD_TYPE   "\n\n:type: list[Callable[[str], None]]"
#define RENDER_STATS_ARG
#define PYDOC_RENDER_STATS_TYPE   "\n\n:type: list[Callable[[str], None]]"
#define DEPSGRAPH_UPDATE_ARG
#define PYDOC_DEPSGRAPH_UPDATE_TYPE
#define RENDER_ARG
#define PYDOC_RENDER_TYPE   "\n\n:type: list[Callable[[bpy.types.Scene], None]]"
#define OBJECT_BAKE_ARG
#define PYDOC_OBJECT_BAKE_TYPE   "\n\n:type: list[Callable[[bpy.types.Object], None]]"
#define COMPOSITE_ARG
#define PYDOC_COMPOSITE_TYPE   "\n\n:type: list[Callable[[bpy.types.Scene], None]]"
#define ANNOTATION_ARG
#define PYDOC_ANNOTATION_TYPE   "\n\n:type: list[Callable[[bpy.types.GreasePencil, bpy.types.Depsgraph], None]]"
#define BLENDIMPORT_ARG
#define PYDOC_BLENDIMPORT_TYPE   "\n\n:type: list[Callable[[bpy.types.BlendImportContext], None]]"
#define SCENE_ARG
#define PYDOC_SCENE_TYPE   "\n\n:type: list[Callable[[bpy.types.Scene], None]]"
#define PYDOC_HANDLER_TYPE_NONE   "\n\n:type: list[Callable[[], None]]"
#define PYDOC_HANDLER_TYPE_BOOL   "\n\n:type: list[Callable[[bool], None]]"
#define APP_CB_OTHER_FIELDS   1

Functions

void blender::bpy_app_generic_callback (Main *main, PointerRNA **pointers, const int pointers_num, void *arg)
static PyObject * blender::make_app_cb_info ()
PyObject * blender::BPY_app_handlers_struct ()
void blender::BPY_app_handlers_reset (bool do_all)
static PyObject * blender::choose_arguments (PyObject *func, PyObject *args_all, PyObject *args_single)

Variables

static PyTypeObject blender::BlenderAppCbType
static PyStructSequence_Field blender::app_cb_info_fields []
static PyStructSequence_Desc blender::app_cb_info_desc
static PyObject * blender::py_cb_array [BKE_CB_EVT_TOT] = {nullptr}

Permanent Tagging Code

#define PERMINENT_CB_ID   "_bpy_persistent"
static PyTypeObject blender::BPyPersistent_Type
static PyObject * blender::bpy_app_handlers_persistent_new (PyTypeObject *, PyObject *args, PyObject *)

Detailed Description

This file defines a #PyStructSequence accessed via bpy.app.handlers, which exposes various lists that the script author can add callback functions into (called via blenders generic BLI_cb API)

Definition in file bpy_app_handlers.cc.

Macro Definition Documentation

◆ ANNOTATION_ARG

#define ANNOTATION_ARG
Value:
"Accepts two arguments: " \
"the annotation data-block and dependency graph"

Definition at line 76 of file bpy_app_handlers.cc.

◆ APP_CB_OTHER_FIELDS

#define APP_CB_OTHER_FIELDS   1

◆ BLENDIMPORT_ARG

#define BLENDIMPORT_ARG
Value:
"Accepts one argument: " \
"a BlendImportContext"

Definition at line 82 of file bpy_app_handlers.cc.

◆ COMPOSITE_ARG

#define COMPOSITE_ARG
Value:
"Accepts one argument: " \
"the scene data-block"

Definition at line 71 of file bpy_app_handlers.cc.

◆ DEPSGRAPH_UPDATE_ARG

#define DEPSGRAPH_UPDATE_ARG
Value:
"Accepts one or two arguments: " \
"The scene data-block, and optionally the dependency graph being updated"

Definition at line 52 of file bpy_app_handlers.cc.

◆ FILEPATH_LOAD_ARG

#define FILEPATH_LOAD_ARG
Value:
"Accepts one argument: " \
"the file being loaded, an empty string for the startup-file."

Definition at line 41 of file bpy_app_handlers.cc.

◆ FILEPATH_SAVE_ARG

#define FILEPATH_SAVE_ARG
Value:
"Accepts one argument: " \
"the file being saved, an empty string for the startup-file."

Definition at line 36 of file bpy_app_handlers.cc.

◆ OBJECT_BAKE_ARG

#define OBJECT_BAKE_ARG
Value:
"Accepts one argument: " \
"the object data-block being baked"

Definition at line 66 of file bpy_app_handlers.cc.

◆ PERMINENT_CB_ID

#define PERMINENT_CB_ID   "_bpy_persistent"

◆ PYDOC_ANNOTATION_TYPE

#define PYDOC_ANNOTATION_TYPE   "\n\n:type: list[Callable[[bpy.types.GreasePencil, bpy.types.Depsgraph], None]]"

Definition at line 79 of file bpy_app_handlers.cc.

◆ PYDOC_BLENDIMPORT_TYPE

#define PYDOC_BLENDIMPORT_TYPE   "\n\n:type: list[Callable[[bpy.types.BlendImportContext], None]]"

Definition at line 85 of file bpy_app_handlers.cc.

◆ PYDOC_COMPOSITE_TYPE

#define PYDOC_COMPOSITE_TYPE   "\n\n:type: list[Callable[[bpy.types.Scene], None]]"

Definition at line 74 of file bpy_app_handlers.cc.

◆ PYDOC_DEPSGRAPH_UPDATE_TYPE

#define PYDOC_DEPSGRAPH_UPDATE_TYPE
Value:
"\n\n:type: list[" \
"Callable[[bpy.types.Scene, bpy.types.Depsgraph], None] | " \
"Callable[[bpy.types.Scene], None]" \
"]"

Definition at line 55 of file bpy_app_handlers.cc.

◆ PYDOC_FILEPATH_LOAD_TYPE

#define PYDOC_FILEPATH_LOAD_TYPE   "\n\n:type: list[Callable[[str], None]]"

Definition at line 44 of file bpy_app_handlers.cc.

◆ PYDOC_FILEPATH_SAVE_TYPE

#define PYDOC_FILEPATH_SAVE_TYPE   "\n\n:type: list[Callable[[str], None]]"

Definition at line 39 of file bpy_app_handlers.cc.

◆ PYDOC_HANDLER_TYPE_BOOL

#define PYDOC_HANDLER_TYPE_BOOL   "\n\n:type: list[Callable[[bool], None]]"

Definition at line 92 of file bpy_app_handlers.cc.

◆ PYDOC_HANDLER_TYPE_NONE

#define PYDOC_HANDLER_TYPE_NONE   "\n\n:type: list[Callable[[], None]]"

Definition at line 91 of file bpy_app_handlers.cc.

◆ PYDOC_OBJECT_BAKE_TYPE

#define PYDOC_OBJECT_BAKE_TYPE   "\n\n:type: list[Callable[[bpy.types.Object], None]]"

Definition at line 69 of file bpy_app_handlers.cc.

◆ PYDOC_RENDER_STATS_TYPE

#define PYDOC_RENDER_STATS_TYPE   "\n\n:type: list[Callable[[str], None]]"

Definition at line 50 of file bpy_app_handlers.cc.

◆ PYDOC_RENDER_TYPE

#define PYDOC_RENDER_TYPE   "\n\n:type: list[Callable[[bpy.types.Scene], None]]"

Definition at line 64 of file bpy_app_handlers.cc.

◆ PYDOC_SCENE_TYPE

#define PYDOC_SCENE_TYPE   "\n\n:type: list[Callable[[bpy.types.Scene], None]]"

Definition at line 90 of file bpy_app_handlers.cc.

◆ RENDER_ARG

#define RENDER_ARG
Value:
"Accepts one argument: " \
"the scene data-block being rendered"

Definition at line 61 of file bpy_app_handlers.cc.

◆ RENDER_STATS_ARG

#define RENDER_STATS_ARG
Value:
"Accepts one argument: " \
"the render progress as a string containing current frame, current sample, render time and " \
"saving time."

Definition at line 46 of file bpy_app_handlers.cc.

◆ SCENE_ARG

#define SCENE_ARG
Value:
"Accepts one argument: " \
"the scene data-block"

Definition at line 87 of file bpy_app_handlers.cc.