Vector3D Class Reference

#include "Vector3D.h"

Public Member Functions
	Vector3D ()
	Vector3D (double nx, double ny, double nz)
	Vector3D (const Vector3D &v)
Vector3D	copy () const
double	magnitude () const
double	length () const
double	lengthSquared () const
void	normalize ()
double	dotProduct (const Vector3D &v) const
Vector3D	crossProduct (const Vector3D &v) const
Vector3D	reflection (Vector3D norm) const
Vector3D	refraction (Vector3D norm, double fact) const
void	set (double nx, double ny, double nz)
void	set (const Vector3D &v)
bool	operator== (const Vector3D &v)
bool	operator!= (const Vector3D &v)
Vector3D &	operator= (const Vector3D &v)
Vector3D	operator+ (const Vector3D &v) const
Vector3D &	operator+= (const Vector3D &v)
Vector3D	operator- (const Vector3D &v) const
Vector3D &	operator-= (const Vector3D &v)
Vector3D	operator* (const Vector3D &v) const
Vector3D &	operator*= (const Vector3D &v)
Vector3D	operator/ (const Vector3D &v) const
Vector3D &	operator/= (const Vector3D &v)
Vector3D	operator* (const double &k) const
Vector3D &	operator*= (const double &k)
Vector3D	operator/ (const double &k) const
Vector3D &	operator/= (const double &k)
bool	isNotZero ()
void	MakeRandomPointOnSphere (double radius)
void	MakeRandomPointOnSphereLayer (double radiusInner, double radiusOuter)

Public Attributes
double	x
double	y
double	z

Detailed Description

A 3 dimensional double vector.

Definition at line 37 of file Vector3D.h.

Constructor & Destructor Documentation

Vector3D::Vector3D ( )

inline

Definition at line 42 of file Vector3D.h.

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

    {
        x = y = z = 0;
    }

Here is the caller graph for this function:

Vector3D::Vector3D ( double  nx, double  ny, double  nz  )

inline

Definition at line 47 of file Vector3D.h.

    {
        x = nx;
        y = ny;
        z = nz;
    }

Vector3D::Vector3D ( const Vector3D &  v )

inline

Definition at line 54 of file Vector3D.h.

References x, y, and z.

    {
        x = v.x;
        y = v.y;
        z = v.z;
    }

Member Function Documentation

Vector3D Vector3D::copy ( ) const

inline

Return a copy of the vector.

Returns

The copy of the vector.

Definition at line 65 of file Vector3D.h.

References Vector3D().

    {
        return Vector3D(*this);
    }

Here is the call graph for this function:

Vector3D Vector3D::crossProduct

(

const Vector3D &

v

)

const

Calculate the cross product of this vector and the provided vector.

Parameters

v	The provided vector.

Returns

The cross product of the 2 vectors.

Note

The resultant vector is perpendicular to a plane formed by the two vectors.

The magnitude of the result is the area formed by the parallelogram of the two vectors.

Definition at line 64 of file Vector3D.cpp.

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

{
    double nx = y * v.z - z * v.y;
    double ny = z * v.x - x * v.z;
    double nz = x * v.y - y * v.x;
    return Vector3D(nx, ny, nz);
}

Here is the call graph for this function:

double Vector3D::dotProduct

(

const Vector3D &

v

)

const

Calculate the dot product of this vector and the provided vector.

Parameters

v	The provided vector.

Returns

The dot product.

Note

If both Vectors are unit Vectors then the result is the cosine of the angle between them. otherwise it's scaled by the product of there lengths.

Definition at line 59 of file Vector3D.cpp.

References x, y, and z.

Referenced by reflection(), and refraction().

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

Here is the caller graph for this function:

bool Vector3D::isNotZero ( )

inline

Definition at line 163 of file Vector3D.h.

    {
        return x != 0 || y != 0 || z != 0;
    }

double Vector3D::length ( ) const

inline

Definition at line 76 of file Vector3D.h.

References magnitude().

    {
        return magnitude();
    }

Here is the call graph for this function:

double Vector3D::lengthSquared ( ) const

inline

Definition at line 81 of file Vector3D.h.

References y.

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

double Vector3D::magnitude

(

)

const

Retrieves the length of the Vector.

Returns

The length of the vector.

Definition at line 28 of file Vector3D.cpp.

References x, y, and z.

Referenced by length().

{
    double m;

    //calculate the length of the Vector3D
    m = (x * x) + (y * y) + (z * z);
    m = sqrt(m);

    return m;
}

Here is the caller graph for this function:

void Vector3D::MakeRandomPointOnSphere ( double  radius )

inline

Definition at line 173 of file Vector3D.h.

References MakeRandomFloat().

    {
        double theta = MakeRandomFloat(0.0, (2 * M_PI));
        double phi = MakeRandomFloat(0.0, (2 * M_PI));
        x += radius * sin(theta) * cos(phi);
        y += radius * sin(theta) * sin(phi);
        z += radius * cos(theta);
    }

Here is the call graph for this function:

void Vector3D::MakeRandomPointOnSphereLayer ( double  radiusInner, double  radiusOuter  )

inline

Definition at line 187 of file Vector3D.h.

References MakeRandomFloat().

    {
        double theta = MakeRandomFloat(0.0, (2 * M_PI));
        double phi = MakeRandomFloat(0.0, (2 * M_PI));
        double intermediateRadius = MakeRandomFloat(radiusInner, radiusOuter);
        x += intermediateRadius * sin(theta) * cos(phi);
        y += intermediateRadius * sin(theta) * sin(phi);
        z += intermediateRadius * cos(theta);
    }

Here is the call graph for this function:

void Vector3D::normalize

(

)

Scale the Vector so it has a length of 1.

Definition at line 39 of file Vector3D.cpp.

References x, y, and z.

{
    double m;

    //calculate the length of the Vector3D
    m = (x * x) + (y * y) + (z * z);
    m = sqrt(m);

    // if the length is zero then the Vector3D is zero so return
    if (m == 0)
    {
        return;
    }

    //Scale the Vector3D to a unit length
    x /= m;
    y /= m;
    z /= m;
}

bool Vector3D::operator!= ( const Vector3D &  v )

inline

Definition at line 141 of file Vector3D.h.

References x, y, and z.

    {
        return v.x != x || v.y != y || v.z != z;
    }

Vector3D Vector3D::operator*

(

const Vector3D &

v

)

const

Definition at line 143 of file Vector3D.cpp.

References Vector3D().

{
    return Vector3D(*this) *= v;
}

Here is the call graph for this function:

Vector3D Vector3D::operator*

(

const double &

k

)

const

Definition at line 169 of file Vector3D.cpp.

References Vector3D().

{
    return Vector3D(*this) *= k;
}

Here is the call graph for this function:

Vector3D & Vector3D::operator*=

(

const Vector3D &

v

)

Definition at line 148 of file Vector3D.cpp.

References x, y, and z.

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

Vector3D & Vector3D::operator*=

(

const double &

k

)

Definition at line 174 of file Vector3D.cpp.

References x, y, and z.

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

Vector3D Vector3D::operator+

(

const Vector3D &

v

)

const

Definition at line 117 of file Vector3D.cpp.

References Vector3D().

{
    return Vector3D(*this) += v;
}

Here is the call graph for this function:

Vector3D & Vector3D::operator+=

(

const Vector3D &

v

)

Definition at line 122 of file Vector3D.cpp.

References x, y, and z.

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

Vector3D Vector3D::operator-

(

const Vector3D &

v

)

const

Definition at line 130 of file Vector3D.cpp.

References Vector3D().

{
    return Vector3D(*this) -= v;
}

Here is the call graph for this function:

Vector3D & Vector3D::operator-=

(

const Vector3D &

v

)

Definition at line 135 of file Vector3D.cpp.

References x, y, and z.

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

Vector3D Vector3D::operator/

(

const Vector3D &

v

)

const

Definition at line 156 of file Vector3D.cpp.

References Vector3D().

{
    return Vector3D(*this) /= v;
}

Here is the call graph for this function:

Vector3D Vector3D::operator/

(

const double &

k

)

const

Definition at line 182 of file Vector3D.cpp.

References Vector3D().

{
    return Vector3D(*this) /= k;
}

Here is the call graph for this function:

Vector3D & Vector3D::operator/=

(

const Vector3D &

v

)

Definition at line 161 of file Vector3D.cpp.

References x, y, and z.

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

Vector3D & Vector3D::operator/=

(

const double &

k

)

Definition at line 187 of file Vector3D.cpp.

References x, y, and z.

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

Vector3D & Vector3D::operator=

(

const Vector3D &

v

)

Definition at line 109 of file Vector3D.cpp.

References x, y, and z.

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

bool Vector3D::operator== ( const Vector3D &  v )

inline

Definition at line 137 of file Vector3D.h.

References x, y, and z.

    {
        return v.x == x && v.y == y && v.z == z;
    }

Vector3D Vector3D::reflection

(

Vector3D

norm

)

const

Calculate the reflection vector for a surface with the specified normal.

Parameters

norm	The surface normal of the surface to reflect from.

Returns

The reflection vector.

Definition at line 72 of file Vector3D.cpp.

References dotProduct().

{
    Vector3D refl;
    refl = norm * (-2 * dotProduct(norm));
    refl = (*this) - refl;
    return refl;
}

Here is the call graph for this function:

Vector3D Vector3D::refraction	(	Vector3D	norm,
		double	fact
	)		const

Calculate the refraction vector for a surface with the specified normal.

Parameters

norm	The surface normal of the surface to refract through.
fact	The refraction factor.

Returns

The refraction vector.

Definition at line 80 of file Vector3D.cpp.

References dotProduct().

{
    Vector3D refr;
    double n_r = this->dotProduct(norm);
    double k = 1 - (n_r * n_r);
    k = 1 - (fact * fact) * k;
    if (k < 0)
    {
        return refr;
    }
    refr = (*this) * fact;
    refr -= norm * (fact * n_r + sqrt(k));
    return refr;
}

Here is the call graph for this function:

void Vector3D::set	(	double	nx,
		double	ny,
		double	nz
	)

Set the values of the vector.

Parameters

nx	The new value for X.
ny	The new value for Y.
nz	The new value for Z.

Definition at line 95 of file Vector3D.cpp.

References x, y, and z.

{
    x = nx;
    y = ny;
    z = nz;
}

void Vector3D::set

(

const Vector3D &

v

)

Set the values of the vector.

Parameters

v	The new value for the vector.

Definition at line 102 of file Vector3D.cpp.

References x, y, and z.

{
    x = v.x;
    y = v.y;
    z = v.z;
}

Member Data Documentation

double Vector3D::x

Definition at line 40 of file Vector3D.h.

Referenced by crossProduct(), dotProduct(), magnitude(), normalize(), operator!=(), operator*=(), operator+=(), operator-=(), operator/=(), operator=(), operator==(), set(), and Vector3D().

double Vector3D::y

Definition at line 40 of file Vector3D.h.

Referenced by crossProduct(), dotProduct(), lengthSquared(), magnitude(), normalize(), operator!=(), operator*=(), operator+=(), operator-=(), operator/=(), operator=(), operator==(), set(), and Vector3D().

double Vector3D::z

Definition at line 40 of file Vector3D.h.

Referenced by crossProduct(), dotProduct(), magnitude(), normalize(), operator!=(), operator*=(), operator+=(), operator-=(), operator/=(), operator=(), operator==(), set(), and Vector3D().

---

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

• /backups/local/src/eve/EvEmu_Crucible/src/eve-core/math/Vector3D.h
• /backups/local/src/eve/EvEmu_Crucible/src/eve-core/math/Vector3D.cpp