Cleanup: remove redundant doxygen \file argument
[blender.git] / source / blender / editors / gizmo_library / gizmo_types / blank3d_gizmo.c
1 /*
2  * This program is free software; you can redistribute it and/or
3  * modify it under the terms of the GNU General Public License
4  * as published by the Free Software Foundation; either version 2
5  * of the License, or (at your option) any later version.
6  *
7  * This program is distributed in the hope that it will be useful,
8  * but WITHOUT ANY WARRANTY; without even the implied warranty of
9  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
10  * GNU General Public License for more details.
11  *
12  * You should have received a copy of the GNU General Public License
13  * along with this program; if not, write to the Free Software Foundation,
14  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
15  *
16  * The Original Code is Copyright (C) 2014 Blender Foundation.
17  * All rights reserved.
18  */
19
20 /** \file \ingroup edgizmolib
21  *
22  * \name Blank Gizmo
23  *
24  * \brief Gizmo to use as a fallback (catch events).
25  */
26
27
28 #include "BKE_context.h"
29
30 #include "ED_view3d.h"
31 #include "ED_gizmo_library.h"
32
33 #include "WM_types.h"
34 #include "WM_api.h"
35
36 /* own includes */
37 #include "../gizmo_geometry.h"
38 #include "../gizmo_library_intern.h"
39
40
41 static void gizmo_blank_draw(const bContext *UNUSED(C), wmGizmo *UNUSED(gz))
42 {
43         /* pass */
44 }
45
46 static int gizmo_blank_invoke(
47         bContext *UNUSED(C), wmGizmo *UNUSED(gz), const wmEvent *UNUSED(event))
48 {
49         return OPERATOR_RUNNING_MODAL;
50 }
51
52 static int gizmo_blank_test_select(
53         bContext *UNUSED(C), wmGizmo *UNUSED(gz), const int UNUSED(mval[2]))
54 {
55         return 0;
56 }
57
58 /* -------------------------------------------------------------------- */
59 /** \name Blank Gizmo API
60  *
61  * \{ */
62
63 static void GIZMO_GT_blank_3d(wmGizmoType *gzt)
64 {
65         /* identifiers */
66         gzt->idname = "GIZMO_GT_blank_3d";
67
68         /* api callbacks */
69         gzt->draw = gizmo_blank_draw;
70         gzt->invoke = gizmo_blank_invoke;
71         gzt->test_select = gizmo_blank_test_select;
72
73         gzt->struct_size = sizeof(wmGizmo);
74 }
75
76 void ED_gizmotypes_blank_3d(void)
77 {
78         WM_gizmotype_append(GIZMO_GT_blank_3d);
79 }
80
81 /** \} */