6e358a1d06
This commit lands the core backend of the Custom Manipulators project onto the blender2.8 branch. It is a generic backend for managinig interactive on-screen controls that can be integrated into any 2D or 3D edito. It's also already integrated into the window-manager and editor code where needed. NOTE: The changes here should not be visible for users at all. It's really just a back-end patch. Neither does this include any RNA or Python integration. Of course, there's still lots of work ahead for custom manipulators, but this is a big milestone. WIP code that actually uses this backend can be found in the 'custom-manipulators' branch (previously called 'wiggly-widgets'). The work here isn't completely my own, all the initial work was done by @Antony Riakiotakis (psy-fi) and - although it has changed a lot since them - it's still the same in essence. He definitely deserves a big credit! Some changes in this patch were also done by @Campbell Barton (campbellbarton). Thank you guys! Merge accepted by @brecht and @merwin. Patch: https://developer.blender.org/D2232 Code documentation: https://wiki.blender.org/index.php/Dev:2.8/Source/Custom_Manipulator Main task: https://developer.blender.org/T47343 More info: https://code.blender.org/2015/09/the-custom-manipulator-project-widget-project/
111 lines
4.9 KiB
C++
111 lines
4.9 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 Main;
|
|
struct wmKeyConfig;
|
|
struct wmManipulatorGroupType;
|
|
struct wmManipulatorMap;
|
|
struct wmManipulatorMapType;
|
|
struct wmManipulatorMapType_Params;
|
|
|
|
/* -------------------------------------------------------------------- */
|
|
/* wmManipulator */
|
|
|
|
struct wmManipulator *WM_manipulator_new(
|
|
void (*draw)(const struct bContext *, struct wmManipulator *),
|
|
void (*render_3d_intersection)(const struct bContext *, struct wmManipulator *, int),
|
|
int (*intersect)(struct bContext *, const struct wmEvent *, struct wmManipulator *),
|
|
int (*handler)(struct bContext *, const struct wmEvent *, struct wmManipulator *, const int));
|
|
void WM_manipulator_delete(
|
|
ListBase *manipulatorlist, struct wmManipulatorMap *mmap, struct wmManipulator *manipulator,
|
|
struct bContext *C);
|
|
|
|
void WM_manipulator_set_property(struct wmManipulator *, int slot, struct PointerRNA *ptr, const char *propname);
|
|
struct PointerRNA *WM_manipulator_set_operator(struct wmManipulator *, const char *opname);
|
|
void WM_manipulator_set_func_select(
|
|
struct wmManipulator *manipulator,
|
|
void (*select)(struct bContext *, struct wmManipulator *, const int action)); /* wmManipulatorSelectFunc */
|
|
void WM_manipulator_set_origin(struct wmManipulator *manipulator, const float origin[3]);
|
|
void WM_manipulator_set_offset(struct wmManipulator *manipulator, const float offset[3]);
|
|
void WM_manipulator_set_flag(struct wmManipulator *manipulator, const int flag, const bool enable);
|
|
void WM_manipulator_set_scale(struct wmManipulator *manipulator, float scale);
|
|
void WM_manipulator_set_line_width(struct wmManipulator *manipulator, const float line_width);
|
|
void WM_manipulator_set_colors(struct wmManipulator *manipulator, const float col[4], const float col_hi[4]);
|
|
|
|
|
|
/* -------------------------------------------------------------------- */
|
|
/* wmManipulatorGroup */
|
|
|
|
struct wmManipulatorGroupType *WM_manipulatorgrouptype_append(
|
|
struct wmManipulatorMapType *mmaptype,
|
|
void (*mgrouptype_func)(struct wmManipulatorGroupType *));
|
|
struct wmManipulatorGroupType *WM_manipulatorgrouptype_append_runtime(
|
|
const struct Main *main, struct wmManipulatorMapType *mmaptype,
|
|
void (*mgrouptype_func)(struct wmManipulatorGroupType *));
|
|
void WM_manipulatorgrouptype_init_runtime(
|
|
const struct Main *bmain, struct wmManipulatorMapType *mmaptype,
|
|
struct wmManipulatorGroupType *mgrouptype);
|
|
void WM_manipulatorgrouptype_unregister(
|
|
struct bContext *C, struct Main *bmain, struct wmManipulatorGroupType *mgroup);
|
|
|
|
struct wmKeyMap *WM_manipulatorgroup_keymap_common(
|
|
const struct wmManipulatorGroupType *mgrouptype, struct wmKeyConfig *config);
|
|
struct wmKeyMap *WM_manipulatorgroup_keymap_common_sel(
|
|
const struct wmManipulatorGroupType *mgrouptype, struct wmKeyConfig *config);
|
|
|
|
|
|
/* -------------------------------------------------------------------- */
|
|
/* wmManipulatorMap */
|
|
|
|
struct wmManipulatorMapType *WM_manipulatormaptype_find(
|
|
const struct wmManipulatorMapType_Params *mmap_params);
|
|
struct wmManipulatorMapType *WM_manipulatormaptype_ensure(
|
|
const struct wmManipulatorMapType_Params *mmap_params);
|
|
|
|
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);
|
|
|
|
#endif /* __WM_MANIPULATOR_API_H__ */
|
|
|