#include <OgreVector3.h>
Public Member Functions | |
Vector3 () | |
Vector3 (const Real fX, const Real fY, const Real fZ) | |
Vector3 (const Real afCoordinate[3]) | |
Vector3 (const int afCoordinate[3]) | |
Vector3 (Real *const r) | |
Vector3 (const Real scaler) | |
Vector3 (const Vector3 &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. | |
Vector3 & | operator= (const Vector3 &rkVector) |
Assigns the value of the other vector. | |
Vector3 & | operator= (const Real fScaler) |
bool | operator== (const Vector3 &rkVector) const |
bool | operator!= (const Vector3 &rkVector) const |
Vector3 | operator+ (const Vector3 &rkVector) const |
Vector3 | operator- (const Vector3 &rkVector) const |
Vector3 | operator * (const Real fScalar) const |
Vector3 | operator * (const Vector3 &rhs) const |
Vector3 | operator/ (const Real fScalar) const |
Vector3 | operator/ (const Vector3 &rhs) const |
const Vector3 & | operator+ () const |
Vector3 | operator- () const |
Vector3 & | operator+= (const Vector3 &rkVector) |
Vector3 & | operator+= (const Real fScalar) |
Vector3 & | operator-= (const Vector3 &rkVector) |
Vector3 & | operator-= (const Real fScalar) |
Vector3 & | operator *= (const Real fScalar) |
Vector3 & | operator *= (const Vector3 &rkVector) |
Vector3 & | operator/= (const Real fScalar) |
Vector3 & | operator/= (const Vector3 &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 Vector3 &rhs) const |
Returns the distance to another vector. | |
Real | squaredDistance (const Vector3 &rhs) const |
Returns the square of the distance to another vector. | |
Real | dotProduct (const Vector3 &vec) const |
Calculates the dot (scalar) product of this vector with another. | |
Real | absDotProduct (const Vector3 &vec) const |
Calculates the absolute dot (scalar) product of this vector with another. | |
Real | normalise () |
Normalises the vector. | |
Vector3 | crossProduct (const Vector3 &rkVector) const |
Calculates the cross-product of 2 vectors, i.e. | |
Vector3 | midPoint (const Vector3 &vec) const |
Returns a vector at a point half way between this and the passed in vector. | |
bool | operator< (const Vector3 &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 Vector3 &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 Vector3 &cmp) |
Sets this vector's components to the minimum of its own and the ones of the passed in vector. | |
void | makeCeil (const Vector3 &cmp) |
Sets this vector's components to the maximum of its own and the ones of the passed in vector. | |
Vector3 | perpendicular (void) const |
Generates a vector perpendicular to this vector (eg an 'up' vector). | |
Vector3 | randomDeviant (const Radian &angle, const Vector3 &up=Vector3::ZERO) const |
Generates a new random vector which deviates from this vector by a given angle in a random direction. | |
Quaternion | getRotationTo (const Vector3 &dest, const Vector3 &fallbackAxis=Vector3::ZERO) const |
Gets the shortest arc quaternion to rotate this vector to the destination vector. | |
bool | isZeroLength (void) const |
Returns true if this vector is zero length. | |
Vector3 | normalisedCopy (void) const |
As normalise, except that this vector is unaffected and the normalised vector is returned as a copy. | |
Vector3 | reflect (const Vector3 &normal) const |
Calculates a reflection vector to the plane with the given normal . | |
bool | positionEquals (const Vector3 &rhs, Real tolerance=1e-03) const |
Returns whether this vector is within a positional tolerance of another vector. | |
bool | positionCloses (const Vector3 &rhs, Real tolerance=1e-03f) const |
Returns whether this vector is within a positional tolerance of another vector, also take scale of the vectors into account. | |
bool | directionEquals (const Vector3 &rhs, const Radian &tolerance) const |
Returns whether this vector is within a directional tolerance of another vector. | |
Public Attributes | |
Real | x |
Real | y |
Real | z |
Static Public Attributes | |
static const Vector3 | ZERO |
static const Vector3 | UNIT_X |
static const Vector3 | UNIT_Y |
static const Vector3 | UNIT_Z |
static const Vector3 | NEGATIVE_UNIT_X |
static const Vector3 | NEGATIVE_UNIT_Y |
static const Vector3 | NEGATIVE_UNIT_Z |
static const Vector3 | UNIT_SCALE |
Friends | |
Vector3 | operator * (const Real fScalar, const Vector3 &rkVector) |
Vector3 | operator/ (const Real fScalar, const Vector3 &rkVector) |
Vector3 | operator+ (const Vector3 &lhs, const Real rhs) |
Vector3 | operator+ (const Real lhs, const Vector3 &rhs) |
Vector3 | operator- (const Vector3 &lhs, const Real rhs) |
Vector3 | operator- (const Real lhs, const Vector3 &rhs) |
_OgreExport friend std::ostream & | operator<< (std::ostream &o, const Vector3 &v) |
Function for writing to a stream. |
Definition at line 46 of file OgreVector3.h.
Ogre::Vector3::Vector3 | ( | ) |
Definition at line 52 of file OgreVector3.h.
Definition at line 56 of file OgreVector3.h.
Ogre::Vector3::Vector3 | ( | const Real | afCoordinate[3] | ) | [explicit] |
Definition at line 61 of file OgreVector3.h.
Ogre::Vector3::Vector3 | ( | const int | afCoordinate[3] | ) | [explicit] |
Definition at line 68 of file OgreVector3.h.
Ogre::Vector3::Vector3 | ( | Real *const | r | ) | [explicit] |
Definition at line 75 of file OgreVector3.h.
Ogre::Vector3::Vector3 | ( | const Real | scaler | ) | [explicit] |
Definition at line 80 of file OgreVector3.h.
Ogre::Vector3::Vector3 | ( | const Vector3 & | rkVector | ) |
Definition at line 88 of file OgreVector3.h.
Real Ogre::Vector3::operator[] | ( | const size_t | i | ) | const |
Definition at line 93 of file OgreVector3.h.
Real& Ogre::Vector3::operator[] | ( | const size_t | i | ) |
Definition at line 100 of file OgreVector3.h.
Real* Ogre::Vector3::ptr | ( | ) |
Pointer accessor for direct copying.
Definition at line 107 of file OgreVector3.h.
Referenced by Ogre::AnimableValue::setAsBaseValue().
const Real* Ogre::Vector3::ptr | ( | ) | const |
Assigns the value of the other vector.
rkVector | The other vector |
Definition at line 121 of file OgreVector3.h.
Definition at line 130 of file OgreVector3.h.
bool Ogre::Vector3::operator== | ( | const Vector3 & | rkVector | ) | const |
bool Ogre::Vector3::operator!= | ( | const Vector3 & | rkVector | ) | const |
Definition at line 166 of file OgreVector3.h.
Definition at line 182 of file OgreVector3.h.
const Vector3& Ogre::Vector3::operator+ | ( | ) | const |
Definition at line 202 of file OgreVector3.h.
Vector3 Ogre::Vector3::operator- | ( | ) | const |
Definition at line 207 of file OgreVector3.h.
Definition at line 271 of file OgreVector3.h.
Definition at line 288 of file OgreVector3.h.
Definition at line 296 of file OgreVector3.h.
Definition at line 313 of file OgreVector3.h.
Real Ogre::Vector3::length | ( | ) | const |
Returns the length (magnitude) of the vector.
Definition at line 343 of file OgreVector3.h.
References Ogre::Math::Sqrt().
Real Ogre::Vector3::squaredLength | ( | ) | const |
Returns the square of the length(magnitude) of the vector.
Definition at line 358 of file OgreVector3.h.
Referenced by Ogre::Sphere::intersects(), perpendicular(), and positionCloses().
Returns the distance to another vector.
Definition at line 370 of file OgreVector3.h.
Returns the square of the distance to another vector.
Definition at line 385 of file OgreVector3.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 404 of file OgreVector3.h.
Referenced by getRotationTo().
Calculates the absolute dot (scalar) product of this vector with another.
vec | Vector with which to calculate the absolute dot product (together with this one). |
Definition at line 419 of file OgreVector3.h.
References Ogre::Math::Abs(), x, y, and z.
Real Ogre::Vector3::normalise | ( | ) |
Normalises the vector.
Definition at line 433 of file OgreVector3.h.
References Ogre::Math::Sqrt().
Referenced by getRotationTo(), normalisedCopy(), Ogre::Matrix4::operator *(), and perpendicular().
Calculates the cross-product of 2 vectors, i.e.
the vector that lies perpendicular to them both.
vec | Vector which, together with this one, will be used to calculate the cross-product. |
Definition at line 477 of file OgreVector3.h.
Referenced by getRotationTo().
Returns a vector at a point half way between this and the passed in vector.
Definition at line 488 of file OgreVector3.h.
bool Ogre::Vector3::operator< | ( | const Vector3 & | 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 499 of file OgreVector3.h.
bool Ogre::Vector3::operator> | ( | const Vector3 & | 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 509 of file OgreVector3.h.
void Ogre::Vector3::makeFloor | ( | const Vector3 & | cmp | ) |
Sets this vector's components to the minimum of its own and the ones of the passed in vector.
Definition at line 523 of file OgreVector3.h.
Referenced by Ogre::AxisAlignedBox::intersection(), and Ogre::AxisAlignedBox::merge().
void Ogre::Vector3::makeCeil | ( | const Vector3 & | cmp | ) |
Sets this vector's components to the maximum of its own and the ones of the passed in vector.
Definition at line 537 of file OgreVector3.h.
Referenced by Ogre::AxisAlignedBox::intersection(), and Ogre::AxisAlignedBox::merge().
Vector3 Ogre::Vector3::perpendicular | ( | void | ) | const |
Generates a vector perpendicular to this vector (eg an 'up' vector).
Definition at line 551 of file OgreVector3.h.
References normalise(), squaredLength(), UNIT_X, and UNIT_Y.
Vector3 Ogre::Vector3::randomDeviant | ( | const Radian & | angle, | |
const Vector3 & | up = Vector3::ZERO | |||
) | const |
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 | |
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 588 of file OgreVector3.h.
References Ogre::Quaternion::FromAngleAxis(), Ogre::Math::TWO_PI, Ogre::Math::UnitRandom(), and ZERO.
Quaternion Ogre::Vector3::getRotationTo | ( | const Vector3 & | dest, | |
const Vector3 & | fallbackAxis = Vector3::ZERO | |||
) | const |
Gets the shortest arc quaternion to rotate this vector to the destination vector.
Definition at line 630 of file OgreVector3.h.
References crossProduct(), dotProduct(), Ogre::Quaternion::FromAngleAxis(), Ogre::Quaternion::IDENTITY, isZeroLength(), Ogre::Quaternion::normalise(), normalise(), Ogre::Math::PI, Ogre::Math::Sqrt(), UNIT_X, UNIT_Y, Ogre::Quaternion::w, x, Ogre::Quaternion::x, y, Ogre::Quaternion::y, z, Ogre::Quaternion::z, and ZERO.
bool Ogre::Vector3::isZeroLength | ( | void | ) | const |
Returns true if this vector is zero length.
Definition at line 681 of file OgreVector3.h.
Referenced by getRotationTo().
Vector3 Ogre::Vector3::normalisedCopy | ( | void | ) | const |
As normalise, except that this vector is unaffected and the normalised vector is returned as a copy.
Definition at line 690 of file OgreVector3.h.
References normalise().
Calculates a reflection vector to the plane with the given normal .
Definition at line 700 of file OgreVector3.h.
Returns whether this vector is within a positional tolerance of another vector.
rhs | The vector to compare with | |
tolerance | The amount that each element of the vector may vary by and still be considered equal |
Definition at line 711 of file OgreVector3.h.
References Ogre::Math::RealEqual(), x, y, and z.
Returns whether this vector is within a positional tolerance of another vector, also take scale of the vectors into account.
rhs | The vector to compare with | |
tolerance | The amount (related to the scale of vectors) that distance of the vector may vary by and still be considered close |
Definition at line 725 of file OgreVector3.h.
References squaredLength().
Returns whether this vector is within a directional tolerance of another vector.
rhs | The vector to compare with | |
tolerance | The maximum angle by which the vectors may vary and still be considered equal |
Definition at line 738 of file OgreVector3.h.
References Ogre::Math::Abs(), Ogre::Math::ACos(), and Ogre::Radian::valueRadians().
Definition at line 213 of file OgreVector3.h.
Definition at line 221 of file OgreVector3.h.
Definition at line 229 of file OgreVector3.h.
Definition at line 237 of file OgreVector3.h.
Definition at line 245 of file OgreVector3.h.
Definition at line 253 of file OgreVector3.h.
_OgreExport friend std::ostream& operator<< | ( | std::ostream & | o, | |
const Vector3 & | v | |||
) | [friend] |
Definition at line 49 of file OgreVector3.h.
Referenced by absDotProduct(), Ogre::AxisAlignedBox::contains(), crossProduct(), dotProduct(), getRotationTo(), Ogre::Matrix4::getScale(), Ogre::Matrix4::getTrans(), Ogre::AxisAlignedBox::intersection(), Ogre::AxisAlignedBox::intersects(), makeCeil(), makeFloor(), Ogre::Matrix4::makeTrans(), midPoint(), operator *(), Ogre::Matrix4::operator *(), operator *=(), operator!=(), Ogre::EdgeListBuilder::vectorLess::operator()(), operator+(), operator+=(), operator-(), operator-=(), operator/(), operator/=(), operator<(), Ogre::Vector4::operator=(), operator=(), operator==(), operator>(), positionEquals(), Ogre::AxisAlignedBox::setExtents(), Ogre::AxisAlignedBox::setMaximum(), Ogre::AxisAlignedBox::setMinimum(), Ogre::Matrix4::setScale(), Ogre::Matrix4::setTrans(), Ogre::AxisAlignedBox::transform(), Ogre::Matrix4::transformAffine(), Ogre::AxisAlignedBox::transformAffine(), and Ogre::AxisAlignedBox::volume().
Definition at line 49 of file OgreVector3.h.
Referenced by absDotProduct(), Ogre::AxisAlignedBox::contains(), crossProduct(), dotProduct(), getRotationTo(), Ogre::Matrix4::getScale(), Ogre::Matrix4::getTrans(), Ogre::AxisAlignedBox::intersection(), Ogre::AxisAlignedBox::intersects(), makeCeil(), makeFloor(), Ogre::Matrix4::makeTrans(), midPoint(), operator *(), Ogre::Matrix4::operator *(), operator *=(), operator!=(), Ogre::EdgeListBuilder::vectorLess::operator()(), operator+(), operator+=(), operator-(), operator-=(), operator/(), operator/=(), operator<(), Ogre::Vector4::operator=(), operator=(), operator==(), operator>(), positionEquals(), Ogre::AxisAlignedBox::setExtents(), Ogre::Matrix4::setScale(), Ogre::Matrix4::setTrans(), Ogre::AxisAlignedBox::transform(), Ogre::Matrix4::transformAffine(), Ogre::AxisAlignedBox::transformAffine(), and Ogre::AxisAlignedBox::volume().
Definition at line 49 of file OgreVector3.h.
Referenced by absDotProduct(), Ogre::AxisAlignedBox::contains(), crossProduct(), dotProduct(), getRotationTo(), Ogre::Matrix4::getScale(), Ogre::Matrix4::getTrans(), Ogre::AxisAlignedBox::intersection(), Ogre::AxisAlignedBox::intersects(), makeCeil(), makeFloor(), Ogre::Matrix4::makeTrans(), midPoint(), operator *(), Ogre::Matrix4::operator *(), operator *=(), operator!=(), Ogre::EdgeListBuilder::vectorLess::operator()(), operator+(), operator+=(), operator-(), operator-=(), operator/(), operator/=(), operator<(), Ogre::Vector4::operator=(), operator=(), operator==(), operator>(), positionEquals(), Ogre::AxisAlignedBox::setExtents(), Ogre::Matrix4::setScale(), Ogre::Matrix4::setTrans(), Ogre::AxisAlignedBox::transform(), Ogre::Matrix4::transformAffine(), Ogre::AxisAlignedBox::transformAffine(), and Ogre::AxisAlignedBox::volume().
const Vector3 Ogre::Vector3::ZERO [static] |
Definition at line 749 of file OgreVector3.h.
Referenced by Ogre::AxisAlignedBox::getHalfSize(), getRotationTo(), Ogre::AxisAlignedBox::getSize(), Ogre::BorderRenderable::getWorldPosition(), and randomDeviant().
const Vector3 Ogre::Vector3::UNIT_X [static] |
const Vector3 Ogre::Vector3::UNIT_Y [static] |
const Vector3 Ogre::Vector3::UNIT_Z [static] |
Definition at line 752 of file OgreVector3.h.
const Vector3 Ogre::Vector3::NEGATIVE_UNIT_X [static] |
Definition at line 753 of file OgreVector3.h.
const Vector3 Ogre::Vector3::NEGATIVE_UNIT_Y [static] |
Definition at line 754 of file OgreVector3.h.
const Vector3 Ogre::Vector3::NEGATIVE_UNIT_Z [static] |
Definition at line 755 of file OgreVector3.h.
const Vector3 Ogre::Vector3::UNIT_SCALE [static] |
Definition at line 756 of file OgreVector3.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:06 2008