This class is an interface for different types of selecting frustums, defining different selection types, like point, box or polyline selection. It contains signatures of functions for detection of overlap by sensitive entity and initializes some data for building the selecting frustum. More...

#include <SelectMgr_BaseFrustum.hxx>

Inheritance diagram for SelectMgr_BaseFrustum:

[legend]

Public Member Functions
	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.

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_BaseIntersector
	SelectMgr_BaseIntersector ()
	Creates new empty selecting volume.

virtual	~SelectMgr_BaseIntersector ()
	Destructor.

virtual void	Build ()=0
	Builds intersector according to internal parameters.

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

virtual Standard_Boolean	IsScalable () const =0
	Checks if it is possible to scale this intersector.

virtual Handle< SelectMgr_BaseIntersector >	ScaleAndTransform (const Standard_Integer theScaleFactor, const gp_GTrsf &theTrsf, const Handle< SelectMgr_FrustumBuilder > &theBuilder) const =0
	Note that this method does not perform any checks on type of the frustum.

virtual Handle< SelectMgr_BaseIntersector >	CopyWithBuilder (const Handle< SelectMgr_FrustumBuilder > &theBuilder) const =0

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 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. This method only clears input vector for the base class.

virtual Standard_Boolean	OverlapsBox (const SelectMgr_Vec3 &theBoxMin, const SelectMgr_Vec3 &theBoxMax, const SelectMgr_ViewClipRange &theClipRange, SelectBasics_PickResult &thePickResult) const =0
	SAT intersection test between defined volume and given axis-aligned box.

virtual Standard_Boolean	OverlapsBox (const SelectMgr_Vec3 &theBoxMin, const SelectMgr_Vec3 &theBoxMax, Standard_Boolean *theInside=NULL) const =0
	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 =0
	Intersection test between defined volume and given point.

virtual Standard_Boolean	OverlapsPoint (const gp_Pnt &thePnt) const =0
	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.

virtual Standard_Boolean	OverlapsPolygon (const TColgp_Array1OfPnt &theArrayOfPnts, Select3D_TypeOfSensitivity theSensType, const SelectMgr_ViewClipRange &theClipRange, SelectBasics_PickResult &thePickResult) const =0
	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 =0
	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 =0
	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 Standard_Boolean	OverlapsSphere (const gp_Pnt &theCenter, const Standard_Real theRadius, Standard_Boolean *theInside=NULL) const =0
	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 =0
	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 =0
	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 =0
	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 =0
	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().

virtual Standard_Boolean	OverlapsCircle (const Standard_Real theBottomRad, const gp_Trsf &theTrsf, const Standard_Boolean theIsFilled, Standard_Boolean *theInside=NULL) const =0
	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().

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 gp_Pnt	DetectedPoint (const Standard_Real 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 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.

Protected Attributes
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

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.

Detailed Description

This class is an interface for different types of selecting frustums, defining different selection types, like point, box or polyline selection. It contains signatures of functions for detection of overlap by sensitive entity and initializes some data for building the selecting frustum.

Constructor & Destructor Documentation

◆ SelectMgr_BaseFrustum()

SelectMgr_BaseFrustum::SelectMgr_BaseFrustum ( )

Creates new selecting volume with pixel tolerance set to 2, orthographic camera and empty frustum builder.

◆ ~SelectMgr_BaseFrustum()

virtual SelectMgr_BaseFrustum::~SelectMgr_BaseFrustum ( )

inlinevirtual

Destructor.

Member Function Documentation

◆ DumpJson()

virtual void SelectMgr_BaseFrustum::DumpJson	(	Standard_OStream &	theOStream,
		Standard_Integer	theDepth = -1 ) const

overridevirtual

Dumps the content of me into the stream.

Reimplemented from SelectMgr_BaseIntersector.

Reimplemented in SelectMgr_Frustum< N >, SelectMgr_Frustum< 3 >, SelectMgr_Frustum< 4 >, SelectMgr_RectangularFrustum, SelectMgr_TriangularFrustum, and SelectMgr_TriangularFrustumSet.

◆ IsBoundaryIntersectSphere()

Standard_Boolean SelectMgr_BaseFrustum::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.

◆ SetBuilder()

void SelectMgr_BaseFrustum::SetBuilder ( const Handle< SelectMgr_FrustumBuilder > & theBuilder )

Nullifies the builder created in the constructor and copies the pointer given.

◆ SetCamera()

virtual void SelectMgr_BaseFrustum::SetCamera ( const Handle< Graphic3d_Camera > & theCamera )

overridevirtual

Saves camera definition and passes it to builder.

Reimplemented from SelectMgr_BaseIntersector.

◆ SetPixelTolerance()

virtual void SelectMgr_BaseFrustum::SetPixelTolerance ( const Standard_Integer theTol )

overridevirtual

Sets pixel tolerance. It makes sense only for scalable intersectors (built on a single point). This method does nothing for the base class.

Reimplemented from SelectMgr_BaseIntersector.

◆ SetViewport()

virtual void SelectMgr_BaseFrustum::SetViewport	(	const Standard_Real	theX,
		const Standard_Real	theY,
		const Standard_Real	theWidth,
		const Standard_Real	theHeight )

overridevirtual

Passes viewport parameters to builder.

Reimplemented from SelectMgr_BaseIntersector.

◆ SetWindowSize()

virtual void SelectMgr_BaseFrustum::SetWindowSize	(	const Standard_Integer	theWidth,
		const Standard_Integer	theHeight )

overridevirtual

Sets current window size. This method does nothing for the base class.

Reimplemented from SelectMgr_BaseIntersector.

◆ WindowSize()

virtual void SelectMgr_BaseFrustum::WindowSize	(	Standard_Integer &	theWidth,
		Standard_Integer &	theHeight ) const

overridevirtual

Returns current window size. This method doesn't set any output values for the base class.

Reimplemented from SelectMgr_BaseIntersector.

Field Documentation

◆ myBuilder

Handle< SelectMgr_FrustumBuilder > SelectMgr_BaseFrustum::myBuilder

protected

A tool implementing methods for volume build.

◆ myPixelTolerance

Standard_Integer SelectMgr_BaseFrustum::myPixelTolerance

protected

Pixel tolerance.

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

SelectMgr_BaseFrustum.hxx

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ SelectMgr_BaseFrustum()

◆ ~SelectMgr_BaseFrustum()

Member Function Documentation

◆ DumpJson()

◆ IsBoundaryIntersectSphere()

◆ SetBuilder()

◆ SetCamera()

◆ SetPixelTolerance()

◆ SetViewport()

◆ SetWindowSize()

◆ WindowSize()

Field Documentation

◆ myBuilder

◆ myPixelTolerance