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