Blender V5.3
gpencil_utils.cc
Go to the documentation of this file.
1/* SPDX-FileCopyrightText: 2014 Blender Authors
2 *
3 * SPDX-License-Identifier: GPL-2.0-or-later */
4
8
9#include <cstdlib>
10#include <cstring>
11
12#include "MEM_guardedalloc.h"
13
14#include "BLI_math_matrix_c.hh"
15#include "BLI_utildefines.hh"
16
18#include "DNA_material_types.h"
19#include "DNA_object_types.h"
20#include "DNA_scene_types.h"
21#include "DNA_screen_types.h"
22#include "DNA_space_types.h"
23
24#include "BKE_context.hh"
25#include "BKE_paint.hh"
26#include "BKE_tracking.hh"
27
28#include "WM_api.hh"
29#include "WM_types.hh"
30
31#include "RNA_access.hh"
32#include "RNA_prototypes.hh"
33
34#include "UI_view2d.hh"
35
36#include "ED_clip.hh"
37#include "ED_gpencil_legacy.hh"
38#include "ED_view3d.hh"
39
41
42#include "gpencil_intern.hh"
43
44namespace blender {
45
46/* ******************************************************** */
47/* Context Wrangling... */
48
50 ScrArea *area,
51 Scene *scene,
52 PointerRNA *r_ptr)
53{
54 /* If there's an active area, check if the particular editor may
55 * have defined any special Grease Pencil context for editing. */
56 if (area) {
57 SpaceLink *sl = area->spacedata.first_as<SpaceLink>();
58
59 switch (area->spacetype) {
60 case SPACE_INFO: /* header info */
61 {
62 return nullptr;
63 }
64
65 case SPACE_TOPBAR: /* Top-bar */
66 case SPACE_VIEW3D: /* 3D-View */
67 case SPACE_PROPERTIES: /* properties */
68 {
69 if (r_ptr) {
70 *r_ptr = RNA_id_pointer_create(&scene->id);
71 }
72 return &scene->gpd;
73 }
74 case SPACE_NODE: /* Nodes Editor */
75 {
76 SpaceNode *snode = reinterpret_cast<SpaceNode *>(sl);
77
78 /* return the GP data for the active node block/node */
79 if (snode && snode->nodetree) {
80 /* for now, as long as there's an active node tree,
81 * default to using that in the Nodes Editor */
82 if (r_ptr) {
83 *r_ptr = RNA_id_pointer_create(&snode->nodetree->id);
84 }
85 return &snode->nodetree->gpd;
86 }
87
88 /* Even when there is no node-tree, don't allow this to flow to scene. */
89 return nullptr;
90 }
91 case SPACE_SEQ: /* Sequencer */
92 {
93 SpaceSeq *sseq = reinterpret_cast<SpaceSeq *>(sl);
94
95 /* For now, Grease Pencil data is associated with the space
96 * (actually preview region only). */
97 if (r_ptr) {
98 *r_ptr = RNA_pointer_create_discrete(screen_id, RNA_SpaceSequenceEditor, sseq);
99 }
100 return &sseq->gpd;
101 }
102 case SPACE_IMAGE: /* Image/UV Editor */
103 {
104 SpaceImage *sima = reinterpret_cast<SpaceImage *>(sl);
105
106 /* For now, Grease Pencil data is associated with the space... */
107 if (r_ptr) {
108 *r_ptr = RNA_pointer_create_discrete(screen_id, RNA_SpaceImageEditor, sima);
109 }
110 return &sima->gpd;
111 }
112 case SPACE_CLIP: /* Nodes Editor */
113 {
114 SpaceClip *sc = reinterpret_cast<SpaceClip *>(sl);
116
117 if (clip) {
120 &clip->tracking);
121 MovieTrackingTrack *track = tracking_object->active_track;
122
123 if (!track) {
124 return nullptr;
125 }
126
127 if (r_ptr) {
128 *r_ptr = RNA_pointer_create_discrete(&clip->id, RNA_MovieTrackingTrack, track);
129 }
130 return &track->gpd;
131 }
132 if (r_ptr) {
133 *r_ptr = RNA_id_pointer_create(&clip->id);
134 }
135 return &clip->gpd;
136 }
137 break;
138 }
139 default: /* unsupported space */
140 return nullptr;
141 }
142 }
143
144 return nullptr;
145}
146
148{
149 ID *screen_id = id_cast<ID *>(CTX_wm_screen(C));
150 Scene *scene = CTX_data_scene(C);
151 ScrArea *area = CTX_wm_area(C);
152
153 return ED_annotation_data_get_pointers_direct(screen_id, area, scene, r_ptr);
154}
155/* -------------------------------------------------------- */
156
158{
159 bGPdata **gpd_ptr = ED_annotation_data_get_pointers_direct(screen_id, area, scene, nullptr);
160 return (gpd_ptr) ? *(gpd_ptr) : nullptr;
161}
162
164{
165 bGPdata **gpd_ptr = ED_annotation_data_get_pointers(C, nullptr);
166 return (gpd_ptr) ? *(gpd_ptr) : nullptr;
167}
168
169/* ******************************************************** */
170/* Brush Tool Core */
171
172bool gpencil_stroke_inside_circle(const float mval[2], int rad, int x0, int y0, int x1, int y1)
173{
174 /* simple within-radius check for now */
175 const float screen_co_a[2] = {float(x0), float(y0)};
176 const float screen_co_b[2] = {float(x1), float(y1)};
177
178 if (edge_inside_circle(mval, rad, screen_co_a, screen_co_b)) {
179 return true;
180 }
181
182 /* not inside */
183 return false;
184}
185
186/* ******************************************************** */
187/* Stroke Validity Testing */
188
190{
191 /* sanity check */
192 if (ELEM(nullptr, area, gps)) {
193 return false;
194 }
195
196 /* filter stroke types by flags + spacetype */
197 if (gps->flag & GP_STROKE_3DSPACE) {
198 /* 3D strokes - only in 3D view */
200 }
201 if (gps->flag & GP_STROKE_2DIMAGE) {
202 /* Special "image" strokes - only in Image Editor */
203 return (area->spacetype == SPACE_IMAGE);
204 }
205 if (gps->flag & GP_STROKE_2DSPACE) {
206 /* 2D strokes (data-space) - for any 2D view (i.e. everything other than 3D view). */
207 return (area->spacetype != SPACE_VIEW3D);
208 }
209 /* view aligned - anything goes */
210 return true;
211}
212
213/* ******************************************************** */
214/* Space Conversion */
215
217 const GP_SpaceConversion *gsc, const bGPDstroke *gps, const bGPDspoint *pt, int *r_x, int *r_y)
218{
219 const ARegion *region = gsc->region;
220 const View2D *v2d = gsc->v2d;
221 const rctf *subrect = gsc->subrect;
222 int xyval[2];
223
224 /* sanity checks */
227
228 if (gps->flag & GP_STROKE_3DSPACE) {
230 {
231 *r_x = xyval[0];
232 *r_y = xyval[1];
233 }
234 else {
235 *r_x = V2D_IS_CLIPPED;
236 *r_y = V2D_IS_CLIPPED;
237 }
238 }
239 else if (gps->flag & GP_STROKE_2DSPACE) {
240 float vec[3] = {pt->x, pt->y, 0.0f};
241 mul_m4_v3(gsc->mat, vec);
242 ui::view2d_view_to_region_clip(v2d, vec[0], vec[1], r_x, r_y);
243 }
244 else {
245 if (subrect == nullptr) {
246 /* normal 3D view (or view space) */
247 *r_x = int(pt->x / 100 * region->winx);
248 *r_y = int(pt->y / 100 * region->winy);
249 }
250 else {
251 /* camera view, use subrect */
252 *r_x = int((pt->x / 100) * BLI_rctf_size_x(subrect)) + subrect->xmin;
253 *r_y = int((pt->y / 100) * BLI_rctf_size_y(subrect)) + subrect->ymin;
254 }
255 }
256}
257
259 int *buffer_size,
260 int *buffer_used,
261 const bool clear)
262{
263 tGPspoint *p = nullptr;
264
265 /* By default a buffer is created with one block with a predefined number of free points,
266 * if the size is not enough, the cache is reallocated adding a new block of free points.
267 * This is done in order to keep cache small and improve speed. */
268 if (*buffer_used + 1 > *buffer_size) {
269 if ((*buffer_size == 0) || (buffer_array == nullptr)) {
271 *buffer_size = GP_STROKE_BUFFER_CHUNK;
272 }
273 else {
274 *buffer_size += GP_STROKE_BUFFER_CHUNK;
275 p = static_cast<tGPspoint *>(
276 MEM_realloc_zeroed(buffer_array, sizeof(tGPspoint) * *buffer_size));
277 }
278
279 if (p == nullptr) {
280 *buffer_size = *buffer_used = 0;
281 }
282
283 buffer_array = p;
284 }
285
286 /* clear old data */
287 if (clear) {
288 *buffer_used = 0;
289 if (buffer_array != nullptr) {
290 memset(buffer_array, 0, sizeof(tGPspoint) * *buffer_size);
291 }
292 }
293
294 return buffer_array;
295}
296
297} // namespace blender
Object is a sort of wrapper for general info.
Read Blender memory allocation and freeing.
#define C
Definition RandGen.cpp:29
#define V2D_IS_CLIPPED
Definition UI_view2d.hh:46
#define ELEM(...)
#define MEM_realloc_zeroed(vmemh, len)
#define GP_STROKE_BUFFER_CHUNK
bool view2d_view_to_region_clip(const View2D *v2d, float x, float y, int *r_region_x, int *r_region_y) ATTR_NONNULL()
Definition view2d.cc:1684
BMesh Iterators.
eV3DProjStatus ED_view3d_project_int_global(const ARegion *region, const float co[3], int r_co[2], eV3DProjTest flag)
BLI_assert(slot->slot_subtype.map==BMO_OP_SLOT_SUBTYPE_MAP_FLT)
@ V3D_PROJ_RET_OK
Definition ED_view3d.hh:273
ScrArea * CTX_wm_area(const bContext *C)
PointerRNA RNA_id_pointer_create(ID *id)
bGPdata ** ED_annotation_data_get_pointers(const bContext *C, PointerRNA *r_ptr)
MovieTrackingObject * BKE_tracking_object_get_active(const MovieTracking *tracking)
Definition tracking.cc:1982
bool gpencil_stroke_inside_circle(const float mval[2], int rad, int x0, int y0, int x1, int y1)
bool ED_gpencil_stroke_can_use_direct(const ScrArea *area, const bGPDstroke *gps)
void mul_m4_v3(const float M[4][4], float r[3])
BLI_INLINE float BLI_rctf_size_y(const struct rctf *rct)
Definition BLI_rect.hh:215
PointerRNA RNA_pointer_create_discrete(ID *id, StructRNA *type, void *data)
bGPdata * ED_annotation_data_get_active_direct(ID *screen_id, ScrArea *area, Scene *scene)
bGPdata * ED_annotation_data_get_active(const bContext *C)
bGPdata ** ED_annotation_data_get_pointers_direct(ID *screen_id, ScrArea *area, Scene *scene, PointerRNA *r_ptr)
bool edge_inside_circle(const float cent[2], float radius, const float screen_co_a[2], const float screen_co_b[2])
void gpencil_point_to_xy(const GP_SpaceConversion *gsc, const bGPDstroke *gps, const bGPDspoint *pt, int *r_x, int *r_y)
MovieClip * ED_space_clip_get_clip(const SpaceClip *sc)
BLI_INLINE float BLI_rctf_size_x(const struct rctf *rct)
Definition BLI_rect.hh:211
tGPspoint * ED_gpencil_sbuffer_ensure(tGPspoint *buffer_array, int *buffer_size, int *buffer_used, const bool clear)
@ V3D_PROJ_TEST_NOP
Definition ED_view3d.hh:295
Scene * CTX_data_scene(const bContext *C)
bScreen * CTX_wm_screen(const bContext *C)
void * MEM_new_array_zeroed(size_t len, size_t size, const char *str) ATTR_WARN_UNUSED_RESULT ATTR_ALLOC_SIZE(1
KERNEL_FEATURE_LIGHT_PASSES KERNEL_FEATURE_PATH_GUIDING float
struct MovieTracking tracking
MovieTrackingTrack * active_track
struct bGPdata * gpd
ListBaseT< SpaceLink > spacedata
eSpaceClip_GPencil_Source gpencil_src
struct bGPdata * gpd
struct bNodeTree * nodetree
struct bGPdata * gpd
struct bGPdata * gpd