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/vector2_8h_source.html | 261 ++++++++++++++++++++++++++++ 1 file changed, 261 insertions(+) create mode 100644 dev/MinGfx/docs/html/vector2_8h_source.html (limited to 'dev/MinGfx/docs/html/vector2_8h_source.html') diff --git a/dev/MinGfx/docs/html/vector2_8h_source.html b/dev/MinGfx/docs/html/vector2_8h_source.html new file mode 100644 index 0000000..935000d --- /dev/null +++ b/dev/MinGfx/docs/html/vector2_8h_source.html @@ -0,0 +1,261 @@ + + + + + + + +MinGfx Toolkit: src/vector2.h Source File + + + + + + + + + + + + +
+
+ + + + + + +
+
MinGfx Toolkit +  1.0 +
+
A minimal library for writing cross-platform (Windows, OSX, linux) graphics programs.
+
+
+ + + + + + + + +
+
+ + +
+ +
+ + +
+
+
+
vector2.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_VECTOR2_H_
+
15 #define SRC_VECTOR2_H_
+
16 
+
17 #include <iostream>
+
18 
+
19 #include "point2.h"
+
20 
+
21 
+
22 namespace mingfx {
+
23 
+
24 
+
28 class Vector2 {
+
29 public:
+
30 
+
32  Vector2();
+
33 
+
36  Vector2(float x, float y);
+
37 
+
39  Vector2(float *v);
+
40 
+
42  Vector2(const Vector2& v);
+
43 
+
45  virtual ~Vector2();
+
46 
+
48  bool operator==(const Vector2& v) const;
+
49 
+
51  bool operator!=(const Vector2& v) const;
+
52 
+
54  Vector2& operator=(const Vector2& v);
+
55 
+
57  float operator[](const int i) const;
+
58 
+
66  float& operator[](const int i);
+
67 
+
70  float x() const { return v[0]; }
+
71 
+
74  float y() const { return v[1]; }
+
75 
+
77  float w() const { return 0.0; }
+
78 
+
79 
+
80  // --- Vector operations ---
+
81 
+
83  float Dot(const Vector2& v) const;
+
84 
+
86  float Length() const;
+
87 
+
89  void Normalize();
+
90 
+
93  Vector2 ToUnit() const;
+
94 
+
98  Vector2 Lerp(const Vector2 &b, float alpha) const;
+
99 
+
101  const float * value_ptr() const;
+
102 
+
103 
+
104 
+
106  static Vector2 Normalize(const Vector2 &v);
+
107 
+
109  static float Dot(const Vector2 &v1, const Vector2 &v2);
+
110 
+
112  static const Vector2& Zero();
+
113 
+
115  static const Vector2& One();
+
116 
+
118  static const Vector2& UnitX();
+
119 
+
121  static const Vector2& UnitY();
+
122 
+
125  static Vector2 Lerp(const Vector2 &a, const Vector2 &b, float alpha);
+
126 
+
127 private:
+
128  float v[2];
+
129 };
+
130 
+
131 
+
132 // ---------- Operator Overloads for Working with Vectors ----------
+
133 
+
134 
+
135 // --- Scalers ---
+
136 
+
138 Vector2 operator/(const Vector2& v, const float s);
+
139 
+
141 Vector2 operator*(const float s, const Vector2& v);
+
142 
+
144 Vector2 operator*(const Vector2& v, const float s);
+
145 
+
147 Vector2 operator-(const Vector2& v);
+
148 
+
149 // Note: no -(point) operator, that's an undefined operation
+
150 
+
151 
+
152 // --- Point and Vector Arithmetic ---
+
153 
+
155 Point2 operator+(const Vector2& v, const Point2& p);
+
156 
+
158 Point2 operator+(const Point2& p, const Vector2& v);
+
159 
+
161 Vector2 operator+(const Vector2& v1, const Vector2& v2);
+
162 
+
163 // Note: no (point + point) operator, that's an undefined operation
+
164 
+
166 Point2 operator-(const Point2& p, const Vector2& v);
+
167 
+
169 Vector2 operator-(const Vector2& v1, const Vector2& v2);
+
170 
+
172 Vector2 operator-(const Point2& p1, const Point2& p2);
+
173 
+
174 // Note: no (vector - point) operator, that's an undefined operation
+
175 
+
176 
+
177 // --- Stream operators ---
+
178 
+
179 // Vector2
+
180 std::ostream & operator<< ( std::ostream &os, const Vector2 &v);
+
181 std::istream & operator>> ( std::istream &is, Vector2 &v);
+
182 
+
183 
+
184 } // end namespace
+
185 
+
186 #endif
+
mingfx::Point2
A 2D Point with floating point coordinates, used for storing 2D texture coordinates,...
Definition: point2.h:28
+
mingfx::Vector2
A 2D Vector with floating point coordinates, used for storing 2D translations, mouse movements,...
Definition: vector2.h:28
+
mingfx::Vector2::Normalize
static Vector2 Normalize(const Vector2 &v)
Returns a new vector that is the unit version of v.
+
mingfx::Vector2::operator!=
bool operator!=(const Vector2 &v) const
Check for "inequality", taking floating point imprecision into account.
+
mingfx::Vector2::w
float w() const
In homogeneous coordinates, the w coordinate for all vectors is 0.0.
Definition: vector2.h:77
+
mingfx::Vector2::operator=
Vector2 & operator=(const Vector2 &v)
Vector assignment operator.
+
mingfx::Vector2::Vector2
Vector2(const Vector2 &v)
Copy constructor for vector.
+
mingfx::Vector2::Lerp
Vector2 Lerp(const Vector2 &b, float alpha) const
Linear interpolation between this vector and another. Alpha=0.0 returns this vector,...
+
mingfx::Vector2::One
static const Vector2 & One()
(1,1) - a shortcut for a special vector that is frequently needed
+
mingfx::Vector2::Normalize
void Normalize()
Normalizes the vector by making it unit length.
+
mingfx::Vector2::Vector2
Vector2(float *v)
Constructs a vector given a pointer to x,y,z data.
+
mingfx::Vector2::ToUnit
Vector2 ToUnit() const
Returns a normalized (i.e., unit length) version of the vector without modifying the original ('this'...
+
mingfx::Vector2::Length
float Length() const
Returns the length of the vector.
+
mingfx::Vector2::Zero
static const Vector2 & Zero()
(0,0) - a shortcut for a special vector that is frequently needed
+
mingfx::Vector2::value_ptr
const float * value_ptr() const
Returns a const pointer to the raw data array.
+
mingfx::Vector2::UnitX
static const Vector2 & UnitX()
(1,0) - a shortcut for a special vector that is frequently needed
+
mingfx::Vector2::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::Vector2::Vector2
Vector2()
Default constructor to create zero vector.
+
mingfx::Vector2::Dot
static float Dot(const Vector2 &v1, const Vector2 &v2)
Returns v1 dot v2.
+
mingfx::Vector2::UnitY
static const Vector2 & UnitY()
(0,1) - a shortcut for a special vector that is frequently needed
+
mingfx::Vector2::Lerp
static Vector2 Lerp(const Vector2 &a, const Vector2 &b, float alpha)
Linear interpolation between two vectors. Alpha=0.0 returns 'a' and alpha=1.0 returns 'b',...
+
mingfx::Vector2::y
float y() const
Read only access to the y coordinate. Can also use my_vector[1]. Use the my_vector[1] = 1....
Definition: vector2.h:74
+
mingfx::Vector2::~Vector2
virtual ~Vector2()
Vector destructor.
+
mingfx::Vector2::Vector2
Vector2(float x, float y)
Constructs a vector (x,y,0), where the 0 comes from the use of homogeneous coordinates in computer gr...
+
mingfx::Vector2::operator==
bool operator==(const Vector2 &v) const
Check for "equality", taking floating point imprecision into account.
+
mingfx::Vector2::operator[]
float operator[](const int i) const
Read only access to the ith coordinate of the vector.
+
mingfx::Vector2::Dot
float Dot(const Vector2 &v) const
Returns "this dot v".
+
mingfx::Vector2::x
float x() const
Read only access to the x coordinate. Can also use my_vector[0]. Use the my_vector[0] = 1....
Definition: vector2.h:70
+
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