Open CASCADE Technology  7.3.1.dev
Data Structures | Public Member Functions | Protected Types | Protected Member Functions | Protected Attributes
BRepTools_ReShape Class Reference

Rebuilds a Shape by making pre-defined substitutions on some of its components. More...

#include <BRepTools_ReShape.hxx>

Inheritance diagram for BRepTools_ReShape:
Inheritance graph
[legend]

Public Member Functions

 BRepTools_ReShape ()
 Returns an empty Reshape. More...
 
virtual void Clear ()
 Clears all substitutions requests. More...
 
virtual void Remove (const TopoDS_Shape &shape)
 Sets a request to Remove a Shape whatever the orientation. More...
 
virtual void Replace (const TopoDS_Shape &shape, const TopoDS_Shape &newshape)
 Sets a request to Replace a Shape by a new one. More...
 
template<typename TCollection >
void Merge (const TCollection &theParts, const TopoDS_Shape &theProduct)
 Merges the parts to the single product. The first part is replaced by the product. The other parts are removed. The history of the merged shapes is presented by equal ways. More...
 
virtual Standard_Boolean IsRecorded (const TopoDS_Shape &shape) const
 Tells if a shape is recorded for Replace/Remove. More...
 
virtual TopoDS_Shape Value (const TopoDS_Shape &shape) const
 Returns the new value for an individual shape If not recorded, returns the original shape itself If to be Removed, returns a Null Shape Else, returns the replacing item. More...
 
virtual Standard_Integer Status (const TopoDS_Shape &shape, TopoDS_Shape &newsh, const Standard_Boolean last=Standard_False)
 Returns a complete substitution status for a shape 0 : not recorded, <newsh> = original <shape> < 0: to be removed, <newsh> is NULL

0: to be replaced, <newsh> is a new item

If <last> is False, returns status and new shape recorded in the map directly for the shape, if True and status > 0 then recursively searches for the last status and new shape. More...

 
virtual TopoDS_Shape Apply (const TopoDS_Shape &shape, const TopAbs_ShapeEnum until=TopAbs_SHAPE)
 Applies the substitutions requests to a shape. More...
 
virtual Standard_BooleanModeConsiderLocation ()
 Returns (modifiable) the flag which defines whether Location of shape take into account during replacing shapes. More...
 
TopoDS_Vertex CopyVertex (const TopoDS_Vertex &theV, const Standard_Real theTol=-1.0)
 Returns modified copy of vertex if original one is not recorded or returns modified original vertex otherwise. More...
 
TopoDS_Vertex CopyVertex (const TopoDS_Vertex &theV, const gp_Pnt &theNewPos, const Standard_Real aTol)
 Returns modified copy of vertex if original one is not recorded or returns modified original vertex otherwise. More...
 
Standard_Boolean IsNewShape (const TopoDS_Shape &theShape) const
 Checks if shape has been recorded by reshaper as a value. More...
 
Handle< BRepTools_HistoryHistory () const
 Returns the history of the substituted shapes. More...
 
- Public Member Functions inherited from Standard_Transient
 Standard_Transient ()
 Empty constructor. More...
 
 Standard_Transient (const Standard_Transient &)
 Copy constructor – does nothing. More...
 
Standard_Transientoperator= (const Standard_Transient &)
 Assignment operator, needed to avoid copying reference counter. More...
 
virtual ~Standard_Transient ()
 Destructor must be virtual. More...
 
virtual void Delete () const
 Memory deallocator for transient classes. More...
 
virtual const opencascade::handle< Standard_Type > & DynamicType () const
 Returns a type descriptor about this object. More...
 
Standard_Boolean IsInstance (const opencascade::handle< Standard_Type > &theType) const
 Returns a true value if this is an instance of Type. More...
 
Standard_Boolean IsInstance (const Standard_CString theTypeName) const
 Returns a true value if this is an instance of TypeName. More...
 
Standard_Boolean IsKind (const opencascade::handle< Standard_Type > &theType) const
 Returns true if this is an instance of Type or an instance of any class that inherits from Type. Note that multiple inheritance is not supported by OCCT RTTI mechanism. More...
 
Standard_Boolean IsKind (const Standard_CString theTypeName) const
 Returns true if this is an instance of TypeName or an instance of any class that inherits from TypeName. Note that multiple inheritance is not supported by OCCT RTTI mechanism. More...
 
Standard_TransientThis () const
 Returns non-const pointer to this object (like const_cast). For protection against creating handle to objects allocated in stack or call from constructor, it will raise exception Standard_ProgramError if reference counter is zero. More...
 
Standard_Integer GetRefCount () const
 Get the reference counter of this object. More...
 
void IncrementRefCounter () const
 Increments the reference counter of this object. More...
 
Standard_Integer DecrementRefCounter () const
 Decrements the reference counter of this object; returns the decremented value. More...
 

Protected Types

enum  TReplacementKind { TReplacementKind_Remove = 1, TReplacementKind_Modify = 2, TReplacementKind_Merge_Main = 4, TReplacementKind_Merge_Ordinary = 8 }
 The kinds of the replacements. More...
 

Protected Member Functions

virtual void replace (const TopoDS_Shape &shape, const TopoDS_Shape &newshape, const TReplacementKind theKind)
 Replaces the first shape by the second one after the following reorientation. More...
 

Protected Attributes

TopTools_MapOfShape myNewShapes
 
Standard_Integer myStatus
 

Additional Inherited Members

- Public Types inherited from Standard_Transient
typedef void base_type
 Returns a type descriptor about this object. More...
 
- Static Public Member Functions inherited from Standard_Transient
static const char * get_type_name ()
 Returns a type descriptor about this object. More...
 
static const opencascade::handle< Standard_Type > & get_type_descriptor ()
 Returns type descriptor of Standard_Transient class. More...
 

Detailed Description

Rebuilds a Shape by making pre-defined substitutions on some of its components.

In a first phase, it records requests to replace or remove some individual shapes For each shape, the last given request is recorded Requests may be applied "Oriented" (i.e. only to an item with the SAME orientation) or not (the orientation of replacing shape is respectful of that of the original one)

Then, these requests may be applied to any shape which may contain one or more of these individual shapes

Supports the 'BRepTools_History' history by method 'History'.

Member Enumeration Documentation

◆ TReplacementKind

The kinds of the replacements.

Enumerator
TReplacementKind_Remove 
TReplacementKind_Modify 
TReplacementKind_Merge_Main 
TReplacementKind_Merge_Ordinary 

Constructor & Destructor Documentation

◆ BRepTools_ReShape()

BRepTools_ReShape::BRepTools_ReShape ( )

Returns an empty Reshape.

Member Function Documentation

◆ Apply()

virtual TopoDS_Shape BRepTools_ReShape::Apply ( const TopoDS_Shape shape,
const TopAbs_ShapeEnum  until = TopAbs_SHAPE 
)
virtual

Applies the substitutions requests to a shape.

<until> gives the level of type until which requests are taken into account. For subshapes of the type <until> no rebuild and futher exploring are done.

NOTE: each subshape can be replaced by shape of the same type or by shape containing only shapes of that type (for example, TopoDS_Edge can be replaced by TopoDS_Edge, TopoDS_Wire or TopoDS_Compound containing TopoDS_Edges). If incompatible shape type is encountered, it is ignored and flag FAIL1 is set in Status.

Reimplemented in ShapeBuild_ReShape.

◆ Clear()

virtual void BRepTools_ReShape::Clear ( )
virtual

Clears all substitutions requests.

◆ CopyVertex() [1/2]

TopoDS_Vertex BRepTools_ReShape::CopyVertex ( const TopoDS_Vertex theV,
const Standard_Real  theTol = -1.0 
)

Returns modified copy of vertex if original one is not recorded or returns modified original vertex otherwise.

◆ CopyVertex() [2/2]

TopoDS_Vertex BRepTools_ReShape::CopyVertex ( const TopoDS_Vertex theV,
const gp_Pnt theNewPos,
const Standard_Real  aTol 
)

Returns modified copy of vertex if original one is not recorded or returns modified original vertex otherwise.

◆ History()

Handle< BRepTools_History > BRepTools_ReShape::History ( ) const

Returns the history of the substituted shapes.

◆ IsNewShape()

Standard_Boolean BRepTools_ReShape::IsNewShape ( const TopoDS_Shape theShape) const

Checks if shape has been recorded by reshaper as a value.

◆ IsRecorded()

virtual Standard_Boolean BRepTools_ReShape::IsRecorded ( const TopoDS_Shape shape) const
virtual

Tells if a shape is recorded for Replace/Remove.

◆ Merge()

template<typename TCollection >
void BRepTools_ReShape::Merge ( const TCollection theParts,
const TopoDS_Shape theProduct 
)
inline

Merges the parts to the single product. The first part is replaced by the product. The other parts are removed. The history of the merged shapes is presented by equal ways.

◆ ModeConsiderLocation()

virtual Standard_Boolean& BRepTools_ReShape::ModeConsiderLocation ( )
inlinevirtual

Returns (modifiable) the flag which defines whether Location of shape take into account during replacing shapes.

◆ Remove()

virtual void BRepTools_ReShape::Remove ( const TopoDS_Shape shape)
virtual

Sets a request to Remove a Shape whatever the orientation.

◆ Replace()

virtual void BRepTools_ReShape::Replace ( const TopoDS_Shape shape,
const TopoDS_Shape newshape 
)
inlinevirtual

Sets a request to Replace a Shape by a new one.

◆ replace()

virtual void BRepTools_ReShape::replace ( const TopoDS_Shape shape,
const TopoDS_Shape newshape,
const TReplacementKind  theKind 
)
protectedvirtual

Replaces the first shape by the second one after the following reorientation.

If the first shape has the reversed orientation then the both shapes are reversed. If the first shape has the internal or external orientation then:

  • the second shape is oriented forward (reversed) if it's orientation is equal (not equal) to the orientation of the first shape;
  • the first shape is oriented forward.

◆ Status()

virtual Standard_Integer BRepTools_ReShape::Status ( const TopoDS_Shape shape,
TopoDS_Shape newsh,
const Standard_Boolean  last = Standard_False 
)
virtual

Returns a complete substitution status for a shape 0 : not recorded, <newsh> = original <shape> < 0: to be removed, <newsh> is NULL

0: to be replaced, <newsh> is a new item

If <last> is False, returns status and new shape recorded in the map directly for the shape, if True and status > 0 then recursively searches for the last status and new shape.

Reimplemented in ShapeBuild_ReShape.

◆ Value()

virtual TopoDS_Shape BRepTools_ReShape::Value ( const TopoDS_Shape shape) const
virtual

Returns the new value for an individual shape If not recorded, returns the original shape itself If to be Removed, returns a Null Shape Else, returns the replacing item.

Field Documentation

◆ myNewShapes

TopTools_MapOfShape BRepTools_ReShape::myNewShapes
protected

◆ myStatus

Standard_Integer BRepTools_ReShape::myStatus
protected

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