Campbell Barton
830df9b33d
While this is work-in-progress from custom-manipulators branch its stable so adding into 2.8 so we don't get too much out of sync. - ManipulatorGroupType's are moved out of the manipulator-map and are now global (like operators, panels etc) and added into spaces as needed. Without this all operators that might ever use a manipulator in the 3D view would be polling the viewport. - Add optional get/set callbacks for non-RNA properties Needed so re-usable manipulators can control values that don't correspond to a single properly or need conversion. - Fix divide by zero bug in arrow manipulator (when moving zero pixels).
200 lines
8.6 KiB
C++
200 lines
8.6 KiB
C++
/*
|
|
* ***** BEGIN GPL LICENSE BLOCK *****
|
|
*
|
|
* This program is free software; you can redistribute it and/or
|
|
* modify it under the terms of the GNU General Public License
|
|
* as published by the Free Software Foundation; either version 2
|
|
* of the License, or (at your option) any later version.
|
|
*
|
|
* This program is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU General Public License
|
|
* along with this program; if not, write to the Free Software Foundation,
|
|
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
|
|
*
|
|
* The Original Code is Copyright (C) 2016 Blender Foundation.
|
|
* All rights reserved.
|
|
*
|
|
* Contributor(s): none yet.
|
|
*
|
|
* ***** END GPL LICENSE BLOCK *****
|
|
*/
|
|
|
|
/** \file blender/windowmanager/manipulators/WM_manipulator_api.h
|
|
* \ingroup wm
|
|
*
|
|
* \name Manipulator API
|
|
* \brief API for external use of wmManipulator types.
|
|
*
|
|
* Only included in WM_api.h
|
|
*/
|
|
|
|
|
|
#ifndef __WM_MANIPULATOR_API_H__
|
|
#define __WM_MANIPULATOR_API_H__
|
|
|
|
struct ARegion;
|
|
struct GHashIterator;
|
|
struct Main;
|
|
struct wmKeyConfig;
|
|
struct wmManipulator;
|
|
struct wmManipulatorProperty;
|
|
struct wmManipulatorType;
|
|
struct wmManipulatorGroup;
|
|
struct wmManipulatorGroupType;
|
|
struct wmManipulatorMap;
|
|
struct wmManipulatorMapType;
|
|
struct wmManipulatorMapType_Params;
|
|
|
|
#include "wm_manipulator_fn.h"
|
|
|
|
/* -------------------------------------------------------------------- */
|
|
/* wmManipulator */
|
|
|
|
struct wmManipulator *WM_manipulator_new_ptr(
|
|
const struct wmManipulatorType *wt,
|
|
struct wmManipulatorGroup *mgroup, const char *name);
|
|
struct wmManipulator *WM_manipulator_new(
|
|
const char *idname,
|
|
struct wmManipulatorGroup *mgroup, const char *name);
|
|
void WM_manipulator_free(
|
|
ListBase *manipulatorlist, struct wmManipulatorMap *mmap, struct wmManipulator *mpr,
|
|
struct bContext *C);
|
|
|
|
struct PointerRNA *WM_manipulator_set_operator(struct wmManipulator *, const char *opname);
|
|
|
|
/* callbacks */
|
|
void WM_manipulator_set_fn_custom_modal(struct wmManipulator *mpr, wmManipulatorFnModal fn);
|
|
|
|
void WM_manipulator_set_origin(struct wmManipulator *mpr, const float origin[3]);
|
|
void WM_manipulator_set_offset(struct wmManipulator *mpr, const float offset[3]);
|
|
void WM_manipulator_set_flag(struct wmManipulator *mpr, const int flag, const bool enable);
|
|
void WM_manipulator_set_scale(struct wmManipulator *mpr, float scale);
|
|
void WM_manipulator_set_line_width(struct wmManipulator *mpr, const float line_width);
|
|
|
|
void WM_manipulator_get_color(const struct wmManipulator *mpr, float col[4]);
|
|
void WM_manipulator_set_color(struct wmManipulator *mpr, const float col[4]);
|
|
void WM_manipulator_get_color_highlight(const struct wmManipulator *mpr, float col_hi[4]);
|
|
void WM_manipulator_set_color_highlight(struct wmManipulator *mpr, const float col[4]);
|
|
|
|
/* wm_manipulator_type.c */
|
|
const struct wmManipulatorType *WM_manipulatortype_find(const char *idname, bool quiet);
|
|
void WM_manipulatortype_append(void (*wtfunc)(struct wmManipulatorType *));
|
|
void WM_manipulatortype_append_ptr(void (*mnpfunc)(struct wmManipulatorType *, void *), void *userdata);
|
|
bool WM_manipulatortype_remove(const char *idname);
|
|
void WM_manipulatortype_remove_ptr(struct wmManipulatorType *wt);
|
|
void WM_manipulatortype_iter(struct GHashIterator *ghi);
|
|
|
|
/* wm_manipulatorgroup_type.c */
|
|
struct wmManipulatorGroupType *WM_manipulatorgrouptype_find(const char *idname, bool quiet);
|
|
struct wmManipulatorGroupType *WM_manipulatorgrouptype_append(void (*wtfunc)(struct wmManipulatorGroupType *));
|
|
struct wmManipulatorGroupType *WM_manipulatorgrouptype_append_ptr(void (*mnpfunc)(struct wmManipulatorGroupType *, void *), void *userdata);
|
|
bool WM_manipulatorgrouptype_remove(const char *idname);
|
|
void WM_manipulatorgrouptype_remove_ptr(struct wmManipulatorGroupType *wt);
|
|
void WM_manipulatorgrouptype_iter(struct GHashIterator *ghi);
|
|
|
|
struct wmManipulatorGroupTypeRef *WM_manipulatorgrouptype_append_and_link(
|
|
struct wmManipulatorMapType *mmap_type,
|
|
void (*wtfunc)(struct wmManipulatorGroupType *));
|
|
|
|
/* wm_manipulatormap.c */
|
|
|
|
/* Dynamic Updates (for RNA runtime registration) */
|
|
void WM_manipulatorconfig_update_tag_init(struct wmManipulatorMapType *mmap_type, struct wmManipulatorGroupType *wgt);
|
|
void WM_manipulatorconfig_update(const struct Main *bmain);
|
|
|
|
|
|
/* wm_maniulator_property.c */
|
|
struct wmManipulatorProperty *WM_manipulator_property_find(
|
|
struct wmManipulator *mpr, const char *idname);
|
|
|
|
void WM_manipulator_property_def_rna(
|
|
struct wmManipulator *mpr, const char *idname,
|
|
struct PointerRNA *ptr, const char *propname, int index);
|
|
void WM_manipulator_property_def_func(
|
|
struct wmManipulator *mpr, const char *idname,
|
|
const struct wmManipulatorPropertyFnParams *params);
|
|
|
|
bool WM_manipulator_property_is_valid(
|
|
const struct wmManipulatorProperty *mpr_prop);
|
|
void WM_manipulator_property_value_set(
|
|
struct bContext *C, const struct wmManipulator *mpr, struct wmManipulatorProperty *mpr_prop, const float value);
|
|
float WM_manipulator_property_value_get(
|
|
const struct wmManipulator *mpr, struct wmManipulatorProperty *mpr_prop);
|
|
void WM_manipulator_property_range_get(
|
|
const struct wmManipulator *mpr, struct wmManipulatorProperty *mpr_prop,
|
|
float range[2]);
|
|
|
|
/* -------------------------------------------------------------------- */
|
|
/* wmManipulatorGroup */
|
|
|
|
/* Callbacks for 'wmManipulatorGroupType.setup_keymap' */
|
|
struct wmKeyMap *WM_manipulatorgroup_keymap_common(
|
|
const struct wmManipulatorGroupType *wgt, struct wmKeyConfig *config);
|
|
struct wmKeyMap *WM_manipulatorgroup_keymap_common_select(
|
|
const struct wmManipulatorGroupType *wgt, struct wmKeyConfig *config);
|
|
|
|
|
|
/* -------------------------------------------------------------------- */
|
|
/* wmManipulatorMap */
|
|
|
|
struct wmManipulatorMap *WM_manipulatormap_new_from_type(
|
|
const struct wmManipulatorMapType_Params *mmap_params);
|
|
void WM_manipulatormap_tag_refresh(struct wmManipulatorMap *mmap);
|
|
void WM_manipulatormap_draw(struct wmManipulatorMap *mmap, const struct bContext *C, const int drawstep);
|
|
void WM_manipulatormap_add_handlers(struct ARegion *ar, struct wmManipulatorMap *mmap);
|
|
bool WM_manipulatormap_select_all(struct bContext *C, struct wmManipulatorMap *mmap, const int action);
|
|
bool WM_manipulatormap_cursor_set(const struct wmManipulatorMap *mmap, struct wmWindow *win);
|
|
|
|
/* -------------------------------------------------------------------- */
|
|
/* wmManipulatorMapType */
|
|
|
|
struct wmManipulatorMapType *WM_manipulatormaptype_find(
|
|
const struct wmManipulatorMapType_Params *mmap_params);
|
|
struct wmManipulatorMapType *WM_manipulatormaptype_ensure(
|
|
const struct wmManipulatorMapType_Params *mmap_params);
|
|
|
|
struct wmManipulatorGroupTypeRef *WM_manipulatormaptype_group_find(
|
|
struct wmManipulatorMapType *mmap_type,
|
|
const char *idname);
|
|
struct wmManipulatorGroupTypeRef *WM_manipulatormaptype_group_find_ptr(
|
|
struct wmManipulatorMapType *mmap_type,
|
|
const struct wmManipulatorGroupType *wgt);
|
|
struct wmManipulatorGroupTypeRef *WM_manipulatormaptype_group_link(
|
|
struct wmManipulatorMapType *mmap_type,
|
|
const char *idname);
|
|
struct wmManipulatorGroupTypeRef *WM_manipulatormaptype_group_link_ptr(
|
|
struct wmManipulatorMapType *mmap_type,
|
|
struct wmManipulatorGroupType *wgt);
|
|
|
|
void WM_manipulatormaptype_group_init_runtime(
|
|
const struct Main *bmain, struct wmManipulatorMapType *mmap_type,
|
|
struct wmManipulatorGroupType *wgt);
|
|
void WM_manipulatormaptype_group_unlink(
|
|
struct bContext *C, struct Main *bmain, struct wmManipulatorMapType *mmap_type,
|
|
const struct wmManipulatorGroupType *wgt);
|
|
|
|
void WM_manipulatormaptype_group_free(struct wmManipulatorGroupTypeRef *wgt);
|
|
|
|
/* -------------------------------------------------------------------- */
|
|
/* Manipulator Add/Remove (High level API) */
|
|
|
|
void WM_manipulator_group_add_ptr_ex(
|
|
struct wmManipulatorGroupType *wgt,
|
|
struct wmManipulatorMapType *mmap_type);
|
|
void WM_manipulator_group_add_ptr(
|
|
struct wmManipulatorGroupType *wgt);
|
|
void WM_manipulator_group_add(const char *idname);
|
|
|
|
void WM_manipulator_group_remove_ptr_ex(
|
|
struct Main *bmain, struct wmManipulatorGroupType *wgt,
|
|
struct wmManipulatorMapType *mmap_type);
|
|
void WM_manipulator_group_remove_ptr(
|
|
struct Main *bmain, struct wmManipulatorGroupType *wgt);
|
|
void WM_manipulator_group_remove(struct Main *bmain, const char *idname);
|
|
|
|
#endif /* __WM_MANIPULATOR_API_H__ */
|