File: Vector2D.hh

package info (click to toggle)
3dwm 0.3.1-8
  • links: PTS
  • area: main
  • in suites: woody
  • size: 3,368 kB
  • ctags: 2,547
  • sloc: cpp: 11,981; sh: 7,850; ansic: 851; makefile: 287; yacc: 135; lex: 92
file content (220 lines) | stat: -rw-r--r-- 4,979 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
/* ------------------------------------------------------------------------
 * $Id: Vector2D.hh,v 1.1 2001/06/15 14:42:04 elm Exp $
 *
 * This file is part of 3Dwm: The Three-Dimensional User Environment.
 *
 * 3Dwm: The Three-Dimensional User Environment:
 *	<http://www.3dwm.org>
 *
 * Chalmers Medialab
 * 	<http://www.medialab.chalmers.se>
 * 
 * ------------------------------------------------------------------------
 * File created 2001-06-15 by Niklas Elmqvist.
 *
 * Copyright (c) 2001 Niklas Elmqvist <elm@3dwm.org>.
 * ------------------------------------------------------------------------
 * This library 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 2.1 of the License, or (at your option) any later version.
 * 
 * This library 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 this library; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
 * USA
 * ------------------------------------------------------------------------
 */

#ifndef _Vector2D_hh_
#define _Vector2D_hh_

// -- System Includes
#include <iostream>

// -- Class Declarations

/**
 * Two-dimensional vector class.
 **/
class Vector2D {
public:
    
    /**
     * Default constructor.
     **/
    Vector2D(float x = 0., float y = 0.);

    /**
     * Constructor.
     **/
    Vector2D(const float c[2]);

    /**
     * Copy constructor.
     **/
    Vector2D(const Vector2D &v);

    /**
     * Destructor.
     **/
    ~Vector2D() { }

    /**
     * Access operator (indexing).
     **/
    float &operator () (int n) { return _coord[n]; }

    /**
     * Access operator (indexing). Read-only.
     **/
    float operator () (int n) const { return _coord[n]; }
    
    float x() const { return _coord[0]; }
    float y() const { return _coord[1]; }

    float &x() { return _coord[0]; }
    float &y() { return _coord[1]; }
    
    /**
     * Vector addition assignment.
     **/
    Vector2D &operator += (const Vector2D &v);
    
    /**
     * Vector subtraction assignment.
     **/
    Vector2D &operator -= (const Vector2D &v);

    /**
     * Vector element-wise addition.
     **/    
    Vector2D operator + (const Vector2D &v) const;

    /**
     * Vector element-wise subtraction.
     **/
    Vector2D operator - (const Vector2D &v) const;

    /**
     * Vector element-wise division.
     **/
    Vector2D operator / (const Vector2D &v) const;

    /**
     * Vector element-wise multiplication.
     **/
    Vector2D operator * (const Vector2D &v) const;
    
    /**
     * Scalar addition assignment.
     **/
    Vector2D &operator += (float f);

    /**
     * Scalar addition assignment.
     **/
    Vector2D &operator -= (float f);

    /**
     * Scalar subtraction assignment.
     **/
    Vector2D &operator /= (float f);

    /**
     * Scalar multiplication assignment.
     **/
    Vector2D &operator *= (float f);

    /**
     * Scalar addition.
     **/
    Vector2D operator + (const float f) const;

    /**
     * Scalar subtraction.
     **/
    Vector2D operator - (const float f) const;

    /**
     * Scalar division.
     **/
    Vector2D operator / (const float f) const;

    /**
     * Scalar multiplication.
     **/
    Vector2D operator * (const float f) const;

    /**
     * Unary negation.
     **/
    Vector2D operator - () const;

    /**
     * Assignment operator.
     **/
    Vector2D &operator = (const Vector2D &v);
    
    /**
     * Compute magnitude of vector.
     **/
    float magnitude();

    /**
     * Normalize vector (make the vector unit-length).
     **/
    void normalize();

    /**
     * Clear the vector (set it to [x y] = [0 0]).
     **/
    void clear();
    
    /**
     * Zero the vector (same as clear, set it to [0 0]).
     **/
    void zero();

    /**
     * Vector output operator.
     **/
    friend std::ostream & operator << (std::ostream &f, const Vector2D &v);

    /**
     * Compute the (vector) dot product.
     * 
     * @param a first vector.
     * @param b second vector.
     * @return the dot product of the two vectors.
     **/
    static float dot(const Vector2D &a, const Vector2D &b);
    
private:
    
    /// Vector coordinates array
    float _coord[2];
};

/**
 * Vector equality operator.
 * 
 * @param a first vector.
 * @param b second vector.
 * @return true if the vectors are equal.
 **/
bool operator == (const Vector2D &a, const Vector2D &b);

/**
 * Scalar vector multiplication.
 **/
inline Vector2D operator * (float f, Vector2D v) {
    return v * f;
}

#endif /* Vector2D.hh */