hkl3d/hkl3d.h

   1 /* This file is part of the hkl3d library.
   2  *
   3  * The hkl library is free software: you can redistribute it and/or modify
   4  * it under the terms of the GNU General Public License as published by
   5  * the Free Software Foundation, either version 3 of the License, or
   6  * (at your option) any later version.
   7  *
   8  * The hkl library is distributed in the hope that it will be useful,
   9  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  11  * GNU General Public License for more details.
  12  *
  13  * You should have received a copy of the GNU General Public License
  14  * along with the hkl library.  If not, see <http://www.gnu.org/licenses/>.
  15  *
  16  * Copyright (C) 2010-2019 Synchrotron SOLEIL
  17  *                         L'Orme des Merisiers Saint-Aubin
  18  *                         BP 48 91192 GIF-sur-YVETTE CEDEX
  19  *
  20  * Authors: Picca Frédéric-Emmanuel <picca@synchrotron-soleil.fr>
  21  *          Oussama SBOUI <oussama.sboui@synchrotron-soleil.fr>
  22  */
  23
  24 #ifndef __HKL3D_H__
  25 #define __HKL3D_H__
  26
  27 #include <g3d/types.h>
  28 #include "hkl.h"
  29
  30 // forward declaration due to bullet static linking
  31 struct btCollisionObject;
  32 struct btCollisionWorld;
  33 struct btCollisionConfiguration;
  34 struct btBroadphaseInterface;
  35 struct btCollisionDispatcher;
  36 struct btCollisionShape;
  37 struct btVector3;
  38 struct btTriangleMesh;
  39
  40 #ifdef __cplusplus
  41 extern "C" {
  42 #endif
  43
  44         typedef struct _Hkl3DStats Hkl3DStats;
  45         typedef struct _Hkl3DObject Hkl3DObject;
  46         typedef struct _Hkl3DModel Hkl3DModel;
  47         typedef struct _Hkl3DConfig Hkl3DConfig;
  48         typedef struct _Hkl3DAxis Hkl3DAxis;
  49         typedef struct _Hkl3DGeometry Hkl3DGeometry;
  50         typedef struct _Hkl3D Hkl3D;
  51
  52         /**************/
  53         /* Hkl3DStats */
  54         /**************/
  55
  56         struct _Hkl3DStats
  57         {
  58                 struct timeval collision;
  59                 struct timeval transformation;
  60         };
  61
  62         extern double hkl3d_stats_get_collision_ms(const Hkl3DStats *self);
  63         extern void hkl3d_stats_fprintf(FILE *f, Hkl3DStats *self);
  64
  65         /***************/
  66         /* Hkl3DObject */
  67         /***************/
  68
  69         struct _Hkl3DObject
  70         {
  71                 Hkl3DModel *model; /* weak reference */
  72                 int id;
  73                 Hkl3DAxis *axis; /* weak reference */
  74                 G3DObject *g3d; /* weak reference */
  75                 struct btCollisionObject *btObject;
  76                 struct btCollisionShape *btShape;
  77                 struct btTriangleMesh *meshes;
  78                 struct btVector3 *color;
  79                 int is_colliding;
  80                 int hide;
  81                 int added;
  82                 int selected;
  83                 int movable;
  84                 char *axis_name;
  85                 float transformation[16];
  86         };
  87
  88         extern void hkl3d_object_aabb_get(const Hkl3DObject *self, float from[3], float to[3]);
  89         extern void hkl3d_object_fprintf(FILE *f, const Hkl3DObject *self);
  90
  91         /**************/
  92         /* Hkl3DModel */
  93         /**************/
  94
  95         struct _Hkl3DModel
  96         {
  97                 char *filename;
  98                 G3DModel *g3d;
  99                 Hkl3DObject **objects;
 100                 size_t len;
 101         };
 102
 103         extern void hkl3d_model_fprintf(FILE *f, const Hkl3DModel *self);
 104
 105         /***************/
 106         /* Hkl3DConfig */
 107         /***************/
 108
 109         struct _Hkl3DConfig
 110         {
 111                 Hkl3DModel **models;
 112                 size_t len;
 113         };
 114
 115         extern void hkl3d_config_fprintf(FILE *f, const Hkl3DConfig *self);
 116
 117         /*************/
 118         /* Hkl3DAxis */
 119         /*************/
 120
 121         struct _Hkl3DAxis
 122         {
 123                 Hkl3DObject **objects; /* connected object */
 124                 size_t len;
 125         };
 126
 127         /*****************/
 128         /* HKL3DGeometry */
 129         /*****************/
 130
 131         struct _Hkl3DGeometry
 132         {
 133                 HklGeometry *geometry; /* weak reference */
 134                 Hkl3DAxis **axes;
 135         };
 136
 137         /*********/
 138         /* HKL3D */
 139         /*********/
 140
 141         struct _Hkl3D
 142         {
 143                 char const *filename; /* config filename */
 144                 Hkl3DGeometry *geometry;
 145                 G3DModel *model;
 146                 Hkl3DStats stats;
 147                 Hkl3DConfig *config;
 148
 149                 struct btCollisionConfiguration *_btCollisionConfiguration;
 150                 struct btBroadphaseInterface *_btBroadphase;
 151                 struct btCollisionWorld *_btWorld;
 152                 struct btCollisionDispatcher *_btDispatcher;
 153 #ifdef USE_PARALLEL_DISPATCHER
 154                 struct btThreadSupportInterface *_btThreadSupportInterface;
 155 #endif
 156         };
 157
 158         HKLAPI extern Hkl3D* hkl3d_new(const char *filename, HklGeometry *geometry) HKL_ARG_NONNULL(2);
 159         HKLAPI extern void hkl3d_free(Hkl3D *self) HKL_ARG_NONNULL(1);
 160
 161         HKLAPI extern int hkl3d_is_colliding(Hkl3D *self) HKL_ARG_NONNULL(1);
 162         HKLAPI extern void hkl3d_load_config(Hkl3D *self, const char *filename) HKL_ARG_NONNULL(1, 2);
 163         HKLAPI extern void hkl3d_save_config(Hkl3D *self, const char *filename) HKL_ARG_NONNULL(1, 2);
 164         HKLAPI extern Hkl3DModel *hkl3d_add_model_from_file(Hkl3D *self,
 165                                                             const char *filename,
 166                                                             const char *directory) HKL_ARG_NONNULL(1, 2, 3);
 167
 168         HKLAPI extern void hkl3d_connect_all_axes(Hkl3D *self) HKL_ARG_NONNULL(1);
 169         HKLAPI extern void hkl3d_hide_object(Hkl3D *self, Hkl3DObject *object, int hide) HKL_ARG_NONNULL(1, 2);
 170         HKLAPI extern void hkl3d_remove_object(Hkl3D *self, Hkl3DObject *object) HKL_ARG_NONNULL(1, 2);
 171
 172         HKLAPI extern void hkl3d_get_bounding_boxes(Hkl3D *self,
 173                                                     struct btVector3 *min,
 174                                                     struct btVector3 *max) HKL_ARG_NONNULL(1, 2, 3);
 175         HKLAPI extern int hkl3d_get_nb_manifolds(Hkl3D *self) HKL_ARG_NONNULL(1);
 176         HKLAPI extern int hkl3d_get_nb_contacts(Hkl3D *self, int manifold) HKL_ARG_NONNULL(1);
 177         HKLAPI extern void hkl3d_get_collision_coordinates(Hkl3D *self, int manifold, int contact,
 178                                                            double *xa, double *ya, double *za,
 179                                                            double *xb, double *yb, double *zb) HKL_ARG_NONNULL(1);
 180         HKLAPI extern void hkl3d_connect_object_to_axis(Hkl3D *self,
 181                                                         Hkl3DObject *object,
 182                                                         const char *name) HKL_ARG_NONNULL(1, 2, 3);
 183
 184         HKLAPI extern void hkl3d_fprintf(FILE *f, const Hkl3D *self) HKL_ARG_NONNULL(1, 2);
 185
 186 #ifdef __cplusplus
 187 }
 188 #endif
 189
 190 #endif