class Vector2D
Defined in:
The TSVector2D.h
Vector2D
class encapsulates a 2D vector.
Definition
class Vector2D : public Vec2D<TypeVector2D>
Member Functions
Vector2D::Set |
Sets both components of a vector. |
Vector2D::Normalize |
Normalizes a 2D vector. |
Vector2D::Rotate |
Rotates a vector in the x-y plane. |
Constructor
Vector2D();
Vector2D(float a, float b);
template <typename type> explicit Vector2D(const Vec2D<type>& v);
Parameters
a |
The value of the x coordinate. |
b |
The value of the y coordinate. |
v |
Another 2D vector, possibly with a different component type, that is converted to a Vector2D .
|
Description
The Vector2D
class is used to store a two-dimensional direction vector having floating-point components x and y. A direction vector stored in this class is assumed to have a w coordinate of 0 whenever it needs to be converted to a four-dimensional representation. Two-dimensional points (for which the w coordinate is 1) should be stored using the Point2D
class. The z coordinate of a 2D vector is always assumed to be 0.The default constructor leaves the components of the vector undefined. If the values
a
and b
are supplied, then they are assigned to the x and y coordinates of the vector, respectively.
Overloaded Operators
float& operator [](machine k); |
Returns a reference to the k -th scalar component of a vector. The value of k must be 0 or 1.
|
const float& operator [](machine k) const; |
Returns a constant reference to the k -th scalar component of a vector. The value of k must be 0 or 1.
|
Vector2D& operator +=(const Vector2D& v); |
Adds the vector v .
|
Vector2D& operator -=(const Vector2D& v); |
Subtracts the vector v .
|
Vector2D& operator *=(const Vector2D& v); |
Calculates the componentwise product with the vector v .
|
Vector2D& operator *=(float n); |
Multiplies by the scalar n .
|
Vector2D& operator /=(float n); |
Divides by the scalar n .
|
Nonmember Operations
bool operator ==(const Vector2D& v1, const Vector2D& v2) const; |
Returns a boolean value indicating whether the two vectors v1 and v2 are equal.
|
bool operator !=(const Vector2D& v1, const Vector2D& v2) const; |
Returns a boolean value indicating whether the two vectors v1 and v2 are not equal.
|
Vector2D operator -(const Vector2D& v) const; |
Returns the negation of the vector v .
|
Vector2D operator +(const Vector2D& a, const Vector2D& b) const; |
Returns the sum of the vectors a and b .
|
Vector2D operator -(const Vector2D& a, const Vector2D& b) const; |
Returns the difference of the vectors a and b .
|
Vector2D operator *(const Vector2D& v, float n) const; |
Returns the product of the vector v and the scalar n .
|
Vector2D operator *(float n, const Vector2D& v); |
Returns the product of the vector v and the scalar n .
|
Vector2D operator /(const Vector2D& v, float n) const; |
Returns the product of the vector v and the inverse of the scalar n .
|
Vector2D operator *(const Vector2D& a, const Vector2D& b) const; |
Returns the componentwise product of the vectors a and b .
|
float Magnitude(const Vector2D& v); |
Returns the magnitude of the vector v .
|
float InverseMag(const Vector2D& v); |
Returns the inverse magnitude of the vector v .
|
float SquaredMag(const Vector2D& v); |
Returns the squared magnitude of the vector v .
|
float Dot(const Vector2D& a, const Vector2D& b); |
Returns the dot product between a and b .
|
Vector2D Project(const Vector2D& a, const Vector2D& b); |
Returns (a ⋅ b)b, which is the projection of a onto b under the assumption that the magnitude of b is one.
|
Vector2D Reject(const Vector2D& a, const Vector2D& b); |
Returns a − (a ⋅ b)b, which is the rejection of a from b under the assumption that the magnitude of b is one.
|
Base Classes
Vec2D |
Vectors use a generic base class to store their components. |
See Also