masks_types.h

Go to the documentation of this file.

/*
    This file is part of Ansel,
    Copyright (C) 2026 Aurélien PIERRE.
 
    Ansel is free software: you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.
 
    Ansel is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.
 
    You should have received a copy of the GNU General Public License
    along with Ansel.  If not, see <http://www.gnu.org/licenses/>.
*/
 
#ifndef DT_DEVELOP_MASKS_TYPES_H
#define DT_DEVELOP_MASKS_TYPES_H
 
#include <glib.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
#define DT_MASKS_FORM_NAME_LEN 128
 
typedef struct dt_masks_form_t dt_masks_form_t;
 
#define DEVELOP_MASKS_NB_SHAPES 5
 
typedef enum dt_masks_type_t
{
  DT_MASKS_NONE = 0, // keep first
  DT_MASKS_CIRCLE = 1 << 0,
  DT_MASKS_POLYGON = 1 << 1,
  DT_MASKS_GROUP = 1 << 2,
  DT_MASKS_CLONE = 1 << 3,
  DT_MASKS_GRADIENT = 1 << 4,
  DT_MASKS_ELLIPSE = 1 << 5,
  DT_MASKS_BRUSH = 1 << 6,
  DT_MASKS_NON_CLONE = 1 << 7,
 
  DT_MASKS_ALL = DT_MASKS_CIRCLE | DT_MASKS_POLYGON | DT_MASKS_GROUP |
                 DT_MASKS_GRADIENT | DT_MASKS_ELLIPSE | DT_MASKS_BRUSH,
 
  DT_MASKS_IS_CLOSED_SHAPE = DT_MASKS_CIRCLE | DT_MASKS_ELLIPSE | DT_MASKS_POLYGON,
  DT_MASKS_IS_OPEN_SHAPE   = DT_MASKS_ALL & ~DT_MASKS_IS_CLOSED_SHAPE,
  
  DT_MASKS_IS_RETOUCHE = DT_MASKS_CLONE | DT_MASKS_NON_CLONE,
 
  DT_MASKS_IS_PATH_SHAPE   = DT_MASKS_POLYGON | DT_MASKS_BRUSH,
  DT_MASKS_IS_PRIMITIVE_SHAPE = DT_MASKS_CIRCLE | DT_MASKS_ELLIPSE | DT_MASKS_GRADIENT
 
} dt_masks_type_t;
 
typedef enum dt_masks_state_t
{
  DT_MASKS_STATE_NONE = 0,
  DT_MASKS_STATE_USE = 1 << 0,
  DT_MASKS_STATE_SHOW = 1 << 1,
  DT_MASKS_STATE_INVERSE = 1 << 2,
  DT_MASKS_STATE_UNION = 1 << 3,
  DT_MASKS_STATE_INTERSECTION = 1 << 4,
  DT_MASKS_STATE_DIFFERENCE = 1 << 5,
  DT_MASKS_STATE_EXCLUSION = 1 << 6,
  DT_MASKS_STATE_NOOP = 1 << 7,
 
  DT_MASKS_STATE_IS_COMBINE_OP = DT_MASKS_STATE_UNION | DT_MASKS_STATE_INTERSECTION | DT_MASKS_STATE_DIFFERENCE | DT_MASKS_STATE_EXCLUSION
} dt_masks_state_t;
 
typedef enum dt_masks_increment_t
{
  DT_MASKS_INCREMENT_ABSOLUTE = 0,
  DT_MASKS_INCREMENT_SCALE = 1,
  DT_MASKS_INCREMENT_OFFSET = 2
} dt_masks_increment_t;
 
typedef enum dt_masks_edit_mode_t
{
  DT_MASKS_EDIT_OFF = 0,
  DT_MASKS_EDIT_FULL = 1,
  DT_MASKS_EDIT_RESTRICTED = 2
} dt_masks_edit_mode_t;
 
/*
* Type of user interaction to map with internal properties of masks.
* Those used to be deduced implicitly by each shape from Shift/Ctrl/Shift+Ctrl + mouse
* scroll, which is a shitty design when using Wacom tablets. No shape reads key modifiers
* any more: the wheel is resolved once, against the user's mapping, by
* dt_masks_scroll_get_interaction() -- see masks_gui.h -- and every entry point
* (mouse_scroll callback, context-menu sliders) names the property it acts on.
*/
typedef enum dt_masks_interaction_t
{
  DT_MASKS_INTERACTION_UNDEF = 0,    // no property: an unmapped wheel combination does nothing
  DT_MASKS_INTERACTION_SIZE = 1,     // property of the form (shape), explicit
  DT_MASKS_INTERACTION_FADING = 2,   // property of the form (shape), explicit
  DT_MASKS_INTERACTION_OPACITY = 3,  // property of the group in which the form is included, explicit
  DT_MASKS_INTERACTION_ROTATION = 4, // property of the form (shape), explicit
  DT_MASKS_INTERACTION_LAST
} dt_masks_interaction_t;
 
typedef struct dt_masks_form_group_t
{
  int formid;
  int parentid;
  int state;
  float opacity;
} dt_masks_form_group_t;
 
typedef enum dt_masks_result_t
{
  DT_MASKS_OK = 0,     /* the model changed */
  DT_MASKS_UNCHANGED,  /* legal request, nothing to do -- caller skips the history commit */
  DT_MASKS_NOT_FOUND,  /* no such group, or no such member in it */
  DT_MASKS_INVALID     /* refused: not a group, self-inclusion, bad argument */
} dt_masks_result_t;
 
typedef struct dt_masks_member_t
{
  int              formid;
  int              parentid;   /* the row's AUTHORED origin; not always the group holding it */
  guint            index;      /* position == compositing order == GTK row identity */
  dt_masks_state_t state;      /* tightened from the stored struct's plain int */
  float            opacity;
} dt_masks_member_t;
 
typedef struct dt_masks_form_info_t
{
  int             formid;
  dt_masks_type_t type;
  int             version;
  gboolean        is_group;
  gboolean        is_retouch;   /* (type & DT_MASKS_IS_RETOUCHE) != 0 */
  guint           member_count; /* 0 unless is_group */
  char            name[DT_MASKS_FORM_NAME_LEN];
} dt_masks_form_info_t;
 
typedef struct dt_masks_skip_range_t
{
  int jump_from;
  int resume_at;
} dt_masks_skip_range_t;
 
#ifdef __cplusplus
}
#endif
 
#endif // DT_DEVELOP_MASKS_TYPES_H
 
// clang-format off
// modelines: These editor modelines have been set for all relevant files by tools/update_modelines.py
// vim: shiftwidth=2 expandtab tabstop=2 cindent
// kate: tab-indents: off; indent-width 2; replace-tabs on; indent-mode cstyle; remove-trailing-spaces modified;
// clang-format on