gimp/app/core/gimpbrush.h

/* GIMP - The GNU Image Manipulation Program
 * Copyright (C) 1995 Spencer Kimball and Peter Mattis
 *
 * This program 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.
 *
 * 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
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

#ifndef __GIMP_BRUSH_H__
#define __GIMP_BRUSH_H__


#include "libgimpmath/gimpvector.h"
#include "gimpdata.h"


#define GIMP_TYPE_BRUSH            (gimp_brush_get_type ())
#define GIMP_BRUSH(obj)            (G_TYPE_CHECK_INSTANCE_CAST ((obj), GIMP_TYPE_BRUSH, GimpBrush))
#define GIMP_BRUSH_CLASS(klass)    (G_TYPE_CHECK_CLASS_CAST ((klass), GIMP_TYPE_BRUSH, GimpBrushClass))
#define GIMP_IS_BRUSH(obj)         (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GIMP_TYPE_BRUSH))
#define GIMP_IS_BRUSH_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GIMP_TYPE_BRUSH))
#define GIMP_BRUSH_GET_CLASS(obj)  (G_TYPE_INSTANCE_GET_CLASS ((obj), GIMP_TYPE_BRUSH, GimpBrushClass))


typedef struct _GimpBrushClass GimpBrushClass;

struct _GimpBrush
{
  GimpData      parent_instance;

  TempBuf      *mask;       /*  the actual mask                */
  TempBuf      *pixmap;     /*  optional pixmap data           */

  gint          spacing;    /*  brush's spacing                */
  GimpVector2   x_axis;     /*  for calculating brush spacing  */
  GimpVector2   y_axis;     /*  for calculating brush spacing  */
};

struct _GimpBrushClass
{
  GimpDataClass parent_class;

  /*  virtual functions  */
  GimpBrush * (* select_brush)     (GimpBrush        *brush,
                                    const GimpCoords *last_coords,
                                    const GimpCoords *current_coords);
  gboolean    (* want_null_motion) (GimpBrush        *brush,
                                    const GimpCoords *last_coords,
                                    const GimpCoords *current_coords);
  void        (* transform_size)   (GimpBrush        *brush,
                                    gdouble           scale,
                                    gdouble           aspect_ratio,
                                    gdouble           angle,
                                    gint             *width,
                                    gint             *height);
  TempBuf   * (* transform_mask)   (GimpBrush        *brush,
                                    gdouble           scale,
                                    gdouble           aspect_ratio,
                                    gdouble           angle,
                                    gdouble           hardness);
  TempBuf   * (* transform_pixmap) (GimpBrush        *brush,
                                    gdouble           scale,
                                    gdouble           aspect_ratio,
                                    gdouble           angle,
                                    gdouble           hardness);

  /*  signals  */
  void        (* spacing_changed)  (GimpBrush        *brush);
};


GType       gimp_brush_get_type         (void) G_GNUC_CONST;

GimpData  * gimp_brush_new              (GimpContext      *context,
                                         const gchar      *name);
GimpData  * gimp_brush_get_standard     (GimpContext      *context);

GimpBrush * gimp_brush_select_brush     (GimpBrush        *brush,
                                         const GimpCoords *last_coords,
                                         const GimpCoords *current_coords);
gboolean    gimp_brush_want_null_motion (GimpBrush        *brush,
                                         const GimpCoords *last_coords,
                                         const GimpCoords *current_coords);

/* Gets width and height of a transformed mask of the brush, for provided parameters. */
void        gimp_brush_transform_size   (GimpBrush        *brush,
                                         gdouble           scale,
                                         gdouble           aspect_ratio,
                                         gdouble           angle,
                                         gint             *width,
                                         gint             *height);
TempBuf   * gimp_brush_transform_mask   (GimpBrush        *brush,
                                         gdouble           scale,
                                         gdouble           aspect_ratio,
                                         gdouble           angle,
                                         gdouble           hardness);
TempBuf   * gimp_brush_transform_pixmap (GimpBrush        *brush,
                                         gdouble           scale,
                                         gdouble           aspect_ratio,
                                         gdouble           angle,
                                         gdouble           hardness);

gdouble     gimp_brush_clamp_scale      (GimpBrush        *brush,
                                         gdouble           scale);

TempBuf   * gimp_brush_get_mask         (const GimpBrush  *brush);
TempBuf   * gimp_brush_get_pixmap       (const GimpBrush  *brush);

gint        gimp_brush_get_spacing      (const GimpBrush  *brush);
void        gimp_brush_set_spacing      (GimpBrush        *brush,
                                         gint              spacing);
void        gimp_brush_spacing_changed  (GimpBrush        *brush);


#endif /* __GIMP_BRUSH_H__ */