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