src/IGESDimen/IGESDimen_SectionedArea.hxx

   1 // Created on: 1993-01-09
   2 // Created by: CKY / Contract Toubro-Larsen ( SIVA )
   3 // Copyright (c) 1993-1999 Matra Datavision
   4 // Copyright (c) 1999-2014 OPEN CASCADE SAS
   5 //
   6 // This file is part of Open CASCADE Technology software library.
   7 //
   8 // This library is free software; you can redistribute it and/or modify it under
   9 // the terms of the GNU Lesser General Public License version 2.1 as published
  10 // by the Free Software Foundation, with special exception defined in the file
  11 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
  12 // distribution for complete text of the license and disclaimer of any warranty.
  13 //
  14 // Alternatively, this file may be used under the terms of Open CASCADE
  15 // commercial license or contractual agreement.
  16
  17 #ifndef _IGESDimen_SectionedArea_HeaderFile
  18 #define _IGESDimen_SectionedArea_HeaderFile
  19
  20 #include <Standard.hxx>
  21 #include <Standard_Type.hxx>
  22
  23 #include <Standard_Integer.hxx>
  24 #include <gp_XYZ.hxx>
  25 #include <Standard_Real.hxx>
  26 #include <IGESData_HArray1OfIGESEntity.hxx>
  27 #include <IGESData_IGESEntity.hxx>
  28 #include <Standard_Boolean.hxx>
  29 class IGESData_IGESEntity;
  30 class Standard_OutOfRange;
  31 class gp_XYZ;
  32 class gp_Pnt;
  33
  34
  35 class IGESDimen_SectionedArea;
  36 DEFINE_STANDARD_HANDLE(IGESDimen_SectionedArea, IGESData_IGESEntity)
  37
  38 //! defines IGES Sectioned Area, Type <230> Form <0>,
  39 //! in package IGESDimen
  40 //! A sectioned area is a portion of a design which is to be
  41 //! filled with a pattern of lines. Ordinarily, this entity
  42 //! is used to reveal or expose shape or material characteri-
  43 //! stics defined by other entities. It consists of a pointer
  44 //! to an exterior definition curve, a specification of the
  45 //! pattern of lines, the coordinates of a point on a pattern
  46 //! line, the distance between the pattern lines, the angle
  47 //! between the pattern lines and the X-axis of definition
  48 //! space, and the specification of any enclosed definition
  49 //! curves (commonly known as islands).
  50 class IGESDimen_SectionedArea : public IGESData_IGESEntity
  51 {
  52
  53 public:
  54
  55
  56   Standard_EXPORT IGESDimen_SectionedArea();
  57
  58   Standard_EXPORT void Init (const Handle(IGESData_IGESEntity)& aCurve, const Standard_Integer aPattern, const gp_XYZ& aPoint, const Standard_Real aDistance, const Standard_Real anAngle, const Handle(IGESData_HArray1OfIGESEntity)& someIslands);
  59
  60   //! Sets the cross hatches to be inverted or not,
  61   //! according value of <mode> (corresponds to FormNumber)
  62   Standard_EXPORT void SetInverted (const Standard_Boolean mode);
  63
  64   //! Returns True if cross hatches as Inverted, else they are
  65   //! Standard (Inverted : Form=1, Standard : Form=0)
  66   Standard_EXPORT Standard_Boolean IsInverted() const;
  67
  68   //! returns the exterior definition curve
  69   Standard_EXPORT Handle(IGESData_IGESEntity) ExteriorCurve() const;
  70
  71   //! returns fill pattern code
  72   Standard_EXPORT Standard_Integer Pattern() const;
  73
  74   //! returns point thru which line should pass
  75   Standard_EXPORT gp_Pnt PassingPoint() const;
  76
  77   //! returns point thru which line should pass after Transformation
  78   Standard_EXPORT gp_Pnt TransformedPassingPoint() const;
  79
  80   //! returns the Z depth
  81   Standard_EXPORT Standard_Real ZDepth() const;
  82
  83   //! returns the normal distance between lines
  84   Standard_EXPORT Standard_Real Distance() const;
  85
  86   //! returns the angle of lines with XT axis
  87   Standard_EXPORT Standard_Real Angle() const;
  88
  89   //! returns the number of island curves
  90   Standard_EXPORT Standard_Integer NbIslands() const;
  91
  92   //! returns the interior definition curves, returns Null Handle
  93   //! exception raised if Index <= 0 or Index > NbIslands()
  94   Standard_EXPORT Handle(IGESData_IGESEntity) IslandCurve (const Standard_Integer Index) const;
  95
  96
  97
  98
  99   DEFINE_STANDARD_RTTIEXT(IGESDimen_SectionedArea,IGESData_IGESEntity)
 100
 101 protected:
 102
 103
 104
 105
 106 private:
 107
 108
 109   Handle(IGESData_IGESEntity) theExteriorCurve;
 110   Standard_Integer thePattern;
 111   gp_XYZ thePassingPoint;
 112   Standard_Real theDistance;
 113   Standard_Real theAngle;
 114   Handle(IGESData_HArray1OfIGESEntity) theIslandCurves;
 115
 116
 117 };
 118
 119
 120
 121
 122
 123
 124
 125 #endif // _IGESDimen_SectionedArea_HeaderFile