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

    A framework to define sensitive 3D circles. More...

    #include <Select3D_SensitiveCircle.hxx>

    Inheritance diagram for Select3D_SensitiveCircle:

    Public Member Functions

     Select3D_SensitiveCircle (const occ::handle< SelectMgr_EntityOwner > &theOwnerId, const gp_Circ &theCircle, const bool theIsFilled=false)
     Constructs the sensitive circle object defined by the owner theOwnerId, the circle theCircle and the boolean theIsFilled.
     Select3D_SensitiveCircle (const occ::handle< SelectMgr_EntityOwner > &theOwnerId, const gp_Circ &theCircle, const bool theIsFilled, const int)
     Constructs the sensitive circle object defined by the owner theOwnerId, the circle theCircle, the boolean theIsFilled and the number of points theNbPnts.
    bool Matches (SelectBasics_SelectingVolumeManager &theMgr, SelectBasics_PickResult &thePickResult) override
     Checks whether the circle overlaps current selecting volume.
    occ::handle< Select3D_SensitiveEntityGetConnected () override
     Returns a copy of this sensitive circle.
    Select3D_BndBox3d BoundingBox () override
     Returns bounding box of the circle. If location transformation is set, it will be applied.
    bool ToBuildBVH () const override
     Always returns false.
    int NbSubElements () const override
     Returns the amount of points.
    gp_Pnt CenterOfGeometry () const override
     Returns center of the circle with transformation applied.
    const gp_TrsfTransformation () const
     The transformation for gp::XOY() with center in gp::Origin(), it specifies the position and orientation of the circle.
    gp_Circ Circle () const
     Returns circle.
    double Radius () const
     Returns circle radius.
    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 void BVH ()
     Builds BVH tree for a sensitive if needed.
    virtual void Clear ()
     Clears up all resources and memory.
    virtual bool HasInitLocation () const
     Returns true if the shape corresponding to the entity has init location.
    virtual gp_GTrsf InvInitLocation () const
     Returns inversed location transformation matrix if the shape corresponding to this entity has init location set. Otherwise, returns identity matrix.
    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_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.

    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_EntityOwnermyOwnerId
    occ::handle< Graphic3d_TransformPersmyTrsfPers
    occ::handle< Graphic3d_FlippermyFlipper
    int mySFactor

    Detailed Description

    A framework to define sensitive 3D circles.

    Constructor & Destructor Documentation

    ◆ Select3D_SensitiveCircle() [1/2]

    Select3D_SensitiveCircle::Select3D_SensitiveCircle ( const occ::handle< SelectMgr_EntityOwner > & theOwnerId,
    const gp_Circ & theCircle,
    const bool theIsFilled = false )

    Constructs the sensitive circle object defined by the owner theOwnerId, the circle theCircle and the boolean theIsFilled.

    ◆ Select3D_SensitiveCircle() [2/2]

    Select3D_SensitiveCircle::Select3D_SensitiveCircle ( const occ::handle< SelectMgr_EntityOwner > & theOwnerId,
    const gp_Circ & theCircle,
    const bool theIsFilled,
    const int  )
    inline

    Constructs the sensitive circle object defined by the owner theOwnerId, the circle theCircle, the boolean theIsFilled and the number of points theNbPnts.

    Deprecated
    ("Deprecated constructor, theNbPnts parameter will be ignored")

    Member Function Documentation

    ◆ BoundingBox()

    Select3D_BndBox3d Select3D_SensitiveCircle::BoundingBox ( )
    overridevirtual

    Returns bounding box of the circle. If location transformation is set, it will be applied.

    Implements Select3D_SensitiveEntity.

    ◆ CenterOfGeometry()

    gp_Pnt Select3D_SensitiveCircle::CenterOfGeometry ( ) const
    overridevirtual

    Returns center of the circle with transformation applied.

    Implements Select3D_SensitiveEntity.

    ◆ Circle()

    gp_Circ Select3D_SensitiveCircle::Circle ( ) const
    inline

    Returns circle.

    ◆ GetConnected()

    occ::handle< Select3D_SensitiveEntity > Select3D_SensitiveCircle::GetConnected ( )
    overridevirtual

    Returns a copy of this sensitive circle.

    Reimplemented from Select3D_SensitiveEntity.

    ◆ Matches()

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

    Checks whether the circle overlaps current selecting volume.

    Implements Select3D_SensitiveEntity.

    ◆ NbSubElements()

    int Select3D_SensitiveCircle::NbSubElements ( ) const
    inlineoverridevirtual

    Returns the amount of points.

    Implements Select3D_SensitiveEntity.

    ◆ Radius()

    double Select3D_SensitiveCircle::Radius ( ) const
    inline

    Returns circle radius.

    ◆ ToBuildBVH()

    bool Select3D_SensitiveCircle::ToBuildBVH ( ) const
    inlineoverridevirtual

    Always returns false.

    Reimplemented from Select3D_SensitiveEntity.

    ◆ Transformation()

    const gp_Trsf & Select3D_SensitiveCircle::Transformation ( ) const
    inline

    The transformation for gp::XOY() with center in gp::Origin(), it specifies the position and orientation of the circle.


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