#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) | |
Vector2 (const Vector2 &rkVector) | |
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 | 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 . | |
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. |
Definition at line 46 of file OgreVector2.h.
Ogre::Vector2::Vector2 | ( | ) |
Definition at line 52 of file OgreVector2.h.
Definition at line 56 of file OgreVector2.h.
Ogre::Vector2::Vector2 | ( | const Real | scaler | ) | [explicit] |
Definition at line 61 of file OgreVector2.h.
Ogre::Vector2::Vector2 | ( | const Real | afCoordinate[2] | ) | [explicit] |
Definition at line 66 of file OgreVector2.h.
Ogre::Vector2::Vector2 | ( | const int | afCoordinate[2] | ) | [explicit] |
Definition at line 72 of file OgreVector2.h.
Ogre::Vector2::Vector2 | ( | Real *const | r | ) | [explicit] |
Definition at line 78 of file OgreVector2.h.
Ogre::Vector2::Vector2 | ( | const Vector2 & | rkVector | ) |
Definition at line 83 of file OgreVector2.h.
Real Ogre::Vector2::operator[] | ( | const size_t | i | ) | const |
Definition at line 88 of file OgreVector2.h.
Real& Ogre::Vector2::operator[] | ( | const size_t | i | ) |
Definition at line 95 of file OgreVector2.h.
Real* Ogre::Vector2::ptr | ( | ) |
Pointer accessor for direct copying.
Definition at line 103 of file OgreVector2.h.
Referenced by Ogre::AnimableValue::setAsBaseValue().
const Real* Ogre::Vector2::ptr | ( | ) | const |
Assigns the value of the other vector.
rkVector | The other vector |
Definition at line 117 of file OgreVector2.h.
Definition at line 125 of file OgreVector2.h.
bool Ogre::Vector2::operator== | ( | const Vector2 & | rkVector | ) | const |
bool Ogre::Vector2::operator!= | ( | const Vector2 & | rkVector | ) | const |
Definition at line 158 of file OgreVector2.h.
Definition at line 172 of file OgreVector2.h.
const Vector2& Ogre::Vector2::operator+ | ( | ) | const |
Definition at line 190 of file OgreVector2.h.
Vector2 Ogre::Vector2::operator- | ( | ) | const |
Definition at line 195 of file OgreVector2.h.
Definition at line 251 of file OgreVector2.h.
Definition at line 267 of file OgreVector2.h.
Definition at line 275 of file OgreVector2.h.
Definition at line 291 of file OgreVector2.h.
Real Ogre::Vector2::length | ( | ) | const |
Returns the length (magnitude) of the vector.
Definition at line 318 of file OgreVector2.h.
References Ogre::Math::Sqrt().
Real Ogre::Vector2::squaredLength | ( | ) | const |
Returns the square of the length(magnitude) of the vector.
Definition at line 333 of file OgreVector2.h.
Calculates the dot (scalar) product of this vector with another.
vec | Vector with which to calculate the dot product (together with this one). |
Definition at line 352 of file OgreVector2.h.
Real Ogre::Vector2::normalise | ( | ) |
Normalises the vector.
Definition at line 366 of file OgreVector2.h.
References Ogre::Math::Sqrt().
Referenced by normalisedCopy().
Returns a vector at a point half way between this and the passed in vector.
Definition at line 386 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 396 of file OgreVector2.h.
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 406 of file OgreVector2.h.
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.
Definition at line 420 of file OgreVector2.h.
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.
Definition at line 433 of file OgreVector2.h.
Vector2 Ogre::Vector2::perpendicular | ( | void | ) | const |
Generates a vector perpendicular to this vector (eg an 'up' vector).
Definition at line 446 of file OgreVector2.h.
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 453 of file OgreVector2.h.
Generates a new random vector which deviates from this vector by a given angle in a random direction.
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) |
Definition at line 476 of file OgreVector2.h.
References Ogre::Math::TWO_PI, and Ogre::Math::UnitRandom().
bool Ogre::Vector2::isZeroLength | ( | void | ) | const |
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 497 of file OgreVector2.h.
References normalise().
Calculates a reflection vector to the plane with the given normal .
Definition at line 507 of file OgreVector2.h.
Definition at line 201 of file OgreVector2.h.
Definition at line 208 of file OgreVector2.h.
Definition at line 215 of file OgreVector2.h.
Definition at line 222 of file OgreVector2.h.
Definition at line 229 of file OgreVector2.h.
Definition at line 236 of file OgreVector2.h.
_OgreExport friend std::ostream& operator<< | ( | std::ostream & | o, | |
const Vector2 & | v | |||
) | [friend] |
Definition at line 49 of file OgreVector2.h.
Referenced by crossProduct(), dotProduct(), makeCeil(), makeFloor(), midPoint(), operator *(), operator *=(), operator!=(), operator+(), operator+=(), operator-(), operator-=(), operator/(), operator/=(), operator<(), operator=(), operator==(), and operator>().
Definition at line 49 of file OgreVector2.h.
Referenced by crossProduct(), dotProduct(), makeCeil(), makeFloor(), midPoint(), operator *(), operator *=(), operator!=(), operator+(), operator+=(), operator-(), operator-=(), operator/(), operator/=(), operator<(), operator=(), operator==(), and operator>().
const Vector2 Ogre::Vector2::ZERO [static] |
Definition at line 513 of file OgreVector2.h.
const Vector2 Ogre::Vector2::UNIT_X [static] |
Definition at line 514 of file OgreVector2.h.
const Vector2 Ogre::Vector2::UNIT_Y [static] |
Definition at line 515 of file OgreVector2.h.
const Vector2 Ogre::Vector2::NEGATIVE_UNIT_X [static] |
Definition at line 516 of file OgreVector2.h.
const Vector2 Ogre::Vector2::NEGATIVE_UNIT_Y [static] |
Definition at line 517 of file OgreVector2.h.
const Vector2 Ogre::Vector2::UNIT_SCALE [static] |
Definition at line 518 of file OgreVector2.h.
Copyright © 2000-2005 by The OGRE Team
This work is licensed under a Creative Commons Attribution-ShareAlike 2.5 License.
Last modified Mon Jun 16 12:55:04 2008