include/opencascade/GccInt_Bisec.hxx

0001 // Created on: 1991-10-04
0002 // Created by: Remi GILET
0003 // Copyright (c) 1991-1999 Matra Datavision
0004 // Copyright (c) 1999-2014 OPEN CASCADE SAS
0005 //
0006 // This file is part of Open CASCADE Technology software library.
0007 //
0008 // This library is free software; you can redistribute it and/or modify it under
0009 // the terms of the GNU Lesser General Public License version 2.1 as published
0010 // by the Free Software Foundation, with special exception defined in the file
0011 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
0012 // distribution for complete text of the license and disclaimer of any warranty.
0013 //
0014 // Alternatively, this file may be used under the terms of Open CASCADE
0015 // commercial license or contractual agreement.
0016
0017 #ifndef _GccInt_Bisec_HeaderFile
0018 #define _GccInt_Bisec_HeaderFile
0019
0020 #include <Standard.hxx>
0021 #include <Standard_Type.hxx>
0022
0023 #include <Standard_Transient.hxx>
0024 #include <GccInt_IType.hxx>
0025 class gp_Pnt2d;
0026 class gp_Lin2d;
0027 class gp_Circ2d;
0028 class gp_Hypr2d;
0029 class gp_Parab2d;
0030 class gp_Elips2d;
0031
0032 class GccInt_Bisec;
0033 DEFINE_STANDARD_HANDLE(GccInt_Bisec, Standard_Transient)
0034
0035 //! The deferred class GccInt_Bisec is the root class for
0036 //! elementary bisecting loci between two simple geometric
0037 //! objects (i.e. circles, lines or points).
0038 //! Bisecting loci between two geometric objects are such
0039 //! that each of their points is at the same distance from the
0040 //! two geometric objects. It is typically a curve, such as a
0041 //! line, circle or conic.
0042 //! Generally there is more than one elementary object
0043 //! which is the solution to a bisecting loci problem: each
0044 //! solution is described with one elementary bisecting
0045 //! locus. For example, the bisectors of two secant straight
0046 //! lines are two perpendicular straight lines.
0047 //! The GccInt package provides concrete implementations
0048 //! of the following elementary derived bisecting loci:
0049 //! -   lines, circles, ellipses, hyperbolas and parabolas, and
0050 //! -   points (not used in this context).
0051 //! The GccAna package provides numerous algorithms for
0052 //! computing the bisecting loci between circles, lines or
0053 //! points, whose solutions are these types of elementary bisecting locus.
0054 class GccInt_Bisec : public Standard_Transient
0055 {
0056
0057 public:
0058   //! Returns the type of bisecting object (line, circle,
0059   //! parabola, hyperbola, ellipse, point).
0060   Standard_EXPORT virtual GccInt_IType ArcType() const = 0;
0061
0062   //! Returns the bisecting line when ArcType returns Pnt.
0063   //! An exception DomainError is raised if ArcType is not a Pnt.
0064   Standard_EXPORT virtual gp_Pnt2d Point() const;
0065
0066   //! Returns the bisecting line when ArcType returns Lin.
0067   //! An exception DomainError is raised if ArcType is not a Lin.
0068   Standard_EXPORT virtual gp_Lin2d Line() const;
0069
0070   //! Returns the bisecting line when ArcType returns Cir.
0071   //! An exception DomainError is raised if ArcType is not a Cir.
0072   Standard_EXPORT virtual gp_Circ2d Circle() const;
0073
0074   //! Returns the bisecting line when ArcType returns Hpr.
0075   //! An exception DomainError is raised if ArcType is not a Hpr.
0076   Standard_EXPORT virtual gp_Hypr2d Hyperbola() const;
0077
0078   //! Returns the bisecting line when ArcType returns Par.
0079   //! An exception DomainError is raised if ArcType is not a Par.
0080   Standard_EXPORT virtual gp_Parab2d Parabola() const;
0081
0082   //! Returns the bisecting line when ArcType returns Ell.
0083   //! An exception DomainError is raised if ArcType is not an Ell.
0084   Standard_EXPORT virtual gp_Elips2d Ellipse() const;
0085
0086   DEFINE_STANDARD_RTTIEXT(GccInt_Bisec, Standard_Transient)
0087
0088 protected:
0089 private:
0090 };
0091
0092 #endif // _GccInt_Bisec_HeaderFile