2ab59859c9
Ref: #132179 Renames: - `Editing.act_seq` -> `Editing.act_strip` - `SequenceModifierData` -> `StripModifierData` - Its member `mask_sequence` is now `mask_strip`. - `MetaStack.parseq` -> `MetaStack.parent_strip` - Remaining function names/parameters that were not dealt with in #132748 - Various references to `seq` or `sequence` throughout code and docs when referring to a strip Also moves `_get` to the end of the renamed function names where applicable for standardization (unless "by" or "from" are used). There should be no changes to current behavior. Pull Request: https://projects.blender.org/blender/blender/pulls/138077
156 lines
4.7 KiB
C++
156 lines
4.7 KiB
C++
/* SPDX-FileCopyrightText: 2004-2024 Blender Authors
|
|
*
|
|
* SPDX-License-Identifier: GPL-2.0-or-later */
|
|
|
|
#pragma once
|
|
|
|
/** \file
|
|
* \ingroup sequencer
|
|
*/
|
|
|
|
#include "DNA_scene_types.h"
|
|
|
|
struct BlendDataReader;
|
|
struct BlendWriter;
|
|
struct Depsgraph;
|
|
struct Editing;
|
|
struct Main;
|
|
struct MetaStack;
|
|
struct Scene;
|
|
struct SeqTimelineChannel;
|
|
struct Strip;
|
|
struct SequencerToolSettings;
|
|
|
|
namespace blender::seq {
|
|
|
|
constexpr int MAX_CHANNELS = 128;
|
|
|
|
/* RNA enums, just to be more readable */
|
|
enum {
|
|
SIDE_MOUSE = -1,
|
|
SIDE_NONE = 0,
|
|
SIDE_LEFT,
|
|
SIDE_RIGHT,
|
|
SIDE_BOTH,
|
|
SIDE_NO_CHANGE,
|
|
};
|
|
|
|
/* strip_duplicate' flags */
|
|
#define STRIP_DUPE_UNIQUE_NAME (1 << 0)
|
|
#define STRIP_DUPE_ALL (1 << 3) /* otherwise only selected are copied */
|
|
|
|
SequencerToolSettings *tool_settings_init();
|
|
SequencerToolSettings *tool_settings_ensure(Scene *scene);
|
|
void tool_settings_free(SequencerToolSettings *tool_settings);
|
|
eSeqImageFitMethod tool_settings_fit_method_get(Scene *scene);
|
|
void tool_settings_fit_method_set(Scene *scene, eSeqImageFitMethod fit_method);
|
|
short tool_settings_snap_flag_get(Scene *scene);
|
|
short tool_settings_snap_mode_get(Scene *scene);
|
|
int tool_settings_snap_distance_get(Scene *scene);
|
|
eSeqOverlapMode tool_settings_overlap_mode_get(Scene *scene);
|
|
int tool_settings_pivot_point_get(Scene *scene);
|
|
SequencerToolSettings *tool_settings_copy(SequencerToolSettings *tool_settings);
|
|
Editing *editing_get(const Scene *scene);
|
|
Editing *editing_ensure(Scene *scene);
|
|
void editing_free(Scene *scene, bool do_id_user);
|
|
/**
|
|
* Get seqbase that is being viewed currently. This can be main seqbase or meta strip seqbase
|
|
*
|
|
* \param ed: sequence editor data
|
|
* \return pointer to active seqbase. returns NULL if ed is NULL
|
|
*/
|
|
ListBase *active_seqbase_get(const Editing *ed);
|
|
/**
|
|
* Set seqbase that is being viewed currently. This can be main seqbase or meta strip seqbase
|
|
*
|
|
* \param ed: sequence editor data
|
|
* \param seqbase: ListBase with strips
|
|
*/
|
|
void active_seqbase_set(Editing *ed, ListBase *seqbase);
|
|
Strip *strip_alloc(ListBase *lb, int timeline_frame, int machine, int type);
|
|
void strip_free(Scene *scene, Strip *strip);
|
|
/**
|
|
* Get #MetaStack that corresponds to current level that is being viewed
|
|
*
|
|
* \return pointer to meta stack
|
|
*/
|
|
MetaStack *meta_stack_active_get(const Editing *ed);
|
|
/**
|
|
* Open Meta strip content for editing.
|
|
*
|
|
* \param ed: sequence editor data
|
|
* \param dst: meta strip or NULL for top level view
|
|
*/
|
|
void meta_stack_set(const Scene *scene, Strip *dst);
|
|
/**
|
|
* Close last Meta strip open for editing.
|
|
*
|
|
* \param ed: sequence editor data
|
|
*/
|
|
Strip *meta_stack_pop(Editing *ed);
|
|
Strip *strip_duplicate_recursive(
|
|
const Scene *scene_src, Scene *scene_dst, ListBase *new_seq_list, Strip *strip, int dupe_flag);
|
|
void seqbase_duplicate_recursive(const Scene *scene_src,
|
|
Scene *scene_dst,
|
|
ListBase *nseqbase,
|
|
const ListBase *seqbase,
|
|
int dupe_flag,
|
|
int flag);
|
|
bool is_valid_strip_channel(const Strip *strip);
|
|
|
|
/**
|
|
* Read and Write functions for `.blend` file data.
|
|
*/
|
|
void blend_write(BlendWriter *writer, ListBase *seqbase);
|
|
void blend_read(BlendDataReader *reader, ListBase *seqbase);
|
|
|
|
void doversion_250_sound_proxy_update(Main *bmain, Editing *ed);
|
|
|
|
/* Depsgraph update function. */
|
|
|
|
/**
|
|
* Evaluate parts of strips which needs to be done as a part of a dependency graph evaluation.
|
|
* This does NOT include actual rendering of the strips, but rather makes them up-to-date for
|
|
* animation playback and makes them ready for the sequencer's rendering pipeline to render them.
|
|
*/
|
|
void eval_strips(Depsgraph *depsgraph, Scene *scene, ListBase *seqbase);
|
|
|
|
/**
|
|
* Find a strip with a given name.
|
|
* If lookup hash doesn't exist, it will be created. If hash is tagged as invalid, it will be
|
|
* rebuilt.
|
|
*
|
|
* \param ed: Editing that owns lookup hash
|
|
* \param key: Strip name without SQ prefix (strip->name + 2)
|
|
*
|
|
* \return pointer to Strip
|
|
*/
|
|
Strip *lookup_strip_by_name(Editing *ed, const char *key);
|
|
|
|
/**
|
|
* Find which meta strip the given timeline channel belongs to. Returns nullptr if it is a global
|
|
* channel.
|
|
*/
|
|
Strip *lookup_strip_by_channel_owner(Editing *ed, const SeqTimelineChannel *channel);
|
|
/**
|
|
* Find meta strip, that contains strip `key`.
|
|
* If lookup hash doesn't exist, it will be created. If hash is tagged as invalid, it will be
|
|
* rebuilt.
|
|
*
|
|
* \param key: pointer to Strip inside of meta strip
|
|
*
|
|
* \return pointer to meta strip
|
|
*/
|
|
Strip *lookup_meta_by_strip(Editing *ed, const Strip *key);
|
|
/**
|
|
* Free lookup hash data.
|
|
*/
|
|
void strip_lookup_free(Editing *ed);
|
|
|
|
/**
|
|
* Mark strip lookup as invalid (i.e. will need rebuilding).
|
|
*/
|
|
void strip_lookup_invalidate(const Editing *ed);
|
|
|
|
} // namespace blender::seq
|