Open CASCADE Technology  6.7.1
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Member Functions | Protected Member Functions | Protected Attributes
BRepBuilderAPI_ModifyShape Class Reference

Implements the methods of MakeShape for the
constant topology modifications. The methods are
implemented when the modification uses a Modifier
from BRepTools. Some of them have to be redefined
if the modification is implemented with another
tool (see Transform from BRepBuilderAPI for example).
The BRepBuilderAPI package provides the following
frameworks to perform modifications of this sort:
More...

#include <BRepBuilderAPI_ModifyShape.hxx>

Inheritance diagram for BRepBuilderAPI_ModifyShape:
Inheritance graph
[legend]

Public Member Functions

virtual const
TopTools_ListOfShape
Modified (const TopoDS_Shape &S)
 Returns the list of shapes modified from the shape
<S>.
More...
 
virtual const TopoDS_ShapeModifiedShape (const TopoDS_Shape &S) const
 
 Returns the modified shape corresponding to <S>. <br>

S can correspond to the entire initial shape or to its subshape.
Exceptions
Standard_NoSuchObject if S is not the initial shape or
a subshape of the initial shape to which the
transformation has been applied. Raises NoSuchObject from Standard
if S is not the initial shape or a sub-shape
of the initial shape.
More...

 
- Public Member Functions inherited from BRepBuilderAPI_MakeShape
virtual void Delete ()
 
virtual ~BRepBuilderAPI_MakeShape ()
 
virtual void Build ()
 This is called by Shape(). It does nothing but
may be redefined.
More...
 
const TopoDS_ShapeShape () const
 
 Returns a shape built by the shape construction algorithm. <br>

Raises exception StdFail_NotDone if the shape was not built.
More...

 
 operator TopoDS_Shape () const
 
virtual const
TopTools_ListOfShape
Generated (const TopoDS_Shape &S)
 Returns the list of shapes generated from the
shape <S>.
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...
 

Protected Member Functions

 BRepBuilderAPI_ModifyShape ()
 Empty constructor.
More...
 
 BRepBuilderAPI_ModifyShape (const TopoDS_Shape &S)
 Initializes the modifier with the Shape <S>, and
set the field <myInitialShape> to <S>.
More...
 
 BRepBuilderAPI_ModifyShape (const Handle< BRepTools_Modification > &M)
 Set the field <myModification> with <M>.
More...
 
 BRepBuilderAPI_ModifyShape (const TopoDS_Shape &S, const Handle< BRepTools_Modification > &M)
 Initializes the modifier with the Shape <S>, and
set the field <myInitialShape> to <S>, and set the
field <myModification> with <M>, the performs the
modification.
More...
 
void DoModif (const TopoDS_Shape &S)
 Performs the previously given modification on the
shape <S>.
More...
 
void DoModif (const Handle< BRepTools_Modification > &M)
 Performs the modification <M> on a previously
given shape.
More...
 
void DoModif (const TopoDS_Shape &S, const Handle< BRepTools_Modification > &M)
 Performs the modification <M> on the shape <S>.
More...
 
- 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

BRepTools_Modifier myModifier
 
TopoDS_Shape myInitialShape
 
Handle_BRepTools_Modification myModification
 
- Protected Attributes inherited from BRepBuilderAPI_MakeShape
TopoDS_Shape myShape
 
TopTools_ListOfShape myGenerated
 

Detailed Description

Implements the methods of MakeShape for the
constant topology modifications. The methods are
implemented when the modification uses a Modifier
from BRepTools. Some of them have to be redefined
if the modification is implemented with another
tool (see Transform from BRepBuilderAPI for example).
The BRepBuilderAPI package provides the following
frameworks to perform modifications of this sort:

Constructor & Destructor Documentation

BRepBuilderAPI_ModifyShape::BRepBuilderAPI_ModifyShape ( )
protected

Empty constructor.

BRepBuilderAPI_ModifyShape::BRepBuilderAPI_ModifyShape ( const TopoDS_Shape S)
protected

Initializes the modifier with the Shape <S>, and
set the field <myInitialShape> to <S>.

BRepBuilderAPI_ModifyShape::BRepBuilderAPI_ModifyShape ( const Handle< BRepTools_Modification > &  M)
protected

Set the field <myModification> with <M>.

BRepBuilderAPI_ModifyShape::BRepBuilderAPI_ModifyShape ( const TopoDS_Shape S,
const Handle< BRepTools_Modification > &  M 
)
protected

Initializes the modifier with the Shape <S>, and
set the field <myInitialShape> to <S>, and set the
field <myModification> with <M>, the performs the
modification.

Member Function Documentation

void BRepBuilderAPI_ModifyShape::DoModif ( const TopoDS_Shape S)
protected

Performs the previously given modification on the
shape <S>.

void BRepBuilderAPI_ModifyShape::DoModif ( const Handle< BRepTools_Modification > &  M)
protected

Performs the modification <M> on a previously
given shape.

void BRepBuilderAPI_ModifyShape::DoModif ( const TopoDS_Shape S,
const Handle< BRepTools_Modification > &  M 
)
protected

Performs the modification <M> on the shape <S>.

virtual const TopTools_ListOfShape& BRepBuilderAPI_ModifyShape::Modified ( const TopoDS_Shape S)
virtual

Returns the list of shapes modified from the shape
<S>.

Reimplemented from BRepBuilderAPI_MakeShape.

Reimplemented in BRepOffsetAPI_DraftAngle, BRepBuilderAPI_GTransform, and BRepBuilderAPI_Transform.

virtual const TopoDS_Shape& BRepBuilderAPI_ModifyShape::ModifiedShape ( const TopoDS_Shape S) const
virtual

 Returns the modified shape corresponding to <S>. <br>

S can correspond to the entire initial shape or to its subshape.
Exceptions
Standard_NoSuchObject if S is not the initial shape or
a subshape of the initial shape to which the
transformation has been applied. Raises NoSuchObject from Standard
if S is not the initial shape or a sub-shape
of the initial shape.

Reimplemented in BRepBuilderAPI_GTransform, and BRepBuilderAPI_Transform.

Field Documentation

TopoDS_Shape BRepBuilderAPI_ModifyShape::myInitialShape
protected
Handle_BRepTools_Modification BRepBuilderAPI_ModifyShape::myModification
protected
BRepTools_Modifier BRepBuilderAPI_ModifyShape::myModifier
protected

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