Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Namespace Members   Compound Members   File Members   Related Pages  

Ogre::Vector3 Class Reference

Standard 3-dimensional vector. More...

#include <OgreVector3.h>

List of all members.

Public Methods

 Vector3 ()
 Vector3 (Real fX, Real fY, Real fZ)
 Vector3 (Real afCoordinate[3])
 Vector3 (int afCoordinate[3])
 Vector3 (const Real *const r)
 Vector3 (const Vector3 &rkVector)
Real operator[] (unsigned i) const
Realoperator[] (unsigned i)
Vector3 & operator= (const Vector3 &rkVector)
 Assigns the value of the other vector. More...

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 * (Real fScalar) const
Vector3 operator * (const Vector3 &rhs) const
Vector3 operator/ (Real fScalar) const
Vector3 operator- () const
Vector3 & operator+= (const Vector3 &rkVector)
Vector3 & operator-= (const Vector3 &rkVector)
Vector3 & operator *= (Real fScalar)
Vector3 & operator/= (Real fScalar)
Real length () const
 Returns the length (magnitude) of the vector. More...

Real squaredLength () const
 Returns the square of the length(magnitude) of the vector. More...

Real dotProduct (const Vector3 &vec) const
 Calculates the dot (scalar) product of this vector with another. More...

Vector3 & normalise ()
 Normalises the vector. More...

Vector3 crossProduct (const Vector3 &rkVector) const
 Calculates the cross-product of 2 vectors, i.e. More...

Vector3 midPoint (const Vector3 &vec) const
 Returns a vector at a point half way between this and the passed in vector. More...

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. More...

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. More...

void makeFloor (const Vector3 &cmp)
 Sets this vector's components to the minimum of its own and the ones of the passed in vector. More...

void makeCeil (const Vector3 &cmp)
 Sets this vector's components to the maximum of its own and the ones of the passed in vector. More...

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

Vector3 randomDeviant (Real angle, const Vector3 &up=Vector3::ZERO)
 Generates a new random vector which deviates from this vector by a given angle in a random direction. More...

Quaternion getRotationTo (const Vector3 &dest) const
 Gets the shortest arc quaternion to rotate this vector to the destination vector. More...


Public Attributes

Real x
Real y
Real z

Static Public Attributes

const Vector3 ZERO
const Vector3 UNIT_X
const Vector3 UNIT_Y
const Vector3 UNIT_Z
const Vector3 UNIT_SCALE

Friends

Vector3 operator * (Real fScalar, const Vector3 &rkVector)
_OgreExport friend std::ostream & operator<< (std::ostream &o, const Vector3 &v)
 Function for writing to a stream. More...


Detailed Description

Standard 3-dimensional vector.

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


Constructor & Destructor Documentation

Ogre::Vector3::Vector3   [inline]
 

Ogre::Vector3::Vector3 Real    fX,
Real    fY,
Real    fZ
[inline]
 

Ogre::Vector3::Vector3 Real    afCoordinate[3] [inline]
 

Ogre::Vector3::Vector3 int    afCoordinate[3] [inline]
 

Ogre::Vector3::Vector3 const Real *const    r [inline]
 

Ogre::Vector3::Vector3 const Vector3 &    rkVector [inline]
 


Member Function Documentation

Vector3 Ogre::Vector3::crossProduct const Vector3 &    rkVector const [inline]
 

Calculates the cross-product of 2 vectors, i.e.

the vector that lies perpendicular to them both.

Remarks:
The cross-product is normally used to calculate the normal vector of a plane, by calculating the cross-product of 2 non-equivalent vectors which lie on the plane (e.g. 2 edges of a triangle).
Parameters:
vec  Vector which, together with this one, will be used to calculate the cross-product.
Returns:
A vector which is the result of the cross-product. This vector will NOT be normalised, to maximise efficiency
  • call Vector3::normalise on the result if you wish this to be done. As for which side the resultant vector will be on, the returned vector will be on the side from which the arc from 'this' to rkVector is anticlockwise, e.g. UNIT_Y.crossProduct(UNIT_Z) = UNIT_X, whilst UNIT_Z.crossProduct(UNIT_Y) = -UNIT_X.

For a clearer explanation, look a the left and the bottom edges of your monitor's screen. Assume that the first vector is the left edge and the second vector is the bottom edge, both of them starting from the lower-left corner of the screen. The resulting vector is going to be perpendicular to both of them and will go inside the screen, towards the cathode tube (assuming you're using a CRT monitor, of course).

Real Ogre::Vector3::dotProduct const Vector3 &    vec const [inline]
 

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.

Quaternion Ogre::Vector3::getRotationTo const Vector3 &    dest const [inline]
 

Gets the shortest arc quaternion to rotate this vector to the destination vector.

Remarks:
Don't call this if you think the dest vector can be close to the inverse of this vector, since then ANY axis of rotation is ok.

Real Ogre::Vector3::length   const [inline]
 

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.

void Ogre::Vector3::makeCeil const Vector3 &    cmp [inline]
 

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.

void Ogre::Vector3::makeFloor const Vector3 &    cmp [inline]
 

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.

Vector3 Ogre::Vector3::midPoint const Vector3 &    vec const [inline]
 

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

Vector3& Ogre::Vector3::normalise   [inline]
 

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.

Vector3 Ogre::Vector3::operator * const Vector3 &    rhs const [inline]
 

Vector3 Ogre::Vector3::operator * Real    fScalar const [inline]
 

Vector3& Ogre::Vector3::operator *= Real    fScalar [inline]
 

bool Ogre::Vector3::operator!= const Vector3 &    rkVector const [inline]
 

Vector3 Ogre::Vector3::operator+ const Vector3 &    rkVector const [inline]
 

Vector3& Ogre::Vector3::operator+= const Vector3 &    rkVector [inline]
 

Vector3 Ogre::Vector3::operator-   const [inline]
 

Vector3 Ogre::Vector3::operator- const Vector3 &    rkVector const [inline]
 

Vector3& Ogre::Vector3::operator-= const Vector3 &    rkVector [inline]
 

Vector3 Ogre::Vector3::operator/ Real    fScalar const [inline]
 

Vector3& Ogre::Vector3::operator/= Real    fScalar [inline]
 

bool Ogre::Vector3::operator< const Vector3 &    rhs const [inline]
 

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

Vector3& Ogre::Vector3::operator= const Vector3 &    rkVector [inline]
 

Assigns the value of the other vector.

Parameters:
rkVector  The other vector

bool Ogre::Vector3::operator== const Vector3 &    rkVector const [inline]
 

bool Ogre::Vector3::operator> const Vector3 &    rhs const [inline]
 

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

Real& Ogre::Vector3::operator[] unsigned    i [inline]
 

Real Ogre::Vector3::operator[] unsigned    i const [inline]
 

Vector3 Ogre::Vector3::perpendicular void    [inline]
 

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.

Vector3 Ogre::Vector3::randomDeviant Real    angle,
const Vector3 &    up = Vector3::ZERO
[inline]
 

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.

Real Ogre::Vector3::squaredLength   const [inline]
 

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.


Friends And Related Function Documentation

Vector3 operator * Real    fScalar,
const Vector3 &    rkVector
[friend]
 

_OgreExport friend std::ostream& operator<< std::ostream &    o,
const Vector3 &    v
[friend]
 

Function for writing to a stream.


Member Data Documentation

const Vector3 Ogre::Vector3::UNIT_SCALE [static]
 

const Vector3 Ogre::Vector3::UNIT_X [static]
 

const Vector3 Ogre::Vector3::UNIT_Y [static]
 

const Vector3 Ogre::Vector3::UNIT_Z [static]
 

Real Ogre::Vector3::x
 

Real Ogre::Vector3::y
 

Real Ogre::Vector3::z
 

const Vector3 Ogre::Vector3::ZERO [static]
 

Copyright © 2002 by The OGRE Team