git.rot13.org Git - simavr/blob - examples/board_reprap/src/c3/c3geometry.h

   1 /*
   2         c3geometry.h
   3
   4         Copyright 2008-2012 Michel Pollet <buserror@gmail.com>
   5
   6         This file is part of simavr.
   7
   8         simavr is free software: you can redistribute it and/or modify
   9         it under the terms of the GNU General Public License as published by
  10         the Free Software Foundation, either version 3 of the License, or
  11         (at your option) any later version.
  12
  13         simavr is distributed in the hope that it will be useful,
  14         but WITHOUT ANY WARRANTY; without even the implied warranty of
  15         MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16         GNU General Public License for more details.
  17
  18         You should have received a copy of the GNU General Public License
  19         along with simavr.  If not, see <http://www.gnu.org/licenses/>.
  20  */
  21
  22 /*
  23  * c3geometry is a structure containing one set of vertices and various
  24  * bits related to it. Ultimately it contains a pre-cached projected
  25  * version of the vertices that the drawing code can use directly.
  26  * c3geometry is aways attached to a c3object as a parent.
  27  */
  28
  29 #ifndef __C3GEOMETRY_H___
  30 #define __C3GEOMETRY_H___
  31
  32 #include "c3/c3algebra.h"
  33 #include "c_utils.h"
  34
  35 typedef c3vec3 c3vertex;
  36 typedef c3vec4 c3colorf;
  37 typedef c3vec2 c3tex;
  38
  39 struct c3object_t;
  40
  41 DECLARE_C_ARRAY(c3vertex, c3vertex_array, 16);
  42 DECLARE_C_ARRAY(c3tex, c3tex_array, 16);
  43 DECLARE_C_ARRAY(c3colorf, c3colorf_array, 16);
  44
  45 //! Geometry material. TODO: Beef up. Add vertex/fragment programs..
  46 typedef struct c3material_t {
  47         c3colorf        color;
  48         uint32_t        texture;
  49 } c3material_t;
  50
  51 //! Bounding box. TODO: Move to a separate file?
  52 typedef struct c3bbox_t {
  53         c3vec3  min, max;
  54 } c3bbox_t;
  55
  56 //! Generic geometry type
  57 enum {
  58         C3_RAW_TYPE = 0,
  59         C3_TRIANGLE_TYPE,
  60         C3_TEXTURE_TYPE,
  61 };
  62
  63 /*!
  64  * geometry type.
  65  * The type is used as non-opengl description of what the geometry
  66  * contains, like "texture", and the subtype can be used to store the
  67  * real format of the vertices. like GL_LINES etc
  68  */
  69 typedef union {
  70         struct  { uint32_t type : 16, subtype : 16; };
  71         uint32_t value;
  72 } c3geometry_type_t;
  73
  74 /*!
  75  * Geometry object. Describes a set of vertices, texture coordinates,
  76  * normals, colors and material
  77  * The projection is not set here, a geometry is always attached to a
  78  * c3object that has the projection
  79  */
  80 typedef struct c3geometry_t {
  81         c3geometry_type_t       type;   // C3_TRIANGLE_TYPE, GL_LINES etc
  82         int                                     dirty : 1,
  83                                                 texture : 1,    // has a valid material.texture
  84                                                 custom : 1;             // has a custom driver
  85         str_p                           name;   // optional
  86         c3material_t            mat;
  87         struct c3object_t * object;
  88         const struct c3driver_geometry_t ** driver;
  89
  90         c3vertex_array_t        vertice;
  91         c3tex_array_t           textures;
  92         c3colorf_array_t        colorf;
  93         c3vertex_array_t        normals;
  94
  95         // projected version of the vertice
  96         c3vertex_array_t        projected;
  97         c3bbox_t                        bbox;
  98 } c3geometry_t, *c3geometry_p;
  99
 100 DECLARE_C_ARRAY(c3geometry_p, c3geometry_array, 4);
 101
 102 //! Allocates a new geometry, init it, and attached it to parent 'o' (optional)
 103 c3geometry_p
 104 c3geometry_new(
 105                 c3geometry_type_t type,
 106                 struct c3object_t * o /* = NULL */);
 107 //! Init an existing new geometry, and attached it to parent 'o' (optional)
 108 c3geometry_p
 109 c3geometry_init(
 110                 c3geometry_p g,
 111                 c3geometry_type_t type,
 112                 struct c3object_t * o /* = NULL */);
 113 //! Disposes (via the driver interface) the geometry
 114 void
 115 c3geometry_dispose(
 116                 c3geometry_p g);
 117
 118 //! Prepares a geometry.
 119 /*!
 120  * The prepare phase is called only when the container object is 'dirty'
 121  * for example if it's projection has changed.
 122  * The prepare call is responsible for reprojecting the geometry and that
 123  * sort of things
 124  */
 125 void
 126 c3geometry_prepare(
 127                 c3geometry_p g );
 128
 129 //! Draw the geometry
 130 /*
 131  * Called when drawing the context. Typicaly this calls the geometry
 132  * driver, which in turn will call the 'context' draw method, and the
 133  * application to draw this particular geometry
 134  */
 135 void
 136 c3geometry_draw(
 137                 c3geometry_p g );
 138
 139
 140 //! allocate (if not there) and return a custom driver for this geometry
 141 /*!
 142  * Geometries come with a default, read only driver stack.. It is a constant
 143  * global to save memory for each of the 'generic' object.
 144  * This call will duplicate that stack and allocate (if not there) a read/write
 145  * empty driver that the application can use to put their own, per object,
 146  * callback. For example you can add your own prepare() or draw() function
 147  * and have it called first
 148  */
 149 struct c3driver_geometry_t *
 150 c3geometry_get_custom(
 151                 c3geometry_p g );
 152
 153 IMPLEMENT_C_ARRAY(c3geometry_array);
 154 IMPLEMENT_C_ARRAY(c3vertex_array);
 155 IMPLEMENT_C_ARRAY(c3tex_array);
 156 IMPLEMENT_C_ARRAY(c3colorf_array);
 157
 158 static inline c3geometry_type_t
 159 c3geometry_type(int type, int subtype)
 160 {
 161         c3geometry_type_t r = { .type = type, .subtype = subtype };
 162         return r;
 163 }
 164
 165 #endif /* __C3GEOMETRY_H___ */