Open CASCADE Technology  7.7.0.dev
Data Structures | Public Member Functions

SelectMgr_TriangularFrustumSet Class Reference

This class is used to handle polyline selection. The main principle of polyline selection algorithm is to split the polygon defined by polyline onto triangles. Than each of them is considered as a base for triangular frustum building. In other words, each triangle vertex will be projected from 2d screen space to 3d world space onto near and far view frustum planes. Thus, the projected triangles make up the bases of selecting frustum. When the set of such frustums is created, the function determining selection iterates through triangular frustum set and searches for overlap with any frustum. More...

#include <SelectMgr_TriangularFrustumSet.hxx>

Inheritance diagram for SelectMgr_TriangularFrustumSet:
Inheritance graph
[legend]

Data Structures

struct  SelectionPolyline
 Auxiliary structure to define selection polyline. More...
 

Public Member Functions

 SelectMgr_TriangularFrustumSet ()
 Constructor. More...
 
virtual ~SelectMgr_TriangularFrustumSet ()
 Destructor. More...
 
void Init (const TColgp_Array1OfPnt2d &thePoints)
 Initializes set of triangular frustums by polyline. More...
 
virtual void Build () override
 Meshes polygon bounded by polyline. Than organizes a set of triangular frustums, where each triangle's projection onto near and far view frustum planes is considered as a frustum base NOTE: it should be called after Init() method. More...
 
virtual Standard_Boolean IsScalable () const override
 Returns FALSE (not applicable to this volume). More...
 
virtual Handle< SelectMgr_BaseIntersectorScaleAndTransform (const Standard_Integer theScale, const gp_GTrsf &theTrsf, const Handle< SelectMgr_FrustumBuilder > &theBuilder) const override
 Returns a copy of the frustum with all sub-volumes transformed according to the matrix given. More...
 
virtual Standard_Boolean OverlapsBox (const SelectMgr_Vec3 &theMinPnt, const SelectMgr_Vec3 &theMaxPnt, const SelectMgr_ViewClipRange &theClipRange, SelectBasics_PickResult &thePickResult) const override
 SAT intersection test between defined volume and given axis-aligned box. More...
 
virtual Standard_Boolean OverlapsBox (const SelectMgr_Vec3 &theMinPnt, const SelectMgr_Vec3 &theMaxPnt, Standard_Boolean *theInside) const override
 Returns true if selecting volume is overlapped by axis-aligned bounding box with minimum corner at point theMinPt and maximum at point theMaxPt. More...
 
virtual Standard_Boolean OverlapsPoint (const gp_Pnt &thePnt, const SelectMgr_ViewClipRange &theClipRange, SelectBasics_PickResult &thePickResult) const override
 Intersection test between defined volume and given point. More...
 
virtual Standard_Boolean OverlapsPoint (const gp_Pnt &) const override
 Always returns FALSE (not applicable to this selector). More...
 
virtual Standard_Boolean OverlapsPolygon (const TColgp_Array1OfPnt &theArrayOfPnts, Select3D_TypeOfSensitivity theSensType, const SelectMgr_ViewClipRange &theClipRange, SelectBasics_PickResult &thePickResult) const override
 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. More...
 
virtual Standard_Boolean OverlapsSegment (const gp_Pnt &thePnt1, const gp_Pnt &thePnt2, const SelectMgr_ViewClipRange &theClipRange, SelectBasics_PickResult &thePickResult) const override
 Checks if line segment overlaps selecting frustum. More...
 
virtual Standard_Boolean OverlapsTriangle (const gp_Pnt &thePnt1, const gp_Pnt &thePnt2, const gp_Pnt &thePnt3, Select3D_TypeOfSensitivity theSensType, const SelectMgr_ViewClipRange &theClipRange, SelectBasics_PickResult &thePickResult) const override
 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. More...
 
virtual gp_Pnt DetectedPoint (const Standard_Real theDepth) const override
 Calculates the point on a view ray that was detected during the run of selection algo by given depth. More...
 
virtual Standard_Boolean OverlapsSphere (const gp_Pnt &theCenter, const Standard_Real theRadius, Standard_Boolean *theInside=NULL) const override
 Returns true if selecting volume is overlapped by sphere with center theCenter and radius theRadius. More...
 
virtual Standard_Boolean OverlapsSphere (const gp_Pnt &theCenter, const Standard_Real theRadius, const SelectMgr_ViewClipRange &theClipRange, SelectBasics_PickResult &thePickResult) const override
 Returns true if selecting volume is overlapped by sphere with center theCenter and radius theRadius. More...
 
virtual Standard_Boolean OverlapsCylinder (const Standard_Real theBottomRad, const Standard_Real theTopRad, const Standard_Real theHeight, const gp_Trsf &theTrsf, const SelectMgr_ViewClipRange &theClipRange, SelectBasics_PickResult &thePickResult) const override
 Returns true if selecting volume is overlapped by cylinder (or cone) with radiuses theBottomRad and theTopRad, height theHeight and transformation to apply theTrsf. More...
 
virtual Standard_Boolean OverlapsCylinder (const Standard_Real theBottomRad, const Standard_Real theTopRad, const Standard_Real theHeight, const gp_Trsf &theTrsf, Standard_Boolean *theInside=NULL) const override
 Returns true if selecting volume is overlapped by cylinder (or cone) with radiuses theBottomRad and theTopRad, height theHeight and transformation to apply theTrsf. More...
 
virtual void GetPlanes (NCollection_Vector< SelectMgr_Vec4 > &thePlaneEquations) const override
 Stores plane equation coefficients (in the following form: Ax + By + Cz + D = 0) to the given vector. More...
 
virtual void SetAllowOverlapDetection (const Standard_Boolean theIsToAllow)
 If theIsToAllow is false, only fully included sensitives will be detected, otherwise the algorithm will mark both included and overlapped entities as matched. More...
 
virtual void DumpJson (Standard_OStream &theOStream, Standard_Integer theDepth=-1) const override
 Dumps the content of me into the stream. More...
 
- Public Member Functions inherited from SelectMgr_BaseFrustum
 SelectMgr_BaseFrustum ()
 Creates new selecting volume with pixel tolerance set to 2, orthographic camera and empty frustum builder. More...
 
virtual ~SelectMgr_BaseFrustum ()
 Destructor. More...
 
void SetBuilder (const Handle< SelectMgr_FrustumBuilder > &theBuilder)
 Nullifies the builder created in the constructor and copies the pointer given. More...
 
virtual void SetCamera (const Handle< Graphic3d_Camera > &theCamera) override
 Saves camera definition and passes it to builder. More...
 
virtual void SetPixelTolerance (const Standard_Integer 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. More...
 
virtual void SetWindowSize (const Standard_Integer theWidth, const Standard_Integer theHeight) override
 Sets current window size. This method does nothing for the base class. More...
 
virtual void WindowSize (Standard_Integer &theWidth, Standard_Integer &theHeight) const override
 Returns current window size. This method doesn't set any output values for the base class. More...
 
virtual void SetViewport (const Standard_Real theX, const Standard_Real theY, const Standard_Real theWidth, const Standard_Real theHeight) override
 Passes viewport parameters to builder. More...
 
Standard_Boolean IsBoundaryIntersectSphere (const gp_Pnt &theCenter, const Standard_Real theRadius, const gp_Dir &thePlaneNormal, const TColgp_Array1OfPnt &theBoundaries, Standard_Boolean &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. More...
 
- Public Member Functions inherited from SelectMgr_BaseIntersector
 SelectMgr_BaseIntersector ()
 Creates new empty selecting volume. More...
 
virtual ~SelectMgr_BaseIntersector ()
 Destructor. More...
 
SelectMgr_SelectionType GetSelectionType () const
 Returns selection type of this intersector. More...
 
const Handle< Graphic3d_Camera > & Camera () const
 Return camera definition. More...
 
virtual const gp_PntGetNearPnt () const
 Returns near point of intersector. This method returns zero point for the base class. More...
 
virtual const gp_PntGetFarPnt () const
 Returns far point of intersector. This method returns zero point for the base class. More...
 
virtual const gp_DirGetViewRayDirection () const
 Returns direction ray of intersector. This method returns zero direction for the base class. More...
 
virtual const gp_Pnt2dGetMousePosition () const
 Returns current mouse coordinates. This method returns infinite point for the base class. More...
 
virtual Standard_Real 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. More...
 
virtual Standard_Boolean RaySphereIntersection (const gp_Pnt &theCenter, const Standard_Real theRadius, const gp_Pnt &theLoc, const gp_Dir &theRayDir, Standard_Real &theTimeEnter, Standard_Real &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. More...
 
virtual Standard_Boolean RayCylinderIntersection (const Standard_Real theBottomRadius, const Standard_Real theTopRadius, const Standard_Real theHeight, const gp_Pnt &theLoc, const gp_Dir &theRayDir, Standard_Real &theTimeEnter, Standard_Real &theTimeLeave) const
 Checks whether the ray that starts at the point theLoc and directs with the direction theRayDir intersects with the cylinder (or cone) with radiuses theBottomRad and theTopRad and height theHeights. More...
 
- Public Member Functions inherited from Standard_Transient
 Standard_Transient ()
 Empty constructor. More...
 
 Standard_Transient (const Standard_Transient &)
 Copy constructor – does nothing. More...
 
Standard_Transientoperator= (const Standard_Transient &)
 Assignment operator, needed to avoid copying reference counter. More...
 
virtual ~Standard_Transient ()
 Destructor must be virtual. More...
 
virtual void Delete () const
 Memory deallocator for transient classes. More...
 
virtual const opencascade::handle< Standard_Type > & DynamicType () const
 Returns a type descriptor about this object. More...
 
Standard_Boolean IsInstance (const opencascade::handle< Standard_Type > &theType) const
 Returns a true value if this is an instance of Type. More...
 
Standard_Boolean IsInstance (const Standard_CString theTypeName) const
 Returns a true value if this is an instance of TypeName. More...
 
Standard_Boolean 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. More...
 
Standard_Boolean IsKind (const Standard_CString 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. More...
 
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. More...
 
Standard_Integer GetRefCount () const
 Get the reference counter of this object. More...
 
void IncrementRefCounter () const
 Increments the reference counter of this object. More...
 
Standard_Integer DecrementRefCounter () const
 Decrements the reference counter of this object; returns the decremented value. More...
 

Additional Inherited Members

- Public Types inherited from Standard_Transient
typedef void base_type
 Returns a type descriptor about this object. More...
 
- Static Public Member Functions inherited from Standard_Transient
static const char * get_type_name ()
 Returns a type descriptor about this object. More...
 
static const opencascade::handle< Standard_Type > & get_type_descriptor ()
 Returns type descriptor of Standard_Transient class. More...
 
- Protected Attributes inherited from SelectMgr_BaseFrustum
Standard_Integer myPixelTolerance
 Pixel tolerance. More...
 
Handle< SelectMgr_FrustumBuildermyBuilder
 A tool implementing methods for volume build. More...
 
- Protected Attributes inherited from SelectMgr_BaseIntersector
Handle< Graphic3d_CameramyCamera
 camera definition (if builder isn't NULL it is the same as its camera) More...
 
SelectMgr_SelectionType mySelectionType
 type of selection More...
 

Detailed Description

This class is used to handle polyline selection. The main principle of polyline selection algorithm is to split the polygon defined by polyline onto triangles. Than each of them is considered as a base for triangular frustum building. In other words, each triangle vertex will be projected from 2d screen space to 3d world space onto near and far view frustum planes. Thus, the projected triangles make up the bases of selecting frustum. When the set of such frustums is created, the function determining selection iterates through triangular frustum set and searches for overlap with any frustum.

Constructor & Destructor Documentation

◆ SelectMgr_TriangularFrustumSet()

SelectMgr_TriangularFrustumSet::SelectMgr_TriangularFrustumSet ( )

Constructor.

◆ ~SelectMgr_TriangularFrustumSet()

virtual SelectMgr_TriangularFrustumSet::~SelectMgr_TriangularFrustumSet ( )
virtual

Destructor.

Member Function Documentation

◆ Build()

virtual void SelectMgr_TriangularFrustumSet::Build ( )
overridevirtual

Meshes polygon bounded by polyline. Than organizes a set of triangular frustums, where each triangle's projection onto near and far view frustum planes is considered as a frustum base NOTE: it should be called after Init() method.

Implements SelectMgr_BaseIntersector.

◆ DetectedPoint()

virtual gp_Pnt SelectMgr_TriangularFrustumSet::DetectedPoint ( const Standard_Real  theDepth) const
overridevirtual

Calculates the point on a view ray that was detected during the run of selection algo by given depth.

Reimplemented from SelectMgr_BaseIntersector.

◆ DumpJson()

virtual void SelectMgr_TriangularFrustumSet::DumpJson ( Standard_OStream theOStream,
Standard_Integer  theDepth = -1 
) const
overridevirtual

Dumps the content of me into the stream.

Reimplemented from SelectMgr_BaseFrustum.

◆ GetPlanes()

virtual void SelectMgr_TriangularFrustumSet::GetPlanes ( NCollection_Vector< SelectMgr_Vec4 > &  thePlaneEquations) const
overridevirtual

Stores plane equation coefficients (in the following form: Ax + By + Cz + D = 0) to the given vector.

Reimplemented from SelectMgr_BaseIntersector.

◆ Init()

void SelectMgr_TriangularFrustumSet::Init ( const TColgp_Array1OfPnt2d thePoints)

Initializes set of triangular frustums by polyline.

◆ IsScalable()

virtual Standard_Boolean SelectMgr_TriangularFrustumSet::IsScalable ( ) const
inlineoverridevirtual

Returns FALSE (not applicable to this volume).

Implements SelectMgr_BaseIntersector.

◆ OverlapsBox() [1/2]

virtual Standard_Boolean SelectMgr_TriangularFrustumSet::OverlapsBox ( const SelectMgr_Vec3 theBoxMin,
const SelectMgr_Vec3 theBoxMax,
const SelectMgr_ViewClipRange theClipRange,
SelectBasics_PickResult thePickResult 
) const
overridevirtual

SAT intersection test between defined volume and given axis-aligned box.

Implements SelectMgr_BaseIntersector.

◆ OverlapsBox() [2/2]

virtual Standard_Boolean SelectMgr_TriangularFrustumSet::OverlapsBox ( const SelectMgr_Vec3 theBoxMin,
const SelectMgr_Vec3 theBoxMax,
Standard_Boolean theInside 
) const
overridevirtual

Returns true if selecting volume is overlapped by axis-aligned bounding box with minimum corner at point theMinPt and maximum at point theMaxPt.

Implements SelectMgr_BaseIntersector.

◆ OverlapsCylinder() [1/2]

virtual Standard_Boolean SelectMgr_TriangularFrustumSet::OverlapsCylinder ( const Standard_Real  theBottomRad,
const Standard_Real  theTopRad,
const Standard_Real  theHeight,
const gp_Trsf theTrsf,
const SelectMgr_ViewClipRange theClipRange,
SelectBasics_PickResult thePickResult 
) const
overridevirtual

Returns true if selecting volume is overlapped by cylinder (or cone) with radiuses theBottomRad and theTopRad, height theHeight and transformation to apply theTrsf.

Implements SelectMgr_BaseIntersector.

◆ OverlapsCylinder() [2/2]

virtual Standard_Boolean SelectMgr_TriangularFrustumSet::OverlapsCylinder ( const Standard_Real  theBottomRad,
const Standard_Real  theTopRad,
const Standard_Real  theHeight,
const gp_Trsf theTrsf,
Standard_Boolean theInside = NULL 
) const
overridevirtual

Returns true if selecting volume is overlapped by cylinder (or cone) with radiuses theBottomRad and theTopRad, height theHeight and transformation to apply theTrsf.

Implements SelectMgr_BaseIntersector.

◆ OverlapsPoint() [1/2]

virtual Standard_Boolean SelectMgr_TriangularFrustumSet::OverlapsPoint ( const gp_Pnt ) const
inlineoverridevirtual

Always returns FALSE (not applicable to this selector).

Implements SelectMgr_BaseIntersector.

◆ OverlapsPoint() [2/2]

virtual Standard_Boolean SelectMgr_TriangularFrustumSet::OverlapsPoint ( const gp_Pnt thePnt,
const SelectMgr_ViewClipRange theClipRange,
SelectBasics_PickResult thePickResult 
) const
overridevirtual

Intersection test between defined volume and given point.

Implements SelectMgr_BaseIntersector.

◆ OverlapsPolygon()

virtual Standard_Boolean SelectMgr_TriangularFrustumSet::OverlapsPolygon ( const TColgp_Array1OfPnt theArrayOfPnts,
Select3D_TypeOfSensitivity  theSensType,
const SelectMgr_ViewClipRange theClipRange,
SelectBasics_PickResult thePickResult 
) const
overridevirtual

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.

Implements SelectMgr_BaseIntersector.

◆ OverlapsSegment()

virtual Standard_Boolean SelectMgr_TriangularFrustumSet::OverlapsSegment ( const gp_Pnt thePnt1,
const gp_Pnt thePnt2,
const SelectMgr_ViewClipRange theClipRange,
SelectBasics_PickResult thePickResult 
) const
overridevirtual

Checks if line segment overlaps selecting frustum.

Implements SelectMgr_BaseIntersector.

◆ OverlapsSphere() [1/2]

virtual Standard_Boolean SelectMgr_TriangularFrustumSet::OverlapsSphere ( const gp_Pnt theCenter,
const Standard_Real  theRadius,
const SelectMgr_ViewClipRange theClipRange,
SelectBasics_PickResult thePickResult 
) const
overridevirtual

Returns true if selecting volume is overlapped by sphere with center theCenter and radius theRadius.

Implements SelectMgr_BaseIntersector.

◆ OverlapsSphere() [2/2]

virtual Standard_Boolean SelectMgr_TriangularFrustumSet::OverlapsSphere ( const gp_Pnt theCenter,
const Standard_Real  theRadius,
Standard_Boolean theInside = NULL 
) const
overridevirtual

Returns true if selecting volume is overlapped by sphere with center theCenter and radius theRadius.

Implements SelectMgr_BaseIntersector.

◆ OverlapsTriangle()

virtual Standard_Boolean SelectMgr_TriangularFrustumSet::OverlapsTriangle ( const gp_Pnt thePnt1,
const gp_Pnt thePnt2,
const gp_Pnt thePnt3,
Select3D_TypeOfSensitivity  theSensType,
const SelectMgr_ViewClipRange theClipRange,
SelectBasics_PickResult thePickResult 
) const
overridevirtual

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.

Implements SelectMgr_BaseIntersector.

◆ ScaleAndTransform()

virtual Handle< SelectMgr_BaseIntersector > SelectMgr_TriangularFrustumSet::ScaleAndTransform ( const Standard_Integer  theScale,
const gp_GTrsf theTrsf,
const Handle< SelectMgr_FrustumBuilder > &  theBuilder 
) const
overridevirtual

Returns a copy of the frustum with all sub-volumes transformed according to the matrix given.

Implements SelectMgr_BaseIntersector.

◆ SetAllowOverlapDetection()

virtual void SelectMgr_TriangularFrustumSet::SetAllowOverlapDetection ( const Standard_Boolean  theIsToAllow)
virtual

If theIsToAllow is false, only fully included sensitives will be detected, otherwise the algorithm will mark both included and overlapped entities as matched.


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