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
    XSControl_ConnectedShapes Class Reference

    From a TopoDS_Shape, or from the entity which has produced it, searches for the shapes, and the entities which have produced them in last transfer, which are adjacent to it by VERTICES. More...

    #include <XSControl_ConnectedShapes.hxx>

    Inheritance diagram for XSControl_ConnectedShapes:

    Public Member Functions

     XSControl_ConnectedShapes ()
     Creates a Selection ConnectedShapes. It remains to be set a TransferReader.
     XSControl_ConnectedShapes (const occ::handle< XSControl_TransferReader > &TR)
     Creates a Selection ConnectedShapes, which will work with the current TransferProcess brought by the TransferReader.
    void SetReader (const occ::handle< XSControl_TransferReader > &TR)
     Sets a TransferReader to sort entities : it brings the TransferProcess which may change, while the TransferReader does not.
    bool Explore (const int levellevel, const occ::handle< Standard_Transient > &ent, const Interface_Graph &G, Interface_EntityIterator &explored) const override
     Explores an entity : entities from which are connected to that produced by this entity, including itself.
    TCollection_AsciiString ExploreLabel () const override
     Returns a text defining the criterium. "Connected Entities through produced Shapes".
    Public Member Functions inherited from IFSelect_SelectExplore
    int Level () const
     Returns the required exploring level.
    Interface_EntityIterator RootResult (const Interface_Graph &G) const override
     Returns the list of selected entities. Works by calling the method Explore on each input entity : it can be rejected, taken for output, or to explore. If the maximum level has not yet been attained, or if no max level is specified, entities to be explored are themselves used as if they were input.
    TCollection_AsciiString Label () const override
     Returns a text saying "(Recursive)" or "(Level nn)" plus specific criterium returned by ExploreLabel (see below).
    Public Member Functions inherited from IFSelect_SelectDeduct
    void SetInput (const occ::handle< IFSelect_Selection > &sel)
     Defines or Changes the Input Selection.
    occ::handle< IFSelect_SelectionInput () const
     Returns the Input Selection.
    bool HasInput () const
     Returns True if the Input Selection is defined, False else.
    bool HasAlternate () const
     Tells if an Alternate List has been set, i.e. : the Alternate Definition is present and set.
    occ::handle< IFSelect_SelectPointed > & Alternate ()
     Returns the Alternate Definition It is returned modifiable, hence an already defined SelectPointed can be used But if it was not yet defined, it is created the first time.
    Interface_EntityIterator InputResult (const Interface_Graph &G) const
     Returns the Result determined by Input Selection, as Unique if Input Selection is not defined, returns an empty list.
    void FillIterator (IFSelect_SelectionIterator &iter) const override
     Puts in an Iterator the Selections from which "me" depends This list contains one Selection : the InputSelection.
    Public Member Functions inherited from IFSelect_Selection
    Interface_EntityIterator UniqueResult (const Interface_Graph &G) const
     Returns the list of selected entities, each of them being unique. Default definition works from RootResult. According HasUniqueResult, UniqueResult returns directly RootResult, or build a Unique Result from it with a Graph.
    virtual Interface_EntityIterator CompleteResult (const Interface_Graph &G) const
     Returns the list of entities involved by a Selection, i.e. UniqueResult plus the shared entities (directly or not).
    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 Public Member Functions

    static occ::handle< NCollection_HSequence< occ::handle< Standard_Transient > > > AdjacentEntities (const TopoDS_Shape &ashape, const occ::handle< Transfer_TransientProcess > &TP, const TopAbs_ShapeEnum typetype)
     This functions considers a shape from a transfer and performs the search function explained above.
    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.

    Additional Inherited Members

    typedef void base_type
     Returns a type descriptor about this object.
    Protected Member Functions inherited from IFSelect_SelectExplore
     IFSelect_SelectExplore (const int levellevel)
     Initializes a SelectExplore : the level must be specified on starting. 0 means all levels, 1 means level one only, etc...
    Protected Member Functions inherited from IFSelect_Selection
    virtual bool HasUniqueResult () const
     Returns True if RootResult guarantees uniqueness for each Entity. Called by UniqueResult. Default answer is False. Can be redefined.

    Detailed Description

    From a TopoDS_Shape, or from the entity which has produced it, searches for the shapes, and the entities which have produced them in last transfer, which are adjacent to it by VERTICES.

    Constructor & Destructor Documentation

    ◆ XSControl_ConnectedShapes() [1/2]

    XSControl_ConnectedShapes::XSControl_ConnectedShapes ( )

    Creates a Selection ConnectedShapes. It remains to be set a TransferReader.

    ◆ XSControl_ConnectedShapes() [2/2]

    XSControl_ConnectedShapes::XSControl_ConnectedShapes ( const occ::handle< XSControl_TransferReader > & TR)

    Creates a Selection ConnectedShapes, which will work with the current TransferProcess brought by the TransferReader.

    Member Function Documentation

    ◆ AdjacentEntities()

    occ::handle< NCollection_HSequence< occ::handle< Standard_Transient > > > XSControl_ConnectedShapes::AdjacentEntities ( const TopoDS_Shape & ashape,
    const occ::handle< Transfer_TransientProcess > & TP,
    const TopAbs_ShapeEnum type )
    static

    This functions considers a shape from a transfer and performs the search function explained above.

    ◆ Explore()

    bool XSControl_ConnectedShapes::Explore ( const int level,
    const occ::handle< Standard_Transient > & ent,
    const Interface_Graph & G,
    Interface_EntityIterator & explored ) const
    overridevirtual

    Explores an entity : entities from which are connected to that produced by this entity, including itself.

    Implements IFSelect_SelectExplore.

    ◆ ExploreLabel()

    TCollection_AsciiString XSControl_ConnectedShapes::ExploreLabel ( ) const
    overridevirtual

    Returns a text defining the criterium. "Connected Entities through produced Shapes".

    Implements IFSelect_SelectExplore.

    ◆ SetReader()

    void XSControl_ConnectedShapes::SetReader ( const occ::handle< XSControl_TransferReader > & TR)

    Sets a TransferReader to sort entities : it brings the TransferProcess which may change, while the TransferReader does not.


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