include/opencascade/IGESGeom_CopiousData.hxx

0001 // Created on: 1993-01-09
0002 // Created by: CKY / Contract Toubro-Larsen ( Kiran )
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 _IGESGeom_CopiousData_HeaderFile
0018 #define _IGESGeom_CopiousData_HeaderFile
0019
0020 #include <Standard.hxx>
0021 #include <Standard_Type.hxx>
0022
0023 #include <Standard_Integer.hxx>
0024 #include <TColStd_HArray1OfReal.hxx>
0025 #include <IGESData_IGESEntity.hxx>
0026 class gp_Pnt;
0027 class gp_Vec;
0028
0029 class IGESGeom_CopiousData;
0030 DEFINE_STANDARD_HANDLE(IGESGeom_CopiousData, IGESData_IGESEntity)
0031
0032 //! defines IGESCopiousData, Type <106> Form <1-3,11-13,63>
0033 //! in package IGESGeom
0034 //! This entity stores data points in the form of pairs,
0035 //! triples, or sextuples. An interpretation flag value
0036 //! signifies which of these forms is being used.
0037 class IGESGeom_CopiousData : public IGESData_IGESEntity
0038 {
0039
0040 public:
0041   Standard_EXPORT IGESGeom_CopiousData();
0042
0043   //! This method is used to set the fields of the class
0044   //! CopiousData
0045   //! - aDataType : Specifies whether data is a pair or a triple
0046   //! or a sextuple.
0047   //! - aZPlane   : Common Z value for all points if datatype = 1
0048   //! - allData   : Data to be read in groups of 2, 3 or 6
0049   Standard_EXPORT void Init(const Standard_Integer               aDataType,
0050                             const Standard_Real                  aZPlane,
0051                             const Handle(TColStd_HArray1OfReal)& allData);
0052
0053   //! Sets Copious Data to be a Polyline if <mode> is True
0054   //! (Form = 11-12-13) or a Set of Points else (Form 1-2-3)
0055   Standard_EXPORT void SetPolyline(const Standard_Boolean mode);
0056
0057   //! Sets Copious Data to be a Closed Path 2D (Form 63)
0058   //! Warning : DataType is not checked and must be set to ONE by Init
0059   Standard_EXPORT void SetClosedPath2D();
0060
0061   //! Returns True if <me> is a Set of Points (Form 1-2-3)
0062   Standard_EXPORT Standard_Boolean IsPointSet() const;
0063
0064   //! Returns True if <me> is a Polyline (Form 11-12-13)
0065   Standard_EXPORT Standard_Boolean IsPolyline() const;
0066
0067   //! Returns True if <me> is a Closed Path 2D (Form 63)
0068   Standard_EXPORT Standard_Boolean IsClosedPath2D() const;
0069
0070   //! returns data type
0071   //! 1 = XY ( with common Z given by plane)
0072   //! 2 = XYZ ( point)
0073   //! 3 = XYZ + Vec(XYZ) (point + normal vector)
0074   Standard_EXPORT Standard_Integer DataType() const;
0075
0076   //! returns the number of tuples
0077   Standard_EXPORT Standard_Integer NbPoints() const;
0078
0079   //! Returns an individual Data, given the N0 of the Point
0080   //! and the B0 of the Coordinate (according DataType)
0081   Standard_EXPORT Standard_Real Data(const Standard_Integer NumPoint,
0082                                      const Standard_Integer NumData) const;
0083
0084   //! If datatype = 1, then returns common z value for all data
0085   //! else returns 0
0086   Standard_EXPORT Standard_Real ZPlane() const;
0087
0088   //! returns the coordinates of the point specified by the anIndex
0089   //! raises exception if anIndex <= 0 or anIndex > NbPoints()
0090   Standard_EXPORT gp_Pnt Point(const Standard_Integer anIndex) const;
0091
0092   //! returns the coordinates of the point specified by the anIndex
0093   //! after applying Transf. Matrix
0094   //! raises exception if anIndex <= 0 or anIndex > NbPoints()
0095   Standard_EXPORT gp_Pnt TransformedPoint(const Standard_Integer anIndex) const;
0096
0097   //! returns i, j, k values if 3-tuple else returns (0, 0, 0)
0098   //! raises exception if anIndex <= 0 or anIndex > NbPoints()
0099   Standard_EXPORT gp_Vec Vector(const Standard_Integer anIndex) const;
0100
0101   //! returns transformed vector if 3-tuple else returns (0, 0, 0)
0102   //! raises exception if anIndex <= 0 or anIndex > NbPoints()
0103   Standard_EXPORT gp_Vec TransformedVector(const Standard_Integer anIndex) const;
0104
0105   DEFINE_STANDARD_RTTIEXT(IGESGeom_CopiousData, IGESData_IGESEntity)
0106
0107 protected:
0108 private:
0109   Standard_Integer              theDataType;
0110   Standard_Real                 theZPlane;
0111   Handle(TColStd_HArray1OfReal) theData;
0112 };
0113
0114 #endif // _IGESGeom_CopiousData_HeaderFile