include/opencascade/StepData_Factors.hxx

0001 // Copyright (c) 2021 OPEN CASCADE SAS
0002 //
0003 // This file is part of Open CASCADE Technology software library.
0004 //
0005 // This library is free software; you can redistribute it and/or modify it under
0006 // the terms of the GNU Lesser General Public License version 2.1 as published
0007 // by the Free Software Foundation, with special exception defined in the file
0008 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
0009 // distribution for complete text of the license and disclaimer of any warranty.
0010 //
0011 // Alternatively, this file may be used under the terms of Open CASCADE
0012 // commercial license or contractual agreement.
0013
0014 #ifndef _StepData_Factors_HeaderFile
0015 #define _StepData_Factors_HeaderFile
0016
0017 #include <Standard.hxx>
0018 #include <Standard_DefineAlloc.hxx>
0019 #include <Standard_Handle.hxx>
0020 #include <Standard_Real.hxx>
0021 #include <Standard_Boolean.hxx>
0022
0023 //! Class for using units variables
0024 class StepData_Factors
0025 {
0026 public:
0027   DEFINE_STANDARD_ALLOC
0028
0029   //! Constructor
0030   Standard_EXPORT StepData_Factors();
0031
0032   //! Initializes the 3 factors for the conversion of units
0033   Standard_EXPORT void InitializeFactors(const double theLengthFactor,
0034                                          const double thePlaneAngleFactor,
0035                                          const double theSolidAngleFactor);
0036
0037   //! Sets length unit for current transfer process
0038   Standard_EXPORT void SetCascadeUnit(const double theUnit);
0039
0040   //! Returns length unit for current transfer process (mm by default)
0041   Standard_EXPORT double CascadeUnit() const;
0042
0043   //! Returns transient length factor for scaling of shapes
0044   //! at one stage of transfer process
0045   Standard_EXPORT double LengthFactor() const;
0046
0047   //! Returns transient plane angle factor for conversion of angles
0048   //! at one stage of transfer process
0049   Standard_EXPORT double PlaneAngleFactor() const;
0050
0051   //! Returns transient solid angle factor for conversion of angles
0052   //! at one stage of transfer process
0053   Standard_EXPORT double SolidAngleFactor() const;
0054
0055   //! Returns transient factor radian degree for conversion of angles
0056   //! at one stage of transfer process
0057   Standard_EXPORT double FactorRadianDegree() const;
0058
0059   //! Returns transient factor degree radian for conversion of angles
0060   //! at one stage of transfer process
0061   Standard_EXPORT double FactorDegreeRadian() const;
0062
0063 private:
0064   double myLengthFactor;
0065   double myPlaneAngleFactor;
0066   double mySolidAngleFactor;
0067   double myFactRD;
0068   double myFactDR;
0069   double myCascadeUnit;
0070 };
0071
0072 #endif // _StepData_Factors_HeaderFile