BRepOffsetAPI_FindContigousEdges Class Reference

Provides methods to identify contiguous boundaries for continuity control (C0, C1, ...) More...

#include <BRepOffsetAPI_FindContigousEdges.hxx>

Public Member Functions
	BRepOffsetAPI_FindContigousEdges (const Standard_Real tolerance=1.0e-06, const Standard_Boolean option=Standard_True)
	Initializes an algorithm for identifying contiguous edges on shapes with tolerance as the tolerance of contiguity (defaulted to 1.0e-6). This tolerance value is used to determine whether two edges or sections of edges are coincident. Use the function Add to define the shapes to be checked. Set option to false. This argument (defaulted to true) will serve in subsequent software releases for performing an analysis of degenerated shapes.
void	Init (const Standard_Real tolerance, const Standard_Boolean option)
	Initializes this algorithm for identifying contiguous edges on shapes using the tolerance of contiguity tolerance. This tolerance value is used to determine whether two edges or sections of edges are coincident. Use the function Add to define the shapes to be checked. Sets <option> to false.
void	Add (const TopoDS_Shape &shape)
	Adds the shape shape to the list of shapes to be checked by this algorithm. Once all the shapes to be checked have been added, use the function Perform to find the contiguous edges and the function ContigousEdge to return these edges.
void	Perform ()
	Finds coincident parts of edges of two or more shapes added to this algorithm and breaks down these edges into contiguous and non-contiguous sections on copies of the initial shapes. The function ContigousEdge returns contiguous edges. The function Modified can be used to return modified copies of the initial shapes where one or more edges were broken down into contiguous and non-contiguous sections. Warning This function must be used once all the shapes to be checked have been added. It is not possible to add further shapes subsequently and then to repeat the call to Perform.
Standard_Integer	NbEdges () const
	Gives the number of edges (free edges + contiguous edges + multiple edge)
Standard_Integer	NbContigousEdges () const
	Returns the number of contiguous edges found by the function Perform on the shapes added to this algorithm.
const TopoDS_Edge &	ContigousEdge (const Standard_Integer index) const
	Returns the contiguous edge of index index found by the function Perform on the shapes added to this algorithm. Exceptions Standard_OutOfRange if:
const TopTools_ListOfShape &	ContigousEdgeCouple (const Standard_Integer index) const
	Returns a list of edges coincident with the contiguous edge of index index found by the function Perform. There are as many edges in the list as there are faces adjacent to this contiguous edge. Exceptions Standard_OutOfRange if:
const TopoDS_Edge &	SectionToBoundary (const TopoDS_Edge &section) const
	Returns the edge on the initial shape, of which the modified copy contains the edge section. section is coincident with a contiguous edge found by the function Perform. Use the function ContigousEdgeCouple to obtain a valid section. This information is useful for verification purposes, since it provides a means of determining the surface to which the contiguous edge belongs. Exceptions Standard_NoSuchObject if section is not coincident with a contiguous edge. Use the function ContigousEdgeCouple to obtain a valid section.
Standard_Integer	NbDegeneratedShapes () const
	Gives the number of degenerated shapes.
const TopoDS_Shape &	DegeneratedShape (const Standard_Integer index) const
	Gives a degenerated shape.
Standard_Boolean	IsDegenerated (const TopoDS_Shape &shape) const
	Indicates if a input shape is degenerated.
Standard_Boolean	IsModified (const TopoDS_Shape &shape) const
	Returns true if the copy of the initial shape shape was modified by the function Perform (i.e. if one or more of its edges was broken down into contiguous and non-contiguous sections). Warning Returns false if shape is not one of the initial shapes added to this algorithm.
const TopoDS_Shape &	Modified (const TopoDS_Shape &shape) const
	Gives a modifieded shape Raises NoSuchObject if shape has not been modified.
void	Dump () const
	Dump properties of resulting shape.

Detailed Description

Provides methods to identify contiguous boundaries for continuity control (C0, C1, ...)

Use this function as following:

• create an object
• default tolerance 1.E-06
• with analysis of degenerated faces on
• define if necessary a new tolerance
• set if necessary analysis of degenerated shapes off
• add shapes to be controlled -> Add
• compute -> Perform
• output couples of connected edges for control
• output the problems if any

Constructor & Destructor Documentation

BRepOffsetAPI_FindContigousEdges()

BRepOffsetAPI_FindContigousEdges::BRepOffsetAPI_FindContigousEdges	(	const Standard_Real	tolerance = 1.0e-06,
		const Standard_Boolean	option = Standard_True )

Initializes an algorithm for identifying contiguous edges on shapes with tolerance as the tolerance of contiguity (defaulted to 1.0e-6). This tolerance value is used to determine whether two edges or sections of edges are coincident. Use the function Add to define the shapes to be checked. Set option to false. This argument (defaulted to true) will serve in subsequent software releases for performing an analysis of degenerated shapes.

Member Function Documentation

Add()

void BRepOffsetAPI_FindContigousEdges::Add

(

const TopoDS_Shape &

shape

)

Adds the shape shape to the list of shapes to be checked by this algorithm. Once all the shapes to be checked have been added, use the function Perform to find the contiguous edges and the function ContigousEdge to return these edges.

ContigousEdge()

const TopoDS_Edge & BRepOffsetAPI_FindContigousEdges::ContigousEdge

(

const Standard_Integer

index

)

const

Returns the contiguous edge of index index found by the function Perform on the shapes added to this algorithm. Exceptions Standard_OutOfRange if:

• index is less than 1, or
• index is greater than the number of contiguous edges found by the function Perform on the shapes added to this algorithm.

ContigousEdgeCouple()

const TopTools_ListOfShape & BRepOffsetAPI_FindContigousEdges::ContigousEdgeCouple

(

const Standard_Integer

index

)

const

Returns a list of edges coincident with the contiguous edge of index index found by the function Perform. There are as many edges in the list as there are faces adjacent to this contiguous edge. Exceptions Standard_OutOfRange if:

• index is less than 1, or
• index is greater than the number of contiguous edges found by the function Perform on the shapes added to this algorithm.

DegeneratedShape()

const TopoDS_Shape & BRepOffsetAPI_FindContigousEdges::DegeneratedShape

(

const Standard_Integer

index

)

const

Gives a degenerated shape.

Dump()

void BRepOffsetAPI_FindContigousEdges::Dump

(

)

const

Dump properties of resulting shape.

Init()

void BRepOffsetAPI_FindContigousEdges::Init	(	const Standard_Real	tolerance,
		const Standard_Boolean	option )

Initializes this algorithm for identifying contiguous edges on shapes using the tolerance of contiguity tolerance. This tolerance value is used to determine whether two edges or sections of edges are coincident. Use the function Add to define the shapes to be checked. Sets <option> to false.

IsDegenerated()

Standard_Boolean BRepOffsetAPI_FindContigousEdges::IsDegenerated

(

const TopoDS_Shape &

shape

)

const

Indicates if a input shape is degenerated.

IsModified()

Standard_Boolean BRepOffsetAPI_FindContigousEdges::IsModified

(

const TopoDS_Shape &

shape

)

const

Returns true if the copy of the initial shape shape was modified by the function Perform (i.e. if one or more of its edges was broken down into contiguous and non-contiguous sections). Warning Returns false if shape is not one of the initial shapes added to this algorithm.

Modified()

const TopoDS_Shape & BRepOffsetAPI_FindContigousEdges::Modified

(

const TopoDS_Shape &

shape

)

const

Gives a modifieded shape Raises NoSuchObject if shape has not been modified.

NbContigousEdges()

Standard_Integer BRepOffsetAPI_FindContigousEdges::NbContigousEdges

(

)

const

Returns the number of contiguous edges found by the function Perform on the shapes added to this algorithm.

NbDegeneratedShapes()

Standard_Integer BRepOffsetAPI_FindContigousEdges::NbDegeneratedShapes

(

)

const

Gives the number of degenerated shapes.

NbEdges()

Standard_Integer BRepOffsetAPI_FindContigousEdges::NbEdges

(

)

const

Gives the number of edges (free edges + contiguous edges + multiple edge)

Perform()

void BRepOffsetAPI_FindContigousEdges::Perform

(

)

Finds coincident parts of edges of two or more shapes added to this algorithm and breaks down these edges into contiguous and non-contiguous sections on copies of the initial shapes. The function ContigousEdge returns contiguous edges. The function Modified can be used to return modified copies of the initial shapes where one or more edges were broken down into contiguous and non-contiguous sections. Warning This function must be used once all the shapes to be checked have been added. It is not possible to add further shapes subsequently and then to repeat the call to Perform.

SectionToBoundary()

const TopoDS_Edge & BRepOffsetAPI_FindContigousEdges::SectionToBoundary

(

const TopoDS_Edge &

section

)

const

Returns the edge on the initial shape, of which the modified copy contains the edge section. section is coincident with a contiguous edge found by the function Perform. Use the function ContigousEdgeCouple to obtain a valid section. This information is useful for verification purposes, since it provides a means of determining the surface to which the contiguous edge belongs. Exceptions Standard_NoSuchObject if section is not coincident with a contiguous edge. Use the function ContigousEdgeCouple to obtain a valid section.

---

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

• BRepOffsetAPI_FindContigousEdges.hxx