include/opencascade/BRepSweep_Prism.hxx

0001 // Created on: 1993-06-22
0002 // Created by: Laurent BOURESCHE
0003 // Copyright (c) 1993-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 _BRepSweep_Prism_HeaderFile
0018 #define _BRepSweep_Prism_HeaderFile
0019
0020 #include <Standard.hxx>
0021 #include <Standard_DefineAlloc.hxx>
0022 #include <Standard_Handle.hxx>
0023
0024 #include <BRepSweep_Translation.hxx>
0025 #include <Standard_Boolean.hxx>
0026 class TopoDS_Shape;
0027 class gp_Vec;
0028 class gp_Dir;
0029 class Sweep_NumShape;
0030 class TopLoc_Location;
0031
0032 //! Provides natural constructors to build BRepSweep
0033 //! translated swept Primitives.
0034 class BRepSweep_Prism
0035 {
0036 public:
0037   DEFINE_STANDARD_ALLOC
0038
0039   //! Builds the prism of base S and vector V. If C is true,
0040   //! S is copied. If Canonize is true then generated surfaces
0041   //! are attempted to be canonized in simple types
0042   Standard_EXPORT BRepSweep_Prism(const TopoDS_Shape& S,
0043                                   const gp_Vec&       V,
0044                                   const bool          Copy     = false,
0045                                   const bool          Canonize = true);
0046
0047   //! Builds a semi-infinite or an infinite prism of base S.
0048   //! If Copy is true S is copied. If Inf is true the prism
0049   //! is infinite, if Inf is false the prism is infinite in
0050   //! the direction D. If Canonize is true then generated surfaces
0051   //! are attempted to be canonized in simple types
0052   Standard_EXPORT BRepSweep_Prism(const TopoDS_Shape& S,
0053                                   const gp_Dir&       D,
0054                                   const bool          Inf      = true,
0055                                   const bool          Copy     = false,
0056                                   const bool          Canonize = true);
0057
0058   //! Returns the TopoDS Shape attached to the prism.
0059   Standard_EXPORT TopoDS_Shape Shape();
0060
0061   //! Returns the TopoDS Shape generated with aGenS
0062   //! (subShape of the generating shape).
0063   Standard_EXPORT TopoDS_Shape Shape(const TopoDS_Shape& aGenS);
0064
0065   //! Returns the TopoDS Shape of the bottom of the prism.
0066   Standard_EXPORT TopoDS_Shape FirstShape();
0067
0068   //! Returns the TopoDS Shape of the bottom of the prism.
0069   //! generated with aGenS (subShape of the generating
0070   //! shape).
0071   Standard_EXPORT TopoDS_Shape FirstShape(const TopoDS_Shape& aGenS);
0072
0073   //! Returns the TopoDS Shape of the top of the prism.
0074   Standard_EXPORT TopoDS_Shape LastShape();
0075
0076   //! Returns the TopoDS Shape of the top of the prism.
0077   //! generated with aGenS (subShape of the generating
0078   //! shape).
0079   Standard_EXPORT TopoDS_Shape LastShape(const TopoDS_Shape& aGenS);
0080
0081   //! Returns the Vector of the Prism, if it is an infinite
0082   //! prism the Vec is unitar.
0083   Standard_EXPORT gp_Vec Vec() const;
0084
0085   //! Returns true if the
0086   //! aGenS is used in resulting shape
0087   Standard_EXPORT bool IsUsed(const TopoDS_Shape& aGenS) const;
0088
0089   //! Returns true if the shape, generated from theS
0090   //! is used in result shape
0091   Standard_EXPORT bool GenIsUsed(const TopoDS_Shape& theS) const;
0092
0093 private:
0094   //! used to build the NumShape of a limited prism.
0095   Standard_EXPORT Sweep_NumShape NumShape() const;
0096
0097   //! used to build the NumShape of an infinite prism.
0098   Standard_EXPORT Sweep_NumShape NumShape(const bool Inf) const;
0099
0100   //! used to build the Location.
0101   Standard_EXPORT TopLoc_Location Location(const gp_Vec& V) const;
0102
0103   BRepSweep_Translation myTranslation;
0104 };
0105
0106 #endif // _BRepSweep_Prism_HeaderFile