graphene-quaternion.h 7.97 KB
Newer Older
Iñigo Martínez's avatar
Iñigo Martínez committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136
/* graphene-quaternion.h: Quaternion
 *
 * Copyright 2014  Emmanuele Bassi
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */

#ifndef __GRAPHENE_QUATERNION_H__
#define __GRAPHENE_QUATERNION_H__

#if !defined(GRAPHENE_H_INSIDE) && !defined(GRAPHENE_COMPILATION)
#error "Only graphene.h can be included directly."
#endif

#include "graphene-types.h"
#include "graphene-vec4.h"

GRAPHENE_BEGIN_DECLS

/**
 * graphene_quaternion_t:
 *
 * A quaternion.
 *
 * The contents of the #graphene_quaternion_t structure are private
 * and should never be accessed directly.
 *
 * Since: 1.0
 */
struct _graphene_quaternion_t
{
  /*< private >*/
  GRAPHENE_PRIVATE_FIELD (float, x);
  GRAPHENE_PRIVATE_FIELD (float, y);
  GRAPHENE_PRIVATE_FIELD (float, z);
  GRAPHENE_PRIVATE_FIELD (float, w);
};

GRAPHENE_AVAILABLE_IN_1_0
graphene_quaternion_t * graphene_quaternion_alloc                       (void);
GRAPHENE_AVAILABLE_IN_1_0
void                    graphene_quaternion_free                        (graphene_quaternion_t       *q);

GRAPHENE_AVAILABLE_IN_1_0
graphene_quaternion_t * graphene_quaternion_init                        (graphene_quaternion_t       *q,
                                                                         float                        x,
                                                                         float                        y,
                                                                         float                        z,
                                                                         float                        w);
GRAPHENE_AVAILABLE_IN_1_0
graphene_quaternion_t * graphene_quaternion_init_identity               (graphene_quaternion_t       *q);
GRAPHENE_AVAILABLE_IN_1_0
graphene_quaternion_t * graphene_quaternion_init_from_quaternion        (graphene_quaternion_t       *q,
                                                                         const graphene_quaternion_t *src);
GRAPHENE_AVAILABLE_IN_1_0
graphene_quaternion_t * graphene_quaternion_init_from_vec4              (graphene_quaternion_t       *q,
                                                                         const graphene_vec4_t       *src);
GRAPHENE_AVAILABLE_IN_1_0
graphene_quaternion_t * graphene_quaternion_init_from_matrix            (graphene_quaternion_t       *q,
                                                                         const graphene_matrix_t     *m);
GRAPHENE_AVAILABLE_IN_1_0
graphene_quaternion_t * graphene_quaternion_init_from_angles            (graphene_quaternion_t       *q,
                                                                         float                        deg_x,
                                                                         float                        deg_y,
                                                                         float                        deg_z);
GRAPHENE_AVAILABLE_IN_1_4
graphene_quaternion_t * graphene_quaternion_init_from_radians           (graphene_quaternion_t       *q,
                                                                         float                        rad_x,
                                                                         float                        rad_y,
                                                                         float                        rad_z);
GRAPHENE_AVAILABLE_IN_1_0
graphene_quaternion_t * graphene_quaternion_init_from_angle_vec3        (graphene_quaternion_t       *q,
                                                                         float                        angle,
                                                                         const graphene_vec3_t       *axis);
GRAPHENE_AVAILABLE_IN_1_2
graphene_quaternion_t * graphene_quaternion_init_from_euler             (graphene_quaternion_t       *q,
                                                                         const graphene_euler_t      *e);

GRAPHENE_AVAILABLE_IN_1_0
void                    graphene_quaternion_to_vec4                     (const graphene_quaternion_t *q,
                                                                         graphene_vec4_t             *res);
GRAPHENE_AVAILABLE_IN_1_0
void                    graphene_quaternion_to_matrix                   (const graphene_quaternion_t *q,
                                                                         graphene_matrix_t           *m);
GRAPHENE_AVAILABLE_IN_1_2
void                    graphene_quaternion_to_angles                   (const graphene_quaternion_t *q,
                                                                         float                       *deg_x,
                                                                         float                       *deg_y,
                                                                         float                       *deg_z);
GRAPHENE_AVAILABLE_IN_1_4
void                    graphene_quaternion_to_radians                  (const graphene_quaternion_t *q,
                                                                         float                       *rad_x,
                                                                         float                       *rad_y,
                                                                         float                       *rad_z);
GRAPHENE_AVAILABLE_IN_1_0
void                    graphene_quaternion_to_angle_vec3               (const graphene_quaternion_t *q,
                                                                         float                       *angle,
                                                                         graphene_vec3_t             *axis);

GRAPHENE_AVAILABLE_IN_1_0
bool                    graphene_quaternion_equal                       (const graphene_quaternion_t *a,
                                                                         const graphene_quaternion_t *b);
GRAPHENE_AVAILABLE_IN_1_0
float                   graphene_quaternion_dot                         (const graphene_quaternion_t *a,
                                                                         const graphene_quaternion_t *b);
GRAPHENE_AVAILABLE_IN_1_0
void                    graphene_quaternion_invert                      (const graphene_quaternion_t *q,
                                                                         graphene_quaternion_t       *res);
GRAPHENE_AVAILABLE_IN_1_0
void                    graphene_quaternion_normalize                   (const graphene_quaternion_t *q,
                                                                         graphene_quaternion_t       *res);
GRAPHENE_AVAILABLE_IN_1_0
void                    graphene_quaternion_slerp                       (const graphene_quaternion_t *a,
                                                                         const graphene_quaternion_t *b,
                                                                         float                        factor,
                                                                         graphene_quaternion_t       *res);

GRAPHENE_END_DECLS

#endif /* __GRAPHENE_QUATERNION_H__ */