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

    This class is an interface for different types of selecting frustums, defining different selection types, like point, box or polyline selection. It contains signatures of functions for detection of overlap by sensitive entity and initializes some data for building the selecting frustum. More...

    #include <SelectMgr_BaseFrustum.hxx>

    Inheritance diagram for SelectMgr_BaseFrustum:

    Public Member Functions

     SelectMgr_BaseFrustum ()
     Creates new selecting volume with pixel tolerance set to 2, orthographic camera and empty frustum builder.
     ~SelectMgr_BaseFrustum () override=default
     Destructor.
    void SetBuilder (const occ::handle< SelectMgr_FrustumBuilder > &theBuilder)
     Nullifies the builder created in the constructor and copies the pointer given.
    void SetCamera (const occ::handle< Graphic3d_Camera > &theCamera) override
     Saves camera definition and passes it to builder.
    void SetPixelTolerance (const int theTol) override
     Sets pixel tolerance. It makes sense only for scalable intersectors (built on a single point). This method does nothing for the base class.
    void SetWindowSize (const int theWidth, const int theHeight) override
     Sets current window size. This method does nothing for the base class.
    void WindowSize (int &theWidth, int &theHeight) const override
     Returns current window size. This method doesn't set any output values for the base class.
    void SetViewport (const double theX, const double theY, const double theWidth, const double theHeight) override
     Passes viewport parameters to builder.
    bool IsBoundaryIntersectSphere (const gp_Pnt &theCenter, const double theRadius, const gp_Dir &thePlaneNormal, const NCollection_Array1< gp_Pnt > &theBoundaries, bool &theBoundaryInside) const
     Checks whether the boundary of the current volume selection intersects with a sphere or are there it's boundaries lying inside the sphere.
    void DumpJson (Standard_OStream &theOStream, int theDepth=-1) const override
     Dumps the content of me into the stream.
    Public Member Functions inherited from SelectMgr_BaseIntersector
     SelectMgr_BaseIntersector ()
     Creates new empty selecting volume.
     ~SelectMgr_BaseIntersector () override
     Destructor.
    virtual void Build ()=0
     Builds intersector according to internal parameters.
    SelectMgr_SelectionType GetSelectionType () const
     Returns selection type of this intersector.
    virtual bool IsScalable () const =0
     Checks if it is possible to scale this intersector.
    virtual occ::handle< SelectMgr_BaseIntersectorScaleAndTransform (const int theScaleFactor, const gp_GTrsf &theTrsf, const occ::handle< SelectMgr_FrustumBuilder > &theBuilder) const =0
     Note that this method does not perform any checks on type of the frustum.
    virtual occ::handle< SelectMgr_BaseIntersectorCopyWithBuilder (const occ::handle< SelectMgr_FrustumBuilder > &theBuilder) const =0
    const occ::handle< Graphic3d_Camera > & Camera () const
     Return camera definition.
    virtual const gp_PntGetNearPnt () const
     Returns near point of intersector. This method returns zero point for the base class.
    virtual const gp_PntGetFarPnt () const
     Returns far point of intersector. This method returns zero point for the base class.
    virtual const gp_DirGetViewRayDirection () const
     Returns direction ray of intersector. This method returns zero direction for the base class.
    virtual const gp_Pnt2dGetMousePosition () const
     Returns current mouse coordinates. This method returns infinite point for the base class.
    virtual void GetPlanes (NCollection_DynamicArray< NCollection_Vec4< double > > &thePlaneEquations) const
     Stores plane equation coefficients (in the following form: Ax + By + Cz + D = 0) to the given vector. This method only clears input vector for the base class.
    virtual bool OverlapsBox (const NCollection_Vec3< double > &theBoxMin, const NCollection_Vec3< double > &theBoxMax, const SelectMgr_ViewClipRange &theClipRange, SelectBasics_PickResult &thePickResult) const =0
     SAT intersection test between defined volume and given axis-aligned box.
    virtual bool OverlapsBox (const NCollection_Vec3< double > &theBoxMin, const NCollection_Vec3< double > &theBoxMax, bool *theInside=nullptr) const =0
     Returns true if selecting volume is overlapped by axis-aligned bounding box with minimum corner at point theMinPt and maximum at point theMaxPt.
    virtual bool OverlapsPoint (const gp_Pnt &thePnt, const SelectMgr_ViewClipRange &theClipRange, SelectBasics_PickResult &thePickResult) const =0
     Intersection test between defined volume and given point.
    virtual bool OverlapsPoint (const gp_Pnt &thePnt) const =0
     Intersection test between defined volume and given point Does not perform depth calculation, so this method is defined as helper function for inclusion test. Therefore, its implementation makes sense only for rectangular frustum with box selection mode activated.
    virtual bool OverlapsPolygon (const NCollection_Array1< gp_Pnt > &theArrayOfPnts, Select3D_TypeOfSensitivity theSensType, const SelectMgr_ViewClipRange &theClipRange, SelectBasics_PickResult &thePickResult) const =0
     SAT intersection test between defined volume and given ordered set of points, representing line segments. The test may be considered of interior part or boundary line defined by segments depending on given sensitivity type.
    virtual bool OverlapsSegment (const gp_Pnt &thePnt1, const gp_Pnt &thePnt2, const SelectMgr_ViewClipRange &theClipRange, SelectBasics_PickResult &thePickResult) const =0
     Checks if line segment overlaps selecting frustum.
    virtual bool OverlapsTriangle (const gp_Pnt &thePnt1, const gp_Pnt &thePnt2, const gp_Pnt &thePnt3, Select3D_TypeOfSensitivity theSensType, const SelectMgr_ViewClipRange &theClipRange, SelectBasics_PickResult &thePickResult) const =0
     SAT intersection test between defined volume and given triangle. The test may be considered of interior part or boundary line defined by triangle vertices depending on given sensitivity type.
    virtual bool OverlapsSphere (const gp_Pnt &theCenter, const double theRadius, bool *theInside=nullptr) const =0
     Returns true if selecting volume is overlapped by sphere with center theCenter and radius theRadius.
    virtual bool OverlapsSphere (const gp_Pnt &theCenter, const double theRadius, const SelectMgr_ViewClipRange &theClipRange, SelectBasics_PickResult &thePickResult) const =0
     Returns true if selecting volume is overlapped by sphere with center theCenter and radius theRadius.
    virtual bool OverlapsCylinder (const double theBottomRad, const double theTopRad, const double theHeight, const gp_Trsf &theTrsf, const bool theIsHollow, const SelectMgr_ViewClipRange &theClipRange, SelectBasics_PickResult &thePickResult) const =0
     Returns true if selecting volume is overlapped by cylinder (or cone) with radiuses theBottomRad and theTopRad, height theHeight and transformation to apply theTrsf.
    virtual bool OverlapsCylinder (const double theBottomRad, const double theTopRad, const double theHeight, const gp_Trsf &theTrsf, const bool theIsHollow, bool *theInside=nullptr) const =0
     Returns true if selecting volume is overlapped by cylinder (or cone) with radiuses theBottomRad and theTopRad, height theHeight and transformation to apply theTrsf.
    virtual bool OverlapsCircle (const double theBottomRad, const gp_Trsf &theTrsf, const bool theIsFilled, const SelectMgr_ViewClipRange &theClipRange, SelectBasics_PickResult &thePickResult) const =0
     Returns true if selecting volume is overlapped by circle with radius theRadius, boolean theIsFilled and transformation to apply theTrsf. The position and orientation of the circle are specified via theTrsf transformation for gp::XOY() with center in gp::Origin().
    virtual bool OverlapsCircle (const double theBottomRad, const gp_Trsf &theTrsf, const bool theIsFilled, bool *theInside=nullptr) const =0
     Returns true if selecting volume is overlapped by circle with radius theRadius, boolean theIsFilled and transformation to apply theTrsf. The position and orientation of the circle are specified via theTrsf transformation for gp::XOY() with center in gp::Origin().
    virtual double DistToGeometryCenter (const gp_Pnt &theCOG) const
     Measures distance between 3d projection of user-picked screen point and given point theCOG. It makes sense only for intersectors built on a single point. This method returns infinite value for the base class.
    virtual gp_Pnt DetectedPoint (const double theDepth) const
     Calculates the point on a view ray that was detected during the run of selection algo by given depth. It makes sense only for intersectors built on a single point. This method returns infinite point for the base class.
    virtual bool RaySphereIntersection (const gp_Pnt &theCenter, const double theRadius, const gp_Pnt &theLoc, const gp_Dir &theRayDir, double &theTimeEnter, double &theTimeLeave) const
     Checks whether the ray that starts at the point theLoc and directs with the direction theRayDir intersects with the sphere with center at theCenter and radius TheRadius.
    virtual bool RayCylinderIntersection (const double theBottomRadius, const double theTopRadius, const double theHeight, const gp_Pnt &theLoc, const gp_Dir &theRayDir, const bool theIsHollow, double &theTimeEnter, double &theTimeLeave) const
     Checks whether the ray that starts at the point theLoc and directs with the direction theRayDir intersects with the hollow cylinder (or cone).
    virtual bool RayCircleIntersection (const double theRadius, const gp_Pnt &theLoc, const gp_Dir &theRayDir, const bool theIsFilled, double &theTime) const
     Checks whether the ray that starts at the point theLoc and directs with the direction theRayDir intersects with the circle.
    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.

    Protected Attributes

    int myPixelTolerance
     Pixel tolerance.
    occ::handle< SelectMgr_FrustumBuildermyBuilder
     A tool implementing methods for volume build.
    Protected Attributes inherited from SelectMgr_BaseIntersector
    occ::handle< Graphic3d_CameramyCamera
     camera definition (if builder isn't NULL it is the same as its camera)
    SelectMgr_SelectionType mySelectionType
     type of selection

    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

    This class is an interface for different types of selecting frustums, defining different selection types, like point, box or polyline selection. It contains signatures of functions for detection of overlap by sensitive entity and initializes some data for building the selecting frustum.

    Constructor & Destructor Documentation

    ◆ SelectMgr_BaseFrustum()

    SelectMgr_BaseFrustum::SelectMgr_BaseFrustum ( )

    Creates new selecting volume with pixel tolerance set to 2, orthographic camera and empty frustum builder.

    ◆ ~SelectMgr_BaseFrustum()

    SelectMgr_BaseFrustum::~SelectMgr_BaseFrustum ( )
    overridedefault

    Destructor.

    Member Function Documentation

    ◆ DumpJson()

    void SelectMgr_BaseFrustum::DumpJson ( Standard_OStream & theOStream,
    int theDepth = -1 ) const
    overridevirtual

    ◆ IsBoundaryIntersectSphere()

    bool SelectMgr_BaseFrustum::IsBoundaryIntersectSphere ( const gp_Pnt & theCenter,
    const double theRadius,
    const gp_Dir & thePlaneNormal,
    const NCollection_Array1< gp_Pnt > & theBoundaries,
    bool & theBoundaryInside ) const

    Checks whether the boundary of the current volume selection intersects with a sphere or are there it's boundaries lying inside the sphere.

    ◆ SetBuilder()

    void SelectMgr_BaseFrustum::SetBuilder ( const occ::handle< SelectMgr_FrustumBuilder > & theBuilder)

    Nullifies the builder created in the constructor and copies the pointer given.

    ◆ SetCamera()

    void SelectMgr_BaseFrustum::SetCamera ( const occ::handle< Graphic3d_Camera > & theCamera)
    overridevirtual

    Saves camera definition and passes it to builder.

    Reimplemented from SelectMgr_BaseIntersector.

    ◆ SetPixelTolerance()

    void SelectMgr_BaseFrustum::SetPixelTolerance ( const int theTol)
    overridevirtual

    Sets pixel tolerance. It makes sense only for scalable intersectors (built on a single point). This method does nothing for the base class.

    Reimplemented from SelectMgr_BaseIntersector.

    ◆ SetViewport()

    void SelectMgr_BaseFrustum::SetViewport ( const double theX,
    const double theY,
    const double theWidth,
    const double theHeight )
    overridevirtual

    Passes viewport parameters to builder.

    Reimplemented from SelectMgr_BaseIntersector.

    ◆ SetWindowSize()

    void SelectMgr_BaseFrustum::SetWindowSize ( const int theWidth,
    const int theHeight )
    overridevirtual

    Sets current window size. This method does nothing for the base class.

    Reimplemented from SelectMgr_BaseIntersector.

    ◆ WindowSize()

    void SelectMgr_BaseFrustum::WindowSize ( int & theWidth,
    int & theHeight ) const
    overridevirtual

    Returns current window size. This method doesn't set any output values for the base class.

    Reimplemented from SelectMgr_BaseIntersector.

    Field Documentation

    ◆ myBuilder

    occ::handle<SelectMgr_FrustumBuilder> SelectMgr_BaseFrustum::myBuilder
    protected

    A tool implementing methods for volume build.

    ◆ myPixelTolerance

    int SelectMgr_BaseFrustum::myPixelTolerance
    protected

    Pixel tolerance.


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