EIC code displayed by LXR master/​include/​opencascade/​BRepPrimAPI_MakePrism.hxx	Source navigation Diff markup Identifier search General search
	Version: master test Revert   Change

File indexing completed on 2026-09-08 09:15:49

 // Created on: 1993-10-12
 // Created by: Remi LEQUETTE
 // Copyright (c) 1993-1999 Matra Datavision
 // Copyright (c) 1999-2014 OPEN CASCADE SAS
 //
 // This file is part of Open CASCADE Technology software library.
 //
 // This library is free software; you can redistribute it and/or modify it under
 // the terms of the GNU Lesser General Public License version 2.1 as published
 // by the Free Software Foundation, with special exception defined in the file
 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
 // distribution for complete text of the license and disclaimer of any warranty.
 //
 // Alternatively, this file may be used under the terms of Open CASCADE
 // commercial license or contractual agreement.
 
 #ifndef _BRepPrimAPI_MakePrism_HeaderFile
 #define _BRepPrimAPI_MakePrism_HeaderFile
 
 #include <Standard.hxx>
 #include <Standard_DefineAlloc.hxx>
 
 #include <BRepSweep_Prism.hxx>
 #include <BRepPrimAPI_MakeSweep.hxx>
 #include <TopTools_ListOfShape.hxx>
 class TopoDS_Shape;
 class gp_Vec;
 class gp_Dir;
 
 //! Describes functions to build linear swept topologies, called prisms.
 //! A prism is defined by:
 //! -   a basis shape, which is swept, and
 //! -   a sweeping direction, which is:
 //! -   a vector for finite prisms, or
 //! -   a direction for infinite or semi-infinite prisms.
 //! The basis shape must not contain any solids.
 //! The profile generates objects according to the following rules:
 //! -   Vertices generate Edges
 //! -   Edges generate Faces.
 //! -   Wires generate Shells.
 //! -   Faces generate Solids.
 //! -   Shells generate Composite Solids
 //! A MakePrism object provides a framework for:
 //! -   defining the construction of a prism,
 //! -   implementing the construction algorithm, and
 //! -   consulting the result.
 class BRepPrimAPI_MakePrism : public BRepPrimAPI_MakeSweep
 {
 public:
   DEFINE_STANDARD_ALLOC
 
   //! Builds the prism of base S and vector V. If C is true,
   //! S is copied. If Canonize is true then generated surfaces
   //! are attempted to be canonized in simple types
   Standard_EXPORT BRepPrimAPI_MakePrism(const TopoDS_Shape&    S,
                                         const gp_Vec&          V,
                                         const Standard_Boolean Copy     = Standard_False,
                                         const Standard_Boolean Canonize = Standard_True);
 
   //! Builds a semi-infinite or an infinite prism of base S.
   //! If Inf is true the prism  is infinite, if Inf is false
   //! the prism is semi-infinite (in the direction D).  If C
   //! is true S is copied (for semi-infinite prisms).
   //! If Canonize is true then generated surfaces
   //! are attempted to be canonized in simple types
   Standard_EXPORT BRepPrimAPI_MakePrism(const TopoDS_Shape&    S,
                                         const gp_Dir&          D,
                                         const Standard_Boolean Inf      = Standard_True,
                                         const Standard_Boolean Copy     = Standard_False,
                                         const Standard_Boolean Canonize = Standard_True);
 
   //! Returns the internal sweeping algorithm.
   Standard_EXPORT const BRepSweep_Prism& Prism() const;
 
   //! Builds the resulting shape (redefined from MakeShape).
   Standard_EXPORT virtual void Build(
     const Message_ProgressRange& theRange = Message_ProgressRange()) Standard_OVERRIDE;
 
   //! Returns the  TopoDS  Shape of the bottom of the prism.
   Standard_EXPORT TopoDS_Shape FirstShape() Standard_OVERRIDE;
 
   //! Returns the TopoDS Shape of the top of the prism.
   //! In the case of a finite prism, FirstShape returns the
   //! basis of the prism, in other words, S if Copy is false;
   //! otherwise, the copy of S belonging to the prism.
   //! LastShape returns the copy of S translated by V at the
   //! time of construction.
   Standard_EXPORT TopoDS_Shape LastShape() Standard_OVERRIDE;
 
   //! Returns ListOfShape from TopTools.
   Standard_EXPORT virtual const TopTools_ListOfShape& Generated(const TopoDS_Shape& S)
     Standard_OVERRIDE;
 
   //! Returns true if the shape S has been deleted.
   Standard_EXPORT virtual Standard_Boolean IsDeleted(const TopoDS_Shape& S) Standard_OVERRIDE;
 
   //! Returns the TopoDS Shape of the bottom  of the  prism.
   //! generated  with  theShape (subShape of the  generating shape).
   Standard_EXPORT TopoDS_Shape FirstShape(const TopoDS_Shape& theShape);
 
   //! Returns the  TopoDS  Shape of the top  of  the  prism.
   //! generated  with  theShape (subShape of the  generating shape).
   Standard_EXPORT TopoDS_Shape LastShape(const TopoDS_Shape& theShape);
 
 protected:
 private:
   BRepSweep_Prism myPrism;
 };
 
 #endif // _BRepPrimAPI_MakePrism_HeaderFile

This page was automatically generated by the 2.3.7 LXR engine. The LXR team