JGEOMETRY3D::JSegment3D Class Reference

Line segment in two dimensions. More...

#include <JSegment3D.hh>

Inheritance diagram for JGEOMETRY3D::JSegment3D:

Public Member Functions
	JSegment3D ()
	Default constructor. More...
	JSegment3D (const JVector3D &A, const JVector3D &B)
	Constructor. More...
double	getLengthSquared () const
	Get length squared. More...
double	getLength () const
	Get length. More...
double	getDistanceSquared (const JVector3D &point, const double precision=1.0e-8) const
	Get squared of distance to point. More...
double	getDistance (const JVector3D &point) const
	Get distance to point. More...
double	getDot (const JSegment3D &segment) const
	Get dot product. More...

Friends
JReader &	operator>> (JReader &in, JSegment3D &segment)
	Read segment from input. More...
JWriter &	operator<< (JWriter &out, const JSegment3D &segment)
	Write segment to output. More...

Detailed Description

Line segment in two dimensions.

Definition at line 33 of file JSegment3D.hh.

Constructor & Destructor Documentation

JGEOMETRY3D::JSegment3D::JSegment3D ( )

inline

Default constructor.

Definition at line 40 of file JSegment3D.hh.

                 :
      JSegment3D_t()
    {}

JGEOMETRY3D::JSegment3D::JSegment3D ( const JVector3D &  A, const JVector3D &  B  )

inline

Constructor.

Parameters

A	start position
B	end position

Definition at line 51 of file JSegment3D.hh.

                                   :
      JSegment3D_t(A,B)
    {}

Member Function Documentation

double JGEOMETRY3D::JSegment3D::getLengthSquared ( ) const

inline

Get length squared.

Returns

square of length

Definition at line 62 of file JSegment3D.hh.

    {
      return JVector3D(this->second - this->first).getLengthSquared();
    }

double JGEOMETRY3D::JSegment3D::getLength ( ) const

inline

Get length.

Returns

length

Definition at line 73 of file JSegment3D.hh.

    {
      return sqrt(getLengthSquared());
    }

double JGEOMETRY3D::JSegment3D::getDistanceSquared ( const JVector3D &  point, const double  precision = 1.0e-8  ) const

inline

Get squared of distance to point.

Parameters

point	point
precision	precision

Returns

square of distance

Definition at line 86 of file JSegment3D.hh.

    {
      JVector3D D(this->second - this->first);

      const double gp = D.getLengthSquared();

      if (gp > precision) {

        const JVector3D U(point - this->first);

        double u = D.getDot(U);

        if      (u < 0.0)
          u  = 0.0;
        else if (u > gp)
          u  = 1.0;
        else
          u /= gp;

        D.mul(u);
        D.sub(U);

        return D.getLengthSquared();

      } else {

        return this->first.getDistanceSquared(point);
      }
    }

double JGEOMETRY3D::JSegment3D::getDistance ( const JVector3D &  point ) const

inline

Get distance to point.

Parameters

point

point

Returns

distance

Definition at line 123 of file JSegment3D.hh.

    {
      return sqrt(getDistanceSquared(point));
    }

double JGEOMETRY3D::JSegment3D::getDot ( const JSegment3D &  segment ) const

inline

Get dot product.

Parameters

segment

segment

Returns

dot product

Definition at line 135 of file JSegment3D.hh.

    {
      return JVector3D(this->second - this->first).getDot(segment.second - segment.first);
    }

Friends And Related Function Documentation

JReader& operator>> ( JReader &  in, JSegment3D &  segment  )

friend

Read segment from input.

Parameters

in	reader
segment	segment

Returns

reader

Definition at line 148 of file JSegment3D.hh.

    {
      in >> segment.first;
      in >> segment.second;

      return in;
    }

JWriter& operator<< ( JWriter &  out, const JSegment3D &  segment  )

friend

Write segment to output.

Parameters

out	writer
segment	segment

Returns

writer

Definition at line 164 of file JSegment3D.hh.

    {
      out << segment.first;
      out << segment.second;

      return out;
    }

---

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

• JSegment3D.hh