Open CASCADE Technology  7.6.0.dev
Public Member Functions
SelectMgr_TriangularFrustum Class Reference

This class contains representation of triangular selecting frustum, created in case of polyline selection, and algorithms for overlap detection between selecting frustum and sensitive entities. Overlap detection tests are implemented according to the terms of separating axis theorem (SAT). More...

#include <SelectMgr_TriangularFrustum.hxx>

Inheritance diagram for SelectMgr_TriangularFrustum:
Inheritance graph
[legend]

Public Member Functions

 SelectMgr_TriangularFrustum ()
 Creates new triangular frustum with bases of triangles with vertices theP1, theP2 and theP3 projections onto near and far view frustum planes. More...
 
 ~SelectMgr_TriangularFrustum ()
 
virtual void Build (const gp_Pnt2d &theP1, const gp_Pnt2d &theP2, const gp_Pnt2d &theP3) override
 Creates new triangular frustum with bases of triangles with vertices theP1, theP2 and theP3 projections onto near and far view frustum planes (only for triangular frustums) More...
 
virtual Handle< SelectMgr_BaseFrustumScaleAndTransform (const Standard_Integer theScale, const gp_GTrsf &theTrsf) const override
 Returns a copy of the frustum transformed according to the matrix given. More...
 
virtual Standard_Boolean Overlaps (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 Overlaps (const SelectMgr_Vec3 &theMinPt, const SelectMgr_Vec3 &theMaxPt, 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 Overlaps (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 Overlaps (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 Overlaps (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 Overlaps (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...
 
void Clear ()
 Nullifies the handle to corresponding builder instance to prevent memory leaks. 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 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_Frustum< 3 >
 SelectMgr_Frustum ()
 
- Public Member Functions inherited from SelectMgr_BaseFrustum
 SelectMgr_BaseFrustum ()
 Creates new selecting volume with pixel toletance set to 2, orthographic camera and empty frustum builder. More...
 
virtual ~SelectMgr_BaseFrustum ()
 
const Handle< Graphic3d_Camera > & Camera () const
 Return camera definition. More...
 
void SetCamera (const Handle< Graphic3d_Camera > &theCamera)
 Passes camera projection and orientation matrices to builder. More...
 
void SetCamera (const Graphic3d_Mat4d &theProjection, const Graphic3d_Mat4d &theWorldView, const Standard_Boolean theIsOrthographic, const Graphic3d_WorldViewProjState &theWVPState=Graphic3d_WorldViewProjState())
 Passes camera projection and orientation matrices to builder. More...
 
const Graphic3d_Mat4dProjectionMatrix () const
 
const Graphic3d_Mat4dWorldViewMatrix () const
 
const Graphic3d_WorldViewProjStateWorldViewProjState () const
 
void SetPixelTolerance (const Standard_Integer theTol)
 
void SetWindowSize (const Standard_Integer theWidth, const Standard_Integer theHeight)
 
void WindowSize (Standard_Integer &theWidth, Standard_Integer &theHeight) const
 
void SetViewport (const Standard_Real theX, const Standard_Real theY, const Standard_Real theWidth, const Standard_Real theHeight)
 Passes viewport parameters to builder. More...
 
void SetBuilder (const Handle< SelectMgr_FrustumBuilder > &theBuilder)
 Nullifies the builder created in the constructor and copies the pointer given. More...
 
virtual void Build (const gp_Pnt2d &)
 Builds volume according to the point and given pixel tolerance. More...
 
virtual void Build (const gp_Pnt2d &, const gp_Pnt2d &)
 Builds volume according to the selected rectangle. More...
 
virtual void Build (const TColgp_Array1OfPnt2d &)
 Builds selecting volumes set according to polyline points. More...
 
virtual Standard_Boolean Overlaps (const gp_Pnt &thePnt) const
 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. More...
 
virtual Standard_Real DistToGeometryCenter (const gp_Pnt &theCOG) const
 Measures distance between 3d projection of user-picked screen point and given point theCOG. More...
 
virtual gp_Pnt DetectedPoint (const Standard_Real theDepth) const
 
- 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 Member Functions inherited from SelectMgr_Frustum< 3 >
Standard_Boolean hasOverlap (const SelectMgr_Vec3 &theBoxMin, const SelectMgr_Vec3 &theBoxMax, Standard_Boolean *theInside=NULL) const
 Returns true if selecting volume is overlapped by axis-aligned bounding box with minimum corner at point theMinPt and maximum at point theMaxPt. More...
 
Standard_Boolean hasOverlap (const gp_Pnt &thePnt) const
 SAT intersection test between defined volume and given point. More...
 
Standard_Boolean hasOverlap (const gp_Pnt &thePnt1, const gp_Pnt &thePnt2) const
 SAT intersection test between defined volume and given segment. More...
 
Standard_Boolean hasOverlap (const TColgp_Array1OfPnt &theArrayOfPnts, gp_Vec &theNormal) const
 SAT intersection test between frustum given and planar convex polygon represented as ordered point set. More...
 
Standard_Boolean hasOverlap (const gp_Pnt &thePnt1, const gp_Pnt &thePnt2, const gp_Pnt &thePnt3, gp_Vec &theNormal) const
 SAT intersection test between defined volume and given triangle. More...
 
- Protected Attributes inherited from SelectMgr_Frustum< 3 >
gp_Vec myPlanes [N+2]
 Plane equations. More...
 
gp_Pnt myVertices [N *2]
 Vertices coordinates. More...
 
Standard_Real myMaxVertsProjections [N+2]
 Cached projections of vertices onto frustum plane directions. More...
 
Standard_Real myMinVertsProjections [N+2]
 Cached projections of vertices onto frustum plane directions. More...
 
Standard_Real myMaxOrthoVertsProjections [3]
 Cached projections of vertices onto directions of ortho unit vectors. More...
 
Standard_Real myMinOrthoVertsProjections [3]
 Cached projections of vertices onto directions of ortho unit vectors. More...
 
gp_Vec myEdgeDirs [6]
 Cached edge directions. More...
 
- Protected Attributes inherited from SelectMgr_BaseFrustum
Standard_Integer myPixelTolerance
 Pixel tolerance. More...
 
Standard_Boolean myIsOrthographic
 Defines if current camera is orthographic. More...
 
Handle< SelectMgr_FrustumBuildermyBuilder
 A tool implementing methods for volume build. More...
 
Handle< Graphic3d_CameramyCamera
 camera definition More...
 

Detailed Description

This class contains representation of triangular selecting frustum, created in case of polyline selection, and algorithms for overlap detection between selecting frustum and sensitive entities. Overlap detection tests are implemented according to the terms of separating axis theorem (SAT).

Constructor & Destructor Documentation

◆ SelectMgr_TriangularFrustum()

SelectMgr_TriangularFrustum::SelectMgr_TriangularFrustum ( )
inline

Creates new triangular frustum with bases of triangles with vertices theP1, theP2 and theP3 projections onto near and far view frustum planes.

◆ ~SelectMgr_TriangularFrustum()

SelectMgr_TriangularFrustum::~SelectMgr_TriangularFrustum ( )

Member Function Documentation

◆ Build()

virtual void SelectMgr_TriangularFrustum::Build ( const gp_Pnt2d theP1,
const gp_Pnt2d theP2,
const gp_Pnt2d theP3 
)
overridevirtual

Creates new triangular frustum with bases of triangles with vertices theP1, theP2 and theP3 projections onto near and far view frustum planes (only for triangular frustums)

Reimplemented from SelectMgr_BaseFrustum.

◆ Clear()

void SelectMgr_TriangularFrustum::Clear ( )

Nullifies the handle to corresponding builder instance to prevent memory leaks.

◆ DumpJson()

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

Dumps the content of me into the stream.

Reimplemented from SelectMgr_Frustum< 3 >.

◆ GetPlanes()

virtual void SelectMgr_TriangularFrustum::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_BaseFrustum.

◆ Overlaps() [1/6]

virtual Standard_Boolean SelectMgr_TriangularFrustum::Overlaps ( const SelectMgr_Vec3 theMinPnt,
const SelectMgr_Vec3 theMaxPnt,
const SelectMgr_ViewClipRange theClipRange,
SelectBasics_PickResult thePickResult 
) const
overridevirtual

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

Reimplemented from SelectMgr_BaseFrustum.

◆ Overlaps() [2/6]

virtual Standard_Boolean SelectMgr_TriangularFrustum::Overlaps ( const SelectMgr_Vec3 theMinPt,
const SelectMgr_Vec3 theMaxPt,
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.

Reimplemented from SelectMgr_BaseFrustum.

◆ Overlaps() [3/6]

virtual Standard_Boolean SelectMgr_TriangularFrustum::Overlaps ( const gp_Pnt thePnt,
const SelectMgr_ViewClipRange theClipRange,
SelectBasics_PickResult thePickResult 
) const
overridevirtual

Intersection test between defined volume and given point.

Reimplemented from SelectMgr_BaseFrustum.

◆ Overlaps() [4/6]

virtual Standard_Boolean SelectMgr_TriangularFrustum::Overlaps ( 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.

Reimplemented from SelectMgr_BaseFrustum.

◆ Overlaps() [5/6]

virtual Standard_Boolean SelectMgr_TriangularFrustum::Overlaps ( const gp_Pnt thePnt1,
const gp_Pnt thePnt2,
const SelectMgr_ViewClipRange theClipRange,
SelectBasics_PickResult thePickResult 
) const
overridevirtual

Checks if line segment overlaps selecting frustum.

Reimplemented from SelectMgr_BaseFrustum.

◆ Overlaps() [6/6]

virtual Standard_Boolean SelectMgr_TriangularFrustum::Overlaps ( 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.

Reimplemented from SelectMgr_BaseFrustum.

◆ ScaleAndTransform()

virtual Handle< SelectMgr_BaseFrustum > SelectMgr_TriangularFrustum::ScaleAndTransform ( const Standard_Integer  theScale,
const gp_GTrsf theTrsf 
) const
overridevirtual

Returns a copy of the frustum transformed according to the matrix given.

Reimplemented from SelectMgr_BaseFrustum.


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