/simpletypesystem/trunk

#ifndef __H_VEC__

#define __H_VEC__

#include <stdlib.h>

#include <stdint.h>

#include "defs.h"

/** @file

 * @defgroup Vectors Vectors

 * @addtogroup Vectors

 * @{

 * Vectors are multi value structures that can be used when doing some types of

 * maths.

 */

S_BEGIN_DECLS

/**

 * A Vector of three standard int values.

 *

 * A Vec3 is considerer a primitive type and as such has no ref/unref memory

 * management and no vec_free function. You will have to do that yourself.

 *

 * @sa vec3_new

 * @sa Vec3_16

 */

typedef struct

Vec3 {

  sint a;

  sint b;

  sint c;

} Vec3;

/**

 * A Vector of three 16 bit int values.

 *

 * @sa vec3_16_new

 * @sa Vec3

 */

typedef struct

Vec3_16 {

  sshort a;

  sshort b;

  sshort c;

} Vec3_16;

/**

 *

 * A Vec3_f is a vector of three 32bit precision floating point values.

 */

typedef struct

Vec3_f {

  sfloat a;

  sfloat b;

  sfloat c;

} Vec3_f;

#ifndef __MSC_VER

/**

 * Add Vectors together, resulting in a new vector.

 *

 * The type of vector that is returned depends on the types that were put in.

 *

 * Due to the reflective way of these operations, many may just be inverses of

 * others. IE: `vec3_add (Vec3 *, Vec3_16 *)` is the same as

 * `vec3_add (Vec3_16 *, Vec3 *)`.

 */

#define vec3_add(x, y) _Generic((x, y)\

                                 Vec3 *: _Generic((y)\

                                                 Vec3 *: vec3_add_vec3\

                                                 Vec3_16 *: vec3_add_vec3_16\

                                                 Vec3_f *: vec3_add_vec3_f\

                                                 )\

                                 Vec3_16 *: _Generic((y)\

                                                    Vec3 *: vec3_16_add_vec3\

                                                    Vec3_16 *: vec3_16_add_vec3_16\

                                                    Vec3_f *: vec3_16_add_vec3_f\

                                                    )\

                                 Vec3_f *: _Generic((y)\

                                                   Vec3 *: vec3_f_add_vec3\

                                                   Vec3_16 *: vec3_f_add_vec3_16\

                                                   Vec3_f *: vec3_f_add_vec3_f\

                                                   )\

                                 )(x,y)

#endif /* __MSC_VER */

#define vec_free(x) free (x)

/** @brief

 * allocates and initialises a Vec3 pointer.

 *

 * @sa Vec3

 */

S_EXPORTED

Vec3 *

vec3_new (sint a,

          sint b,

          sint c);

/**

 * Add Vector a to Vector

 */

S_EXPORTED

Vec3 *

vec3_add_vec3 (Vec3 * a,

               Vec3 * b);

S_EXPORTED

Vec3 *

vec3_add_vec3_16 (Vec3 * a,

                  Vec3_16 * b);

/**

 * @brief

 * allocates and initialises a Vec3_16 pointer.

 * 

 * @sa Vec3_16

 */

S_EXPORTED

Vec3_16 *

vec3_16_new (sshort a,

             sshort b,

             sshort c);

S_EXPORTED

Vec3_16 *

vec3_16_add_vec3_16 (Vec3_16 * a,

                     Vec3_16 * b);

S_EXPORTED

Vec3 *

vec3_16_add_vec3(Vec3_16 * a,

                 Vec3 * b);

/**

 * Allocates and initialises a Vec3_f pointer.

 */

S_EXPORTED

Vec3_f *

vec3_f_new (sfloat a,

            sfloat b,

            sfloat c);

S_EXPORTED

Vec3_f *

vec3_f_add_vec3_f (Vec3_f * a,

                   Vec3_f * b);

S_EXPORTED

Vec3_f *

vec3_f_add_vec3 (Vec3_f * a,

                 Vec3 * b);

S_EXPORTED

Vec3_f *

vec3_f_add_vec3_16 (Vec3_f * a,

                    Vec3_16 * b);

S_EXPORTED

Vec3_f *

vec3_add_vec3_f (Vec3 * a,

                 Vec3_f * b);

S_EXPORTED

Vec3_f *

vec3_16_add_vec3_f (Vec3_16 * a,

                    Vec3_f * b);

/** @} */

S_END_DECLS

#endif /* __H_VEC__ */