160 lines
5.4 KiB
C++
160 lines
5.4 KiB
C++
/* SPDX-FileCopyrightText: 2009 Blender Authors
|
|
*
|
|
* SPDX-License-Identifier: GPL-2.0-or-later */
|
|
|
|
/** \file
|
|
* \ingroup editors
|
|
*/
|
|
|
|
#pragma once
|
|
|
|
struct ARegion;
|
|
struct ImBuf;
|
|
struct Main;
|
|
struct Mask;
|
|
struct MovieClip;
|
|
struct SpaceClip;
|
|
struct bContext;
|
|
struct bScreen;
|
|
|
|
/* `clip_editor.cc` */
|
|
|
|
/* Returns true when the following conditions are met:
|
|
* - Current space is Space Clip.
|
|
* - There is a movie clip opened in it. */
|
|
bool ED_space_clip_poll(bContext *C);
|
|
|
|
/* Returns true when the following conditions are met:
|
|
* - Current space is Space Clip.
|
|
* - It is set to Clip view.
|
|
*
|
|
* It is not required to have movie clip opened for editing. */
|
|
bool ED_space_clip_view_clip_poll(bContext *C);
|
|
|
|
/* Returns true when the following conditions are met:
|
|
* - Current space is Space Clip.
|
|
* - It is set to Tracking mode.
|
|
*
|
|
* It is not required to have movie clip opened for editing. */
|
|
bool ED_space_clip_tracking_poll(bContext *C);
|
|
|
|
/* Returns true when the following conditions are met:
|
|
* - Current space is Space Clip.
|
|
* - It is set to Mask mode.
|
|
*
|
|
* It is not required to have mask opened for editing. */
|
|
bool ED_space_clip_maskedit_poll(bContext *C);
|
|
|
|
/* Returns true when the following conditions are met:
|
|
* - Current space is Space Clip.
|
|
* - It is set to Mask mode.
|
|
* - Mask has visible and editable splines.
|
|
*
|
|
* It is not required to have mask opened for editing. */
|
|
bool ED_space_clip_maskedit_visible_splines_poll(bContext *C);
|
|
|
|
/* Returns true when the following conditions are met:
|
|
* - Current space is Space Clip.
|
|
* - It is set to Mask mode.
|
|
* - The space has mask opened. */
|
|
bool ED_space_clip_maskedit_mask_poll(bContext *C);
|
|
|
|
/* Returns true when the following conditions are met:
|
|
* - Current space is Space Clip.
|
|
* - It is set to Mask mode.
|
|
* - The space has mask opened.
|
|
* - Mask has visible and editable splines. */
|
|
bool ED_space_clip_maskedit_mask_visible_splines_poll(bContext *C);
|
|
|
|
void ED_space_clip_get_size(const SpaceClip *sc, int *r_width, int *r_height);
|
|
void ED_space_clip_get_size_fl(const SpaceClip *sc, float r_size[2]);
|
|
void ED_space_clip_get_zoom(const SpaceClip *sc,
|
|
const ARegion *region,
|
|
float *r_zoomx,
|
|
float *r_zoomy);
|
|
void ED_space_clip_get_aspect(const SpaceClip *sc, float *r_aspx, float *r_aspy);
|
|
void ED_space_clip_get_aspect_dimension_aware(const SpaceClip *sc, float *r_aspx, float *r_aspy);
|
|
|
|
/**
|
|
* Return current frame number in clip space.
|
|
*/
|
|
int ED_space_clip_get_clip_frame_number(const SpaceClip *sc);
|
|
|
|
ImBuf *ED_space_clip_get_buffer(const SpaceClip *sc);
|
|
ImBuf *ED_space_clip_get_stable_buffer(const SpaceClip *sc,
|
|
float loc[2],
|
|
float *scale,
|
|
float *angle);
|
|
|
|
bool ED_space_clip_get_position(const SpaceClip *sc,
|
|
const ARegion *region,
|
|
const int mval[2],
|
|
float r_fpos[2]);
|
|
/**
|
|
* Returns color in linear space, matching #ED_space_image_color_sample().
|
|
*/
|
|
bool ED_space_clip_color_sample(const SpaceClip *sc,
|
|
const ARegion *region,
|
|
const int mval[2],
|
|
float r_col[3]);
|
|
|
|
void ED_clip_update_frame(const Main *mainp, int cfra);
|
|
bool ED_clip_view_selection(const bContext *C, const ARegion *region, bool fit);
|
|
|
|
void ED_clip_select_all(const SpaceClip *sc, int action, bool *r_has_selection);
|
|
bool ED_clip_can_select(bContext *C);
|
|
|
|
void ED_clip_point_undistorted_pos(const SpaceClip *sc, const float co[2], float r_co[2]);
|
|
void ED_clip_point_stable_pos(
|
|
const SpaceClip *sc, const ARegion *region, float x, float y, float *xr, float *yr);
|
|
/**
|
|
* \brief the reverse of #ED_clip_point_stable_pos(), gets the marker region coords.
|
|
* better name here? view_to_track / track_to_view or so?
|
|
*/
|
|
void ED_clip_point_stable_pos__reverse(const SpaceClip *sc,
|
|
const ARegion *region,
|
|
const float co[2],
|
|
float r_co[2]);
|
|
/**
|
|
* Takes `event->mval`.
|
|
*/
|
|
void ED_clip_mouse_pos(const SpaceClip *sc,
|
|
const ARegion *region,
|
|
const int mval[2],
|
|
float r_co[2]);
|
|
|
|
bool ED_space_clip_check_show_trackedit(const SpaceClip *sc);
|
|
bool ED_space_clip_check_show_maskedit(const SpaceClip *sc);
|
|
|
|
MovieClip *ED_space_clip_get_clip(const SpaceClip *sc);
|
|
void ED_space_clip_set_clip(bContext *C, bScreen *screen, SpaceClip *sc, MovieClip *clip);
|
|
|
|
Mask *ED_space_clip_get_mask(const SpaceClip *sc);
|
|
void ED_space_clip_set_mask(bContext *C, SpaceClip *sc, Mask *mask);
|
|
|
|
/* Locked state is used to preserve current clip editor viewport upon changes. Example usage:
|
|
*
|
|
* ...
|
|
*
|
|
* ClipViewLockState lock_state;
|
|
* ED_clip_view_lock_state_store(C, &lock_state);
|
|
*
|
|
* <change selection>
|
|
*
|
|
* ED_clip_view_lock_state_restore_no_jump(C, &lock_state);
|
|
*
|
|
* These function are to be used from space clip editor context only. Otherwise debug builds will
|
|
* assert, release builds will crash. */
|
|
|
|
struct ClipViewLockState {
|
|
float offset_x, offset_y;
|
|
float lock_offset_x, lock_offset_y;
|
|
float zoom;
|
|
};
|
|
|
|
void ED_clip_view_lock_state_store(const bContext *C, ClipViewLockState *state);
|
|
void ED_clip_view_lock_state_restore_no_jump(const bContext *C, const ClipViewLockState *state);
|
|
|
|
/* `clip_ops.cc` */
|
|
void ED_operatormacros_clip();
|