src/Draw/Draw_Grid.hxx

   1 // Created on: 1994-02-03
   2 // Created by: Jean Marc LACHAUME
   3 // Copyright (c) 1994-1999 Matra Datavision
   4 // Copyright (c) 1999-2014 OPEN CASCADE SAS
   5 //
   6 // This file is part of Open CASCADE Technology software library.
   7 //
   8 // This library is free software; you can redistribute it and/or modify it under
   9 // the terms of the GNU Lesser General Public License version 2.1 as published
  10 // by the Free Software Foundation, with special exception defined in the file
  11 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
  12 // distribution for complete text of the license and disclaimer of any warranty.
  13 //
  14 // Alternatively, this file may be used under the terms of Open CASCADE
  15 // commercial license or contractual agreement.
  16
  17 #ifndef _Draw_Grid_HeaderFile
  18 #define _Draw_Grid_HeaderFile
  19
  20 #include <Standard.hxx>
  21 #include <Standard_Type.hxx>
  22
  23 #include <Standard_Real.hxx>
  24 #include <Standard_Boolean.hxx>
  25 #include <Draw_Drawable3D.hxx>
  26 class Draw_Display;
  27
  28
  29 class Draw_Grid;
  30 DEFINE_STANDARD_HANDLE(Draw_Grid, Draw_Drawable3D)
  31
  32
  33 class Draw_Grid : public Draw_Drawable3D
  34 {
  35
  36 public:
  37
  38
  39   //! Creates a grid.
  40   Standard_EXPORT Draw_Grid();
  41
  42   //! Sets the steps along the X, Y & Z axis.
  43   Standard_EXPORT void Steps (const Standard_Real StepX, const Standard_Real StepY, const Standard_Real StepZ);
  44
  45   //! Returns the step along the X axis.
  46     Standard_Real StepX() const;
  47
  48   //! Returns the step along the Y axis.
  49     Standard_Real StepY() const;
  50
  51   //! Returns the step along the Z axis.
  52     Standard_Real StepZ() const;
  53
  54   //! Returns if the grid is active or not.
  55     Standard_Boolean IsActive() const;
  56
  57   //! Displays the grid.
  58   Standard_EXPORT void DrawOn (Draw_Display& Out) const Standard_OVERRIDE;
  59
  60
  61
  62
  63   DEFINE_STANDARD_RTTIEXT(Draw_Grid,Draw_Drawable3D)
  64
  65 protected:
  66
  67
  68
  69
  70 private:
  71
  72
  73   Standard_Real myStepX;
  74   Standard_Real myStepY;
  75   Standard_Real myStepZ;
  76   Standard_Boolean myIsActive;
  77
  78
  79 };
  80
  81
  82 #include <Draw_Grid.lxx>
  83
  84
  85
  86
  87
  88 #endif // _Draw_Grid_HeaderFile