adg/adg-entity.h

   1 /* ADG - Automatic Drawing Generation
   2  * Copyright (C) 2007,2008,2009 Nicola Fontana <ntd at entidi.it>
   3  *
   4  * This library is free software; you can redistribute it and/or
   5  * modify it under the terms of the GNU Lesser General Public
   6  * License as published by the Free Software Foundation; either
   7  * version 2 of the License, or (at your option) any later version.
   8  *
   9  * This library is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12  * Lesser General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU Lesser General Public
  15  * License along with this library; if not, write to the
  16  * Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
  17  * Boston, MA  02110-1301, USA.
  18  */
  19
  20
  21 #ifndef __ADG_ENTITY_H__
  22 #define __ADG_ENTITY_H__
  23
  24 #include <adg/adg-util.h>
  25 #include <adg/adg-type-builtins.h>
  26 #include <adg/adg-matrix.h>
  27 #include <cpml/cpml.h>
  28
  29
  30 G_BEGIN_DECLS
  31
  32 #define ADG_TYPE_ENTITY             (adg_entity_get_type())
  33 #define ADG_ENTITY(obj)             (G_TYPE_CHECK_INSTANCE_CAST((obj), ADG_TYPE_ENTITY, AdgEntity))
  34 #define ADG_ENTITY_CLASS(klass)     (G_TYPE_CHECK_CLASS_CAST((klass), ADG_TYPE_ENTITY, AdgEntityClass))
  35 #define ADG_IS_ENTITY(obj)          (G_TYPE_CHECK_INSTANCE_TYPE((obj), ADG_TYPE_ENTITY))
  36 #define ADG_IS_ENTITY_CLASS(klass)  (G_TYPE_CHECK_CLASS_TYPE((klass), ADG_TYPE_ENTITY))
  37 #define ADG_ENTITY_GET_CLASS(obj)   (G_TYPE_INSTANCE_GET_CLASS((obj), ADG_TYPE_ENTITY, AdgEntityClass))
  38
  39
  40 /* Forward declaration */
  41 ADG_FORWARD_DECL(AdgStyle);
  42 typedef gint                     AdgDress;
  43
  44
  45 typedef struct _AdgEntity        AdgEntity;
  46 typedef struct _AdgEntityClass   AdgEntityClass;
  47 typedef void (*AdgEntityCallback) (AdgEntity *entity, gpointer user_data);
  48
  49 ADG_FORWARD_DECL(AdgCanvas);
  50
  51
  52 struct _AdgEntity {
  53     /*< private >*/
  54     GInitiallyUnowned    parent;
  55     gpointer             data;
  56 };
  57
  58 struct _AdgEntityClass {
  59     /*< private >*/
  60     GInitiallyUnownedClass      parent_class;
  61     /*< public >*/
  62     /* Signals */
  63     void                (*parent_set)           (AdgEntity       *entity,
  64                                                  AdgEntity       *old_parent);
  65     void                (*global_changed)       (AdgEntity       *entity);
  66     void                (*local_changed)        (AdgEntity       *entity);
  67
  68     /* Virtual Table */
  69     void                (*invalidate)           (AdgEntity       *entity);
  70     void                (*arrange)              (AdgEntity       *entity);
  71     void                (*render)               (AdgEntity       *entity,
  72                                                  cairo_t         *cr);
  73 };
  74
  75
  76 GType            adg_entity_get_type            (void) G_GNUC_CONST;
  77 AdgCanvas *      adg_entity_get_canvas          (AdgEntity       *entity);
  78
  79 AdgEntity *      adg_entity_get_parent          (AdgEntity       *entity);
  80 void             adg_entity_set_parent          (AdgEntity       *entity,
  81                                                  AdgEntity       *parent);
  82 void             adg_entity_get_global_map      (AdgEntity       *entity,
  83                                                  AdgMatrix       *map);
  84 void             adg_entity_set_global_map      (AdgEntity       *entity,
  85                                                  const AdgMatrix *map);
  86 void             adg_entity_transform_global_map(AdgEntity       *entity,
  87                                                  const AdgMatrix *transformation,
  88                                                  AdgTransformationMode mode);
  89 void             adg_entity_get_local_map       (AdgEntity       *entity,
  90                                                  AdgMatrix       *map);
  91 void             adg_entity_set_local_map       (AdgEntity       *entity,
  92                                                  const AdgMatrix *map);
  93 void             adg_entity_transform_local_map (AdgEntity       *entity,
  94                                                  const AdgMatrix *transformation,
  95                                                  AdgTransformationMode mode);
  96 gboolean         adg_entity_get_normalized      (AdgEntity       *entity);
  97 void             adg_entity_set_normalized      (AdgEntity       *entity,
  98                                                  gboolean         normalized);
  99 void             adg_entity_get_extents         (AdgEntity       *entity,
 100                                                  CpmlExtents     *extents);
 101 void             adg_entity_set_extents         (AdgEntity       *entity,
 102                                                  const CpmlExtents *extents);
 103 AdgStyle *       adg_entity_style               (AdgEntity       *entity,
 104                                                  AdgDress         dress);
 105 AdgStyle *       adg_entity_get_style           (AdgEntity       *entity,
 106                                                  AdgDress         dress);
 107 void             adg_entity_set_style           (AdgEntity       *entity,
 108                                                  AdgDress         dress,
 109                                                  AdgStyle        *style);
 110 void             adg_entity_apply_dress         (AdgEntity       *entity,
 111                                                  AdgDress         dress,
 112                                                  cairo_t         *cr);
 113 const AdgMatrix *adg_entity_global_matrix       (AdgEntity       *entity);
 114 const AdgMatrix *adg_entity_local_matrix        (AdgEntity       *entity);
 115 const AdgMatrix *adg_entity_ctm                 (AdgEntity       *entity);
 116 void             adg_entity_global_changed      (AdgEntity       *entity);
 117 void             adg_entity_local_changed       (AdgEntity       *entity);
 118 void             adg_entity_invalidate          (AdgEntity       *entity);
 119 void             adg_entity_arrange             (AdgEntity       *entity);
 120 void             adg_entity_render              (AdgEntity       *entity,
 121                                                  cairo_t         *cr);
 122
 123 G_END_DECLS
 124
 125
 126 #endif /* __ADG_ENTITY_H__ */