Vector3f.h

Go to the documentation of this file.

/* This file is part of the Zenipex Library (zenilib).
 * Copyright (C) 2011 Mitchell Keith Bloch (bazald).
 *
 * zenilib is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * zenilib is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with zenilib.  If not, see <http://www.gnu.org/licenses/>.
 */

#ifndef ZENI_VECTOR3F_H
#define ZENI_VECTOR3F_H

#include <Zeni/Serialization.h>

namespace Zeni {

  struct Point3f;
  struct Vector2f;
  struct Vector3f;

  namespace Global {
    ZENI_DLL extern const float pi; 
    ZENI_DLL extern const float pi_over_two; 
    ZENI_DLL extern const float three_pi_over_two; 
    ZENI_DLL extern const float over_three; 
    ZENI_DLL extern const float sqrt_two; 
    ZENI_DLL extern const float sqrt_three; 

    ZENI_DLL extern const Vector3f vector_i; 
    ZENI_DLL extern const Vector3f vector_j; 
    ZENI_DLL extern const Vector3f vector_k; 
  }

  struct ZENI_DLL Vector3f {
    inline explicit Vector3f(const bool &degenerate_ = false);
    inline Vector3f(const float &i_, const float &j_, const float &k_, const bool &degenerate_ = false);
    inline Vector3f(const Vector3f &rhs, const bool &degenerate_ = false);
    inline Vector3f(const Point3f &rhs);
    inline explicit Vector3f(const Vector2f &rhs);

    // Vector addition/subtraction
    inline Vector3f operator+(const Vector3f &rhs) const; 
    inline Vector3f operator-(const Vector3f &rhs) const; 
    inline Vector3f & operator+=(const Vector3f &rhs); 
    inline Vector3f & operator-=(const Vector3f &rhs); 

    // Vector Dot-Product and Cross-Product
    inline float operator*(const Vector3f &rhs) const; 
    inline Vector3f operator%(const Vector3f &rhs) const; 
    inline Vector3f & operator%=(const Vector3f &rhs); 

    // Vector Scalar Multiplication I of II
    inline Vector3f operator*(const float &rhs) const; 
    inline Vector3f operator/(const float &rhs) const; 
    inline Vector3f & operator*=(const float &rhs); 
    inline Vector3f & operator/=(const float &rhs); 
    inline Vector3f operator-() const; 

    // Other Standard Functions
    Vector3f & normalize(); 
    Vector3f normalized() const; 
    inline float magnitude2() const; 
    inline float magnitude() const; 

    // Other helpful functions
    inline Vector3f get_i() const; 
    inline Vector3f get_j() const; 
    inline Vector3f get_k() const; 
    inline Vector3f get_ij() const; 
    inline Vector3f get_ik() const; 
    inline Vector3f get_jk() const; 
    inline Vector3f multiply_by(const Vector3f &rhs) const; 
    inline Vector3f divide_by(const Vector3f &rhs) const; 
    inline float angle_between(const Vector3f &rhs) const; 

    // Indexing
    inline const float & operator[](const int &index) const; 
    inline float & operator[](const int &index); 

    // Spherical Accessors and Modifiers
    float theta() const; 
    float phi() const; 
    void set_spherical(const float &theta, const float &phi, const float &magnitude = 1); 

    union {
      float i;
      float x;
    };
    union {
      float j;
      float y;
    };
    union {
      float k;
      float z;
    };

    bool degenerate;
  };

  // Vector Scalar Multiplication Part II of II
  inline Vector3f operator*(const float &lhs, const Vector3f &rhs); 

  ZENI_DLL std::ostream & serialize(std::ostream &os, const Vector3f &value);
  ZENI_DLL std::istream & unserialize(std::istream &is, Vector3f &value);
}

#endif