Line.h

Go to the documentation of this file.

//  ************************************************************************************************
//
//  BornAgain: simulate and fit reflection and scattering
//
//! @file      Device/Mask/Line.h
//! @brief     Defines class Line.
//!
//! @homepage  http://www.bornagainproject.org
//! @license   GNU General Public License v3 or higher (see COPYING)
//! @copyright Forschungszentrum Jülich GmbH 2018
//! @authors   Scientific Computing Group at MLZ (see CITATION, AUTHORS)
//
//  ************************************************************************************************
 
#ifndef BORNAGAIN_DEVICE_MASK_LINE_H
#define BORNAGAIN_DEVICE_MASK_LINE_H
 
#include "Device/Mask/IShape2D.h"
 
//! A line segment, for use in detector masks.
//! @ingroup mask
 
class Line : public IShape2D {
public:
    Line(double x1, double y1, double x2, double y2);
    Line* clone() const { return new Line(m_x1, m_y1, m_x2, m_y2); }
 
    bool contains(double x, double y) const;
    bool contains(const Bin1D& binx, const Bin1D& biny) const;
 
private:
    double m_x1, m_y1, m_x2, m_y2;
};
 
//! An infinite vertical line.
//! @ingroup mask
 
class VerticalLine : public IShape2D {
public:
    VerticalLine(double x);
    VerticalLine* clone() const { return new VerticalLine(m_x); }
 
    bool contains(double x, double y) const;
    bool contains(const Bin1D& binx, const Bin1D& biny) const;
 
    double getXpos() const { return m_x; }
 
private:
    double m_x;
};
 
//! An infinite horizontal line.
//! @ingroup mask
 
class HorizontalLine : public IShape2D {
public:
    HorizontalLine(double y);
    HorizontalLine* clone() const { return new HorizontalLine(m_y); }
 
    bool contains(double x, double y) const;
    bool contains(const Bin1D& binx, const Bin1D& biny) const;
 
    double getYpos() const { return m_y; }
 
private:
    double m_y;
};
 
#endif // BORNAGAIN_DEVICE_MASK_LINE_H