JGEOMETRY3D::JVector3D Class Reference

Data structure for vector in three dimensions. More...

#include <JVector3D.hh>

Inheritance diagram for JGEOMETRY3D::JVector3D:

Public Member Functions
	JVector3D ()
	Default constructor. More...
	JVector3D (const double x, const double y, const double z)
	Constructor. More...
	JVector3D (const JVector2D &vector, const double z)
	Constructor. More...
	operator JVector2D () const
	Type conversion operator. More...
double	getX () const
	Get x position. More...
double	getY () const
	Get y position. More...
double	getZ () const
	Get z position. More...
JVector3D &	negate ()
	Negate vector. More...
JVector3D &	add (const JVector3D &vector)
	Add vector. More...
JVector3D &	sub (const JVector3D &vector)
	Subtract vector. More...
JVector3D &	mul (const double factor)
	Scale vector. More...
JVector3D &	div (const double factor)
	Scale vector. More...
JVector3D &	transform (const JMatrix3D &T)
	Transform. More...
bool	equals (const JVector3D &vector) const
	Check equality. More...
double	getLengthSquared () const
	Get length squared. More...
double	getLength () const
	Get length. More...
double	getDistanceSquared (const JVector3D &pos) const
	Get squared of distance to point. More...
double	getDistance (const JVector3D &pos) const
	Get distance to point. More...
double	getDot (const JVector3D &vector) const
	Get dot product. More...
JVector3D &	cross (const JVector3D &first, const JVector3D &second)
	Get cross product. More...
JVector3D &	mul (const JNullType &object)
	Multiply with object. More...

Protected Attributes
double	__x
double	__y
double	__z

Detailed Description

Data structure for vector in three dimensions.

This class implements the JMATH::JMath interface.

Definition at line 32 of file JVector3D.hh.

Constructor & Destructor Documentation

JGEOMETRY3D::JVector3D::JVector3D ( )

inline

Default constructor.

Definition at line 39 of file JVector3D.hh.

                :
      __x(0.0),
      __y(0.0),
      __z(0.0)
    {}

JGEOMETRY3D::JVector3D::JVector3D ( const double  x, const double  y, const double  z  )

inline

Constructor.

Parameters

x	x value
y	y value
z	z value

Definition at line 53 of file JVector3D.hh.

                              :
      __x(x),
      __y(y),
      __z(z)
    {}

JGEOMETRY3D::JVector3D::JVector3D ( const JVector2D &  vector, const double  z  )

inline

Constructor.

Parameters

vector	(x,y) values
z	z value

Definition at line 68 of file JVector3D.hh.

                                  :
      __x(vector.getX()),
      __y(vector.getY()),
      __z(z)
    {}

Member Function Documentation

JGEOMETRY3D::JVector3D::operator JVector2D ( ) const

inline

Type conversion operator.

Returns

JVector2D

Definition at line 81 of file JVector3D.hh.

    {
      return JVector2D(this->getX(), this->getY());
    }

double JGEOMETRY3D::JVector3D::getX ( ) const

inline

Get x position.

Returns

x position

Definition at line 92 of file JVector3D.hh.

    { 
      return __x;
    }

double JGEOMETRY3D::JVector3D::getY ( ) const

inline

Get y position.

Returns

y position

Definition at line 102 of file JVector3D.hh.

    { 
      return __y;
    }

double JGEOMETRY3D::JVector3D::getZ ( ) const

inline

Get z position.

Returns

z position

Definition at line 113 of file JVector3D.hh.

    { 
      return __z;
    }

JVector3D& JGEOMETRY3D::JVector3D::negate ( )

inline

Negate vector.

Returns

this vector

Definition at line 124 of file JVector3D.hh.

    {
      __x = -__x;
      __y = -__y;
      __z = -__z;

      return *this;
    }

JVector3D& JGEOMETRY3D::JVector3D::add ( const JVector3D &  vector )

inline

Add vector.

Parameters

vector

vector

Returns

this vector

Definition at line 140 of file JVector3D.hh.

    {
      __x += vector.getX();
      __y += vector.getY();
      __z += vector.getZ();

      return *this;
    }

JVector3D& JGEOMETRY3D::JVector3D::sub ( const JVector3D &  vector )

inline

Subtract vector.

Parameters

vector

vector

Returns

this vector

Definition at line 156 of file JVector3D.hh.

    {
      __x -= vector.getX();
      __y -= vector.getY();
      __z -= vector.getZ();

      return *this;
    }

JVector3D& JGEOMETRY3D::JVector3D::mul ( const double  factor )

inline

Scale vector.

Parameters

factor

multiplication factor

Returns

this vector

Definition at line 172 of file JVector3D.hh.

    {
      __x *= factor;
      __y *= factor;
      __z *= factor;

      return *this;
    }

JVector3D& JGEOMETRY3D::JVector3D::div ( const double  factor )

inline

Scale vector.

Parameters

factor

division factor

Returns

this vector

Definition at line 188 of file JVector3D.hh.

    {
      __x /= factor;
      __y /= factor;
      __z /= factor;

      return *this;
    }

JVector3D& JGEOMETRY3D::JVector3D::transform ( const JMatrix3D &  T )

inline

Transform.

Parameters

T

matrix

Returns

this vector

Definition at line 204 of file JVector3D.hh.

    {
      T.transform(__x, __y, __z);

      return *this;
    }

bool JGEOMETRY3D::JVector3D::equals ( const JVector3D &  vector ) const

inline

Check equality.

Parameters

vector

vector

Returns

true if vectors are equal; else false

Definition at line 218 of file JVector3D.hh.

    {
      return (getX() == vector.getX() && 
              getY() == vector.getY() &&
              getZ() == vector.getZ());
    }

double JGEOMETRY3D::JVector3D::getLengthSquared ( ) const

inline

Get length squared.

Returns

square of length

Definition at line 231 of file JVector3D.hh.

    { 
      return getX()*getX() + getY()*getY() + getZ()*getZ();
    }

double JGEOMETRY3D::JVector3D::getLength ( ) const

inline

Get length.

Returns

length

Definition at line 242 of file JVector3D.hh.

    { 
      return sqrt(getLengthSquared());
    }

double JGEOMETRY3D::JVector3D::getDistanceSquared ( const JVector3D &  pos ) const

inline

Get squared of distance to point.

Parameters

pos

position

Returns

square of distance

Definition at line 254 of file JVector3D.hh.

    {
      return JVector3D(pos).sub(*this).getLengthSquared();
    }

double JGEOMETRY3D::JVector3D::getDistance ( const JVector3D &  pos ) const

inline

Get distance to point.

Parameters

pos

position

Returns

distance

Definition at line 266 of file JVector3D.hh.

    {
      return sqrt(getDistanceSquared(pos));
    }

double JGEOMETRY3D::JVector3D::getDot ( const JVector3D &  vector ) const

inline

Get dot product.

Parameters

vector

vector

Returns

dot product

Definition at line 278 of file JVector3D.hh.

    {
      return
        getX() * vector.getX() +
        getY() * vector.getY() +
        getZ() * vector.getZ();
    }

JVector3D& JGEOMETRY3D::JVector3D::cross ( const JVector3D &  first, const JVector3D &  second  )

inline

Get cross product.

Note that this vector should not overlap with the first or second vector,

Parameters

first	first vector
second	second vector

Returns

this vector

Definition at line 295 of file JVector3D.hh.

    {
      __x = first .getY() * second.getZ()  -  second.getY() * first .getZ();
      __y = second.getX() * first .getZ()  -  first .getX() * second.getZ();
      __z = first .getX() * second.getY()  -  second.getX() * first .getY();

      return *this;
    }

JVector3D & JMATH::JMath< JVector3D , JNullType >::mul ( const JNullType &  object )

inlineinherited

Multiply with object.

Parameters

object

object

Returns

result object

Definition at line 273 of file JMath.hh.

    {
      return static_cast<JFirst_t&>(*this) = JCalculator<JFirst_t>::calculator.mul(static_cast<const JFirst_t&>(*this), object);
    }

Member Data Documentation

double JGEOMETRY3D::JVector3D::__x

protected

Definition at line 306 of file JVector3D.hh.

double JGEOMETRY3D::JVector3D::__y

protected

Definition at line 307 of file JVector3D.hh.

double JGEOMETRY3D::JVector3D::__z

protected

Definition at line 308 of file JVector3D.hh.

---

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

• JVector3D.hh