include/opencascade/HatchGen_IntersectionPoint.hxx

0001 // Created on: 1993-10-29
0002 // Created by: Jean Marc LACHAUME
0003 // Copyright (c) 1993-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 _HatchGen_IntersectionPoint_HeaderFile
0018 #define _HatchGen_IntersectionPoint_HeaderFile
0019
0020 #include <Standard.hxx>
0021 #include <Standard_DefineAlloc.hxx>
0022 #include <Standard_Handle.hxx>
0023
0024 #include <Standard_Real.hxx>
0025 #include <TopAbs_Orientation.hxx>
0026 #include <TopAbs_State.hxx>
0027 #include <Standard_Boolean.hxx>
0028
0029 class HatchGen_IntersectionPoint
0030 {
0031 public:
0032   DEFINE_STANDARD_ALLOC
0033
0034   //! Sets the index of the supporting curve.
0035   Standard_EXPORT void SetIndex(const int Index);
0036
0037   //! Returns the index of the supporting curve.
0038   Standard_EXPORT int Index() const;
0039
0040   //! Sets the parameter on the curve.
0041   Standard_EXPORT void SetParameter(const double Parameter);
0042
0043   //! Returns the parameter on the curve.
0044   Standard_EXPORT double Parameter() const;
0045
0046   //! Sets the position of the point on the curve.
0047   Standard_EXPORT void SetPosition(const TopAbs_Orientation Position);
0048
0049   //! Returns the position of the point on the curve.
0050   Standard_EXPORT TopAbs_Orientation Position() const;
0051
0052   //! Sets the transition state before the intersection.
0053   Standard_EXPORT void SetStateBefore(const TopAbs_State State);
0054
0055   //! Returns the transition state before the intersection.
0056   Standard_EXPORT TopAbs_State StateBefore() const;
0057
0058   //! Sets the transition state after the intersection.
0059   Standard_EXPORT void SetStateAfter(const TopAbs_State State);
0060
0061   //! Returns the transition state after of the intersection.
0062   Standard_EXPORT TopAbs_State StateAfter() const;
0063
0064   //! Sets the flag that the point is the beginning of a segment.
0065   Standard_EXPORT void SetSegmentBeginning(const bool State = true);
0066
0067   //! Returns the flag that the point is the beginning of a segment.
0068   Standard_EXPORT bool SegmentBeginning() const;
0069
0070   //! Sets the flag that the point is the end of a segment.
0071   Standard_EXPORT void SetSegmentEnd(const bool State = true);
0072
0073   //! Returns the flag that the point is the end of a segment.
0074   Standard_EXPORT bool SegmentEnd() const;
0075
0076   //! Dump of the point on element.
0077   Standard_EXPORT virtual void Dump(const int Index = 0) const = 0;
0078
0079 protected:
0080   //! Creates an empty intersection point.
0081   Standard_EXPORT HatchGen_IntersectionPoint();
0082
0083   //! Destructor is protected for safer inheritance
0084   ~HatchGen_IntersectionPoint() = default;
0085
0086 protected:
0087   int                myIndex;
0088   double             myParam;
0089   TopAbs_Orientation myPosit;
0090   TopAbs_State       myBefore;
0091   TopAbs_State       myAfter;
0092   bool               mySegBeg;
0093   bool               mySegEnd;
0094 };
0095
0096 #endif // _HatchGen_IntersectionPoint_HeaderFile