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 vertiex 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]

Public Member Functions
	SelectMgr_TriangularFrustumSet ()

	~SelectMgr_TriangularFrustumSet ()

virtual void	Build (const TColgp_Array1OfPnt2d &thePoints) 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. More...

virtual Handle< SelectMgr_BaseFrustum >	ScaleAndTransform (const Standard_Integer theScale, const gp_GTrsf &theTrsf) const override
	Returns a copy of the frustum with all sub-volumes 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 &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	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...

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 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_Mat4d &	ProjectionMatrix () const

const Graphic3d_Mat4d &	WorldViewMatrix () const

const Graphic3d_WorldViewProjState &	WorldViewProjState () 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 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_Transient &	operator= (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_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. 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...

Standard_Boolean	myIsOrthographic
	Defines if current camera is orthographic. More...

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

Handle< Graphic3d_Camera >	myCamera
	camera definition 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 vertiex 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 ( )

◆ ~SelectMgr_TriangularFrustumSet()

SelectMgr_TriangularFrustumSet::~SelectMgr_TriangularFrustumSet ( )

inline

Member Function Documentation

◆ Build()

virtual void SelectMgr_TriangularFrustumSet::Build ( const TColgp_Array1OfPnt2d & thePoints )

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.

Reimplemented from SelectMgr_BaseFrustum.

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

◆ Overlaps() [1/6]

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

Reimplemented from SelectMgr_BaseFrustum.

◆ Overlaps() [2/6]

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

Reimplemented from SelectMgr_BaseFrustum.

◆ Overlaps() [3/6]

virtual Standard_Boolean SelectMgr_TriangularFrustumSet::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_TriangularFrustumSet::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_TriangularFrustumSet::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_TriangularFrustumSet::Overlaps	(	const gp_Pnt &	thePt1,
		const gp_Pnt &	thePt2,
		const gp_Pnt &	thePt3,
		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_TriangularFrustumSet::ScaleAndTransform	(	const Standard_Integer	theScale,
		const gp_GTrsf &	theTrsf
	)		const

overridevirtual

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

Reimplemented from SelectMgr_BaseFrustum.

◆ 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:

SelectMgr_TriangularFrustumSet.hxx

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ SelectMgr_TriangularFrustumSet()

◆ ~SelectMgr_TriangularFrustumSet()

Member Function Documentation

◆ Build()

◆ DumpJson()

◆ GetPlanes()

◆ Overlaps() [1/6]

◆ Overlaps() [2/6]

◆ Overlaps() [3/6]

◆ Overlaps() [4/6]

◆ Overlaps() [5/6]

◆ Overlaps() [6/6]

◆ ScaleAndTransform()

◆ SetAllowOverlapDetection()