Pileus Git - grits/blob - src/objects/grits-object.h

   1 /*
   2  * Copyright (C) 2009-2011 Andy Spencer <andy753421@gmail.com>
   3  *
   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  * (at your option) any later version.
   8  *
   9  * This program 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
  12  * GNU General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU General Public License
  15  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  16  */
  17
  18 #ifndef __GRITS_OBJECT_H__
  19 #define __GRITS_OBJECT_H__
  20
  21 #include <glib.h>
  22 #include <glib-object.h>
  23 #include "grits-util.h"
  24
  25 /* GritsObject */
  26 #define GRITS_TYPE_OBJECT            (grits_object_get_type())
  27 #define GRITS_OBJECT(obj)            (G_TYPE_CHECK_INSTANCE_CAST((obj),   GRITS_TYPE_OBJECT, GritsObject))
  28 #define GRITS_IS_OBJECT(obj)         (G_TYPE_CHECK_INSTANCE_TYPE((obj),   GRITS_TYPE_OBJECT))
  29 #define GRITS_OBJECT_CLASS(klass)    (G_TYPE_CHECK_CLASS_CAST   ((klass), GRITS_TYPE_OBJECT, GritsObjectClass))
  30 #define GRITS_IS_OBJECT_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE   ((klass), GRITS_TYPE_OBJECT))
  31 #define GRITS_OBJECT_GET_CLASS(obj)  (G_TYPE_INSTANCE_GET_CLASS ((obj),   GRITS_TYPE_OBJECT, GritsObjectClass))
  32
  33 /* Bitmask of things to skip while drawing the object */
  34 #define GRITS_SKIP_LOD     (1<<0)
  35 #define GRITS_SKIP_HORIZON (1<<1)
  36 #define GRITS_SKIP_CENTER  (1<<2)
  37 #define GRITS_SKIP_STATE   (1<<3)
  38
  39 /* Mouse move threshold for clicking */
  40 #define GRITS_CLICK_THRESHOLD 8
  41
  42 /* Picking states */
  43 typedef struct {
  44         guint picked   : 1;
  45         guint selected : 1;
  46         guint clicking : 6;
  47 } GritsState;
  48
  49 typedef struct _GritsObject      GritsObject;
  50 typedef struct _GritsObjectClass GritsObjectClass;
  51
  52 #include "grits-opengl.h"
  53 struct _GritsObject {
  54         GObject      parent_instance;
  55         GritsViewer *viewer; // The viewer the object was added to
  56         gpointer     ref;    // Reference for objects that have been added
  57         GritsPoint   center; // Center of the object
  58         gboolean     hidden; // If true, the object will not be drawn
  59         gdouble      lod;    // Level of detail, used to hide small objects
  60         guint32      skip;   // Bit mask of safe operations
  61
  62         GritsState   state;  // Internal, used for picking
  63         GdkCursor   *cursor; // Internal, cached cursor
  64 };
  65
  66 struct _GritsObjectClass {
  67         GObjectClass parent_class;
  68
  69         /* Move some of these to GObject? */
  70         void (*draw) (GritsObject *object, GritsOpenGL *opengl);
  71         void (*pick) (GritsObject *object, GritsOpenGL *opengl);
  72         void (*hide) (GritsObject *object, gboolean hidden);
  73 };
  74
  75 GType grits_object_get_type(void);
  76
  77 /* Implemented by sub-classes */
  78 void grits_object_draw(GritsObject *object, GritsOpenGL *opengl);
  79
  80 void grits_object_hide(GritsObject *object, gboolean hidden);
  81
  82 /* Interal, used by grits_opengl */
  83 void grits_object_pick(GritsObject *object, GritsOpenGL *opengl);
  84 gboolean grits_object_set_pointer(GritsObject *object, GdkEvent *event, gboolean selected);
  85 gboolean grits_object_event(GritsObject *object, GdkEvent *event);
  86
  87 /**
  88  * grits_object_queue_draw:
  89  * @object: The #GritsObject that needs drawing
  90  *
  91  * Cause the widget to be redrawn on the screen at some later point
  92  */
  93 void grits_object_queue_draw(GritsObject *object);
  94
  95 /**
  96  * grits_object_set_cursor:
  97  * @object: The #GritsObject to set the cursor for
  98  * @cursor: The cursor to use when the object is hovered over
  99  *
 100  * Causes the cursor to use a particular icon when located over a given object
 101  */
 102 void grits_object_set_cursor(GritsObject *object, GdkCursorType cursor);
 103
 104 /**
 105  * grits_object_destroy:
 106  * @object: The #GritsObject to destroy
 107  *
 108  * Removes the widget from it's current viewer (if it has one) and decrements
 109  * it's reference count.
 110  */
 111 void grits_object_destroy(GritsObject *object);
 112
 113 /**
 114  * grits_object_destroy_pointer:
 115  * @object: The pointer to the #GritsObject to destroy
 116  *
 117  * This functions the same as grits_object_destroy, except that the location of
 118  * the object is set to null before proceeding.
 119  */
 120 #define grits_object_destroy_pointer(object) ({           \
 121         if (*object) {                                    \
 122                 GritsObject *tmp = GRITS_OBJECT(*object); \
 123                 *object = NULL;                           \
 124                 grits_object_destroy(tmp);                \
 125         }                                                 \
 126 })
 127
 128 /**
 129  * grits_object_center:
 130  * @object: The #GritsObject to get the center of
 131  *
 132  * Get the #GritsPoint representing the center of an object
 133  *
 134  * Returns: the center point
 135  */
 136 #define grits_object_center(object) \
 137         (&GRITS_OBJECT(object)->center)
 138
 139 #endif