Open CASCADE Technology 7.8.2.dev
BRepBuilderAPI_MakeShell Class Reference

Describes functions to build a shape corresponding to the skin of a surface. Note that the term shell in the class name has the same definition as that of a shell in STEP, in other words the skin of a shape, and not a solid model defined by surface and thickness. If you want to build the second sort of shell, you must use BRepOffsetAPI_MakeOffsetShape. A shell is made of a series of faces connected by their common edges. If the underlying surface of a face is not C2 continuous and the flag Segment is True, MakeShell breaks the surface down into several faces which are all C2 continuous and which are connected along the non-regular curves on the surface. The resulting shell contains all these faces. Construction of a Shell from a non-C2 continuous Surface A MakeShell object provides a framework for: More...

#include <BRepBuilderAPI_MakeShell.hxx>

Inheritance diagram for BRepBuilderAPI_MakeShell:

Public Member Functions

 BRepBuilderAPI_MakeShell ()
 Constructs an empty shell framework. The Init function is used to define the construction arguments. Warning The function Error will return BRepBuilderAPI_EmptyShell if it is called before the function Init.
 
 BRepBuilderAPI_MakeShell (const Handle< Geom_Surface > &S, const Standard_Boolean Segment=Standard_False)
 Constructs a shell from the surface S.
 
 BRepBuilderAPI_MakeShell (const Handle< Geom_Surface > &S, const Standard_Real UMin, const Standard_Real UMax, const Standard_Real VMin, const Standard_Real VMax, const Standard_Boolean Segment=Standard_False)
 Constructs a shell from the surface S, limited in the u parametric direction by the two parameter values UMin and UMax, and limited in the v parametric direction by the two parameter values VMin and VMax.
 
void Init (const Handle< Geom_Surface > &S, const Standard_Real UMin, const Standard_Real UMax, const Standard_Real VMin, const Standard_Real VMax, const Standard_Boolean Segment=Standard_False)
 Defines or redefines the arguments for the construction of a shell. The construction is initialized with the surface S, limited in the u parametric direction by the two parameter values UMin and UMax, and in the v parametric direction by the two parameter values VMin and VMax. Warning The function Error returns:
 
virtual Standard_Boolean IsDone () const override
 Returns true if the shell is built.
 
BRepBuilderAPI_ShellError Error () const
 Returns the construction status:
 
const TopoDS_ShellShell () const
 Returns the new Shell.
 
 operator TopoDS_Shell () const
 
- Public Member Functions inherited from BRepBuilderAPI_MakeShape
virtual void Build (const Message_ProgressRange &theRange=Message_ProgressRange())
 This is called by Shape(). It does nothing but may be redefined.
 
virtual const TopoDS_ShapeShape ()
 Returns a shape built by the shape construction algorithm. Raises exception StdFail_NotDone if the shape was not built.
 
 operator TopoDS_Shape ()
 
virtual const TopTools_ListOfShapeGenerated (const TopoDS_Shape &S)
 Returns the list of shapes generated from the shape .
 
virtual const TopTools_ListOfShapeModified (const TopoDS_Shape &S)
 Returns the list of shapes modified from the shape .
 
virtual Standard_Boolean IsDeleted (const TopoDS_Shape &S)
 Returns true if the shape S has been deleted.
 
- Public Member Functions inherited from BRepBuilderAPI_Command
virtual ~BRepBuilderAPI_Command ()
 
void Check () const
 Raises NotDone if done is false.
 

Additional Inherited Members

- Protected Member Functions inherited from BRepBuilderAPI_MakeShape
 BRepBuilderAPI_MakeShape ()
 
- Protected Member Functions inherited from BRepBuilderAPI_Command
 BRepBuilderAPI_Command ()
 Set done to False.
 
void Done ()
 Set done to true.
 
void NotDone ()
 Set done to false.
 
- Protected Attributes inherited from BRepBuilderAPI_MakeShape
TopoDS_Shape myShape
 
TopTools_ListOfShape myGenerated
 

Detailed Description

Describes functions to build a shape corresponding to the skin of a surface. Note that the term shell in the class name has the same definition as that of a shell in STEP, in other words the skin of a shape, and not a solid model defined by surface and thickness. If you want to build the second sort of shell, you must use BRepOffsetAPI_MakeOffsetShape. A shell is made of a series of faces connected by their common edges. If the underlying surface of a face is not C2 continuous and the flag Segment is True, MakeShell breaks the surface down into several faces which are all C2 continuous and which are connected along the non-regular curves on the surface. The resulting shell contains all these faces. Construction of a Shell from a non-C2 continuous Surface A MakeShell object provides a framework for:

  • defining the construction of a shell,
  • implementing the construction algorithm, and
  • consulting the result. Warning The connected C2 faces in the shell resulting from a decomposition of the surface are not sewn. For a sewn result, you need to use BRepOffsetAPI_Sewing. For a shell with thickness, you need to use BRepOffsetAPI_MakeOffsetShape.

Constructor & Destructor Documentation

◆ BRepBuilderAPI_MakeShell() [1/3]

BRepBuilderAPI_MakeShell::BRepBuilderAPI_MakeShell ( )

Constructs an empty shell framework. The Init function is used to define the construction arguments. Warning The function Error will return BRepBuilderAPI_EmptyShell if it is called before the function Init.

◆ BRepBuilderAPI_MakeShell() [2/3]

BRepBuilderAPI_MakeShell::BRepBuilderAPI_MakeShell ( const Handle< Geom_Surface > & S,
const Standard_Boolean Segment = Standard_False )

Constructs a shell from the surface S.

◆ BRepBuilderAPI_MakeShell() [3/3]

BRepBuilderAPI_MakeShell::BRepBuilderAPI_MakeShell ( const Handle< Geom_Surface > & S,
const Standard_Real UMin,
const Standard_Real UMax,
const Standard_Real VMin,
const Standard_Real VMax,
const Standard_Boolean Segment = Standard_False )

Constructs a shell from the surface S, limited in the u parametric direction by the two parameter values UMin and UMax, and limited in the v parametric direction by the two parameter values VMin and VMax.

Member Function Documentation

◆ Error()

BRepBuilderAPI_ShellError BRepBuilderAPI_MakeShell::Error ( ) const

Returns the construction status:

  • BRepBuilderAPI_ShellDone if the shell is built, or
  • another value of the BRepBuilderAPI_ShellError enumeration indicating why the construction failed. This is frequently BRepBuilderAPI_ShellParametersOutOfRange indicating that the given parameters are outside the bounds of the surface.

◆ Init()

void BRepBuilderAPI_MakeShell::Init ( const Handle< Geom_Surface > & S,
const Standard_Real UMin,
const Standard_Real UMax,
const Standard_Real VMin,
const Standard_Real VMax,
const Standard_Boolean Segment = Standard_False )

Defines or redefines the arguments for the construction of a shell. The construction is initialized with the surface S, limited in the u parametric direction by the two parameter values UMin and UMax, and in the v parametric direction by the two parameter values VMin and VMax. Warning The function Error returns:

  • BRepBuilderAPI_ShellParametersOutOfRange when the given parameters are outside the bounds of the surface or the basis surface if S is trimmed

◆ IsDone()

virtual Standard_Boolean BRepBuilderAPI_MakeShell::IsDone ( ) const
overridevirtual

Returns true if the shell is built.

Reimplemented from BRepBuilderAPI_Command.

◆ operator TopoDS_Shell()

BRepBuilderAPI_MakeShell::operator TopoDS_Shell ( ) const

◆ Shell()

const TopoDS_Shell & BRepBuilderAPI_MakeShell::Shell ( ) const

Returns the new Shell.


The documentation for this class was generated from the following file: