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. More...
	JVector2D (const double x, const double y)
	Constructor. More...
double	getX () const
	Get x position. More...
double	getY () const
	Get y position. More...
JVector2D &	negate ()
	Negate vector. More...
JVector2D &	add (const JVector2D &vector)
	Add vector. More...
JVector2D &	sub (const JVector2D &vector)
	Subtract vector. More...
JVector2D &	mul (const double factor)
	Scale vector. More...
JVector2D &	div (const double factor)
	Scale vector. More...
JVector2D &	transform (const JMatrix2D &T)
	Transform. More...
bool	equals (const JVector2D &vector) const
	Check equality. More...
double	getLengthSquared () const
	Get length squared. More...
double	getLength () const
	Get length. More...
double	getDistanceSquared (const JVector2D &point) const
	Get squared of distance to point. More...
double	getDistance (const JVector2D &point) const
	Get distance to point. More...
double	getDot (const JVector2D &point) const
	Get dot product. More...
double	getPerpDot (const JVector2D &point) const
	Get perpendicular dot product. More...
JVector2D &	mul (const JNullType &object)
	Multiply with object. More...

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 30 of file JVector2D.hh.

Constructor & Destructor Documentation

JGEOMETRY2D::JVector2D::JVector2D ( )

inline

Default constructor.

Definition at line 37 of file JVector2D.hh.

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

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

inline

Constructor.

Parameters

x	x value
y	y value

Definition at line 49 of file JVector2D.hh.

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

Member Function Documentation

double JGEOMETRY2D::JVector2D::getX ( ) const

inline

Get x position.

Returns

x position

Definition at line 61 of file JVector2D.hh.

    { 
      return __x;
    }

double JGEOMETRY2D::JVector2D::getY ( ) const

inline

Get y position.

Returns

y position

Definition at line 72 of file JVector2D.hh.

    { 
      return __y;
    }

JVector2D& JGEOMETRY2D::JVector2D::negate ( )

inline

Negate vector.

Returns

this vector

Definition at line 83 of file JVector2D.hh.

    {
      __x = -__x;
      __y = -__y;

      return *this;
    }

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

inline

Add vector.

Parameters

vector

vector

Returns

this vector

Definition at line 98 of file JVector2D.hh.

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

      return *this;
    }

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

inline

Subtract vector.

Parameters

vector

vector

Returns

this vector

Definition at line 113 of file JVector2D.hh.

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

      return *this;
    }

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

inline

Scale vector.

Parameters

factor

multiplication factor

Returns

this vector

Definition at line 128 of file JVector2D.hh.

    {
      __x *= factor;
      __y *= factor;

      return *this;
    }

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

inline

Scale vector.

Parameters

factor

division factor

Returns

this vector

Definition at line 143 of file JVector2D.hh.

    {
      __x /= factor;
      __y /= factor;

      return *this;
    }

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

inline

Transform.

Parameters

T

matrix

Returns

this vector

Definition at line 158 of file JVector2D.hh.

    {
      T.transform(__x, __y);

      return *this;
    }

bool JGEOMETRY2D::JVector2D::equals ( const JVector2D &  vector ) const

inline

Check equality.

Parameters

vector

vector

Returns

true if vectors are equal; else false

Definition at line 172 of file JVector2D.hh.

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

double JGEOMETRY2D::JVector2D::getLengthSquared ( ) const

inline

Get length squared.

Returns

square of length

Definition at line 184 of file JVector2D.hh.

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

double JGEOMETRY2D::JVector2D::getLength ( ) const

inline

Get length.

Returns

length

Definition at line 195 of file JVector2D.hh.

    { 
      return sqrt(getLengthSquared());
    }

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 207 of file JVector2D.hh.

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

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

inline

Get distance to point.

Parameters

point

point

Returns

distance

Definition at line 219 of file JVector2D.hh.

    {
      return sqrt(getDistanceSquared(point));
    }

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

inline

Get dot product.

Parameters

point

vector

Returns

dot product

Definition at line 231 of file JVector2D.hh.

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

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

inline

Get perpendicular dot product.

Parameters

point

vector

Returns

perpendicular dot product

Definition at line 245 of file JVector2D.hh.

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

JVector2D & JMATH::JMath< JVector2D , 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 JGEOMETRY2D::JVector2D::__x

protected

Definition at line 253 of file JVector2D.hh.

double JGEOMETRY2D::JVector2D::__y

protected

Definition at line 254 of file JVector2D.hh.

---

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

• JVector2D.hh