JGEOMETRY2D::JVector2D Class Reference

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

#include <JVector2D.hh>

Inheritance diagram for JGEOMETRY2D::JVector2D:

Public Member Functions
	JVector2D ()
	Default constructor.
	JVector2D (const double x, const double y)
	Constructor.
double	getX () const
	Get x position.
double	getY () const
	Get y position.
JVector2D &	negate ()
	Negate vector.
JVector2D &	add (const JVector2D &vector)
	Add vector.
JVector2D &	sub (const JVector2D &vector)
	Subtract vector.
JVector2D &	mul (const double factor)
	Scale vector.
JVector2D &	div (const double factor)
	Scale vector.
JVector2D &	transform (const JMatrix2D &T)
	Transform.
bool	equals (const JVector2D &vector, const double precision=std::numeric_limits< double >::min()) const
	Check equality.
double	getLengthSquared () const
	Get length squared.
double	getLength () const
	Get length.
double	getDistanceSquared (const JVector2D &point) const
	Get squared of distance to point.
double	getDistance (const JVector2D &point) const
	Get distance to point.
double	getDot (const JVector2D &point) const
	Get dot product.
double	getPerpDot (const JVector2D &point) const
	Get perpendicular dot product.
JFirst_t &	mul (const JSecond_t &object)
	Multiply with object.

Protected Attributes
double	__x
double	__y

Detailed Description

Data structure for vector in two dimensions.

This class implements the JMATH::JMath interface.

Definition at line 32 of file JVector2D.hh.

Constructor & Destructor Documentation

JVector2D() [1/2]

JGEOMETRY2D::JVector2D::JVector2D ( )

inline

Default constructor.

Definition at line 39 of file JVector2D.hh.

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

JVector2D() [2/2]

JGEOMETRY2D::JVector2D::JVector2D ( const double x, const double y )

inline

Constructor.

Parameters

x	x value
y	y value

Definition at line 51 of file JVector2D.hh.

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

Member Function Documentation

getX()

double JGEOMETRY2D::JVector2D::getX ( ) const

inline

Get x position.

Returns

x position

Definition at line 63 of file JVector2D.hh.

    { 
      return __x;
    }

getY()

double JGEOMETRY2D::JVector2D::getY ( ) const

inline

Get y position.

Returns

y position

Definition at line 74 of file JVector2D.hh.

    { 
      return __y;
    }

negate()

JVector2D & JGEOMETRY2D::JVector2D::negate ( )

inline

Negate vector.

Returns

this vector

Definition at line 85 of file JVector2D.hh.

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

add()

JVector2D & JGEOMETRY2D::JVector2D::add ( const JVector2D & vector )

inline

Add vector.

Parameters

vector

vector

Returns

this vector

Definition at line 100 of file JVector2D.hh.

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

sub()

JVector2D & JGEOMETRY2D::JVector2D::sub ( const JVector2D & vector )

inline

Subtract vector.

Parameters

vector

vector

Returns

this vector

Definition at line 115 of file JVector2D.hh.

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

mul() [1/2]

JVector2D & JGEOMETRY2D::JVector2D::mul ( const double factor )

inline

Scale vector.

Parameters

factor

multiplication factor

Returns

this vector

Definition at line 130 of file JVector2D.hh.

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

div()

JVector2D & JGEOMETRY2D::JVector2D::div ( const double factor )

inline

Scale vector.

Parameters

factor

division factor

Returns

this vector

Definition at line 145 of file JVector2D.hh.

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

transform()

JVector2D & JGEOMETRY2D::JVector2D::transform ( const JMatrix2D & T )

inline

Transform.

Parameters

T

matrix

Returns

this vector

Definition at line 160 of file JVector2D.hh.

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

equals()

bool JGEOMETRY2D::JVector2D::equals ( const JVector2D & 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 175 of file JVector2D.hh.

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

getLengthSquared()

double JGEOMETRY2D::JVector2D::getLengthSquared ( ) const

inline

Get length squared.

Returns

square of length

Definition at line 188 of file JVector2D.hh.

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

getLength()

double JGEOMETRY2D::JVector2D::getLength ( ) const

inline

Get length.

Returns

length

Definition at line 199 of file JVector2D.hh.

    { 
      return sqrt(getLengthSquared());
    }

getDistanceSquared()

double JGEOMETRY2D::JVector2D::getDistanceSquared ( const JVector2D & point ) const

inline

Get squared of distance to point.

Parameters

point

point

Returns

square of distance

Definition at line 211 of file JVector2D.hh.

    {
      return JVector2D(point).sub(*this).getLengthSquared();
    }

getDistance()

double JGEOMETRY2D::JVector2D::getDistance ( const JVector2D & point ) const

inline

Get distance to point.

Parameters

point

point

Returns

distance

Definition at line 223 of file JVector2D.hh.

    {
      return sqrt(getDistanceSquared(point));
    }

getDot()

double JGEOMETRY2D::JVector2D::getDot ( const JVector2D & point ) const

inline

Get dot product.

Parameters

point

vector

Returns

dot product

Definition at line 235 of file JVector2D.hh.

    {
      return
        getX() * point.getX() + 
        getY() * point.getY();
    }

getPerpDot()

double JGEOMETRY2D::JVector2D::getPerpDot ( const JVector2D & point ) const

inline

Get perpendicular dot product.

Parameters

point

vector

Returns

perpendicular dot product

Definition at line 249 of file JVector2D.hh.

    {
      return
        getX() * point.getY() - 
        getY() * point.getX();
    }

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 JGEOMETRY2D::JVector2D::__x

protected

Definition at line 257 of file JVector2D.hh.

__y

double JGEOMETRY2D::JVector2D::__y

protected

Definition at line 258 of file JVector2D.hh.

---

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

• JVector2D.hh