Vector Class Reference

#include <vector.h>

Public Member Functions
	Vector ()
	Vector (const float x0, const float y0, const float z0)
	Vector (const Vector &v)
bool	isNull () const
Vector &	operator= (const Vector &v)
Vector	operator* (const float c) const
Vector &	operator*= (const float c)
Vector	operator/ (const float c) const
Vector &	operator/= (const float c)
Vector	operator+ (const Vector &v) const
Vector &	operator+= (const Vector &v)
Vector	operator- (const Vector &v) const
Vector &	operator-= (const Vector &v)
float	length () const
float	squaredLength () const
float	manhattanLength () const
Vector	normalized () const

Data Fields
float	x
float	y
float	z

Detailed Description

Vector class. Represents either a 3D point in space, a velocity or a force. Provides several convenient operator overloads.

Definition at line 39 of file vector.h.

Constructor & Destructor Documentation

Vector() [1/3]

Vector::Vector ( )

inline

Constructor.

Definition at line 45 of file vector.h.

                 :
            x(0.0F),
            y(0.0F),
            z(0.0F)
        {}

Referenced by normalized(), operator*(), operator+(), operator-(), and operator/().

Vector() [2/3]

Vector::Vector ( const float  x0, const float  y0, const float  z0  )

inline

Constructor.

Definition at line 54 of file vector.h.

                               :
            x(x0),
            y(y0),
            z(z0)
        {}

Vector() [3/3]

Vector::Vector ( const Vector &  v )

inline

Copy constructor.

Definition at line 65 of file vector.h.

                                :
            x(v.x),
            y(v.y),
            z(v.z)
        {}

Member Function Documentation

isNull()

bool Vector::isNull ( ) const

inline

Returns true if all coordinates are set to 0, otherwise returns false.

Definition at line 77 of file vector.h.

        {
            return x == 0.0F && y == 0.0F && z == 0.0F;
        }

References x, y, and z.

length()

float Vector::length ( ) const

inline

Returns the length of this vector. This method does a relatively slow square root.

Definition at line 178 of file vector.h.

        {
            return sqrtf(x * x + y * y + z * z);
        }

References x, y, and z.

Referenced by normalized().

manhattanLength()

float Vector::manhattanLength ( ) const

inline

Returns the manhattan length of this vector.

Definition at line 194 of file vector.h.

        {
            return fabsf(x) + fabsf(y) + fabsf(z);
        }

References x, y, and z.

normalized()

Vector Vector::normalized ( ) const

inline

Returns a normalized version of this vector. This is a unit vector running parallel to it.

Definition at line 203 of file vector.h.

        {
            const float len = length();
            return Vector(x / len, y / len, z / len);
        }

References length(), Vector(), x, y, and z.

operator*()

Vector Vector::operator* ( const float  c ) const

inline

Scale vector operator.

Definition at line 93 of file vector.h.

        {
            return Vector(x * c,
                          y * c,
                          z * c);
        }

References Vector(), x, y, and z.

operator*=()

Vector& Vector::operator*= ( const float  c )

inline

In-place scale vector operator.

Definition at line 103 of file vector.h.

        {
            x *= c;
            y *= c;
            z *= c;
            return *this;
        }

References x, y, and z.

operator+()

Vector Vector::operator+ ( const Vector &  v ) const

inline

Add vector operator.

Definition at line 135 of file vector.h.

        {
            return Vector(x + v.x,
                          y + v.y,
                          z + v.z);
        }

References Vector(), x, y, and z.

operator+=()

Vector& Vector::operator+= ( const Vector &  v )

inline

In-place add vector operator.

Definition at line 145 of file vector.h.

        {
            x += v.x;
            y += v.y;
            z += v.z;
            return *this;
        }

References x, y, and z.

operator-()

Vector Vector::operator- ( const Vector &  v ) const

inline

Subtract vector operator.

Definition at line 156 of file vector.h.

        {
            return Vector(x - v.x,
                          y - v.y,
                          z - v.z);
        }

References Vector(), x, y, and z.

operator-=()

Vector& Vector::operator-= ( const Vector &  v )

inline

In-place subtract vector operator.

Definition at line 166 of file vector.h.

        {
            x -= v.x;
            y -= v.y;
            z -= v.z;
            return *this;
        }

References x, y, and z.

operator/()

Vector Vector::operator/ ( const float  c ) const

inline

Scale vector operator.

Definition at line 114 of file vector.h.

        {
            return Vector(x / c,
                          y / c,
                          z / c);
        }

References Vector(), x, y, and z.

operator/=()

Vector& Vector::operator/= ( const float  c )

inline

In-place scale vector operator.

Definition at line 124 of file vector.h.

        {
            x /= c;
            y /= c;
            z /= c;
            return *this;
        }

References x, y, and z.

operator=()

Vector& Vector::operator= ( const Vector &  v )

inline

Definition at line 82 of file vector.h.

        {
            x = v.x;
            y = v.y;
            z = v.z;
            return *this;
        }

References x, y, and z.

squaredLength()

float Vector::squaredLength ( ) const

inline

Returns the squared length of this vector. Avoids the square root.

Definition at line 186 of file vector.h.

        {
            return x * x + y * y + z * z;
        }

References x, y, and z.

Field Documentation

x

float Vector::x

Definition at line 209 of file vector.h.

Referenced by Being::calcDirection(), Actor::getPixelX(), isNull(), length(), LocalPlayer::loadHomes(), ActorSprite::logic(), manhattanLength(), LocalPlayer::moveToHome(), normalized(), FindBeingFunctor::operator()(), operator*(), operator*=(), operator+(), operator+=(), operator-(), operator-=(), operator/(), operator/=(), operator<<(), operator=(), FloorItem::postInit(), LocalPlayer::saveHomes(), LocalPlayer::setDestination(), LocalPlayer::setHome(), Particle::setVelocity(), squaredLength(), Particle::update(), LocalPlayer::updateNavigateList(), and Particle::updateSelf().

y

float Vector::y

Definition at line 209 of file vector.h.

Referenced by Being::calcDirection(), Actor::getPixelY(), Particle::getPixelY(), TextParticle::getPixelY(), Actor::getSortPixelY(), Particle::getSortPixelY(), TextParticle::getSortPixelY(), isNull(), length(), LocalPlayer::loadHomes(), ActorSprite::logic(), manhattanLength(), LocalPlayer::moveToHome(), normalized(), FindBeingFunctor::operator()(), operator*(), operator*=(), operator+(), operator+=(), operator-(), operator-=(), operator/(), operator/=(), operator<<(), operator=(), FloorItem::postInit(), LocalPlayer::saveHomes(), LocalPlayer::setDestination(), LocalPlayer::setHome(), Particle::setVelocity(), squaredLength(), Particle::update(), LocalPlayer::updateNavigateList(), and Particle::updateSelf().

z

float Vector::z

Definition at line 209 of file vector.h.

Referenced by TextParticle::getPixelY(), TextParticle::getSortPixelY(), isNull(), length(), manhattanLength(), normalized(), operator*(), operator*=(), operator+(), operator+=(), operator-(), operator-=(), operator/(), operator/=(), operator<<(), operator=(), Particle::setVelocity(), squaredLength(), and Particle::updateSelf().

---

The documentation for this class was generated from the following file:

• src/resources/vector.h (986a3bf)