gimpgradient.h 15.5 KB
Newer Older
1
/* GIMP - The GNU Image Manipulation Program
2 3
 * Copyright (C) 1995 Spencer Kimball and Peter Mattis
 *
4
 * This program is free software: you can redistribute it and/or modify
5
 * it under the terms of the GNU General Public License as published by
6
 * the Free Software Foundation; either version 3 of the License, or
7 8 9 10 11 12 13 14
 * (at your option) any later version.
 *
 * This program 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
15
 * along with this program.  If not, see <https://www.gnu.org/licenses/>.
16 17 18 19 20 21
 */

#ifndef __GIMP_GRADIENT_H__
#define __GIMP_GRADIENT_H__


22 23 24
#include "gimpdata.h"


25
#define GIMP_GRADIENT_DEFAULT_SAMPLE_SIZE 40
26

27 28 29 30

struct _GimpGradientSegment
{
  gdouble                  left, middle, right;
31 32

  GimpGradientColor        left_color_type;
33
  GimpRGB                  left_color;
34
  GimpGradientColor        right_color_type;
35
  GimpRGB                  right_color;
36

37 38 39 40 41 42 43 44 45
  GimpGradientSegmentType  type;          /*  Segment's blending function  */
  GimpGradientSegmentColor color;         /*  Segment's coloring type      */

  GimpGradientSegment     *prev;
  GimpGradientSegment     *next;
};


#define GIMP_TYPE_GRADIENT            (gimp_gradient_get_type ())
46 47 48 49
#define GIMP_GRADIENT(obj)            (G_TYPE_CHECK_INSTANCE_CAST ((obj), GIMP_TYPE_GRADIENT, GimpGradient))
#define GIMP_GRADIENT_CLASS(klass)    (G_TYPE_CHECK_CLASS_CAST ((klass), GIMP_TYPE_GRADIENT, GimpGradientClass))
#define GIMP_IS_GRADIENT(obj)         (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GIMP_TYPE_GRADIENT))
#define GIMP_IS_GRADIENT_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GIMP_TYPE_GRADIENT))
50
#define GIMP_GRADIENT_GET_CLASS(obj)  (G_TYPE_INSTANCE_GET_CLASS ((obj), GIMP_TYPE_GRADIENT, GimpGradientClass))
51 52 53 54 55 56


typedef struct _GimpGradientClass GimpGradientClass;

struct _GimpGradient
{
57
  GimpData             parent_instance;
58 59 60 61 62 63

  GimpGradientSegment *segments;
};

struct _GimpGradientClass
{
64
  GimpDataClass  parent_class;
65 66 67
};


68
GType                 gimp_gradient_get_type       (void) G_GNUC_CONST;
69

70 71
GimpData            * gimp_gradient_new            (GimpContext   *context,
                                                    const gchar   *name);
72
GimpData            * gimp_gradient_get_standard   (GimpContext   *context);
73

74
GimpGradientSegment * gimp_gradient_get_color_at   (GimpGradient        *gradient,
75
                                                    GimpContext         *context,
76 77 78
                                                    GimpGradientSegment *seg,
                                                    gdouble              pos,
                                                    gboolean             reverse,
79
                                                    GimpGradientBlendColorSpace blend_color_space,
80 81 82
                                                    GimpRGB             *color);
GimpGradientSegment * gimp_gradient_get_segment_at (GimpGradient  *grad,
                                                    gdouble        pos);
Ell's avatar
Ell committed
83 84 85 86
void                  gimp_gradient_split_at       (GimpGradient         *gradient,
                                                    GimpContext          *context,
                                                    GimpGradientSegment  *seg,
                                                    gdouble               pos,
87
                                                    GimpGradientBlendColorSpace blend_color_space,
Ell's avatar
Ell committed
88 89
                                                    GimpGradientSegment **newl,
                                                    GimpGradientSegment **newr);
90

91
gboolean          gimp_gradient_has_fg_bg_segments (GimpGradient  *gradient);
92 93
GimpGradient    * gimp_gradient_flatten            (GimpGradient  *gradient,
                                                    GimpContext   *context);
94

95 96 97

/*  gradient segment functions  */

98 99 100
GimpGradientSegment * gimp_gradient_segment_new       (void);
GimpGradientSegment * gimp_gradient_segment_get_last  (GimpGradientSegment *seg);
GimpGradientSegment * gimp_gradient_segment_get_first (GimpGradientSegment *seg);
101 102
GimpGradientSegment * gimp_gradient_segment_get_nth   (GimpGradientSegment *seg,
                                                       gint                 index);
103

104 105
void                  gimp_gradient_segment_free      (GimpGradientSegment *seg);
void                  gimp_gradient_segments_free     (GimpGradientSegment *seg);
106

107
void    gimp_gradient_segment_split_midpoint  (GimpGradient         *gradient,
108
                                               GimpContext          *context,
109
                                               GimpGradientSegment  *lseg,
110
                                               GimpGradientBlendColorSpace blend_color_space,
111 112
                                               GimpGradientSegment **newl,
                                               GimpGradientSegment **newr);
113
void    gimp_gradient_segment_split_uniform   (GimpGradient         *gradient,
114
                                               GimpContext          *context,
115 116
                                               GimpGradientSegment  *lseg,
                                               gint                  parts,
117
                                               GimpGradientBlendColorSpace blend_color_space,
118 119 120
                                               GimpGradientSegment **newl,
                                               GimpGradientSegment **newr);

121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138
/* Colors Setting/Getting Routines */
void    gimp_gradient_segment_get_left_color  (GimpGradient         *gradient,
                                               GimpGradientSegment  *seg,
                                               GimpRGB              *color);

void    gimp_gradient_segment_set_left_color  (GimpGradient         *gradient,
                                               GimpGradientSegment  *seg,
                                               const GimpRGB        *color);


void    gimp_gradient_segment_get_right_color (GimpGradient         *gradient,
                                               GimpGradientSegment  *seg,
                                               GimpRGB              *color);

void    gimp_gradient_segment_set_right_color (GimpGradient         *gradient,
                                               GimpGradientSegment  *seg,
                                               const GimpRGB        *color);

139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159

GimpGradientColor
gimp_gradient_segment_get_left_color_type     (GimpGradient         *gradient,
                                               GimpGradientSegment  *seg);

void
gimp_gradient_segment_set_left_color_type     (GimpGradient         *gradient,
                                               GimpGradientSegment  *seg,
                                               GimpGradientColor     color_type);


GimpGradientColor
gimp_gradient_segment_get_right_color_type    (GimpGradient         *gradient,
                                               GimpGradientSegment  *seg);

void
gimp_gradient_segment_set_right_color_type    (GimpGradient         *gradient,
                                               GimpGradientSegment  *seg,
                                               GimpGradientColor     color_type);


160 161 162 163 164 165 166 167 168 169 170 171 172 173
void
gimp_gradient_segment_get_left_flat_color     (GimpGradient         *gradient,
                                               GimpContext          *context,
                                               GimpGradientSegment  *seg,
                                               GimpRGB              *color);


void
gimp_gradient_segment_get_right_flat_color    (GimpGradient         *gradient,
                                               GimpContext          *context,
                                               GimpGradientSegment  *seg,
                                               GimpRGB              *color);


174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205
/* Position Setting/Getting Routines */
/* (Setters return the position after it was set) */
gdouble gimp_gradient_segment_get_left_pos    (GimpGradient         *gradient,
                                               GimpGradientSegment  *seg);
gdouble gimp_gradient_segment_set_left_pos    (GimpGradient         *gradient,
                                               GimpGradientSegment  *seg,
                                               gdouble               pos);

gdouble gimp_gradient_segment_get_right_pos   (GimpGradient         *gradient,
                                               GimpGradientSegment  *seg);
gdouble gimp_gradient_segment_set_right_pos   (GimpGradient         *gradient,
                                               GimpGradientSegment  *seg,
                                               gdouble               pos);

gdouble gimp_gradient_segment_get_middle_pos  (GimpGradient         *gradient,
                                               GimpGradientSegment  *seg);
gdouble gimp_gradient_segment_set_middle_pos  (GimpGradient         *gradient,
                                               GimpGradientSegment  *seg,
                                               gdouble               pos);

/* Getting/Setting the Blending Function/Coloring Type */
GimpGradientSegmentType
gimp_gradient_segment_get_blending_function   (GimpGradient         *gradient,
                                               GimpGradientSegment  *seg);
GimpGradientSegmentColor
gimp_gradient_segment_get_coloring_type       (GimpGradient         *gradient,
                                               GimpGradientSegment  *seg);

/*
 * If the second segment is NULL, these functions will process
 * until the end of the string.
 * */
206 207 208 209 210
gint    gimp_gradient_segment_range_get_n_segments
                                              (GimpGradient         *gradient,
                                               GimpGradientSegment  *range_l,
                                               GimpGradientSegment  *range_r);

211 212
void    gimp_gradient_segment_range_compress  (GimpGradient         *gradient,
                                               GimpGradientSegment  *range_l,
213 214 215
                                               GimpGradientSegment  *range_r,
                                               gdouble               new_l,
                                               gdouble               new_r);
216 217
void    gimp_gradient_segment_range_blend     (GimpGradient         *gradient,
                                               GimpGradientSegment  *lseg,
218
                                               GimpGradientSegment  *rseg,
219 220
                                               const GimpRGB        *rgb1,
                                               const GimpRGB        *rgb2,
221 222
                                               gboolean              blend_colors,
                                               gboolean              blend_opacity);
223

224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250
void    gimp_gradient_segment_range_set_blending_function
                                              (GimpGradient         *gradient,
                                               GimpGradientSegment  *start_seg,
                                               GimpGradientSegment  *end_seg,
                                               GimpGradientSegmentType new_type);

void    gimp_gradient_segment_range_set_coloring_type
                                              (GimpGradient         *gradient,
                                               GimpGradientSegment  *start_seg,
                                               GimpGradientSegment  *end_seg,
                                               GimpGradientSegmentColor new_color);

void    gimp_gradient_segment_range_flip      (GimpGradient         *gradient,
                                               GimpGradientSegment  *start_seg,
                                               GimpGradientSegment  *end_seg,
                                               GimpGradientSegment **final_start_seg,
                                               GimpGradientSegment **final_end_seg);

void    gimp_gradient_segment_range_replicate (GimpGradient         *gradient,
                                               GimpGradientSegment  *start_seg,
                                               GimpGradientSegment  *end_seg,
                                               gint                  replicate_times,
                                               GimpGradientSegment **final_start_seg,
                                               GimpGradientSegment **final_end_seg);

void    gimp_gradient_segment_range_split_midpoint
                                              (GimpGradient         *gradient,
251
                                               GimpContext          *context,
252 253
                                               GimpGradientSegment  *start_seg,
                                               GimpGradientSegment  *end_seg,
254
                                               GimpGradientBlendColorSpace blend_color_space,
255 256 257 258 259
                                               GimpGradientSegment **final_start_seg,
                                               GimpGradientSegment **final_end_seg);

void    gimp_gradient_segment_range_split_uniform
                                              (GimpGradient         *gradient,
260
                                               GimpContext          *context,
261 262 263
                                               GimpGradientSegment  *start_seg,
                                               GimpGradientSegment  *end_seg,
                                               gint                  parts,
264
                                               GimpGradientBlendColorSpace blend_color_space,
265 266 267 268 269 270 271 272
                                               GimpGradientSegment **final_start_seg,
                                               GimpGradientSegment **final_end_seg);

void    gimp_gradient_segment_range_delete    (GimpGradient         *gradient,
                                               GimpGradientSegment  *start_seg,
                                               GimpGradientSegment  *end_seg,
                                               GimpGradientSegment **final_start_seg,
                                               GimpGradientSegment **final_end_seg);
273 274 275 276 277 278

void    gimp_gradient_segment_range_merge     (GimpGradient         *gradient,
                                               GimpGradientSegment  *start_seg,
                                               GimpGradientSegment  *end_seg,
                                               GimpGradientSegment **final_start_seg,
                                               GimpGradientSegment **final_end_seg);
279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295

void    gimp_gradient_segment_range_recenter_handles
                                              (GimpGradient         *gradient,
                                               GimpGradientSegment  *start_seg,
                                               GimpGradientSegment  *end_seg);
void    gimp_gradient_segment_range_redistribute_handles
                                              (GimpGradient         *gradient,
                                               GimpGradientSegment  *start_seg,
                                               GimpGradientSegment  *end_seg);

gdouble gimp_gradient_segment_range_move      (GimpGradient         *gradient,
                                               GimpGradientSegment  *range_l,
                                               GimpGradientSegment  *range_r,
                                               gdouble               delta,
                                               gboolean              control_compress);


296
#endif /* __GIMP_GRADIENT_H__ */