Open CASCADE Technology  7.3.0
Public Member Functions | Protected Attributes

ShapeFix_Face Class Reference

This operator allows to perform various fixes on face and its wires: fixes provided by ShapeFix_Wire, fixing orientation of wires, addition of natural bounds, fixing of missing seam edge, and detection and removal of null-area wires. More...

#include <ShapeFix_Face.hxx>

Inheritance diagram for ShapeFix_Face:
Inheritance graph
[legend]

Public Member Functions

 ShapeFix_Face ()
 Creates an empty tool. More...
 
 ShapeFix_Face (const TopoDS_Face &face)
 Creates a tool and loads a face. More...
 
virtual void ClearModes ()
 Sets all modes to default. More...
 
void Init (const TopoDS_Face &face)
 Loads a whole face already created, with its wires, sense and location. More...
 
void Init (const Handle< Geom_Surface > &surf, const Standard_Real preci, const Standard_Boolean fwd=Standard_True)
 Starts the creation of the face By default it will be FORWARD, or REVERSED if <fwd> is False. More...
 
void Init (const Handle< ShapeAnalysis_Surface > &surf, const Standard_Real preci, const Standard_Boolean fwd=Standard_True)
 Starts the creation of the face By default it will be FORWARD, or REVERSED if <fwd> is False. More...
 
virtual void SetMsgRegistrator (const Handle< ShapeExtend_BasicMsgRegistrator > &msgreg) override
 Sets message registrator. More...
 
virtual void SetPrecision (const Standard_Real preci) override
 Sets basic precision value (also to FixWireTool) More...
 
virtual void SetMinTolerance (const Standard_Real mintol) override
 Sets minimal allowed tolerance (also to FixWireTool) More...
 
virtual void SetMaxTolerance (const Standard_Real maxtol) override
 Sets maximal allowed tolerance (also to FixWireTool) More...
 
Standard_IntegerFixWireMode ()
 Returns (modifiable) the mode for applying fixes of ShapeFix_Wire, by default True. More...
 
Standard_IntegerFixOrientationMode ()
 Returns (modifiable) the fix orientation mode, by default True. If True, wires oriented to border limited square. More...
 
Standard_IntegerFixAddNaturalBoundMode ()
 Returns (modifiable) the add natural bound mode. If true, natural boundary is added on faces that miss them. Default is False for faces with single wire (they are handled by FixOrientation in that case) and True for others. More...
 
Standard_IntegerFixMissingSeamMode ()
 Returns (modifiable) the fix missing seam mode, by default True. If True, tries to insert seam is missed. More...
 
Standard_IntegerFixSmallAreaWireMode ()
 Returns (modifiable) the fix small area wire mode, by default False. If True, drops small wires. More...
 
Standard_IntegerRemoveSmallAreaFaceMode ()
 Returns (modifiable) the remove face with small area, by default False. If True, drops faces with small outer wires. More...
 
Standard_IntegerFixIntersectingWiresMode ()
 Returns (modifiable) the fix intersecting wires mode by default True. More...
 
Standard_IntegerFixLoopWiresMode ()
 Returns (modifiable) the fix loop wires mode by default True. More...
 
Standard_IntegerFixSplitFaceMode ()
 Returns (modifiable) the fix split face mode by default True. More...
 
Standard_IntegerAutoCorrectPrecisionMode ()
 Returns (modifiable) the auto-correct precision mode by default False. More...
 
Standard_IntegerFixPeriodicDegeneratedMode ()
 Returns (modifiable) the activation flag for periodic degenerated fix. False by default. More...
 
TopoDS_Face Face () const
 Returns a face which corresponds to the current state Warning: The finally produced face may be another one ... but with the same support. More...
 
TopoDS_Shape Result () const
 Returns resulting shape (Face or Shell if splitted) To be used instead of Face() if FixMissingSeam involved. More...
 
void Add (const TopoDS_Wire &wire)
 Add a wire to current face using BRep_Builder. Wire is added without taking into account orientation of face (as if face were FORWARD). More...
 
Standard_Boolean Perform ()
 Performs all the fixes, depending on modes Function Status returns the status of last call to Perform() ShapeExtend_OK : face was OK, nothing done ShapeExtend_DONE1: some wires are fixed ShapeExtend_DONE2: orientation of wires fixed ShapeExtend_DONE3: missing seam added ShapeExtend_DONE4: small area wire removed ShapeExtend_DONE5: natural bounds added ShapeExtend_FAIL1: some fails during fixing wires ShapeExtend_FAIL2: cannot fix orientation of wires ShapeExtend_FAIL3: cannot add missing seam ShapeExtend_FAIL4: cannot remove small area wire. More...
 
Standard_Boolean FixOrientation ()
 Fixes orientation of wires on the face It tries to make all wires lie outside all others (according to orientation) by reversing orientation of some of them. If face lying on sphere or torus has single wire and AddNaturalBoundMode is True, that wire is not reversed in any case (supposing that natural bound will be added). Returns True if wires were reversed. More...
 
Standard_Boolean FixOrientation (TopTools_DataMapOfShapeListOfShape &MapWires)
 Fixes orientation of wires on the face It tries to make all wires lie outside all others (according to orientation) by reversing orientation of some of them. If face lying on sphere or torus has single wire and AddNaturalBoundMode is True, that wire is not reversed in any case (supposing that natural bound will be added). Returns True if wires were reversed OutWires return information about out wires + list of internal wires for each (for performing split face). More...
 
Standard_Boolean FixAddNaturalBound ()
 Adds natural boundary on face if it is missing. Two cases are supported: More...
 
Standard_Boolean FixMissingSeam ()
 Detects and fixes the special case when face on a closed surface is given by two wires closed in 3d but with gap in 2d. In that case it creates a new wire from the two, and adds a missing seam edge Returns True if missing seam was added. More...
 
Standard_Boolean FixSmallAreaWire (const Standard_Boolean theIsRemoveSmallFace)
 Detects wires with small area (that is less than 100*Precision::PConfusion(). Removes these wires if they are internal. Returns : True if at least one small wire removed, False if does nothing. More...
 
Standard_Boolean FixLoopWire (TopTools_SequenceOfShape &aResWires)
 Detects if wire has a loop and fixes this situation by splitting on the few parts. if wire has a loops and it was splitted Status was set to value ShapeExtend_DONE6. More...
 
Standard_Boolean FixIntersectingWires ()
 Detects and fixes the special case when face has more than one wire and this wires have intersection point. More...
 
Standard_Boolean FixWiresTwoCoincEdges ()
 If wire contains two coincidence edges it must be removed Queries on status after Perform() More...
 
Standard_Boolean FixSplitFace (const TopTools_DataMapOfShapeListOfShape &MapWires)
 Split face if there are more than one out wire using inrormation after FixOrientation() More...
 
Standard_Boolean FixPeriodicDegenerated ()
 Fixes topology for a specific case when face is composed by a single wire belting a periodic surface. In that case a degenerated edge is reconstructed in the degenerated pole of the surface. Initial wire gets consistent orientation. Must be used in couple and before FixMissingSeam routine. More...
 
Standard_Boolean Status (const ShapeExtend_Status status) const
 Returns the status of last call to Perform() ShapeExtend_OK : face was OK, nothing done ShapeExtend_DONE1: some wires are fixed ShapeExtend_DONE2: orientation of wires fixed ShapeExtend_DONE3: missing seam added ShapeExtend_DONE4: small area wire removed ShapeExtend_DONE5: natural bounds added ShapeExtend_DONE8: face may be splited ShapeExtend_FAIL1: some fails during fixing wires ShapeExtend_FAIL2: cannot fix orientation of wires ShapeExtend_FAIL3: cannot add missing seam ShapeExtend_FAIL4: cannot remove small area wire. More...
 
Handle< ShapeFix_WireFixWireTool ()
 Returns tool for fixing wires. More...
 
- Public Member Functions inherited from ShapeFix_Root
 ShapeFix_Root ()
 Empty Constructor (no context is created) More...
 
virtual void Set (const Handle< ShapeFix_Root > &Root)
 Copy all fields from another Root object. More...
 
virtual void SetContext (const Handle< ShapeBuild_ReShape > &context)
 Sets context. More...
 
Handle< ShapeBuild_ReShapeContext () const
 Returns context. More...
 
Handle< ShapeExtend_BasicMsgRegistratorMsgRegistrator () const
 Returns message registrator. More...
 
Standard_Real Precision () const
 Returns basic precision value. More...
 
Standard_Real MinTolerance () const
 Returns minimal allowed tolerance. More...
 
Standard_Real MaxTolerance () const
 Returns maximal allowed tolerance. More...
 
Standard_Real LimitTolerance (const Standard_Real toler) const
 Returns tolerance limited by [myMinTol,myMaxTol]. More...
 
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. More...
 
void SendMsg (const Message_Msg &message, const Message_Gravity gravity=Message_Info) const
 Sends a message to be attached to myShape. Calls previous method. More...
 
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. More...
 
void SendWarning (const Message_Msg &message) const
 Calls previous method for myShape. More...
 
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. More...
 
void SendFail (const Message_Msg &message) const
 Calls previous method for myShape. 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 Attributes

Handle< ShapeAnalysis_SurfacemySurf
 
TopoDS_Face myFace
 
TopoDS_Shape myResult
 
Handle< ShapeFix_WiremyFixWire
 
Standard_Boolean myFwd
 
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. 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...
 
- 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. More...
 

Detailed Description

This operator allows to perform various fixes on face and its wires: fixes provided by ShapeFix_Wire, fixing orientation of wires, addition of natural bounds, fixing of missing seam edge, and detection and removal of null-area wires.

Constructor & Destructor Documentation

◆ ShapeFix_Face() [1/2]

ShapeFix_Face::ShapeFix_Face ( )

Creates an empty tool.

◆ ShapeFix_Face() [2/2]

ShapeFix_Face::ShapeFix_Face ( const TopoDS_Face face)

Creates a tool and loads a face.

Member Function Documentation

◆ Add()

void ShapeFix_Face::Add ( const TopoDS_Wire wire)

Add a wire to current face using BRep_Builder. Wire is added without taking into account orientation of face (as if face were FORWARD).

◆ AutoCorrectPrecisionMode()

Standard_Integer& ShapeFix_Face::AutoCorrectPrecisionMode ( )

Returns (modifiable) the auto-correct precision mode by default False.

◆ ClearModes()

virtual void ShapeFix_Face::ClearModes ( )
virtual

Sets all modes to default.

◆ Face()

TopoDS_Face ShapeFix_Face::Face ( ) const

Returns a face which corresponds to the current state Warning: The finally produced face may be another one ... but with the same support.

◆ FixAddNaturalBound()

Standard_Boolean ShapeFix_Face::FixAddNaturalBound ( )

Adds natural boundary on face if it is missing. Two cases are supported:

  • face has no wires
  • face lies on geometrically double-closed surface (sphere or torus) and none of wires is left-oriented Returns True if natural boundary was added

◆ FixAddNaturalBoundMode()

Standard_Integer& ShapeFix_Face::FixAddNaturalBoundMode ( )

Returns (modifiable) the add natural bound mode. If true, natural boundary is added on faces that miss them. Default is False for faces with single wire (they are handled by FixOrientation in that case) and True for others.

◆ FixIntersectingWires()

Standard_Boolean ShapeFix_Face::FixIntersectingWires ( )

Detects and fixes the special case when face has more than one wire and this wires have intersection point.

◆ FixIntersectingWiresMode()

Standard_Integer& ShapeFix_Face::FixIntersectingWiresMode ( )

Returns (modifiable) the fix intersecting wires mode by default True.

◆ FixLoopWire()

Standard_Boolean ShapeFix_Face::FixLoopWire ( TopTools_SequenceOfShape aResWires)

Detects if wire has a loop and fixes this situation by splitting on the few parts. if wire has a loops and it was splitted Status was set to value ShapeExtend_DONE6.

◆ FixLoopWiresMode()

Standard_Integer& ShapeFix_Face::FixLoopWiresMode ( )

Returns (modifiable) the fix loop wires mode by default True.

◆ FixMissingSeam()

Standard_Boolean ShapeFix_Face::FixMissingSeam ( )

Detects and fixes the special case when face on a closed surface is given by two wires closed in 3d but with gap in 2d. In that case it creates a new wire from the two, and adds a missing seam edge Returns True if missing seam was added.

◆ FixMissingSeamMode()

Standard_Integer& ShapeFix_Face::FixMissingSeamMode ( )

Returns (modifiable) the fix missing seam mode, by default True. If True, tries to insert seam is missed.

◆ FixOrientation() [1/2]

Standard_Boolean ShapeFix_Face::FixOrientation ( )

Fixes orientation of wires on the face It tries to make all wires lie outside all others (according to orientation) by reversing orientation of some of them. If face lying on sphere or torus has single wire and AddNaturalBoundMode is True, that wire is not reversed in any case (supposing that natural bound will be added). Returns True if wires were reversed.

◆ FixOrientation() [2/2]

Standard_Boolean ShapeFix_Face::FixOrientation ( TopTools_DataMapOfShapeListOfShape MapWires)

Fixes orientation of wires on the face It tries to make all wires lie outside all others (according to orientation) by reversing orientation of some of them. If face lying on sphere or torus has single wire and AddNaturalBoundMode is True, that wire is not reversed in any case (supposing that natural bound will be added). Returns True if wires were reversed OutWires return information about out wires + list of internal wires for each (for performing split face).

◆ FixOrientationMode()

Standard_Integer& ShapeFix_Face::FixOrientationMode ( )

Returns (modifiable) the fix orientation mode, by default True. If True, wires oriented to border limited square.

◆ FixPeriodicDegenerated()

Standard_Boolean ShapeFix_Face::FixPeriodicDegenerated ( )

Fixes topology for a specific case when face is composed by a single wire belting a periodic surface. In that case a degenerated edge is reconstructed in the degenerated pole of the surface. Initial wire gets consistent orientation. Must be used in couple and before FixMissingSeam routine.

◆ FixPeriodicDegeneratedMode()

Standard_Integer& ShapeFix_Face::FixPeriodicDegeneratedMode ( )

Returns (modifiable) the activation flag for periodic degenerated fix. False by default.

◆ FixSmallAreaWire()

Standard_Boolean ShapeFix_Face::FixSmallAreaWire ( const Standard_Boolean  theIsRemoveSmallFace)

Detects wires with small area (that is less than 100*Precision::PConfusion(). Removes these wires if they are internal. Returns : True if at least one small wire removed, False if does nothing.

◆ FixSmallAreaWireMode()

Standard_Integer& ShapeFix_Face::FixSmallAreaWireMode ( )

Returns (modifiable) the fix small area wire mode, by default False. If True, drops small wires.

◆ FixSplitFace()

Standard_Boolean ShapeFix_Face::FixSplitFace ( const TopTools_DataMapOfShapeListOfShape MapWires)

Split face if there are more than one out wire using inrormation after FixOrientation()

◆ FixSplitFaceMode()

Standard_Integer& ShapeFix_Face::FixSplitFaceMode ( )

Returns (modifiable) the fix split face mode by default True.

◆ FixWireMode()

Standard_Integer& ShapeFix_Face::FixWireMode ( )

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

◆ FixWiresTwoCoincEdges()

Standard_Boolean ShapeFix_Face::FixWiresTwoCoincEdges ( )

If wire contains two coincidence edges it must be removed Queries on status after Perform()

◆ FixWireTool()

Handle< ShapeFix_Wire > ShapeFix_Face::FixWireTool ( )

Returns tool for fixing wires.

◆ Init() [1/3]

void ShapeFix_Face::Init ( const TopoDS_Face face)

Loads a whole face already created, with its wires, sense and location.

◆ Init() [2/3]

void ShapeFix_Face::Init ( const Handle< Geom_Surface > &  surf,
const Standard_Real  preci,
const Standard_Boolean  fwd = Standard_True 
)

Starts the creation of the face By default it will be FORWARD, or REVERSED if <fwd> is False.

◆ Init() [3/3]

void ShapeFix_Face::Init ( const Handle< ShapeAnalysis_Surface > &  surf,
const Standard_Real  preci,
const Standard_Boolean  fwd = Standard_True 
)

Starts the creation of the face By default it will be FORWARD, or REVERSED if <fwd> is False.

◆ Perform()

Standard_Boolean ShapeFix_Face::Perform ( )

Performs all the fixes, depending on modes Function Status returns the status of last call to Perform() ShapeExtend_OK : face was OK, nothing done ShapeExtend_DONE1: some wires are fixed ShapeExtend_DONE2: orientation of wires fixed ShapeExtend_DONE3: missing seam added ShapeExtend_DONE4: small area wire removed ShapeExtend_DONE5: natural bounds added ShapeExtend_FAIL1: some fails during fixing wires ShapeExtend_FAIL2: cannot fix orientation of wires ShapeExtend_FAIL3: cannot add missing seam ShapeExtend_FAIL4: cannot remove small area wire.

◆ RemoveSmallAreaFaceMode()

Standard_Integer& ShapeFix_Face::RemoveSmallAreaFaceMode ( )

Returns (modifiable) the remove face with small area, by default False. If True, drops faces with small outer wires.

◆ Result()

TopoDS_Shape ShapeFix_Face::Result ( ) const

Returns resulting shape (Face or Shell if splitted) To be used instead of Face() if FixMissingSeam involved.

◆ SetMaxTolerance()

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

Sets maximal allowed tolerance (also to FixWireTool)

Reimplemented from ShapeFix_Root.

◆ SetMinTolerance()

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

Sets minimal allowed tolerance (also to FixWireTool)

Reimplemented from ShapeFix_Root.

◆ SetMsgRegistrator()

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

Sets message registrator.

Reimplemented from ShapeFix_Root.

◆ SetPrecision()

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

Sets basic precision value (also to FixWireTool)

Reimplemented from ShapeFix_Root.

◆ Status()

Standard_Boolean ShapeFix_Face::Status ( const ShapeExtend_Status  status) const

Returns the status of last call to Perform() ShapeExtend_OK : face was OK, nothing done ShapeExtend_DONE1: some wires are fixed ShapeExtend_DONE2: orientation of wires fixed ShapeExtend_DONE3: missing seam added ShapeExtend_DONE4: small area wire removed ShapeExtend_DONE5: natural bounds added ShapeExtend_DONE8: face may be splited ShapeExtend_FAIL1: some fails during fixing wires ShapeExtend_FAIL2: cannot fix orientation of wires ShapeExtend_FAIL3: cannot add missing seam ShapeExtend_FAIL4: cannot remove small area wire.

Field Documentation

◆ myFace

TopoDS_Face ShapeFix_Face::myFace
protected

◆ myFixWire

Handle< ShapeFix_Wire > ShapeFix_Face::myFixWire
protected

◆ myFwd

Standard_Boolean ShapeFix_Face::myFwd
protected

◆ myResult

TopoDS_Shape ShapeFix_Face::myResult
protected

◆ myStatus

Standard_Integer ShapeFix_Face::myStatus
protected

◆ mySurf

Handle< ShapeAnalysis_Surface > ShapeFix_Face::mySurf
protected

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