hkl/hkl-axis-private.h

   1 /* This file is part of the hkl 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) 2003-2017 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  */
  22 #ifndef __HKL_AXIS_PRIVATE_H__
  23 #define __HKL_AXIS_PRIVATE_H__
  24
  25 #include "hkl-parameter-private.h"      // for _HklParameter
  26 #include "hkl-quaternion-private.h"     // for _HklQuaternion
  27 #include "hkl-vector-private.h"         // for HklVector, HklQuaternion
  28 #include "hkl.h"                        // for HklParameter, etc
  29
  30 G_BEGIN_DECLS
  31
  32 typedef struct _HklAxis HklAxis;
  33 typedef struct _HklRotationWithOrigin HklRotationWithOrigin;
  34 typedef struct _HklTranslation HklTranslation;
  35
  36 struct _HklAxis {
  37         HklParameter parameter;
  38         HklVector axis_v;
  39         HklQuaternion q; /* internal */
  40 };
  41
  42 struct _HklRotationWithOrigin {
  43         HklAxis axis;
  44         HklVector origin;
  45 };
  46
  47 struct _HklTranslation {
  48         HklParameter parameter;
  49         HklVector axis_v;
  50 };
  51
  52 extern HklParameter *hkl_parameter_new_rotation(const char* name,
  53                                                 HklVector const *axis_v,
  54                                                 const HklUnit *punit);
  55
  56 extern HklParameter *hkl_parameter_new_rotation_with_origin(const char* name,
  57                                                             const HklVector *axis_v,
  58                                                             const HklVector *origin,
  59                                                             const HklUnit *punit);
  60
  61 extern HklParameter *hkl_parameter_new_translation(const char *name,
  62                                                    const HklVector *axis_v,
  63                                                    const HklUnit *punit);
  64
  65 G_END_DECLS
  66
  67 #endif /* __HKL_AXIS_PRIVATE_H__ */