BRepOffsetAPI_NormalProjection Class Reference

A framework to define projection onto a shape according to the normal from each point to be projected. The target shape is a face, and the source shape is an edge or a wire. More...

#include <BRepOffsetAPI_NormalProjection.hxx>

Inheritance diagram for BRepOffsetAPI_NormalProjection:

Public Member Functions
	BRepOffsetAPI_NormalProjection ()
	Constructs an empty framework to define projection on a shape according to the normal from each point to be projected to the shape.
	BRepOffsetAPI_NormalProjection (const TopoDS_Shape &S)
	Constructs a framework to define projection onto the basis shape S according to the normal from each point to be projected from the shape added to this framework by Add. Default parameters of the algorithm: Tol3D = 1.e-04, Tol2D =sqr(tol3d) , InternalContinuity = GeomAbs_C2, MaxDegree = 14, MaxSeg = 16.
void	Init (const TopoDS_Shape &S)
	Initializes the empty constructor framework with the shape S.
void	Add (const TopoDS_Shape &ToProj)
	Adds the shape ToProj to the framework for calculation of the projection by Compute3d. ToProj is an edge or a wire and will be projected onto the basis shape. Exceptions Standard_ConstructionError if ToProj is not added.
void	SetParams (const Standard_Real Tol3D, const Standard_Real Tol2D, const GeomAbs_Shape InternalContinuity, const Standard_Integer MaxDegree, const Standard_Integer MaxSeg)
	Sets the parameters used for computation Tol3 is the required tolerance between the 3d projected curve and its 2d representation InternalContinuity is the order of constraints used for approximation MaxDeg and MaxSeg are the maximum degree and the maximum number of segment for BSpline resulting of an approximation.
void	SetMaxDistance (const Standard_Real MaxDist)
	Sets the maximum distance between target shape and shape to project. If this condition is not satisfied then corresponding part of solution is discarded. if MaxDist < 0 then this method does not affect the algorithm.
void	SetLimit (const Standard_Boolean FaceBoundaries=Standard_True)
	Manage limitation of projected edges.
void	Compute3d (const Standard_Boolean With3d=Standard_True)
	Returns true if a 3D curve is computed. If not, false is returned and an initial 3D curve is kept to build the resulting edges.
virtual void	Build (const Message_ProgressRange &theRange=Message_ProgressRange()) override
	Builds the result of the projection as a compound of wires. Tries to build oriented wires.
Standard_Boolean	IsDone () const override
	Returns true if the object was correctly built by the shape construction algorithm. If at the construction time of the shape, the algorithm cannot be completed, or the original data is corrupted, IsDone returns false and therefore protects the use of functions to access the result of the construction (typically the Shape function).
const TopoDS_Shape &	Projection () const
	Performs the projection. The construction of the result is performed by Build. Exceptions StdFail_NotDone if the projection was not performed.
const TopoDS_Shape &	Couple (const TopoDS_Edge &E) const
	Returns the initial face corresponding to the projected edge E. Exceptions StdFail_NotDone if no face was found. Standard_NoSuchObject if a face corresponding to E has already been found.
virtual const TopTools_ListOfShape &	Generated (const TopoDS_Shape &S) override
	Returns the list of shapes generated from the shape .
const TopoDS_Shape &	Ancestor (const TopoDS_Edge &E) const
	Returns the initial edge corresponding to the edge E resulting from the computation of the projection. Exceptions StdFail_NotDone if no edge was found. Standard_NoSuchObject if an edge corresponding to E has already been found.
Standard_Boolean	BuildWire (TopTools_ListOfShape &Liste) const
	build the result as a list of wire if possible in – a first returns a wire only if there is only a wire.
Public Member Functions inherited from BRepBuilderAPI_MakeShape
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 TopTools_ListOfShape &	Modified (const TopoDS_Shape &S)
	Returns the list of shapes modified from the shape .
virtual Standard_Boolean	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
TopTools_ListOfShape	myGenerated

Detailed Description

A framework to define projection onto a shape according to the normal from each point to be projected. The target shape is a face, and the source shape is an edge or a wire.

Constructor & Destructor Documentation

BRepOffsetAPI_NormalProjection() [1/2]

BRepOffsetAPI_NormalProjection::BRepOffsetAPI_NormalProjection

(

)

Constructs an empty framework to define projection on a shape according to the normal from each point to be projected to the shape.

BRepOffsetAPI_NormalProjection() [2/2]

BRepOffsetAPI_NormalProjection::BRepOffsetAPI_NormalProjection

(

const TopoDS_Shape &

S

)

Constructs a framework to define projection onto the basis shape S according to the normal from each point to be projected from the shape added to this framework by Add. Default parameters of the algorithm: Tol3D = 1.e-04, Tol2D =sqr(tol3d) , InternalContinuity = GeomAbs_C2, MaxDegree = 14, MaxSeg = 16.

Member Function Documentation

Add()

void BRepOffsetAPI_NormalProjection::Add

(

const TopoDS_Shape &

ToProj

)

Adds the shape ToProj to the framework for calculation of the projection by Compute3d. ToProj is an edge or a wire and will be projected onto the basis shape. Exceptions Standard_ConstructionError if ToProj is not added.

Ancestor()

const TopoDS_Shape & BRepOffsetAPI_NormalProjection::Ancestor

(

const TopoDS_Edge &

E

)

const

Returns the initial edge corresponding to the edge E resulting from the computation of the projection. Exceptions StdFail_NotDone if no edge was found. Standard_NoSuchObject if an edge corresponding to E has already been found.

Build()

virtual void BRepOffsetAPI_NormalProjection::Build ( const Message_ProgressRange & theRange = Message_ProgressRange() )

overridevirtual

Builds the result of the projection as a compound of wires. Tries to build oriented wires.

Reimplemented from BRepBuilderAPI_MakeShape.

BuildWire()

Standard_Boolean BRepOffsetAPI_NormalProjection::BuildWire

(

TopTools_ListOfShape &

Liste

)

const

build the result as a list of wire if possible in – a first returns a wire only if there is only a wire.

Compute3d()

void BRepOffsetAPI_NormalProjection::Compute3d

(

const Standard_Boolean

With3d = Standard_True

)

Returns true if a 3D curve is computed. If not, false is returned and an initial 3D curve is kept to build the resulting edges.

Couple()

const TopoDS_Shape & BRepOffsetAPI_NormalProjection::Couple

(

const TopoDS_Edge &

E

)

const

Returns the initial face corresponding to the projected edge E. Exceptions StdFail_NotDone if no face was found. Standard_NoSuchObject if a face corresponding to E has already been found.

Generated()

virtual const TopTools_ListOfShape & BRepOffsetAPI_NormalProjection::Generated ( const TopoDS_Shape & S )

overridevirtual

Returns the list of shapes generated from the shape .

Reimplemented from BRepBuilderAPI_MakeShape.

Init()

void BRepOffsetAPI_NormalProjection::Init

(

const TopoDS_Shape &

S

)

Initializes the empty constructor framework with the shape S.

IsDone()

Standard_Boolean BRepOffsetAPI_NormalProjection::IsDone ( ) const

overridevirtual

Returns true if the object was correctly built by the shape construction algorithm. If at the construction time of the shape, the algorithm cannot be completed, or the original data is corrupted, IsDone returns false and therefore protects the use of functions to access the result of the construction (typically the Shape function).

Reimplemented from BRepBuilderAPI_Command.

Projection()

const TopoDS_Shape & BRepOffsetAPI_NormalProjection::Projection

(

)

const

Performs the projection. The construction of the result is performed by Build. Exceptions StdFail_NotDone if the projection was not performed.

SetLimit()

void BRepOffsetAPI_NormalProjection::SetLimit

(

const Standard_Boolean

FaceBoundaries = Standard_True

)

Manage limitation of projected edges.

SetMaxDistance()

void BRepOffsetAPI_NormalProjection::SetMaxDistance

(

const Standard_Real

MaxDist

)

Sets the maximum distance between target shape and shape to project. If this condition is not satisfied then corresponding part of solution is discarded. if MaxDist < 0 then this method does not affect the algorithm.

SetParams()

void BRepOffsetAPI_NormalProjection::SetParams	(	const Standard_Real	Tol3D,
		const Standard_Real	Tol2D,
		const GeomAbs_Shape	InternalContinuity,
		const Standard_Integer	MaxDegree,
		const Standard_Integer	MaxSeg )

Sets the parameters used for computation Tol3 is the required tolerance between the 3d projected curve and its 2d representation InternalContinuity is the order of constraints used for approximation MaxDeg and MaxSeg are the maximum degree and the maximum number of segment for BSpline resulting of an approximation.

---

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

• BRepOffsetAPI_NormalProjection.hxx