include/opencascade/HelixGeom_BuilderHelix.hxx

0001 // Copyright (c) 2025 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 _HelixGeom_BuilderHelix_HeaderFile
0015 #define _HelixGeom_BuilderHelix_HeaderFile
0016
0017 #include <Standard.hxx>
0018 #include <Standard_DefineAlloc.hxx>
0019 #include <Standard_Handle.hxx>
0020
0021 #include <gp_Ax2.hxx>
0022 #include <HelixGeom_BuilderHelixGen.hxx>
0023 class gp_Ax2;
0024
0025 //! Upper level class for geometrical algorithm of building
0026 //! helix curves using arbitrary axis
0027 class HelixGeom_BuilderHelix : public HelixGeom_BuilderHelixGen
0028 {
0029 public:
0030   DEFINE_STANDARD_ALLOC
0031
0032   //! Empty constructor
0033   Standard_EXPORT HelixGeom_BuilderHelix();
0034   Standard_EXPORT ~HelixGeom_BuilderHelix() override;
0035
0036   //! Sets coordinate axes for helix
0037   Standard_EXPORT void SetPosition(const gp_Ax2& aAx2);
0038
0039   //! Gets coordinate axes for helix
0040   Standard_EXPORT const gp_Ax2& Position() const;
0041
0042   //! Performs calculations
0043   Standard_EXPORT void Perform() override;
0044
0045 protected:
0046   gp_Ax2 myPosition;
0047 };
0048
0049 #endif // _HelixGeom_BuilderHelix_HeaderFile