JGEOMETRY2D::JAxis2D Class Reference

Axis object. More...

#include <JAxis2D.hh>

Inheritance diagram for JGEOMETRY2D::JAxis2D:

Public Member Functions
	JAxis2D ()
	Default constructor.
	JAxis2D (const JVector2D &pos)
	Constructor.
	JAxis2D (const JVector2D &pos, const JVersor2D &dir)
	Constructor.
	JAxis2D (const JSegment2D &segment)
	Constructor.
const JAxis2D &	getAxis () const
	Get axis.
void	setAxis (const JAxis2D &axis)
	Set axis.
JAxis2D &	negate ()
	Negate axis.
void	move (const double step)
	Move vertex along this axis.
bool	intersects (const JSegment2D &segment) const
	Test whether this axis and given line segment intersect.
double	getIntersection (const JAxis2D &axis, const double precision=1.0e-8) const
	Get intersection of two axes.
double	getDistanceSquared (const JVector2D &point) const
	Get squared of distance to point.
double	getDistance (const JVector2D &point) const
	Get distance to point.
JAxis2D &	rotate (const JRotation2D &R)
	Rotate axis.
JAxis2D &	rotate_back (const JRotation2D &R)
	Rotate back axis.
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.
double	getDot (const JAngle2D &angle) const
	Get dot product.
double	getDot (const JVersor2D &versor) const
	Get dot product.
double	getDot (const JVector2D &point) 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	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 &	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.
const JDirection2D &	getDirection () const
	Get direction.
JDirection2D &	getDirection ()
	Get direction.
void	setDirection (const JDirection2D &dir)
	Set direction.
	operator JAngle2D () const
	Type conversion operator.
	operator JVector2D () const
	Type conversion operator.
JDirection2D &	transform (const JMatrix2D &T)
	Transform.
double	getDot (const JAngle2D &angle) const
	Get dot product.
double	getDot (const JVector2D &pos) 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 JVector2D &pos) const
	Get perpendicular dot product.
double	getPerpDot (const JVersor2D &versor) const
	Get perpendicular dot product.
double	getDX () const
	Get x direction.
double	getDY () const
	Get y direction.
double	getPhi () const
	Get phi angle.
bool	equals (const JVersor2D &versor, const double precision=std::numeric_limits< double >::min()) const
	Check equality.
JVersor2D &	normalise ()
	Normalise versor.

Protected Attributes
double	__x
double	__y
double	__dx
double	__dy

Friends
std::istream &	operator>> (std::istream &in, JAxis2D &axis)
	Read axis from input.
std::ostream &	operator<< (std::ostream &out, const JAxis2D &axis)
	Write axis to output.
JReader &	operator>> (JReader &in, JAxis2D &axis)
	Read axis from input.
JWriter &	operator<< (JWriter &out, const JAxis2D &axis)
	Write axis to output.

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

JAxis2D() [1/4]

JGEOMETRY2D::JAxis2D::JAxis2D ( )

inline

Default constructor.

Definition at line 40 of file JAxis2D.hh.

              :
      JPosition2D (),
      JDirection2D()
    {}

JAxis2D() [2/4]

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

inline

Constructor.

Parameters

pos

position

Definition at line 51 of file JAxis2D.hh.

                                  :
      JPosition2D (pos), 
      JDirection2D()
    {}

JAxis2D() [3/4]

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

JAxis2D() [4/4]

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

getAxis()

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

inline

Get axis.

Returns

axis

Definition at line 86 of file JAxis2D.hh.

    { 
      return *this; 
    }

setAxis()

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

inline

Set axis.

Parameters

axis

axis

Definition at line 97 of file JAxis2D.hh.

    { 
      *this = axis; 
    }

negate()

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

move()

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

intersects()

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

getIntersection()

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

getDistanceSquared()

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

getDistance()

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

rotate()

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

rotate_back()

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

getPosition() [1/2]

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

getPosition() [2/2]

JPosition2D & JGEOMETRY2D::JPosition2D::getPosition ( )

inlineinherited

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 )

inlineinherited

Set position.

Parameters

pos

position

Definition at line 120 of file JPosition2D.hh.

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

operator JAngle2D() [1/2]

JGEOMETRY2D::JPosition2D::operator JAngle2D ( ) const

inlineinherited

Type conversion operator.

Returns

angle

Definition at line 131 of file JPosition2D.hh.

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

operator JVersor2D()

JGEOMETRY2D::JPosition2D::operator JVersor2D ( ) const

inlineinherited

Type conversion operator.

Returns

direction

Definition at line 142 of file JPosition2D.hh.

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

getDot() [1/6]

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

getDot() [2/6]

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

getDot() [3/6]

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

getPerpDot() [1/6]

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

getPerpDot() [2/6]

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

getPerpDot() [3/6]

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

transform() [1/2]

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

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

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

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

getDirection() [1/2]

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

getDirection() [2/2]

JDirection2D & JGEOMETRY2D::JDirection2D::getDirection ( )

inlineinherited

Get direction.

Returns

direction

Definition at line 106 of file JDirection2D.hh.

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

setDirection()

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

operator JAngle2D() [2/2]

JGEOMETRY2D::JDirection2D::operator JAngle2D ( ) const

inlineinherited

Type conversion operator.

Returns

angle

Definition at line 128 of file JDirection2D.hh.

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

operator JVector2D()

JGEOMETRY2D::JDirection2D::operator JVector2D ( ) const

inlineinherited

Type conversion operator.

Returns

position

Definition at line 139 of file JDirection2D.hh.

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

transform() [2/2]

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

getDot() [4/6]

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

getDot() [5/6]

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

getDot() [6/6]

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

getPerpDot() [4/6]

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

getPerpDot() [5/6]

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

getPerpDot() [6/6]

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

getDX()

double JGEOMETRY2D::JVersor2D::getDX ( ) const

inlineinherited

Get x direction.

Returns

x direction

Definition at line 53 of file JVersor2D.hh.

    {
      return __dx;
    }

getDY()

double JGEOMETRY2D::JVersor2D::getDY ( ) const

inlineinherited

Get y direction.

Returns

y direction

Definition at line 64 of file JVersor2D.hh.

    {
      return __dy;
    }

getPhi()

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

equals() [2/2]

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

normalise()

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 Symbol Documentation

operator>> [1/2]

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

operator<< [1/2]

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

operator>> [2/2]

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

operator<< [2/2]

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

__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.

__dx

double JGEOMETRY2D::JVersor2D::__dx

protectedinherited

Definition at line 160 of file JVersor2D.hh.

__dy

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