2 * Copyright (C) 2009-2011 Andy Spencer <andy753421@gmail.com>
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.
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.
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/>.
18 #ifndef __GRITS_OBJECT_H__
19 #define __GRITS_OBJECT_H__
22 #include <glib-object.h>
23 #include "grits-util.h"
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))
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)
46 typedef struct _GritsObject GritsObject;
47 typedef struct _GritsObjectClass GritsObjectClass;
49 #include "grits-opengl.h"
51 GObject parent_instance;
52 GritsViewer *viewer; // The viewer the object was added to
53 gpointer ref; // Reference for objects that have been added
54 GritsPoint center; // Center of the object
55 gboolean hidden; // If true, the object will not be drawn
56 gdouble lod; // Level of detail, used to hide small objects
57 guint32 skip; // Bit mask of safe operations
59 GritsState state; // Internal, used for picking
60 GdkCursor *cursor; // Internal, cached cursor
63 struct _GritsObjectClass {
64 GObjectClass parent_class;
66 /* Move some of these to GObject? */
67 void (*draw) (GritsObject *object, GritsOpenGL *opengl);
68 void (*pick) (GritsObject *object, GritsOpenGL *opengl);
69 void (*hide) (GritsObject *object, gboolean hidden);
72 GType grits_object_get_type(void);
74 /* Implemented by sub-classes */
75 void grits_object_draw(GritsObject *object, GritsOpenGL *opengl);
77 void grits_object_hide(GritsObject *object, gboolean hidden);
79 /* Interal, used by grits_opengl */
80 void grits_object_pick(GritsObject *object, GritsOpenGL *opengl);
81 gboolean grits_object_set_pointer(GritsObject *object, GdkEvent *event, gboolean selected);
82 gboolean grits_object_event(GritsObject *object, GdkEvent *event);
85 * grits_object_queue_draw:
86 * @object: The #GritsObject that needs drawing
88 * Cause the widget to be redrawn on the screen at some later point
90 void grits_object_queue_draw(GritsObject *object);
93 * grits_object_set_cursor:
94 * @object: The #GritsObject to set the cursor for
95 * @cursor: The cursor to use when the object is hovered over
97 * Causes the cursor to use a particular icon when located over a given object
99 void grits_object_set_cursor(GritsObject *object, GdkCursorType cursor);
102 * grits_object_center:
103 * @object: The #GritsObject to get the center of
105 * Get the #GritsPoint representing the center of an object
107 * Returns: the center point
109 #define grits_object_center(object) \
110 (&GRITS_OBJECT(object)->center)