include/opencascade/Draw_Grid.hxx

0001 // Created on: 1994-02-03
0002 // Created by: Jean Marc LACHAUME
0003 // Copyright (c) 1994-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 _Draw_Grid_HeaderFile
0018 #define _Draw_Grid_HeaderFile
0019
0020 #include <Standard.hxx>
0021 #include <Standard_Type.hxx>
0022
0023 #include <Draw_Drawable3D.hxx>
0024 class Draw_Display;
0025
0026 class Draw_Grid : public Draw_Drawable3D
0027 {
0028
0029 public:
0030   //! Creates a grid.
0031   Standard_EXPORT Draw_Grid();
0032
0033   //! Sets the steps along the X, Y & Z axis.
0034   Standard_EXPORT void Steps(const double StepX, const double StepY, const double StepZ);
0035
0036   //! Returns the step along the X axis.
0037   double StepX() const;
0038
0039   //! Returns the step along the Y axis.
0040   double StepY() const;
0041
0042   //! Returns the step along the Z axis.
0043   double StepZ() const;
0044
0045   //! Returns if the grid is active or not.
0046   bool IsActive() const;
0047
0048   //! Displays the grid.
0049   Standard_EXPORT void DrawOn(Draw_Display& Out) const override;
0050
0051   DEFINE_STANDARD_RTTIEXT(Draw_Grid, Draw_Drawable3D)
0052
0053 private:
0054   double myStepX;
0055   double myStepY;
0056   double myStepZ;
0057   bool   myIsActive;
0058 };
0059
0060 #include <Draw_Grid.lxx>
0061
0062 #endif // _Draw_Grid_HeaderFile