Classes
struct	ActionData
	Plugin action data. More...

struct	CompareShapes
	Sort shapes in the list by their coordinates. More...

class	Hatcher

struct	PluginData
	Plugin data. More...

struct	Range

class	Trsf2d

class	TrsfCurve2d

Typedefs
typedef std::vector< std::string >	NodeLinks

typedef std::map< std::string, NodeLinks >	LevelInfo

typedef std::vector< LevelInfo >	LevelsList

typedef std::map< std::string, std::pair< LevelsList, LevelsList > >	TreeModel

typedef std::vector< Range >	Distribution

typedef std::list< PluginData >	PluginInfo
	Plugins information. More...

Enumerations
enum	ComparisonCondition { CC_GT , CC_GE , CC_LT , CC_LE }
	This enumeration represents comparison conditions. More...

Functions
Standard_EXPORT std::pair< double, double >	ShapeToDouble (const TopoDS_Shape &theShape, bool isOldSorting=false)
	Compute numerical functor for the shape. More...

Standard_EXPORT gp_Ax3	GetPosition (const TopoDS_Shape &theShape)
	Get Local Coordinate System, corresponding to the given shape. More...

Standard_EXPORT gp_Vec	GetVector (const TopoDS_Shape &theShape, Standard_Boolean doConsiderOrientation)
	Get vector, defined by the given edge. More...

Standard_EXPORT void	SortShapes (TopTools_ListOfShape &SL, const Standard_Boolean isOldSorting=Standard_True)
	Sort shapes by their centers of mass, using formula X999 + Y99 + Z*0.9. More...

Standard_EXPORT TopoDS_Shape	CompsolidToCompound (const TopoDS_Shape &theCompsolid)
	Convert TopoDS_COMPSOLID to TopoDS_COMPOUND. More...

Standard_EXPORT void	AddSimpleShapes (const TopoDS_Shape &theShape, TopTools_ListOfShape &theList)
	Recursively extract all shapes from compounds and compsolids of the given shape into theList. More...

Standard_EXPORT TopAbs_ShapeEnum	GetTypeOfSimplePart (const TopoDS_Shape &theShape)
	Return type of shape for explode. In case of compound it will be a type of its first sub shape. More...

Standard_EXPORT TopAbs_ShapeEnum	GetCommonShapeType (const TopoDS_Shape &theShape)
	Get the common shape type of the top-level shapes contained in the given shape. More...

Standard_EXPORT TopoDS_Shape	GetEdgeNearPoint (const TopoDS_Shape &theShape, const TopoDS_Vertex &thePoint)
	Find an edge of theShape, closest to thePoint. More...

Standard_EXPORT Standard_Boolean	PreciseBoundingBox (const TopoDS_Shape &theShape, Bnd_Box &theBox)
	Compute precise bounding box of the shape based on the rough bounding box. More...

Standard_EXPORT Standard_Real	GetMinDistance (const TopoDS_Shape &theShape1, const TopoDS_Shape &theShape2, gp_Pnt &thePnt1, gp_Pnt &thePnt2)
	Computes minumal distance between two shapes. More...

Standard_EXPORT gp_Pnt	ProjectPointOnFace (const gp_Pnt &thePoint, const TopoDS_Shape &theFace, double &theU, double &theV, const double theTol=1e-04)
	Computes normal projection of thePoint to theFace. More...

Standard_EXPORT Standard_Real	DistanceToProjectionOnFace (const gp_Pnt &thePoint, const TopoDS_Shape &theFace, const double theTol=1e-04)
	Computes distance from thePoint to its normal projection on theFace. More...

Standard_EXPORT gp_Pnt	ConvertClickToPoint (int x, int y, Handle(V3d_View) theView)
	Returns the point clicked in 3D view. More...

Standard_EXPORT void	ConvertTreeToString (const TreeModel &tree, std::string &dependencyStr)
	Convert dependency tree data to the string representation. More...

Standard_EXPORT void	ConvertStringToTree (const std::string &dependencyStr, TreeModel &tree)
	Restore dependency tree data from the string representation. More...

Standard_EXPORT bool	CheckShape (TopoDS_Shape &shape, bool checkGeometry=false, bool isExact=false)
	Check shape. More...

Standard_EXPORT bool	CheckBOPArguments (const TopoDS_Shape &theShape)
	Check boolean and partition operations arguments. More...

Standard_EXPORT bool	FixShapeTolerance (TopoDS_Shape &shape, TopAbs_ShapeEnum type=TopAbs_SHAPE, Standard_Real tolerance=Precision::Confusion(), bool checkGeometry=false, bool isExactAdjust=false)
	Limit shape tolerance to the given value. More...

Standard_EXPORT bool	FixShapeCurves (TopoDS_Shape &shape)
	Fix curves of the given shape. More...

Standard_EXPORT bool	Write (const TopoDS_Shape &shape, const char *fileName)
	Write shape to the BREP file. More...

Standard_EXPORT TopoDS_Shape	ReduceCompound (const TopoDS_Shape &shape)
	Extract single SOLID from COMPSOLID or COMPOUND. More...

Standard_EXPORT double	DefaultDeflection ()
	Get default deflection coefficient used for triangulation. More...

Standard_EXPORT bool	MeshShape (const TopoDS_Shape theShape, const double theDeflection=DefaultDeflection(), const bool theForced=true, const double theAngleDeflection=0.5, const bool isRelative=true, const bool doPostCheck=false)
	Generate triangulation for theShape. More...

Standard_EXPORT bool	CheckTriangulation (const TopoDS_Shape &theShape)
	Build a triangulation on theShape if it is absent. More...

Standard_EXPORT bool	IsOpenPath (const TopoDS_Shape &theShape)
	Check if the shape is not a closed wire or edge. More...

Standard_EXPORT int	CompareToleranceValues (const double theTolShape, const double theTolRef)
	This function compares two tolerances. More...

Standard_EXPORT bool	IsFitCondition (const ComparisonCondition theCondition, const double theTolShape, const double theTolRef)
	Check if the comarison of tolerances fit the condition. More...

std::map< int, double >	ComputeMeasures (std::list< TopoDS_Shape > shapes, TopAbs_ShapeEnum entity, Range &range)

Distribution	ComputeDistribution (TopoDS_Shape shape, TopAbs_ShapeEnum entity, int intervals, Range range)

Distribution	ComputeDistribution (std::list< TopoDS_Shape > shapes, TopAbs_ShapeEnum entity, int nbIntervals, Range range)

PluginInfo	ReadPluginInfo ()

Detailed Description

This class represents a hatcher for topological faces.

This class represents a non-persistent transformation in 2D space. The transformations can be represented as follow :

 V1   V2   T       XY        XY

| a11 a12 a13 | | x | | x'| | a21 a22 a23 | | y | | y'| | 0 0 1 | | 1 | | 1 |

where {V1, V2} defines the vectorial part of the transformation and T defines the translation part of the transformation. This transformation can change the nature of the objects if it is anisotropic.

Typedef Documentation

◆ Distribution

typedef std::vector<Range> GEOMUtils::Distribution

◆ LevelInfo

typedef std::map<std::string, NodeLinks> GEOMUtils::LevelInfo

◆ LevelsList

typedef std::vector<LevelInfo> GEOMUtils::LevelsList

◆ NodeLinks

typedef std::vector<std::string> GEOMUtils::NodeLinks

◆ PluginInfo

typedef std::list<PluginData> GEOMUtils::PluginInfo

◆ TreeModel

typedef std::map<std::string,std::pair<LevelsList,LevelsList> > GEOMUtils::TreeModel

Enumeration Type Documentation

◆ ComparisonCondition

enum GEOMUtils::ComparisonCondition

Enumerator
CC_GT	Greater then.
CC_GE	Greater then or equal to.
CC_LT	Less then.
CC_LE	Less then or equal to.

Function Documentation

◆ AddSimpleShapes()

void GEOMUtils::AddSimpleShapes	(	const TopoDS_Shape &	theShape,
		TopTools_ListOfShape &	theList
	)

If theShape is not compound or compsolid, theList will contain only theShape itself.

Parameters

theShape	The shape to be exploded.
theList	Output parameter.

References AddSimpleShapes().

◆ CheckBOPArguments()

bool GEOMUtils::CheckBOPArguments ( const TopoDS_Shape & theShape )

Parameters

theShape the argument of an operation to be checked

Returns: true if the argument is valid for a boolean or partition operation or false otherwise

◆ CheckShape()

bool GEOMUtils::CheckShape	(	TopoDS_Shape &	shape,
		bool	checkGeometry = `false`,
		bool	isExact = `false`
	)

Parameters

shape	input shape object
checkGeometry	when set to `true`, causes check of underlying geometry in addition to the topology
isExact	when set to `true`, causes exact check of curves on surfaces

Returns: true if shape is valid or false otherwise

◆ CheckTriangulation()

bool GEOMUtils::CheckTriangulation ( const TopoDS_Shape & theShape )

Parameters

theShape The shape to check/build triangulation on.

Return values

bool	Returns false if the shape has no faces, i.e. impossible to build triangulation.

References DefaultDeflection(), and MeshShape().

◆ CompareToleranceValues()

int GEOMUtils::CompareToleranceValues	(	const double	theTolShape,
		const double	theTolRef
	)

The shape tolerance (the first argument) is considered less than the reference tolerance (the second argument) if theTolShape < theTolRef - Tolerance(theTolRef). theTolShape is considered greater than theTolRef if theTolShape > theTolRef + Tolerance(theTolRef). Otherwise these tolerances are equal. Tolerance(theTolRef) = theTolRef*DEFAULT_TOLERANCE_TOLERANCE. But this value should not be greated than DEFAULT_MAX_TOLERANCE_TOLERANCE.

Parameters

theTolShape	the shape tolerance
theTolRef	the reference tolerance

Returns: -1 if theTolShape is less than theTolRef; 1 if theTolShape is greater than theTolRef; 0 if they are equal

References aResult, DEFAULT_MAX_TOLERANCE_TOLERANCE, and DEFAULT_TOLERANCE_TOLERANCE.

◆ CompsolidToCompound()

TopoDS_Shape GEOMUtils::CompsolidToCompound ( const TopoDS_Shape & theCompsolid )

If the argument shape is not of type TopoDS_COMPSOLID, this method returns it as is.

Parameters

theCompsolid The compsolid to be converted.

Return values

TopoDS_Shape Returns the resulting compound.

◆ ComputeDistribution() [1/2]

Standard_EXPORT Distribution GEOMUtils::ComputeDistribution	(	std::list< TopoDS_Shape >	shapes,
		TopAbs_ShapeEnum	entity,
		int	nbIntervals,
		Range	range
	)

References ComputeMeasures(), GEOMUtils::Range::count, GEOMUtils::Range::indices, GEOMUtils::Range::max, and GEOMUtils::Range::min.

◆ ComputeDistribution() [2/2]

Standard_EXPORT Distribution GEOMUtils::ComputeDistribution	(	TopoDS_Shape	shape,
		TopAbs_ShapeEnum	entity,
		int	intervals,
		Range	range
	)

References ComputeDistribution().

◆ ComputeMeasures()

Standard_EXPORT std::map< int, double > GEOMUtils::ComputeMeasures	(	std::list< TopoDS_Shape >	shapes,
		TopAbs_ShapeEnum	entity,
		Range &	range
	)

References GEOMUtils::Range::max, and GEOMUtils::Range::min.

◆ ConvertClickToPoint()

gp_Pnt GEOMUtils::ConvertClickToPoint	(	int	x,
		int	y,
		Handle(V3d_View)	theView
	)

Parameters

x	The X coordinate in the view.
y	The Y coordinate in the view.
theView	View where the given point takes place.

Return values

gp_Pnt Returns the point clicked in 3D view

◆ ConvertStringToTree()

void GEOMUtils::ConvertStringToTree	(	const std::string &	dependencyStr,
		TreeModel &	tree
	)

Parameters

dependencyStr	string representation of tree data
tree	output dependency tree data

◆ ConvertTreeToString()

void GEOMUtils::ConvertTreeToString	(	const TreeModel &	tree,
		std::string &	dependencyStr
	)

Parameters

tree	dependency tree data
dependencyStr	output string

◆ DefaultDeflection()

double GEOMUtils::DefaultDeflection ( )

Returns: default deflection value

References DefaultDeflection().

◆ DistanceToProjectionOnFace()

Standard_Real GEOMUtils::DistanceToProjectionOnFace	(	const gp_Pnt &	thePoint,
		const TopoDS_Shape &	theFace,
		const double	theTol = `1e-04`
	)

Parameters

thePoint	the 3d point
theFace	the face shape
theTol	the tolerance value. Maximum of theTol and 1e-04 will be used for calculation.

Return values

distance from thePoint to the projection point. If projection point is not found or is OUT of face boundary, -1 is returned.

References Handle().

◆ FixShapeCurves()

bool GEOMUtils::FixShapeCurves ( TopoDS_Shape & shape )

The function checks each curve of the input shape in the following way:

compute deviation of the curve from the underlying surface in a set of points computed with the certain discretization step value
find maximum tolerance between computed deviation values
limit tolerance of the curve with the computed maximum value

Parameters

shape shape being fixed

Returns: true if resulting shape is valid

References CheckShape().

◆ FixShapeTolerance()

bool GEOMUtils::FixShapeTolerance	(	TopoDS_Shape &	shape,
		TopAbs_ShapeEnum	type = `TopAbs_SHAPE`,
		Standard_Real	tolerance = `Precision::Confusion()`,
		bool	checkGeometry = `false`,
		bool	isExactAdjust = `false`
	)

Parameters

shape	shape being fixed
type	topology type which tolerance is to be limited; TopAbs_SHAPE means all types of topology
tolerance	expected tolerance value (1e-7 by default)
checkGeometry	check geometry validity of result

Returns: true if resulting shape is valid

Note: Resulting tolerance of the shape is not mandatory equal to requested value as it might be changed by fixshape operation in order to get valid shape where possible; By default, result only checked for topology validity; check of geometry can be done by passing true to checkGeometry parameter

References CheckShape(), and Handle().

◆ GetCommonShapeType()

TopAbs_ShapeEnum GEOMUtils::GetCommonShapeType ( const TopoDS_Shape & theShape )

In contrast to GetTypeOfSimplePart(), this function returns the common type of the top-level sub-shapes of the COMPOUND, if there are multiple sub-shapes. If there is no common shape type for the same COMPOUND, the generic SHAPE value is returned.

Parameters

theShape The shape to get common type of.

Return values

TopAbs_ShapeEnum Returns the common shape type.

References GetCommonShapeType().

◆ GetEdgeNearPoint()

TopoDS_Shape GEOMUtils::GetEdgeNearPoint	(	const TopoDS_Shape &	theShape,
		const TopoDS_Vertex &	thePoint
	)

Parameters

theShape	The shape to explore.
thePoint	The point near the required edge.

Return values

TopoDS_Shape Returns the found edge or an empty shape if multiple edges found.

References aResult.

◆ GetMinDistance()

Standard_Real GEOMUtils::GetMinDistance	(	const TopoDS_Shape &	theShape1,
		const TopoDS_Shape &	theShape2,
		gp_Pnt &	thePnt1,
		gp_Pnt &	thePnt2
	)

Parameters

theShape1	the first shape
theShape2	the second shape
thePnt1	the output result point on the first shape
thePnt2	the output result point on the second shape

Return values

negative value in case of failure; otherwise the real distance.

References aResult.

◆ GetPosition()

gp_Ax3 GEOMUtils::GetPosition ( const TopoDS_Shape & theShape )

Origin of the LCS is situated at the shape's center of mass. Axes of the LCS are obtained from shape's location or, if the shape is a planar face, from position of its plane.

References aResult, GetTypeOfSimplePart(), and Handle().

◆ GetTypeOfSimplePart()

TopAbs_ShapeEnum GEOMUtils::GetTypeOfSimplePart ( const TopoDS_Shape & theShape )

Parameters

theShape The shape to get type of.

Return values

TopAbs_ShapeEnum Return type of shape for explode.

References GetTypeOfSimplePart().

◆ GetVector()

gp_Vec GEOMUtils::GetVector	(	const TopoDS_Shape &	theShape,
		Standard_Boolean	doConsiderOrientation
	)

Parameters

theShape	The edge.
doConsiderOrientation	If True, take into account the edge orientation.

Note: It is recommended to use doConsiderOrientation=Standard_False, because the same edge can have different orientation depending on the way it was extracted from a shape.

References GEOM::Vertices.

◆ IsFitCondition()

bool GEOMUtils::IsFitCondition	(	const ComparisonCondition	theCondition,
		const double	theTolShape,
		const double	theTolRef
	)

The comparison of tolerances is performed using the function CompareToleranceValues.

Parameters

theCondition	the condition
theTolShape	the shape tolerance
theTolRef	the reference tolerance

Returns: true if the shape tolerance fits the condition; false otherwise.

References CC_GE, CC_GT, CC_LE, CC_LT, and CompareToleranceValues().

◆ IsOpenPath()

bool GEOMUtils::IsOpenPath ( const TopoDS_Shape & theShape )

This function is used for pipe creation algorithm to test if the pipe path is not closed. It returns false if theShape is a wire or an edge with coincident end vertices. Otherwise it returns true.

Parameters

theShape the shape to be tested.

Returns: true if theShape is not a closed wire or edge.

References GEOM::Vertices.

◆ MeshShape()

bool GEOMUtils::MeshShape	(	const TopoDS_Shape	theShape,
		const double	theDeflection = `DefaultDeflection()`,
		const bool	theForced = `true`,
		const double	theAngleDeflection = `0.5`,
		const bool	isRelative = `true`,
		const bool	doPostCheck = `false`
	)

Parameters

theShape	shape to be meshed.
theDeflection	deflection coefficient to be used.
theForced	if `true`, causes generation of mesh regardless it is already present in the shape.
theAngleDeflection	angular deflection coefficient to be used.
isRelative	if true, theDeflection is considered relative to theShape maximum axial dimension.
doPostCheck	if true, check mesh generation result and return corresponding boolean value.

Return values

bool	Returns false in the following cases: The shape has neither faces nor edges, i.e. impossible to build triangulation or polygon. theForced is false and theShape has no mesh or has incomplete mesh. doPostCheck is true and mesh generation failed or produced an incomplete mesh.

References MeshShape().

◆ PreciseBoundingBox()

Standard_Boolean GEOMUtils::PreciseBoundingBox	(	const TopoDS_Shape &	theShape,
		Bnd_Box &	theBox
	)

Parameters

theShape	the shape.
theBox	rough bounding box on input; precise bounding box on output.

Return values

Standard_True in case of success; Standard_False otherwise.

References GetMinDistance().

◆ ProjectPointOnFace()

gp_Pnt GEOMUtils::ProjectPointOnFace	(	const gp_Pnt &	thePoint,
		const TopoDS_Shape &	theFace,
		double &	theU,
		double &	theV,
		const double	theTol = `1e-04`
	)

Parameters

thePoint	the 3d point
theFace	the face shape
theU	the output U parameter of the point on the face
theV	the output V parameter of the point on the face
theTol	the tolerance value. Maximum of theTol and 1e-04 will be used for calculation.

Return values

the	projection (3d point) if found, throws an exception otherwise

References Handle().

◆ ReadPluginInfo()

Standard_EXPORT PluginInfo GEOMUtils::ReadPluginInfo ( )

References GEOMUtils::ActionData::accel, GEOMUtils::PluginData::actions, GEOMUtils::PluginData::clientLib, GEOMUtils::ActionData::icon, GEOMUtils::ActionData::label, GEOMUtils::ActionData::menuText, GEOMUtils::PluginData::name, GEOMUtils::PluginData::serverLib, GEOMUtils::ActionData::statusText, and GEOMUtils::ActionData::toolTip.

◆ ReduceCompound()

TopoDS_Shape GEOMUtils::ReduceCompound ( const TopoDS_Shape & shape )

If the argument shape is a COMPOUND or COMPSOLID and there's only single simple-shape type inside, this sub-shape is returned as a result; otherwise, the shape is not changed.

Parameters

shape compound or compsolid being processed.

Return values

TopoDS_Shape resulting shape

References ReduceCompound().

◆ ShapeToDouble()

std::pair< double, double > GEOMUtils::ShapeToDouble	(	const TopoDS_Shape &	theShape,
		bool	isOldSorting = `false`
	)

Resulting value can be used to sort out shapes according to some parameter.

Returns a pair of two values (dist, functor) where

dist is a some value that is computed according to the center of mass of given shape;
functor is a numerical functor value

The numerical functor is computed according to the shape's topological properties as follows:

orientation for vertices
length for edges and wires
area for faces and shells
volume for solids, compounds, compsolids

If isOldSorting parameter is set to true, for all cases linear properties of the shape are used (to support backward compatibility in some methods). By default, this parameter is set to false.

◆ SortShapes()

void GEOMUtils::SortShapes	(	TopTools_ListOfShape &	SL,
		const Standard_Boolean	isOldSorting = `Standard_True`
	)

◆ Write()

bool GEOMUtils::Write	(	const TopoDS_Shape &	shape,
		const char *	fileName
	)

Parameters

source shape

Returns: true if file was written or false otherwise

References Write().

Classes

Typedefs

Enumerations

Functions

Detailed Description

Typedef Documentation

◆ Distribution

◆ LevelInfo

◆ LevelsList

◆ NodeLinks

◆ PluginInfo

◆ TreeModel

Enumeration Type Documentation

◆ ComparisonCondition

Function Documentation

◆ AddSimpleShapes()

◆ CheckBOPArguments()

◆ CheckShape()

◆ CheckTriangulation()

◆ CompareToleranceValues()

◆ CompsolidToCompound()

◆ ComputeDistribution() [1/2]

◆ ComputeDistribution() [2/2]

◆ ComputeMeasures()

◆ ConvertClickToPoint()

◆ ConvertStringToTree()

◆ ConvertTreeToString()

◆ DefaultDeflection()

◆ DistanceToProjectionOnFace()

◆ FixShapeCurves()

◆ FixShapeTolerance()

◆ GetCommonShapeType()

◆ GetEdgeNearPoint()

◆ GetMinDistance()

◆ GetPosition()

◆ GetTypeOfSimplePart()

◆ GetVector()

◆ IsFitCondition()

◆ IsOpenPath()

◆ MeshShape()

◆ PreciseBoundingBox()

◆ ProjectPointOnFace()

◆ ReadPluginInfo()

◆ ReduceCompound()

◆ ShapeToDouble()

◆ SortShapes()

◆ Write()