include/opencascade/GC_MakeTrimmedCylinder.hxx

0001 // Created on: 1992-09-28
0002 // Created by: Remi GILET
0003 // Copyright (c) 1992-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 _GC_MakeTrimmedCylinder_HeaderFile
0018 #define _GC_MakeTrimmedCylinder_HeaderFile
0019
0020 #include <Standard.hxx>
0021 #include <Standard_DefineAlloc.hxx>
0022 #include <Standard_Handle.hxx>
0023
0024 #include <GC_Root.hxx>
0025 #include <Geom_RectangularTrimmedSurface.hxx>
0026
0027 class gp_Pnt;
0028 class gp_Circ;
0029 class gp_Ax1;
0030
0031
0032 //! Implements construction algorithms for a trimmed
0033 //! cylinder limited by two planes orthogonal to its axis.
0034 //! The result is a Geom_RectangularTrimmedSurface surface.
0035 //! A MakeTrimmedCylinder provides a framework for:
0036 //! -   defining the construction of the trimmed cylinder,
0037 //! -   implementing the construction algorithm, and
0038 //! -   consulting the results. In particular, the Value
0039 //! function returns the constructed trimmed cylinder.
0040 class GC_MakeTrimmedCylinder  : public GC_Root
0041 {
0042 public:
0043
0044   DEFINE_STANDARD_ALLOC
0045
0046
0047   //! Make a cylindricalSurface <Cyl> from Geom
0048   //! Its axis is <P1P2> and its radius is the distance
0049   //! between <P3> and <P1P2>.
0050   //! The height is the distance between P1 and P2.
0051   Standard_EXPORT GC_MakeTrimmedCylinder(const gp_Pnt& P1, const gp_Pnt& P2, const gp_Pnt& P3);
0052
0053   //! Make a cylindricalSurface <Cyl> from gp by its base <Circ>.
0054   //! Its axis is the normal to the plane defined bi <Circ>.
0055   //! <Height> can be greater than zero or lower than zero.
0056   //! In the first case the V parametric direction of the
0057   //! result has the same orientation as the normal to <Circ>.
0058   //! In the other case it has the opposite orientation.
0059   Standard_EXPORT GC_MakeTrimmedCylinder(const gp_Circ& Circ, const Standard_Real Height);
0060
0061   //! Make a cylindricalSurface <Cyl> from gp by its
0062   //! axis <A1> and its radius <Radius>.
0063   //! It returns NullObject if <Radius> is lower than zero.
0064   //! <Height> can be greater than zero or lower than zero.
0065   //! In the first case the V parametric direction of the
0066   //! result has the same orientation as <A1>.
0067   //! In the other case it has the opposite orientation.
0068   Standard_EXPORT GC_MakeTrimmedCylinder(const gp_Ax1& A1, const Standard_Real Radius, const Standard_Real Height);
0069
0070   //! Returns the constructed trimmed cylinder.
0071   //! Exceptions
0072   //! StdFail_NotDone if no trimmed cylinder is constructed.
0073   Standard_EXPORT const Handle(Geom_RectangularTrimmedSurface)& Value() const;
0074
0075   operator const Handle(Geom_RectangularTrimmedSurface)& () const { return Value(); }
0076
0077 private:
0078   Handle(Geom_RectangularTrimmedSurface) TheCyl;
0079 };
0080
0081 #endif // _GC_MakeTrimmedCylinder_HeaderFile