1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
|
/*
* 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) 2009 Blender Foundation.
* All rights reserved.
*/
/** \file
* \ingroup RNA
*/
#include <stdio.h>
#include <stdlib.h>
#include "BLI_kdopbvh.h"
#include "BLI_path_util.h"
#include "BLI_utildefines.h"
#include "RNA_define.h"
#include "RNA_enum_types.h"
#include "DNA_anim_types.h"
#include "DNA_object_types.h"
#include "DNA_scene_types.h"
#include "rna_internal.h" /* own include */
#ifdef WITH_ALEMBIC
# include "ABC_alembic.h"
#endif
#ifdef RNA_RUNTIME
# include "BKE_editmesh.h"
# include "BKE_global.h"
# include "BKE_image.h"
# include "BKE_scene.h"
# include "BKE_writeavi.h"
# include "DEG_depsgraph_query.h"
# include "ED_transform.h"
# include "ED_transform_snap_object_context.h"
# include "ED_uvedit.h"
# ifdef WITH_PYTHON
# include "BPY_extern.h"
# endif
static void rna_Scene_frame_set(Scene *scene, Main *bmain, int frame, float subframe)
{
double cfra = (double)frame + (double)subframe;
CLAMP(cfra, MINAFRAME, MAXFRAME);
BKE_scene_frame_set(scene, cfra);
# ifdef WITH_PYTHON
BPy_BEGIN_ALLOW_THREADS;
# endif
for (ViewLayer *view_layer = scene->view_layers.first; view_layer != NULL;
view_layer = view_layer->next) {
Depsgraph *depsgraph = BKE_scene_ensure_depsgraph(bmain, scene, view_layer);
BKE_scene_graph_update_for_newframe(depsgraph);
}
# ifdef WITH_PYTHON
BPy_END_ALLOW_THREADS;
# endif
if (BKE_scene_camera_switch_update(scene)) {
for (bScreen *screen = bmain->screens.first; screen; screen = screen->id.next) {
BKE_screen_view3d_scene_sync(screen, scene);
}
}
/* don't do notifier when we're rendering, avoid some viewport crashes
* redrawing while the data is being modified for render */
if (!G.is_rendering) {
/* cant use NC_SCENE|ND_FRAME because this causes wm_event_do_notifiers to call
* BKE_scene_graph_update_for_newframe which will lose any un-keyed changes T24690. */
/* WM_main_add_notifier(NC_SCENE|ND_FRAME, scene); */
/* instead just redraw the views */
WM_main_add_notifier(NC_WINDOW, NULL);
}
}
static void rna_Scene_uvedit_aspect(Scene *UNUSED(scene), Object *ob, float *aspect)
{
if ((ob->type == OB_MESH) && (ob->mode == OB_MODE_EDIT)) {
BMEditMesh *em;
em = BKE_editmesh_from_object(ob);
if (EDBM_uv_check(em)) {
ED_uvedit_get_aspect(ob, aspect, aspect + 1);
return;
}
}
aspect[0] = aspect[1] = 1.0f;
}
static void rna_SceneRender_get_frame_path(
RenderData *rd, Main *bmain, int frame, bool preview, const char *view, char *name)
{
const char *suffix = BKE_scene_multiview_view_suffix_get(rd, view);
/* avoid NULL pointer */
if (!suffix) {
suffix = "";
}
if (BKE_imtype_is_movie(rd->im_format.imtype)) {
BKE_movie_filepath_get(name, rd, preview != 0, suffix);
}
else {
BKE_image_path_from_imformat(name,
rd->pic,
BKE_main_blendfile_path(bmain),
(frame == INT_MIN) ? rd->cfra : frame,
&rd->im_format,
(rd->scemode & R_EXTENSION) != 0,
true,
suffix);
}
}
static void rna_Scene_ray_cast(Scene *scene,
Depsgraph *depsgraph,
float origin[3],
float direction[3],
float ray_dist,
bool *r_success,
float r_location[3],
float r_normal[3],
int *r_index,
Object **r_ob,
float r_obmat[16])
{
normalize_v3(direction);
SnapObjectContext *sctx = ED_transform_snap_object_context_create(scene, 0);
bool ret = ED_transform_snap_object_project_ray_ex(sctx,
depsgraph,
&(const struct SnapObjectParams){
.snap_select = SNAP_ALL,
},
origin,
direction,
&ray_dist,
r_location,
r_normal,
r_index,
r_ob,
(float(*)[4])r_obmat);
ED_transform_snap_object_context_destroy(sctx);
if (r_ob != NULL && *r_ob != NULL) {
*r_ob = DEG_get_original_object(*r_ob);
}
if (ret) {
*r_success = true;
}
else {
*r_success = false;
unit_m4((float(*)[4])r_obmat);
zero_v3(r_location);
zero_v3(r_normal);
}
}
static void rna_Scene_sequencer_editing_free(Scene *scene)
{
SEQ_editing_free(scene, true);
}
# ifdef WITH_ALEMBIC
static void rna_Scene_alembic_export(Scene *scene,
bContext *C,
const char *filepath,
int frame_start,
int frame_end,
int xform_samples,
int geom_samples,
float shutter_open,
float shutter_close,
bool selected_only,
bool uvs,
bool normals,
bool vcolors,
bool apply_subdiv,
bool flatten_hierarchy,
bool visible_objects_only,
bool renderable_only,
bool face_sets,
bool use_subdiv_schema,
bool export_hair,
bool export_particles,
bool packuv,
float scale,
bool triangulate,
int quad_method,
int ngon_method)
{
/* We have to enable allow_threads, because we may change scene frame number
* during export. */
# ifdef WITH_PYTHON
BPy_BEGIN_ALLOW_THREADS;
# endif
const struct AlembicExportParams params = {
.frame_start = frame_start,
.frame_end = frame_end,
.frame_samples_xform = xform_samples,
.frame_samples_shape = geom_samples,
.shutter_open = shutter_open,
.shutter_close = shutter_close,
.selected_only = selected_only,
.uvs = uvs,
.normals = normals,
.vcolors = vcolors,
.apply_subdiv = apply_subdiv,
.flatten_hierarchy = flatten_hierarchy,
.visible_objects_only = visible_objects_only,
.renderable_only = renderable_only,
.face_sets = face_sets,
.use_subdiv_schema = use_subdiv_schema,
.export_hair = export_hair,
.export_particles = export_particles,
.packuv = packuv,
.triangulate = triangulate,
.quad_method = quad_method,
.ngon_method = ngon_method,
.global_scale = scale,
};
ABC_export(scene, C, filepath, ¶ms, true);
# ifdef WITH_PYTHON
BPy_END_ALLOW_THREADS;
# endif
}
# endif
#else
void RNA_api_scene(StructRNA *srna)
{
FunctionRNA *func;
PropertyRNA *parm;
func = RNA_def_function(srna, "frame_set", "rna_Scene_frame_set");
RNA_def_function_ui_description(func, "Set scene frame updating all objects immediately");
parm = RNA_def_int(
func, "frame", 0, MINAFRAME, MAXFRAME, "", "Frame number to set", MINAFRAME, MAXFRAME);
RNA_def_parameter_flags(parm, 0, PARM_REQUIRED);
RNA_def_float(
func, "subframe", 0.0, 0.0, 1.0, "", "Sub-frame time, between 0.0 and 1.0", 0.0, 1.0);
RNA_def_function_flag(func, FUNC_USE_MAIN);
func = RNA_def_function(srna, "uvedit_aspect", "rna_Scene_uvedit_aspect");
RNA_def_function_ui_description(func, "Get uv aspect for current object");
parm = RNA_def_pointer(func, "object", "Object", "", "Object");
RNA_def_parameter_flags(parm, PROP_NEVER_NULL, PARM_REQUIRED);
parm = RNA_def_float_vector(func, "result", 2, NULL, 0.0f, FLT_MAX, "", "aspect", 0.0f, FLT_MAX);
RNA_def_parameter_flags(parm, PROP_THICK_WRAP, 0);
RNA_def_function_output(func, parm);
/* Ray Cast */
func = RNA_def_function(srna, "ray_cast", "rna_Scene_ray_cast");
RNA_def_function_ui_description(func, "Cast a ray onto in object space");
parm = RNA_def_pointer(func, "depsgraph", "Depsgraph", "", "The current dependency graph");
RNA_def_parameter_flags(parm, PROP_NEVER_NULL, PARM_REQUIRED);
/* ray start and end */
parm = RNA_def_float_vector(func, "origin", 3, NULL, -FLT_MAX, FLT_MAX, "", "", -1e4, 1e4);
RNA_def_parameter_flags(parm, 0, PARM_REQUIRED);
parm = RNA_def_float_vector(func, "direction", 3, NULL, -FLT_MAX, FLT_MAX, "", "", -1e4, 1e4);
RNA_def_parameter_flags(parm, 0, PARM_REQUIRED);
RNA_def_float(func,
"distance",
BVH_RAYCAST_DIST_MAX,
0.0,
BVH_RAYCAST_DIST_MAX,
"",
"Maximum distance",
0.0,
BVH_RAYCAST_DIST_MAX);
/* return location and normal */
parm = RNA_def_boolean(func, "result", 0, "", "");
RNA_def_function_output(func, parm);
parm = RNA_def_float_vector(func,
"location",
3,
NULL,
-FLT_MAX,
FLT_MAX,
"Location",
"The hit location of this ray cast",
-1e4,
1e4);
RNA_def_parameter_flags(parm, PROP_THICK_WRAP, 0);
RNA_def_function_output(func, parm);
parm = RNA_def_float_vector(func,
"normal",
3,
NULL,
-FLT_MAX,
FLT_MAX,
"Normal",
"The face normal at the ray cast hit location",
-1e4,
1e4);
RNA_def_parameter_flags(parm, PROP_THICK_WRAP, 0);
RNA_def_function_output(func, parm);
parm = RNA_def_int(
func, "index", 0, 0, 0, "", "The face index, -1 when original data isn't available", 0, 0);
RNA_def_function_output(func, parm);
parm = RNA_def_pointer(func, "object", "Object", "", "Ray cast object");
RNA_def_function_output(func, parm);
parm = RNA_def_float_matrix(func, "matrix", 4, 4, NULL, 0.0f, 0.0f, "", "Matrix", 0.0f, 0.0f);
RNA_def_function_output(func, parm);
/* Sequencer. */
func = RNA_def_function(srna, "sequence_editor_create", "SEQ_editing_ensure");
RNA_def_function_ui_description(func, "Ensure sequence editor is valid in this scene");
parm = RNA_def_pointer(
func, "sequence_editor", "SequenceEditor", "", "New sequence editor data or NULL");
RNA_def_function_return(func, parm);
func = RNA_def_function(srna, "sequence_editor_clear", "rna_Scene_sequencer_editing_free");
RNA_def_function_ui_description(func, "Clear sequence editor in this scene");
# ifdef WITH_ALEMBIC
/* XXX Deprecated, will be removed in 2.8 in favor of calling the export operator. */
func = RNA_def_function(srna, "alembic_export", "rna_Scene_alembic_export");
RNA_def_function_ui_description(
func, "Export to Alembic file (deprecated, use the Alembic export operator)");
parm = RNA_def_string(
func, "filepath", NULL, FILE_MAX, "File Path", "File path to write Alembic file");
RNA_def_parameter_flags(parm, 0, PARM_REQUIRED);
RNA_def_property_subtype(parm, PROP_FILEPATH); /* allow non utf8 */
RNA_def_int(func, "frame_start", 1, INT_MIN, INT_MAX, "Start", "Start Frame", INT_MIN, INT_MAX);
RNA_def_int(func, "frame_end", 1, INT_MIN, INT_MAX, "End", "End Frame", INT_MIN, INT_MAX);
RNA_def_int(
func, "xform_samples", 1, 1, 128, "Xform samples", "Transform samples per frame", 1, 128);
RNA_def_int(
func, "geom_samples", 1, 1, 128, "Geom samples", "Geometry samples per frame", 1, 128);
RNA_def_float(func, "shutter_open", 0.0f, -1.0f, 1.0f, "Shutter open", "", -1.0f, 1.0f);
RNA_def_float(func, "shutter_close", 1.0f, -1.0f, 1.0f, "Shutter close", "", -1.0f, 1.0f);
RNA_def_boolean(func, "selected_only", 0, "Selected only", "Export only selected objects");
RNA_def_boolean(func, "uvs", 1, "UVs", "Export UVs");
RNA_def_boolean(func, "normals", 1, "Normals", "Export normals");
RNA_def_boolean(func, "vcolors", 0, "Vertex colors", "Export vertex colors");
RNA_def_boolean(
func, "apply_subdiv", 1, "Subsurfs as meshes", "Export subdivision surfaces as meshes");
RNA_def_boolean(func, "flatten", 0, "Flatten hierarchy", "Flatten hierarchy");
RNA_def_boolean(func,
"visible_objects_only",
0,
"Visible layers only",
"Export only objects in visible layers");
RNA_def_boolean(func,
"renderable_only",
0,
"Renderable objects only",
"Export only objects marked renderable in the outliner");
RNA_def_boolean(func, "face_sets", 0, "Facesets", "Export face sets");
RNA_def_boolean(func,
"subdiv_schema",
0,
"Use Alembic subdivision Schema",
"Use Alembic subdivision Schema");
RNA_def_boolean(
func, "export_hair", 1, "Export Hair", "Exports hair particle systems as animated curves");
RNA_def_boolean(
func, "export_particles", 1, "Export Particles", "Exports non-hair particle systems");
RNA_def_boolean(
func, "packuv", 0, "Export with packed UV islands", "Export with packed UV islands");
RNA_def_float(
func,
"scale",
1.0f,
0.0001f,
1000.0f,
"Scale",
"Value by which to enlarge or shrink the objects with respect to the world's origin",
0.0001f,
1000.0f);
RNA_def_boolean(
func, "triangulate", 0, "Triangulate", "Export Polygons (Quads & NGons) as Triangles");
RNA_def_enum(func,
"quad_method",
rna_enum_modifier_triangulate_quad_method_items,
0,
"Quad Method",
"Method for splitting the quads into triangles");
RNA_def_enum(func,
"ngon_method",
rna_enum_modifier_triangulate_quad_method_items,
0,
"Polygon Method",
"Method for splitting the polygons into triangles");
RNA_def_function_flag(func, FUNC_USE_CONTEXT);
# endif
}
void RNA_api_scene_render(StructRNA *srna)
{
FunctionRNA *func;
PropertyRNA *parm;
func = RNA_def_function(srna, "frame_path", "rna_SceneRender_get_frame_path");
RNA_def_function_flag(func, FUNC_USE_MAIN);
RNA_def_function_ui_description(
func, "Return the absolute path to the filename to be written for a given frame");
RNA_def_int(func,
"frame",
INT_MIN,
INT_MIN,
INT_MAX,
"",
"Frame number to use, if unset the current frame will be used",
MINAFRAME,
MAXFRAME);
RNA_def_boolean(func, "preview", 0, "Preview", "Use preview range");
RNA_def_string_file_path(func,
"view",
NULL,
FILE_MAX,
"View",
"The name of the view to use to replace the \"%\" chars");
parm = RNA_def_string_file_path(func,
"filepath",
NULL,
FILE_MAX,
"File Path",
"The resulting filepath from the scenes render settings");
RNA_def_parameter_flags(parm, PROP_THICK_WRAP, 0); /* needed for string return value */
RNA_def_function_output(func, parm);
}
#endif
|