The intersection Context contains geometrical and topological toolkit (classifiers, projectors, etc). The intersection Context is for caching the tools to increase the performance. More...

#include <IntTools_Context.hxx>

Inheritance diagram for IntTools_Context:

[legend]

Public Member Functions
	IntTools_Context ()

virtual	~IntTools_Context ()

	IntTools_Context (const Handle< NCollection_BaseAllocator > &theAllocator)

IntTools_FClass2d &	FClass2d (const TopoDS_Face &aF)
	Returns a reference to point classifier for given face.

GeomAPI_ProjectPointOnSurf &	ProjPS (const TopoDS_Face &aF)
	Returns a reference to point projector for given face.

GeomAPI_ProjectPointOnCurve &	ProjPC (const TopoDS_Edge &aE)
	Returns a reference to point projector for given edge.

GeomAPI_ProjectPointOnCurve &	ProjPT (const Handle< Geom_Curve > &aC)
	Returns a reference to point projector for given curve.

IntTools_SurfaceRangeLocalizeData &	SurfaceData (const TopoDS_Face &aF)
	Returns a reference to surface localization data for given face.

BRepClass3d_SolidClassifier &	SolidClassifier (const TopoDS_Solid &aSolid)
	Returns a reference to solid classifier for given solid.

Geom2dHatch_Hatcher &	Hatcher (const TopoDS_Face &aF)
	Returns a reference to 2D hatcher for given face.

BRepAdaptor_Surface &	SurfaceAdaptor (const TopoDS_Face &theFace)
	Returns a reference to surface adaptor for given face.

Bnd_OBB &	OBB (const TopoDS_Shape &theShape, const Standard_Real theFuzzyValue=Precision::Confusion())
	Builds and stores an Oriented Bounding Box for the shape. Returns a reference to OBB.

void	UVBounds (const TopoDS_Face &theFace, Standard_Real &UMin, Standard_Real &UMax, Standard_Real &VMin, Standard_Real &VMax)
	Computes the boundaries of the face using surface adaptor.

Standard_Integer	ComputePE (const gp_Pnt &theP, const Standard_Real theTolP, const TopoDS_Edge &theE, Standard_Real &theT, Standard_Real &theDist)
	Computes parameter of the Point theP on the edge aE. Returns zero if the distance between point and edge is less than sum of tolerance value of edge and theTopP, otherwise and for following conditions returns negative value.

Standard_Integer	ComputeVE (const TopoDS_Vertex &theV, const TopoDS_Edge &theE, Standard_Real &theT, Standard_Real &theTol, const Standard_Real theFuzz=Precision::Confusion())
	Computes parameter of the vertex aV on the edge aE and correct tolerance value for the vertex on the edge. Returns zero if the distance between vertex and edge is less than sum of tolerances and the fuzzy value, otherwise and for following conditions returns negative value:

Standard_Integer	ComputeVF (const TopoDS_Vertex &theVertex, const TopoDS_Face &theFace, Standard_Real &theU, Standard_Real &theV, Standard_Real &theTol, const Standard_Real theFuzz=Precision::Confusion())
	Computes UV parameters of the vertex aV on face aF and correct tolerance value for the vertex on the face. Returns zero if the distance between vertex and face is less than or equal the sum of tolerances and the fuzzy value and the projection point lays inside boundaries of the face. For following conditions returns negative value

TopAbs_State	StatePointFace (const TopoDS_Face &aF, const gp_Pnt2d &aP2D)
	Returns the state of the point aP2D relative to face aF.

Standard_Boolean	IsPointInFace (const TopoDS_Face &aF, const gp_Pnt2d &aP2D)
	Returns true if the point aP2D is inside the boundaries of the face aF, otherwise returns false.

Standard_Boolean	IsPointInFace (const gp_Pnt &aP3D, const TopoDS_Face &aF, const Standard_Real aTol)
	Returns true if the point aP2D is inside the boundaries of the face aF, otherwise returns false.

Standard_Boolean	IsPointInOnFace (const TopoDS_Face &aF, const gp_Pnt2d &aP2D)
	Returns true if the point aP2D is inside or on the boundaries of aF.

Standard_Boolean	IsValidPointForFace (const gp_Pnt &aP3D, const TopoDS_Face &aF, const Standard_Real aTol)
	Returns true if the distance between point aP3D and face aF is less or equal to tolerance aTol and projection point is inside or on the boundaries of the face aF.

Standard_Boolean	IsValidPointForFaces (const gp_Pnt &aP3D, const TopoDS_Face &aF1, const TopoDS_Face &aF2, const Standard_Real aTol)
	Returns true if IsValidPointForFace returns true for both face aF1 and aF2.

Standard_Boolean	IsValidBlockForFace (const Standard_Real aT1, const Standard_Real aT2, const IntTools_Curve &aIC, const TopoDS_Face &aF, const Standard_Real aTol)
	Returns true if IsValidPointForFace returns true for some 3d point that lay on the curve aIC bounded by parameters aT1 and aT2.

Standard_Boolean	IsValidBlockForFaces (const Standard_Real aT1, const Standard_Real aT2, const IntTools_Curve &aIC, const TopoDS_Face &aF1, const TopoDS_Face &aF2, const Standard_Real aTol)
	Returns true if IsValidBlockForFace returns true for both faces aF1 and aF2.

Standard_Boolean	IsVertexOnLine (const TopoDS_Vertex &aV, const IntTools_Curve &aIC, const Standard_Real aTolC, Standard_Real &aT)
	Computes parameter of the vertex aV on the curve aIC. Returns true if the distance between vertex and curve is less than sum of tolerance of aV and aTolC, otherwise or if projection algorithm failed returns false (in this case aT isn't significant)

Standard_Boolean	IsVertexOnLine (const TopoDS_Vertex &aV, const Standard_Real aTolV, const IntTools_Curve &aIC, const Standard_Real aTolC, Standard_Real &aT)
	Computes parameter of the vertex aV on the curve aIC. Returns true if the distance between vertex and curve is less than sum of tolerance of aV and aTolC, otherwise or if projection algorithm failed returns false (in this case aT isn't significant)

Standard_Boolean	ProjectPointOnEdge (const gp_Pnt &aP, const TopoDS_Edge &aE, Standard_Real &aT)
	Computes parameter of the point aP on the edge aE. Returns false if projection algorithm failed other wiese returns true.

Bnd_Box &	BndBox (const TopoDS_Shape &theS)

Standard_Boolean	IsInfiniteFace (const TopoDS_Face &theFace)
	Returns true if the solid <theFace> has infinite bounds.

void	SetPOnSProjectionTolerance (const Standard_Real theValue)
	Sets tolerance to be used for projection of point on surface. Clears map of already cached projectors in order to maintain correct value for all projectors.

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
Handle< NCollection_BaseAllocator >	myAllocator

NCollection_DataMap< TopoDS_Shape, IntTools_FClass2d *, TopTools_ShapeMapHasher >	myFClass2dMap

NCollection_DataMap< TopoDS_Shape, GeomAPI_ProjectPointOnSurf *, TopTools_ShapeMapHasher >	myProjPSMap

NCollection_DataMap< TopoDS_Shape, GeomAPI_ProjectPointOnCurve *, TopTools_ShapeMapHasher >	myProjPCMap

NCollection_DataMap< TopoDS_Shape, BRepClass3d_SolidClassifier *, TopTools_ShapeMapHasher >	mySClassMap

NCollection_DataMap< Handle< Geom_Curve >, GeomAPI_ProjectPointOnCurve * >	myProjPTMap

NCollection_DataMap< TopoDS_Shape, Geom2dHatch_Hatcher *, TopTools_ShapeMapHasher >	myHatcherMap

NCollection_DataMap< TopoDS_Shape, IntTools_SurfaceRangeLocalizeData *, TopTools_ShapeMapHasher >	myProjSDataMap

NCollection_DataMap< TopoDS_Shape, Bnd_Box *, TopTools_ShapeMapHasher >	myBndBoxDataMap

NCollection_DataMap< TopoDS_Shape, BRepAdaptor_Surface *, TopTools_ShapeMapHasher >	mySurfAdaptorMap

NCollection_DataMap< TopoDS_Shape, Bnd_OBB *, TopTools_ShapeMapHasher >	myOBBMap

Standard_Integer	myCreateFlag

Standard_Real	myPOnSTolerance

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

The intersection Context contains geometrical and topological toolkit (classifiers, projectors, etc). The intersection Context is for caching the tools to increase the performance.

Constructor & Destructor Documentation

◆ IntTools_Context() [1/2]

IntTools_Context::IntTools_Context ( )

◆ ~IntTools_Context()

virtual IntTools_Context::~IntTools_Context ( )

virtual

◆ IntTools_Context() [2/2]

IntTools_Context::IntTools_Context ( const Handle< NCollection_BaseAllocator > & theAllocator )

Member Function Documentation

◆ BndBox()

Bnd_Box & IntTools_Context::BndBox ( const TopoDS_Shape & theS )

◆ ComputePE()

Standard_Integer IntTools_Context::ComputePE	(	const gp_Pnt &	theP,
		const Standard_Real	theTolP,
		const TopoDS_Edge &	theE,
		Standard_Real &	theT,
		Standard_Real &	theDist
	)

Computes parameter of the Point theP on the edge aE. Returns zero if the distance between point and edge is less than sum of tolerance value of edge and theTopP, otherwise and for following conditions returns negative value.

the edge is degenerated (-1)
the edge does not contain 3d curve and pcurves (-2)
projection algorithm failed (-3)

◆ ComputeVE()

Standard_Integer IntTools_Context::ComputeVE	(	const TopoDS_Vertex &	theV,
		const TopoDS_Edge &	theE,
		Standard_Real &	theT,
		Standard_Real &	theTol,
		const Standard_Real	theFuzz = `Precision::Confusion()`
	)

Computes parameter of the vertex aV on the edge aE and correct tolerance value for the vertex on the edge. Returns zero if the distance between vertex and edge is less than sum of tolerances and the fuzzy value, otherwise and for following conditions returns negative value:

the edge is degenerated (-1)
the edge does not contain 3d curve and pcurves (-2)
projection algorithm failed (-3)

◆ ComputeVF()

Standard_Integer IntTools_Context::ComputeVF	(	const TopoDS_Vertex &	theVertex,
		const TopoDS_Face &	theFace,
		Standard_Real &	theU,
		Standard_Real &	theV,
		Standard_Real &	theTol,
		const Standard_Real	theFuzz = `Precision::Confusion()`
	)

Computes UV parameters of the vertex aV on face aF and correct tolerance value for the vertex on the face. Returns zero if the distance between vertex and face is less than or equal the sum of tolerances and the fuzzy value and the projection point lays inside boundaries of the face. For following conditions returns negative value

projection algorithm failed (-1)
distance is more than sum of tolerances (-2)
projection point out or on the boundaries of face (-3)

◆ FClass2d()

IntTools_FClass2d & IntTools_Context::FClass2d ( const TopoDS_Face & aF )

Returns a reference to point classifier for given face.

◆ Hatcher()

Geom2dHatch_Hatcher & IntTools_Context::Hatcher ( const TopoDS_Face & aF )

Returns a reference to 2D hatcher for given face.

◆ IsInfiniteFace()

Standard_Boolean IntTools_Context::IsInfiniteFace ( const TopoDS_Face & theFace )

Returns true if the solid <theFace> has infinite bounds.

◆ IsPointInFace() [1/2]

Standard_Boolean IntTools_Context::IsPointInFace	(	const gp_Pnt &	aP3D,
		const TopoDS_Face &	aF,
		const Standard_Real	aTol
	)

Returns true if the point aP2D is inside the boundaries of the face aF, otherwise returns false.

◆ IsPointInFace() [2/2]

Standard_Boolean IntTools_Context::IsPointInFace	(	const TopoDS_Face &	aF,
		const gp_Pnt2d &	aP2D
	)

Returns true if the point aP2D is inside the boundaries of the face aF, otherwise returns false.

◆ IsPointInOnFace()

Standard_Boolean IntTools_Context::IsPointInOnFace	(	const TopoDS_Face &	aF,
		const gp_Pnt2d &	aP2D
	)

Returns true if the point aP2D is inside or on the boundaries of aF.

◆ IsValidBlockForFace()

Standard_Boolean IntTools_Context::IsValidBlockForFace	(	const Standard_Real	aT1,
		const Standard_Real	aT2,
		const IntTools_Curve &	aIC,
		const TopoDS_Face &	aF,
		const Standard_Real	aTol
	)

Returns true if IsValidPointForFace returns true for some 3d point that lay on the curve aIC bounded by parameters aT1 and aT2.

◆ IsValidBlockForFaces()

Standard_Boolean IntTools_Context::IsValidBlockForFaces	(	const Standard_Real	aT1,
		const Standard_Real	aT2,
		const IntTools_Curve &	aIC,
		const TopoDS_Face &	aF1,
		const TopoDS_Face &	aF2,
		const Standard_Real	aTol
	)

Returns true if IsValidBlockForFace returns true for both faces aF1 and aF2.

◆ IsValidPointForFace()

Standard_Boolean IntTools_Context::IsValidPointForFace	(	const gp_Pnt &	aP3D,
		const TopoDS_Face &	aF,
		const Standard_Real	aTol
	)

Returns true if the distance between point aP3D and face aF is less or equal to tolerance aTol and projection point is inside or on the boundaries of the face aF.

◆ IsValidPointForFaces()

Standard_Boolean IntTools_Context::IsValidPointForFaces	(	const gp_Pnt &	aP3D,
		const TopoDS_Face &	aF1,
		const TopoDS_Face &	aF2,
		const Standard_Real	aTol
	)

Returns true if IsValidPointForFace returns true for both face aF1 and aF2.

◆ IsVertexOnLine() [1/2]

Standard_Boolean IntTools_Context::IsVertexOnLine	(	const TopoDS_Vertex &	aV,
		const IntTools_Curve &	aIC,
		const Standard_Real	aTolC,
		Standard_Real &	aT
	)

Computes parameter of the vertex aV on the curve aIC. Returns true if the distance between vertex and curve is less than sum of tolerance of aV and aTolC, otherwise or if projection algorithm failed returns false (in this case aT isn't significant)

◆ IsVertexOnLine() [2/2]

Standard_Boolean IntTools_Context::IsVertexOnLine	(	const TopoDS_Vertex &	aV,
		const Standard_Real	aTolV,
		const IntTools_Curve &	aIC,
		const Standard_Real	aTolC,
		Standard_Real &	aT
	)

Computes parameter of the vertex aV on the curve aIC. Returns true if the distance between vertex and curve is less than sum of tolerance of aV and aTolC, otherwise or if projection algorithm failed returns false (in this case aT isn't significant)

◆ OBB()

Bnd_OBB & IntTools_Context::OBB	(	const TopoDS_Shape &	theShape,
		const Standard_Real	theFuzzyValue = `Precision::Confusion()`
	)

Builds and stores an Oriented Bounding Box for the shape. Returns a reference to OBB.

◆ ProjectPointOnEdge()

Standard_Boolean IntTools_Context::ProjectPointOnEdge	(	const gp_Pnt &	aP,
		const TopoDS_Edge &	aE,
		Standard_Real &	aT
	)

Computes parameter of the point aP on the edge aE. Returns false if projection algorithm failed other wiese returns true.

◆ ProjPC()

GeomAPI_ProjectPointOnCurve & IntTools_Context::ProjPC ( const TopoDS_Edge & aE )

Returns a reference to point projector for given edge.

◆ ProjPS()

GeomAPI_ProjectPointOnSurf & IntTools_Context::ProjPS ( const TopoDS_Face & aF )

Returns a reference to point projector for given face.

◆ ProjPT()

GeomAPI_ProjectPointOnCurve & IntTools_Context::ProjPT ( const Handle< Geom_Curve > & aC )

Returns a reference to point projector for given curve.

◆ SetPOnSProjectionTolerance()

void IntTools_Context::SetPOnSProjectionTolerance ( const Standard_Real theValue )

Sets tolerance to be used for projection of point on surface. Clears map of already cached projectors in order to maintain correct value for all projectors.

◆ SolidClassifier()

BRepClass3d_SolidClassifier & IntTools_Context::SolidClassifier ( const TopoDS_Solid & aSolid )

Returns a reference to solid classifier for given solid.

◆ StatePointFace()

TopAbs_State IntTools_Context::StatePointFace	(	const TopoDS_Face &	aF,
		const gp_Pnt2d &	aP2D
	)

Returns the state of the point aP2D relative to face aF.

◆ SurfaceAdaptor()

BRepAdaptor_Surface & IntTools_Context::SurfaceAdaptor ( const TopoDS_Face & theFace )

Returns a reference to surface adaptor for given face.

◆ SurfaceData()

IntTools_SurfaceRangeLocalizeData & IntTools_Context::SurfaceData ( const TopoDS_Face & aF )

Returns a reference to surface localization data for given face.

◆ UVBounds()

void IntTools_Context::UVBounds	(	const TopoDS_Face &	theFace,
		Standard_Real &	UMin,
		Standard_Real &	UMax,
		Standard_Real &	VMin,
		Standard_Real &	VMax
	)

Computes the boundaries of the face using surface adaptor.

Field Documentation

◆ myAllocator

Handle< NCollection_BaseAllocator > IntTools_Context::myAllocator

protected

◆ myBndBoxDataMap

NCollection_DataMap<TopoDS_Shape, Bnd_Box*, TopTools_ShapeMapHasher> IntTools_Context::myBndBoxDataMap

protected

◆ myCreateFlag

Standard_Integer IntTools_Context::myCreateFlag

protected

◆ myFClass2dMap

NCollection_DataMap<TopoDS_Shape, IntTools_FClass2d*, TopTools_ShapeMapHasher> IntTools_Context::myFClass2dMap

protected

◆ myHatcherMap

NCollection_DataMap<TopoDS_Shape, Geom2dHatch_Hatcher*, TopTools_ShapeMapHasher> IntTools_Context::myHatcherMap

protected

◆ myOBBMap

NCollection_DataMap<TopoDS_Shape, Bnd_OBB*, TopTools_ShapeMapHasher> IntTools_Context::myOBBMap

protected

◆ myPOnSTolerance

Standard_Real IntTools_Context::myPOnSTolerance

protected

◆ myProjPCMap

NCollection_DataMap<TopoDS_Shape, GeomAPI_ProjectPointOnCurve*, TopTools_ShapeMapHasher> IntTools_Context::myProjPCMap

protected

◆ myProjPSMap

NCollection_DataMap<TopoDS_Shape, GeomAPI_ProjectPointOnSurf*, TopTools_ShapeMapHasher> IntTools_Context::myProjPSMap

protected

◆ myProjPTMap

NCollection_DataMap<Handle< Geom_Curve >, GeomAPI_ProjectPointOnCurve*> IntTools_Context::myProjPTMap

protected

◆ myProjSDataMap

NCollection_DataMap<TopoDS_Shape, IntTools_SurfaceRangeLocalizeData*, TopTools_ShapeMapHasher> IntTools_Context::myProjSDataMap

protected

◆ mySClassMap

NCollection_DataMap<TopoDS_Shape, BRepClass3d_SolidClassifier*, TopTools_ShapeMapHasher> IntTools_Context::mySClassMap

protected

◆ mySurfAdaptorMap

NCollection_DataMap<TopoDS_Shape, BRepAdaptor_Surface*, TopTools_ShapeMapHasher> IntTools_Context::mySurfAdaptorMap

protected

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

IntTools_Context.hxx

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ IntTools_Context() [1/2]

◆ ~IntTools_Context()

◆ IntTools_Context() [2/2]

Member Function Documentation

◆ BndBox()

◆ ComputePE()

◆ ComputeVE()

◆ ComputeVF()

◆ FClass2d()

◆ Hatcher()

◆ IsInfiniteFace()

◆ IsPointInFace() [1/2]

◆ IsPointInFace() [2/2]

◆ IsPointInOnFace()

◆ IsValidBlockForFace()

◆ IsValidBlockForFaces()

◆ IsValidPointForFace()

◆ IsValidPointForFaces()

◆ IsVertexOnLine() [1/2]

◆ IsVertexOnLine() [2/2]

◆ OBB()

◆ ProjectPointOnEdge()

◆ ProjPC()

◆ ProjPS()

◆ ProjPT()

◆ SetPOnSProjectionTolerance()

◆ SolidClassifier()

◆ StatePointFace()

◆ SurfaceAdaptor()

◆ SurfaceData()

◆ UVBounds()

Field Documentation

◆ myAllocator

◆ myBndBoxDataMap

◆ myCreateFlag

◆ myFClass2dMap

◆ myHatcherMap

◆ myOBBMap

◆ myPOnSTolerance

◆ myProjPCMap

◆ myProjPSMap

◆ myProjPTMap

◆ myProjSDataMap

◆ mySClassMap

◆ mySurfAdaptorMap