OCC Main Page | ModelingAlgorithms | Toolkits | Packages | Class Hierarchy | Data Structures | File List | Data Fields | Globals

ModelingAlgorithms
TKOffset
BRepOffsetAPI


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.
The target face is considered to be a 2D surface.
.

#include <BRepOffsetAPI_NormalProjection.hxx>

Inheritance diagram for BRepOffsetAPI_NormalProjection:

Inheritance graph
[legend]

Public Member Functions

void * operator new (size_t, void *anAddress)
void * operator new (size_t size)
void operator delete (void *anAddress)
Standard_EXPORT 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.
.
Standard_EXPORT 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.
.
Standard_EXPORT void Init (const TopoDS_Shape &S)
 Initializes the empty constructor framework with the shape S.
.
Standard_EXPORT 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.
.
Standard_EXPORT 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 requiered 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.
.
Standard_EXPORT 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
.
Standard_EXPORT void SetLimit (const Standard_Boolean FaceBoundaries=Standard_True)
 Manage limitation of projected edges.
.
Standard_EXPORT 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 Standard_EXPORT void Build ()
 Builds the result of the projection as a compound of
wires. Tries to build oriented wires.
.
Standard_EXPORT Standard_Boolean IsDone () const
 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).
.
Standard_EXPORT 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.
.
Standard_EXPORT 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 if a face corresponding to
E has already been found.
.
virtual Standard_EXPORT const
TopTools_ListOfShape & 
Generated (const TopoDS_Shape &S)
 Returns the list of shapes generated from the
shape <s>.
.
Standard_EXPORT 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_EXPORT 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.


Private Attributes

BRepAlgo_NormalProjection myNormalProjector

Constructor & Destructor Documentation

Standard_EXPORT BRepOffsetAPI_NormalProjection::BRepOffsetAPI_NormalProjection  ) 
 

Standard_EXPORT BRepOffsetAPI_NormalProjection::BRepOffsetAPI_NormalProjection const TopoDS_Shape &  S  ) 
 


Member Function Documentation

Standard_EXPORT void BRepOffsetAPI_NormalProjection::Add const TopoDS_Shape &  ToProj  ) 
 

Standard_EXPORT const TopoDS_Shape& BRepOffsetAPI_NormalProjection::Ancestor const TopoDS_Edge &  E  )  const
 

virtual Standard_EXPORT void BRepOffsetAPI_NormalProjection::Build  )  [virtual]
 

Reimplemented from BRepBuilderAPI_MakeShape.

Standard_EXPORT Standard_Boolean BRepOffsetAPI_NormalProjection::BuildWire TopTools_ListOfShape &  Liste  )  const
 

Standard_EXPORT void BRepOffsetAPI_NormalProjection::Compute3d const Standard_Boolean  With3d = Standard_True  ) 
 

Standard_EXPORT const TopoDS_Shape& BRepOffsetAPI_NormalProjection::Couple const TopoDS_Edge &  E  )  const
 

virtual Standard_EXPORT const TopTools_ListOfShape& BRepOffsetAPI_NormalProjection::Generated const TopoDS_Shape &  S  )  [virtual]
 

Reimplemented from BRepBuilderAPI_MakeShape.

Standard_EXPORT void BRepOffsetAPI_NormalProjection::Init const TopoDS_Shape &  S  ) 
 

Standard_EXPORT Standard_Boolean BRepOffsetAPI_NormalProjection::IsDone  )  const [virtual]
 

Reimplemented from BRepBuilderAPI_Command.

void BRepOffsetAPI_NormalProjection::operator delete void *  anAddress  )  [inline]
 

Reimplemented from BRepBuilderAPI_MakeShape.

void* BRepOffsetAPI_NormalProjection::operator new size_t  size  )  [inline]
 

Reimplemented from BRepBuilderAPI_MakeShape.

void* BRepOffsetAPI_NormalProjection::operator new size_t  ,
void *  anAddress
[inline]
 

Reimplemented from BRepBuilderAPI_MakeShape.

Standard_EXPORT const TopoDS_Shape& BRepOffsetAPI_NormalProjection::Projection  )  const
 

Standard_EXPORT void BRepOffsetAPI_NormalProjection::SetLimit const Standard_Boolean  FaceBoundaries = Standard_True  ) 
 

Standard_EXPORT void BRepOffsetAPI_NormalProjection::SetMaxDistance const Standard_Real  MaxDist  ) 
 

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


Field Documentation

BRepAlgo_NormalProjection BRepOffsetAPI_NormalProjection::myNormalProjector [private]
 


The documentation for this class was generated from the following file:
Generated on Mon Aug 25 13:41:28 2008 for OpenCASCADE by  doxygen 1.4.1