docs/html/vector3_8h_source.html

 /*

-  This file is part of the MinGfx Project.

-

-  Copyright (c) 2017,2018 Regents of the University of Minnesota.

-  All Rights Reserved.

-

-  Original Author(s) of this File:

-     Dan Keefe, 2018, University of Minnesota

-

-  Author(s) of Significant Updates/Modifications to the File:

-     ...

-  */

-

- #ifndef SRC_VECTOR3_H_

- #define SRC_VECTOR3_H_

-

- #include <iostream>

-

- #include "point3.h"

-

-

- namespace mingfx {

-

-

- class Vector3 {

- public:

-

-     Vector3();

-

-     Vector3(float x, float y, float z);

-

-     Vector3(float *v);

-

-     Vector3(const Vector3& v);

-

-     virtual ~Vector3();

-

-     bool operator==(const Vector3& v) const;

-

-     bool operator!=(const Vector3& v) const;

-

-     Vector3& operator=(const Vector3& v);

-

-     float operator[](const int i) const;

-

-     float& operator[](const int i);

-

-     float x() const { return v[0]; }

-

-     float y() const { return v[1]; }

-

-     float z() const { return v[2]; }

-

-     float w() const { return 0.0; }

-

-

-     // --- Vector operations ---

-

-     float Dot(const Vector3& v) const;

-

-     Vector3 Cross(const Vector3& v) const;

-

-     float Length() const;

-

-     void Normalize();

-

-     Vector3 ToUnit() const;

-

-     const float * value_ptr() const;

-

-     Vector3 Lerp(const Vector3 &b, float alpha) const;

-

-

-     static const Vector3& Zero();

-

-     static const Vector3& One();

-

-     static const Vector3& UnitX();

-

-     static const Vector3& UnitY();

-

-     static const Vector3& UnitZ();

-

-

-     static Vector3 Normalize(const Vector3 &v);

-

-     static Vector3 Cross(const Vector3 &v1, const Vector3 &v2);

-

-     static float Dot(const Vector3 &v1, const Vector3 &v2);

-

-     static Vector3 Lerp(const Vector3 &a, const Vector3 &b, float alpha);

-

- private:

-     float v[3];

- };

-

-

- // ---------- Operator Overloads for Working with Vectors ----------

-

-

- // --- Scalers ---

-

- Vector3 operator/(const Vector3& v, const float s);

-

- Vector3 operator*(const float s, const Vector3& v);

-

- Vector3 operator*(const Vector3& v, const float s);

-

- Vector3 operator-(const Vector3& v);

-

- // Note: no -(point) operator, that's an undefined operation

-

-

- // --- Point and Vector Arithmetic ---

-

- Point3 operator+(const Vector3& v, const Point3& p);

-

- Point3 operator+(const Point3& p, const Vector3& v);

-

- Vector3 operator+(const Vector3& v1, const Vector3& v2);

-

- // Note: no (point + point) operator, that's an undefined operation

-

- Point3 operator-(const Point3& p, const Vector3& v);

-

- Vector3 operator-(const Vector3& v1, const Vector3& v2);

-

- Vector3 operator-(const Point3& p1, const Point3& p2);

-

- // Note: no (vector - point) operator, that's an undefined operation

-

-

-

-

- // --- Stream operators ---

-

- // Vector3

- std::ostream & operator<< ( std::ostream &os, const Vector3 &v);

- std::istream & operator>> ( std::istream &is, Vector3 &v);

-

-

- } // end namespace

-

- #endif

-mingfx::Point3
A 3D Point with floating point coordinates, used for storing vertices and all sorts of other 3D graph...
Definition: point3.h:52

-mingfx::Vector3
A 3D Vector with floating point coordinates, used for storing normals and all sorts of other 3D graph...
Definition: vector3.h:62

-mingfx::Vector3::Dot
static float Dot(const Vector3 &v1, const Vector3 &v2)
Returns v1 dot v2.

-mingfx::Vector3::w
float w() const
In homogeneous coordinates, the w coordinate for all vectors is 0.0.
Definition: vector3.h:115

-mingfx::Vector3::Vector3
Vector3(float x, float y, float z)
Constructs a vector (x,y,z,0), where the 0 comes from the use of homogeneous coordinates in computer ...

-mingfx::Vector3::Dot
float Dot(const Vector3 &v) const
Returns "this dot v", for example:

-mingfx::Vector3::Cross
Vector3 Cross(const Vector3 &v) const
Returns "this cross v", for example:

-mingfx::Vector3::ToUnit
Vector3 ToUnit() const
Returns a normalized (i.e., unit length) version of the vector without modifying the original 'this' ...

-mingfx::Vector3::Cross
static Vector3 Cross(const Vector3 &v1, const Vector3 &v2)
Returns v1 cross v2.

-mingfx::Vector3::Lerp
static Vector3 Lerp(const Vector3 &a, const Vector3 &b, float alpha)
Linear interpolation between two vectors. Alpha=0.0 returns 'a' and alpha=1.0 returns 'b',...

-mingfx::Vector3::UnitZ
static const Vector3 & UnitZ()
(0,0,1) - a shortcut for a special vector that is frequently needed

-mingfx::Vector3::Zero
static const Vector3 & Zero()
(0,0,0) - a shortcut for a special vector that is frequently needed

-mingfx::Vector3::~Vector3
virtual ~Vector3()
Vector destructor.

-mingfx::Vector3::Length
float Length() const
Returns the length of the vector.

-mingfx::Vector3::z
float z() const
Read only access to the z coordinate. Can also use my_vector[2]. Use the my_vector[2] = 1....
Definition: vector3.h:112

-mingfx::Vector3::Vector3
Vector3()
Default constructor to create zero vector.

-mingfx::Vector3::operator==
bool operator==(const Vector3 &v) const
Check for "equality", taking floating point imprecision into account.

-mingfx::Vector3::UnitY
static const Vector3 & UnitY()
(0,1,0) - a shortcut for a special vector that is frequently needed

-mingfx::Vector3::Lerp
Vector3 Lerp(const Vector3 &b, float alpha) const
Linear interpolation between this vector and another. Alpha=0.0 returns this vector,...

-mingfx::Vector3::Vector3
Vector3(float *v)
Constructs a vector given a pointer to x,y,z data.

-mingfx::Vector3::Normalize
void Normalize()
Normalizes the vector by making it unit length.

-mingfx::Vector3::operator[]
float operator[](const int i) const
Read only access to the ith coordinate of the vector.

-mingfx::Vector3::operator=
Vector3 & operator=(const Vector3 &v)
Vector assignment operator.

-mingfx::Vector3::value_ptr
const float * value_ptr() const
Returns a const pointer to the raw data array.

-mingfx::Vector3::operator!=
bool operator!=(const Vector3 &v) const
Check for "inequality", taking floating point imprecision into account.

-mingfx::Vector3::operator[]
float & operator[](const int i)
Returns a reference to the ith coordinate of the vector. Use this accessor if you wish to set the coo...

-mingfx::Vector3::x
float x() const
Read only access to the x coordinate. Can also use my_vector[0]. Use the my_vector[0] = 1....
Definition: vector3.h:104

-mingfx::Vector3::UnitX
static const Vector3 & UnitX()
(1,0,0) - a shortcut for a special vector that is frequently needed

-mingfx::Vector3::y
float y() const
Read only access to the y coordinate. Can also use my_vector[1]. Use the my_vector[1] = 1....
Definition: vector3.h:108

-mingfx::Vector3::Normalize
static Vector3 Normalize(const Vector3 &v)
Returns a new vector that is the unit version of v.

-mingfx::Vector3::Vector3
Vector3(const Vector3 &v)
Copy constructor for vector.

-mingfx::Vector3::One
static const Vector3 & One()
(1,1,1) - a shortcut for a special vector that is frequently needed

-mingfx
Namespace for the MinGfx Toolkit.
Definition: aabb.h:21

-mingfx::operator-
Quaternion operator-(const Quaternion &q)

-mingfx::operator+
AABB operator+(const AABB &A, const AABB &B)

-mingfx::operator/
Quaternion operator/(const Quaternion &q, const float s)

-mingfx::operator<<
std::ostream & operator<<(std::ostream &os, const Color &c)

-mingfx::operator>>
std::istream & operator>>(std::istream &is, Color &c)

-mingfx::operator*
Matrix4 operator*(const Matrix4 &m, const float &s)
Multiply matrix and scalar, returns the new matrix.

-point3.h

-