Brecht Van Lommel
67b014af48
Both the scene and workspace had an active view layer, and it was confusing which settings were being used or displayed where. Now we always have one, so there is no mismatch. The "View Layers" tab in the properties editor is now "View Layer", no longer showing a list of layers. Instead view layers can be added and removed with the workspace view layer selector. They are also listed and selectable in the outliner. Single layer rendering uses the active view layer from the workspace. This fixes bugs where the wrong active view layer was used, but more places remain that are wrong and are now using the first view layer in the scene. These are all marked with BKE_view_layer_context_active_PLACEHOLDER.
421 lines
19 KiB
C++
421 lines
19 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.
|
|
*
|
|
* Contributor(s): Blender Foundation, Dalai Felinto
|
|
*
|
|
* ***** END GPL LICENSE BLOCK *****
|
|
*/
|
|
|
|
#ifndef __BKE_LAYER_H__
|
|
#define __BKE_LAYER_H__
|
|
|
|
/** \file blender/blenkernel/BKE_layer.h
|
|
* \ingroup bke
|
|
*/
|
|
|
|
#include "BKE_collection.h"
|
|
|
|
#include "DNA_scene_types.h"
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
#define TODO_LAYER_OVERRIDE /* CollectionOverride */
|
|
#define TODO_LAYER_OPERATORS /* collection mamanger and property panel operators */
|
|
#define TODO_LAYER /* generic todo */
|
|
|
|
#define ROOT_PROP "root"
|
|
|
|
struct Base;
|
|
struct Depsgraph;
|
|
struct Group;
|
|
struct ID;
|
|
struct IDProperty;
|
|
struct LayerCollection;
|
|
struct ListBase;
|
|
struct Main;
|
|
struct Object;
|
|
struct RenderEngine;
|
|
struct Scene;
|
|
struct SceneCollection;
|
|
struct ViewLayer;
|
|
struct WorkSpace;
|
|
|
|
void BKE_layer_exit(void);
|
|
|
|
struct ViewLayer *BKE_view_layer_default_view(const struct Scene *scene);
|
|
struct ViewLayer *BKE_view_layer_default_render(const struct Scene *scene);
|
|
struct ViewLayer *BKE_view_layer_from_workspace_get(const struct Scene *scene, const struct WorkSpace *workspace);
|
|
struct ViewLayer *BKE_view_layer_add(struct Scene *scene, const char *name);
|
|
struct ViewLayer *BKE_view_layer_group_add(struct Group *group);
|
|
|
|
/* DEPRECATED */
|
|
struct ViewLayer *BKE_view_layer_context_active_PLACEHOLDER(const struct Scene *scene);
|
|
|
|
void BKE_view_layer_free(struct ViewLayer *view_layer);
|
|
void BKE_view_layer_free_ex(struct ViewLayer *view_layer, const bool do_id_user);
|
|
|
|
void BKE_view_layer_selected_objects_tag(struct ViewLayer *view_layer, const int tag);
|
|
|
|
struct Object *BKE_view_layer_camera_find(struct ViewLayer *view_layer);
|
|
struct ViewLayer *BKE_view_layer_first_from_id(const struct ID *owner_id);
|
|
struct ViewLayer *BKE_view_layer_find_from_collection(const struct ID *owner_id, struct LayerCollection *lc);
|
|
struct Base *BKE_view_layer_base_find(struct ViewLayer *view_layer, struct Object *ob);
|
|
void BKE_view_layer_base_deselect_all(struct ViewLayer *view_layer);
|
|
void BKE_view_layer_base_select(struct ViewLayer *view_layer, struct Base *selbase);
|
|
|
|
void BKE_layer_collection_sync_flags(
|
|
struct ID *owner_id,
|
|
struct SceneCollection *scene_collection_dst,
|
|
struct SceneCollection *scene_collection_src);
|
|
|
|
void BKE_view_layer_copy_data(
|
|
struct ViewLayer *view_layer_dst, struct ViewLayer *view_layer_src,
|
|
struct SceneCollection *mc_dst, struct SceneCollection *mc_src,
|
|
const int flag);
|
|
|
|
struct LayerCollection *BKE_layer_collection_duplicate(struct ID *owner_id, struct LayerCollection *layer_collection);
|
|
|
|
void BKE_layer_collection_free(struct ViewLayer *view_layer, struct LayerCollection *lc);
|
|
|
|
struct LayerCollection *BKE_layer_collection_get_active(struct ViewLayer *view_layer);
|
|
struct LayerCollection *BKE_layer_collection_get_active_ensure(struct Scene *scene, struct ViewLayer *view_layer);
|
|
|
|
int BKE_layer_collection_count(struct ViewLayer *view_layer);
|
|
|
|
struct LayerCollection *BKE_layer_collection_from_index(struct ViewLayer *view_layer, const int index);
|
|
int BKE_layer_collection_findindex(struct ViewLayer *view_layer, const struct LayerCollection *lc);
|
|
|
|
bool BKE_layer_collection_move_above(const struct ID *owner_id, struct LayerCollection *lc_dst, struct LayerCollection *lc_src);
|
|
bool BKE_layer_collection_move_below(const struct ID *owner_id, struct LayerCollection *lc_dst, struct LayerCollection *lc_src);
|
|
bool BKE_layer_collection_move_into(const struct ID *owner_id, struct LayerCollection *lc_dst, struct LayerCollection *lc_src);
|
|
|
|
void BKE_layer_collection_resync(const struct ID *owner_id, const struct SceneCollection *sc);
|
|
|
|
struct LayerCollection *BKE_collection_link(struct ViewLayer *view_layer, struct SceneCollection *sc);
|
|
|
|
void BKE_collection_unlink(struct ViewLayer *view_layer, struct LayerCollection *lc);
|
|
|
|
void BKE_collection_enable(struct ViewLayer *view_layer, struct LayerCollection *lc);
|
|
|
|
struct LayerCollection *BKE_layer_collection_first_from_scene_collection(struct ViewLayer *view_layer, const struct SceneCollection *scene_collection);
|
|
bool BKE_view_layer_has_collection(struct ViewLayer *view_layer, const struct SceneCollection *sc);
|
|
bool BKE_scene_has_object(struct Scene *scene, struct Object *ob);
|
|
|
|
void BKE_layer_collection_objects_select(struct LayerCollection *layer_collection);
|
|
|
|
/* syncing */
|
|
|
|
void BKE_layer_sync_new_scene_collection(struct ID *owner_id, const struct SceneCollection *sc_parent, struct SceneCollection *sc);
|
|
void BKE_layer_sync_object_link(const struct ID *owner_id, struct SceneCollection *sc, struct Object *ob);
|
|
void BKE_layer_sync_object_unlink(const struct ID *owner_id, struct SceneCollection *sc, struct Object *ob);
|
|
|
|
/* override */
|
|
|
|
void BKE_override_view_layer_datablock_add(struct ViewLayer *view_layer, int id_type, const char *data_path, const struct ID *owner_id);
|
|
void BKE_override_view_layer_int_add(struct ViewLayer *view_layer, int id_type, const char *data_path, const int value);
|
|
|
|
void BKE_override_layer_collection_boolean_add(struct LayerCollection *layer_collection, int id_type, const char *data_path, const bool value);
|
|
|
|
/* engine settings */
|
|
typedef void (*EngineSettingsCB)(struct RenderEngine *engine, struct IDProperty *props);
|
|
|
|
struct IDProperty *BKE_layer_collection_engine_evaluated_get(struct Object *ob, const int type, const char *engine_name);
|
|
struct IDProperty *BKE_layer_collection_engine_collection_get(struct LayerCollection *lc, const int type, const char *engine_name);
|
|
struct IDProperty *BKE_layer_collection_engine_scene_get(struct Scene *scene, const int type, const char *engine_name);
|
|
void BKE_layer_collection_engine_settings_callback_register(struct Main *bmain, const char *engine_name, EngineSettingsCB func);
|
|
void BKE_layer_collection_engine_settings_callback_free(void);
|
|
void BKE_layer_collection_engine_settings_create(struct IDProperty *root);
|
|
void BKE_layer_collection_engine_settings_validate_scene(struct Scene *scene);
|
|
void BKE_layer_collection_engine_settings_validate_collection(struct LayerCollection *lc);
|
|
|
|
struct IDProperty *BKE_view_layer_engine_evaluated_get(struct ViewLayer *view_layer, const int type, const char *engine_name);
|
|
struct IDProperty *BKE_view_layer_engine_layer_get(struct ViewLayer *view_layer, const int type, const char *engine_name);
|
|
struct IDProperty *BKE_view_layer_engine_scene_get(struct Scene *scene, const int type, const char *engine_name);
|
|
void BKE_view_layer_engine_settings_callback_register(struct Main *bmain, const char *engine_name, EngineSettingsCB func);
|
|
void BKE_view_layer_engine_settings_callback_free(void);
|
|
void BKE_view_layer_engine_settings_validate_scene(struct Scene *scene);
|
|
void BKE_view_layer_engine_settings_validate_layer(struct ViewLayer *view_layer);
|
|
void BKE_view_layer_engine_settings_create(struct IDProperty *root);
|
|
|
|
void BKE_collection_engine_property_add_float(struct IDProperty *props, const char *name, float value);
|
|
void BKE_collection_engine_property_add_float_array(
|
|
struct IDProperty *props, const char *name, const float *values, const int array_length);
|
|
void BKE_collection_engine_property_add_int(struct IDProperty *props, const char *name, int value);
|
|
void BKE_collection_engine_property_add_bool(struct IDProperty *props, const char *name, bool value);
|
|
|
|
int BKE_collection_engine_property_value_get_int(struct IDProperty *props, const char *name);
|
|
float BKE_collection_engine_property_value_get_float(struct IDProperty *props, const char *name);
|
|
const float *BKE_collection_engine_property_value_get_float_array(struct IDProperty *props, const char *name);
|
|
bool BKE_collection_engine_property_value_get_bool(struct IDProperty *props, const char *name);
|
|
void BKE_collection_engine_property_value_set_int(struct IDProperty *props, const char *name, int value);
|
|
void BKE_collection_engine_property_value_set_float(struct IDProperty *props, const char *name, float value);
|
|
void BKE_collection_engine_property_value_set_float_array(struct IDProperty *props, const char *name, const float *values);
|
|
void BKE_collection_engine_property_value_set_bool(struct IDProperty *props, const char *name, bool value);
|
|
|
|
/* evaluation */
|
|
|
|
void BKE_layer_eval_view_layer(
|
|
struct Depsgraph *depsgraph,
|
|
struct ID *owner_id,
|
|
struct ViewLayer *view_layer);
|
|
|
|
void BKE_layer_eval_view_layer_indexed(
|
|
struct Depsgraph *depsgraph,
|
|
struct ID *owner_id,
|
|
int view_layer_index);
|
|
|
|
/* iterators */
|
|
|
|
void BKE_view_layer_selected_objects_iterator_begin(BLI_Iterator *iter, void *data_in);
|
|
void BKE_view_layer_selected_objects_iterator_next(BLI_Iterator *iter);
|
|
void BKE_view_layer_selected_objects_iterator_end(BLI_Iterator *iter);
|
|
|
|
void BKE_view_layer_visible_objects_iterator_begin(BLI_Iterator *iter, void *data_in);
|
|
void BKE_view_layer_visible_objects_iterator_next(BLI_Iterator *iter);
|
|
void BKE_view_layer_visible_objects_iterator_end(BLI_Iterator *iter);
|
|
|
|
struct ObjectsInModeIteratorData {
|
|
int object_mode;
|
|
struct ViewLayer *view_layer;
|
|
struct Base *base_active;
|
|
};
|
|
|
|
void BKE_view_layer_renderable_objects_iterator_begin(BLI_Iterator *iter, void *data_in);
|
|
void BKE_view_layer_renderable_objects_iterator_next(BLI_Iterator *iter);
|
|
void BKE_view_layer_renderable_objects_iterator_end(BLI_Iterator *iter);
|
|
|
|
void BKE_view_layer_bases_in_mode_iterator_begin(BLI_Iterator *iter, void *data_in);
|
|
void BKE_view_layer_bases_in_mode_iterator_next(BLI_Iterator *iter);
|
|
void BKE_view_layer_bases_in_mode_iterator_end(BLI_Iterator *iter);
|
|
|
|
void BKE_view_layer_selected_bases_iterator_begin(BLI_Iterator *iter, void *data_in);
|
|
void BKE_view_layer_selected_bases_iterator_next(BLI_Iterator *iter);
|
|
void BKE_view_layer_selected_bases_iterator_end(BLI_Iterator *iter);
|
|
|
|
void BKE_view_layer_visible_bases_iterator_begin(BLI_Iterator *iter, void *data_in);
|
|
void BKE_view_layer_visible_bases_iterator_next(BLI_Iterator *iter);
|
|
void BKE_view_layer_visible_bases_iterator_end(BLI_Iterator *iter);
|
|
|
|
#define FOREACH_SELECTED_OBJECT_BEGIN(view_layer, _instance) \
|
|
ITER_BEGIN(BKE_view_layer_selected_objects_iterator_begin, \
|
|
BKE_view_layer_selected_objects_iterator_next, \
|
|
BKE_view_layer_selected_objects_iterator_end, \
|
|
view_layer, Object *, _instance)
|
|
|
|
#define FOREACH_SELECTED_OBJECT_END \
|
|
ITER_END
|
|
|
|
#define FOREACH_VISIBLE_OBJECT_BEGIN(view_layer, _instance) \
|
|
ITER_BEGIN(BKE_view_layer_visible_objects_iterator_begin, \
|
|
BKE_view_layer_visible_objects_iterator_next, \
|
|
BKE_view_layer_visible_objects_iterator_end, \
|
|
view_layer, Object *, _instance)
|
|
|
|
#define FOREACH_VISIBLE_OBJECT_END \
|
|
ITER_END
|
|
|
|
|
|
#define FOREACH_BASE_IN_MODE_BEGIN(_view_layer, _object_mode, _instance) \
|
|
{ \
|
|
struct ObjectsInModeIteratorData data_ = { \
|
|
.object_mode = _object_mode, \
|
|
.view_layer = _view_layer, \
|
|
.base_active = _view_layer->basact, \
|
|
}; \
|
|
ITER_BEGIN(BKE_view_layer_bases_in_mode_iterator_begin, \
|
|
BKE_view_layer_bases_in_mode_iterator_next, \
|
|
BKE_view_layer_bases_in_mode_iterator_end, \
|
|
&data_, Base *, _instance)
|
|
|
|
#define FOREACH_BASE_IN_MODE_END \
|
|
ITER_END; \
|
|
} ((void)0)
|
|
|
|
#define FOREACH_BASE_IN_EDIT_MODE_BEGIN(_view_layer, _instance) \
|
|
FOREACH_BASE_IN_MODE_BEGIN(_view_layer, OB_MODE_EDIT, _instance)
|
|
|
|
#define FOREACH_BASE_IN_EDIT_MODE_END \
|
|
FOREACH_BASE_IN_MODE_END
|
|
|
|
#define FOREACH_OBJECT_IN_MODE_BEGIN(_view_layer, _object_mode, _instance) \
|
|
FOREACH_BASE_IN_MODE_BEGIN(_view_layer, _object_mode, _base) { \
|
|
Object *_instance = _base->object;
|
|
|
|
#define FOREACH_OBJECT_IN_MODE_END \
|
|
} FOREACH_BASE_IN_MODE_END
|
|
|
|
#define FOREACH_OBJECT_IN_EDIT_MODE_BEGIN(_view_layer, _instance) \
|
|
FOREACH_BASE_IN_EDIT_MODE_BEGIN(_view_layer, _base) { \
|
|
Object *_instance = _base->object;
|
|
|
|
#define FOREACH_OBJECT_IN_EDIT_MODE_END \
|
|
} FOREACH_BASE_IN_EDIT_MODE_END
|
|
|
|
#define FOREACH_SELECTED_BASE_BEGIN(view_layer, _instance) \
|
|
ITER_BEGIN(BKE_view_layer_selected_bases_iterator_begin, \
|
|
BKE_view_layer_selected_bases_iterator_next, \
|
|
BKE_view_layer_selected_bases_iterator_end, \
|
|
view_layer, Base *, _instance)
|
|
|
|
#define FOREACH_SELECTED_BASE_END \
|
|
ITER_END
|
|
|
|
#define FOREACH_VISIBLE_BASE_BEGIN(view_layer, _instance) \
|
|
ITER_BEGIN(BKE_view_layer_visible_bases_iterator_begin, \
|
|
BKE_view_layer_visible_bases_iterator_next, \
|
|
BKE_view_layer_visible_bases_iterator_end, \
|
|
view_layer, Base *, _instance)
|
|
|
|
#define FOREACH_VISIBLE_BASE_END \
|
|
ITER_END
|
|
|
|
|
|
#define FOREACH_OBJECT_BEGIN(view_layer, _instance) \
|
|
{ \
|
|
Object *_instance; \
|
|
Base *_base; \
|
|
for (_base = (view_layer)->object_bases.first; _base; _base = _base->next) { \
|
|
_instance = _base->object;
|
|
|
|
#define FOREACH_OBJECT_END \
|
|
} \
|
|
} ((void)0)
|
|
|
|
#define FOREACH_OBJECT_FLAG_BEGIN(scene, view_layer, flag, _instance) \
|
|
{ \
|
|
IteratorBeginCb func_begin; \
|
|
IteratorCb func_next, func_end; \
|
|
void *data_in; \
|
|
\
|
|
if (flag == SELECT) { \
|
|
func_begin = &BKE_view_layer_selected_objects_iterator_begin; \
|
|
func_next = &BKE_view_layer_selected_objects_iterator_next; \
|
|
func_end = &BKE_view_layer_selected_objects_iterator_end; \
|
|
data_in = (view_layer); \
|
|
} \
|
|
else { \
|
|
func_begin = BKE_scene_objects_iterator_begin; \
|
|
func_next = BKE_scene_objects_iterator_next; \
|
|
func_end = BKE_scene_objects_iterator_end; \
|
|
data_in = (scene); \
|
|
} \
|
|
ITER_BEGIN(func_begin, func_next, func_end, data_in, Object *, _instance)
|
|
|
|
|
|
#define FOREACH_OBJECT_FLAG_END \
|
|
ITER_END; \
|
|
} ((void)0)
|
|
|
|
struct ObjectsRenderableIteratorData {
|
|
struct Scene *scene;
|
|
struct Base base_temp;
|
|
struct Scene scene_temp;
|
|
|
|
struct {
|
|
struct ViewLayer *view_layer;
|
|
struct Base *base;
|
|
struct Scene *set;
|
|
} iter;
|
|
};
|
|
|
|
#define FOREACH_OBJECT_RENDERABLE_BEGIN(scene_, _instance) \
|
|
{ \
|
|
struct ObjectsRenderableIteratorData data_ = { \
|
|
.scene = (scene_), \
|
|
}; \
|
|
ITER_BEGIN(BKE_view_layer_renderable_objects_iterator_begin, \
|
|
BKE_view_layer_renderable_objects_iterator_next, \
|
|
BKE_view_layer_renderable_objects_iterator_end, \
|
|
&data_, Object *, _instance)
|
|
|
|
|
|
#define FOREACH_OBJECT_RENDERABLE_END \
|
|
ITER_END; \
|
|
} ((void)0)
|
|
|
|
|
|
/* layer_utils.c */
|
|
|
|
struct ObjectsInModeParams {
|
|
int object_mode;
|
|
uint no_dup_data : 1;
|
|
|
|
bool (*filter_fn)(struct Object *ob, void *user_data);
|
|
void *filter_userdata;
|
|
};
|
|
|
|
Base **BKE_view_layer_array_from_bases_in_mode_params(
|
|
struct ViewLayer *view_layer, uint *r_len,
|
|
const struct ObjectsInModeParams *params);
|
|
|
|
struct Object **BKE_view_layer_array_from_objects_in_mode_params(
|
|
struct ViewLayer *view_layer, uint *len,
|
|
const struct ObjectsInModeParams *params);
|
|
|
|
#define BKE_view_layer_array_from_objects_in_mode(view_layer, r_len, ...) \
|
|
BKE_view_layer_array_from_objects_in_mode_params( \
|
|
view_layer, r_len, \
|
|
&(const struct ObjectsInModeParams)__VA_ARGS__)
|
|
|
|
#define BKE_view_layer_array_from_bases_in_mode(view_layer, r_len, ...) \
|
|
BKE_view_layer_array_from_bases_in_mode_params( \
|
|
view_layer, r_len, \
|
|
&(const struct ObjectsInModeParams)__VA_ARGS__)
|
|
|
|
bool BKE_view_layer_filter_edit_mesh_has_uvs(struct Object *ob, void *user_data);
|
|
bool BKE_view_layer_filter_edit_mesh_has_edges(struct Object *ob, void *user_data);
|
|
|
|
/* Utility macros that wrap common args (add more as needed). */
|
|
|
|
#define BKE_view_layer_array_from_objects_in_edit_mode(view_layer, r_len) \
|
|
BKE_view_layer_array_from_objects_in_mode( \
|
|
view_layer, r_len, { \
|
|
.object_mode = OB_MODE_EDIT});
|
|
|
|
#define BKE_view_layer_array_from_bases_in_edit_mode(view_layer, r_len) \
|
|
BKE_view_layer_array_from_bases_in_mode( \
|
|
view_layer, r_len, { \
|
|
.object_mode = OB_MODE_EDIT});
|
|
|
|
#define BKE_view_layer_array_from_objects_in_edit_mode_unique_data(view_layer, r_len) \
|
|
BKE_view_layer_array_from_objects_in_mode( \
|
|
view_layer, r_len, { \
|
|
.object_mode = OB_MODE_EDIT, \
|
|
.no_dup_data = true});
|
|
|
|
#define BKE_view_layer_array_from_bases_in_edit_mode_unique_data(view_layer, r_len) \
|
|
BKE_view_layer_array_from_bases_in_mode( \
|
|
view_layer, r_len, { \
|
|
.object_mode = OB_MODE_EDIT, \
|
|
.no_dup_data = true});
|
|
|
|
#define BKE_view_layer_array_from_objects_in_edit_mode_unique_data_with_uvs(view_layer, r_len) \
|
|
BKE_view_layer_array_from_objects_in_mode( \
|
|
view_layer, r_len, { \
|
|
.object_mode = OB_MODE_EDIT, \
|
|
.no_dup_data = true, \
|
|
.filter_fn = BKE_view_layer_filter_edit_mesh_has_uvs});
|
|
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
|
|
#endif /* __BKE_LAYER_H__ */
|