Infinite plane: free space is the half-space in the normal direction. More...

#include <geomObjects.h>

Inheritance diagram for geom::Plane:

Collaboration diagram for geom::Plane:

Public Member Functions
	Plane ()

	Plane (util::Point n, util::Point p, std::string description="")

	Plane (const Plane &other)

Plane &	operator= (const Plane &other)

void	transform (const util::Point &translation, const double &scale, const double &angle, const util::Point &axis, const util::Point *rotationPoint) override
	Similarity about pivot \(\mathbf p\) (default: old center `d_x`), then rigid displacement \(\mathbf t\) = `translation:` \(\mathbf y = \mathbf p + s\,\mathbf R(\mathbf x-\mathbf p) + \mathbf t\). When \(\theta=0\) and \(s=1\), \(\mathbf y = \mathbf x + \mathbf t\) for every point and the center.

double	volume () const override
	Computes the volume (area in 2d, length in 1d) of object.

util::Point	center () const override
	Computes the center of object.

std::pair< util::Point, util::Point >	box () const override
	Computes the bounding box of object.

std::pair< util::Point, util::Point >	box (const double &tol) const override
	Computes the bounding box of object.

double	inscribedRadius () const override
	Computes the radius of biggest circle/sphere completely within the object.

double	boundingRadius () const override
	Computes the radius of smallest circle/sphere such that object can be fit into it.

bool	isInside (const util::Point &x) const override
	Checks if point is inside this object.

bool	isOutside (const util::Point &x) const override
	Checks if point is outside of this object.

bool	isNear (const util::Point &x, const double &tol) const override
	Checks if point is within given distance of this object.

bool	isNearBoundary (const util::Point &x, const double &tol, const bool &) const override
	Checks if point is within given distance of this object.

bool	doesIntersect (const util::Point &x) const override
	Checks if point lies exactly on the boundary.

bool	wallContactQuery (const util::Point &x, WallContactHit &hit) const override
	Closest-point / signed-gap query for analytical wall contact. Default: unsupported (returns false, clears `hit`).

std::string	printStr (int nt, int lvl) const override
	Returns the string containing printable information about the object.

void	print (int nt, int lvl) const override
	Prints the information about the object.

void	print () const override
	Prints the information about the object.

Public Member Functions inherited from geom::GeomObject
	GeomObject (std::string name="", std::string description="")
	Constructor.

virtual bool	isInside (const std::pair< util::Point, util::Point > &box) const
	Checks if box is completely inside.

virtual bool	isOutside (const std::pair< util::Point, util::Point > &box) const
	Checks if box is outside of the object.

virtual bool	isNear (const std::pair< util::Point, util::Point > &box, const double &tol) const
	Checks if box is within given distance of this object.

virtual bool	doesIntersect (const std::pair< util::Point, util::Point > &box) const
	Checks if box intersects this object.

Data Fields
util::Point	d_n
	outward (free-space) normal, stored unit-length when possible

util::Point	d_p
	a point on the plane

Data Fields inherited from geom::GeomObject
const std::string	d_name
	name of object

const std::string	d_description
	Further description of object.

std::vector< std::string >	d_tags
	Tags/attributes about the object.

Detailed Description

Infinite plane: free space is the half-space in the normal direction.

Factory params: nx,ny,nz, px,py,pz (unit/non-unit normal + point on plane).

Definition at line 428 of file geomObjects.h.

Constructor & Destructor Documentation

◆ Plane() [1/3]

geom::Plane::Plane ( )

inline

Definition at line 433 of file geomObjects.h.

      : GeomObject("plane", ""),
        d_n(util::Point(0., 1., 0.)),
        d_p(util::Point()) {}

◆ Plane() [2/3]

geom::Plane::Plane	(	util::Point	n,
		util::Point	p,
		std::string	description = `""`
	)

inline

Definition at line 438 of file geomObjects.h.

      : GeomObject("plane", std::move(description)), d_n(n), d_p(p) {
      const double ln = d_n.length();
      if (ln > 1.e-16)
        d_n = d_n / ln;
    }

References d_n, and util::Point::length().

Here is the call graph for this function:

◆ Plane() [3/3]

geom::Plane::Plane ( const Plane & other )

inline

Definition at line 445 of file geomObjects.h.

      : GeomObject(other.d_name, other.d_description),
        d_n(other.d_n),
        d_p(other.d_p) {
      d_tags = other.d_tags;
    }

References geom::GeomObject::d_tags.

Member Function Documentation

◆ boundingRadius()

double geom::Plane::boundingRadius ( ) const

inlineoverridevirtual

Computes the radius of smallest circle/sphere such that object can be fit into it.

Returns: Radius Radius of bounding circle/sphere

Reimplemented from geom::GeomObject.

Definition at line 483 of file geomObjects.h.

483{ return 0.; }

◆ box() [1/2]

std::pair< util::Point, util::Point > geom::Plane::box ( ) const

inlineoverridevirtual

Computes the bounding box of object.

Returns: Pair Left-bottom-back and right-top-front corner points of box

Reimplemented from geom::GeomObject.

Definition at line 476 of file geomObjects.h.

                                                       {
      return {d_p, d_p};
    }

References d_p.

◆ box() [2/2]

std::pair< util::Point, util::Point > geom::Plane::box ( const double & tol ) const

inlineoverridevirtual

Computes the bounding box of object.

Parameters

tol	Tolerance/padding used in creating bounding box

Returns: Pair Left-bottom-back and right-top-front corner points of box

Reimplemented from geom::GeomObject.

Definition at line 479 of file geomObjects.h.

                                                                        {
      return {d_p - util::Point(tol, tol, tol), d_p + util::Point(tol, tol, tol)};
    }

References d_p.

◆ center()

util::Point geom::Plane::center ( ) const

inlineoverridevirtual

Computes the center of object.

Returns: Point Coordinates of center

Reimplemented from geom::GeomObject.

Definition at line 475 of file geomObjects.h.

475{ return d_p; }

References d_p.

◆ doesIntersect()

bool geom::Plane::doesIntersect ( const util::Point & x ) const

inlineoverridevirtual

Checks if point lies exactly on the boundary.

Parameters

x Point

Returns: True True if it lies on the boundary

Reimplemented from geom::GeomObject.

Definition at line 498 of file geomObjects.h.

                                                          {
      return isNear(x, 1.e-12);
    }

References isNear().

Here is the call graph for this function:

◆ inscribedRadius()

double geom::Plane::inscribedRadius ( ) const

inlineoverridevirtual

Computes the radius of biggest circle/sphere completely within the object.

Returns: Radius Radius of inscribed circle/sphere

Reimplemented from geom::GeomObject.

Definition at line 482 of file geomObjects.h.

482{ return 0.; }

◆ isInside()

bool geom::Plane::isInside ( const util::Point & x ) const

inlineoverridevirtual

Checks if point is inside this object.

Parameters

x Point

Returns: True If point lies inside

Reimplemented from geom::GeomObject.

Definition at line 485 of file geomObjects.h.

                                                     {
      return (x - d_p) * d_n < 0.;
    }

References d_n, and d_p.

Referenced by isOutside().

Here is the caller graph for this function:

◆ isNear()

bool geom::Plane::isNear	(	const util::Point &	x,
		const double &	tol
	)		const

inlineoverridevirtual

Checks if point is within given distance of this object.

Parameters

x	Point
tol	Tolerance used in checking the nearness

Returns: True True if within the tol distance

Reimplemented from geom::GeomObject.

Definition at line 491 of file geomObjects.h.

                                                                      {
      return std::abs((x - d_p) * d_n) <= tol;
    }

References d_n, and d_p.

Referenced by doesIntersect(), and isNearBoundary().

Here is the caller graph for this function:

◆ isNearBoundary()

bool geom::Plane::isNearBoundary	(	const util::Point &	x,
		const double &	tol,
		const bool &	within
	)		const

inlineoverridevirtual

Checks if point is within given distance of this object.

Parameters

x	Point
tol	Tolerance used in checking the nearness
within	Check if the point is within (inside) the object

Returns: True True if it is near within tol distance

Reimplemented from geom::GeomObject.

Definition at line 494 of file geomObjects.h.

                                                       {
      return isNear(x, tol);
    }

References isNear().

Here is the call graph for this function:

◆ isOutside()

bool geom::Plane::isOutside ( const util::Point & x ) const

inlineoverridevirtual

Checks if point is outside of this object.

Parameters

x Point

Returns: True If point lies outside

Reimplemented from geom::GeomObject.

Definition at line 488 of file geomObjects.h.

                                                      {
      return !isInside(x);
    }

References isInside().

Here is the call graph for this function:

◆ operator=()

Plane & geom::Plane::operator= ( const Plane & other )

inline

Definition at line 452 of file geomObjects.h.

                                         {
      if (this != &other) {
        d_tags = other.d_tags;
        d_n = other.d_n;
        d_p = other.d_p;
      }
      return *this;
    }

References d_n, d_p, and geom::GeomObject::d_tags.

◆ print() [1/2]

void geom::Plane::print ( ) const

inlineoverridevirtual

Prints the information about the object.

Reimplemented from geom::GeomObject.

Definition at line 516 of file geomObjects.h.

516{ print(0, 0); }

geom::Plane::print

void print() const override

Prints the information about the object.

Definition geomObjects.h:516

References print().

Referenced by print().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ print() [2/2]

void geom::Plane::print	(	int	nt,
		int	lvl
	)		const

inlineoverridevirtual

Prints the information about the object.

Parameters

nt	Number of tabs to append before printing
lvl	Information level (higher means more information)

Reimplemented from geom::GeomObject.

Definition at line 513 of file geomObjects.h.

                                               {
      std::cout << printStr(nt, lvl);
    }

References printStr().

Here is the call graph for this function:

◆ printStr()

std::string geom::Plane::printStr	(	int	nt,
		int	lvl
	)		const

inlineoverridevirtual

Returns the string containing printable information about the object.

Parameters

nt	Number of tabs to append before printing
lvl	Information level (higher means more information)

Returns: string String containing printable information about the object

Reimplemented from geom::GeomObject.

Definition at line 505 of file geomObjects.h.

                                                       {
      auto tabS = util::io::getTabS(nt);
      std::ostringstream oss;
      oss << tabS << "------- Plane --------\n\n";
      oss << tabS << "Normal = " << d_n.printStr(0, lvl) << "\n";
      oss << tabS << "Point  = " << d_p.printStr(0, lvl) << "\n";
      return oss.str();
    }

References d_n, d_p, util::io::getTabS(), and util::Point::printStr().

Referenced by print().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ transform()

void geom::Plane::transform	(	const util::Point &	translation,
		const double &	scale,
		const double &	angle,
		const util::Point &	axis,
		const util::Point *	rotationPoint
	)

inlineoverridevirtual

Similarity about pivot \(\mathbf p\) (default: old center d_x), then rigid displacement \(\mathbf t\) = translation: \(\mathbf y = \mathbf p + s\,\mathbf R(\mathbf x-\mathbf p) + \mathbf t\). When \(\theta=0\) and \(s=1\), \(\mathbf y = \mathbf x + \mathbf t\) for every point and the center.

Parameters

translation	Rigid translation vector \(\mathbf t\) (added after rotate+scale about \(\mathbf p\))
scale	Uniform scale factor
angle	Rotation angle (radians)
axis	Axis of rotation
rotationPoint	If non-null, use as \(\mathbf p\); if null, use old `d_x` as pivot.

Reimplemented from geom::GeomObject.

Definition at line 461 of file geomObjects.h.

                                                            {
      (void)scale;
      const util::Point pivot =
          (rotationPoint != nullptr) ? *rotationPoint : d_p;
      d_p = mapSimilarity(d_p, pivot, translation, 1., angle, axis, rotationPoint);
      d_n = util::rotate(d_n, angle, axis);
      const double ln = d_n.length();
      if (ln > 1.e-16)
        d_n = d_n / ln;
    }

References d_n, d_p, util::Point::length(), geom::mapSimilarity(), and util::rotate().

Here is the call graph for this function:

◆ volume()

double geom::Plane::volume ( ) const

inlineoverridevirtual

Computes the volume (area in 2d, length in 1d) of object.

Returns: Volume Volume of object

Reimplemented from geom::GeomObject.

Definition at line 474 of file geomObjects.h.

474{ return 0.; }

◆ wallContactQuery()

bool geom::Plane::wallContactQuery	(	const util::Point &	x,
		WallContactHit &	hit
	)		const

overridevirtual

Closest-point / signed-gap query for analytical wall contact. Default: unsupported (returns false, clears hit).

Reimplemented from geom::GeomObject.

Definition at line 46 of file geomObjects.cpp.

                                                            {
      hit = WallContactHit();
      const double ln = d_n.length();
      if (!(ln > 1.e-16))
        return false;
      const util::Point n = d_n / ln;
      const double gap = (x - d_p) * n;
      hit.active = true;
      hit.signed_gap = gap;
      hit.outward_n = n;
      hit.closest = x - gap * n;
      return true;
    }

References geom::WallContactHit::active, geom::WallContactHit::closest, d_n, d_p, util::Point::length(), geom::WallContactHit::outward_n, and geom::WallContactHit::signed_gap.

Referenced by main().

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

◆ d_n

util::Point geom::Plane::d_n

outward (free-space) normal, stored unit-length when possible

Definition at line 430 of file geomObjects.h.

Referenced by isInside(), isNear(), operator=(), Plane(), printStr(), transform(), and wallContactQuery().

◆ d_p

util::Point geom::Plane::d_p

a point on the plane

Definition at line 431 of file geomObjects.h.

Referenced by box(), box(), center(), isInside(), isNear(), operator=(), printStr(), transform(), and wallContactQuery().

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

/home/user/project/src/geom/geomObjects.h
/home/user/project/src/geom/geomObjects.cpp

Public Member Functions

Data Fields

Detailed Description

Constructor & Destructor Documentation

◆ Plane() [1/3]

◆ Plane() [2/3]

◆ Plane() [3/3]

Member Function Documentation

◆ boundingRadius()

◆ box() [1/2]

◆ box() [2/2]

◆ center()

◆ doesIntersect()

◆ inscribedRadius()

◆ isInside()

◆ isNear()

◆ isNearBoundary()

◆ isOutside()

◆ operator=()

◆ print() [1/2]

◆ print() [2/2]

◆ printStr()

◆ transform()

◆ volume()

◆ wallContactQuery()

Field Documentation

◆ d_n

◆ d_p