Cleanup: Use BLI_layer / BLI_view_layer prefix

Also use doxy sections for iterators.
This commit is contained in:
Campbell Barton
2018-04-18 21:01:55 +02:00
parent 69c42ad57b
commit 75133f5d7c
2 changed files with 109 additions and 71 deletions

View File

@@ -169,23 +169,25 @@ void BKE_collection_engine_property_value_set_bool(struct IDProperty *props, con
/* evaluation */
void BKE_layer_eval_view_layer(struct Depsgraph *depsgraph,
struct ID *owner_id,
struct ViewLayer *view_layer);
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);
void BKE_layer_eval_view_layer_indexed(
struct Depsgraph *depsgraph,
struct ID *owner_id,
int view_layer_index);
/* iterators */
void BKE_selected_objects_iterator_begin(BLI_Iterator *iter, void *data_in);
void BKE_selected_objects_iterator_next(BLI_Iterator *iter);
void BKE_selected_objects_iterator_end(BLI_Iterator *iter);
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_visible_objects_iterator_begin(BLI_Iterator *iter, void *data_in);
void BKE_visible_objects_iterator_next(BLI_Iterator *iter);
void BKE_visible_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;
@@ -193,51 +195,51 @@ struct ObjectsInModeIteratorData {
struct Base *base_active;
};
void BKE_renderable_objects_iterator_begin(BLI_Iterator *iter, void *data_in);
void BKE_renderable_objects_iterator_next(BLI_Iterator *iter);
void BKE_renderable_objects_iterator_end(BLI_Iterator *iter);
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_objects_in_mode_iterator_begin(BLI_Iterator *iter, void *data_in);
void BKE_view_layer_objects_in_mode_iterator_next(BLI_Iterator *iter);
void BKE_view_layer_objects_in_mode_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_selected_bases_iterator_begin(BLI_Iterator *iter, void *data_in);
void BKE_selected_bases_iterator_next(BLI_Iterator *iter);
void BKE_selected_bases_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_visible_bases_iterator_begin(BLI_Iterator *iter, void *data_in);
void BKE_visible_bases_iterator_next(BLI_Iterator *iter);
void BKE_visible_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_selected_objects_iterator_begin, \
BKE_selected_objects_iterator_next, \
BKE_selected_objects_iterator_end, \
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_visible_objects_iterator_begin, \
BKE_visible_objects_iterator_next, \
BKE_visible_objects_iterator_end, \
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) \
#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_objects_in_mode_iterator_begin, \
BKE_view_layer_objects_in_mode_iterator_next, \
BKE_view_layer_objects_in_mode_iterator_end, \
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 \
@@ -261,22 +263,22 @@ void BKE_visible_bases_iterator_end(BLI_Iterator *iter);
FOREACH_BASE_IN_EDIT_MODE_BEGIN(_view_layer, _base) { \
Object *_instance = _base->object;
#define FOREACH_OBJECT_IN_EDIT_MODE_END \
#define FOREACH_OBJECT_IN_EDIT_MODE_END \
} FOREACH_BASE_IN_EDIT_MODE_END
#define FOREACH_SELECTED_BASE_BEGIN(view_layer, _instance) \
ITER_BEGIN(BKE_selected_bases_iterator_begin, \
BKE_selected_bases_iterator_next, \
BKE_selected_bases_iterator_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 \
#define FOREACH_SELECTED_BASE_END \
ITER_END
#define FOREACH_VISIBLE_BASE_BEGIN(view_layer, _instance) \
ITER_BEGIN(BKE_visible_bases_iterator_begin, \
BKE_visible_bases_iterator_next, \
BKE_visible_bases_iterator_end, \
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 \
@@ -301,9 +303,9 @@ void BKE_visible_bases_iterator_end(BLI_Iterator *iter);
void *data_in; \
\
if (flag == SELECT) { \
func_begin = &BKE_selected_objects_iterator_begin; \
func_next = &BKE_selected_objects_iterator_next; \
func_end = &BKE_selected_objects_iterator_end; \
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 { \
@@ -333,12 +335,12 @@ struct ObjectsRenderableIteratorData {
#define FOREACH_OBJECT_RENDERABLE_BEGIN(scene_, _instance) \
{ \
struct ObjectsRenderableIteratorData data_ = { \
struct ObjectsRenderableIteratorData data_ = { \
.scene = (scene_), \
}; \
ITER_BEGIN(BKE_renderable_objects_iterator_begin, \
BKE_renderable_objects_iterator_next, \
BKE_renderable_objects_iterator_end, \
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)

View File

@@ -2035,9 +2035,14 @@ void BKE_view_layer_engine_settings_validate_layer(ViewLayer *view_layer)
IDP_MergeGroup(view_layer->properties, root_reference.view_layer, false);
}
/* ---------------------------------------------------------------------- */
/** \} */
/* Iterators */
/* -------------------------------------------------------------------- */
/** \name Private Iterator Helpers
* \{ */
static void object_bases_iterator_begin(BLI_Iterator *iter, void *data_in, const int flag)
{
ViewLayer *view_layer = data_in;
@@ -2093,67 +2098,96 @@ static void objects_iterator_next(BLI_Iterator *iter, const int flag)
}
}
void BKE_selected_objects_iterator_begin(BLI_Iterator *iter, void *data_in)
/* -------------------------------------------------------------------- */
/** \name BKE_view_layer_selected_objects_iterator
* See: #FOREACH_SELECTED_OBJECT_BEGIN
* \{ */
void BKE_view_layer_selected_objects_iterator_begin(BLI_Iterator *iter, void *data_in)
{
objects_iterator_begin(iter, data_in, BASE_SELECTED);
}
void BKE_selected_objects_iterator_next(BLI_Iterator *iter)
void BKE_view_layer_selected_objects_iterator_next(BLI_Iterator *iter)
{
objects_iterator_next(iter, BASE_SELECTED);
}
void BKE_selected_objects_iterator_end(BLI_Iterator *UNUSED(iter))
void BKE_view_layer_selected_objects_iterator_end(BLI_Iterator *UNUSED(iter))
{
/* do nothing */
}
void BKE_visible_objects_iterator_begin(BLI_Iterator *iter, void *data_in)
/** \} */
/* -------------------------------------------------------------------- */
/** \name BKE_view_layer_selected_objects_iterator
* \{ */
void BKE_view_layer_visible_objects_iterator_begin(BLI_Iterator *iter, void *data_in)
{
objects_iterator_begin(iter, data_in, BASE_VISIBLED);
}
void BKE_visible_objects_iterator_next(BLI_Iterator *iter)
void BKE_view_layer_visible_objects_iterator_next(BLI_Iterator *iter)
{
objects_iterator_next(iter, BASE_VISIBLED);
}
void BKE_visible_objects_iterator_end(BLI_Iterator *UNUSED(iter))
void BKE_view_layer_visible_objects_iterator_end(BLI_Iterator *UNUSED(iter))
{
/* do nothing */
}
void BKE_selected_bases_iterator_begin(BLI_Iterator *iter, void *data_in)
/** \} */
/* -------------------------------------------------------------------- */
/** \name BKE_view_layer_selected_bases_iterator
* \{ */
void BKE_view_layer_selected_bases_iterator_begin(BLI_Iterator *iter, void *data_in)
{
object_bases_iterator_begin(iter, data_in, BASE_SELECTED);
}
void BKE_selected_bases_iterator_next(BLI_Iterator *iter)
void BKE_view_layer_selected_bases_iterator_next(BLI_Iterator *iter)
{
object_bases_iterator_next(iter, BASE_SELECTED);
}
void BKE_selected_bases_iterator_end(BLI_Iterator *UNUSED(iter))
void BKE_view_layer_selected_bases_iterator_end(BLI_Iterator *UNUSED(iter))
{
/* do nothing */
}
void BKE_visible_bases_iterator_begin(BLI_Iterator *iter, void *data_in)
/** \} */
/* -------------------------------------------------------------------- */
/** \name BKE_view_layer_visible_bases_iterator
* \{ */
void BKE_view_layer_visible_bases_iterator_begin(BLI_Iterator *iter, void *data_in)
{
object_bases_iterator_begin(iter, data_in, BASE_VISIBLED);
}
void BKE_visible_bases_iterator_next(BLI_Iterator *iter)
void BKE_view_layer_visible_bases_iterator_next(BLI_Iterator *iter)
{
object_bases_iterator_next(iter, BASE_VISIBLED);
}
void BKE_visible_bases_iterator_end(BLI_Iterator *UNUSED(iter))
void BKE_view_layer_visible_bases_iterator_end(BLI_Iterator *UNUSED(iter))
{
/* do nothing */
}
void BKE_renderable_objects_iterator_begin(BLI_Iterator *iter, void *data_in)
/** \} */
/* -------------------------------------------------------------------- */
/** \name BKE_view_layer_renderable_objects_iterator
* \{ */
void BKE_view_layer_renderable_objects_iterator_begin(BLI_Iterator *iter, void *data_in)
{
struct ObjectsRenderableIteratorData *data = data_in;
@@ -2175,10 +2209,10 @@ void BKE_renderable_objects_iterator_begin(BLI_Iterator *iter, void *data_in)
data->iter.set = NULL;
iter->data = data_in;
BKE_renderable_objects_iterator_next(iter);
BKE_view_layer_renderable_objects_iterator_next(iter);
}
void BKE_renderable_objects_iterator_next(BLI_Iterator *iter)
void BKE_view_layer_renderable_objects_iterator_next(BLI_Iterator *iter)
{
/* Set it early in case we need to exit and we are running from within a loop. */
iter->skip = true;
@@ -2233,16 +2267,18 @@ void BKE_renderable_objects_iterator_next(BLI_Iterator *iter)
iter->valid = false;
}
void BKE_renderable_objects_iterator_end(BLI_Iterator *UNUSED(iter))
void BKE_view_layer_renderable_objects_iterator_end(BLI_Iterator *UNUSED(iter))
{
/* Do nothing - iter->data was static allocated, we can't free it. */
}
/** \} */
/* -------------------------------------------------------------------- */
/** \name BKE_view_layer_objects_in_mode_iterator
/** \name BKE_view_layer_bases_in_mode_iterator
* \{ */
void BKE_view_layer_objects_in_mode_iterator_begin(BLI_Iterator *iter, void *data_in)
void BKE_view_layer_bases_in_mode_iterator_begin(BLI_Iterator *iter, void *data_in)
{
struct ObjectsInModeIteratorData *data = data_in;
Base *base = data->base_active;
@@ -2256,7 +2292,7 @@ void BKE_view_layer_objects_in_mode_iterator_begin(BLI_Iterator *iter, void *dat
iter->current = base;
}
void BKE_view_layer_objects_in_mode_iterator_next(BLI_Iterator *iter)
void BKE_view_layer_bases_in_mode_iterator_next(BLI_Iterator *iter)
{
struct ObjectsInModeIteratorData *data = iter->data;
Base *base = iter->current;
@@ -2286,7 +2322,7 @@ void BKE_view_layer_objects_in_mode_iterator_next(BLI_Iterator *iter)
iter->valid = false;
}
void BKE_view_layer_objects_in_mode_iterator_end(BLI_Iterator *UNUSED(iter))
void BKE_view_layer_bases_in_mode_iterator_end(BLI_Iterator *UNUSED(iter))
{
/* do nothing */
}