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

#include <JPosition2D.hh>

Inheritance diagram for JGEOMETRY2D::JPosition2D:

Public Member Functions
	JPosition2D ()
	Default constructor. More...

	JPosition2D (const JVector2D &pos)
	Constructor. More...

	JPosition2D (const JAngle2D &angle)
	Constructor. More...

	JPosition2D (const JVersor2D &dir)
	Constructor. More...

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

const JPosition2D &	getPosition () const
	Get position. More...

JPosition2D &	getPosition ()
	Get position. More...

void	setPosition (const JVector2D &pos)
	Set position. More...

	operator JAngle2D () const
	Type conversion operator. More...

	operator JVersor2D () const
	Type conversion operator. More...

JPosition2D &	rotate (const JRotation2D &R)
	Rotate. More...

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

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

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

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

double	getPerpDot (const JVersor2D &dir) const
	Get perpendicular dot product. 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 &	mul (const JNullType &object)
	Multiply with object. 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...

Protected Attributes
double	__x

double	__y

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

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

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

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

Detailed Description

Data structure for position in two dimensions.

Definition at line 30 of file JPosition2D.hh.

Constructor & Destructor Documentation

JGEOMETRY2D::JPosition2D::JPosition2D ( )

inline

Default constructor.

Definition at line 43 of file JPosition2D.hh.

                   :
       JVector2D()
     {}

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

inline

Constructor.

Parameters

pos position

Definition at line 53 of file JPosition2D.hh.

                                       :
       JVector2D(pos)
     {}

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

inline

Constructor.

Parameters

angle angle

Definition at line 63 of file JPosition2D.hh.

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

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

inline

Constructor.

Parameters

dir direction

Definition at line 74 of file JPosition2D.hh.

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

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

inline

Constructor.

Parameters

x	x value
y	y value

Definition at line 86 of file JPosition2D.hh.

                                 :
       JVector2D(x,y)
     {}

Member Function Documentation

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

inline

Get position.

Returns: position

Definition at line 97 of file JPosition2D.hh.

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

JPosition2D& JGEOMETRY2D::JPosition2D::getPosition ( )

inline

Get position.

Returns: position

Definition at line 108 of file JPosition2D.hh.

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

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

inline

Set position.

Parameters

pos position

Definition at line 119 of file JPosition2D.hh.

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

JGEOMETRY2D::JPosition2D::operator JAngle2D ( ) const

inline

Type conversion operator.

Returns: angle

Definition at line 130 of file JPosition2D.hh.

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

JGEOMETRY2D::JPosition2D::operator JVersor2D ( ) const

inline

Type conversion operator.

Returns: direction

Definition at line 141 of file JPosition2D.hh.

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

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

inline

Rotate.

Parameters

R	rotation matrix

Returns: this position

Definition at line 153 of file JPosition2D.hh.

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

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

inline

Rotate back.

Parameters

R	rotation matrix

Returns: this position

Definition at line 167 of file JPosition2D.hh.

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

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

inline

Get dot product.

Parameters

angle angle

Returns: dot product

Definition at line 181 of file JPosition2D.hh.

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

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

inline

Get dot product.

Parameters

versor versor

Returns: dot product

Definition at line 195 of file JPosition2D.hh.

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

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

inline

Get perpendicular dot product.

Parameters

angle angle

Returns: perpendicular dot product

Definition at line 209 of file JPosition2D.hh.

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

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

inline

Get perpendicular dot product.

Parameters

dir direction

Returns: perpendicular dot product

Definition at line 223 of file JPosition2D.hh.

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

double JGEOMETRY2D::JVector2D::getX ( ) const

inlineinherited

Get x position.

Returns: x position

Definition at line 61 of file JVector2D.hh.

     { 
       return __x;
     }

double JGEOMETRY2D::JVector2D::getY ( ) const

inlineinherited

Get y position.

Returns: y position

Definition at line 72 of file JVector2D.hh.

     { 
       return __y;
     }

JVector2D& JGEOMETRY2D::JVector2D::negate ( )

inlineinherited

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 )

inlineinherited

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 )

inlineinherited

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 )

inlineinherited

Scale vector.

Parameters

factor multiplication factor

Returns: this vector

Definition at line 128 of file JVector2D.hh.

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

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

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

inlineinherited

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 )

inlineinherited

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

inlineinherited

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

inlineinherited

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

inlineinherited

Get length.

Returns: length

Definition at line 195 of file JVector2D.hh.

     { 
       return sqrt(getLengthSquared());
     }

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

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

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

inlineinherited

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

inlineinherited

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

inlineinherited

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

Friends And Related Function Documentation

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 238 of file JPosition2D.hh.

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

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 253 of file JPosition2D.hh.

     {
       out << position.getX() << ' ' << position.getY();
 
       return out;
     }

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

friend

Read position from input.

Parameters

in	reader
position	position

Returns: reader

Definition at line 268 of file JPosition2D.hh.

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

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

friend

Write position to output.

Parameters

out	writer
position	position

Returns: writer

Definition at line 284 of file JPosition2D.hh.

     {
       out << position.getX();
       out << position.getY();
 
       return out;
     }

Member Data Documentation

double JGEOMETRY2D::JVector2D::__x

protectedinherited

Definition at line 253 of file JVector2D.hh.

double JGEOMETRY2D::JVector2D::__y

protectedinherited

Definition at line 254 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

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation