include/opencascade/IGESGraph_UniformRectGrid.hxx

0001 // Created on: 1993-01-09
0002 // Created by: CKY / Contract Toubro-Larsen ( TCD )
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 _IGESGraph_UniformRectGrid_HeaderFile
0018 #define _IGESGraph_UniformRectGrid_HeaderFile
0019
0020 #include <Standard.hxx>
0021 #include <Standard_Type.hxx>
0022
0023 #include <Standard_Integer.hxx>
0024 #include <gp_XY.hxx>
0025 #include <IGESData_IGESEntity.hxx>
0026 class gp_Pnt2d;
0027 class gp_Vec2d;
0028
0029
0030 class IGESGraph_UniformRectGrid;
0031 DEFINE_STANDARD_HANDLE(IGESGraph_UniformRectGrid, IGESData_IGESEntity)
0032
0033 //! defines IGESUniformRectGrid, Type <406> Form <22>
0034 //! in package IGESGraph
0035 //!
0036 //! Stores sufficient information for the creation of
0037 //! a uniform rectangular grid within a drawing
0038 class IGESGraph_UniformRectGrid : public IGESData_IGESEntity
0039 {
0040
0041 public:
0042
0043
0044   Standard_EXPORT IGESGraph_UniformRectGrid();
0045
0046   //! This method is used to set the fields of the class
0047   //! UniformRectGrid
0048   //! - nbProps      : Number of property values (NP = 9)
0049   //! - finite       : Finite/Infinite grid flag
0050   //! - line         : Line/Point grid flag
0051   //! - weighted     : Weighted/Unweighted grid flag
0052   //! - aGridPoint   : Point on the grid
0053   //! - aGridSpacing : Grid spacing
0054   //! - pointsX      : No. of points/lines in X Direction
0055   //! - pointsY      : No. of points/lines in Y Direction
0056   Standard_EXPORT void Init (const Standard_Integer nbProps, const Standard_Integer finite, const Standard_Integer line, const Standard_Integer weighted, const gp_XY& aGridPoint, const gp_XY& aGridSpacing, const Standard_Integer pointsX, const Standard_Integer pointsY);
0057
0058   //! returns the number of property values in <me>.
0059   Standard_EXPORT Standard_Integer NbPropertyValues() const;
0060
0061   //! returns False if <me> is an infinite grid,
0062   //! True  if <me> is a finite grid.
0063   Standard_EXPORT Standard_Boolean IsFinite() const;
0064
0065   //! returns False if <me> is a Point grid,
0066   //! True  if <me> is a Line grid.
0067   Standard_EXPORT Standard_Boolean IsLine() const;
0068
0069   //! returns False if <me> is a Weighted grid,
0070   //! True  if <me> is not a Weighted grid.
0071   Standard_EXPORT Standard_Boolean IsWeighted() const;
0072
0073   //! returns coordinates of lower left corner,
0074   //! if <me> is a finite grid,
0075   //! coordinates of an arbitrary point,
0076   //! if <me> is an infinite grid.
0077   Standard_EXPORT gp_Pnt2d GridPoint() const;
0078
0079   //! returns the grid-spacing in drawing coordinates.
0080   Standard_EXPORT gp_Vec2d GridSpacing() const;
0081
0082   //! returns the no. of points/lines in X direction
0083   //! (only applicable if IsFinite() = 1, i.e: a finite grid).
0084   Standard_EXPORT Standard_Integer NbPointsX() const;
0085
0086   //! returns the no. of points/lines in Y direction
0087   //! (only applicable if IsFinite() = 1, i.e: a finite grid).
0088   Standard_EXPORT Standard_Integer NbPointsY() const;
0089
0090
0091
0092
0093   DEFINE_STANDARD_RTTIEXT(IGESGraph_UniformRectGrid,IGESData_IGESEntity)
0094
0095 protected:
0096
0097
0098
0099
0100 private:
0101
0102
0103   Standard_Integer theNbPropertyValues;
0104   Standard_Integer isItFinite;
0105   Standard_Integer isItLine;
0106   Standard_Integer isItWeighted;
0107   gp_XY theGridPoint;
0108   gp_XY theGridSpacing;
0109   Standard_Integer theNbPointsX;
0110   Standard_Integer theNbPointsY;
0111
0112
0113 };
0114
0115
0116
0117
0118
0119
0120
0121 #endif // _IGESGraph_UniformRectGrid_HeaderFile