/*
 * ***** 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 */

struct wmManipulatorGroup *wm_manipulator_get_parent_group(const struct wmManipulator *manipulator);

/* wm_manipulator.c, for init/exit */
void wm_manipulatortype_free(void);
void wm_manipulatortype_init(void);

/* -------------------------------------------------------------------- */
/* 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__ */