Axis object. More...

#include <JAxis2D.hh>

Inheritance diagram for JGEOMETRY2D::JAxis2D:

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

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

	JAxis2D (const JVector2D &pos, const JVersor2D &dir)
	Constructor. More...

	JAxis2D (const JSegment2D &segment)
	Constructor. More...

const JAxis2D &	getAxis () const
	Get axis. More...

void	setAxis (const JAxis2D &axis)
	Set axis. More...

JAxis2D &	negate ()
	Negate axis. More...

void	move (const double step)
	Move vertex along this axis. More...

bool	intersects (const JSegment2D &segment) const
	Test whether this axis and given line segment intersect. More...

double	getIntersection (const JAxis2D &axis, const double precision=1.0e-8) const
	Get intersection of two axes. 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...

JAxis2D &	rotate (const JRotation2D &R)
	Rotate axis. More...

JAxis2D &	rotate_back (const JRotation2D &R)
	Rotate back axis. 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...

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

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

double	getDot (const JVector2D &point) 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	getPerpDot (const JVector2D &point) const
	Get perpendicular dot product. More...

double	getX () const
	Get x position. More...

double	getY () const
	Get y position. 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...

JFirst_t &	mul (const JSecond_t &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 double precision=std::numeric_limits< double >::min()) const
	Check equality. More...

double	getLengthSquared () const
	Get length squared. More...

double	getLength () const
	Get length. More...

const JDirection2D &	getDirection () const
	Get direction. More...

JDirection2D &	getDirection ()
	Get direction. More...

void	setDirection (const JDirection2D &dir)
	Set direction. More...

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

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

JDirection2D &	transform (const JMatrix2D &T)
	Transform. More...

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

double	getDot (const JVector2D &pos) 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 JVector2D &pos) const
	Get perpendicular dot product. More...

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

double	getDX () const
	Get x direction. More...

double	getDY () const
	Get y direction. More...

double	getPhi () const
	Get phi angle. More...

bool	equals (const JVersor2D &versor, const double precision=std::numeric_limits< double >::min()) const
	Check equality. More...

JVersor2D &	normalise ()
	Normalise versor. More...

Protected Attributes
double	__x

double	__y

double	__dx

double	__dy

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

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

JReader &	operator>> (JReader &in, JAxis2D &axis)
	Read axis from input. More...

JWriter &	operator<< (JWriter &out, const JAxis2D &axis)
	Write axis to output. More...

Detailed Description

Axis object.

An axis object consists of a position and a direction.

Definition at line 32 of file JAxis2D.hh.

Constructor & Destructor Documentation

JGEOMETRY2D::JAxis2D::JAxis2D ( )

inline

Default constructor.

Definition at line 40 of file JAxis2D.hh.

               :
       JPosition2D (),
       JDirection2D()
     {}

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

inline

Constructor.

Parameters

pos position

Definition at line 51 of file JAxis2D.hh.

                                   :
       JPosition2D (pos), 
       JDirection2D()
     {}

JGEOMETRY2D::JAxis2D::JAxis2D	(	const JVector2D &	pos,
		const JVersor2D &	dir
	)

inline

Constructor.

Parameters

pos	position
dir	direction

Definition at line 63 of file JAxis2D.hh.

                                   :
       JPosition2D (pos), 
       JDirection2D(dir)
     {}

JGEOMETRY2D::JAxis2D::JAxis2D ( const JSegment2D & segment )

inline

Constructor.

Parameters

segment line segment

Definition at line 75 of file JAxis2D.hh.

                                        :
       JPosition2D (segment.first),
       JDirection2D(segment.second - segment.first)
     {}

Member Function Documentation

const JAxis2D& JGEOMETRY2D::JAxis2D::getAxis ( ) const

inline

Get axis.

Returns: axis

Definition at line 86 of file JAxis2D.hh.

     { 
       return *this; 
     }

void JGEOMETRY2D::JAxis2D::setAxis ( const JAxis2D & axis )

inline

Set axis.

Parameters

axis axis

Definition at line 97 of file JAxis2D.hh.

     { 
       *this = axis; 
     }

JAxis2D& JGEOMETRY2D::JAxis2D::negate ( )

inline

Negate axis.

Returns: this axis

Definition at line 108 of file JAxis2D.hh.

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

void JGEOMETRY2D::JAxis2D::move ( const double step )

inline

Move vertex along this axis.

Parameters

step step

Definition at line 122 of file JAxis2D.hh.

     {
       getPosition() += step * JVector2D(getDirection());    
     }

bool JGEOMETRY2D::JAxis2D::intersects ( const JSegment2D & segment ) const

inline

Test whether this axis and given line segment intersect.

Parameters

segment line segment

Returns: true if axis and line segment intersect; else false

Definition at line 134 of file JAxis2D.hh.

     {
       if (getCCW(segment.first, this->getPosition(), segment.second)) 
         return (this->getDirection().getPerpDot(segment.first  - this->getPosition()) > 0.0 && 
                 this->getDirection().getPerpDot(segment.second - this->getPosition()) < 0.0);
       else
         return (this->getDirection().getPerpDot(segment.first  - this->getPosition()) < 0.0 && 
                 this->getDirection().getPerpDot(segment.second - this->getPosition()) > 0.0);
     }

double JGEOMETRY2D::JAxis2D::getIntersection	(	const JAxis2D &	axis,
		const double	precision = `1.0e-8`
	)		const

inline

Get intersection of two axes.

Parameters

axis	axis
precision	precision

Returns: longitudinal position

Definition at line 152 of file JAxis2D.hh.

     {
       const double gp = this->getDirection().getPerpDot(axis.getDirection());
 
       if (fabs(gp) > precision)
         return axis.getDirection().getPerpDot(this->getPosition() - axis.getPosition()) / gp;
       else
         return this->getDistance(axis.getPosition());
     }

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

inline

Get squared of distance to point.

Parameters

point point

Returns: square of distance

Definition at line 169 of file JAxis2D.hh.

     {
       JVector2D D(this->getDirection());
 
       const JVector2D U(point - this->getPosition());
 
       const double u = D.getDot(U);
 
       D.mul(u);
       D.sub(U);
 
       return D.getLengthSquared();
     }

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

inline

Get distance to point.

Parameters

point point

Returns: distance

Definition at line 190 of file JAxis2D.hh.

     {
       return sqrt(getDistanceSquared(point));
     }

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

inline

Rotate axis.

Parameters

R	rotation matrix

Returns: this axis

Definition at line 202 of file JAxis2D.hh.

     {
       static_cast<JPosition2D&> (*this).rotate(R);
       static_cast<JDirection2D&>(*this).rotate(R);
 
       return *this;
     }

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

inline

Rotate back axis.

Parameters

R	rotation matrix

Returns: this axis

Definition at line 217 of file JAxis2D.hh.

     {
       static_cast<JPosition2D&> (*this).rotate_back(R);
       static_cast<JDirection2D&>(*this).rotate_back(R);
 
       return *this;
     }

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

inlineinherited

Get position.

Returns: position

Definition at line 98 of file JPosition2D.hh.

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

JPosition2D& JGEOMETRY2D::JPosition2D::getPosition ( )

inlineinherited

Get position.

Returns: position

Definition at line 109 of file JPosition2D.hh.

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

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

inlineinherited

Set position.

Parameters

pos position

Definition at line 120 of file JPosition2D.hh.

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

JGEOMETRY2D::JPosition2D::operator JAngle2D ( ) const

inlineinherited

Type conversion operator.

Returns: angle

Definition at line 131 of file JPosition2D.hh.

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

JGEOMETRY2D::JPosition2D::operator JVersor2D ( ) const

inlineinherited

Type conversion operator.

Returns: direction

Definition at line 142 of file JPosition2D.hh.

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

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

inlineinherited

Get dot product.

Parameters

angle angle

Returns: dot product

Definition at line 182 of file JPosition2D.hh.

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

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

inlineinherited

Get dot product.

Parameters

versor versor

Returns: dot product

Definition at line 196 of file JPosition2D.hh.

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

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

inlineinherited

Get dot product.

Parameters

point vector

Returns: dot product

Definition at line 235 of file JVector2D.hh.

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

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

inlineinherited

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

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

inlineinherited

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

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

inlineinherited

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

double JGEOMETRY2D::JVector2D::getX ( ) const

inlineinherited

Get x position.

Returns: x position

Definition at line 63 of file JVector2D.hh.

     { 
       return __x;
     }

double JGEOMETRY2D::JVector2D::getY ( ) const

inlineinherited

Get y position.

Returns: y position

Definition at line 74 of file JVector2D.hh.

     { 
       return __y;
     }

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

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

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

template<class JFirst_t, class JSecond_t = JNullType>

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

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

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

inlineinherited

Transform.

Parameters

T matrix

Returns: this vector

Definition at line 160 of file JVector2D.hh.

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

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

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

double JGEOMETRY2D::JVector2D::getLength ( ) const

inlineinherited

Get length.

Returns: length

Definition at line 199 of file JVector2D.hh.

     { 
       return sqrt(getLengthSquared());
     }

const JDirection2D& JGEOMETRY2D::JDirection2D::getDirection ( ) const

inlineinherited

Get direction.

Returns: direction

Definition at line 95 of file JDirection2D.hh.

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

JDirection2D& JGEOMETRY2D::JDirection2D::getDirection ( )

inlineinherited

Get direction.

Returns: direction

Definition at line 106 of file JDirection2D.hh.

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

void JGEOMETRY2D::JDirection2D::setDirection ( const JDirection2D & dir )

inlineinherited

Set direction.

Parameters

dir direction

Definition at line 117 of file JDirection2D.hh.

     {
       static_cast<JDirection2D&>(*this) = dir;
     }

JGEOMETRY2D::JDirection2D::operator JAngle2D ( ) const

inlineinherited

Type conversion operator.

Returns: angle

Definition at line 128 of file JDirection2D.hh.

     {
       return JAngle2D(getDX(), getDY());
     }

JGEOMETRY2D::JDirection2D::operator JVector2D ( ) const

inlineinherited

Type conversion operator.

Returns: position

Definition at line 139 of file JDirection2D.hh.

     {
       return JVector2D(getDX(), getDY());
     }

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

inlineinherited

Transform.

Parameters

T matrix

Returns: this direction

Definition at line 151 of file JDirection2D.hh.

     {
       T.transform(__dx, __dy);
 
       normalise();
 
       return *this;
     }

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

inlineinherited

Get dot product.

Parameters

angle angle

Returns: dot product

Definition at line 199 of file JDirection2D.hh.

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

double JGEOMETRY2D::JDirection2D::getDot ( const JVector2D & pos ) const

inlineinherited

Get dot product.

Parameters

pos position

Returns: dot product

Definition at line 213 of file JDirection2D.hh.

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

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

inlineinherited

Get dot product.

Parameters

versor versor

Returns: dot product

Definition at line 116 of file JVersor2D.hh.

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

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

inlineinherited

Get perpendicular dot product.

Parameters

angle angle

Returns: perpendicular dot product

Definition at line 227 of file JDirection2D.hh.

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

double JGEOMETRY2D::JDirection2D::getPerpDot ( const JVector2D & pos ) const

inlineinherited

Get perpendicular dot product.

Parameters

pos position

Returns: perpendicular dot product

Definition at line 241 of file JDirection2D.hh.

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

double JGEOMETRY2D::JVersor2D::getPerpDot ( const JVersor2D & versor ) const

inlineinherited

Get perpendicular dot product.

Parameters

versor versor

Returns: perpendicular dot product

Definition at line 130 of file JVersor2D.hh.

     {
       return
         getDX() * versor.getDY() - 
         getDY() * versor.getDX();
     }

double JGEOMETRY2D::JVersor2D::getDX ( ) const

inlineinherited

Get x direction.

Returns: x direction

Definition at line 53 of file JVersor2D.hh.

     {
       return __dx;
     }

double JGEOMETRY2D::JVersor2D::getDY ( ) const

inlineinherited

Get y direction.

Returns: y direction

Definition at line 64 of file JVersor2D.hh.

     {
       return __dy;
     }

double JGEOMETRY2D::JVersor2D::getPhi ( ) const

inlineinherited

Get phi angle.

Returns: phi angle [rad]

Definition at line 75 of file JVersor2D.hh.

     { 
       return atan2(__dy, __dx);
     }

bool JGEOMETRY2D::JVersor2D::equals	(	const JVersor2D &	versor,
		const double	precision = `std::numeric_limits<double>::min()`
	)		const

inlineinherited

Check equality.

Parameters

versor	versor
precision	precision

Returns: true if versors are equal; else false

Definition at line 102 of file JVersor2D.hh.

     {
       return (fabs(getDX() - versor.getDX()) <= precision &&
               fabs(getDY() - versor.getDY()) <= precision);
     }

JVersor2D& JGEOMETRY2D::JVersor2D::normalise ( )

inlineinherited

Normalise versor.

This operation may set the result to the unit y-vector.

Returns: this versor

Definition at line 144 of file JVersor2D.hh.

     {
       const double v = sqrt(getDX()*getDX() + getDY()*getDY());
 
       if (v != 0.0) {
         __dx /= v;
         __dy /= v;
       } else {
         __dx = 0.0;
         __dy = 1.0;
       }
 
       return *this;
     }

Friends And Related Function Documentation

std::istream& operator>>	(	std::istream &	in,
		JAxis2D &	axis
	)

friend

Read axis from input.

Parameters

in	input stream
axis	axis

Returns: input stream

Definition at line 233 of file JAxis2D.hh.

     {
       in >> static_cast<JPosition2D&> (axis);
       in >> static_cast<JDirection2D&>(axis);
 
       return in;
     }

std::ostream& operator<<	(	std::ostream &	out,
		const JAxis2D &	axis
	)

friend

Write axis to output.

Parameters

out	output stream
axis	axis

Returns: output stream

Definition at line 249 of file JAxis2D.hh.

     {
       out << static_cast<const JPosition2D&> (axis);
       out << ' ';
       out << static_cast<const JDirection2D&>(axis);
 
       return out;
     }

JReader& operator>>	(	JReader &	in,
		JAxis2D &	axis
	)

friend

Read axis from input.

Parameters

in	reader
axis	axis

Returns: reader

Definition at line 266 of file JAxis2D.hh.

     {
       in >> static_cast<JPosition2D&> (axis);
       in >> static_cast<JDirection2D&>(axis);
 
       return in;
     }

JWriter& operator<<	(	JWriter &	out,
		const JAxis2D &	axis
	)

friend

Write axis to output.

Parameters

out	writer
axis	axis

Returns: writer

Definition at line 282 of file JAxis2D.hh.

     {
       out << static_cast<const JPosition2D&> (axis);
       out << static_cast<const JDirection2D&>(axis);
 
       return out;
     }

Member Data Documentation

double JGEOMETRY2D::JVector2D::__x

protectedinherited

Definition at line 257 of file JVector2D.hh.

double JGEOMETRY2D::JVector2D::__y

protectedinherited

Definition at line 258 of file JVector2D.hh.

double JGEOMETRY2D::JVersor2D::__dx

protectedinherited

Definition at line 160 of file JVersor2D.hh.

double JGEOMETRY2D::JVersor2D::__dy

protectedinherited

Definition at line 161 of file JVersor2D.hh.

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

JAxis2D.hh

Public Member Functions

Protected Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation