Blender  V3.3
Classes
bpy_rna_gizmo.c File Reference
#include <Python.h>
#include <stddef.h>
#include "MEM_guardedalloc.h"
#include "BLI_alloca.h"
#include "BLI_utildefines.h"
#include "WM_api.h"
#include "WM_types.h"
#include "bpy_capi_utils.h"
#include "bpy_rna_gizmo.h"
#include "../generic/py_capi_utils.h"
#include "../generic/python_utildefines.h"
#include "RNA_access.h"
#include "RNA_enum_types.h"
#include "RNA_prototypes.h"
#include "RNA_types.h"
#include "bpy_rna.h"

Go to the source code of this file.

Classes

struct  BPyGizmoWithTarget
 
struct  BPyGizmoWithTargetType
 
struct  BPyGizmoHandlerUserData
 

Functions

Parsing Utility Functions

Functions used as callbacks for #PyArg_ParseTuple O& format string.

static int py_rna_gizmo_parse (PyObject *o, void *p)
 
static int py_rna_gizmo_target_id_parse (PyObject *o, void *p)
 
static int py_rna_gizmo_target_id_parse_and_ensure_is_valid (PyObject *o, void *p)
 
static int py_rna_gizmo_target_type_id_parse (PyObject *o, void *p)
 
Gizmo Target Property Access API
 PyDoc_STRVAR (bpy_gizmo_target_get_value_doc, ".. method:: target_get_value(target):\n" "\n" " Get the value of this target property.\n" "\n" " :arg target: Target property name.\n" " :type target: string\n" " :return: The value of the target property.\n" " :rtype: Single value or array based on the target type\n")
 
static PyObject * bpy_gizmo_target_get_value (PyObject *UNUSED(self), PyObject *args, PyObject *kw)
 
 PyDoc_STRVAR (bpy_gizmo_target_set_value_doc, ".. method:: target_set_value(target):\n" "\n" " Set the value of this target property.\n" "\n" " :arg target: Target property name.\n" " :type target: string\n")
 
static PyObject * bpy_gizmo_target_set_value (PyObject *UNUSED(self), PyObject *args, PyObject *kw)
 
 PyDoc_STRVAR (bpy_gizmo_target_get_range_doc, ".. method:: target_get_range(target):\n" "\n" " Get the range for this target property.\n" "\n" " :arg target: Target property name.\n" " :return: The range of this property (min, max).\n" " :rtype: tuple pair.\n")
 
static PyObject * bpy_gizmo_target_get_range (PyObject *UNUSED(self), PyObject *args, PyObject *kw)
 
Gizmo Module
bool BPY_rna_gizmo_module (PyObject *mod_par)
 

Gizmo Target Property Define API

#define BPY_GIZMO_FN_SLOT_LEN   (BPY_GIZMO_FN_SLOT_RANGE_GET + 1)
 
enum  { BPY_GIZMO_FN_SLOT_GET = 0 , BPY_GIZMO_FN_SLOT_SET , BPY_GIZMO_FN_SLOT_RANGE_GET }
 
static void py_rna_gizmo_handler_get_cb (const wmGizmo *UNUSED(gz), wmGizmoProperty *gz_prop, void *value_p)
 
static void py_rna_gizmo_handler_set_cb (const wmGizmo *UNUSED(gz), wmGizmoProperty *gz_prop, const void *value_p)
 
static void py_rna_gizmo_handler_range_get_cb (const wmGizmo *UNUSED(gz), wmGizmoProperty *gz_prop, void *value_p)
 
static void py_rna_gizmo_handler_free_cb (const wmGizmo *UNUSED(gz), wmGizmoProperty *gz_prop)
 
 PyDoc_STRVAR (bpy_gizmo_target_set_handler_doc, ".. method:: target_set_handler(target, get, set, range=None):\n" "\n" " Assigns callbacks to a gizmos property.\n" "\n" " :arg target: Target property name.\n" " :type target: string\n" " :arg get: Function that returns the value for this property (single value or sequence).\n" " :type get: callable\n" " :arg set: Function that takes a single value argument and applies it.\n" " :type set: callable\n" " :arg range: Function that returns a (min, max) tuple for gizmos that use a range.\n" " :type range: callable\n")
 
static PyObject * bpy_gizmo_target_set_handler (PyObject *UNUSED(self), PyObject *args, PyObject *kw)
 

Detailed Description

This file defines utility methods for bpy.types.Gizmo.

Definition in file bpy_rna_gizmo.c.

Macro Definition Documentation

◆ BPY_GIZMO_FN_SLOT_LEN

#define BPY_GIZMO_FN_SLOT_LEN   (BPY_GIZMO_FN_SLOT_RANGE_GET + 1)

Definition at line 140 of file bpy_rna_gizmo.c.

Enumeration Type Documentation

◆ anonymous enum

anonymous enum
Enumerator
BPY_GIZMO_FN_SLOT_GET 
BPY_GIZMO_FN_SLOT_SET 
BPY_GIZMO_FN_SLOT_RANGE_GET 

Definition at line 135 of file bpy_rna_gizmo.c.

Function Documentation

◆ bpy_gizmo_target_get_range()

static PyObject* bpy_gizmo_target_get_range ( PyObject *  UNUSEDself,
PyObject *  args,
PyObject *  kw 
)
static

◆ bpy_gizmo_target_get_value()

static PyObject* bpy_gizmo_target_get_value ( PyObject *  UNUSEDself,
PyObject *  args,
PyObject *  kw 
)
static

◆ bpy_gizmo_target_set_handler()

static PyObject* bpy_gizmo_target_set_handler ( PyObject *  UNUSEDself,
PyObject *  args,
PyObject *  kw 
)
static

◆ bpy_gizmo_target_set_value()

static PyObject* bpy_gizmo_target_set_value ( PyObject *  UNUSEDself,
PyObject *  args,
PyObject *  kw 
)
static

◆ BPY_rna_gizmo_module()

bool BPY_rna_gizmo_module ( PyObject *  mod_par)

◆ py_rna_gizmo_handler_free_cb()

static void py_rna_gizmo_handler_free_cb ( const wmGizmo UNUSEDgz,
wmGizmoProperty gz_prop 
)
static

◆ py_rna_gizmo_handler_get_cb()

static void py_rna_gizmo_handler_get_cb ( const wmGizmo UNUSEDgz,
wmGizmoProperty gz_prop,
void value_p 
)
static

◆ py_rna_gizmo_handler_range_get_cb()

static void py_rna_gizmo_handler_range_get_cb ( const wmGizmo UNUSEDgz,
wmGizmoProperty gz_prop,
void value_p 
)
static

◆ py_rna_gizmo_handler_set_cb()

static void py_rna_gizmo_handler_set_cb ( const wmGizmo UNUSEDgz,
wmGizmoProperty gz_prop,
const void value_p 
)
static

◆ py_rna_gizmo_parse()

static int py_rna_gizmo_parse ( PyObject *  o,
void p 
)
static

◆ py_rna_gizmo_target_id_parse()

static int py_rna_gizmo_target_id_parse ( PyObject *  o,
void p 
)
static

◆ py_rna_gizmo_target_id_parse_and_ensure_is_valid()

static int py_rna_gizmo_target_id_parse_and_ensure_is_valid ( PyObject *  o,
void p 
)
static

◆ py_rna_gizmo_target_type_id_parse()

static int py_rna_gizmo_target_type_id_parse ( PyObject *  o,
void p 
)
static

◆ PyDoc_STRVAR() [1/4]

PyDoc_STRVAR ( bpy_gizmo_target_get_range_doc  ,
".. method:: target_get_range(target):\n" "\n" " Get the range for this target property.\n" "\n" " :arg target: Target property name.\n" " :return: The range of this property (min, max).\n" " :rtype: tuple pair.\n"   
)

◆ PyDoc_STRVAR() [2/4]

PyDoc_STRVAR ( bpy_gizmo_target_get_value_doc  ,
".. method:: target_get_value(target):\n" "\n" " Get the value of this target property.\n" "\n" " :arg target: Target property name.\n" " :type target: string\n" " :return: The value of the target property.\n" " :rtype: Single value or array based on the target type\n"   
)

◆ PyDoc_STRVAR() [3/4]

PyDoc_STRVAR ( bpy_gizmo_target_set_handler_doc  ,
".. method:: target_set_handler(target, get, set, range=None):\n" "\n" " Assigns callbacks to a gizmos property.\n" "\n" " :arg target: Target property name.\n" " :type target: string\n" " :arg get: Function that returns the value for this property (single value or sequence).\n" " :type get: callable\n" " :arg set: Function that takes a single value argument and applies it.\n" " :type set: callable\n" " :arg range: Function that returns a (min, max) tuple for gizmos that use a range.\n" " :type range: callable\n"   
)

◆ PyDoc_STRVAR() [4/4]

PyDoc_STRVAR ( bpy_gizmo_target_set_value_doc  ,
".. method:: target_set_value(target):\n" "\n" " Set the value of this target property.\n" "\n" " :arg target: Target property name.\n" " :type target: string\n"   
)