Lin.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/Ax1.h>
#include <Geom/GeomEnums.h>
#include <Geom/geom_defines.h>

namespace Geom
{
class Ax2;
class Trsf;
class Vec;
class Pnt;
class Trsf;

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


    // Methods PUBLIC
    //
    Lin();
    Lin(const Geom::Ax1& A1);

    Lin(const Geom::Pnt& P, const Geom::Dir& V);

    void reverse();
    Lin reversed() const;
    void setDirection(const Geom::Dir& V);
    void setLocation(const Geom::Pnt& P);

    void setPosition(const Geom::Ax1& A1);
    const Geom::Dir& direction() const;

    const Geom::Pnt& location() const;

    const Geom::Ax1& position() const;
    double angle(const Lin& Other) const;
    bool contains(const Geom::Pnt& P, const double LinearTolerance) const;
    double distance(const Geom::Pnt& P) const;

    double distance(const Lin& Other) const;

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

    Lin normal(const Geom::Pnt& P) const;


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


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


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


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


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


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

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

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

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

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

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

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

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

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

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

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

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

private:
    Geom::Ax1 pos;
};

}  // namespace Geom