Open CASCADE Technology 7.8.2.dev
ShapeFix_Shape Class Reference

Fixing shape in general. More...

#include <ShapeFix_Shape.hxx>

Inheritance diagram for ShapeFix_Shape:

Public Member Functions

 ShapeFix_Shape ()
 Empty Constructor.
 
 ShapeFix_Shape (const TopoDS_Shape &shape)
 Initislises by shape.
 
void Init (const TopoDS_Shape &shape)
 Initislises by shape.
 
Standard_Boolean Perform (const Message_ProgressRange &theProgress=Message_ProgressRange())
 Iterates on sub- shape and performs fixes.
 
TopoDS_Shape Shape () const
 Returns resulting shape.
 
Handle< ShapeFix_SolidFixSolidTool () const
 Returns tool for fixing solids.
 
Handle< ShapeFix_ShellFixShellTool () const
 Returns tool for fixing shells.
 
Handle< ShapeFix_FaceFixFaceTool () const
 Returns tool for fixing faces.
 
Handle< ShapeFix_WireFixWireTool () const
 Returns tool for fixing wires.
 
Handle< ShapeFix_EdgeFixEdgeTool () const
 Returns tool for fixing edges.
 
Standard_Boolean Status (const ShapeExtend_Status status) const
 Returns the status of the last Fix. This can be a combination of the following flags: ShapeExtend_DONE1: some free edges were fixed ShapeExtend_DONE2: some free wires were fixed ShapeExtend_DONE3: some free faces were fixed ShapeExtend_DONE4: some free shells were fixed ShapeExtend_DONE5: some free solids were fixed ShapeExtend_DONE6: shapes in compound(s) were fixed.
 
virtual void SetMsgRegistrator (const Handle< ShapeExtend_BasicMsgRegistrator > &msgreg) override
 Sets message registrator.
 
virtual void SetPrecision (const Standard_Real preci) override
 Sets basic precision value (also to FixSolidTool)
 
virtual void SetMinTolerance (const Standard_Real mintol) override
 Sets minimal allowed tolerance (also to FixSolidTool)
 
virtual void SetMaxTolerance (const Standard_Real maxtol) override
 Sets maximal allowed tolerance (also to FixSolidTool)
 
Standard_IntegerFixSolidMode ()
 Returns (modifiable) the mode for applying fixes of ShapeFix_Solid, by default True.
 
Standard_IntegerFixFreeShellMode ()
 Returns (modifiable) the mode for applying fixes of ShapeFix_Shell, by default True.
 
Standard_IntegerFixFreeFaceMode ()
 Returns (modifiable) the mode for applying fixes of ShapeFix_Face, by default True.
 
Standard_IntegerFixFreeWireMode ()
 Returns (modifiable) the mode for applying fixes of ShapeFix_Wire, by default True.
 
Standard_IntegerFixSameParameterMode ()
 Returns (modifiable) the mode for applying ShapeFix::SameParameter after all fixes, by default True.
 
Standard_IntegerFixVertexPositionMode ()
 Returns (modifiable) the mode for applying ShapeFix::FixVertexPosition before all fixes, by default False.
 
Standard_IntegerFixVertexTolMode ()
 Returns (modifiable) the mode for fixing tolerances of vertices on whole shape after performing all fixes.
 
- Public Member Functions inherited from ShapeFix_Root
 ShapeFix_Root ()
 Empty Constructor (no context is created)
 
virtual void Set (const Handle< ShapeFix_Root > &Root)
 Copy all fields from another Root object.
 
virtual void SetContext (const Handle< ShapeBuild_ReShape > &context)
 Sets context.
 
Handle< ShapeBuild_ReShapeContext () const
 Returns context.
 
Handle< ShapeExtend_BasicMsgRegistratorMsgRegistrator () const
 Returns message registrator.
 
Standard_Real Precision () const
 Returns basic precision value.
 
Standard_Real MinTolerance () const
 Returns minimal allowed tolerance.
 
Standard_Real MaxTolerance () const
 Returns maximal allowed tolerance.
 
Standard_Real LimitTolerance (const Standard_Real toler) const
 Returns tolerance limited by [myMinTol,myMaxTol].
 
void SendMsg (const TopoDS_Shape &shape, const Message_Msg &message, const Message_Gravity gravity=Message_Info) const
 Sends a message to be attached to the shape. Calls corresponding message of message registrator.
 
void SendMsg (const Message_Msg &message, const Message_Gravity gravity=Message_Info) const
 Sends a message to be attached to myShape. Calls previous method.
 
void SendWarning (const TopoDS_Shape &shape, const Message_Msg &message) const
 Sends a warning to be attached to the shape. Calls SendMsg with gravity set to Message_Warning.
 
void SendWarning (const Message_Msg &message) const
 Calls previous method for myShape.
 
void SendFail (const TopoDS_Shape &shape, const Message_Msg &message) const
 Sends a fail to be attached to the shape. Calls SendMsg with gravity set to Message_Fail.
 
void SendFail (const Message_Msg &message) const
 Calls previous method for myShape.
 
- Public Member Functions inherited from Standard_Transient
 Standard_Transient ()
 Empty constructor.
 
 Standard_Transient (const Standard_Transient &)
 Copy constructor – does nothing.
 
Standard_Transientoperator= (const Standard_Transient &)
 Assignment operator, needed to avoid copying reference counter.
 
virtual ~Standard_Transient ()
 Destructor must be virtual.
 
virtual const opencascade::handle< Standard_Type > & DynamicType () const
 Returns a type descriptor about this object.
 
Standard_Boolean IsInstance (const opencascade::handle< Standard_Type > &theType) const
 Returns a true value if this is an instance of Type.
 
Standard_Boolean IsInstance (const Standard_CString theTypeName) const
 Returns a true value if this is an instance of TypeName.
 
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.
 
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.
 
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.
 
Standard_Integer GetRefCount () const noexcept
 Get the reference counter of this object.
 
void IncrementRefCounter () noexcept
 Increments the reference counter of this object.
 
Standard_Integer DecrementRefCounter () noexcept
 Decrements the reference counter of this object; returns the decremented value.
 
virtual void Delete () const
 Memory deallocator for transient classes.
 

Protected Member Functions

void SameParameter (const TopoDS_Shape &shape, const Standard_Boolean enforce, const Message_ProgressRange &theProgress=Message_ProgressRange())
 Fixes same parameterization problem on the passed shape by updating tolerances of the corresponding topological entities.
 

Protected Attributes

TopoDS_Shape myResult
 
Handle< ShapeFix_SolidmyFixSolid
 
TopTools_MapOfShape myMapFixingShape
 
Standard_Integer myFixSolidMode
 
Standard_Integer myFixShellMode
 
Standard_Integer myFixFaceMode
 
Standard_Integer myFixWireMode
 
Standard_Integer myFixSameParameterMode
 
Standard_Integer myFixVertexPositionMode
 
Standard_Integer myFixVertexTolMode
 
Standard_Integer myStatus
 
- Protected Attributes inherited from ShapeFix_Root
TopoDS_Shape myShape
 

Additional Inherited Members

- Public Types inherited from Standard_Transient
typedef void base_type
 Returns a type descriptor about this object.
 
- Static Public Member Functions inherited from Standard_Transient
static constexpr const char * get_type_name ()
 Returns a type descriptor about this object.
 
static const opencascade::handle< Standard_Type > & get_type_descriptor ()
 Returns type descriptor of Standard_Transient class.
 
- Static Protected Member Functions inherited from ShapeFix_Root
static Standard_Boolean NeedFix (const Standard_Integer flag, const Standard_Boolean def=Standard_True)
 Auxiliary method for work with three-position (on/off/default) flags (modes) in ShapeFix.
 

Detailed Description

Fixing shape in general.

Constructor & Destructor Documentation

◆ ShapeFix_Shape() [1/2]

ShapeFix_Shape::ShapeFix_Shape ( )

Empty Constructor.

◆ ShapeFix_Shape() [2/2]

ShapeFix_Shape::ShapeFix_Shape ( const TopoDS_Shape & shape)

Initislises by shape.

Member Function Documentation

◆ FixEdgeTool()

Handle< ShapeFix_Edge > ShapeFix_Shape::FixEdgeTool ( ) const

Returns tool for fixing edges.

◆ FixFaceTool()

Handle< ShapeFix_Face > ShapeFix_Shape::FixFaceTool ( ) const

Returns tool for fixing faces.

◆ FixFreeFaceMode()

Standard_Integer & ShapeFix_Shape::FixFreeFaceMode ( )

Returns (modifiable) the mode for applying fixes of ShapeFix_Face, by default True.

◆ FixFreeShellMode()

Standard_Integer & ShapeFix_Shape::FixFreeShellMode ( )

Returns (modifiable) the mode for applying fixes of ShapeFix_Shell, by default True.

◆ FixFreeWireMode()

Standard_Integer & ShapeFix_Shape::FixFreeWireMode ( )

Returns (modifiable) the mode for applying fixes of ShapeFix_Wire, by default True.

◆ FixSameParameterMode()

Standard_Integer & ShapeFix_Shape::FixSameParameterMode ( )

Returns (modifiable) the mode for applying ShapeFix::SameParameter after all fixes, by default True.

◆ FixShellTool()

Handle< ShapeFix_Shell > ShapeFix_Shape::FixShellTool ( ) const

Returns tool for fixing shells.

◆ FixSolidMode()

Standard_Integer & ShapeFix_Shape::FixSolidMode ( )

Returns (modifiable) the mode for applying fixes of ShapeFix_Solid, by default True.

◆ FixSolidTool()

Handle< ShapeFix_Solid > ShapeFix_Shape::FixSolidTool ( ) const

Returns tool for fixing solids.

◆ FixVertexPositionMode()

Standard_Integer & ShapeFix_Shape::FixVertexPositionMode ( )

Returns (modifiable) the mode for applying ShapeFix::FixVertexPosition before all fixes, by default False.

◆ FixVertexTolMode()

Standard_Integer & ShapeFix_Shape::FixVertexTolMode ( )

Returns (modifiable) the mode for fixing tolerances of vertices on whole shape after performing all fixes.

◆ FixWireTool()

Handle< ShapeFix_Wire > ShapeFix_Shape::FixWireTool ( ) const

Returns tool for fixing wires.

◆ Init()

void ShapeFix_Shape::Init ( const TopoDS_Shape & shape)

Initislises by shape.

◆ Perform()

Standard_Boolean ShapeFix_Shape::Perform ( const Message_ProgressRange & theProgress = Message_ProgressRange())

Iterates on sub- shape and performs fixes.

◆ SameParameter()

void ShapeFix_Shape::SameParameter ( const TopoDS_Shape & shape,
const Standard_Boolean enforce,
const Message_ProgressRange & theProgress = Message_ProgressRange() )
protected

Fixes same parameterization problem on the passed shape by updating tolerances of the corresponding topological entities.

◆ SetMaxTolerance()

virtual void ShapeFix_Shape::SetMaxTolerance ( const Standard_Real maxtol)
overridevirtual

Sets maximal allowed tolerance (also to FixSolidTool)

Reimplemented from ShapeFix_Root.

◆ SetMinTolerance()

virtual void ShapeFix_Shape::SetMinTolerance ( const Standard_Real mintol)
overridevirtual

Sets minimal allowed tolerance (also to FixSolidTool)

Reimplemented from ShapeFix_Root.

◆ SetMsgRegistrator()

virtual void ShapeFix_Shape::SetMsgRegistrator ( const Handle< ShapeExtend_BasicMsgRegistrator > & msgreg)
overridevirtual

Sets message registrator.

Reimplemented from ShapeFix_Root.

◆ SetPrecision()

virtual void ShapeFix_Shape::SetPrecision ( const Standard_Real preci)
overridevirtual

Sets basic precision value (also to FixSolidTool)

Reimplemented from ShapeFix_Root.

◆ Shape()

TopoDS_Shape ShapeFix_Shape::Shape ( ) const

Returns resulting shape.

◆ Status()

Standard_Boolean ShapeFix_Shape::Status ( const ShapeExtend_Status status) const

Returns the status of the last Fix. This can be a combination of the following flags: ShapeExtend_DONE1: some free edges were fixed ShapeExtend_DONE2: some free wires were fixed ShapeExtend_DONE3: some free faces were fixed ShapeExtend_DONE4: some free shells were fixed ShapeExtend_DONE5: some free solids were fixed ShapeExtend_DONE6: shapes in compound(s) were fixed.

Field Documentation

◆ myFixFaceMode

Standard_Integer ShapeFix_Shape::myFixFaceMode
protected

◆ myFixSameParameterMode

Standard_Integer ShapeFix_Shape::myFixSameParameterMode
protected

◆ myFixShellMode

Standard_Integer ShapeFix_Shape::myFixShellMode
protected

◆ myFixSolid

Handle< ShapeFix_Solid > ShapeFix_Shape::myFixSolid
protected

◆ myFixSolidMode

Standard_Integer ShapeFix_Shape::myFixSolidMode
protected

◆ myFixVertexPositionMode

Standard_Integer ShapeFix_Shape::myFixVertexPositionMode
protected

◆ myFixVertexTolMode

Standard_Integer ShapeFix_Shape::myFixVertexTolMode
protected

◆ myFixWireMode

Standard_Integer ShapeFix_Shape::myFixWireMode
protected

◆ myMapFixingShape

TopTools_MapOfShape ShapeFix_Shape::myMapFixingShape
protected

◆ myResult

TopoDS_Shape ShapeFix_Shape::myResult
protected

◆ myStatus

Standard_Integer ShapeFix_Shape::myStatus
protected

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