include/opencascade/HatchGen_Domain.hxx

0001 // Created on: 1993-11-05
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_Domain_HeaderFile
0018 #define _HatchGen_Domain_HeaderFile
0019
0020 #include <Standard.hxx>
0021 #include <Standard_DefineAlloc.hxx>
0022 #include <Standard_Handle.hxx>
0023
0024 #include <Standard_Boolean.hxx>
0025 #include <HatchGen_PointOnHatching.hxx>
0026
0027
0028 class HatchGen_Domain
0029 {
0030 public:
0031
0032   DEFINE_STANDARD_ALLOC
0033
0034
0035   //! Creates an infinite domain.
0036   Standard_EXPORT HatchGen_Domain();
0037
0038   //! Creates a domain for the curve associated to a hatching.
0039   Standard_EXPORT HatchGen_Domain(const HatchGen_PointOnHatching& P1, const HatchGen_PointOnHatching& P2);
0040
0041   //! Creates a semi-infinite domain for the curve associated
0042   //! to a hatching. The `First' flag means that the given
0043   //! point is the first one.
0044   Standard_EXPORT HatchGen_Domain(const HatchGen_PointOnHatching& P, const Standard_Boolean First);
0045
0046   //! Sets the first and the second points of the domain.
0047     void SetPoints (const HatchGen_PointOnHatching& P1, const HatchGen_PointOnHatching& P2);
0048
0049   //! Sets the first and the second points of the domain
0050   //! as the infinite.
0051     void SetPoints();
0052
0053   //! Sets the first point of the domain.
0054     void SetFirstPoint (const HatchGen_PointOnHatching& P);
0055
0056   //! Sets the first point of the domain at the
0057   //! infinite.
0058     void SetFirstPoint();
0059
0060   //! Sets the second point of the domain.
0061     void SetSecondPoint (const HatchGen_PointOnHatching& P);
0062
0063   //! Sets the second point of the domain at the
0064   //! infinite.
0065     void SetSecondPoint();
0066
0067   //! Returns True if the domain has a first point.
0068     Standard_Boolean HasFirstPoint() const;
0069
0070   //! Returns the first point of the domain.
0071   //! The exception DomainError is raised if
0072   //! HasFirstPoint returns False.
0073     const HatchGen_PointOnHatching& FirstPoint() const;
0074
0075   //! Returns True if the domain has a second point.
0076     Standard_Boolean HasSecondPoint() const;
0077
0078   //! Returns the second point of the domain.
0079   //! The exception DomainError is raised if
0080   //! HasSecondPoint returns False.
0081     const HatchGen_PointOnHatching& SecondPoint() const;
0082
0083   //! Dump of the domain.
0084   Standard_EXPORT void Dump (const Standard_Integer Index = 0) const;
0085
0086
0087
0088
0089 protected:
0090
0091
0092
0093
0094
0095 private:
0096
0097
0098
0099   Standard_Boolean myHasFirstPoint;
0100   HatchGen_PointOnHatching myFirstPoint;
0101   Standard_Boolean myHasSecondPoint;
0102   HatchGen_PointOnHatching mySecondPoint;
0103
0104
0105 };
0106
0107
0108 #include <HatchGen_Domain.lxx>
0109
0110
0111
0112
0113
0114 #endif // _HatchGen_Domain_HeaderFile