Description

Basic class for all shapes in 2D.

Definition at line 26 of file IShape2D.h.

Inheritance diagram for IShape2D:

Collaboration diagram for IShape2D:

Public Member Functions
	IShape2D (const char *name)

	~IShape2D () override=default

IShape2D *	clone () const override=0

virtual bool	contains (const Bin1D &binx, const Bin1D &biny) const =0
	Returns true if area defined by two bins is inside or on border of polygon (more precisely, if mid point of two bins satisfy this condition). More...

virtual bool	contains (double x, double y) const =0
	Returns true if point with given coordinates is inside or on border of the shape. More...

virtual void	transferToCPP ()
	Used for Python overriding of clone (see swig/tweaks.py) More...

Protected Member Functions
virtual void	print (std::ostream &ostr) const

Private Attributes
const char *const	m_name

Friends
std::ostream &	operator<< (std::ostream &ostr, const IShape2D &shape)

Constructor & Destructor Documentation

◆ IShape2D()

IShape2D::IShape2D ( const char * name )

inline

Definition at line 28 of file IShape2D.h.

         : m_name(name)
     {
     }

◆ ~IShape2D()

IShape2D::~IShape2D ( )

overridedefault

Member Function Documentation

◆ clone()

IShape2D* IShape2D::clone ( ) const

overridepure virtual

Implements ICloneable.

Implemented in Rectangle, Polygon, HorizontalLine, VerticalLine, Line, InfinitePlane, and Ellipse.

Referenced by DetectorMask::addMask(), and MaskPattern::clone().

◆ contains() [1/2]

virtual bool IShape2D::contains	(	const Bin1D &	binx,
		const Bin1D &	biny
	)		const

pure virtual

Returns true if area defined by two bins is inside or on border of polygon (more precisely, if mid point of two bins satisfy this condition).

Implemented in Rectangle, Polygon, HorizontalLine, VerticalLine, Line, Ellipse, and InfinitePlane.

◆ contains() [2/2]

virtual bool IShape2D::contains	(	double	x,
		double	y
	)		const

pure virtual

Returns true if point with given coordinates is inside or on border of the shape.

Implemented in InfinitePlane, Rectangle, Polygon, HorizontalLine, VerticalLine, Line, and Ellipse.

Referenced by DetectorMask::process_masks().

◆ print()

virtual void IShape2D::print ( std::ostream & ostr ) const

inlineprotectedvirtual

Reimplemented in Polygon.

Definition at line 49 of file IShape2D.h.

49 { ostr << m_name; }

References m_name.

◆ transferToCPP()

virtual void ICloneable::transferToCPP ( )

inlinevirtualinherited

Used for Python overriding of clone (see swig/tweaks.py)

Definition at line 32 of file ICloneable.h.

Friends And Related Function Documentation

◆ operator<<

std::ostream& operator<<	(	std::ostream &	ostr,
		const IShape2D &	shape
	)

friend

Definition at line 42 of file IShape2D.h.

     {
         shape.print(ostr);
         return ostr;
     }

Member Data Documentation

◆ m_name

const char* const IShape2D::m_name

private

Definition at line 52 of file IShape2D.h.

Referenced by print().

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

/home/build/builds/o5h8MZZm/0/mlz/bornagain/Device/Mask/IShape2D.h