src/Aspect/Aspect_CircularGrid.hxx

   1 // Created on: 1995-03-17
   2 // Created by: Mister rmi
   3 // Copyright (c) 1995-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 _Aspect_CircularGrid_HeaderFile
  18 #define _Aspect_CircularGrid_HeaderFile
  19
  20 #include <Standard.hxx>
  21 #include <Standard_Type.hxx>
  22
  23 #include <Standard_Integer.hxx>
  24 #include <Standard_Real.hxx>
  25 #include <Aspect_Grid.hxx>
  26
  27 class Standard_NegativeValue;
  28 class Standard_NullValue;
  29 class Standard_NumericError;
  30
  31 class Aspect_CircularGrid;
  32 DEFINE_STANDARD_HANDLE(Aspect_CircularGrid, Aspect_Grid)
  33
  34 class Aspect_CircularGrid : public Aspect_Grid
  35 {
  36
  37 public:
  38
  39   //! creates a new grid. By default this grid is not
  40   //! active.
  41   Standard_EXPORT Aspect_CircularGrid(const Standard_Real aRadiusStep, const Standard_Integer aDivisionNumber, const Standard_Real XOrigin = 0, const Standard_Real anYOrigin = 0, const Standard_Real aRotationAngle = 0);
  42
  43   //! defines the x step of the grid.
  44   Standard_EXPORT void SetRadiusStep (const Standard_Real aStep);
  45
  46   //! defines the step of the grid.
  47   Standard_EXPORT void SetDivisionNumber (const Standard_Integer aNumber);
  48
  49   Standard_EXPORT void SetGridValues (const Standard_Real XOrigin, const Standard_Real YOrigin, const Standard_Real RadiusStep, const Standard_Integer DivisionNumber, const Standard_Real RotationAngle);
  50
  51   //! returns the point of the grid the closest to the point X,Y
  52   Standard_EXPORT void Compute (const Standard_Real X, const Standard_Real Y, Standard_Real& gridX, Standard_Real& gridY) const Standard_OVERRIDE;
  53
  54   //! returns the x step of the grid.
  55   Standard_EXPORT Standard_Real RadiusStep() const;
  56
  57   //! returns the x step of the grid.
  58   Standard_EXPORT Standard_Integer DivisionNumber() const;
  59
  60   Standard_EXPORT void Init() Standard_OVERRIDE;
  61
  62   DEFINE_STANDARD_RTTIEXT(Aspect_CircularGrid,Aspect_Grid)
  63
  64 private:
  65
  66   Standard_Real myRadiusStep;
  67   Standard_Integer myDivisionNumber;
  68   Standard_Real myAlpha;
  69   Standard_Real myA1;
  70   Standard_Real myB1;
  71
  72 };
  73
  74 #endif // _Aspect_CircularGrid_HeaderFile