Heed::circumf Class Reference

Circumference, determined by point (center), normal vector, and radius. More...

#include <circumf.h>

Inheritance diagram for Heed::circumf:

Public Member Functions
	circumf ()
	Default constructor.
	circumf (const point &fpiv, const vec &fdir, vfloat frad)
	Constructor.
	circumf (const circumf &f)
circumf &	operator= (const circumf &f)
virtual	~circumf ()
	Destructor.
point	Gpiv () const
vec	Gdir () const
vfloat	Grad () const
int	check_point_in (const point &fp, vfloat prec) const
	Return 1 if point on the circumference.
int	cross (const plane &pn, point pt[2], vfloat prec) const
Public Member Functions inherited from Heed::absref
virtual	~absref ()
	Destructor.
virtual void	down (const abssyscoor *fasc)
	Convert numbering representation of object to basical system of fasc.
virtual void	up (const abssyscoor *fasc)
	Convert numbering representation of objects to new system.
virtual void	turn (const vec &dir, vfloat angle)
	Turn around axis doing via center of coordinate system along dir.
virtual void	shift (const vec &dir)

Protected Member Functions
virtual absref_transmit	get_components () override

Protected Attributes
point	piv
	Central point, pivot.
vec	dir
vfloat	rad
	Radius, >0.

Static Protected Attributes
static absref absref::*	aref [2]

Friends
int	operator== (const circumf &f1, const circumf &f2)
int	operator!= (const circumf &f1, const circumf &f2)
bool	apeq (const circumf &f1, const circumf &f2, vfloat prec)
std::ostream &	operator<< (std::ostream &file, const circumf &f)

Detailed Description

Circumference, determined by point (center), normal vector, and radius.

Definition at line 23 of file circumf.h.

Constructor & Destructor Documentation

circumf() [1/3]

Heed::circumf::circumf

(

)

Default constructor.

Definition at line 20 of file circumf.cpp.

: piv(), dir(), rad(0) {}

circumf() [2/3]

Heed::circumf::circumf	(	const point &	fpiv,
		const vec &	fdir,
		vfloat	frad
	)

Constructor.

Definition at line 21 of file circumf.cpp.

    : piv(fpiv), dir(), rad(frad) {
  pvecerror("circumf(...)");
  check_econd11(fdir.length(), == 0, mcerr);
  dir = unit_vec(fdir);
}

circumf() [3/3]

Heed::circumf::circumf

(

const circumf &

f

)

Definition at line 27 of file circumf.cpp.

    : absref(f), piv(f.piv), dir(f.dir), rad(f.rad) {}

~circumf()

virtual Heed::circumf::~circumf ( )

inlinevirtual

Destructor.

Definition at line 37 of file circumf.h.

{}

Member Function Documentation

check_point_in()

int Heed::circumf::check_point_in	(	const point &	fp,
		vfloat	prec
	)		const

Return 1 if point on the circumference.

Definition at line 50 of file circumf.cpp.

                                                              {
  // returns 1 if point on the circumference
  pvecerror("int circumf::check_point_in(const point &fp, vfloat prec) const");
  vec d = fp - piv;
  if (check_perp(d, dir, prec) != 1) return 0;
  if (apeq(d.length(), rad)) return 1;
  return 0;
}

cross()

int Heed::circumf::cross	(	const plane &	pn,
		point	pt[2],
		vfloat	prec
	)		const

Definition at line 58 of file circumf.cpp.

                                                                  {
  pvecerror("int circumf::cross(const plane& pn, point pt[2]) const");
  if (pn.distance(piv) > rad) return 0;  // to avoid cross at very far pn
  plane pnc(piv, dir);
  straight sl(pnc, pn);
  if (vecerror == 3) {
    vecerror = 0;
    return -1;
  }
  if (vecerror == 2) {
    vecerror = 0;
    return 0;
  }
  point closest_pt;
  vfloat d = sl.distance(piv, closest_pt);
  if (apeq(d, rad, prec)) {
    pt[0] = closest_pt;
    return 1;
  }
  if (d > rad) return 0;
  vfloat cat = sqrt(rad * rad - d * d);
  pt[0] = closest_pt + cat * sl.Gdir();
  pt[1] = closest_pt - cat * sl.Gdir();
  return 2;
}

Gdir()

vec Heed::circumf::Gdir ( ) const

inline

Definition at line 45 of file circumf.h.

{ return dir; }

get_components()

absref_transmit Heed::circumf::get_components ( )

overrideprotectedvirtual

Reimplemented from Heed::absref.

Definition at line 30 of file circumf.cpp.

                                        {
  return absref_transmit(2, aref);
}

Gpiv()

point Heed::circumf::Gpiv ( ) const

inline

Definition at line 44 of file circumf.h.

{ return piv; }

Grad()

vfloat Heed::circumf::Grad ( ) const

inline

Definition at line 46 of file circumf.h.

{ return rad; }

operator=()

circumf & Heed::circumf::operator= ( const circumf &  f )

inline

Definition at line 30 of file circumf.h.

                                       {
    piv = f.piv;
    dir = f.dir;
    rad = f.rad;
    return *this;
  }

Friends And Related Function Documentation

apeq

bool apeq ( const circumf &  f1, const circumf &  f2, vfloat  prec  )

friend

Definition at line 44 of file circumf.cpp.

                                                             {
  pvecerror("bool apeq(const circumf &f1, const circumf &f2, vfloat prec)");
  if (check_par(f1.dir, f2.dir, prec) == 0) return false;
  return apeq(f1.piv, f2.piv, prec) && apeq(f1.rad, f2.rad, prec);
}

Referenced by check_point_in(), and cross().

operator!=

int operator!= ( const circumf &  f1, const circumf &  f2  )

friend

Definition at line 39 of file circumf.h.

                                                              {
    return f1 == f2 ? 0 : 1;
  }

operator<<

std::ostream & operator<< ( std::ostream &  file, const circumf &  f  )

friend

Definition at line 84 of file circumf.cpp.

                                                           {
  Ifile << "circumf(erence):\n";
  indn.n += 2;
  Ifile << "rad=" << f.rad << '\n';
  file << f.piv << f.dir;
  indn.n -= 2;
  return file;
}

operator==

int operator== ( const circumf &  f1, const circumf &  f2  )

friend

Definition at line 34 of file circumf.cpp.

                                                     {
  pvecerror("int operator==(const circumf &f1, const circumf &f2)");
 
  if (!(f1.dir == f2.dir || f1.dir == -f2.dir)) return 0;
  if (f1.piv == f2.piv && f1.rad == f2.rad)
    return 1;
  else
    return 0;
}

Member Data Documentation

aref

absref absref::* Heed::circumf::aref

staticprotected

Initial value:

= {(absref absref::*)&circumf::piv,
                                     (absref absref::*)&circumf::dir}

Definition at line 67 of file circumf.h.

Referenced by get_components().

dir

vec Heed::circumf::dir

protected

Normal direction, unit vector. Circles with dir and -dir are considered the same.

Definition at line 62 of file circumf.h.

Referenced by check_point_in(), circumf(), cross(), Gdir(), and operator=().

piv

point Heed::circumf::piv

protected

Central point, pivot.

Definition at line 59 of file circumf.h.

Referenced by check_point_in(), cross(), Gpiv(), and operator=().

rad

vfloat Heed::circumf::rad

protected

Radius, >0.

Definition at line 64 of file circumf.h.

Referenced by check_point_in(), cross(), Grad(), and operator=().

---

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

• circumf.h
• circumf.cpp