Open CASCADE Technology  7.3.0
Public Member Functions | Protected Member Functions

SelectMgr_RectangularFrustum Class Reference

This class contains 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_RectangularFrustum.hxx>

Inheritance diagram for SelectMgr_RectangularFrustum:
Inheritance graph
[legend]

Public Member Functions

 SelectMgr_RectangularFrustum ()
 
virtual void Build (const gp_Pnt2d &thePoint) override
 Builds volume according to the point and given pixel tolerance. More...
 
virtual void Build (const gp_Pnt2d &theMinPnt, const gp_Pnt2d &theMaxPnt) override
 Builds volume according to the selected rectangle. More...
 
virtual Handle< SelectMgr_BaseFrustumScaleAndTransform (const Standard_Integer theScaleFactor, const gp_GTrsf &theTrsf) const override
 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, Standard_Real &theDepth) override
 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) 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, Standard_Real &theDepth) override
 Intersection test between defined volume and given point. More...
 
virtual Standard_Boolean Overlaps (const gp_Pnt &thePnt) override
 Intersection test between defined volume and given point. More...
 
virtual Standard_Boolean Overlaps (const TColgp_Array1OfPnt &theArrayOfPnts, Select3D_TypeOfSensitivity theSensType, Standard_Real &theDepth) 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, Standard_Real &theDepth) 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, Standard_Real &theDepth) 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 Standard_Real DistToGeometryCenter (const gp_Pnt &theCOG) override
 Measures distance between 3d projection of user-picked screen point and given point theCOG. 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 IsClipped (const Graphic3d_SequenceOfHClipPlane &thePlanes, const Standard_Real theDepth) override
 Checks if the point of sensitive in which selection was detected belongs to the region defined by clipping planes. More...
 
virtual void SetViewClipping (const Handle< Graphic3d_SequenceOfHClipPlane > &thePlanes) override
 Valid for point selection only! Computes depth range for global (defined for the whole view) clipping planes. More...
 
virtual Standard_Boolean SetViewClippingEnabled (const Standard_Boolean theToEnable) override
 Set if view clipping plane is enabled or not. More...
 
const gp_PntGetVertices () const
 A set of helper functions that return rectangular selecting frustum data. More...
 
const gp_PntGetNearPnt () const
 Returns projection of 2d mouse picked point or projection of center of 2d rectangle (for point and rectangular selection correspondingly) onto near view frustum plane. More...
 
const gp_PntGetFarPnt () const
 Returns projection of 2d mouse picked point or projection of center of 2d rectangle (for point and rectangular selection correspondingly) onto far view frustum plane. 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...
 
- Public Member Functions inherited from SelectMgr_Frustum< 4 >
 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 &, 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...
 
- 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

void segmentSegmentDistance (const gp_Pnt &theSegPnt1, const gp_Pnt &theSegPnt2, Standard_Real &theDepth)
 
void segmentPlaneIntersection (const gp_Vec &thePlane, const gp_Pnt &thePntOnPlane, Standard_Real &theDepth)
 
void computeClippingRange (const Graphic3d_SequenceOfHClipPlane &thePlanes, Standard_Real &theDepthMin, Standard_Real &theDepthMax)
 Computes valid depth range for the given clipping planes. More...
 
Standard_Boolean isViewClippingOk (const Standard_Real theDepth) const
 Returns false if theDepth must be clipped by current view clip range. More...
 
- Protected Member Functions inherited from SelectMgr_Frustum< 4 >
Standard_Boolean hasOverlap (const SelectMgr_Vec3 &theBoxMin, const SelectMgr_Vec3 &theBoxMax, Standard_Boolean *theInside=NULL)
 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)
 SAT intersection test between defined volume and given point. More...
 
Standard_Boolean hasOverlap (const gp_Pnt &thePnt1, const gp_Pnt &thePnt2)
 SAT intersection test between defined volume and given segment. More...
 
Standard_Boolean hasOverlap (const TColgp_Array1OfPnt &theArrayOfPnts, gp_Vec &theNormal)
 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)
 SAT intersection test between defined volume and given triangle. 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_Frustum< 4 >
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 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_RectangularFrustum()

SelectMgr_RectangularFrustum::SelectMgr_RectangularFrustum ( )
inline

Member Function Documentation

◆ Build() [1/2]

virtual void SelectMgr_RectangularFrustum::Build ( const gp_Pnt2d thePoint)
overridevirtual

Builds volume according to the point and given pixel tolerance.

Reimplemented from SelectMgr_BaseFrustum.

◆ Build() [2/2]

virtual void SelectMgr_RectangularFrustum::Build ( const gp_Pnt2d theMinPnt,
const gp_Pnt2d theMaxPnt 
)
overridevirtual

Builds volume according to the selected rectangle.

Reimplemented from SelectMgr_BaseFrustum.

◆ computeClippingRange()

void SelectMgr_RectangularFrustum::computeClippingRange ( const Graphic3d_SequenceOfHClipPlane thePlanes,
Standard_Real theDepthMin,
Standard_Real theDepthMax 
)
protected

Computes valid depth range for the given clipping planes.

◆ DetectedPoint()

virtual gp_Pnt SelectMgr_RectangularFrustum::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_BaseFrustum.

◆ DistToGeometryCenter()

virtual Standard_Real SelectMgr_RectangularFrustum::DistToGeometryCenter ( const gp_Pnt theCOG)
overridevirtual

Measures distance between 3d projection of user-picked screen point and given point theCOG.

Reimplemented from SelectMgr_BaseFrustum.

◆ GetFarPnt()

const gp_Pnt& SelectMgr_RectangularFrustum::GetFarPnt ( ) const
inline

Returns projection of 2d mouse picked point or projection of center of 2d rectangle (for point and rectangular selection correspondingly) onto far view frustum plane.

◆ GetNearPnt()

const gp_Pnt& SelectMgr_RectangularFrustum::GetNearPnt ( ) const
inline

Returns projection of 2d mouse picked point or projection of center of 2d rectangle (for point and rectangular selection correspondingly) onto near view frustum plane.

◆ GetPlanes()

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

◆ GetVertices()

const gp_Pnt* SelectMgr_RectangularFrustum::GetVertices ( ) const
inline

A set of helper functions that return rectangular selecting frustum data.

◆ IsClipped()

virtual Standard_Boolean SelectMgr_RectangularFrustum::IsClipped ( const Graphic3d_SequenceOfHClipPlane thePlanes,
const Standard_Real  theDepth 
)
overridevirtual

Checks if the point of sensitive in which selection was detected belongs to the region defined by clipping planes.

Reimplemented from SelectMgr_BaseFrustum.

◆ isViewClippingOk()

Standard_Boolean SelectMgr_RectangularFrustum::isViewClippingOk ( const Standard_Real  theDepth) const
protected

Returns false if theDepth must be clipped by current view clip range.

◆ Overlaps() [1/7]

virtual Standard_Boolean SelectMgr_RectangularFrustum::Overlaps ( const SelectMgr_Vec3 theBoxMin,
const SelectMgr_Vec3 theBoxMax,
Standard_Real theDepth 
)
overridevirtual

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

Reimplemented from SelectMgr_BaseFrustum.

◆ Overlaps() [2/7]

virtual Standard_Boolean SelectMgr_RectangularFrustum::Overlaps ( const SelectMgr_Vec3 theBoxMin,
const SelectMgr_Vec3 theBoxMax,
Standard_Boolean theInside = NULL 
)
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/7]

virtual Standard_Boolean SelectMgr_RectangularFrustum::Overlaps ( const gp_Pnt thePnt,
Standard_Real theDepth 
)
overridevirtual

Intersection test between defined volume and given point.

Reimplemented from SelectMgr_BaseFrustum.

◆ Overlaps() [4/7]

virtual Standard_Boolean SelectMgr_RectangularFrustum::Overlaps ( const gp_Pnt thePnt)
overridevirtual

Intersection test between defined volume and given point.

Reimplemented from SelectMgr_BaseFrustum.

◆ Overlaps() [5/7]

virtual Standard_Boolean SelectMgr_RectangularFrustum::Overlaps ( const TColgp_Array1OfPnt theArrayOfPnts,
Select3D_TypeOfSensitivity  theSensType,
Standard_Real theDepth 
)
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() [6/7]

virtual Standard_Boolean SelectMgr_RectangularFrustum::Overlaps ( const gp_Pnt thePnt1,
const gp_Pnt thePnt2,
Standard_Real theDepth 
)
overridevirtual

Checks if line segment overlaps selecting frustum.

Reimplemented from SelectMgr_BaseFrustum.

◆ Overlaps() [7/7]

virtual Standard_Boolean SelectMgr_RectangularFrustum::Overlaps ( const gp_Pnt thePnt1,
const gp_Pnt thePnt2,
const gp_Pnt thePnt3,
Select3D_TypeOfSensitivity  theSensType,
Standard_Real theDepth 
)
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_RectangularFrustum::ScaleAndTransform ( const Standard_Integer  theScaleFactor,
const gp_GTrsf theTrsf 
) const
overridevirtual

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:

  • transformation only is needed: must be initialized as any negative value;
  • scale only is needed: must be set to gp_Identity.

Reimplemented from SelectMgr_BaseFrustum.

◆ segmentPlaneIntersection()

void SelectMgr_RectangularFrustum::segmentPlaneIntersection ( const gp_Vec thePlane,
const gp_Pnt thePntOnPlane,
Standard_Real theDepth 
)
protected

◆ segmentSegmentDistance()

void SelectMgr_RectangularFrustum::segmentSegmentDistance ( const gp_Pnt theSegPnt1,
const gp_Pnt theSegPnt2,
Standard_Real theDepth 
)
protected

◆ SetViewClipping()

virtual void SelectMgr_RectangularFrustum::SetViewClipping ( const Handle< Graphic3d_SequenceOfHClipPlane > &  thePlanes)
overridevirtual

Valid for point selection only! Computes depth range for global (defined for the whole view) clipping planes.

Reimplemented from SelectMgr_BaseFrustum.

◆ SetViewClippingEnabled()

virtual Standard_Boolean SelectMgr_RectangularFrustum::SetViewClippingEnabled ( const Standard_Boolean  theToEnable)
inlineoverridevirtual

Set if view clipping plane is enabled or not.

Returns
previous value of the flag

Reimplemented from SelectMgr_BaseFrustum.


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