OCCT 8.0.1
OCCT documentation

Search guides and API reference

Enter at least two characters.

    Open CASCADE Technology Reference Manual 8.0.1
    MeshVS_DummySensitiveEntity Class Reference

    This class allows to create owners to all elements or nodes, both hidden and shown, but these owners user cannot select "by hands" in viewer. They means for internal application tasks, for example, receiving all owners, both for hidden and shown entities. More...

    #include <MeshVS_DummySensitiveEntity.hxx>

    Inheritance diagram for MeshVS_DummySensitiveEntity:

    Public Member Functions

     MeshVS_DummySensitiveEntity (const occ::handle< SelectMgr_EntityOwner > &theOwnerId)
    bool Matches (SelectBasics_SelectingVolumeManager &theMgr, SelectBasics_PickResult &thePickResult) override
     Checks whether sensitive overlaps current selecting volume. Stores minimum depth, distance to center of geometry and closest point detected into thePickResult.
    int NbSubElements () const override
     Returns the number of sub-entities or elements in sensitive entity. Is used to determine if entity is complex and needs to pre-build BVH at the creation of sensitive entity step or is light-weighted so the tree can be build on demand with unnoticeable delay.
    Select3D_BndBox3d BoundingBox () override
     Returns bounding box of a sensitive with transformation applied.
    void BVH () override
     Builds BVH tree for a sensitive if needed.
    bool ToBuildBVH () const override
     Returns TRUE if BVH tree is in invalidated state.
    void Clear () override
     Clears up all resources and memory.
    bool HasInitLocation () const override
     Returns true if the shape corresponding to the entity has init location.
    gp_GTrsf InvInitLocation () const override
     Returns inversed location transformation matrix if the shape corresponding to this entity has init location set. Otherwise, returns identity matrix.
    gp_Pnt CenterOfGeometry () const override
     Returns center of a sensitive with transformation applied.
    Public Member Functions inherited from Select3D_SensitiveEntity
    const occ::handle< SelectMgr_EntityOwner > & OwnerId () const
     Returns pointer to owner of the entity.
    virtual void Set (const occ::handle< SelectMgr_EntityOwner > &theOwnerId)
     Sets owner of the entity.
    int SensitivityFactor () const
     allows a better sensitivity for a specific entity in selection algorithms useful for small sized entities.
    void SetSensitivityFactor (const int theNewSens)
     Allows to manage sensitivity of a particular sensitive entity.
    virtual occ::handle< Select3D_SensitiveEntity > GetConnected ()
     Originally this method intended to return sensitive entity with new location aLocation, but currently sensitive entities do not hold a location, instead HasLocation() and Location() methods call corresponding entity owner's methods. Thus all entities returned by GetConnected() share the same location propagated from corresponding selectable object. You must redefine this function for any type of sensitive entity which can accept another connected sensitive entity.
    const occ::handle< Graphic3d_TransformPers > & TransformPersistence () const
     Return transformation persistence.
    virtual void SetTransformPersistence (const occ::handle< Graphic3d_TransformPers > &theTrsfPers)
     Set transformation persistence.
    const occ::handle< Graphic3d_Flipper > & Flipper () const
     Return flipper metadata describing the runtime flip of the owning group, or null.
    virtual void SetFlippingOptions (const bool theIsEnabled, const gp_Ax2 &theRefPlane)
     Set flipping options. When enabled, creates a Graphic3d_Flipper for theRefPlane; otherwise clears the flipper.
    virtual void DumpJson (Standard_OStream &theOStream, int theDepth=-1) const
     Dumps the content of me into the stream.
    Public Member Functions inherited from Standard_Transient
     Standard_Transient ()
     Empty constructor.
     Standard_Transient (const Standard_Transient &)
     Copy constructor – does nothing.
    Standard_Transient & operator= (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_Transient * This () 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.

    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.
    Protected Member Functions inherited from Select3D_SensitiveEntity
     Select3D_SensitiveEntity (const occ::handle< SelectMgr_EntityOwner > &theOwnerId)
    Protected Attributes inherited from Select3D_SensitiveEntity
    occ::handle< SelectMgr_EntityOwner > myOwnerId
    occ::handle< Graphic3d_TransformPers > myTrsfPers
    occ::handle< Graphic3d_Flipper > myFlipper
    int mySFactor

    Detailed Description

    This class allows to create owners to all elements or nodes, both hidden and shown, but these owners user cannot select "by hands" in viewer. They means for internal application tasks, for example, receiving all owners, both for hidden and shown entities.

    Constructor & Destructor Documentation

    ◆ MeshVS_DummySensitiveEntity()

    MeshVS_DummySensitiveEntity::MeshVS_DummySensitiveEntity ( const occ::handle< SelectMgr_EntityOwner > & theOwnerId)

    Member Function Documentation

    ◆ BoundingBox()

    Select3D_BndBox3d MeshVS_DummySensitiveEntity::BoundingBox ( )
    overridevirtual

    Returns bounding box of a sensitive with transformation applied.

    Implements Select3D_SensitiveEntity.

    ◆ BVH()

    void MeshVS_DummySensitiveEntity::BVH ( )
    overridevirtual

    Builds BVH tree for a sensitive if needed.

    Reimplemented from Select3D_SensitiveEntity.

    ◆ CenterOfGeometry()

    gp_Pnt MeshVS_DummySensitiveEntity::CenterOfGeometry ( ) const
    inlineoverridevirtual

    Returns center of a sensitive with transformation applied.

    Implements Select3D_SensitiveEntity.

    ◆ Clear()

    void MeshVS_DummySensitiveEntity::Clear ( )
    overridevirtual

    Clears up all resources and memory.

    Reimplemented from Select3D_SensitiveEntity.

    ◆ HasInitLocation()

    bool MeshVS_DummySensitiveEntity::HasInitLocation ( ) const
    overridevirtual

    Returns true if the shape corresponding to the entity has init location.

    Reimplemented from Select3D_SensitiveEntity.

    ◆ InvInitLocation()

    gp_GTrsf MeshVS_DummySensitiveEntity::InvInitLocation ( ) const
    overridevirtual

    Returns inversed location transformation matrix if the shape corresponding to this entity has init location set. Otherwise, returns identity matrix.

    Reimplemented from Select3D_SensitiveEntity.

    ◆ Matches()

    bool MeshVS_DummySensitiveEntity::Matches ( SelectBasics_SelectingVolumeManager & theMgr,
    SelectBasics_PickResult & thePickResult )
    overridevirtual

    Checks whether sensitive overlaps current selecting volume. Stores minimum depth, distance to center of geometry and closest point detected into thePickResult.

    Implements Select3D_SensitiveEntity.

    ◆ NbSubElements()

    int MeshVS_DummySensitiveEntity::NbSubElements ( ) const
    overridevirtual

    Returns the number of sub-entities or elements in sensitive entity. Is used to determine if entity is complex and needs to pre-build BVH at the creation of sensitive entity step or is light-weighted so the tree can be build on demand with unnoticeable delay.

    Implements Select3D_SensitiveEntity.

    ◆ ToBuildBVH()

    bool MeshVS_DummySensitiveEntity::ToBuildBVH ( ) const
    inlineoverridevirtual

    Returns TRUE if BVH tree is in invalidated state.

    Reimplemented from Select3D_SensitiveEntity.


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