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). NOTE: the object of this class can be created only as part of SelectMgr_TriangularFrustumSet. More...

#include <SelectMgr_TriangularFrustum.hxx>

Inheritance diagram for SelectMgr_TriangularFrustum:

[legend]

Data Structures
struct	SelectionTriangle
	Auxiliary structure to define selection triangle. More...

Public Member Functions
	~SelectMgr_TriangularFrustum () override
	Destructor.

void	Init (const gp_Pnt2d &theP1, const gp_Pnt2d &theP2, const gp_Pnt2d &theP3)
	Initializes selection triangle by input points.

void	Build () 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) NOTE: it should be called after Init() method.

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

occ::handle< SelectMgr_BaseIntersector >	ScaleAndTransform (const int theScale, const gp_GTrsf &theTrsf, const occ::handle< SelectMgr_FrustumBuilder > &theBuilder) const override
	Returns a copy of the frustum transformed according to the matrix given.

occ::handle< SelectMgr_BaseIntersector >	CopyWithBuilder (const occ::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.

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 tolerance set to 2, orthographic camera and empty frustum builder.

	~SelectMgr_BaseFrustum () override=default
	Destructor.

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

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

void	SetPixelTolerance (const int 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.

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

void	WindowSize (int &theWidth, int &theHeight) const override
	Returns current window size. This method doesn't set any output values for the base class.

void	SetViewport (const double theX, const double theY, const double theWidth, const double theHeight) override
	Passes viewport parameters to builder.

bool	IsBoundaryIntersectSphere (const gp_Pnt &theCenter, const double theRadius, const gp_Dir &thePlaneNormal, const NCollection_Array1< gp_Pnt > &theBoundaries, bool &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.

	~SelectMgr_BaseIntersector () override
	Destructor.

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

const occ::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 double	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 gp_Pnt	DetectedPoint (const double theDepth) const
	Calculates the point on a view ray that was detected during the run of selection algo by given depth. It makes sense only for intersectors built on a single point. This method returns infinite point for the base class.

virtual bool	RaySphereIntersection (const gp_Pnt &theCenter, const double theRadius, const gp_Pnt &theLoc, const gp_Dir &theRayDir, double &theTimeEnter, double &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 bool	RayCylinderIntersection (const double theBottomRadius, const double theTopRadius, const double theHeight, const gp_Pnt &theLoc, const gp_Dir &theRayDir, const bool theIsHollow, double &theTimeEnter, double &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 bool	RayCircleIntersection (const double theRadius, const gp_Pnt &theLoc, const gp_Dir &theRayDir, const bool theIsFilled, double &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 ()=default
	Destructor must be virtual.

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

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

bool	IsInstance (const char *const theTypeName) const
	Returns a true value if this is an instance of TypeName.

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

bool	IsKind (const char *const 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.

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

void	IncrementRefCounter () noexcept
	Increments the reference counter of this object. Uses relaxed memory ordering since incrementing only requires atomicity, not synchronization with other memory operations.

int	DecrementRefCounter () noexcept
	Decrements the reference counter of this object; returns the decremented value. Uses release ordering for the decrement to ensure all writes to the object are visible before the count reaches zero. An acquire fence is added only when the count reaches zero, ensuring proper synchronization before deletion. This is more efficient than using acq_rel for every decrement.

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

SAT Tests for different objects
SAT intersection test between defined volume and given axis-aligned box
SelectionTriangle	mySelTriangle
	parameters of selection triangle (it is used to build triangle frustum)

bool	OverlapsBox (const NCollection_Vec3< double > &theMinPnt, const NCollection_Vec3< double > &theMaxPnt, const SelectMgr_ViewClipRange &theClipRange, SelectBasics_PickResult &thePickResult) const override
	parameters of selection triangle (it is used to build triangle frustum)

bool	OverlapsBox (const NCollection_Vec3< double > &theMinPt, const NCollection_Vec3< double > &theMaxPt, bool *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.

bool	OverlapsPoint (const gp_Pnt &thePnt, const SelectMgr_ViewClipRange &theClipRange, SelectBasics_PickResult &thePickResult) const override
	Intersection test between defined volume and given point.

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

bool	OverlapsPolygon (const NCollection_Array1< gp_Pnt > &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.

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

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

bool	OverlapsSphere (const gp_Pnt &theCenter, const double theRadius, bool *theInside=nullptr) const override
	Returns true if selecting volume is overlapped by sphere with center theCenter and radius theRadius.

bool	OverlapsSphere (const gp_Pnt &theCenter, const double 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.

bool	OverlapsCylinder (const double theBottomRad, const double theTopRad, const double theHeight, const gp_Trsf &theTrsf, const bool 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.

bool	OverlapsCylinder (const double theBottomRad, const double theTopRad, const double theHeight, const gp_Trsf &theTrsf, const bool theIsHollow, bool *theInside=nullptr) 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.

bool	OverlapsCircle (const double theRadius, const gp_Trsf &theTrsf, const bool theIsFilled, const SelectMgr_ViewClipRange &theClipRange, SelectBasics_PickResult &thePickResult) const override
	Returns true if selecting volume is overlapped by circle with radius theRadius, boolean theIsFilled and transformation to apply theTrsf. The position and orientation of the circle are specified via theTrsf transformation for gp::XOY() with center in gp::Origin().

bool	OverlapsCircle (const double theRadius, const gp_Trsf &theTrsf, const bool theIsFilled, bool *theInside=nullptr) const override
	Returns true if selecting volume is overlapped by circle with radius theRadius, boolean theIsFilled and transformation to apply theTrsf. The position and orientation of the circle are specified via theTrsf transformation for gp::XOY() with center in gp::Origin().

void	Clear ()
	Nullifies the handle to corresponding builder instance to prevent memory leaks.

void	GetPlanes (NCollection_DynamicArray< NCollection_Vec4< double > > &thePlaneEquations) const override
	Stores plane equation coefficients (in the following form: Ax + By + Cz + D = 0) to the given vector.

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

	SelectMgr_TriangularFrustum ()
	Creates an empty triangular frustum.

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 Member Functions inherited from SelectMgr_Frustum< 3 >
bool	hasBoxOverlap (const NCollection_Vec3< double > &theBoxMin, const NCollection_Vec3< double > &theBoxMax, bool *theInside=nullptr) const
	Returns true if selecting volume is overlapped by axis-aligned bounding box with minimum corner at point theMinPt and maximum at point theMaxPt.

bool	hasPointOverlap (const gp_Pnt &thePnt) const
	SAT intersection test between defined volume and given point.

bool	hasSegmentOverlap (const gp_Pnt &thePnt1, const gp_Pnt &thePnt2) const
	SAT intersection test between defined volume and given segment.

bool	hasPolygonOverlap (const NCollection_Array1< gp_Pnt > &theArrayOfPnts, gp_Vec &theNormal) const
	SAT intersection test between frustum given and planar convex polygon represented as ordered point set.

bool	hasTriangleOverlap (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.

bool	hasSphereOverlap (const gp_Pnt &thePnt1, const double theRadius, bool *theInside=nullptr) const
	Intersection test between defined volume and given sphere.

bool	hasCylinderOverlap (const double theBottomRad, const double theTopRad, const double theHeight, const gp_Trsf &theTrsf, const bool theIsHollow, bool *theInside=nullptr) const
	Intersection test between defined volume and given cylinder (or cone).

bool	hasCircleOverlap (const double theRadius, const gp_Trsf &theTrsf, const bool theIsFilled, bool *theInside=nullptr) const
	Intersection test between defined volume and given circle.

bool	isInsideCylinderEndFace (const double theBottomRad, const double theTopRad, const double theHeight, const gp_Trsf &theTrsf, const NCollection_Array1< gp_Pnt > &theVertices) const
	Returns True if all vertices (theVertices) are inside the top and bottom sides of the cylinder.

bool	isDotInside (const gp_Pnt &thePnt, const NCollection_Array1< gp_Pnt > &theVertices) const
	Checking whether the point thePnt is inside the shape with borders theVertices. thePnt and theVertices lie in the same plane.

Protected Attributes inherited from SelectMgr_Frustum< 3 >
gp_Vec	myPlanes [N+2]
	Plane equations.

gp_Pnt	myVertices [N *2]
	Vertices coordinates.

double	myMaxVertsProjections [N+2]
	Cached projections of vertices onto frustum plane directions.

double	myMinVertsProjections [N+2]
	Cached projections of vertices onto frustum plane directions.

double	myMaxOrthoVertsProjections [3]
	Cached projections of vertices onto directions of ortho unit vectors.

double	myMinOrthoVertsProjections [3]
	Cached projections of vertices onto directions of ortho unit vectors.

gp_Vec	myEdgeDirs [6]
	Cached edge directions.

Protected Attributes inherited from SelectMgr_BaseFrustum
int	myPixelTolerance
	Pixel tolerance.

occ::handle< SelectMgr_FrustumBuilder >	myBuilder
	A tool implementing methods for volume build.

Protected Attributes inherited from SelectMgr_BaseIntersector
occ::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 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). NOTE: the object of this class can be created only as part of SelectMgr_TriangularFrustumSet.

Constructor & Destructor Documentation

◆ ~SelectMgr_TriangularFrustum()

SelectMgr_TriangularFrustum::~SelectMgr_TriangularFrustum ( )

override

Destructor.

◆ SelectMgr_TriangularFrustum()

SelectMgr_TriangularFrustum::SelectMgr_TriangularFrustum ( )

protected

Creates an empty triangular frustum.

Member Function Documentation

◆ Build()

void SelectMgr_TriangularFrustum::Build ( )

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) NOTE: it should be called after Init() method.

void SelectMgr_TriangularFrustum::Init	(	const gp_Pnt2d &	theP1,
		const gp_Pnt2d &	theP2,
		const gp_Pnt2d &	theP3 )

Data Structures

Public Member Functions

SAT Tests for different objects

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ~SelectMgr_TriangularFrustum()

◆ SelectMgr_TriangularFrustum()

Member Function Documentation

◆ Build()

◆ Clear()

◆ CopyWithBuilder()

◆ 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()

Field Documentation

◆ mySelTriangle