6ac58a5b8a
Part of Code Quality Project outlined in #130975. This patch eschews warning messages urging the user to "select all related strips" when copying or creating new metastrips and instead automatically includes those related strips in the operation. - Attempting to copy or create a metastrip with no strips selected no longer delivers a warning. - When copying strip(s), if there are related effect chains, they will be automatically selected and included in the copy if the operation succeeds. - The decision to select related strips was intentional, as it allows the user to easily see the entire effect chain and thus which strips were copied. - When creating a new metastrip, if there are related effect chains, they will automatically be included in the resulting metastrip. - This is done using a new `SEQ_query_strip_connected_and_effect_chain()` iterator. This iterator is only used for metastrips, and not copying, since the user may wish to only copy single strips in a connection, but connected strips should always stay together in a metastrip/seqbase. Pull Request: https://projects.blender.org/blender/blender/pulls/132930
133 lines
5.1 KiB
C++
133 lines
5.1 KiB
C++
/* SPDX-FileCopyrightText: 2004 Blender Authors
|
|
*
|
|
* SPDX-License-Identifier: GPL-2.0-or-later */
|
|
|
|
#pragma once
|
|
|
|
/** \file
|
|
* \ingroup sequencer
|
|
*/
|
|
|
|
#include "BLI_vector_set.hh"
|
|
|
|
struct ListBase;
|
|
struct Scene;
|
|
struct Strip;
|
|
|
|
/**
|
|
* Callback format for the for_each function below.
|
|
*/
|
|
using SeqForEachFunc = bool (*)(Strip *strip, void *user_data);
|
|
|
|
/**
|
|
* Utility function to recursively iterate through all sequence strips in a `seqbase` list.
|
|
* Uses callback to do operations on each sequence element.
|
|
* The callback can stop the iteration if needed.
|
|
*
|
|
* \param seqbase: #ListBase of sequences to be iterated over.
|
|
* \param callback: query function callback, returns false if iteration should stop.
|
|
* \param user_data: pointer to user data that can be used in the callback function.
|
|
*/
|
|
void SEQ_for_each_callback(ListBase *seqbase, SeqForEachFunc callback, void *user_data);
|
|
|
|
/**
|
|
* Expand set by running `strip_query_func()` for each strip, which will be used as reference.
|
|
* Results of these queries will be merged into provided collection.
|
|
*
|
|
* \param seqbase: ListBase in which strips are queried
|
|
* \param strips: set of strips to be expanded
|
|
* \param strip_query_func: query function callback
|
|
*/
|
|
void SEQ_iterator_set_expand(const Scene *scene,
|
|
ListBase *seqbase,
|
|
blender::VectorSet<Strip *> &strips,
|
|
void strip_query_func(const Scene *scene,
|
|
Strip *strip_reference,
|
|
ListBase *seqbase,
|
|
blender::VectorSet<Strip *> &strips));
|
|
/**
|
|
* Query strips from seqbase. strip_reference is used by query function as filter condition.
|
|
*
|
|
* \param strip_reference: reference strip for query function
|
|
* \param seqbase: ListBase in which strips are queried
|
|
* \param strip_query_func: query function callback
|
|
* \return set of strips
|
|
*/
|
|
blender::VectorSet<Strip *> SEQ_query_by_reference(
|
|
Strip *strip_reference,
|
|
const Scene *scene,
|
|
ListBase *seqbase,
|
|
void strip_query_func(const Scene *scene,
|
|
Strip *strip_reference,
|
|
ListBase *seqbase,
|
|
blender::VectorSet<Strip *> &strips));
|
|
/**
|
|
* Query all selected strips in seqbase.
|
|
*
|
|
* \param seqbase: ListBase in which strips are queried
|
|
* \return set of strips
|
|
*/
|
|
blender::VectorSet<Strip *> SEQ_query_selected_strips(ListBase *seqbase);
|
|
/**
|
|
* Query all unselected strips in seqbase.
|
|
*
|
|
* \param seqbase: ListBase in which strips are queried
|
|
* \return set of strips
|
|
*/
|
|
blender::VectorSet<Strip *> SEQ_query_unselected_strips(ListBase *seqbase);
|
|
/**
|
|
* Query all strips in seqbase. This does not include strips nested in meta strips.
|
|
*
|
|
* \param seqbase: ListBase in which strips are queried
|
|
* \return set of strips
|
|
*/
|
|
blender::VectorSet<Strip *> SEQ_query_all_strips(ListBase *seqbase);
|
|
/**
|
|
* Query all strips in seqbase and nested meta strips.
|
|
*
|
|
* \param seqbase: ListBase in which strips are queried
|
|
* \return set of strips
|
|
*/
|
|
blender::VectorSet<Strip *> SEQ_query_all_strips_recursive(const ListBase *seqbase);
|
|
|
|
/**
|
|
* Query all effect strips that are directly or indirectly connected to strip_reference.
|
|
* This includes all effects of strip_reference, strips used by another inputs and their effects,
|
|
* so that whole chain is fully independent of other strips.
|
|
*
|
|
* \param strip_reference: reference strip
|
|
* \param seqbase: ListBase in which strips are queried
|
|
* \param strips: set of strips to be filled
|
|
*/
|
|
void SEQ_query_strip_effect_chain(const Scene *scene,
|
|
Strip *strip_reference,
|
|
ListBase *seqbase,
|
|
blender::VectorSet<Strip *> &r_strips);
|
|
|
|
/**
|
|
* Query all connected strips, as well as all effect strips directly or indirectly connected to
|
|
* those connected strips. These steps repeat until there are no new strips to process.
|
|
*
|
|
* \param strip_reference: reference strip
|
|
* \param seqbase: ListBase in which strips are queried
|
|
* \param strips: set of strips to be filled
|
|
*/
|
|
void SEQ_query_strip_connected_and_effect_chain(const Scene *scene,
|
|
Strip *reference_strip,
|
|
ListBase *seqbase,
|
|
blender::VectorSet<Strip *> &r_strips);
|
|
|
|
/**
|
|
* Query strips that are rendered at \a timeline_frame when \a displayed channel is viewed
|
|
*
|
|
* \param seqbase: ListBase in which strips are queried
|
|
* \param timeline_frame: viewed frame
|
|
* \param displayed_channel: viewed channel. when set to 0, no channel filter is applied
|
|
* \return set of strips
|
|
*/
|
|
blender::VectorSet<Strip *> SEQ_query_rendered_strips(const Scene *scene,
|
|
ListBase *channels,
|
|
ListBase *seqbase,
|
|
int timeline_frame,
|
|
int displayed_channel);
|