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

#include <JPosition2D.hh>

Inheritance diagram for JGEOMETRY2D::JPosition2D:

Public Member Functions
	JPosition2D ()
	Default constructor.

	JPosition2D (const JVector2D &pos)
	Constructor.

	JPosition2D (const JAngle2D &angle)
	Constructor.

	JPosition2D (const JVersor2D &dir)
	Constructor.

	JPosition2D (const double x, const double y)
	Constructor.

const JPosition2D &	getPosition () const
	Get position.

JPosition2D &	getPosition ()
	Get position.

void	setPosition (const JVector2D &pos)
	Set position.

	operator JAngle2D () const
	Type conversion operator.

	operator JVersor2D () const
	Type conversion operator.

JPosition2D &	rotate (const JRotation2D &R)
	Rotate.

JPosition2D &	rotate_back (const JRotation2D &R)
	Rotate back.

double	getDot (const JAngle2D &angle) const
	Get dot product.

double	getDot (const JVersor2D &versor) const
	Get dot product.

double	getPerpDot (const JAngle2D &angle) const
	Get perpendicular dot product.

double	getPerpDot (const JVersor2D &dir) const
	Get perpendicular dot product.

double	getDot (const JVector2D &point) const
	Get dot product.

double	getPerpDot (const JVector2D &point) const
	Get perpendicular dot product.

JVector2D &	transform (const JMatrix2D &T)
	Transform.

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.

JFirst_t &	mul (const JSecond_t &object)
	Multiply with object.

JVector2D &	div (const double factor)
	Scale vector.

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.

Protected Attributes
double	__x

double	__y

Friends
std::istream &	operator>> (std::istream &in, JPosition2D &position)
	Read position from input.

std::ostream &	operator<< (std::ostream &out, const JPosition2D &position)
	Write position to output.

JReader &	operator>> (JReader &in, JPosition2D &position)
	Read position from input.

JWriter &	operator<< (JWriter &out, const JPosition2D &position)
	Write position to output.

Detailed Description

Data structure for position in two dimensions.

Definition at line 31 of file JPosition2D.hh.

Constructor & Destructor Documentation

◆ JPosition2D() [1/5]

JGEOMETRY2D::JPosition2D::JPosition2D ( )

inline

Default constructor.

Definition at line 44 of file JPosition2D.hh.

                  :
      JVector2D()
    {}

◆ JPosition2D() [2/5]

JGEOMETRY2D::JPosition2D::JPosition2D ( const JVector2D & pos )

inline

Constructor.

Parameters

pos position

Definition at line 54 of file JPosition2D.hh.

                                      :
      JVector2D(pos)
    {}

◆ JPosition2D() [3/5]

JGEOMETRY2D::JPosition2D::JPosition2D ( const JAngle2D & angle )

inline

Constructor.

Parameters

angle angle

Definition at line 64 of file JPosition2D.hh.

                                       :
      JVector2D(angle.getDX(),
                angle.getDY())
    {}

◆ JPosition2D() [4/5]

JGEOMETRY2D::JPosition2D::JPosition2D ( const JVersor2D & dir )

inline

Constructor.

Parameters

dir direction

Definition at line 75 of file JPosition2D.hh.

                                      :
      JVector2D(dir.getDX(),
                dir.getDY())
    {}

◆ JPosition2D() [5/5]

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

inline

Constructor.

Parameters

x	x value
y	y value

Definition at line 87 of file JPosition2D.hh.

                                :
      JVector2D(x,y)
    {}

Member Function Documentation

◆ getPosition() [1/2]

const JPosition2D & JGEOMETRY2D::JPosition2D::getPosition ( ) const

inline

Get position.

Returns: position

Definition at line 98 of file JPosition2D.hh.

    {
      return static_cast<const JPosition2D&>(*this);
    }

◆ getPosition() [2/2]

JPosition2D & JGEOMETRY2D::JPosition2D::getPosition ( )

inline

Get position.

Returns: position

Definition at line 109 of file JPosition2D.hh.

    {
      return static_cast<JPosition2D&>(*this);
    }

◆ setPosition()

void JGEOMETRY2D::JPosition2D::setPosition ( const JVector2D & pos )

inline

Set position.

Parameters

pos position

Definition at line 120 of file JPosition2D.hh.

    {
      static_cast<JVector2D&>(*this) = pos;
    }

◆ operator JAngle2D()

JGEOMETRY2D::JPosition2D::operator JAngle2D ( ) const

inline

Type conversion operator.

Returns: angle

Definition at line 131 of file JPosition2D.hh.

    {
      return JAngle2D(getX(), getY());
    }

◆ operator JVersor2D()

JGEOMETRY2D::JPosition2D::operator JVersor2D ( ) const

inline

Type conversion operator.

Returns: direction

Definition at line 142 of file JPosition2D.hh.

    {
      return JVersor2D(getX(), getY());
    }

◆ rotate()

JPosition2D & JGEOMETRY2D::JPosition2D::rotate ( const JRotation2D & R )

inline

Rotate.

Parameters

R	rotation matrix

Returns: this position

Definition at line 154 of file JPosition2D.hh.

    {
      R.rotate(__x, __y);
 
      return *this;
    }

◆ rotate_back()

JPosition2D & JGEOMETRY2D::JPosition2D::rotate_back ( const JRotation2D & R )

inline

Rotate back.

Parameters

R	rotation matrix

Returns: this position

Definition at line 168 of file JPosition2D.hh.

    {
      R.rotate_back(__x, __y);
 
      return *this;
    }

◆ getDot() [1/3]

double JGEOMETRY2D::JPosition2D::getDot ( const JAngle2D & angle ) const

inline

Get dot product.

Parameters

angle angle

Returns: dot product

Definition at line 182 of file JPosition2D.hh.

    {
      return
        getX() * angle.getDX() +
        getY() * angle.getDY();
    }

◆ getDot() [2/3]

double JGEOMETRY2D::JPosition2D::getDot ( const JVersor2D & versor ) const

inline

Get dot product.

Parameters

versor versor

Returns: dot product

Definition at line 196 of file JPosition2D.hh.

    {
      return
        getX() * versor.getDX() +
        getY() * versor.getDY();
    }

◆ getPerpDot() [1/3]

double JGEOMETRY2D::JPosition2D::getPerpDot ( const JAngle2D & angle ) const

inline

Get perpendicular dot product.

Parameters

angle angle

Returns: perpendicular dot product

Definition at line 210 of file JPosition2D.hh.

    {
      return
        getX() * angle.getDY() -
        getY() * angle.getDX();
    }

◆ getPerpDot() [2/3]

double JGEOMETRY2D::JPosition2D::getPerpDot ( const JVersor2D & dir ) const

inline

Get perpendicular dot product.

Parameters

dir direction

Returns: perpendicular dot product

Definition at line 224 of file JPosition2D.hh.

    {
      return
        getX() * dir.getDY() -
        getY() * dir.getDX();
    }

◆ getDot() [3/3]

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() [3/3]

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();
    }

◆ 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;
    }

◆ getX()

double JGEOMETRY2D::JVector2D::getX ( ) const

inlineinherited

Get x position.

Returns: x position

Definition at line 63 of file JVector2D.hh.

    { 
      return __x;
    }

◆ getY()

double JGEOMETRY2D::JVector2D::getY ( ) const

inlineinherited

Get y position.

Returns: y position

Definition at line 74 of file JVector2D.hh.

    { 
      return __y;
    }

◆ negate()

JVector2D & JGEOMETRY2D::JVector2D::negate ( )

inlineinherited

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 )

inlineinherited

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 )

inlineinherited

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 )

inlineinherited

Scale vector.

Parameters

factor multiplication factor

Returns: this vector

Definition at line 130 of file JVector2D.hh.

    {
      __x *= factor;
      __y *= factor;
 
      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);
    }

◆ div()

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

inlineinherited

Scale vector.

Parameters

factor division factor

Returns: this vector

Definition at line 145 of file JVector2D.hh.

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

◆ equals()

bool JGEOMETRY2D::JVector2D::equals	(	const JVector2D &	vector,
		const double	precision = std::numeric_limits<double>::min() ) const

inlineinherited

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

inlineinherited

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

inlineinherited

Get length.

Returns: length

Definition at line 199 of file JVector2D.hh.

    { 
      return sqrt(getLengthSquared());
    }

◆ getDistanceSquared()

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

inlineinherited

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

inlineinherited

Get distance to point.

Parameters

point point

Returns: distance

Definition at line 223 of file JVector2D.hh.

    {
      return sqrt(getDistanceSquared(point));
    }

Friends And Related Symbol Documentation

◆ operator>> [1/2]

std::istream & operator>>	(	std::istream &	in,
		JPosition2D &	position )

friend

Read position from input.

Parameters

in	input stream
position	position

Returns: input stream

Definition at line 239 of file JPosition2D.hh.

    {
      in >> position.__x >> position.__y;
 
      return in;
    }

◆ operator<< [1/2]

std::ostream & operator<<	(	std::ostream &	out,
		const JPosition2D &	position )

friend

Write position to output.

Parameters

out	output stream
position	position

Returns: output stream

Definition at line 254 of file JPosition2D.hh.

    {
      const JFormat format(out, getFormat<JPosition2D>(JFormat_t(9, 3, std::ios::fixed | std::ios::showpos)));
 
      out << format << position.getX() << ' ' 
          << format << position.getY();
 
      return out;
    }

◆ operator>> [2/2]

JReader & operator>>	(	JReader &	in,
		JPosition2D &	position )

friend

Read position from input.

Parameters

in	reader
position	position

Returns: reader

Definition at line 272 of file JPosition2D.hh.

    {
      in >> position.__x;
      in >> position.__y;
 
      return in;
    }

◆ operator<< [2/2]

JWriter & operator<<	(	JWriter &	out,
		const JPosition2D &	position )

friend

Write position to output.

Parameters

out	writer
position	position

Returns: writer

Definition at line 288 of file JPosition2D.hh.

    {
      out << position.__x;
      out << position.__y;
 
      return out;
    }

Member Data Documentation

◆ __x

double JGEOMETRY2D::JVector2D::__x

protectedinherited

Definition at line 257 of file JVector2D.hh.

◆ __y

double JGEOMETRY2D::JVector2D::__y

protectedinherited

Definition at line 258 of file JVector2D.hh.

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

JPosition2D.hh

Public Member Functions

Protected Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

◆ JPosition2D() [1/5]

◆ JPosition2D() [2/5]

◆ JPosition2D() [3/5]

◆ JPosition2D() [4/5]

◆ JPosition2D() [5/5]

Member Function Documentation

◆ getPosition() [1/2]

◆ getPosition() [2/2]

◆ setPosition()

◆ operator JAngle2D()

◆ operator JVersor2D()

◆ rotate()

◆ rotate_back()

◆ getDot() [1/3]

◆ getDot() [2/3]

◆ getPerpDot() [1/3]

◆ getPerpDot() [2/3]

◆ getDot() [3/3]

◆ getPerpDot() [3/3]

◆ transform()

◆ getX()

◆ getY()

◆ negate()

◆ add()

◆ sub()

◆ mul() [1/2]

◆ mul() [2/2]

◆ div()

◆ equals()

◆ getLengthSquared()

◆ getLength()

◆ getDistanceSquared()

◆ getDistance()

Friends And Related Symbol Documentation

◆ operator>> [1/2]

◆ operator<< [1/2]

◆ operator>> [2/2]

◆ operator<< [2/2]

Member Data Documentation

◆ __x

◆ __y