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:

[legend]

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

Public Member Functions
	SelectMgr_TriangularFrustumSet ()
	Constructor.

virtual	~SelectMgr_TriangularFrustumSet ()
	Destructor.

void	Init (const TColgp_Array1OfPnt2d &thePoints)
	Initializes set of triangular frustums by polyline.

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.

virtual Standard_Boolean	IsScalable () const override
	Returns FALSE (not applicable to this volume).

virtual Handle< SelectMgr_BaseIntersector >	ScaleAndTransform (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.

virtual Handle< SelectMgr_BaseIntersector >	CopyWithBuilder (const Handle< SelectMgr_FrustumBuilder > &theBuilder) const override
	Returns a copy of the frustum using the given frustum builder configuration. Returned frustum should be re-constructed before being used.

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.

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.

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.

virtual Standard_Boolean	OverlapsPoint (const gp_Pnt &) const override
	Always returns FALSE (not applicable to this selector).

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.

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.

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.

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.

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.

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.

virtual Standard_Boolean	OverlapsCylinder (const Standard_Real theBottomRad, const Standard_Real theTopRad, const Standard_Real theHeight, const gp_Trsf &theTrsf, const Standard_Boolean theIsHollow, 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.

virtual Standard_Boolean	OverlapsCylinder (const Standard_Real theBottomRad, const Standard_Real theTopRad, const Standard_Real theHeight, const gp_Trsf &theTrsf, const Standard_Boolean theIsHollow, 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.

virtual Standard_Boolean	OverlapsCircle (const Standard_Real theBottomRad, const gp_Trsf &theTrsf, const Standard_Boolean theIsFilled, 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.

virtual Standard_Boolean	OverlapsCircle (const Standard_Real theBottomRad, const gp_Trsf &theTrsf, const Standard_Boolean theIsFilled, 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.

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.

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.

virtual void	DumpJson (Standard_OStream &theOStream, Standard_Integer theDepth=-1) const override
	Dumps the content of me into the stream.

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.

virtual	~SelectMgr_BaseFrustum ()
	Destructor.

void	SetBuilder (const Handle< SelectMgr_FrustumBuilder > &theBuilder)
	Nullifies the builder created in the constructor and copies the pointer given.

virtual void	SetCamera (const Handle< Graphic3d_Camera > &theCamera) override
	Saves camera definition and passes it to builder.

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.

virtual void	SetWindowSize (const Standard_Integer theWidth, const Standard_Integer theHeight) override
	Sets current window size. This method does nothing for the base class.

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.

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.

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.

Public Member Functions inherited from SelectMgr_BaseIntersector
	SelectMgr_BaseIntersector ()
	Creates new empty selecting volume.

virtual	~SelectMgr_BaseIntersector ()
	Destructor.

SelectMgr_SelectionType	GetSelectionType () const
	Returns selection type of this intersector.

const Handle< Graphic3d_Camera > &	Camera () const
	Return camera definition.

virtual const gp_Pnt &	GetNearPnt () const
	Returns near point of intersector. This method returns zero point for the base class.

virtual const gp_Pnt &	GetFarPnt () const
	Returns far point of intersector. This method returns zero point for the base class.

virtual const gp_Dir &	GetViewRayDirection () const
	Returns direction ray of intersector. This method returns zero direction for the base class.

virtual const gp_Pnt2d &	GetMousePosition () const
	Returns current mouse coordinates. This method returns infinite point for the base class.

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.

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.

virtual Standard_Boolean	RayCylinderIntersection (const Standard_Real theBottomRadius, const Standard_Real theTopRadius, const Standard_Real theHeight, const gp_Pnt &theLoc, const gp_Dir &theRayDir, const Standard_Boolean theIsHollow, 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 hollow cylinder (or cone)

virtual Standard_Boolean	RayCircleIntersection (const Standard_Real theRadius, const gp_Pnt &theLoc, const gp_Dir &theRayDir, const Standard_Boolean theIsFilled, Standard_Real &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_Transient &	operator= (const Standard_Transient &)
	Assignment operator, needed to avoid copying reference counter.

virtual	~Standard_Transient ()
	Destructor must be virtual.

virtual const opencascade::handle< Standard_Type > &	DynamicType () const
	Returns a type descriptor about this object.

Standard_Boolean	IsInstance (const opencascade::handle< Standard_Type > &theType) const
	Returns a true value if this is an instance of Type.

Standard_Boolean	IsInstance (const Standard_CString theTypeName) const
	Returns a true value if this is an instance of TypeName.

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.

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.

Standard_Transient *	This () 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.

Standard_Integer	GetRefCount () const noexcept
	Get the reference counter of this object.

void	IncrementRefCounter () noexcept
	Increments the reference counter of this object.

Standard_Integer	DecrementRefCounter () noexcept
	Decrements the reference counter of this object; returns the decremented value.

virtual void	Delete () const
	Memory deallocator for transient classes.

Additional Inherited Members
Public Types inherited from Standard_Transient
typedef void	base_type
	Returns a type descriptor about this object.

Static Public Member Functions inherited from Standard_Transient
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.

Protected Attributes inherited from SelectMgr_BaseFrustum
Standard_Integer	myPixelTolerance
	Pixel tolerance.

Handle< SelectMgr_FrustumBuilder >	myBuilder
	A tool implementing methods for volume build.

Protected Attributes inherited from SelectMgr_BaseIntersector
Handle< Graphic3d_Camera >	myCamera
	camera definition (if builder isn't NULL it is the same as its camera)

SelectMgr_SelectionType	mySelectionType
	type of selection

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.

Data Structures

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ SelectMgr_TriangularFrustumSet()

◆ ~SelectMgr_TriangularFrustumSet()

Member Function Documentation

◆ Build()

◆ CopyWithBuilder()

◆ DetectedPoint()

◆ DumpJson()

◆ GetPlanes()

◆ Init()

◆ IsScalable()

◆ OverlapsBox() [1/2]

◆ OverlapsBox() [2/2]

◆ OverlapsCircle() [1/2]

◆ OverlapsCircle() [2/2]

◆ OverlapsCylinder() [1/2]

◆ OverlapsCylinder() [2/2]

◆ OverlapsPoint() [1/2]

◆ OverlapsPoint() [2/2]

◆ OverlapsPolygon()

◆ OverlapsSegment()

◆ OverlapsSphere() [1/2]

◆ OverlapsSphere() [2/2]

◆ OverlapsTriangle()

◆ ScaleAndTransform()

◆ SetAllowOverlapDetection()