OCCT3D OCCT 8.0.1
OCCT documentation

Search guides and API reference

Enter at least two characters.

    Open CASCADE Technology Reference Manual 8.0.1
    ShapeFix_Root Class Reference

    Root class for fixing operations Provides context for recording changes (optional), basic precision value and limit (minimal and maximal) values for tolerances, and message registrator. More...

    #include <ShapeFix_Root.hxx>

    Inheritance diagram for ShapeFix_Root:

    Public Member Functions

     ShapeFix_Root ()
     Empty Constructor (no context is created).
    virtual void Set (const occ::handle< ShapeFix_Root > &Root)
     Copy all fields from another Root object.
    virtual void SetContext (const occ::handle< ShapeBuild_ReShape > &context)
     Sets context.
    occ::handle< ShapeBuild_ReShapeContext () const
     Returns context.
    virtual void SetMsgRegistrator (const occ::handle< ShapeExtend_BasicMsgRegistrator > &msgreg)
     Sets message registrator.
    occ::handle< ShapeExtend_BasicMsgRegistratorMsgRegistrator () const
     Returns message registrator.
    virtual void SetPrecision (const double preci)
     Sets basic precision value.
    double Precision () const
     Returns basic precision value.
    virtual void SetMinTolerance (const double mintol)
     Sets minimal allowed tolerance.
    double MinTolerance () const
     Returns minimal allowed tolerance.
    virtual void SetMaxTolerance (const double maxtol)
     Sets maximal allowed tolerance.
    double MaxTolerance () const
     Returns maximal allowed tolerance.
    double LimitTolerance (const double toler) const
     Returns tolerance limited by [myMinTol,myMaxTol].
    void SendMsg (const TopoDS_Shape &shape, const Message_Msg &messagemessage, 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 &messagemessage, 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 &messagemessage) const
     Sends a warning to be attached to the shape. Calls SendMsg with gravity set to Message_Warning.
    void SendWarning (const Message_Msg &messagemessage) const
     Calls previous method for myShape.
    void SendFail (const TopoDS_Shape &shape, const Message_Msg &messagemessage) const
     Sends a fail to be attached to the shape. Calls SendMsg with gravity set to Message_Fail.
    void SendFail (const Message_Msg &messagemessage) 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 ()=default
     Destructor must be virtual.
    virtual const opencascade::handle< Standard_Type > & DynamicType () const
     Returns a type descriptor about this object.
    bool IsInstance (const opencascade::handle< Standard_Type > &theType) const
     Returns a true value if this is an instance of Type.
    bool IsInstance (const char *const theTypeName) const
     Returns a true value if this is an instance of TypeName.
    bool 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.
    bool IsKind (const char *const 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.
    int GetRefCount () const noexcept
     Get the reference counter of this object.
    void IncrementRefCounter () noexcept
     Increments the reference counter of this object. Uses relaxed memory ordering since incrementing only requires atomicity, not synchronization with other memory operations.
    int DecrementRefCounter () noexcept
     Decrements the reference counter of this object; returns the decremented value. Uses release ordering for the decrement to ensure all writes to the object are visible before the count reaches zero. An acquire fence is added only when the count reaches zero, ensuring proper synchronization before deletion. This is more efficient than using acq_rel for every decrement.
    virtual void Delete () const
     Memory deallocator for transient classes.

    Static Protected Member Functions

    static bool NeedFix (const int flag, const bool def=true)
     Auxiliary method for work with three-position (on/off/default) flags (modes) in ShapeFix.

    Protected Attributes

    TopoDS_Shape myShape

    Additional Inherited Members

    typedef void base_type
     Returns a type descriptor about this object.
    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.

    Detailed Description

    Root class for fixing operations Provides context for recording changes (optional), basic precision value and limit (minimal and maximal) values for tolerances, and message registrator.

    Constructor & Destructor Documentation

    ◆ ShapeFix_Root()

    ShapeFix_Root::ShapeFix_Root ( )

    Empty Constructor (no context is created).

    Member Function Documentation

    ◆ Context()

    occ::handle< ShapeBuild_ReShape > ShapeFix_Root::Context ( ) const

    Returns context.

    ◆ LimitTolerance()

    double ShapeFix_Root::LimitTolerance ( const double toler) const

    Returns tolerance limited by [myMinTol,myMaxTol].

    ◆ MaxTolerance()

    double ShapeFix_Root::MaxTolerance ( ) const

    Returns maximal allowed tolerance.

    ◆ MinTolerance()

    double ShapeFix_Root::MinTolerance ( ) const

    Returns minimal allowed tolerance.

    ◆ MsgRegistrator()

    occ::handle< ShapeExtend_BasicMsgRegistrator > ShapeFix_Root::MsgRegistrator ( ) const

    Returns message registrator.

    ◆ NeedFix()

    bool ShapeFix_Root::NeedFix ( const int flag,
    const bool def = true )
    staticprotected

    Auxiliary method for work with three-position (on/off/default) flags (modes) in ShapeFix.

    ◆ Precision()

    double ShapeFix_Root::Precision ( ) const

    Returns basic precision value.

    ◆ SendFail() [1/2]

    void ShapeFix_Root::SendFail ( const Message_Msg & message) const

    Calls previous method for myShape.

    ◆ SendFail() [2/2]

    void ShapeFix_Root::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.

    ◆ SendMsg() [1/2]

    void ShapeFix_Root::SendMsg ( const Message_Msg & message,
    const Message_Gravity gravity = Message_Info ) const

    Sends a message to be attached to myShape. Calls previous method.

    ◆ SendMsg() [2/2]

    void ShapeFix_Root::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.

    ◆ SendWarning() [1/2]

    void ShapeFix_Root::SendWarning ( const Message_Msg & message) const

    Calls previous method for myShape.

    ◆ SendWarning() [2/2]

    void ShapeFix_Root::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.

    ◆ Set()

    virtual void ShapeFix_Root::Set ( const occ::handle< ShapeFix_Root > & Root)
    virtual

    Copy all fields from another Root object.

    ◆ SetContext()

    virtual void ShapeFix_Root::SetContext ( const occ::handle< ShapeBuild_ReShape > & context)
    virtual

    Sets context.

    ◆ SetMaxTolerance()

    virtual void ShapeFix_Root::SetMaxTolerance ( const double maxtol)
    virtual

    Sets maximal allowed tolerance.

    Reimplemented in ShapeFix_Face, ShapeFix_Shape, ShapeFix_Shell, and ShapeFix_Solid.

    ◆ SetMinTolerance()

    virtual void ShapeFix_Root::SetMinTolerance ( const double mintol)
    virtual

    Sets minimal allowed tolerance.

    Reimplemented in ShapeFix_Face, ShapeFix_Shape, ShapeFix_Shell, and ShapeFix_Solid.

    ◆ SetMsgRegistrator()

    virtual void ShapeFix_Root::SetMsgRegistrator ( const occ::handle< ShapeExtend_BasicMsgRegistrator > & msgreg)
    virtual

    Sets message registrator.

    Reimplemented in ShapeFix_Face, ShapeFix_Shape, ShapeFix_Shell, and ShapeFix_Solid.

    ◆ SetPrecision()

    virtual void ShapeFix_Root::SetPrecision ( const double preci)
    virtual

    Sets basic precision value.

    Reimplemented in ShapeFix_Face, ShapeFix_Shape, ShapeFix_Shell, ShapeFix_Solid, and ShapeFix_Wire.

    Field Documentation

    ◆ myShape

    TopoDS_Shape ShapeFix_Root::myShape
    protected

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