Open CASCADE Technology  7.7.0.dev
Public Member Functions

BRepOffsetAPI_MakeDraft Class Reference

Build a draft surface along a wire. More...

#include <BRepOffsetAPI_MakeDraft.hxx>

Inheritance diagram for BRepOffsetAPI_MakeDraft:
Inheritance graph
[legend]

Public Member Functions

 BRepOffsetAPI_MakeDraft (const TopoDS_Shape &Shape, const gp_Dir &Dir, const Standard_Real Angle)
 Constructs the draft surface object defined by the shape Shape, the direction Dir, and the angle Angle. Shape must be a TopoDS_Wire, Topo_DS_Face or TopoDS_Shell with free boundaries. Exceptions Standard_NotDone if Shape is not a TopoDS_Wire, Topo_DS_Face or TopoDS_Shell with free boundaries. More...
 
void SetOptions (const BRepBuilderAPI_TransitionMode Style=BRepBuilderAPI_RightCorner, const Standard_Real AngleMin=0.01, const Standard_Real AngleMax=3.0)
 Sets the options of this draft tool. If a transition has to be performed, it can be defined by the mode Style as RightCorner or RoundCorner, RightCorner being a corner defined by a sharp angle, and RoundCorner being a rounded corner. AngleMin is an angular tolerance used to detect whether a transition has to be performed or not. AngleMax sets the maximum value within which a RightCorner transition can be performed. AngleMin and AngleMax are expressed in radians. More...
 
void SetDraft (const Standard_Boolean IsInternal=Standard_False)
 Sets the direction of the draft for this object. If IsInternal is true, the draft is internal to the argument Shape used in the constructor. More...
 
void Perform (const Standard_Real LengthMax)
 Performs the draft using the length LengthMax as the maximum length for the corner edge between two draft faces. More...
 
void Perform (const Handle< Geom_Surface > &Surface, const Standard_Boolean KeepInsideSurface=Standard_True)
 Performs the draft up to the surface Surface. If KeepInsideSurface is true, the part of Surface inside the draft is kept in the result. More...
 
void Perform (const TopoDS_Shape &StopShape, const Standard_Boolean KeepOutSide=Standard_True)
 Performs the draft up to the shape StopShape. If KeepOutSide is true, the part of StopShape which is outside the Draft is kept in the result. More...
 
TopoDS_Shell Shell () const
 Returns the shell resulting from performance of the draft along the wire. More...
 
virtual const TopTools_ListOfShapeGenerated (const TopoDS_Shape &S) override
 Returns the list of shapes generated from the shape . More...
 
- 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. More...
 
virtual const TopoDS_ShapeShape ()
 Returns a shape built by the shape construction algorithm. Raises exception StdFail_NotDone if the shape was not built. More...
 
 operator TopoDS_Shape ()
 
virtual const TopTools_ListOfShapeModified (const TopoDS_Shape &S)
 Returns the list of shapes modified from the shape . More...
 
virtual Standard_Boolean IsDeleted (const TopoDS_Shape &S)
 Returns true if the shape S has been deleted. More...
 
- Public Member Functions inherited from BRepBuilderAPI_Command
virtual ~BRepBuilderAPI_Command ()
 
virtual Standard_Boolean IsDone () const
 
void Check () const
 Raises NotDone if done is false. More...
 

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. More...
 
void Done ()
 Set done to true. More...
 
void NotDone ()
 Set done to false. More...
 
- Protected Attributes inherited from BRepBuilderAPI_MakeShape
TopoDS_Shape myShape
 
TopTools_ListOfShape myGenerated
 

Detailed Description

Build a draft surface along a wire.

Constructor & Destructor Documentation

◆ BRepOffsetAPI_MakeDraft()

BRepOffsetAPI_MakeDraft::BRepOffsetAPI_MakeDraft ( const TopoDS_Shape Shape,
const gp_Dir Dir,
const Standard_Real  Angle 
)

Constructs the draft surface object defined by the shape Shape, the direction Dir, and the angle Angle. Shape must be a TopoDS_Wire, Topo_DS_Face or TopoDS_Shell with free boundaries. Exceptions Standard_NotDone if Shape is not a TopoDS_Wire, Topo_DS_Face or TopoDS_Shell with free boundaries.

Member Function Documentation

◆ Generated()

virtual const TopTools_ListOfShape& BRepOffsetAPI_MakeDraft::Generated ( const TopoDS_Shape S)
overridevirtual

Returns the list of shapes generated from the shape .

Reimplemented from BRepBuilderAPI_MakeShape.

◆ Perform() [1/3]

void BRepOffsetAPI_MakeDraft::Perform ( const Handle< Geom_Surface > &  Surface,
const Standard_Boolean  KeepInsideSurface = Standard_True 
)

Performs the draft up to the surface Surface. If KeepInsideSurface is true, the part of Surface inside the draft is kept in the result.

◆ Perform() [2/3]

void BRepOffsetAPI_MakeDraft::Perform ( const Standard_Real  LengthMax)

Performs the draft using the length LengthMax as the maximum length for the corner edge between two draft faces.

◆ Perform() [3/3]

void BRepOffsetAPI_MakeDraft::Perform ( const TopoDS_Shape StopShape,
const Standard_Boolean  KeepOutSide = Standard_True 
)

Performs the draft up to the shape StopShape. If KeepOutSide is true, the part of StopShape which is outside the Draft is kept in the result.

◆ SetDraft()

void BRepOffsetAPI_MakeDraft::SetDraft ( const Standard_Boolean  IsInternal = Standard_False)

Sets the direction of the draft for this object. If IsInternal is true, the draft is internal to the argument Shape used in the constructor.

◆ SetOptions()

void BRepOffsetAPI_MakeDraft::SetOptions ( const BRepBuilderAPI_TransitionMode  Style = BRepBuilderAPI_RightCorner,
const Standard_Real  AngleMin = 0.01,
const Standard_Real  AngleMax = 3.0 
)

Sets the options of this draft tool. If a transition has to be performed, it can be defined by the mode Style as RightCorner or RoundCorner, RightCorner being a corner defined by a sharp angle, and RoundCorner being a rounded corner. AngleMin is an angular tolerance used to detect whether a transition has to be performed or not. AngleMax sets the maximum value within which a RightCorner transition can be performed. AngleMin and AngleMax are expressed in radians.

◆ Shell()

TopoDS_Shell BRepOffsetAPI_MakeDraft::Shell ( ) const

Returns the shell resulting from performance of the draft along the wire.


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