9da7dfa158
This will allow much finer controll over how we copy data-blocks, from full copy in Main database, to "lighter" ones (out of Main, inside an already allocated datablock, etc.). This commit also transfers a llot of what was previously handled by per-ID-type custom code to generic ID handling code in BKE_library. Hopefully will avoid in future inconsistencies and missing bits we had all over the codebase in the past. It also adds missing copying handling for a few types, most notably Scene (which where using a fully customized handling previously). Note that the type of allocation used during copying (regular in Main, allocated but outside of Main, or not allocated by ID handling code at all) is stored in ID's, which allows to handle them correctly when freeing. This needs to be taken care of with caution when doing 'weird' unusual things with ID copying and/or allocation! As a final note, while rather noisy, this commit will hopefully not break too much existing branches, old 'API' has been kept for the main part, as a wrapper around new code. Cleaning it up will happen later. Design task : T51804 Phab Diff: D2714
180 lines
7.8 KiB
C
180 lines
7.8 KiB
C
/*
|
|
* ***** 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) 2001-2002 by NaN Holding BV.
|
|
* All rights reserved.
|
|
*
|
|
* The Original Code is: all of this file.
|
|
*
|
|
* Contributor(s): none yet.
|
|
*
|
|
* ***** END GPL LICENSE BLOCK *****
|
|
*/
|
|
#ifndef __BKE_SCENE_H__
|
|
#define __BKE_SCENE_H__
|
|
|
|
/** \file BKE_scene.h
|
|
* \ingroup bke
|
|
* \since March 2001
|
|
* \author nzc
|
|
*/
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
struct AviCodecData;
|
|
struct Base;
|
|
struct EvaluationContext;
|
|
struct Main;
|
|
struct Object;
|
|
struct QuicktimeCodecData;
|
|
struct RenderData;
|
|
struct SceneRenderLayer;
|
|
struct Scene;
|
|
struct UnitSettings;
|
|
struct Main;
|
|
|
|
#define SCE_COPY_NEW 0
|
|
#define SCE_COPY_EMPTY 1
|
|
#define SCE_COPY_LINK_OB 2
|
|
#define SCE_COPY_LINK_DATA 3
|
|
#define SCE_COPY_FULL 4
|
|
|
|
/* Use as the contents of a 'for' loop: for (SETLOOPER(...)) { ... */
|
|
#define SETLOOPER(_sce_basis, _sce_iter, _base) \
|
|
_sce_iter = _sce_basis, _base = _setlooper_base_step(&_sce_iter, NULL); \
|
|
_base; \
|
|
_base = _setlooper_base_step(&_sce_iter, _base)
|
|
|
|
struct Base *_setlooper_base_step(struct Scene **sce_iter, struct Base *base);
|
|
|
|
void free_avicodecdata(struct AviCodecData *acd);
|
|
void free_qtcodecdata(struct QuicktimeCodecData *acd);
|
|
|
|
void BKE_scene_free(struct Scene *sce);
|
|
void BKE_scene_init(struct Scene *sce);
|
|
struct Scene *BKE_scene_add(struct Main *bmain, const char *name);
|
|
|
|
/* base functions */
|
|
struct Base *BKE_scene_base_find_by_name(struct Scene *scene, const char *name);
|
|
struct Base *BKE_scene_base_find(struct Scene *scene, struct Object *ob);
|
|
struct Base *BKE_scene_base_add(struct Scene *sce, struct Object *ob);
|
|
void BKE_scene_base_unlink(struct Scene *sce, struct Base *base);
|
|
void BKE_scene_base_deselect_all(struct Scene *sce);
|
|
void BKE_scene_base_select(struct Scene *sce, struct Base *selbase);
|
|
|
|
/* Scene base iteration function.
|
|
* Define struct here, so no need to bother with alloc/free it.
|
|
*/
|
|
typedef struct SceneBaseIter {
|
|
struct ListBase *duplilist;
|
|
struct DupliObject *dupob;
|
|
float omat[4][4];
|
|
struct Object *dupli_refob;
|
|
int phase;
|
|
} SceneBaseIter;
|
|
|
|
int BKE_scene_base_iter_next(struct EvaluationContext *eval_ctx, struct SceneBaseIter *iter,
|
|
struct Scene **scene, int val, struct Base **base, struct Object **ob);
|
|
|
|
void BKE_scene_base_flag_to_objects(struct Scene *scene);
|
|
void BKE_scene_base_flag_from_objects(struct Scene *scene);
|
|
|
|
void BKE_scene_set_background(struct Main *bmain, struct Scene *sce);
|
|
struct Scene *BKE_scene_set_name(struct Main *bmain, const char *name);
|
|
|
|
void BKE_scene_copy_data(struct Main *bmain, struct Scene *sce_dst, const struct Scene *sce_src, const int flag);
|
|
struct Scene *BKE_scene_copy(struct Main *bmain, struct Scene *sce, int type);
|
|
void BKE_scene_groups_relink(struct Scene *sce);
|
|
|
|
void BKE_scene_make_local(struct Main *bmain, struct Scene *sce, const bool lib_local);
|
|
|
|
struct Object *BKE_scene_camera_find(struct Scene *sc);
|
|
#ifdef DURIAN_CAMERA_SWITCH
|
|
struct Object *BKE_scene_camera_switch_find(struct Scene *scene); // DURIAN_CAMERA_SWITCH
|
|
#endif
|
|
int BKE_scene_camera_switch_update(struct Scene *scene);
|
|
|
|
char *BKE_scene_find_marker_name(struct Scene *scene, int frame);
|
|
char *BKE_scene_find_last_marker_name(struct Scene *scene, int frame);
|
|
|
|
/* checks for cycle, returns 1 if it's all OK */
|
|
bool BKE_scene_validate_setscene(struct Main *bmain, struct Scene *sce);
|
|
|
|
float BKE_scene_frame_get(const struct Scene *scene);
|
|
float BKE_scene_frame_get_from_ctime(const struct Scene *scene, const float frame);
|
|
void BKE_scene_frame_set(struct Scene *scene, double cfra);
|
|
|
|
/* ** Scene evaluation ** */
|
|
void BKE_scene_update_tagged(struct EvaluationContext *eval_ctx, struct Main *bmain, struct Scene *sce);
|
|
void BKE_scene_update_for_newframe(struct EvaluationContext *eval_ctx, struct Main *bmain, struct Scene *sce, unsigned int lay);
|
|
void BKE_scene_update_for_newframe_ex(struct EvaluationContext *eval_ctx, struct Main *bmain, struct Scene *sce, unsigned int lay, bool do_invisible_flush);
|
|
|
|
struct SceneRenderLayer *BKE_scene_add_render_layer(struct Scene *sce, const char *name);
|
|
bool BKE_scene_remove_render_layer(struct Main *main, struct Scene *scene, struct SceneRenderLayer *srl);
|
|
|
|
struct SceneRenderView *BKE_scene_add_render_view(struct Scene *sce, const char *name);
|
|
bool BKE_scene_remove_render_view(struct Scene *scene, struct SceneRenderView *srv);
|
|
|
|
/* render profile */
|
|
int get_render_subsurf_level(const struct RenderData *r, int level, bool for_render);
|
|
int get_render_child_particle_number(const struct RenderData *r, int num, bool for_render);
|
|
int get_render_shadow_samples(const struct RenderData *r, int samples);
|
|
float get_render_aosss_error(const struct RenderData *r, float error);
|
|
|
|
bool BKE_scene_use_new_shading_nodes(const struct Scene *scene);
|
|
bool BKE_scene_use_shading_nodes_custom(struct Scene *scene);
|
|
bool BKE_scene_use_world_space_shading(struct Scene *scene);
|
|
bool BKE_scene_use_spherical_stereo(struct Scene *scene);
|
|
|
|
bool BKE_scene_uses_blender_internal(const struct Scene *scene);
|
|
bool BKE_scene_uses_blender_game(const struct Scene *scene);
|
|
|
|
void BKE_scene_disable_color_management(struct Scene *scene);
|
|
bool BKE_scene_check_color_management_enabled(const struct Scene *scene);
|
|
bool BKE_scene_check_rigidbody_active(const struct Scene *scene);
|
|
|
|
int BKE_scene_num_threads(const struct Scene *scene);
|
|
int BKE_render_num_threads(const struct RenderData *r);
|
|
|
|
double BKE_scene_unit_scale(const struct UnitSettings *unit, const int unit_type, double value);
|
|
|
|
/* multiview */
|
|
bool BKE_scene_multiview_is_stereo3d(const struct RenderData *rd);
|
|
bool BKE_scene_multiview_is_render_view_active(const struct RenderData *rd, const struct SceneRenderView *srv);
|
|
bool BKE_scene_multiview_is_render_view_first(const struct RenderData *rd, const char *viewname);
|
|
bool BKE_scene_multiview_is_render_view_last(const struct RenderData *rd, const char *viewname);
|
|
int BKE_scene_multiview_num_views_get(const struct RenderData *rd);
|
|
struct SceneRenderView *BKE_scene_multiview_render_view_findindex(const struct RenderData *rd, const int view_id);
|
|
const char *BKE_scene_multiview_render_view_name_get(const struct RenderData *rd, const int view_id);
|
|
int BKE_scene_multiview_view_id_get(const struct RenderData *rd, const char *viewname);
|
|
void BKE_scene_multiview_filepath_get(struct SceneRenderView *srv, const char *filepath, char *r_filepath);
|
|
void BKE_scene_multiview_view_filepath_get(const struct RenderData *rd, const char *filepath, const char *view, char *r_filepath);
|
|
const char *BKE_scene_multiview_view_suffix_get(const struct RenderData *rd, const char *viewname);
|
|
const char *BKE_scene_multiview_view_id_suffix_get(const struct RenderData *rd, const int view_id);
|
|
void BKE_scene_multiview_view_prefix_get(struct Scene *scene, const char *name, char *rprefix, const char **rext);
|
|
void BKE_scene_multiview_videos_dimensions_get(const struct RenderData *rd, const size_t width, const size_t height, size_t *r_width, size_t *r_height);
|
|
int BKE_scene_multiview_num_videos_get(const struct RenderData *rd);
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
|
|
#endif
|
|
|