goat3d

view src/goat3d.h @ 26:1c601bf07b86

find changesets by author, revision, files, or words in the commit message
added the node API glue
author John Tsiombikas <nuclear@member.fsf.org>
date Sat, 28 Sep 2013 20:36:55 +0300
parents d0260d80ae09
children 4deb0b12fe14
line source
1 #ifndef GOAT3D_H_
2 #define GOAT3D_H_
3
4 #include <stdio.h>
5 #include <stdlib.h>
6
7 #define GOAT3D_MAT_ATTR_DIFFUSE "diffuse"
8 #define GOAT3D_MAT_ATTR_SPECULAR "specular"
9 #define GOAT3D_MAT_ATTR_SHININESS "shininess"
10 #define GOAT3D_MAT_ATTR_NORMAL "normal"
11 #define GOAT3D_MAT_ATTR_BUMP "bump"
12 #define GOAT3D_MAT_ATTR_REFLECTION "reflection"
13 #define GOAT3D_MAT_ATTR_TRANSMISSION "transmission"
14 #define GOAT3D_MAT_ATTR_IOR "ior"
15
16 enum goat3d_mesh_attrib {
17 GOAT3D_MESH_ATTR_VERTEX,
18 GOAT3D_MESH_ATTR_NORMAL,
19 GOAT3D_MESH_ATTR_TANGENT,
20 GOAT3D_MESH_ATTR_TEXCOORD,
21 GOAT3D_MESH_ATTR_SKIN_WEIGHT,
22 GOAT3D_MESH_ATTR_SKIN_MATRIX,
23 GOAT3D_MESH_ATTR_COLOR,
24
25 NUM_GOAT3D_MESH_ATTRIBS
26 };
27
28 enum goat3d_node_type {
29 GOAT3D_NODE_NULL,
30 GOAT3D_NODE_MESH,
31 GOAT3D_NODE_LIGHT,
32 GOAT3D_NODE_CAMERA
33 };
34
35 /* immediate mode mesh construction primitive type */
36 enum goat3d_im_primitive {
37 GOAT3D_TRIANGLES,
38 GOAT3D_QUADS
39 };
40
41
42 enum goat3d_option {
43 GOAT3D_OPT_SAVEXML, /* save in XML format */
44
45 NUM_GOAT3D_OPTIONS
46 };
47
48 struct goat3d;
49 struct goat3d_material;
50 struct goat3d_mesh;
51 struct goat3d_light;
52 struct goat3d_camera;
53 struct goat3d_node;
54
55 struct goat3d_io {
56 void *cls; /* closure data */
57
58 long (*read)(void *buf, size_t bytes, void *uptr);
59 long (*write)(const void *buf, size_t bytes, void *uptr);
60 long (*seek)(long offs, int whence, void *uptr);
61 };
62
63 #ifdef __cplusplus
64 extern "C" {
65 #endif
66
67 /* construction/destruction */
68 struct goat3d *goat3d_create(void);
69 void goat3d_free(struct goat3d *g);
70
71 void goat3d_setopt(struct goat3d *g, enum goat3d_option opt, int val);
72 int goat3d_getopt(const struct goat3d *g, enum goat3d_option opt);
73
74 /* load/save */
75 int goat3d_load(struct goat3d *g, const char *fname);
76 int goat3d_save(const struct goat3d *g, const char *fname);
77
78 int goat3d_load_file(struct goat3d *g, FILE *fp);
79 int goat3d_save_file(const struct goat3d *g, FILE *fp);
80
81 int goat3d_load_io(struct goat3d *g, struct goat3d_io *io);
82 int goat3d_save_io(const struct goat3d *g, struct goat3d_io *io);
83
84 /* misc scene properties */
85 int goat3d_set_name(struct goat3d *g, const char *name);
86 const char *goat3d_get_name(const struct goat3d *g);
87
88 void goat3d_set_ambient(struct goat3d *g, const float *ambient);
89 void goat3d_set_ambient3f(struct goat3d *g, float ar, float ag, float ab);
90 const float *goat3d_get_ambient(const struct goat3d *g);
91
92 /* materials */
93 struct goat3d_material *goat3d_create_mtl(void);
94 void goat3d_destroy_mtl(struct goat3d_material *mtl);
95
96 void goat3d_set_mtl_name(struct goat3d_material *mtl, const char *name);
97 const char *goat3d_get_mtl_name(const struct goat3d_material *mtl);
98
99 void goat3d_set_mtl_attrib(struct goat3d_material *mtl, const char *attrib, const float *val);
100 void goat3d_set_mtl_attrib1f(struct goat3d_material *mtl, const char *attrib, float val);
101 void goat3d_set_mtl_attrib3f(struct goat3d_material *mtl, const char *attrib, float r, float g, float b);
102 void goat3d_set_mtl_attrib4f(struct goat3d_material *mtl, const char *attrib, float r, float g, float b, float a);
103 const float *goat3d_get_mtl_attrib(struct goat3d_material *mtl, const char *attrib);
104
105 void goat3d_set_mtl_attrib_map(struct goat3d_material *mtl, const char *attrib, const char *mapname);
106 const char *goat3d_get_mtl_attrib_map(struct goat3d_material *mtl, const char *attrib);
107
108 void goat3d_add_mtl(struct goat3d *g, struct goat3d_material *mtl);
109
110 /* meshes */
111 struct goat3d_mesh *goat3d_create_mesh(void);
112 void goat3d_destroy_mesh(struct goat3d_mesh *mesh);
113
114 void goat3d_set_mesh_name(struct goat3d_mesh *mesh, const char *name);
115 const char *goat3d_get_mesh_name(const struct goat3d_mesh *mesh);
116
117 void goat3d_set_mesh_mtl(struct goat3d_mesh *mesh, struct goat3d_material *mtl);
118 struct goat3d_material *goat3d_get_mesh_mtl(struct goat3d_mesh *mesh);
119
120 int goat3d_get_mesh_attrib_count(struct goat3d_mesh *mesh, enum goat3d_mesh_attrib attrib);
121 int goat3d_get_mesh_face_count(struct goat3d_mesh *mesh);
122
123 /* sets all the data for a single vertex attribute array in one go.
124 * vnum is the number of *vertices* to be set, not the number of floats, ints or whatever
125 * data is expected to be something different depending on the attribute:
126 * - GOAT3D_MESH_ATTR_VERTEX - 3 floats per vertex
127 * - GOAT3D_MESH_ATTR_NORMAL - 3 floats per vertex
128 * - GOAT3D_MESH_ATTR_TANGENT - 3 floats per vertex
129 * - GOAT3D_MESH_ATTR_TEXCOORD - 2 floats per vertex
130 * - GOAT3D_MESH_ATTR_SKIN_WEIGHT - 4 floats per vertex
131 * - GOAT3D_MESH_ATTR_SKIN_MATRIX - 4 ints per vertex
132 * - GOAT3D_MESH_ATTR_COLOR - 4 floats per vertex
133 */
134 void goat3d_set_mesh_attribs(struct goat3d_mesh *mesh, enum goat3d_mesh_attrib attrib, const void *data, int vnum);
135 /* returns a pointer to the beginning of the requested mesh attribute array */
136 void *goat3d_get_mesh_attribs(struct goat3d_mesh *mesh, enum goat3d_mesh_attrib attrib);
137 /* returns a pointer to the requested mesh attribute */
138 void *goat3d_get_mesh_attrib(struct goat3d_mesh *mesh, enum goat3d_mesh_attrib attrib, int idx);
139
140 /* sets all the faces in one go. data is an array of 3 int vertex indices per face */
141 void goat3d_set_mesh_faces(struct goat3d_mesh *mesh, const int *data, int fnum);
142 /* returns a pointer to the beginning of the face index array */
143 int *goat3d_get_mesh_faces(struct goat3d_mesh *mesh);
144 /* returns a pointer to a face index */
145 int *goat3d_get_mesh_face(struct goat3d_mesh *mesh, int idx);
146
147 /* immediate mode OpenGL-like interface for setting mesh data
148 * NOTE: using this interface will result in no vertex sharing between faces
149 * NOTE2: the immedate mode interface is not thread-safe, either use locks, or don't
150 * use it at all in multithreaded situations.
151 */
152 void goat3d_begin(struct goat3d_mesh *mesh, enum goat3d_im_primitive prim);
153 void goat3d_end(void);
154 void goat3d_vertex3f(float x, float y, float z);
155 void goat3d_normal3f(float x, float y, float z);
156 void goat3d_tangent3f(float x, float y, float z);
157 void goat3d_texcoord2f(float x, float y);
158 void goat3d_skin_weight4f(float x, float y, float z, float w);
159 void goat3d_skin_matrix4i(int x, int y, int z, int w);
160 void goat3d_color3f(float x, float y, float z);
161 void goat3d_color4f(float x, float y, float z, float w);
162
163 void goat3d_add_mesh(struct goat3d *g, struct goat3d_mesh *mesh);
164
165 int goat3d_get_mesh_count(struct goat3d *g);
166 struct goat3d_mesh *goat3d_get_mesh(struct goat3d *g, int idx);
167
168 /* nodes */
169 struct goat3d_node *goat3d_create_node(void);
170
171 void goat3d_set_node_name(struct goat3d_node *node, const char *name);
172 const char *goat3d_get_node_name(const struct goat3d_node *node);
173
174 void goat3d_set_node_object(struct goat3d_node *node, enum goat3d_node_type type, void *obj);
175 void *goat3d_get_node_object(const struct goat3d_node *node);
176 enum goat3d_node_type goat3d_get_node_type(const struct goat3d_node *node);
177
178 void goat3d_add_node_child(struct goat3d_node *node, struct goat3d_node *child);
179 int goat3d_get_node_child_count(const struct goat3d_node *node);
180 struct goat3d_node *goat3d_get_node_child(const struct goat3d_node *node, int idx);
181
182 void goat3d_set_node_position(struct goat3d_node *node, float x, float y, float z, long tmsec);
183 void goat3d_set_node_rotation(struct goat3d_node *node, float qx, float qy, float qz, float qw, long tmsec);
184 void goat3d_set_node_scaling(struct goat3d_node *node, float sx, float sy, float sz, long tmsec);
185 void goat3d_set_node_pivot(struct goat3d_node *node, float px, float py, float pz);
186
187 void goat3d_get_node_position(const struct goat3d_node *node, float *xptr, float *yptr, float *zptr, long tmsec);
188 void goat3d_get_node_rotation(const struct goat3d_node *node, float *xptr, float *yptr, float *zptr, float *wptr, long tmsec);
189 void goat3d_get_node_scaling(const struct goat3d_node *node, float *xptr, float *yptr, float *zptr, long tmsec);
190 void goat3d_get_node_pivot(const struct goat3d_node *node, float *xptr, float *yptr, float *zptr);
191
192 void goat3d_get_node_matrix(const struct goat3d_node *node, float *matrix, long tmsec);
193
194 #ifdef __cplusplus
195 }
196 #endif
197
198 #endif /* GOAT3D_H_ */