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
0030
0031 class HatchGen_IntersectionPoint
0032 {
0033 public:
0034
0035   DEFINE_STANDARD_ALLOC
0036
0037
0038   //! Sets the index of the supporting curve.
0039   Standard_EXPORT void SetIndex (const Standard_Integer Index);
0040
0041   //! Returns the index of the supporting curve.
0042   Standard_EXPORT Standard_Integer Index() const;
0043
0044   //! Sets the parameter on the curve.
0045   Standard_EXPORT void SetParameter (const Standard_Real Parameter);
0046
0047   //! Returns the parameter on the curve.
0048   Standard_EXPORT Standard_Real Parameter() const;
0049
0050   //! Sets the position of the point on the curve.
0051   Standard_EXPORT void SetPosition (const TopAbs_Orientation Position);
0052
0053   //! Returns the position of the point on the curve.
0054   Standard_EXPORT TopAbs_Orientation Position() const;
0055
0056   //! Sets the transition state before the intersection.
0057   Standard_EXPORT void SetStateBefore (const TopAbs_State State);
0058
0059   //! Returns the transition state before the intersection.
0060   Standard_EXPORT TopAbs_State StateBefore() const;
0061
0062   //! Sets the transition state after the intersection.
0063   Standard_EXPORT void SetStateAfter (const TopAbs_State State);
0064
0065   //! Returns the transition state after of the intersection.
0066   Standard_EXPORT TopAbs_State StateAfter() const;
0067
0068   //! Sets the flag that the point is the beginning of a segment.
0069   Standard_EXPORT void SetSegmentBeginning (const Standard_Boolean State = Standard_True);
0070
0071   //! Returns the flag that the point is the beginning of a segment.
0072   Standard_EXPORT Standard_Boolean SegmentBeginning() const;
0073
0074   //! Sets the flag that the point is the end of a segment.
0075   Standard_EXPORT void SetSegmentEnd (const Standard_Boolean State = Standard_True);
0076
0077   //! Returns the flag that the point is the end of a segment.
0078   Standard_EXPORT Standard_Boolean SegmentEnd() const;
0079
0080   //! Dump of the point on element.
0081   Standard_EXPORT virtual void Dump (const Standard_Integer Index = 0) const = 0;
0082
0083 protected:
0084
0085   //! Creates an empty intersection point.
0086   Standard_EXPORT HatchGen_IntersectionPoint();
0087
0088   //! Destructor is protected for safer inheritance
0089   ~HatchGen_IntersectionPoint() {}
0090
0091 protected:
0092
0093   Standard_Integer myIndex;
0094   Standard_Real myParam;
0095   TopAbs_Orientation myPosit;
0096   TopAbs_State myBefore;
0097   TopAbs_State myAfter;
0098   Standard_Boolean mySegBeg;
0099   Standard_Boolean mySegEnd;
0100 };
0101
0102 #endif // _HatchGen_IntersectionPoint_HeaderFile