Open CASCADE Technology  7.5.0
Public Member Functions | Protected Member Functions | Protected Attributes
SelectMgr_Frustum< N > Class Template Reference

This is an internal class containing representation of rectangular selecting frustum, created in case of point and box selection, and algorithms for overlap detection between selecting frustum and sensitive entities. The principle of frustum calculation: More...

#include <SelectMgr_Frustum.hxx>

Inheritance diagram for SelectMgr_Frustum< N >:
Inheritance graph
[legend]

Public Member Functions

 SelectMgr_Frustum ()
 
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 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 gp_Pnt2d &, const gp_Pnt2d &, const gp_Pnt2d &)
 Builds volume according to the triangle given. More...
 
virtual void Build (const TColgp_Array1OfPnt2d &)
 Builds selecting volumes set according to polyline points. More...
 
virtual Handle< SelectMgr_BaseFrustumScaleAndTransform (const Standard_Integer, const gp_GTrsf &) const
 IMPORTANT: Scaling makes sense only for frustum built on a single point! Note that this method does not perform any checks on type of the frustum. Returns a copy of the frustum resized according to the scale factor given and transforms it using the matrix given. There are no default parameters, but in case if: More...
 
virtual Standard_Boolean Overlaps (const SelectMgr_Vec3 &theBoxMin, const SelectMgr_Vec3 &theBoxMax, const SelectMgr_ViewClipRange &theClipRange, SelectBasics_PickResult &thePickResult) const
 SAT intersection test between defined volume and given axis-aligned box. More...
 
virtual Standard_Boolean Overlaps (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...
 
virtual Standard_Boolean Overlaps (const gp_Pnt &thePnt, const SelectMgr_ViewClipRange &theClipRange, SelectBasics_PickResult &thePickResult) const
 Intersection test between defined volume and given point. 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_Boolean Overlaps (const TColgp_Array1OfPnt &theArrayOfPnts, Select3D_TypeOfSensitivity theSensType, const SelectMgr_ViewClipRange &theClipRange, SelectBasics_PickResult &thePickResult) const
 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
 Checks if line segment overlaps selecting frustum. More...
 
virtual Standard_Boolean Overlaps (const gp_Pnt &thePt1, const gp_Pnt &thePt2, const gp_Pnt &thePt3, Select3D_TypeOfSensitivity theSensType, const SelectMgr_ViewClipRange &theClipRange, SelectBasics_PickResult &thePickResult) const
 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 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
 
virtual void GetPlanes (NCollection_Vector< SelectMgr_Vec4 > &thePlaneEquations) const
 Stores plane equation coefficients (in the following form: Ax + By + Cz + D = 0) to the given vector. 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...
 

Protected Member Functions

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

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...
 

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...
 

Detailed Description

template<int N>
class SelectMgr_Frustum< N >

This is an internal class containing representation of rectangular selecting frustum, created in case of point and box selection, and algorithms for overlap detection between selecting frustum and sensitive entities. The principle of frustum calculation:

Constructor & Destructor Documentation

◆ SelectMgr_Frustum()

template<int N>
SelectMgr_Frustum< N >::SelectMgr_Frustum ( )
inline

Member Function Documentation

◆ DumpJson()

template<int N>
virtual void SelectMgr_Frustum< N >::DumpJson ( Standard_OStream theOStream,
Standard_Integer  theDepth = -1 
) const
overridevirtual

Dumps the content of me into the stream.

Reimplemented from SelectMgr_BaseFrustum.

Reimplemented in SelectMgr_RectangularFrustum, and SelectMgr_TriangularFrustum.

◆ hasOverlap() [1/5]

template<int N>
Standard_Boolean SelectMgr_Frustum< N >::hasOverlap ( const SelectMgr_Vec3 theBoxMin,
const SelectMgr_Vec3 theBoxMax,
Standard_Boolean theInside = NULL 
) const
protected

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

◆ hasOverlap() [2/5]

template<int N>
Standard_Boolean SelectMgr_Frustum< N >::hasOverlap ( const gp_Pnt thePnt) const
protected

SAT intersection test between defined volume and given point.

◆ hasOverlap() [3/5]

template<int N>
Standard_Boolean SelectMgr_Frustum< N >::hasOverlap ( const gp_Pnt thePnt1,
const gp_Pnt thePnt2 
) const
protected

SAT intersection test between defined volume and given segment.

◆ hasOverlap() [4/5]

template<int N>
Standard_Boolean SelectMgr_Frustum< N >::hasOverlap ( const TColgp_Array1OfPnt theArrayOfPnts,
gp_Vec theNormal 
) const
protected

SAT intersection test between frustum given and planar convex polygon represented as ordered point set.

◆ hasOverlap() [5/5]

template<int N>
Standard_Boolean SelectMgr_Frustum< N >::hasOverlap ( const gp_Pnt thePnt1,
const gp_Pnt thePnt2,
const gp_Pnt thePnt3,
gp_Vec theNormal 
) const
protected

SAT intersection test between defined volume and given triangle.

Field Documentation

◆ myEdgeDirs

template<int N>
gp_Vec SelectMgr_Frustum< N >::myEdgeDirs[6]
protected

Cached edge directions.

◆ myMaxOrthoVertsProjections

template<int N>
Standard_Real SelectMgr_Frustum< N >::myMaxOrthoVertsProjections[3]
protected

Cached projections of vertices onto directions of ortho unit vectors.

◆ myMaxVertsProjections

template<int N>
Standard_Real SelectMgr_Frustum< N >::myMaxVertsProjections[N+2]
protected

Cached projections of vertices onto frustum plane directions.

◆ myMinOrthoVertsProjections

template<int N>
Standard_Real SelectMgr_Frustum< N >::myMinOrthoVertsProjections[3]
protected

Cached projections of vertices onto directions of ortho unit vectors.

◆ myMinVertsProjections

template<int N>
Standard_Real SelectMgr_Frustum< N >::myMinVertsProjections[N+2]
protected

Cached projections of vertices onto frustum plane directions.

◆ myPlanes

template<int N>
gp_Vec SelectMgr_Frustum< N >::myPlanes[N+2]
protected

Plane equations.

◆ myVertices

template<int N>
gp_Pnt SelectMgr_Frustum< N >::myVertices[N *2]
protected

Vertices coordinates.


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