From 9b83919815f6a6ce5d73da1c28483970d0ca5589 Mon Sep 17 00:00:00 2001 From: unknown Date: Wed, 3 Feb 2021 14:22:28 -0600 Subject: added dev/MinGfx/ --- dev/MinGfx/docs/html/vector3_8h_source.html | 275 ++++++++++++++++++++++++++++ 1 file changed, 275 insertions(+) create mode 100644 dev/MinGfx/docs/html/vector3_8h_source.html (limited to 'dev/MinGfx/docs/html/vector3_8h_source.html') diff --git a/dev/MinGfx/docs/html/vector3_8h_source.html b/dev/MinGfx/docs/html/vector3_8h_source.html new file mode 100644 index 0000000..a64d797 --- /dev/null +++ b/dev/MinGfx/docs/html/vector3_8h_source.html @@ -0,0 +1,275 @@ + + + + + + + +MinGfx Toolkit: src/vector3.h Source File + + + + + + + + + + + + +
+
+ + + + + + +
+
MinGfx Toolkit +  1.0 +
+
A minimal library for writing cross-platform (Windows, OSX, linux) graphics programs.
+
+
+ + + + + + + + +
+
+ + +
+ +
+ + +
+
+
+
vector3.h
+
+
+Go to the documentation of this file.
1 /*
+
2  This file is part of the MinGfx Project.
+
3 
+
4  Copyright (c) 2017,2018 Regents of the University of Minnesota.
+
5  All Rights Reserved.
+
6 
+
7  Original Author(s) of this File:
+
8  Dan Keefe, 2018, University of Minnesota
+
9 
+
10  Author(s) of Significant Updates/Modifications to the File:
+
11  ...
+
12  */
+
13 
+
14 #ifndef SRC_VECTOR3_H_
+
15 #define SRC_VECTOR3_H_
+
16 
+
17 #include <iostream>
+
18 
+
19 #include "point3.h"
+
20 
+
21 
+
22 namespace mingfx {
+
23 
+
24 
+
62 class Vector3 {
+
63 public:
+
64 
+
66  Vector3();
+
67 
+
70  Vector3(float x, float y, float z);
+
71 
+
73  Vector3(float *v);
+
74 
+
76  Vector3(const Vector3& v);
+
77 
+
79  virtual ~Vector3();
+
80 
+
82  bool operator==(const Vector3& v) const;
+
83 
+
85  bool operator!=(const Vector3& v) const;
+
86 
+
88  Vector3& operator=(const Vector3& v);
+
89 
+
91  float operator[](const int i) const;
+
92 
+
100  float& operator[](const int i);
+
101 
+
104  float x() const { return v[0]; }
+
105 
+
108  float y() const { return v[1]; }
+
109 
+
112  float z() const { return v[2]; }
+
113 
+
115  float w() const { return 0.0; }
+
116 
+
117 
+
118  // --- Vector operations ---
+
119 
+
127  float Dot(const Vector3& v) const;
+
128 
+
136  Vector3 Cross(const Vector3& v) const;
+
137 
+
139  float Length() const;
+
140 
+
142  void Normalize();
+
143 
+
146  Vector3 ToUnit() const;
+
147 
+
149  const float * value_ptr() const;
+
150 
+
154  Vector3 Lerp(const Vector3 &b, float alpha) const;
+
155 
+
156 
+
158  static const Vector3& Zero();
+
159 
+
161  static const Vector3& One();
+
162 
+
164  static const Vector3& UnitX();
+
165 
+
167  static const Vector3& UnitY();
+
168 
+
170  static const Vector3& UnitZ();
+
171 
+
172 
+
182  static Vector3 Normalize(const Vector3 &v);
+
183 
+
194  static Vector3 Cross(const Vector3 &v1, const Vector3 &v2);
+
195 
+
206  static float Dot(const Vector3 &v1, const Vector3 &v2);
+
207 
+
210  static Vector3 Lerp(const Vector3 &a, const Vector3 &b, float alpha);
+
211 
+
212 private:
+
213  float v[3];
+
214 };
+
215 
+
216 
+
217 // ---------- Operator Overloads for Working with Vectors ----------
+
218 
+
219 
+
220 // --- Scalers ---
+
221 
+
223 Vector3 operator/(const Vector3& v, const float s);
+
224 
+
226 Vector3 operator*(const float s, const Vector3& v);
+
227 
+
229 Vector3 operator*(const Vector3& v, const float s);
+
230 
+
232 Vector3 operator-(const Vector3& v);
+
233 
+
234 // Note: no -(point) operator, that's an undefined operation
+
235 
+
236 
+
237 // --- Point and Vector Arithmetic ---
+
238 
+
240 Point3 operator+(const Vector3& v, const Point3& p);
+
241 
+
243 Point3 operator+(const Point3& p, const Vector3& v);
+
244 
+
246 Vector3 operator+(const Vector3& v1, const Vector3& v2);
+
247 
+
248 // Note: no (point + point) operator, that's an undefined operation
+
249 
+
251 Point3 operator-(const Point3& p, const Vector3& v);
+
252 
+
254 Vector3 operator-(const Vector3& v1, const Vector3& v2);
+
255 
+
257 Vector3 operator-(const Point3& p1, const Point3& p2);
+
258 
+
259 // Note: no (vector - point) operator, that's an undefined operation
+
260 
+
261 
+
262 
+
263 
+
264 // --- Stream operators ---
+
265 
+
266 // Vector3
+
267 std::ostream & operator<< ( std::ostream &os, const Vector3 &v);
+
268 std::istream & operator>> ( std::istream &is, Vector3 &v);
+
269 
+
270 
+
271 } // end namespace
+
272 
+
273 #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.
+ +
+ + +
+Generated by   +doxygen + 1.9.1 +
+ + -- cgit v1.2.3