diff options
author | Campbell Barton <ideasman42@gmail.com> | 2021-12-08 13:02:29 +0300 |
---|---|---|
committer | Campbell Barton <ideasman42@gmail.com> | 2021-12-08 13:05:06 +0300 |
commit | 32b1a13fa1e427bc5b2cce2bf179fd274679e08f (patch) | |
tree | 0c8715816dc675ba37b29b89062ff4da3f12124b /source/blender/sequencer/SEQ_transform.h | |
parent | e89d42ddffef8892a8eb52d29e2a7329ad381204 (diff) |
Cleanup: move public doc-strings into headers for 'sequencer'
Ref T92709
Diffstat (limited to 'source/blender/sequencer/SEQ_transform.h')
-rw-r--r-- | source/blender/sequencer/SEQ_transform.h | 47 |
1 files changed, 47 insertions, 0 deletions
diff --git a/source/blender/sequencer/SEQ_transform.h b/source/blender/sequencer/SEQ_transform.h index 18437680731..fe0c223bcb1 100644 --- a/source/blender/sequencer/SEQ_transform.h +++ b/source/blender/sequencer/SEQ_transform.h @@ -36,13 +36,24 @@ int SEQ_transform_get_left_handle_frame(struct Sequence *seq); int SEQ_transform_get_right_handle_frame(struct Sequence *seq); void SEQ_transform_set_left_handle_frame(struct Sequence *seq, int val); void SEQ_transform_set_right_handle_frame(struct Sequence *seq, int val); +/** + * Use to impose limits when dragging/extending - so impossible situations don't happen. + * Can't use the #SEQ_LEFTSEL and #SEQ_LEFTSEL directly because the strip may be in a meta-strip. + */ void SEQ_transform_handle_xlimits(struct Sequence *seq, int leftflag, int rightflag); bool SEQ_transform_sequence_can_be_translated(struct Sequence *seq); +/** + * Used so we can do a quick check for single image seq + * since they work a bit differently to normal image seq's (during transform). + */ bool SEQ_transform_single_image_check(struct Sequence *seq); void SEQ_transform_fix_single_image_seq_offsets(struct Sequence *seq); bool SEQ_transform_test_overlap(struct ListBase *seqbasep, struct Sequence *test); bool SEQ_transform_test_overlap_seq_seq(struct Sequence *seq1, struct Sequence *seq2); void SEQ_transform_translate_sequence(struct Scene *scene, struct Sequence *seq, int delta); +/** + * \return 0 if there weren't enough space. + */ bool SEQ_transform_seqbase_shuffle_ex(struct ListBase *seqbasep, struct Sequence *test, struct Scene *evil_scene, @@ -55,21 +66,57 @@ bool SEQ_transform_seqbase_shuffle_time(struct SeqCollection *strips_to_shuffle, struct Scene *evil_scene, struct ListBase *markers, const bool use_sync_markers); +/** + * Check if the selected seq's reference unselected seq's. + */ bool SEQ_transform_seqbase_isolated_sel_check(struct ListBase *seqbase); +/** + * Move strips and markers (if not locked) that start after timeline_frame by delta frames + * + * \param scene: Scene in which strips are located + * \param seqbase: ListBase in which strips are located + * \param delta: offset in frames to be applied + * \param timeline_frame: frame on timeline from where strips are moved + */ void SEQ_transform_offset_after_frame(struct Scene *scene, struct ListBase *seqbase, const int delta, const int timeline_frame); /* Image transformation. */ + void SEQ_image_transform_mirror_factor_get(const struct Sequence *seq, float r_mirror[2]); +/** + * Get strip transform origin offset from image center + * NOTE: This function does not apply axis mirror. + * + * \param scene: Scene in which strips are located + * \param seq: Sequence to calculate image transform origin + * \param r_origin: return value + */ void SEQ_image_transform_origin_offset_pixelspace_get(const struct Scene *scene, const struct Sequence *seq, float r_origin[2]); +/** + * Get 4 corner points of strip image, optionally without rotation component applied. + * Corner vectors are in viewport space. + * + * \param scene: Scene in which strips are located + * \param seq: Sequence to calculate transformed image quad + * \param apply_rotation: Apply sequence rotation transform to the quad + * \param r_quad: array of 4 2D vectors + */ void SEQ_image_transform_quad_get(const struct Scene *scene, const struct Sequence *seq, bool apply_rotation, float r_quad[4][2]); +/** + * Get 4 corner points of strip image. Corner vectors are in viewport space. + * + * \param scene: Scene in which strips are located + * \param seq: Sequence to calculate transformed image quad + * \param r_quad: array of 4 2D vectors + */ void SEQ_image_transform_final_quad_get(const struct Scene *scene, const struct Sequence *seq, float r_quad[4][2]); |