Ogre::Vector2 Class Reference
[Math]

Standard 2-dimensional vector. More...

#include <OgreVector2.h>

Public Member Functions
	Vector2 ()
	Vector2 (const Real fX, const Real fY)
	Vector2 (const Real scaler)
	Vector2 (const Real afCoordinate[2])
	Vector2 (const int afCoordinate[2])
	Vector2 (Real *const r)
void	swap (Vector2 &other)
	Exchange the contents of this vector with another.
Real	operator[] (const size_t i) const
Real &	operator[] (const size_t i)
Real *	ptr ()
	Pointer accessor for direct copying.
const Real *	ptr () const
	Pointer accessor for direct copying.
Vector2 &	operator= (const Vector2 &rkVector)
	Assigns the value of the other vector.
Vector2 &	operator= (const Real fScalar)
bool	operator== (const Vector2 &rkVector) const
bool	operator!= (const Vector2 &rkVector) const
Vector2	operator+ (const Vector2 &rkVector) const
Vector2	operator- (const Vector2 &rkVector) const
Vector2	operator* (const Real fScalar) const
Vector2	operator* (const Vector2 &rhs) const
Vector2	operator/ (const Real fScalar) const
Vector2	operator/ (const Vector2 &rhs) const
const Vector2 &	operator+ () const
Vector2	operator- () const
Vector2 &	operator+= (const Vector2 &rkVector)
Vector2 &	operator+= (const Real fScaler)
Vector2 &	operator-= (const Vector2 &rkVector)
Vector2 &	operator-= (const Real fScaler)
Vector2 &	operator*= (const Real fScalar)
Vector2 &	operator*= (const Vector2 &rkVector)
Vector2 &	operator/= (const Real fScalar)
Vector2 &	operator/= (const Vector2 &rkVector)
Real	length () const
	Returns the length (magnitude) of the vector.
Real	squaredLength () const
	Returns the square of the length(magnitude) of the vector.
Real	distance (const Vector2 &rhs) const
	Returns the distance to another vector.
Real	squaredDistance (const Vector2 &rhs) const
	Returns the square of the distance to another vector.
Real	dotProduct (const Vector2 &vec) const
	Calculates the dot (scalar) product of this vector with another.
Real	normalise ()
	Normalises the vector.
Vector2	midPoint (const Vector2 &vec) const
	Returns a vector at a point half way between this and the passed in vector.
bool	operator< (const Vector2 &rhs) const
	Returns true if the vector's scalar components are all greater that the ones of the vector it is compared against.
bool	operator> (const Vector2 &rhs) const
	Returns true if the vector's scalar components are all smaller that the ones of the vector it is compared against.
void	makeFloor (const Vector2 &cmp)
	Sets this vector's components to the minimum of its own and the ones of the passed in vector.
void	makeCeil (const Vector2 &cmp)
	Sets this vector's components to the maximum of its own and the ones of the passed in vector.
Vector2	perpendicular (void) const
	Generates a vector perpendicular to this vector (eg an 'up' vector).
Real	crossProduct (const Vector2 &rkVector) const
	Calculates the 2 dimensional cross-product of 2 vectors, which results in a single floating point value which is 2 times the area of the triangle.
Vector2	randomDeviant (Real angle) const
	Generates a new random vector which deviates from this vector by a given angle in a random direction.
bool	isZeroLength (void) const
	Returns true if this vector is zero length.
Vector2	normalisedCopy (void) const
	As normalise, except that this vector is unaffected and the normalised vector is returned as a copy.
Vector2	reflect (const Vector2 &normal) const
	Calculates a reflection vector to the plane with the given normal .
bool	isNaN () const
	Check whether this vector contains valid values.
Ogre::Radian	angleBetween (const Ogre::Vector2 &other) const
	Gets the angle between 2 vectors.
Ogre::Radian	angleTo (const Ogre::Vector2 &other) const
	Gets the oriented angle between 2 vectors.
Public Attributes
Real	x
Real	y
Static Public Attributes
static const Vector2	ZERO
static const Vector2	UNIT_X
static const Vector2	UNIT_Y
static const Vector2	NEGATIVE_UNIT_X
static const Vector2	NEGATIVE_UNIT_Y
static const Vector2	UNIT_SCALE
Friends
Vector2	operator* (const Real fScalar, const Vector2 &rkVector)
Vector2	operator/ (const Real fScalar, const Vector2 &rkVector)
Vector2	operator+ (const Vector2 &lhs, const Real rhs)
Vector2	operator+ (const Real lhs, const Vector2 &rhs)
Vector2	operator- (const Vector2 &lhs, const Real rhs)
Vector2	operator- (const Real lhs, const Vector2 &rhs)
_OgreExport friend std::ostream &	operator<< (std::ostream &o, const Vector2 &v)
	Function for writing to a stream.

Detailed Description

Standard 2-dimensional vector.

Remarks:: A direction in 2D space represented as distances along the 2 orthogonal axes (x, y). Note that positions, directions and scaling factors can be represented by a vector, depending on how you interpret the values.

Definition at line 51 of file OgreVector2.h.

Constructor & Destructor Documentation

Ogre::Vector2::Vector2 ( )

Definition at line 57 of file OgreVector2.h.

Ogre::Vector2::Vector2	(	const Real	fX,
		const Real	fY
	)

Definition at line 61 of file OgreVector2.h.

Ogre::Vector2::Vector2 ( const Real scaler ) [explicit]

Definition at line 66 of file OgreVector2.h.

Ogre::Vector2::Vector2 ( const Real afCoordinate[2] ) [explicit]

Definition at line 71 of file OgreVector2.h.

Ogre::Vector2::Vector2 ( const int afCoordinate[2] ) [explicit]

Definition at line 77 of file OgreVector2.h.

Ogre::Vector2::Vector2 ( Real *const r ) [explicit]

Definition at line 83 of file OgreVector2.h.

Member Function Documentation

Ogre::Radian Ogre::Vector2::angleBetween ( const Ogre::Vector2 & other ) const

Gets the angle between 2 vectors.

Remarks:: Vectors do not have to be unit-length but must represent directions.

Definition at line 560 of file OgreVector2.h.

References Ogre::Math::ACos(), Ogre::Math::Clamp(), and length().

Ogre::Radian Ogre::Vector2::angleTo ( const Ogre::Vector2 & other ) const

Gets the oriented angle between 2 vectors.

Remarks:: Vectors do not have to be unit-length but must represent directions. The angle is comprised between 0 and 2 PI.

Definition at line 578 of file OgreVector2.h.

References Ogre::Math::TWO_PI.

Real Ogre::Vector2::crossProduct ( const Vector2 & rkVector ) const

Calculates the 2 dimensional cross-product of 2 vectors, which results in a single floating point value which is 2 times the area of the triangle.

Definition at line 491 of file OgreVector2.h.

References x, and y.

Real Ogre::Vector2::distance ( const Vector2 & rhs ) const

Returns the distance to another vector.

Warning:: This operation requires a square root and is expensive in terms of CPU operations. If you don't need to know the exact distance (e.g. for just comparing distances) use squaredDistance() instead.

Definition at line 354 of file OgreVector2.h.

Real Ogre::Vector2::dotProduct ( const Vector2 & vec ) const

Calculates the dot (scalar) product of this vector with another.

Remarks:: The dot product can be used to calculate the angle between 2 vectors. If both are unit vectors, the dot product is the cosine of the angle; otherwise the dot product must be divided by the product of the lengths of both vectors to get the cosine of the angle. This result can further be used to calculate the distance of a point from a plane.

Parameters:

vec

Vector with which to calculate the dot product (together with this one).

Returns:: A float representing the dot product value.

Definition at line 388 of file OgreVector2.h.

References x, and y.

bool Ogre::Vector2::isNaN ( ) const

Check whether this vector contains valid values.

Definition at line 551 of file OgreVector2.h.

References Ogre::Math::isNaN().

bool Ogre::Vector2::isZeroLength ( void ) const

Returns true if this vector is zero length.

Definition at line 526 of file OgreVector2.h.

Real Ogre::Vector2::length ( ) const

Returns the length (magnitude) of the vector.

Warning:: This operation requires a square root and is expensive in terms of CPU operations. If you don't need to know the exact length (e.g. for just comparing lengths) use squaredLength() instead.

Definition at line 327 of file OgreVector2.h.

References Ogre::Math::Sqrt().

Referenced by angleBetween().

void Ogre::Vector2::makeCeil ( const Vector2 & cmp )

Sets this vector's components to the maximum of its own and the ones of the passed in vector.

Remarks:: 'Maximum' in this case means the combination of the highest value of x, y and z from both vectors. Highest is taken just numerically, not magnitude, so 1 > -3.

Definition at line 470 of file OgreVector2.h.

References x, and y.

void Ogre::Vector2::makeFloor ( const Vector2 & cmp )

Sets this vector's components to the minimum of its own and the ones of the passed in vector.

Remarks:: 'Minimum' in this case means the combination of the lowest value of x, y and z from both vectors. Lowest is taken just numerically, not magnitude, so -1 < 0.

Definition at line 457 of file OgreVector2.h.

References x, and y.

Vector2 Ogre::Vector2::midPoint ( const Vector2 & vec ) const

Returns a vector at a point half way between this and the passed in vector.

Definition at line 423 of file OgreVector2.h.

References x, and y.

Real Ogre::Vector2::normalise ( )

Normalises the vector.

Remarks:: This method normalises the vector such that it's length / magnitude is 1. The result is called a unit vector.

Note:: This function will not crash for zero-sized vectors, but there will be no changes made to their components.

Returns:: The previous length of the vector.

Definition at line 403 of file OgreVector2.h.

References Ogre::Math::Sqrt().

Referenced by normalisedCopy().

Vector2 Ogre::Vector2::normalisedCopy ( void ) const

As normalise, except that this vector is unaffected and the normalised vector is returned as a copy.

Definition at line 535 of file OgreVector2.h.

References normalise().

bool Ogre::Vector2::operator!= ( const Vector2 & rkVector ) const

Definition at line 146 of file OgreVector2.h.

References x, and y.

Vector2 Ogre::Vector2::operator* ( const Vector2 & rhs ) const

Definition at line 173 of file OgreVector2.h.

References x, and y.

Vector2 Ogre::Vector2::operator* ( const Real fScalar ) const

Definition at line 166 of file OgreVector2.h.

Vector2& Ogre::Vector2::operator*= ( const Vector2 & rkVector )

Definition at line 292 of file OgreVector2.h.

References x, and y.

Vector2& Ogre::Vector2::operator*= ( const Real fScalar )

Definition at line 284 of file OgreVector2.h.

const Vector2& Ogre::Vector2::operator+ ( ) const

Definition at line 198 of file OgreVector2.h.

Vector2 Ogre::Vector2::operator+ ( const Vector2 & rkVector ) const

Definition at line 152 of file OgreVector2.h.

References x, and y.

Vector2& Ogre::Vector2::operator+= ( const Real fScaler )

Definition at line 260 of file OgreVector2.h.

Vector2& Ogre::Vector2::operator+= ( const Vector2 & rkVector )

Definition at line 252 of file OgreVector2.h.

References x, and y.

Vector2 Ogre::Vector2::operator- ( ) const

Definition at line 203 of file OgreVector2.h.

Vector2 Ogre::Vector2::operator- ( const Vector2 & rkVector ) const

Definition at line 159 of file OgreVector2.h.

References x, and y.

Vector2& Ogre::Vector2::operator-= ( const Real fScaler )

Definition at line 276 of file OgreVector2.h.

Vector2& Ogre::Vector2::operator-= ( const Vector2 & rkVector )

Definition at line 268 of file OgreVector2.h.

References x, and y.

Vector2 Ogre::Vector2::operator/ ( const Vector2 & rhs ) const

Definition at line 191 of file OgreVector2.h.

References x, and y.

Vector2 Ogre::Vector2::operator/ ( const Real fScalar ) const

Definition at line 180 of file OgreVector2.h.

Vector2& Ogre::Vector2::operator/= ( const Vector2 & rkVector )

Definition at line 312 of file OgreVector2.h.

References x, and y.

Vector2& Ogre::Vector2::operator/= ( const Real fScalar )

Definition at line 300 of file OgreVector2.h.

bool Ogre::Vector2::operator< ( const Vector2 & rhs ) const

Returns true if the vector's scalar components are all greater that the ones of the vector it is compared against.

Definition at line 433 of file OgreVector2.h.

References x, and y.

Vector2& Ogre::Vector2::operator= ( const Real fScalar )

Definition at line 133 of file OgreVector2.h.

Vector2& Ogre::Vector2::operator= ( const Vector2 & rkVector )

Assigns the value of the other vector.

Parameters:

rkVector

The other vector

Definition at line 125 of file OgreVector2.h.

References x, and y.

bool Ogre::Vector2::operator== ( const Vector2 & rkVector ) const

Definition at line 141 of file OgreVector2.h.

References x, and y.

bool Ogre::Vector2::operator> ( const Vector2 & rhs ) const

Returns true if the vector's scalar components are all smaller that the ones of the vector it is compared against.

Definition at line 443 of file OgreVector2.h.

References x, and y.

Real& Ogre::Vector2::operator[] ( const size_t i )

Definition at line 103 of file OgreVector2.h.

Real Ogre::Vector2::operator[] ( const size_t i ) const

Definition at line 96 of file OgreVector2.h.

Vector2 Ogre::Vector2::perpendicular ( void ) const

Generates a vector perpendicular to this vector (eg an 'up' vector).

Remarks:: This method will return a vector which is perpendicular to this vector. There are an infinite number of possibilities but this method will guarantee to generate one of them. If you need more control you should use the Quaternion class.

Definition at line 483 of file OgreVector2.h.

const Real* Ogre::Vector2::ptr ( ) const

Pointer accessor for direct copying.

Definition at line 116 of file OgreVector2.h.

Real* Ogre::Vector2::ptr ( )

Pointer accessor for direct copying.

Definition at line 111 of file OgreVector2.h.

Referenced by Ogre::AnimableValue::setAsBaseValue(), and Ogre::RTShader::UniformParameter::setGpuParameter().

Vector2 Ogre::Vector2::randomDeviant ( Real angle ) const

Generates a new random vector which deviates from this vector by a given angle in a random direction.

Remarks:: This method assumes that the random number generator has already been seeded appropriately.

Parameters:

	angle	The angle at which to deviate in radians
	up	Any vector perpendicular to this one (which could generated by cross-product of this vector and any other non-colinear vector). If you choose not to provide this the function will derive one on it's own, however if you provide one yourself the function will be faster (this allows you to reuse up vectors if you call this method more than once)

Returns:: A random vector which deviates from this vector by angle. This vector will not be normalised, normalise it if you wish afterwards.

Definition at line 515 of file OgreVector2.h.

References Ogre::Math::TWO_PI, and Ogre::Math::UnitRandom().

Vector2 Ogre::Vector2::reflect ( const Vector2 & normal ) const

Calculates a reflection vector to the plane with the given normal .

Remarks:: NB assumes 'this' is pointing AWAY FROM the plane, invert if it is not.

Definition at line 545 of file OgreVector2.h.

Real Ogre::Vector2::squaredDistance ( const Vector2 & rhs ) const

Returns the square of the distance to another vector.

Remarks:: This method is for efficiency - calculating the actual distance to another vector requires a square root, which is expensive in terms of the operations required. This method returns the square of the distance to another vector, i.e. the same as the distance but before the square root is taken. Use this if you want to find the longest / shortest distance without incurring the square root.

Definition at line 369 of file OgreVector2.h.

Real Ogre::Vector2::squaredLength ( ) const

Returns the square of the length(magnitude) of the vector.

Remarks:: This method is for efficiency - calculating the actual length of a vector requires a square root, which is expensive in terms of the operations required. This method returns the square of the length of the vector, i.e. the same as the length but before the square root is taken. Use this if you want to find the longest / shortest vector without incurring the square root.

Definition at line 342 of file OgreVector2.h.

void Ogre::Vector2::swap ( Vector2 & other )

Exchange the contents of this vector with another.

Definition at line 90 of file OgreVector2.h.

References std::swap(), x, and y.