Circ.h

Go to the documentation of this file.

//
// Copyright(C) 2013-2016  OpenCascade [www.opencascade.org]
//
// This library is free software; you can redistribute it and / or
// modify it under the terms of the GNU Lesser General Public
// License as published by the Free Software Foundation; either
// version 2.1 of the License, or (at your option) any later version.
//
// This library is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.See the GNU
// Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 51 Franklin Street,
// Fifth Floor, Boston, MA  02110 - 1301  USA
//

#pragma once

#include <Geom/Ax2.h>
#include <Geom/GeomEnums.h>
#include <Geom/geom_defines.h>

// namespace Geom {
//
// class Ax1;
// class Ax2;
// class Trsf;
// class Vec;
// class Pnt;
//
//}

namespace Geom
{
class GEOM_EXPORT Circ
{
public:
    //                                                       //
    // --------------------- BEGIN API --------------------- //
    //                                                       //
    // ATTENTION: DO NOT CHANGE ANY SIGNATURES IN THE API !  //
    //                                                       //

    Circ();

    Circ(const Geom::Ax2& A2, const double Radius);

    void setAxis(const Geom::Ax1& A1);

    void setLocation(const Geom::Pnt& P);
    void setPosition(const Geom::Ax2& A2);
    void setRadius(const double Radius);
    double area() const;

    const Geom::Ax1& axis() const;
    double length() const;

    const Geom::Pnt& location() const;

    const Geom::Ax2& position() const;
    double radius() const;

    Geom::Ax1 xAxis() const;

    Geom::Ax1 yAxis() const;

    double distance(const Geom::Pnt& P) const;

    double squareDistance(const Geom::Pnt& P) const;

    bool contains(const Geom::Pnt& P, const double LinearTolerance) const;

    void mirror(const Geom::Pnt& P);

    Geom::Circ mirrored(const Geom::Pnt& P) const;

    void mirror(const Geom::Ax1& A1);

    Geom::Circ mirrored(const Geom::Ax1& A1) const;

    void mirror(const Geom::Ax2& A2);

    Geom::Circ mirrored(const Geom::Ax2& A2) const;

    void rotate(const Geom::Ax1& A1, const double Ang);

    Geom::Circ rotated(const Geom::Ax1& A1, const double Ang) const;

    void scale(const Geom::Pnt& P, const double S);

    Geom::Circ scaled(const Geom::Pnt& P, const double S) const;

    void transform(const Geom::Trsf& T);

    Geom::Circ transformed(const Geom::Trsf& T) const;

    void translate(const Geom::Vec& V);

    Geom::Circ translated(const Geom::Vec& V) const;

    void translate(const Geom::Pnt& P1, const Geom::Pnt& P2);

    Geom::Circ translated(const Geom::Pnt& P1, const Geom::Pnt& P2) const;

    //                                                       //
    // ---------------------- END API ---------------------- //
    //                                                       //

private:
    Geom::Ax2 _pos;
    double _radius;
};

}  // namespace Geom