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
|
/*
** ClanLib SDK
** Copyright (c) 1997-2005 The ClanLib Team
**
** This software is provided 'as-is', without any express or implied
** warranty. In no event will the authors be held liable for any damages
** arising from the use of this software.
**
** Permission is granted to anyone to use this software for any purpose,
** including commercial applications, and to alter it and redistribute it
** freely, subject to the following restrictions:
**
** 1. The origin of this software must not be misrepresented; you must not
** claim that you wrote the original software. If you use this software
** in a product, an acknowledgment in the product documentation would be
** appreciated but is not required.
** 2. Altered source versions must be plainly marked as such, and must not be
** misrepresented as being the original software.
** 3. This notice may not be removed or altered from any source distribution.
**
** Note: Some of the libraries ClanLib may link to may have additional
** requirements or restrictions.
**
** File Author(s):
**
** Magnus Norddahl
** (if your name is missing here, please add it)
*/
//! clanCore="Math"
//! header=core.h
#ifndef header_cl_vector
#define header_cl_vector
#ifdef CL_API_DLL
#ifdef CL_CORE_EXPORT
#define CL_API_CORE __declspec(dllexport)
#else
#define CL_API_CORE __declspec(dllimport)
#endif
#else
#define CL_API_CORE
#endif
#if _MSC_VER > 1000
#pragma once
#endif
#include <iostream>
//: Vector class.
//- !group=Core/Math!
//- !header=core.h!
//- <p>This class provides basic functions and operators for working with vectors.</p>
class CL_API_CORE CL_Vector
{
public:
//! Variables:
//: x coordinate
float x;
//: y coordinate
float y;
//: z coordinate
float z;
//: w coordinate
float w;
public:
//! Construction:
//: Constructor that initializes a vector
//param x: Initial x coordinate of vector.
//param y: Initial y coordinate of vector.
//param z: Initial z coordinate of vector.
//param w: Initial w coordinate of vector.
//param other: vector to copy construct from.
CL_Vector(float x = 0.0, float y = 0.0, float z = 0.0, float w = 1.0);
CL_Vector(const CL_Vector &other);
//! Attributes:
//: Returns the (euclid) norm of the vector.
//- <p>This function does not use the w coordinate of the vector. It only uses
//- the x,y,z coordinates.</p>
//return: the euclid norm of the vector (in R^3)
float norm() const;
//: Normalizes the vector (not taking into account the w ordinate!)
void normalize();
//: Dot products this vector with an other vector.
//param vector: Second vector used for the dot product.
//return: The resulting dot product of the two vectors.
float dot(const CL_Vector& vector) const;
//: Calculate the angle between this vector and an other vector.
//param vector: Second vector used to calculate angle.
//return: The angle between the two vectors.
float angle(const CL_Vector& vector) const;
//: Calculate the cross product between this vector and an other vector.
//param vector: Second vector used to perform the calculation.
//return: The cross product of the two vectors.
CL_Vector cross(const CL_Vector& vector) const;
//: Rotate vector around an axis.
//param angle: Angle to rotate.
//param axis: Rotation axis.
//return: The resulting rotated vector.
CL_Vector rotate(float angle, const CL_Vector& axis) const;
//: Rounds all components.
void round();
//! Operators:
//: Scalar product (vector * scalar)
//return: The scalar product
CL_Vector operator * (float scalar) const;
//: Scalar product (scalar * vector)
//return: The scalar product.
friend CL_Vector operator * (float scalar, const CL_Vector& vector);
//: += operator.
void operator += (const CL_Vector& v);
//: -= operator.
void operator -= (const CL_Vector& v);
//: *= operator (scalar multiplication).
void operator *= (float s);
//: + operator.
CL_Vector operator + (const CL_Vector& v) const;
//: - operator.
CL_Vector operator - (const CL_Vector& v) const;
//: unary - operator.
CL_Vector operator - () const;
//: assignment operator.
CL_Vector& operator = (const CL_Vector& v);
//: Returns true if current vector equals v.
//param v: other vector.
//return: true if v equals the current vector, false otherwise.
bool operator == (const CL_Vector& v) const;
//: Returns false if current vector equals v.
//param v: other vector.
//return: false if v equals the current vector, true otherwise.
bool operator != (const CL_Vector& v) const;
//: Returns reference to n-th ordinate (0. == x, 1. == y, ...).
//param n: number of ordinate (starting with 0).
//return: reference to the n-th ordinate.
float& operator [] (int n);
//: cout's the x,y,z ordinates (meant for debugging).
friend std::ostream& operator << (std::ostream&, const CL_Vector& v);
};
std::ostream& operator << (std::ostream& os, const CL_Vector& v);
#endif
|
