Files
test/source/blender/windowmanager/manipulators/wm_manipulator_wmapi.h
Julian Eisel 6e358a1d06 Custom Manipulators Core Backend
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/
2016-10-07 16:59:55 +02:00

91 lines
3.4 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_wmapi.h
* \ingroup wm
*
* \name Manipulators Window Manager API
* API for usage in window manager code only. It should contain all functionality
* needed to hook up the manipulator system with Blender's window manager. It's
* mostly the event system that needs to communicate with manipulator code.
*
* Only included in wm.h and lower level files.
*/
#ifndef __WM_MANIPULATOR_WMAPI_H__
#define __WM_MANIPULATOR_WMAPI_H__
struct wmEventHandler;
struct wmManipulatorMap;
struct wmOperatorType;
struct wmOperator;
/* -------------------------------------------------------------------- */
/* wmManipulator */
typedef void (*wmManipulatorSelectFunc)(struct bContext *, struct wmManipulator *, const int);
struct wmManipulatorGroup *wm_manipulator_get_parent_group(const struct wmManipulator *manipulator);
/* -------------------------------------------------------------------- */
/* wmManipulatorGroup */
void MANIPULATORGROUP_OT_manipulator_select(struct wmOperatorType *ot);
void MANIPULATORGROUP_OT_manipulator_tweak(struct wmOperatorType *ot);
void wm_manipulatorgroup_attach_to_modal_handler(
struct bContext *C, struct wmEventHandler *handler,
struct wmManipulatorGroupType *mgrouptype, struct wmOperator *op);
/* -------------------------------------------------------------------- */
/* wmManipulatorMap */
void wm_manipulatormap_delete(struct wmManipulatorMap *mmap);
void wm_manipulatormaptypes_free(void);
void wm_manipulators_keymap(struct wmKeyConfig *keyconf);
void wm_manipulatormaps_handled_modal_update(
bContext *C, struct wmEvent *event, struct wmEventHandler *handler,
const struct wmOperatorType *ot);
void wm_manipulatormap_handler_context(bContext *C, struct wmEventHandler *handler);
struct wmManipulator *wm_manipulatormap_find_highlighted_manipulator(
struct wmManipulatorMap *mmap, bContext *C,
const struct wmEvent *event, unsigned char *part);
void wm_manipulatormap_set_highlighted_manipulator(
struct wmManipulatorMap *mmap, const bContext *C,
struct wmManipulator *manipulator, unsigned char part);
struct wmManipulator *wm_manipulatormap_get_highlighted_manipulator(struct wmManipulatorMap *mmap);
void wm_manipulatormap_set_active_manipulator(
struct wmManipulatorMap *mmap, bContext *C,
const struct wmEvent *event, struct wmManipulator *manipulator);
struct wmManipulator *wm_manipulatormap_get_active_manipulator(struct wmManipulatorMap *mmap);
#endif /* __WM_MANIPULATOR_WMAPI_H__ */