ED_gpencil_legacy.hh

Go to the documentation of this file.

/* SPDX-FileCopyrightText: 2008 Blender Authors
 *
 * SPDX-License-Identifier: GPL-2.0-or-later */
 
#pragma once
 
struct ID;
struct ListBase;
struct PointerRNA;
 
struct Brush;
struct GP_SpaceConversion;
struct bGPDframe;
struct bGPDlayer;
struct bGPDspoint;
struct bGPDstroke;
struct bGPdata;
struct tGPspoint;
 
struct ARegion;
struct Depsgraph;
struct Main;
struct RegionView3D;
struct ReportList;
struct Scene;
struct ScrArea;
struct SnapObjectContext;
struct ToolSettings;
struct View3D;
struct bContext;
 
struct Material;
struct Object;
 
struct KeyframeEditData;
struct bAnimContext;
 
struct wmKeyConfig;
struct wmOperator;
 
/* ------------- Grease-Pencil Runtime Data ---------------- */
 
struct tGPspoint {
  float m_xy[2];
  float pressure;
  float strength;
  float time;
  float uv_fac;
  float uv_rot;
  float rnd[3];
  bool rnd_dirty;
  float vert_color[4];
};
 
/* ----------- Grease Pencil Tools/Context ------------- */
 
/* Context-dependent */
 
bGPdata **ED_gpencil_data_get_pointers(const bContext *C, PointerRNA *r_ptr);
 
bGPdata *ED_gpencil_data_get_active(const bContext *C);
 
bGPdata **ED_gpencil_data_get_pointers_direct(ScrArea *area, Object *ob, PointerRNA *r_ptr);
 
bGPdata *ED_annotation_data_get_active(const bContext *C);
bGPdata **ED_annotation_data_get_pointers(const bContext *C, PointerRNA *r_ptr);
bGPdata **ED_annotation_data_get_pointers_direct(ID *screen_id,
                                                 ScrArea *area,
                                                 Scene *scene,
                                                 PointerRNA *r_ptr);
bGPdata *ED_annotation_data_get_active_direct(ID *screen_id, ScrArea *area, Scene *scene);
 
bool ED_gpencil_data_owner_is_annotation(PointerRNA *owner_ptr);
 
bool ED_gpencil_stroke_can_use_direct(const ScrArea *area, const bGPDstroke *gps);
bool ED_gpencil_stroke_can_use(const bContext *C, const bGPDstroke *gps);
bool ED_gpencil_stroke_material_editable(Object *ob, const bGPDlayer *gpl, const bGPDstroke *gps);
 
/* ----------- Grease Pencil Operators ----------------- */
 
void ED_keymap_gpencil_legacy(wmKeyConfig *keyconf);
 
void ED_operatortypes_gpencil_legacy();
 
/* ------------- Copy-Paste Buffers -------------------- */
 
void ED_gpencil_strokes_copybuf_free();
 
/* ------------ Grease-Pencil Drawing API ------------------ */
/* `drawgpencil.cc` */
 
void ED_annotation_draw_2dimage(const bContext *C);
void ED_annotation_draw_view2d(const bContext *C, bool onlyv2d);
void ED_annotation_draw_view3d(
    Scene *scene, Depsgraph *depsgraph, View3D *v3d, ARegion *region, bool only3d);
void ED_annotation_draw_ex(
    Scene *scene, bGPdata *gpd, int winx, int winy, int cfra, char spacetype);
 
/* ----------- Grease-Pencil AnimEdit API ------------------ */
bool ED_gpencil_layer_frames_looper(bGPDlayer *gpl,
                                    Scene *scene,
                                    bool (*gpf_cb)(bGPDframe *, Scene *));
void ED_gpencil_layer_make_cfra_list(bGPDlayer *gpl, ListBase *elems, bool onlysel);
 
bool ED_gpencil_layer_frame_select_check(const bGPDlayer *gpl);
void ED_gpencil_layer_frame_select_set(bGPDlayer *gpl, short mode);
void ED_gpencil_layer_frames_select_box(bGPDlayer *gpl, float min, float max, short select_mode);
void ED_gpencil_layer_frames_select_region(KeyframeEditData *ked,
                                           bGPDlayer *gpl,
                                           short tool,
                                           short select_mode);
void ED_gpencil_select_frames(bGPDlayer *gpl, short select_mode);
void ED_gpencil_select_frame(bGPDlayer *gpl, int selx, short select_mode);
 
void ED_gpencil_set_active_channel(bGPdata *gpd, bGPDlayer *gpl);
 
bool ED_gpencil_layer_frames_delete(bGPDlayer *gpl);
void ED_gpencil_layer_frames_duplicate(bGPDlayer *gpl);
 
void ED_gpencil_layer_frames_keytype_set(bGPDlayer *gpl, short type);
void ED_gpencil_layer_snap_frames(bGPDlayer *gpl, Scene *scene, short mode);
 
void ED_gpencil_layer_mirror_frames(bGPDlayer *gpl, Scene *scene, short mode);
 
void ED_gpencil_anim_copybuf_free();
bool ED_gpencil_anim_copybuf_copy(bAnimContext *ac);
bool ED_gpencil_anim_copybuf_paste(bAnimContext *ac, short offset_mode);
 
/* ------------ Grease-Pencil Undo System ------------------ */
int ED_gpencil_session_active();
int ED_undo_gpencil_step(bContext *C, int step); /* eUndoStepDir. */
 
/* ----------- Add Primitive Utilities -------------- */
 
void ED_gpencil_drawing_reference_get(const Scene *scene,
                                      const Object *ob,
                                      char align_flag,
                                      float r_vec[3]);
 
/* texture coordinate utilities */
 
void ED_gpencil_tpoint_to_point(ARegion *region,
                                float origin[3],
                                const tGPspoint *tpt,
                                bGPDspoint *pt);
 
tGPspoint *ED_gpencil_sbuffer_ensure(tGPspoint *buffer_array,
                                     int *buffer_size,
                                     int *buffer_used,
                                     bool clear);