include/opencascade/IGESDimen_SectionedArea.hxx

0001 // Created on: 1993-01-09
0002 // Created by: CKY / Contract Toubro-Larsen ( SIVA )
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 _IGESDimen_SectionedArea_HeaderFile
0018 #define _IGESDimen_SectionedArea_HeaderFile
0019
0020 #include <Standard.hxx>
0021 #include <Standard_Type.hxx>
0022
0023 #include <Standard_Integer.hxx>
0024 #include <gp_XYZ.hxx>
0025 #include <IGESData_HArray1OfIGESEntity.hxx>
0026 #include <IGESData_IGESEntity.hxx>
0027 class gp_Pnt;
0028
0029
0030 class IGESDimen_SectionedArea;
0031 DEFINE_STANDARD_HANDLE(IGESDimen_SectionedArea, IGESData_IGESEntity)
0032
0033 //! defines IGES Sectioned Area, Type <230> Form <0>,
0034 //! in package IGESDimen
0035 //! A sectioned area is a portion of a design which is to be
0036 //! filled with a pattern of lines. Ordinarily, this entity
0037 //! is used to reveal or expose shape or material characteri-
0038 //! stics defined by other entities. It consists of a pointer
0039 //! to an exterior definition curve, a specification of the
0040 //! pattern of lines, the coordinates of a point on a pattern
0041 //! line, the distance between the pattern lines, the angle
0042 //! between the pattern lines and the X-axis of definition
0043 //! space, and the specification of any enclosed definition
0044 //! curves (commonly known as islands).
0045 class IGESDimen_SectionedArea : public IGESData_IGESEntity
0046 {
0047
0048 public:
0049
0050
0051   Standard_EXPORT IGESDimen_SectionedArea();
0052
0053   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);
0054
0055   //! Sets the cross hatches to be inverted or not,
0056   //! according value of <mode> (corresponds to FormNumber)
0057   Standard_EXPORT void SetInverted (const Standard_Boolean mode);
0058
0059   //! Returns True if cross hatches as Inverted, else they are
0060   //! Standard (Inverted : Form=1, Standard : Form=0)
0061   Standard_EXPORT Standard_Boolean IsInverted() const;
0062
0063   //! returns the exterior definition curve
0064   Standard_EXPORT Handle(IGESData_IGESEntity) ExteriorCurve() const;
0065
0066   //! returns fill pattern code
0067   Standard_EXPORT Standard_Integer Pattern() const;
0068
0069   //! returns point thru which line should pass
0070   Standard_EXPORT gp_Pnt PassingPoint() const;
0071
0072   //! returns point thru which line should pass after Transformation
0073   Standard_EXPORT gp_Pnt TransformedPassingPoint() const;
0074
0075   //! returns the Z depth
0076   Standard_EXPORT Standard_Real ZDepth() const;
0077
0078   //! returns the normal distance between lines
0079   Standard_EXPORT Standard_Real Distance() const;
0080
0081   //! returns the angle of lines with XT axis
0082   Standard_EXPORT Standard_Real Angle() const;
0083
0084   //! returns the number of island curves
0085   Standard_EXPORT Standard_Integer NbIslands() const;
0086
0087   //! returns the interior definition curves, returns Null Handle
0088   //! exception raised if Index <= 0 or Index > NbIslands()
0089   Standard_EXPORT Handle(IGESData_IGESEntity) IslandCurve (const Standard_Integer Index) const;
0090
0091
0092
0093
0094   DEFINE_STANDARD_RTTIEXT(IGESDimen_SectionedArea,IGESData_IGESEntity)
0095
0096 protected:
0097
0098
0099
0100
0101 private:
0102
0103
0104   Handle(IGESData_IGESEntity) theExteriorCurve;
0105   Standard_Integer thePattern;
0106   gp_XYZ thePassingPoint;
0107   Standard_Real theDistance;
0108   Standard_Real theAngle;
0109   Handle(IGESData_HArray1OfIGESEntity) theIslandCurves;
0110
0111
0112 };
0113
0114
0115
0116
0117
0118
0119
0120 #endif // _IGESDimen_SectionedArea_HeaderFile