BRepBuilderAPI_MakeFace Class Reference

Provides methods to build faces. More...

#include <BRepBuilderAPI_MakeFace.hxx>

Inheritance diagram for BRepBuilderAPI_MakeFace:

Public Member Functions
	BRepBuilderAPI_MakeFace ()
	Not done.
	BRepBuilderAPI_MakeFace (const TopoDS_Face &F)
	Load a face. useful to add wires.
	BRepBuilderAPI_MakeFace (const gp_Pln &P)
	Make a face from a plane.
	BRepBuilderAPI_MakeFace (const gp_Cylinder &C)
	Make a face from a cylinder.
	BRepBuilderAPI_MakeFace (const gp_Cone &C)
	Make a face from a cone.
	BRepBuilderAPI_MakeFace (const gp_Sphere &S)
	Make a face from a sphere.
	BRepBuilderAPI_MakeFace (const gp_Torus &C)
	Make a face from a torus.
	BRepBuilderAPI_MakeFace (const occ::handle< Geom_Surface > &S, const double TolDegen)
	Make a face from a Surface. Accepts tolerance value (TolDegen) for resolution of degenerated edges.
	BRepBuilderAPI_MakeFace (const gp_Pln &P, const double UMin, const double UMax, const double VMin, const double VMax)
	Make a face from a plane.
	BRepBuilderAPI_MakeFace (const gp_Cylinder &C, const double UMin, const double UMax, const double VMin, const double VMax)
	Make a face from a cylinder.
	BRepBuilderAPI_MakeFace (const gp_Cone &C, const double UMin, const double UMax, const double VMin, const double VMax)
	Make a face from a cone.
	BRepBuilderAPI_MakeFace (const gp_Sphere &S, const double UMin, const double UMax, const double VMin, const double VMax)
	Make a face from a sphere.
	BRepBuilderAPI_MakeFace (const gp_Torus &C, const double UMin, const double UMax, const double VMin, const double VMax)
	Make a face from a torus.
	BRepBuilderAPI_MakeFace (const occ::handle< Geom_Surface > &S, const double UMin, const double UMax, const double VMin, const double VMax, const double TolDegen)
	Make a face from a Surface. Accepts tolerance value (TolDegen) for resolution of degenerated edges.
	BRepBuilderAPI_MakeFace (const TopoDS_Wire &W, const bool OnlyPlane=false)
	Find a surface from the wire and make a face. if <OnlyPlane> is true, the computed surface will be a plane. If it is not possible to find a plane, the flag NotDone will be set.
	BRepBuilderAPI_MakeFace (const gp_Pln &P, const TopoDS_Wire &W, const bool Inside=true)
	Make a face from a plane and a wire.
	BRepBuilderAPI_MakeFace (const gp_Cylinder &C, const TopoDS_Wire &W, const bool Inside=true)
	Make a face from a cylinder and a wire.
	BRepBuilderAPI_MakeFace (const gp_Cone &C, const TopoDS_Wire &W, const bool Inside=true)
	Make a face from a cone and a wire.
	BRepBuilderAPI_MakeFace (const gp_Sphere &S, const TopoDS_Wire &W, const bool Inside=true)
	Make a face from a sphere and a wire.
	BRepBuilderAPI_MakeFace (const gp_Torus &C, const TopoDS_Wire &W, const bool Inside=true)
	Make a face from a torus and a wire.
	BRepBuilderAPI_MakeFace (const occ::handle< Geom_Surface > &S, const TopoDS_Wire &W, const bool Inside=true)
	Make a face from a Surface and a wire. If the surface S is not plane, it must contain pcurves for all edges in W, otherwise the wrong shape will be created.
	BRepBuilderAPI_MakeFace (const TopoDS_Face &F, const TopoDS_Wire &W)
	Adds the wire <W> in the face <F> A general method to create a face is to give.
void	Init (const TopoDS_Face &F)
	Initializes (or reinitializes) the construction of a face by creating a new object which is a copy of the face F, in order to add wires to it, using the function Add. Note: this complete copy of the geometry is only required if you want to work on the geometries of the two faces independently.
void	Init (const occ::handle< Geom_Surface > &S, const bool Bound, const double TolDegen)
	Initializes (or reinitializes) the construction of a face on the surface S. If Bound is true, a wire is automatically created from the natural bounds of the surface S and added to the face in order to bound it. If Bound is false, no wire is added. This option is used when real bounds are known. These will be added to the face after this initialization, using the function Add. TolDegen parameter is used for resolution of degenerated edges if calculation of natural bounds is turned on.
void	Init (const occ::handle< Geom_Surface > &S, const double UMin, const double UMax, const double VMin, const double VMax, const double TolDegen)
	Initializes (or reinitializes) the construction of a face on the surface S, limited in the u parametric direction by the two parameter values UMin and UMax and in the v parametric direction by the two parameter values VMin and VMax. Warning Error returns:
void	Add (const TopoDS_Wire &W)
	Adds the wire W to the constructed face as a hole. Warning W must not cross the other bounds of the face, and all the bounds must define only one area on the surface. (Be careful, however, as this is not checked.) Example // a cylinder gp_Cylinder C = ..; // a wire TopoDS_Wire W = ...; BRepBuilderAPI_MakeFace MF(C); MF.Add(W); TopoDS_Face F = MF;.
bool	IsDone () const override
	Returns true if this algorithm has a valid face.
BRepBuilderAPI_FaceError	Error () const
	Returns the construction status BRepBuilderAPI_FaceDone if the face is built, or.
const TopoDS_Face &	Face () const
	Returns the constructed face. Exceptions StdFail_NotDone if no face is built.
	operator TopoDS_Face () const
Public Member Functions inherited from BRepBuilderAPI_MakeShape
virtual void	Build (const Message_ProgressRange &theRange=Message_ProgressRange())
	This is called by Shape(). It does nothing but may be redefined.
virtual const TopoDS_Shape &	Shape ()
	Returns a shape built by the shape construction algorithm. Raises exception StdFail_NotDone if the shape was not built.
	operator TopoDS_Shape ()
virtual const NCollection_List< TopoDS_Shape > &	Generated (const TopoDS_Shape &S)
	Returns the list of shapes generated from the shape .
virtual const NCollection_List< TopoDS_Shape > &	Modified (const TopoDS_Shape &S)
	Returns the list of shapes modified from the shape .
virtual bool	IsDeleted (const TopoDS_Shape &S)
	Returns true if the shape S has been deleted.
Public Member Functions inherited from BRepBuilderAPI_Command
virtual	~BRepBuilderAPI_Command ()
void	Check () const
	Raises NotDone if done is false.

Additional Inherited Members
Protected Member Functions inherited from BRepBuilderAPI_MakeShape
	BRepBuilderAPI_MakeShape ()
Protected Member Functions inherited from BRepBuilderAPI_Command
	BRepBuilderAPI_Command ()
	Set done to False.
void	Done ()
	Set done to true.
void	NotDone ()
	Set done to false.
Protected Attributes inherited from BRepBuilderAPI_MakeShape
TopoDS_Shape	myShape
NCollection_List< TopoDS_Shape >	myGenerated

Detailed Description

Provides methods to build faces.

A face may be built:

• From a surface.
• Elementary surface from gp.
• Surface from Geom.
• From a surface and U,V values.
• From a wire.
• Find the surface automatically if possible.
• From a surface and a wire.
• A flag Inside is given, when this flag is True the wire is oriented to bound a finite area on the surface.
• From a face and a wire.
• The new wire is a perforation.

Constructor & Destructor Documentation

BRepBuilderAPI_MakeFace() [1/22]

BRepBuilderAPI_MakeFace::BRepBuilderAPI_MakeFace

(

)

Not done.

BRepBuilderAPI_MakeFace() [2/22]

BRepBuilderAPI_MakeFace::BRepBuilderAPI_MakeFace

(

const TopoDS_Face &

F

)

Load a face. useful to add wires.

BRepBuilderAPI_MakeFace() [3/22]

BRepBuilderAPI_MakeFace::BRepBuilderAPI_MakeFace

(

const gp_Pln &

P

)

Make a face from a plane.

BRepBuilderAPI_MakeFace() [4/22]

BRepBuilderAPI_MakeFace::BRepBuilderAPI_MakeFace

(

const gp_Cylinder &

C

)

Make a face from a cylinder.

BRepBuilderAPI_MakeFace() [5/22]

BRepBuilderAPI_MakeFace::BRepBuilderAPI_MakeFace

(

const gp_Cone &

C

)

Make a face from a cone.

BRepBuilderAPI_MakeFace() [6/22]

BRepBuilderAPI_MakeFace::BRepBuilderAPI_MakeFace

(

const gp_Sphere &

S

)

Make a face from a sphere.

BRepBuilderAPI_MakeFace() [7/22]

BRepBuilderAPI_MakeFace::BRepBuilderAPI_MakeFace

(

const gp_Torus &

C

)

Make a face from a torus.

BRepBuilderAPI_MakeFace() [8/22]

BRepBuilderAPI_MakeFace::BRepBuilderAPI_MakeFace	(	const occ::handle< Geom_Surface > &	S,
		const double	TolDegen )

Make a face from a Surface. Accepts tolerance value (TolDegen) for resolution of degenerated edges.

BRepBuilderAPI_MakeFace() [9/22]

BRepBuilderAPI_MakeFace::BRepBuilderAPI_MakeFace	(	const gp_Pln &	P,
		const double	UMin,
		const double	UMax,
		const double	VMin,
		const double	VMax )

Make a face from a plane.

BRepBuilderAPI_MakeFace() [10/22]

BRepBuilderAPI_MakeFace::BRepBuilderAPI_MakeFace	(	const gp_Cylinder &	C,
		const double	UMin,
		const double	UMax,
		const double	VMin,
		const double	VMax )

Make a face from a cylinder.

BRepBuilderAPI_MakeFace() [11/22]

BRepBuilderAPI_MakeFace::BRepBuilderAPI_MakeFace	(	const gp_Cone &	C,
		const double	UMin,
		const double	UMax,
		const double	VMin,
		const double	VMax )

Make a face from a cone.

BRepBuilderAPI_MakeFace() [12/22]

BRepBuilderAPI_MakeFace::BRepBuilderAPI_MakeFace	(	const gp_Sphere &	S,
		const double	UMin,
		const double	UMax,
		const double	VMin,
		const double	VMax )

Make a face from a sphere.

BRepBuilderAPI_MakeFace() [13/22]

BRepBuilderAPI_MakeFace::BRepBuilderAPI_MakeFace	(	const gp_Torus &	C,
		const double	UMin,
		const double	UMax,
		const double	VMin,
		const double	VMax )

Make a face from a torus.

BRepBuilderAPI_MakeFace() [14/22]

BRepBuilderAPI_MakeFace::BRepBuilderAPI_MakeFace	(	const occ::handle< Geom_Surface > &	S,
		const double	UMin,
		const double	UMax,
		const double	VMin,
		const double	VMax,
		const double	TolDegen )

Make a face from a Surface. Accepts tolerance value (TolDegen) for resolution of degenerated edges.

BRepBuilderAPI_MakeFace() [15/22]

BRepBuilderAPI_MakeFace::BRepBuilderAPI_MakeFace	(	const TopoDS_Wire &	W,
		const bool	OnlyPlane = false )

Find a surface from the wire and make a face. if <OnlyPlane> is true, the computed surface will be a plane. If it is not possible to find a plane, the flag NotDone will be set.

BRepBuilderAPI_MakeFace() [16/22]

BRepBuilderAPI_MakeFace::BRepBuilderAPI_MakeFace	(	const gp_Pln &	P,
		const TopoDS_Wire &	W,
		const bool	Inside = true )

Make a face from a plane and a wire.

BRepBuilderAPI_MakeFace() [17/22]

BRepBuilderAPI_MakeFace::BRepBuilderAPI_MakeFace	(	const gp_Cylinder &	C,
		const TopoDS_Wire &	W,
		const bool	Inside = true )

Make a face from a cylinder and a wire.

BRepBuilderAPI_MakeFace() [18/22]

BRepBuilderAPI_MakeFace::BRepBuilderAPI_MakeFace	(	const gp_Cone &	C,
		const TopoDS_Wire &	W,
		const bool	Inside = true )

Make a face from a cone and a wire.

BRepBuilderAPI_MakeFace() [19/22]

BRepBuilderAPI_MakeFace::BRepBuilderAPI_MakeFace	(	const gp_Sphere &	S,
		const TopoDS_Wire &	W,
		const bool	Inside = true )

Make a face from a sphere and a wire.

BRepBuilderAPI_MakeFace() [20/22]

BRepBuilderAPI_MakeFace::BRepBuilderAPI_MakeFace	(	const gp_Torus &	C,
		const TopoDS_Wire &	W,
		const bool	Inside = true )

Make a face from a torus and a wire.

BRepBuilderAPI_MakeFace() [21/22]

BRepBuilderAPI_MakeFace::BRepBuilderAPI_MakeFace	(	const occ::handle< Geom_Surface > &	S,
		const TopoDS_Wire &	W,
		const bool	Inside = true )

Make a face from a Surface and a wire. If the surface S is not plane, it must contain pcurves for all edges in W, otherwise the wrong shape will be created.

BRepBuilderAPI_MakeFace() [22/22]

BRepBuilderAPI_MakeFace::BRepBuilderAPI_MakeFace	(	const TopoDS_Face &	F,
		const TopoDS_Wire &	W )

Adds the wire <W> in the face <F> A general method to create a face is to give.

• a surface S as the support (the geometric domain) of the face,
• and a wire W to bound it. The bounds of the face can also be defined by four parameter values umin, umax, vmin, vmax which determine isoparametric limitations on the parametric space of the surface. In this way, a patch is defined. The parameter values are optional. If they are omitted, the natural bounds of the surface are used. A wire is automatically built using the defined bounds. Up to four edges and four vertices are created with this wire (no edge is created when the corresponding parameter value is infinite). Wires can then be added using the function Add to define other restrictions on the face. These restrictions represent holes. More than one wire may be added by this way, provided that the wires do not cross each other and that they define only one area on the surface. (Be careful, however, as this is not checked). Forbidden addition of wires Note that in this schema, the third case is valid if edges of the wire W are declared internal to the face. As a result, these edges are no longer bounds of the face. A default tolerance (Precision::Confusion()) is given to the face, this tolerance may be increased during construction of the face using various algorithms. Rules applied to the arguments For the surface:
• The surface must not be a 'null handle'.
• If the surface is a trimmed surface, the basis surface is used.
• For the wire: the wire is composed of connected edges, each edge having a parametric curve description in the parametric domain of the surface; in other words, as a pcurve. For the parameters:
• The parameter values must be in the parametric range of the surface (or the basis surface, if the surface is trimmed). If this condition is not satisfied, the face is not built, and the Error function will return BRepBuilderAPI_ParametersOutOfRange.
• The bounding parameters p1 and p2 are adjusted on a periodic surface in a given parametric direction by adding or subtracting the period to obtain p1 in the parametric range of the surface and such p2, that p2 - p1 <= Period, where Period is the period of the surface in this parametric direction.
• A parameter value may be infinite. There will be no edge and no vertex in the corresponding direction.

Member Function Documentation

Add()

void BRepBuilderAPI_MakeFace::Add

(

const TopoDS_Wire &

W

)

Adds the wire W to the constructed face as a hole. Warning W must not cross the other bounds of the face, and all the bounds must define only one area on the surface. (Be careful, however, as this is not checked.) Example // a cylinder gp_Cylinder C = ..; // a wire TopoDS_Wire W = ...; BRepBuilderAPI_MakeFace MF(C); MF.Add(W); TopoDS_Face F = MF;.

Error()

BRepBuilderAPI_FaceError BRepBuilderAPI_MakeFace::Error

(

)

const

Returns the construction status BRepBuilderAPI_FaceDone if the face is built, or.

• another value of the BRepBuilderAPI_FaceError enumeration indicating why the construction failed, in particular when the given parameters are outside the bounds of the surface.

Face()

const TopoDS_Face & BRepBuilderAPI_MakeFace::Face

(

)

const

Returns the constructed face. Exceptions StdFail_NotDone if no face is built.

Init() [1/3]

void BRepBuilderAPI_MakeFace::Init	(	const occ::handle< Geom_Surface > &	S,
		const bool	Bound,
		const double	TolDegen )

Initializes (or reinitializes) the construction of a face on the surface S. If Bound is true, a wire is automatically created from the natural bounds of the surface S and added to the face in order to bound it. If Bound is false, no wire is added. This option is used when real bounds are known. These will be added to the face after this initialization, using the function Add. TolDegen parameter is used for resolution of degenerated edges if calculation of natural bounds is turned on.

Init() [2/3]

void BRepBuilderAPI_MakeFace::Init	(	const occ::handle< Geom_Surface > &	S,
		const double	UMin,
		const double	UMax,
		const double	VMin,
		const double	VMax,
		const double	TolDegen )

Initializes (or reinitializes) the construction of a face on the surface S, limited in the u parametric direction by the two parameter values UMin and UMax and in the v parametric direction by the two parameter values VMin and VMax. Warning Error returns:

• BRepBuilderAPI_ParametersOutOfRange when the parameters given are outside the bounds of the surface or the basis surface of a trimmed surface. TolDegen parameter is used for resolution of degenerated edges.

Init() [3/3]

void BRepBuilderAPI_MakeFace::Init

(

const TopoDS_Face &

F

)

Initializes (or reinitializes) the construction of a face by creating a new object which is a copy of the face F, in order to add wires to it, using the function Add. Note: this complete copy of the geometry is only required if you want to work on the geometries of the two faces independently.

IsDone()

bool BRepBuilderAPI_MakeFace::IsDone ( ) const

overridevirtual

Returns true if this algorithm has a valid face.

Reimplemented from BRepBuilderAPI_Command.

operator TopoDS_Face()

BRepBuilderAPI_MakeFace::operator TopoDS_Face

(

)

const

---

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

• BRepBuilderAPI_MakeFace.hxx