Rename any instance of scene layer or render layer in code with view layer
[blender.git] / source / blender / editors / include / ED_transform_snap_object_context.h
1 /*
2  * ***** BEGIN GPL LICENSE BLOCK *****
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License
6  * as published by the Free Software Foundation; either version 2
7  * of the License, or (at your option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software Foundation,
16  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
17  *
18  * ***** END GPL LICENSE BLOCK *****
19  */
20
21 /** \file ED_transform_snap_object_context.h
22  *  \ingroup editors
23  */
24
25 #ifndef __ED_TRANSFORM_SNAP_OBJECT_CONTEXT_H__
26 #define __ED_TRANSFORM_SNAP_OBJECT_CONTEXT_H__
27
28 struct BMVert;
29 struct BMEdge;
30 struct BMFace;
31
32 struct ListBase;
33 struct RenderEngineType;
34 struct Scene;
35 struct ViewLayer;
36 struct Main;
37 struct Object;
38 struct ARegion;
39 struct View3D;
40 struct bContext;
41
42 /* transform_snap_object.c */
43
44 /* ED_transform_snap_object_*** API */
45
46 typedef enum eSnapSelect {
47         SNAP_ALL = 0,
48         SNAP_NOT_SELECTED = 1,
49         SNAP_NOT_ACTIVE = 2,
50 } eSnapSelect;
51
52 /** used for storing multiple hits */
53 struct SnapObjectHitDepth {
54         struct SnapObjectHitDepth *next, *prev;
55
56         float depth;
57         float co[3];
58         float no[3];
59         int index;
60
61         struct Object *ob;
62         float obmat[4][4];
63
64         /* needed to tell which ray-cast this was part of,
65          * the same object may be part of many ray-casts when dupli's are used. */
66         unsigned int ob_uuid;
67 };
68
69 /** parameters that define which objects will be used to snap. */
70 struct SnapObjectParams {
71         /* special context sensitive handling for the active or selected object */
72         char snap_select;
73         /* use editmode cage */
74         unsigned int use_object_edit_cage : 1;
75 };
76
77 typedef struct SnapObjectContext SnapObjectContext;
78 SnapObjectContext *ED_transform_snap_object_context_create(
79         struct Main *bmain, struct Scene *scene, struct ViewLayer *sl, struct RenderEngineType *engine, int flag);
80 SnapObjectContext *ED_transform_snap_object_context_create_view3d(
81         struct Main *bmain, struct Scene *scene, struct ViewLayer *sl, struct RenderEngineType *engine, int flag,
82         /* extra args for view3d */
83         const struct ARegion *ar, const struct View3D *v3d);
84 void ED_transform_snap_object_context_destroy(SnapObjectContext *sctx);
85
86 /* callbacks to filter how snap works */
87 void ED_transform_snap_object_context_set_editmesh_callbacks(
88         SnapObjectContext *sctx,
89         bool (*test_vert_fn)(struct BMVert *, void *user_data),
90         bool (*test_edge_fn)(struct BMEdge *, void *user_data),
91         bool (*test_face_fn)(struct BMFace *, void *user_data),
92         void *user_data);
93
94 bool ED_transform_snap_object_project_ray_ex(
95         struct SnapObjectContext *sctx,
96         const struct SnapObjectParams *params,
97         const float ray_start[3], const float ray_normal[3], float *ray_depth,
98         /* return args */
99         float r_loc[3], float r_no[3], int *r_index,
100         struct Object **r_ob, float r_obmat[4][4]);
101 bool ED_transform_snap_object_project_ray(
102         SnapObjectContext *sctx,
103         const struct SnapObjectParams *params,
104         const float ray_origin[3], const float ray_direction[3], float *ray_depth,
105         float r_co[3], float r_no[3]);
106
107 bool ED_transform_snap_object_project_ray_all(
108         SnapObjectContext *sctx,
109         const struct SnapObjectParams *params,
110         const float ray_start[3], const float ray_normal[3],
111         float ray_depth, bool sort,
112         struct ListBase *r_hit_list);
113
114 bool ED_transform_snap_object_project_view3d_ex(
115         struct SnapObjectContext *sctx,
116         const unsigned short snap_to,
117         const struct SnapObjectParams *params,
118         const float mval[2], float *dist_px,
119         float *ray_depth,
120         float r_loc[3], float r_no[3], int *r_index);
121 bool ED_transform_snap_object_project_view3d(
122         struct SnapObjectContext *sctx,
123         const unsigned short snap_to,
124         const struct SnapObjectParams *params,
125         const float mval[2], float *dist_px,
126         float *ray_depth,
127         /* return args */
128         float r_loc[3], float r_no[3]);
129 bool ED_transform_snap_object_project_view3d_mixed(
130         SnapObjectContext *sctx,
131         const unsigned short snap_to_flag,
132         const struct SnapObjectParams *params,
133         const float mval_fl[2], float *dist_px,
134         bool use_depth,
135         float r_co[3], float r_no[3]);
136
137 bool ED_transform_snap_object_project_all_view3d_ex(
138         SnapObjectContext *sctx,
139         const struct SnapObjectParams *params,
140         const float mval[2],
141         float ray_depth, bool sort,
142         ListBase *r_hit_list);
143
144 #endif  /* __ED_TRANSFORM_SNAP_OBJECT_CONTEXT_H__ */