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 double precision=std::numeric_limits< double >::min()) 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 &	getCross (const JVector3D &first, const JVector3D &second)
	Get cross product. More...

JFirst_t &	mul (const JSecond_t &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 34 of file JVector3D.hh.

Constructor & Destructor Documentation

◆ JVector3D() [1/3]

JGEOMETRY3D::JVector3D::JVector3D ( )

inline

Default constructor.

Definition at line 41 of file JVector3D.hh.

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

◆ JVector3D() [2/3]

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 55 of file JVector3D.hh.

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

◆ JVector3D() [3/3]

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

inline

Constructor.

Parameters

vector	(x,y) values
z	z value

Definition at line 70 of file JVector3D.hh.

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

Member Function Documentation

◆ operator JVector2D()

JGEOMETRY3D::JVector3D::operator JVector2D ( ) const

inline

Type conversion operator.

Returns: JVector2D

Definition at line 83 of file JVector3D.hh.

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

◆ getX()

double JGEOMETRY3D::JVector3D::getX ( ) const

inline

Get x position.

Returns: x position

Definition at line 94 of file JVector3D.hh.

     { 
       return __x;
     }

◆ getY()

double JGEOMETRY3D::JVector3D::getY ( ) const

inline

Get y position.

Returns: y position

Definition at line 104 of file JVector3D.hh.

     { 
       return __y;
     }

◆ getZ()

double JGEOMETRY3D::JVector3D::getZ ( ) const

inline

Get z position.

Returns: z position

Definition at line 115 of file JVector3D.hh.

     { 
       return __z;
     }

◆ negate()

JVector3D& JGEOMETRY3D::JVector3D::negate ( )

inline

Negate vector.

Returns: this vector

Definition at line 126 of file JVector3D.hh.

     {
       __x = -__x;
       __y = -__y;
       __z = -__z;
  
       return *this;
     }

◆ add()

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

inline

Add vector.

Parameters

vector vector

Returns: this vector

Definition at line 142 of file JVector3D.hh.

     {
       __x += vector.getX();
       __y += vector.getY();
       __z += vector.getZ();
  
       return *this;
     }

◆ sub()

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

inline

Subtract vector.

Parameters

vector vector

Returns: this vector

Definition at line 158 of file JVector3D.hh.

     {
       __x -= vector.getX();
       __y -= vector.getY();
       __z -= vector.getZ();
  
       return *this;
     }

◆ mul() [1/2]

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

inline

Scale vector.

Parameters

factor multiplication factor

Returns: this vector

Definition at line 174 of file JVector3D.hh.

     {
       __x *= factor;
       __y *= factor;
       __z *= factor;
  
       return *this;
     }

◆ div()

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

inline

Scale vector.

Parameters

factor division factor

Returns: this vector

Definition at line 190 of file JVector3D.hh.

     {
       __x /= factor;
       __y /= factor;
       __z /= factor;
  
       return *this;
     }

◆ transform()

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

inline

Transform.

Parameters

T matrix

Returns: this vector

Definition at line 206 of file JVector3D.hh.

     {
       T.transform(__x, __y, __z);
  
       return *this;
     }

◆ equals()

bool JGEOMETRY3D::JVector3D::equals	(	const JVector3D &	vector,
		const double	precision = `std::numeric_limits<double>::min()`
	)		const

inline

Check equality.

Parameters

vector	vector
precision	precision

Returns: true if vectors are equal; else false

Definition at line 221 of file JVector3D.hh.

     {
       return (fabs(getX() - vector.getX()) <= precision &&
               fabs(getY() - vector.getY()) <= precision &&
               fabs(getZ() - vector.getZ()) <= precision);
     }

◆ getLengthSquared()

double JGEOMETRY3D::JVector3D::getLengthSquared ( ) const

inline

Get length squared.

Returns: square of length

Definition at line 235 of file JVector3D.hh.

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

◆ getLength()

double JGEOMETRY3D::JVector3D::getLength ( ) const

inline

Get length.

Returns: length

Definition at line 246 of file JVector3D.hh.

     { 
       return sqrt(getLengthSquared());
     }

◆ getDistanceSquared()

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 258 of file JVector3D.hh.

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

◆ getDistance()

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

inline

Get distance to point.

Parameters

pos position

Returns: distance

Definition at line 270 of file JVector3D.hh.

     {
       return sqrt(getDistanceSquared(pos));
     }

◆ getDot()

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

inline

Get dot product.

Parameters

vector vector

Returns: dot product

Definition at line 282 of file JVector3D.hh.

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

◆ getCross()

JVector3D& JGEOMETRY3D::JVector3D::getCross	(	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 299 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;
     }

◆ mul() [2/2]

template<class JFirst_t , class JSecond_t >

JFirst_t& JMATH::JMath< JFirst_t, JSecond_t >::mul ( const JSecond_t & object )

inlineinherited

Multiply with object.

Parameters

object object

Returns: result object

Definition at line 354 of file JMath.hh.

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

Member Data Documentation

◆ __x

double JGEOMETRY3D::JVector3D::__x

protected

Definition at line 310 of file JVector3D.hh.

◆ __y

double JGEOMETRY3D::JVector3D::__y

protected

Definition at line 311 of file JVector3D.hh.

◆ __z

double JGEOMETRY3D::JVector3D::__z

protected

Definition at line 312 of file JVector3D.hh.

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

JVector3D.hh

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ JVector3D() [1/3]

◆ JVector3D() [2/3]

◆ JVector3D() [3/3]

Member Function Documentation

◆ operator JVector2D()

◆ getX()

◆ getY()

◆ getZ()

◆ negate()

◆ add()

◆ sub()

◆ mul() [1/2]

◆ div()

◆ transform()

◆ equals()

◆ getLengthSquared()

◆ getLength()

◆ getDistanceSquared()

◆ getDistance()

◆ getDot()

◆ getCross()

◆ mul() [2/2]

Member Data Documentation

◆ __x

◆ __y

◆ __z