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
0027 class Draw_Grid;
0028 DEFINE_STANDARD_HANDLE(Draw_Grid, Draw_Drawable3D)
0029
0030
0031 class Draw_Grid : public Draw_Drawable3D
0032 {
0033
0034 public:
0035
0036
0037   //! Creates a grid.
0038   Standard_EXPORT Draw_Grid();
0039
0040   //! Sets the steps along the X, Y & Z axis.
0041   Standard_EXPORT void Steps (const Standard_Real StepX, const Standard_Real StepY, const Standard_Real StepZ);
0042
0043   //! Returns the step along the X axis.
0044     Standard_Real StepX() const;
0045
0046   //! Returns the step along the Y axis.
0047     Standard_Real StepY() const;
0048
0049   //! Returns the step along the Z axis.
0050     Standard_Real StepZ() const;
0051
0052   //! Returns if the grid is active or not.
0053     Standard_Boolean IsActive() const;
0054
0055   //! Displays the grid.
0056   Standard_EXPORT void DrawOn (Draw_Display& Out) const Standard_OVERRIDE;
0057
0058
0059
0060
0061   DEFINE_STANDARD_RTTIEXT(Draw_Grid,Draw_Drawable3D)
0062
0063 protected:
0064
0065
0066
0067
0068 private:
0069
0070
0071   Standard_Real myStepX;
0072   Standard_Real myStepY;
0073   Standard_Real myStepZ;
0074   Standard_Boolean myIsActive;
0075
0076
0077 };
0078
0079
0080 #include <Draw_Grid.lxx>
0081
0082
0083
0084
0085
0086 #endif // _Draw_Grid_HeaderFile