include/opencascade/IntSurf_Transition.hxx

0001 // Created on: 1992-05-06
0002 // Created by: Jacques GOUSSARD
0003 // Copyright (c) 1992-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 _IntSurf_Transition_HeaderFile
0018 #define _IntSurf_Transition_HeaderFile
0019
0020 #include <Standard.hxx>
0021 #include <Standard_DefineAlloc.hxx>
0022 #include <Standard_Handle.hxx>
0023
0024 #include <Standard_Boolean.hxx>
0025 #include <IntSurf_TypeTrans.hxx>
0026 #include <IntSurf_Situation.hxx>
0027
0028
0029 //! Definition of the transition at the intersection
0030 //! between an intersection line and a restriction curve
0031 //! on a surface.
0032 class IntSurf_Transition
0033 {
0034 public:
0035
0036   DEFINE_STANDARD_ALLOC
0037
0038
0039   //! Empty constructor. Creates an UNDECIDED transition.
0040   Standard_EXPORT IntSurf_Transition();
0041
0042   //! Create a IN or OUT transition
0043   Standard_EXPORT IntSurf_Transition(const Standard_Boolean Tangent, const IntSurf_TypeTrans Type);
0044
0045   //! Create a TOUCH transition.
0046   Standard_EXPORT IntSurf_Transition(const Standard_Boolean Tangent, const IntSurf_Situation Situ, const Standard_Boolean Oppos);
0047
0048   //! Set the values of an IN or OUT transition.
0049     void SetValue (const Standard_Boolean Tangent, const IntSurf_TypeTrans Type);
0050
0051   //! Set the values of a TOUCH transition.
0052     void SetValue (const Standard_Boolean Tangent, const IntSurf_Situation Situ, const Standard_Boolean Oppos);
0053
0054   //! Set the values of an UNDECIDED transition.
0055     void SetValue();
0056
0057   //! Returns the type of Transition (in/out/touch/undecided)
0058   //! for the arc given by value. This the transition of
0059   //! the intersection line compared to the Arc of restriction,
0060   //! i-e when the function returns INSIDE for example, it
0061   //! means that the intersection line goes inside the
0062   //! part of plane limited by the arc of restriction.
0063     IntSurf_TypeTrans TransitionType() const;
0064
0065   //! Returns TRUE if the point is tangent to the arc
0066   //! given by Value.
0067   //! An exception is raised if TransitionType returns UNDECIDED.
0068     Standard_Boolean IsTangent() const;
0069
0070   //! Returns a significant value if TransitionType returns
0071   //! TOUCH. In this case, the function returns :
0072   //! INSIDE when the intersection line remains inside the Arc,
0073   //! OUTSIDE when it remains outside the Arc,
0074   //! UNKNOWN when the calsulus cannot give results.
0075   //! If TransitionType returns IN, or OUT, or UNDECIDED, a
0076   //! exception is raised.
0077     IntSurf_Situation Situation() const;
0078
0079   //! returns a significant value if TransitionType returns
0080   //! TOUCH.
0081   //! In this case, the function returns true when
0082   //! the 2 curves locally define two different parts of the
0083   //! space.
0084   //! If TransitionType returns IN or OUT or UNDECIDED, an
0085   //! exception is raised.
0086     Standard_Boolean IsOpposite() const;
0087
0088
0089
0090
0091 protected:
0092
0093
0094
0095
0096
0097 private:
0098
0099
0100
0101   Standard_Boolean tangent;
0102   IntSurf_TypeTrans typetra;
0103   IntSurf_Situation situat;
0104   Standard_Boolean oppos;
0105
0106
0107 };
0108
0109
0110 #include <IntSurf_Transition.lxx>
0111
0112
0113
0114
0115
0116 #endif // _IntSurf_Transition_HeaderFile