#include <math_Function.hxx>
#include <StdFail_NotDone.hxx>
-// reference algorithme:
+// reference algorithm:
// Brent method
-// numerical recipes in C p 269
+// numerical recipes in C (p. 269)
math_BracketedRoot::math_BracketedRoot(math_Function& F,
const Standard_Real Bound1,
const Standard_Real Bound2,
//! Constructs a date from the year yyyy, the
//! month mm, the day dd, the hour hh, the minute
//! mn, the second ss, the millisecond mis
- //! (defaulted to 0) and the microsecond mics (defaulted to 0)..
- //! With: 1 <= mm <= 12
+ //! (defaulted to 0) and the microsecond mics (defaulted to 0).
+ //! With:
+ //! 1 <= mm <= 12
//! 1 <= dd <= max number of days of <mm>
//! 1979 <= yyyy
//! 0 <= hh <= 23
//! Returns minute of a Date.
Standard_EXPORT Standard_Integer Minute();
- //! Returns seconde of a Date.
+ //! Returns second of a Date.
Standard_EXPORT Standard_Integer Second();
//! Returns millisecond of a Date.
class Geom2d_Curve;
class Geom_Surface;
-//! Provides a Tool to build topologies. Used to
+//! Provides a Tool to build topologies. Used to
//! instantiate the Builder algorithm.
class TopOpeBRepDS_BuildTool
{
Standard_EXPORT void AddSolidShell(TopoDS_Shape& S, const TopoDS_Shape& Sh) const;
- //! Sets the parameter <P> for the vertex <V> on the
+ //! Sets the parameter <P> for the vertex <V> on the
//! edge <E>.
Standard_EXPORT void Parameter(const TopoDS_Shape& E,
const TopoDS_Shape& V,
//! only when <Ein> has a closed geometry.
Standard_EXPORT void UpdateEdge(const TopoDS_Shape& Ein, TopoDS_Shape& Eou) const;
- //! Compute the parameter of the vertex <V>, supported
- //! by the edge <E>, on the curve <C>.
+ //! Compute the parameter of the vertex <V>, supported
+ //! by the edge <E>, on the curve <C>.
Standard_EXPORT void Parameter(const TopOpeBRepDS_Curve& C,
TopoDS_Shape& E,
TopoDS_Shape& V) const;
- //! Sets the curve <C> for the edge <E>
+ //! Sets the curve <C> for the edge <E>
Standard_EXPORT void Curve3D(TopoDS_Shape& E,
const Handle(Geom_Curve)& C,
const Standard_Real Tol) const;
- //! Sets the pcurve <C> for the edge <E> on the face
- //! <F>. If OverWrite is True the old pcurve if there
- //! is one is overwritten, else the two pcurves are
+ //! Sets the pcurve <C> for the edge <E> on the face
+ //! <F>. If OverWrite is True the old pcurve if there
+ //! is one is overwritten, else the two pcurves are
//! set.
Standard_EXPORT void PCurve(TopoDS_Shape& F,
TopoDS_Shape& E,
//! si la liste est vide, renvoie vrai
Standard_EXPORT Standard_Boolean CheckShapes(const TopTools_ListOfShape& LS) const;
- //! Verifie que les Vertex non SameDomain sont bien
- //! nonSameDomain, que les vertex sameDomain sont bien
- //! SameDomain, que les Points sont non confondus
+ //! Verifie que les Vertex non SameDomain sont bien
+ //! nonSameDomain, que les vertex sameDomain sont bien
+ //! SameDomain, que les Points sont non confondus
//! ni entre eux, ni avec des Vertex.
Standard_EXPORT Standard_Boolean OneVertexOnPnt();
Standard_EXPORT Standard_OStream& PrintIntg(Standard_OStream& S);
- //! Prints the name of CheckStatus <stat> as a String
+ //! Prints the name of CheckStatus <stat> as a String
Standard_EXPORT Standard_OStream& Print(const TopOpeBRepDS_CheckStatus stat, Standard_OStream& S);
- //! Prints the name of CheckStatus <stat> as a String
+ //! Prints the name of CheckStatus <stat> as a String
Standard_EXPORT Standard_OStream& PrintShape(const TopAbs_ShapeEnum SE, Standard_OStream& S);
- //! Prints the name of CheckStatus <stat> as a String
+ //! Prints the name of CheckStatus <stat> as a String
Standard_EXPORT Standard_OStream& PrintShape(const Standard_Integer index, Standard_OStream& S);
DEFINE_STANDARD_RTTIEXT(TopOpeBRepDS_Check, Standard_Transient)
public:
DEFINE_STANDARD_ALLOC
- //! Creates an iterator on the curves on surface
+ //! Creates an iterator on the curves on surface
//! described by the interferences in <L>.
Standard_EXPORT TopOpeBRepDS_CurveIterator(const TopOpeBRepDS_ListOfInterference& L);
- //! Returns True if the Interference <I> has a
+ //! Returns True if the Interference <I> has a
//! GeometryType() TopOpeBRepDS_CURVE
//! returns False else.
Standard_EXPORT virtual Standard_Boolean MatchInterference(
//! if support type <ST> == EDGE : <S> is edge E
//! FACE : <S> is the face with bound E.
//! <T> is the transition along the edge, crossing the crossed edge.
- //! E is the crossed edge.
+ //! E is the crossed edge.
//! <GIsBound> indicates if <G> is a bound of the edge.
//! <P> is the parameter of <G> on the edge.
//!
Standard_EXPORT void Perform();
- //! Recherche parmi l'ensemble des points d'Interference
+ //! Recherche parmi l'ensemble des points d'Interference
//! la Liste <LI> des points qui correspondent au point d'indice <Index>
Standard_EXPORT void FindAssociatedPoints(const Handle(TopOpeBRepDS_Interference)& I,
TopOpeBRepDS_ListOfInterference& LI);
- //! Enchaine les sections via les points d'Interferences deja
- //! associe; Renvoit dans <L> les points extremites des Lignes.
- //! Methodes pour construire la liste des Points qui
+ //! Enchaine les sections via les points d'Interferences deja
+ //! associe; Renvoit dans <L> les points extremites des Lignes.
+ //! Methodes pour construire la liste des Points qui
//! peuvent correspondre a une Point donne.
Standard_EXPORT Standard_Boolean CheckConnexity(TopOpeBRepDS_ListOfInterference& LI);
Standard_EXPORT void AddPointsOnShape(const TopoDS_Shape& S, TopOpeBRepDS_ListOfInterference& LI);
- //! Methodes pour reduire la liste des Points qui
+ //! Methodes pour reduire la liste des Points qui
//! peuvent correspondre a une Point donne.
Standard_EXPORT void AddPointsOnConnexShape(const TopoDS_Shape& F,
const TopOpeBRepDS_ListOfInterference& LI);
Standard_EXPORT Standard_Boolean IsOnFace(const Handle(TopOpeBRepDS_Interference)& I,
const TopoDS_Face& F) const;
- //! Return TRUE si I ou une de ses representaions a
+ //! Return TRUE si I ou une de ses representaions a
//! pour support <E>.
- //! Methodes de reconstructions des geometries des point
+ //! Methodes de reconstructions des geometries des point
//! et des courbes de section
Standard_EXPORT Standard_Boolean IsOnEdge(const Handle(TopOpeBRepDS_Interference)& I,
const TopoDS_Edge& E) const;
Standard_EXPORT Standard_Boolean EdgeSupport(const Handle(TopOpeBRepDS_Interference)& I,
TopoDS_Shape& E) const;
- //! Return les faces qui ont genere la section origine
+ //! Return les faces qui ont genere la section origine
//! de I
Standard_EXPORT Standard_Boolean FacesSupport(const Handle(TopOpeBRepDS_Interference)& I,
TopoDS_Shape& F1,
Standard_EXPORT void AddAncestors(const TopoDS_Shape& S);
- //! Update the data structure with shapes of type T1
+ //! Update the data structure with shapes of type T1
//! containing a subshape of type T2 which is stored
//! in the DS.
//! Used by the previous one.
//! Returns the surface of index <I>.
Standard_EXPORT const TopOpeBRepDS_Surface& Surface(const Standard_Integer I) const;
- //! Returns an iterator on the curves on the surface
+ //! Returns an iterator on the curves on the surface
//! <I>.
Standard_EXPORT TopOpeBRepDS_CurveIterator SurfaceCurves(const Standard_Integer I) const;
//! Returns the Curve of index <I>.
Standard_EXPORT TopOpeBRepDS_Curve& ChangeCurve(const Standard_Integer I);
- //! Returns an iterator on the points on the curve
+ //! Returns an iterator on the points on the curve
//! <I>.
Standard_EXPORT TopOpeBRepDS_PointIterator CurvePoints(const Standard_Integer I) const;
//! reference shape
Standard_EXPORT Standard_Integer SameDomainReference(const TopoDS_Shape& S) const;
- //! Returns an iterator on the surfaces attached to the
+ //! Returns an iterator on the surfaces attached to the
//! solid <S>.
Standard_EXPORT TopOpeBRepDS_SurfaceIterator SolidSurfaces(const TopoDS_Shape& S) const;
- //! Returns an iterator on the surfaces attached to the
+ //! Returns an iterator on the surfaces attached to the
//! solid <I>.
Standard_EXPORT TopOpeBRepDS_SurfaceIterator SolidSurfaces(const Standard_Integer I) const;
- //! Returns an iterator on the curves attached to the
+ //! Returns an iterator on the curves attached to the
//! face <F>.
Standard_EXPORT TopOpeBRepDS_CurveIterator FaceCurves(const TopoDS_Shape& F) const;
- //! Returns an iterator on the curves attached to the
+ //! Returns an iterator on the curves attached to the
//! face <I>.
Standard_EXPORT TopOpeBRepDS_CurveIterator FaceCurves(const Standard_Integer I) const;
- //! Returns an iterator on the points attached to the
+ //! Returns an iterator on the points attached to the
//! edge <E>.
Standard_EXPORT TopOpeBRepDS_PointIterator EdgePoints(const TopoDS_Shape& E) const;
class TopOpeBRepDS_Interference;
DEFINE_STANDARD_HANDLE(TopOpeBRepDS_Interference, Standard_Transient)
-//! An interference is the description of the
-//! attachment of a new geometry on a geometry. For
-//! example an intersection point on an Edge or on a
+//! An interference is the description of the
+//! attachment of a new geometry on a geometry. For
+//! example an intersection point on an Edge or on a
//! Curve.
//!
-//! The Interference contains the following data :
+//! The Interference contains the following data:
//!
-//! - Transition : How the interference separates the
+//! - Transition: How the interference separates the
//! existing geometry in INSIDE and OUTSIDE.
//!
-//! - SupportType : Type of the object supporting the
+//! - SupportType: Type of the object supporting the
//! interference. (FACE, EDGE, VERTEX, SURFACE, CURVE).
//!
-//! - Support : Index in the data structure of the
+//! - Support: Index in the data structure of the
//! object supporting the interference.
//!
-//! - GeometryType : Type of the geometry of the
+//! - GeometryType: Type ofthe geometry of the
//! interference (SURFACE, CURVE, POINT).
//!
-//! - Geometry : Index in the data structure of the
+//! - Geometry: Index in the data structure of the
//! geometry.
class TopOpeBRepDS_Interference : public Standard_Transient
{
#include <TopOpeBRepDS_ListOfInterference.hxx>
class TopOpeBRepDS_Interference;
-//! Iterate on interferences of a list, matching
-//! conditions on interferences.
-//! Nota :
-//! inheritance of ListIteratorOfListOfInterference from
-//! TopOpeBRepDS has not been done because of the
-//! impossibility of naming the classical More, Next
-//! methods which are declared as static in
+//! Iterate on interferences of a list, matching
+//! conditions on interferences.
+//! Nota:
+//! inheritance of ListIteratorOfListOfInterference from
+//! TopOpeBRepDS has not been done because of the
+//! impossibility of naming the classical More, Next
+//! methods which are declared as static in
//! TCollection_ListIteratorOfList ... . ListIteratorOfList
//! has benn placed as a field of InterferenceIterator.
class TopOpeBRepDS_InterferenceIterator
//! Creates an iterator on the Interference of list <L>.
Standard_EXPORT TopOpeBRepDS_InterferenceIterator(const TopOpeBRepDS_ListOfInterference& L);
- //! re-initialize interference iteration process on
+ //! re-initialize interference iteration process on
//! the list of interference <L>.
//! Conditions are not modified.
Standard_EXPORT void Init(const TopOpeBRepDS_ListOfInterference& L);
//! Interference must match the Support <S>
Standard_EXPORT void Support(const Standard_Integer S);
- //! reach for an interference matching the conditions
- //! (if defined).
+ //! reach for an interference matching the conditions
+ //! (if defined).
Standard_EXPORT void Match();
- //! Returns True if the Interference <I> matches the
+ //! Returns True if the Interference <I> matches the
//! conditions (if defined).
//! If no conditions defined, returns True.
Standard_EXPORT virtual Standard_Boolean MatchInterference(
//! Move to the next Interference.
Standard_EXPORT void Next();
- //! Returns the current Interference, matching the
- //! conditions (if defined).
+ //! Returns the current Interference, matching the
+ //! conditions (if defined).
Standard_EXPORT const Handle(TopOpeBRepDS_Interference)& Value() const;
Standard_EXPORT TopOpeBRepDS_ListIteratorOfListOfInterference& ChangeIterator();
public:
DEFINE_STANDARD_ALLOC
- //! Creates an iterator on the points on curves
+ //! Creates an iterator on the points on curves
//! described by the interferences in <L>.
Standard_EXPORT TopOpeBRepDS_PointIterator(const TopOpeBRepDS_ListOfInterference& L);
- //! Returns True if the Interference <I> has a
+ //! Returns True if the Interference <I> has a
//! GeometryType() TopOpeBRepDS_POINT or TopOpeBRepDS_VERTEX
//! returns False else.
Standard_EXPORT virtual Standard_Boolean MatchInterference(
public:
DEFINE_STANDARD_ALLOC
- //! Creates an iterator on the Surfaces on solid
+ //! Creates an iterator on the Surfaces on solid
//! described by the interferences in <L>.
Standard_EXPORT TopOpeBRepDS_SurfaceIterator(const TopOpeBRepDS_ListOfInterference& L);
public:
DEFINE_STANDARD_ALLOC
- //! Fuse edges (in a wire) of a shape where we have
+ //! Fuse edges (in a wire) of a shape where we have
//! useless vertex.
- //! In case face <FF> is built on UV-non-connexed wires
- //! (with the two closing edges FORWARD and REVERSED, in
+ //! In case face <FF> is built on UV-non-connexed wires
+ //! (with the two closing edges FORWARD and REVERSED, in
//! spite of one only), we find out the faulty edge, add
//! the faulty shapes (edge,wire,face) to <MshNOK>.
//! <FF> is a face descendant of <F>.
//! <MWisOld>(wire) = 1 if wire is wire of <F>
- //! 0 wire results from <F>'s wire split.
+ //! 0 wire results from <F>'s wire split.
//! returns false if purge fails
Standard_EXPORT static Standard_Boolean PurgeClosingEdges(
const TopoDS_Face& F,
const TopTools_IndexedMapOfOrientedShape& MshNOK,
TopTools_ListOfShape& LOFF);
- //! Returns <False> if the face is valid (the UV
- //! representation of the face is a set of pcurves
- //! connexed by points with connexity 2).
- //! Else,
splits <aFace> in order to return a list of valid
+ //! Returns <False> if the face is valid (the UV
+ //! representation of the face is a set of pcurves
+ //! connexed by points with connexity 2).
+ //! Else, splits <aFace> in order to return a list of valid
//! faces.
Standard_EXPORT static Standard_Boolean Regularize(const TopoDS_Face& aFace,
TopTools_ListOfShape& aListOfFaces,
TopTools_DataMapOfShapeListOfShape& ESplits);
- //! Returns <False> if the face is valid (the UV
- //! representation of the face is a set of pcurves
- //! connexed by points with connexity 2).
- //! Else, splits wires of the face, these are boundaries of the
+ //! Returns <False> if the face is valid (the UV
+ //! representation of the face is a set of pcurves
+ //! connexed by points with connexity 2).
+ //! Else, splits wires of the face, these are boundaries of the
//! new faces to build up; <OldWiresNewWires> describes (wire,
//! splits of wire); <ESplits> describes (edge, edge's splits)
Standard_EXPORT static Standard_Boolean RegularizeWires(
//!
//! This class has been created because it is not possible
//! to instantiate the argument TheAncestorsTool (of
-//! DSFiller from TopOpeInter) with a package (TopExp)
+//! DSFiller from TopOpeInter) with a package (TopExp)
//! giving services as package methods.
class TopOpeBRepTool_AncestorsTool
{
class TopoDS_Vertex;
class TopoDS_Edge;
-//! This class can detect vertices in a face that can
+//! This class can detect vertices in a face that can
//! be considered useless and then perform the fuse of
-//! the edges and remove the useless vertices. By
-//! useles vertices, we mean :
-//! * vertices that have exactly two connex edges
+//! the edges and remove the useless vertices. By
+//! useles vertices, we mean:
+//! * vertices that have exactly two connex edges
//! * the edges connex to the vertex must have
-//! exactly the same 2 connex faces .
+//! exactly the same 2 connex faces.
//! * The edges connex to the vertex must have the
//! same geometric support.
class TopOpeBRepTool_FuseEdges
public:
DEFINE_STANDARD_ALLOC
- //! Initialise members and build construction of map
+ //! Initialise members and build construction of map
//! of ancestors.
Standard_EXPORT TopOpeBRepTool_FuseEdges(const TopoDS_Shape& theShape,
const Standard_Boolean PerformNow = Standard_False);
//! set edges to avoid being fused
Standard_EXPORT void AvoidEdges(const TopTools_IndexedMapOfShape& theMapEdg);
- //! returns all the list of edges to be fused
+ //! returns all the list of edges to be fused
//! each list of the map represent a set of connex edges
//! that can be fused.
Standard_EXPORT void Edges(TopTools_DataMapOfIntegerListOfShape& theMapLstEdg);
//! returns all the fused edges. each integer entry in
- //! the map corresponds to the integer in the
- //! DataMapOfIntegerListOfShape we get in method
- //! Edges. That is to say, to the list of edges in
+ //! the map corresponds to the integer in the
+ //! DataMapOfIntegerListOfShape we get in method
+ //! Edges. That is to say, to the list of edges in
//! theMapLstEdg(i) corresponds the resulting edge theMapEdge(i)
Standard_EXPORT void ResultEdges(TopTools_DataMapOfIntegerShape& theMapEdg);
//! returns the number of vertices candidate to be removed
Standard_EXPORT Standard_Integer NbVertices();
- //! Using map of list of connex edges, fuse each list to
+ //! Using map of list of connex edges, fuse each list to
//! one edge and then update myShape
Standard_EXPORT void Perform();
//! Build the all the lists of edges that are to be fused
Standard_EXPORT void BuildListEdges();
- //! Build result fused edges according to the list
+ //! Build result fused edges according to the list
//! builtin BuildLisEdges
Standard_EXPORT void BuildListResultEdges();
DEFINE_STANDARD_ALLOC
//! Boolean flags <CompC3D>, <CompPC1>, <CompPC2>
- //! indicate whether the corresponding result curves
- //! <C3D>, <PC1>, <PC2> of MakeCurves method must or not
+ //! indicate whether the corresponding result curves
+ //! <C3D>, <PC1>, <PC2> of MakeCurves method must or not
//! be computed from an intersection line <L>.
- //! When the line <L> is a walking one, <TypeC3D> is the
- //! kind of the 3D curve <C3D> to compute :
- //! - BSPLINE1 to compute a BSpline of degree 1 on the
- //! walking points of <L>,
- //! - APPROX to build an approximation curve on the
+ //! When the line <L> is a walking one, <TypeC3D> is the
+ //! kind of the 3D curve <C3D> to compute:
+ //! - BSPLINE1 to compute a BSpline of degree 1 on the
+ //! walking points of <L>,
+ //! - APPROX to build an approximation curve on the
//! walking points of <L>.
Standard_EXPORT TopOpeBRepTool_GeomTool(
const TopOpeBRepTool_OutCurveType TypeC3D = TopOpeBRepTool_BSPLINE1,
#include <TopTools_IndexedDataMapOfShapeListOfShape.hxx>
#include <Standard_Integer.hxx>
-//! remove from a shape, the internal edges that are
-//! not connected to any face in the shape. We can
-//! get the list of the edges as a
+//! remove from a shape, the internal edges that are
+//! not connected to any face in the shape. We can
+//! get the list of the edges as a
//! DataMapOfShapeListOfShape with a Face of the Shape
-//! as the key and a list of internal edges as the
-//! value. The list of internal edges means edges
-//! that are not connected to any face in the shape.
+//! as the key and a list of internal edges as the
+//! value. The list of internal edges means edges
+//! that are not connected to any face in the shape.
//!
-//! Example of use :
-//! TopTools_DataMapOfShapeListOfShape mymap;
+//! Example of use:
+//! TopTools_DataMapOfShapeListOfShape mymap;
//! TopOpeBRepTool_PurgeInternalEdges
//! mypurgealgo(mysolid); mypurgealgo.GetFaces(mymap);
class TopOpeBRepTool_PurgeInternalEdges
public:
DEFINE_STANDARD_ALLOC
- //! Initialize members and begin exploration of shape
+ //! Initialize members and begin exploration of shape
//! depending of the value of PerformNow
Standard_EXPORT TopOpeBRepTool_PurgeInternalEdges(
const TopoDS_Shape& theShape,
const Standard_Boolean PerformNow = Standard_True);
- //! returns the list internal edges associated with
- //! the faces of the myShape. If PerformNow was False
+ //! returns the list internal edges associated with
+ //! the faces of the myShape. If PerformNow was False
//! when created, then call the private Perform method
//! that do the main job.
Standard_EXPORT void Faces(TopTools_DataMapOfShapeListOfShape& theMapFacLstEdg);
//! returns the number of edges candidate to be removed
Standard_EXPORT Standard_Integer NbEdges() const;
- //! returns False if the list of internal edges has
+ //! returns False if the list of internal edges has
//! not been extracted
Standard_Boolean IsDone() const { return myIsDone; }
TopTools_IndexedDataMapOfShapeListOfShape myMapEdgLstFac;
private:
- //! Do the main job. Explore all the edges of myShape and
- //! build a map with faces as a key and list of internal
+ //! Do the main job. Explore all the edges of myShape and
+ //! build a map with faces as a key and list of internal
//! edges(without connected faces) as value.
Standard_EXPORT void BuildList();
//! <ToFind> is the type of shapes to search.
//! TopAbs_VERTEX, TopAbs_EDGE, ...
//!
- //! <ToAvoid> is the type of shape to skip in the
- //! exploration. If <ToAvoid> is equal or less
- //! complex than <ToFind> or if <ToAVoid> is SHAPE it
+ //! <ToAvoid> is the type of shape to skip in the
+ //! exploration. If <ToAvoid> is equal or less
+ //! complex than <ToFind> or if <ToAVoid> is SHAPE it
//! has no effect on the exploration.
TopOpeBRepTool_ShapeExplorer(const TopoDS_Shape& S,
const TopAbs_ShapeEnum ToFind,
class Expr_GeneralExpression;
class Expr_GeneralRelation;
-//! This package describes the data structure of any
+//! This package describes the data structure of any
//! expression, relation or function used in mathematics.
//! It also describes the assignment of variables. Standard
//! mathematical functions are implemented such as
class Expr_NamedExpression;
DEFINE_STANDARD_HANDLE(Expr_NamedExpression, Expr_GeneralExpression)
-//! Describe an expression used by its name (as constants
+//! Describe an expression used by its name (as constants
//! or variables). A single reference is made to a
//! NamedExpression in every Expression (i.e. a
//! NamedExpression is shared).
//! If theFlag = TRUE it means that no selection of parts
//! of the tool is needed, t.e. no second part. In that case
//! if theFuse = 0 than operation is COMMON, otherwise CUT21.
- //! If theFlag = FALSE SetOperation(theFuse) function is called.
+ //! If theFlag = FALSE SetOperation(theFuse) function is called.
Standard_EXPORT void SetOperation(const Standard_Integer theFuse, const Standard_Boolean theFlag);
//! Collects parts of the tool.
//! The semantics of form feature creation is based on the construction of shapes:
//! - along a length
//! - up to a limiting face
-//! - from a limiting face to a height
+//! - from a limiting face to a height
//! - above and/or below a plane
//! The shape defining construction of the feature can be either the
//! supporting edge or the concerned area of a face.
Standard_EXPORT virtual Standard_Boolean IsDeleted(const TopoDS_Shape& S) Standard_OVERRIDE;
- //! Returns the list of shapes created at the bottom of
- //! the created form. It may be an empty list.
+ //! Returns the list of shapes created at the bottom of
+ //! the created form. It may be an empty list.
Standard_EXPORT const TopTools_ListOfShape& FirstShape() const;
- //! Returns the list of shapes created at the top of the
- //! created form. It may be an empty list.
+ //! Returns the list of shapes created at the top of the
+ //! created form. It may be an empty list.
Standard_EXPORT const TopTools_ListOfShape& LastShape() const;
//! Returns a list of the limiting and glueing edges
//! Returns the resulting compound shape.
const TopoDS_Shape& GluedShape() const;
- //! This is called by Shape(). It does nothing but
+ //! This is called by Shape(). It does nothing but
//! may be redefined.
Standard_EXPORT virtual void Build(
const Message_ProgressRange& theRange = Message_ProgressRange()) Standard_OVERRIDE;
- //! returns the status of the Face after
+ //! Returns the status of the Face after
//! the shape creation.
Standard_EXPORT virtual Standard_Boolean IsDeleted(const TopoDS_Shape& F) Standard_OVERRIDE;
- //! returns the list of generated Faces.
+ //! Returns the list of generated Faces.
Standard_EXPORT virtual const TopTools_ListOfShape& Modified(const TopoDS_Shape& F)
Standard_OVERRIDE;
//! Sets the axis of the hole(s).
void Init(const gp_Ax1& Axis);
- //! Sets the shape and axis on which hole(s) will be
+ //! Sets the shape and axis on which hole(s) will be
//! performed.
void Init(const TopoDS_Shape& S, const gp_Ax1& Axis);
- //! Performs every hole of radius <Radius>. This
- //! command has the same effect as a cut operation
- //! with an infinite cylinder defined by the given
+ //! Performs every hole of radius <Radius>. This
+ //! command has the same effect as a cut operation
+ //! with an infinite cylinder defined by the given
//! axis and <Radius>.
Standard_EXPORT void Perform(const Standard_Real Radius);
- //! Performs every hole of radius <Radius> located
- //! between PFrom and PTo on the given axis. If
- //! <WithControl> is set to Standard_False no control
- //! are done on the resulting shape after the
+ //! Performs every hole of radius <Radius> located
+ //! between PFrom and PTo on the given axis. If
+ //! <WithControl> is set to Standard_False no control
+ //! are done on the resulting shape after the
//! operation is performed.
Standard_EXPORT void Perform(const Standard_Real Radius,
const Standard_Real PFrom,
const Standard_Boolean WithControl = Standard_True);
//! Performs the first hole of radius <Radius>, in the
- //! direction of the defined axis. First hole signify
+ //! direction of the defined axis. First hole signify
//! first encountered after the origin of the axis. If
- //! <WithControl> is set to Standard_False no control
- //! are done on the resulting shape after the
+ //! <WithControl> is set to Standard_False no control
+ //! are done on the resulting shape after the
//! operation is performed.
Standard_EXPORT void PerformThruNext(const Standard_Real Radius,
const Standard_Boolean WithControl = Standard_True);
- //! Performs every hole of radius <Radius> located
- //! after the origin of the given axis. If
- //! <WithControl> is set to Standard_False no control
- //! are done on the resulting shape after the
+ //! Performs every hole of radius <Radius> located
+ //! after the origin of the given axis. If
+ //! <WithControl> is set to Standard_False no control
+ //! are done on the resulting shape after the
//! operation is performed.
Standard_EXPORT void PerformUntilEnd(const Standard_Real Radius,
const Standard_Boolean WithControl = Standard_True);
- //! Performs a blind hole of radius <Radius> and
- //! length <Length>. The length is measured from the
- //! origin of the given axis. If <WithControl> is set
- //! to Standard_False no control are done after the
+ //! Performs a blind hole of radius <Radius> and
+ //! length <Length>. The length is measured from the
+ //! origin of the given axis. If <WithControl> is set
+ //! to Standard_False no control are done after the
//! operation is performed.
Standard_EXPORT void PerformBlind(const Standard_Real Radius,
const Standard_Real Length,
//! Returns the status after a hole is performed.
BRepFeat_Status Status() const;
- //! Builds the resulting shape (redefined from
- //! MakeShape). Invalidates the given parts of tools
- //! if any, and performs the result of the local
+ //! Builds the resulting shape (redefined from
+ //! MakeShape). Invalidates the given parts of tools
+ //! if any, and performs the result of the local
//! operation.
Standard_EXPORT void Build();
//! serve as the basis from the draft prism. The draft will be
//! defined by the angle Angle and Fuse offers a choice between:
//! - removing matter with a Boolean cut using the setting 0
- //! - adding matter with Boolean fusion using the setting 1.
+ //! - adding matter with Boolean fusion using the setting 1.
//! The sketch face Skface serves to determine the type of
//! operation. If it is inside the basis shape, a local
//! operation such as glueing can be performed.
//! Indicates that the edge <E> will slide on the face
//! <OnFace>.
- //! Raises ConstructionError if the face does not belong to the
+ //! Raises ConstructionError if the face does not belong to the
//! basis shape, or the edge to the prismed shape.
Standard_EXPORT void Add(const TopoDS_Edge& E, const TopoDS_Face& OnFace);
//! Indicates that the edge <E> will slide on the face
//! <OnFace>.
- //! Raises ConstructionError if the face does not belong to the
+ //! Raises ConstructionError if the face does not belong to the
//! basis shape, or the edge to the prismed shape.
Standard_EXPORT void Add(const TopoDS_Edge& E, const TopoDS_Face& OnFace);
const Standard_Boolean Modify);
//! Indicates that the edge <E> will slide on the face
- //! <OnFace>. Raises ConstructionError if the face does not belong to the
+ //! <OnFace>. Raises ConstructionError if the face does not belong to the
//! basis shape, or the edge to the prismed shape.
Standard_EXPORT void Add(const TopoDS_Edge& E, const TopoDS_Face& OnFace);
const Standard_Boolean Modify);
//! Indicates that the edge <E> will slide on the face
- //! <OnFace>. Raises ConstructionError if the face does not belong to the
+ //! <OnFace>. Raises ConstructionError if the face does not belong to the
//! basis shape, or the edge to the prismed shape.
Standard_EXPORT void Add(const TopoDS_Edge& E, const TopoDS_Face& OnFace);
const Standard_Boolean Modify);
//! Indicates that the edge <E> will slide on the face
- //! <OnFace>. Raises ConstructionError if the face does not belong to the
+ //! <OnFace>. Raises ConstructionError if the face does not belong to the
//! basis shape, or the edge to the prismed shape.
Standard_EXPORT void Add(const TopoDS_Edge& E, const TopoDS_Face& OnFace);
Standard_Boolean& Sliding);
//! Indicates that the edge <E> will slide on the face
- //! <OnFace>. Raises ConstructionError if the face does not belong to the
+ //! <OnFace>. Raises ConstructionError if the face does not belong to the
//! basis shape, or the edge to the prismed shape.
Standard_EXPORT void Add(const TopoDS_Edge& E, const TopoDS_Face& OnFace);
Standard_EXPORT virtual const TopTools_ListOfShape& Generated(const TopoDS_Shape& S)
Standard_OVERRIDE;
- //! Returns the list of shapes created at the bottom of
- //! the created form. It may be an empty list.
+ //! Returns the list of shapes created at the bottom of
+ //! the created form. It may be an empty list.
Standard_EXPORT const TopTools_ListOfShape& FirstShape() const;
- //! Returns the list of shapes created at the top of the
- //! created form. It may be an empty list.
+ //! Returns the list of shapes created at the top of the
+ //! created form. It may be an empty list.
Standard_EXPORT const TopTools_ListOfShape& LastShape() const;
//! Returns a list of the limiting and glueing faces
//! Empty constructor
BRepFeat_SplitShape();
- //! Creates the process with the shape <S>.
+ //! Creates the process with the shape <S>.
BRepFeat_SplitShape(const TopoDS_Shape& S);
//! Add splitting edges or wires for whole initial shape
void SetCheckInterior(const Standard_Boolean ToCheckInterior);
//! Adds the wire <W> on the face <F>.
- //! Raises NoSuchObject if <F> does not belong to the original shape.
+ //! Raises NoSuchObject if <F> does not belong to the original shape.
void Add(const TopoDS_Wire& W, const TopoDS_Face& F);
//! Adds the edge <E> on the face <F>.
//! they must be connected topologically, i.e. they
//! must share common vertices.
//!
- //! Raises NoSuchObject if <F> does not belong to the original shape.
+ //! Raises NoSuchObject if <F> does not belong to the original shape.
void Add(const TopoDS_Compound& Comp, const TopoDS_Face& F);
//! Adds the edge <E> on the existing edge <EOn>.
void Add(const TopoDS_Edge& E, const TopoDS_Edge& EOn);
- //! Returns the faces which are the left of the
+ //! Returns the faces which are the left of the
//! projected wires.
Standard_EXPORT const TopTools_ListOfShape& DirectLeft() const;
//! Returns the faces of the "left" part on the shape.
- //! (It is build from DirectLeft, with the faces
+ //! (It is build from DirectLeft, with the faces
//! connected to this set, and so on...).
//! Raises NotDone if IsDone returns <Standard_False>.
Standard_EXPORT const TopTools_ListOfShape& Left() const;
class TopoDS_Edge;
class TopoDS_Shape;
-//! Provides tools to implement local topological
+//! Provides tools to implement local topological
//! operations on a shape.
class LocOpe
{
public:
DEFINE_STANDARD_ALLOC
- //! Returns Standard_True when the wire <W> is closed
+ //! Returns Standard_True when the wire <W> is closed
//! on the face <OnF>.
Standard_EXPORT static Standard_Boolean Closed(const TopoDS_Wire& W, const TopoDS_Face& OnF);
- //! Returns Standard_True when the edge <E> is closed
+ //! Returns Standard_True when the edge <E> is closed
//! on the face <OnF>.
Standard_EXPORT static Standard_Boolean Closed(const TopoDS_Edge& E, const TopoDS_Face& OnF);
- //! Returns Standard_True when the faces are tangent
+ //! Returns Standard_True when the faces are tangent
Standard_EXPORT static Standard_Boolean TgtFaces(const TopoDS_Edge& E,
const TopoDS_Face& F1,
const TopoDS_Face& F2);
LocOpe_BuildShape();
- //! Builds shape(s) from the list <L>. Uses only the
+ //! Builds shape(s) from the list <L>. Uses only the
//! faces of <L>.
LocOpe_BuildShape(const TopTools_ListOfShape& L);
- //! Builds shape(s) from the list <L>. Uses only the
+ //! Builds shape(s) from the list <L>. Uses only the
//! faces of <L>.
Standard_EXPORT void Perform(const TopTools_ListOfShape& L);
class LocOpe_PntFace;
//! This class provides the intersection between a set
-//! of axis or a circle and the faces of a shape. The
-//! intersection points are sorted in increasing
+//! of axis or a circle and the faces of a shape. The
+//! intersection points are sorted in increasing
//! parameter along each axis or circle.
class LocOpe_CSIntersector
{
//! Empty constructor.
LocOpe_CSIntersector();
- //! Creates and performs the intersection between
+ //! Creates and performs the intersection between
//! <Ax1> and <S>.
LocOpe_CSIntersector(const TopoDS_Shape& S);
Standard_EXPORT void Perform(const TColGeom_SequenceOfCurve& Scur);
- //! Returns <Standard_True> if the intersection has
+ //! Returns <Standard_True> if the intersection has
//! been done.
Standard_Boolean IsDone() const;
- //! Returns the number of intersection point on the
+ //! Returns the number of intersection point on the
//! element of range <I>.
Standard_EXPORT Standard_Integer NbPoints(const Standard_Integer I) const;
//! Returns the intersection point of range <Index> on
- //! element of range <I>. The points are sorted in
+ //! element of range <I>. The points are sorted in
//! increasing order of parameter along the axis.
Standard_EXPORT const LocOpe_PntFace& Point(const Standard_Integer I,
const Standard_Integer Index) const;
- //! On the element of range <I>, searches the first
- //! intersection point located after the parameter
- //! <From>, which orientation is not TopAbs_EXTERNAL.
- //! If found, returns <Standard_True>. <Or> contains
- //! the orientation of the point, <IndFrom> and
- //! <IndTo> represents the interval of index in the
- //! sequence of intersection point corresponding to
- //! the point. (IndFrom <= IndTo). <Tol> is used to
+ //! On the element of range <I>, searches the first
+ //! intersection point located after the parameter
+ //! <From>, which orientation is not TopAbs_EXTERNAL.
+ //! If found, returns <Standard_True>. <Or> contains
+ //! the orientation of the point, <IndFrom> and
+ //! <IndTo> represents the interval of index in the
+ //! sequence of intersection point corresponding to
+ //! the point. (IndFrom <= IndTo). <Tol> is used to
//! determine if 2 parameters are equal.
//!
//! Otherwise, returns <Standard_False>.
Standard_Integer& IndFrom,
Standard_Integer& IndTo) const;
- //! On the element of range <I>, searches the first
- //! intersection point located before the parameter
- //! <From>, which orientation is not TopAbs_EXTERNAL.
- //! If found, returns <Standard_True>. <Or> contains
- //! the orientation of the point, <IndFrom> and
- //! <IndTo> represents the interval of index in the
- //! sequence of intersection point corresponding to
- //! the point (IndFrom <= IndTo). <Tol> is used to
+ //! On the element of range <I>, searches the first
+ //! intersection point located before the parameter
+ //! <From>, which orientation is not TopAbs_EXTERNAL.
+ //! If found, returns <Standard_True>. <Or> contains
+ //! the orientation of the point, <IndFrom> and
+ //! <IndTo> represents the interval of index in the
+ //! sequence of intersection point corresponding to
+ //! the point (IndFrom <= IndTo). <Tol> is used to
//! determine if 2 parameters are equal.
//!
//! Otherwise, returns <Standard_False>.
Standard_Integer& IndFrom,
Standard_Integer& IndTo) const;
- //! On the element of range <I>, searches the first
- //! intersection point located after the index
- //! <FromInd> ( >= FromInd + 1), which orientation is
- //! not TopAbs_EXTERNAL. If found, returns
- //! <Standard_True>. <Or> contains the orientation of
- //! the point, <IndFrom> and <IndTo> represents the
- //! interval of index in the sequence of intersection
- //! point corresponding to the point. (IndFrom <=
- //! IndTo). <Tol> is used to determine if 2 parameters
- //! are equal.
+ //! On the element of range <I>, searches the first
+ //! intersection point located after the index
+ //! <FromInd> ( >= FromInd + 1), which orientation is
+ //! not TopAbs_EXTERNAL. If found, returns
+ //! <Standard_True>. <Or> contains the orientation of
+ //! the point, <IndFrom> and <IndTo> represents the
+ //! interval of index in the sequence of intersection
+ //! point corresponding to the point. (IndFrom <= IndTo).
+ //! <Tol> is used to determine if 2 parameters are equal.
//!
//! Otherwise, returns <Standard_False>.
Standard_EXPORT Standard_Boolean LocalizeAfter(const Standard_Integer I,
Standard_Integer& IndFrom,
Standard_Integer& IndTo) const;
- //! On the element of range <I>, searches the first
- //! intersection point located before the index
- //! <FromInd> ( <= FromInd -1), which orientation is
- //! not TopAbs_EXTERNAL. If found, returns
- //! <Standard_True>. <Or> contains the orientation of
- //! the point, <IndFrom> and <IndTo> represents the
- //! interval of index in the sequence of intersection
- //! point corresponding to the point (IndFrom <=
- //! IndTo). <Tol> is used to determine if 2 parameters
- //! are equal.
+ //! On the element of range <I>, searches the first
+ //! intersection point located before the index
+ //! <FromInd> (<= FromInd -1), which orientation is
+ //! not TopAbs_EXTERNAL. If found, returns
+ //! <Standard_True>. <Or> contains the orientation of
+ //! the point, <IndFrom> and <IndTo> represents the
+ //! interval of index in the sequence of intersection
+ //! point corresponding to the point (IndFrom <= IndTo).
+ //! <Tol> is used to determine if 2 parameters are equal.
//!
//! Otherwise, returns <Standard_False>.
Standard_EXPORT Standard_Boolean LocalizeBefore(const Standard_Integer I,
class gp_Circ;
class LocOpe_PntFace;
-//! This class provides the intersection between an
-//! axis or a circle and the faces of a shape. The
-//! intersection points are sorted in increasing
+//! This class provides the intersection between an
+//! axis or a circle and the faces of a shape. The
+//! intersection points are sorted in increasing
//! parameter along the axis.
class LocOpe_CurveShapeIntersector
{
//! Empty constructor.
LocOpe_CurveShapeIntersector();
- //! Creates and performs the intersection between
+ //! Creates and performs the intersection between
//! <Ax1> and <S>.
LocOpe_CurveShapeIntersector(const gp_Ax1& Axis, const TopoDS_Shape& S);
- //! Creates and performs yte intersection between
+ //! Creates and performs the intersection between
//! <C> and <S>.
LocOpe_CurveShapeIntersector(const gp_Circ& C, const TopoDS_Shape& S);
//! Performs the intersection between <Ax1 and <S>.
Standard_EXPORT void Init(const gp_Circ& C, const TopoDS_Shape& S);
- //! Returns <Standard_True> if the intersection has
+ //! Returns <Standard_True> if the intersection has
//! been done.
Standard_Boolean IsDone() const;
//! Returns the number of intersection point.
Standard_Integer NbPoints() const;
- //! Returns the intersection point of range <Index>.
- //! The points are sorted in increasing order of
+ //! Returns the intersection point of range <Index>.
+ //! The points are sorted in increasing order of
//! parameter along the axis.
const LocOpe_PntFace& Point(const Standard_Integer Index) const;
- //! Searches the first intersection point located
- //! after the parameter <From>, which orientation is
- //! not TopAbs_EXTERNAL. If found, returns
- //! <Standard_True>. <Or> contains the orientation of
- //! the point, <IndFrom> and <IndTo> represents the
- //! interval of index in the sequence of intersection
- //! point corresponding to the point. (IndFrom <=
- //! IndTo).
+ //! Searches the first intersection point located
+ //! after the parameter <From>, which orientation is
+ //! not TopAbs_EXTERNAL. If found, returns
+ //! <Standard_True>. <Or> contains the orientation of
+ //! the point, <IndFrom> and <IndTo> represents the
+ //! interval of index in the sequence of intersection
+ //! point corresponding to the point. (IndFrom <= IndTo).
//!
//! Otherwise, returns <Standard_False>.
Standard_EXPORT Standard_Boolean LocalizeAfter(const Standard_Real From,
Standard_Integer& IndFrom,
Standard_Integer& IndTo) const;
- //! Searches the first intersection point located
- //! before the parameter <From>, which orientation is
- //! not TopAbs_EXTERNAL. If found, returns
- //! <Standard_True>. <Or> contains the orientation of
- //! the point, <IndFrom> and <IndTo> represents the
- //! interval of index in the sequence of intersection
- //! point corresponding to the point (IndFrom <=
- //! IndTo).
+ //! Searches the first intersection point located
+ //! before the parameter <From>, which orientation is
+ //! not TopAbs_EXTERNAL. If found, returns
+ //! <Standard_True>. <Or> contains the orientation of
+ //! the point, <IndFrom> and <IndTo> represents the
+ //! interval of index in the sequence of intersection
+ //! point corresponding to the point (IndFrom <= IndTo).
//!
//! Otherwise, returns <Standard_False>.
Standard_EXPORT Standard_Boolean LocalizeBefore(const Standard_Real From,
Standard_Integer& IndFrom,
Standard_Integer& IndTo) const;
- //! Searches the first intersection point located
- //! after the index <FromInd> ( >= FromInd + 1), which
- //! orientation is not TopAbs_EXTERNAL. If found,
- //! returns <Standard_True>. <Or> contains the
- //! orientation of the point, <IndFrom> and <IndTo>
- //! represents the interval of index in the sequence
- //! of intersection point corresponding to the
- //! point. (IndFrom <= IndTo).
+ //! Searches the first intersection point located
+ //! after the index <FromInd> (>= FromInd + 1), which
+ //! orientation is not TopAbs_EXTERNAL. If found,
+ //! returns <Standard_True>. <Or> contains the
+ //! orientation of the point, <IndFrom> and <IndTo>
+ //! represents the interval of index in the sequence
+ //! of intersection point corresponding to the point.
+ //! (IndFrom <= IndTo).
//!
//! Otherwise, returns <Standard_False>.
Standard_EXPORT Standard_Boolean LocalizeAfter(const Standard_Integer FromInd,
Standard_Integer& IndFrom,
Standard_Integer& IndTo) const;
- //! Searches the first intersection point located
+ //! Searches the first intersection point located
//! before the index <FromInd> ( <= FromInd -1), which
- //! orientation is not TopAbs_EXTERNAL. If found,
- //! returns <Standard_True>. <Or> contains the
- //! orientation of the point, <IndFrom> and <IndTo>
- //! represents the interval of index in the sequence
- //! of intersection point corresponding to the point
+ //! orientation is not TopAbs_EXTERNAL. If found,
+ //! returns <Standard_True>. <Or> contains the
+ //! orientation of the point, <IndFrom> and <IndTo>
+ //! represents the interval of index in the sequence
+ //! of intersection point corresponding to the point
//! (IndFrom <= IndTo).
//!
//! Otherwise, returns <Standard_False>.
#include <TopTools_ListOfShape.hxx>
class Geom_Curve;
-//! Defines a pipe (near from Pipe from BRepFill),
+//! Defines a pipe (near from Pipe from BRepFill),
//! with modifications provided for the Pipe feature.
class LocOpe_DPrism
{
public:
Standard_EXPORT virtual const TopTools_ListOfShape& GeneratingEdges() = 0;
- //! Returns the edge created by the vertex <V>. If
+ //! Returns the edge created by the vertex <V>. If
//! none, must return a null shape.
Standard_EXPORT virtual TopoDS_Edge Generated(const TopoDS_Vertex& V) = 0;
//! must return a null shape.
Standard_EXPORT virtual TopoDS_Face Generated(const TopoDS_Edge& E) = 0;
- //! Returns the list of correctly oriented generated
+ //! Returns the list of correctly oriented generated
//! faces.
Standard_EXPORT virtual const TopTools_ListOfShape& OrientedFaces() = 0;
//! Returns the initial shape
const TopoDS_Shape& Shape() const;
- //! Returns the descendant face of <F>. <F> may
+ //! Returns the descendant face of <F>. <F> may
//! belong to the original shape or to the "generated"
- //! shape. The returned face may be a null shape
+ //! shape. The returned face may be a null shape
//! (when <F> disappears).
Standard_EXPORT const TopTools_ListOfShape& DescendantFace(const TopoDS_Face& F);
Standard_EXPORT const TopTools_ListOfShape& GeneratingEdges() Standard_OVERRIDE;
- //! Returns the edge created by the vertex <V>. If
+ //! Returns the edge created by the vertex <V>. If
//! none, must return a null shape.
Standard_EXPORT TopoDS_Edge Generated(const TopoDS_Vertex& V) Standard_OVERRIDE;
//! must return a null shape.
Standard_EXPORT TopoDS_Face Generated(const TopoDS_Edge& E) Standard_OVERRIDE;
- //! Returns the list of correctly oriented generated
+ //! Returns the list of correctly oriented generated
//! faces.
Standard_EXPORT const TopTools_ListOfShape& OrientedFaces() Standard_OVERRIDE;
class TopoDS_Wire;
class Geom_Curve;
-//! Defines a pipe (near from Pipe from BRepFill),
+//! Defines a pipe (near from Pipe from BRepFill),
//! with modifications provided for the Pipe feature.
class LocOpe_Pipe
{
class gp_Dir;
class gp_Pln;
-//! This class provides a tool to realize the
-//! following operations on a shape :
+//! This class provides a tool to realize the
+//! following operations on a shape:
//! - split a face of the shape with a wire,
//! - put draft angle on both side of the wire.
//! For each side, the draft angle may be different.
Standard_EXPORT void Init(const TopoDS_Shape& S);
//! Splits the face <F> of the former given shape with
- //! the wire <W>. The wire is assumed to lie on the
- //! face. Puts a draft angle on both parts of the
- //! wire. <Extractg>, <Nplg>, <Angleg> define the
- //! arguments for the left part of the wire.
- //! <Extractd>,
<Npld>, <Angled> define the arguments
+ //! the wire <W>. The wire is assumed to lie on the
+ //! face. Puts a draft angle on both parts of the
+ //! wire. <Extractg>, <Nplg>, <Angleg> define the
+ //! arguments for the left part of the wire.
+ //! <Extractd>, <Npld>, <Angled> define the arguments
//! for the right part of the wire. The draft angle is
- //! measured with the direction <Extract>. <Npl>
+ //! measured with the direction <Extract>. <Npl>
//! defines the neutral plane (points belonging to the
- //! neutral plane are not modified). <Angle> is the
- //! value of the draft angle. If <ModifyLeft> is set
- //! to <Standard_False>, no draft angle is applied to
+ //! neutral plane are not modified). <Angle> is the
+ //! value of the draft angle. If <ModifyLeft> is set
+ //! to <Standard_False>, no draft angle is applied to
//! the left part of the wire. If <ModifyRight> is set
- //! to <Standard_False>,no draft angle is applied to
+ //! to <Standard_False>,no draft angle is applied to
//! the right part of the wire.
Standard_EXPORT void Perform(const TopoDS_Face& F,
const TopoDS_Wire& W,
const Standard_Boolean ModifyRight = Standard_True);
//! Splits the face <F> of the former given shape with
- //! the wire <W>. The wire is assumed to lie on the
- //! face. Puts a draft angle on the left part of the
- //! wire. The draft angle is measured with the
- //! direction <Extract>. <Npl> defines the neutral
- //! plane (points belonging to the neutral plane are
- //! not modified). <Angle> is the value of the draft
+ //! the wire <W>. The wire is assumed to lie on the
+ //! face. Puts a draft angle on the left part of the
+ //! wire. The draft angle is measured with the
+ //! direction <Extract>. <Npl> defines the neutral
+ //! plane (points belonging to the neutral plane are
+ //! not modified). <Angle> is the value of the draft
//! angle.
Standard_EXPORT void Perform(const TopoDS_Face& F,
const TopoDS_Wire& W,
class TopoDS_Wire;
class TopoDS_Face;
-//! Provides a tool to cut :
+//! Provides a tool to cut:
//! - edges with a vertices,
//! - faces with wires,
-//! and rebuilds the shape containing the edges and
+//! and rebuilds the shape containing the edges and
//! the faces.
class LocOpe_SplitShape
{
Standard_EXPORT const TopTools_ListOfShape& DescendantShapes(const TopoDS_Shape& S);
//! Returns the "left" part defined by the wire <W> on
- //! the face <F>. The returned list of shape is in
- //! fact a list of faces. The face <F> is considered
- //! with its topological orientation in the original
- //! shape. <W> is considered with its orientation.
+ //! the face <F>. The returned list of shape is in
+ //! fact a list of faces. The face <F> is considered
+ //! with its topological orientation in the original
+ //! shape. <W> is considered with its orientation.
Standard_EXPORT const TopTools_ListOfShape& LeftOf(const TopoDS_Wire& W, const TopoDS_Face& F);
protected:
//! Returns the initial shape
const TopoDS_Shape& Shape() const;
- //! Returns the faces which are the left of the
+ //! Returns the faces which are the left of the
//! projected wires and which are
Standard_EXPORT const TopTools_ListOfShape& DirectLeft() const;
//! Returns the faces of the "left" part on the shape.
- //! (It is build from DirectLeft, with the faces
+ //! (It is build from DirectLeft, with the faces
//! connected to this set, and so on...).
Standard_EXPORT const TopTools_ListOfShape& Left() const;
//! edge is projected.
Standard_EXPORT TopoDS_Face OnFace();
- //! If the current edge is projected on an edge,
+ //! If the current edge is projected on an edge,
//! returns <Standard_True> and sets the value of <E>.
//! Otherwise, returns <Standard_False>.
Standard_EXPORT Standard_Boolean OnEdge(TopoDS_Edge& E);
Standard_EXPORT Standard_Boolean OnVertex(const TopoDS_Vertex& Vwire, TopoDS_Vertex& Vshape);
- //! If the vertex <V> lies on an edge of the original
- //! shape, returns <Standard_True> and sets the
- //! concerned edge in <E>, and the parameter on the
+ //! If the vertex <V> lies on an edge of the original
+ //! shape, returns <Standard_True> and sets the
+ //! concerned edge in <E>, and the parameter on the
//! edge in <P>.
//! Else returns <Standard_False>.
Standard_EXPORT Standard_Boolean OnEdge(const TopoDS_Vertex& V, TopoDS_Edge& E, Standard_Real& P);
- //! If the vertex <V> lies on an edge of the original
- //! shape, returns <Standard_True> and sets the
- //! concerned edge in <E>, and the parameter on the
+ //! If the vertex <V> lies on an edge of the original
+ //! shape, returns <Standard_True> and sets the
+ //! concerned edge in <E>, and the parameter on the
//! edge in <P>.
//! Else returns <Standard_False>.
Standard_EXPORT Standard_Boolean OnEdge(const TopoDS_Vertex& V,
TColgp_Array1OfPnt2d& Poles2d,
TColStd_Array1OfReal& Weigths) Standard_OVERRIDE;
- //! compute the first derivative in v direction of the
- //! section for v = param
+ //! compute the first derivative in v direction of the
+ //! section for v = param
Standard_EXPORT virtual Standard_Boolean D1(const Standard_Real Param,
const Standard_Real First,
const Standard_Real Last,
TColStd_Array1OfReal& Weigths,
TColStd_Array1OfReal& DWeigths) Standard_OVERRIDE;
- //! compute the second derivative in v direction of the
- //! section for v = param
+ //! compute the second derivative in v direction of the
+ //! section for v = param
Standard_EXPORT virtual Standard_Boolean D2(const Standard_Real Param,
const Standard_Real First,
const Standard_Real Last,
TColStd_Array1OfReal& DWeigths,
TColStd_Array1OfReal& D2Weigths) Standard_OVERRIDE;
- //! get the number of 2d curves to approximate.
+ //! get the number of 2d curves to approximate.
Standard_EXPORT virtual Standard_Integer Nb2dCurves() const Standard_OVERRIDE;
- //! get the format of an section
+ //! get the format of an section
Standard_EXPORT virtual void SectionShape(Standard_Integer& NbPoles,
Standard_Integer& NbKnots,
Standard_Integer& Degree) const Standard_OVERRIDE;
//! Returns if the section is rational or not
Standard_EXPORT virtual Standard_Boolean IsRational() const Standard_OVERRIDE;
- //! Returns the number of intervals for continuity
+ //! Returns the number of intervals for continuity
//! <S>. May be one if Continuity(me) >= <S>
Standard_EXPORT virtual Standard_Integer NbIntervals(const GeomAbs_Shape S) const
Standard_OVERRIDE;
- //! Stores in <T> the parameters bounding the intervals
+ //! Stores in <T> the parameters bounding the intervals
//! of continuity <S>.
//!
- //! The array must provide enough room to accommodate
+ //! The array must provide enough room to accommodate
//! for the parameters. i.e. T.Length() > NbIntervals()
Standard_EXPORT virtual void Intervals(TColStd_Array1OfReal& T,
const GeomAbs_Shape S) const Standard_OVERRIDE;
Standard_EXPORT virtual void SetInterval(const Standard_Real First,
const Standard_Real Last) Standard_OVERRIDE;
- //! Returns the resolutions in the sub-space 2d <Index> --
- //! This information is usfull to find an good tolerance in
+ //! Returns the resolutions in the sub-space 2d <Index> --
+ //! This information is useful to find a good tolerance in
//! 2d approximation
Standard_EXPORT virtual void Resolution(const Standard_Integer Index,
const Standard_Real Tol,
const Standard_Real AngleTol,
TColStd_Array1OfReal& Tol3d) const Standard_OVERRIDE;
- //! Is usfull, if (me) have to be run numerical
- //! algorithme to perform D0, D1 or D2
+ //! Is useful, if (me) has to be run numerical
+ //! algorithm to perform D0, D1 or D2
Standard_EXPORT virtual void SetTolerance(const Standard_Real Tol3d,
const Standard_Real Tol2d) Standard_OVERRIDE;
- //! Get the barycentre of Surface. An very poor
+ //! Get the barycentre of Surface. An very poor
//! estimation is sufficient. This information is useful
//! to perform well conditioned rational approximation.
Standard_EXPORT virtual gp_Pnt BarycentreOfSurf() const Standard_OVERRIDE;
- //! Returns the length of the maximum section. This
+ //! Returns the length of the maximum section. This
//! information is useful to perform well conditioned rational
//! approximation.
Standard_EXPORT virtual Standard_Real MaximalSection() const Standard_OVERRIDE;
class BRepBlend_AppFuncRst;
DEFINE_STANDARD_HANDLE(BRepBlend_AppFuncRst, BRepBlend_AppFuncRoot)
-//! Function to approximate by AppSurface for Curve/Surface contact.
+//! Function to approximate by AppSurface for Curve/Surface contact.
class BRepBlend_AppFuncRst : public BRepBlend_AppFuncRoot
{
//! Define the Continuity used in the approximation
Standard_EXPORT void SetContinuity(const GeomAbs_Shape C);
- //! define the Weights associed to the criterium used in
- //! the optimization.
+ //! define the Weights associed to the criterium used in
+ //! the optimization.
//!
//! if Wi <= 0
Standard_EXPORT void SetCriteriumWeight(const Standard_Real W1,
//! returns the Continuity used in the approximation
Standard_EXPORT GeomAbs_Shape Continuity() const;
- //! returns the Weights (as percent) associed to the criterium used in
- //! the optimization.
+ //! returns the Weights (as percent) associed to the criterium used in
+ //! the optimization.
Standard_EXPORT void CriteriumWeight(Standard_Real& W1,
Standard_Real& W2,
Standard_Real& W3) const;
public:
DEFINE_STANDARD_ALLOC
- //! Approximation of the new Surface (and
- //! eventually the 2d Curves on the support
+ //! Approximation of the new Surface (and
+ //! eventually the 2d Curves on the support
//! surfaces).
- //! Normally the 2d curve are
- //! approximated with an tolerance given by the
- //! resolution on support surfaces, but if this
- //! tolerance is too large Tol2d is used.
+ //! Normally the 2d curve are
+ //! approximated with a tolerance given by the
+ //! resolution on support surfaces, but if this
+ //! tolerance is too large Tol2d is used.
Standard_EXPORT BRepBlend_AppSurface(const Handle(Approx_SweepFunction)& Funct,
const Standard_Real First,
const Standard_Real Last,
//! Function of reframing between a point and a curve.
//! valid in cases of constant and progressive radius.
-//! This function is used to find a solution on a done
-//! point of the curve 1 when using RstRstConsRad or
+//! This function is used to find a solution on a done
+//! point of the curve 1 when using RstRstConsRad or
//! CSConstRad...
-//! The vector <X> used in Value, Values and Derivatives
-//! methods has to be the vector of the parametric
-//! coordinates w, U where w is the parameter on the
-//! guide line, U are the parametric coordinates of a
+//! The vector <X> used in Value, Values and Derivatives
+//! methods has to be the vector of the parametric
+//! coordinates w, U where w is the parameter on the
+//! guide line, U are the parametric coordinates of a
//! point on the partner curve 2.
class BRepBlend_CurvPointRadInv : public Blend_CurvPointFuncInv
{
//! This method returns the value of the point in 3d space.
const gp_Pnt& Value() const;
- //! Set the tangent vector for an extremity on a
+ //! Set the tangent vector for an extremity on a
//! surface.
void SetTangent(const gp_Vec& Tangent);
- //! Returns TRUE if the Tangent is stored.
+ //! Returns TRUE if the Tangent is stored.
Standard_Boolean HasTangent() const;
- //! This method returns the value of tangent in 3d
+ //! This method returns the value of tangent in 3d
//! space.
const gp_Vec& Tangent() const;
static GeomAbs_Shape Continuity(const Handle(Adaptor2d_Curve2d)& C);
- //! Returns the number of intervals for continuity
+ //! Returns the number of intervals for continuity
//! <S>. May be one if Continuity(myclass) >= <S>
static Standard_Integer NbIntervals(const Handle(Adaptor2d_Curve2d)& C, const GeomAbs_Shape S);
- //! Stores in <T> the parameters bounding the intervals
+ //! Stores in <T> the parameters bounding the intervals
//! of continuity <S>.
//!
- //! The array must provide enough room to accommodate
+ //! The array must provide enough room to accommodate
//! for the parameters. i.e. T.Length() > NbIntervals()
static void Intervals(const Handle(Adaptor2d_Curve2d)& C,
TColStd_Array1OfReal& T,
const Standard_Real U,
const Standard_Integer N);
- //! Returns the parametric resolution corresponding
+ //! Returns the parametric resolution corresponding
//! to the real space resolution <R3d>.
static Standard_Real Resolution(const Handle(Adaptor2d_Curve2d)& C, const Standard_Real R3d);
- //! Returns the type of the curve in the current
- //! interval : Line, Circle, Ellipse, Hyperbola,
+ //! Returns the type of the curve in the current
+ //! interval: Line, Circle, Ellipse, Hyperbola,
//! Parabola, BezierCurve, BSplineCurve, OtherCurve.
static GeomAbs_CurveType GetType(const Handle(Adaptor2d_Curve2d)& C);
Standard_EXPORT Standard_Boolean IsSolution(const math_Vector& Sol,
const Standard_Real Tol) Standard_OVERRIDE;
- //! Returns the minimal Distance between two
+ //! Returns the minimal Distance between two
//! extremities of calculated sections.
Standard_EXPORT virtual Standard_Real GetMinimalDistance() const Standard_OVERRIDE;
//! Returns U,V coordinates of the point on the surface.
Standard_EXPORT const gp_Pnt2d& Pnt2dOnS() const Standard_OVERRIDE;
- //! Returns U,V coordinates of the point on the curve on
+ //! Returns U,V coordinates of the point on the curve on
//! surface.
Standard_EXPORT const gp_Pnt2d& Pnt2dOnRst() const Standard_OVERRIDE;
Standard_EXPORT const gp_Vec2d& Tangent2dOnRst() const Standard_OVERRIDE;
- //! Enables implementation of a criterion of decrochage
- //! specific to the function.
- //! Warning: Can be called without previous call of issolution
- //! but the values calculated can be senseless.
+ //! Enables implementation of a criterion of decrochage
+ //! specific to the function.
+ //! Warning: Can be called without previous call of IsSolution
+ //! but the values calculated can be senseless.
Standard_EXPORT Standard_Boolean Decroch(const math_Vector& Sol,
gp_Vec& NS,
gp_Vec& TgS) const Standard_OVERRIDE;
Standard_EXPORT void Set(const Standard_Real Radius, const Standard_Integer Choix);
- //! Sets the type of section generation for the
+ //! Sets the type of section generation for the
//! approximations.
Standard_EXPORT void Set(const BlendFunc_SectionShape TypeSection);
Standard_Real& Pfin,
gp_Circ& C);
- //! Returns if the section is rational
+ //! Returns if the section is rational
Standard_EXPORT Standard_Boolean IsRational() const Standard_OVERRIDE;
//! Returns the length of the maximum section
//! of all sections.
Standard_EXPORT void GetMinimalWeight(TColStd_Array1OfReal& Weigths) const Standard_OVERRIDE;
- //! Returns the number of intervals for continuity
+ //! Returns the number of intervals for continuity
//! <S>. May be one if Continuity(me) >= <S>
Standard_EXPORT Standard_Integer NbIntervals(const GeomAbs_Shape S) const Standard_OVERRIDE;
- //! Stores in <T> the parameters bounding the intervals
+ //! Stores in <T> the parameters bounding the intervals
//! of continuity <S>.
- //! The array must provide enough room to accommodate
+ //! The array must provide enough room to accommodate
//! for the parameters. i.e. T.Length() > NbIntervals()
Standard_EXPORT void Intervals(TColStd_Array1OfReal& T,
const GeomAbs_Shape S) const Standard_OVERRIDE;
Standard_EXPORT virtual Standard_Boolean IsSolution(const math_Vector& Sol,
const Standard_Real Tol) = 0;
- //! Returns the minimal Distance between two
+ //! Returns the minimal Distance between two
//! extremities of calculated sections.
Standard_EXPORT virtual Standard_Real GetMinimalDistance() const = 0;
//! Returns the point on the first support.
Standard_EXPORT virtual const gp_Pnt& Pnt2() const = 0;
- //! Returns if the section is rational
+ //! Returns if the section is rational
Standard_EXPORT virtual Standard_Boolean IsRational() const = 0;
//! Returns the length of the maximum section
//! of all sections.
Standard_EXPORT virtual void GetMinimalWeight(TColStd_Array1OfReal& Weigths) const = 0;
- //! Returns the number of intervals for continuity
+ //! Returns the number of intervals for continuity
//! <S>. May be one if Continuity(me) >= <S>
Standard_EXPORT virtual Standard_Integer NbIntervals(const GeomAbs_Shape S) const = 0;
- //! Stores in <T> the parameters bounding the intervals
+ //! Stores in <T> the parameters bounding the intervals
//! of continuity <S>.
//!
- //! The array must provide enough room to accommodate
+ //! The array must provide enough room to accommodate
//! for the parameters. i.e. T.Length() > NbIntervals()
//! raises
//! OutOfRange from Standard
Standard_Real& TolU,
Standard_Real& TolV) const = 0;
- //! Returns the parameter of the point P. Used to
+ //! Returns the parameter of the point P. Used to
//! impose the parameters in the approximation.
Standard_EXPORT Standard_Real Parameter(const Blend_Point& P) const;
//! surface between a surface and a curve, using a guide line.
//! The vector <X> used in Value, Values and Derivatives methods
//! may be the vector of the parametric coordinates U,V,
-//! W of the extremities of a section on the surface and
+//! W of the extremities of a section on the surface and
//! the curve.
class Blend_CSFunction : public Blend_AppFunction
{
const Standard_Real Tol)
Standard_OVERRIDE = 0;
- //! Returns the minimal Distance between two
+ //! Returns the minimal Distance between two
//! extremities of calculated sections.
Standard_EXPORT virtual Standard_Real GetMinimalDistance() const Standard_OVERRIDE;
//! Returns the point on the first support.
Standard_EXPORT const gp_Pnt& Pnt1() const Standard_OVERRIDE;
- //! Returns the point on the seconde support.
+ //! Returns the point on the second support.
Standard_EXPORT const gp_Pnt& Pnt2() const Standard_OVERRIDE;
//! Returns the point on the surface.
class math_Matrix;
class gp_Pnt;
-//! Deferred class for a function used to compute a
-//! blending surface between a surface and a curve, using
-//! a guide line. This function is used to find a
+//! Deferred class for a function used to compute a
+//! blending surface between a surface and a curve, using
+//! a guide line. This function is used to find a
//! solution on a done point of the curve.
-//! The vector <X> used in Value, Values and Derivatives
-//! methods has to be the vector of the parametric
-//! coordinates w, U, V where w is the parameter on the
-//! guide line, U,V are the parametric coordinates of a
+//! The vector <X> used in Value, Values and Derivatives
+//! methods has to be the vector of the parametric
+//! coordinates w, U, V where w is the parameter on the
+//! guide line, U,V are the parametric coordinates of a
//! point on the partner surface.
class Blend_CurvPointFuncInv : public math_FunctionSetWithDerivatives
{
//! Returns the point on the first support.
Standard_EXPORT const gp_Pnt& Pnt1() const Standard_OVERRIDE;
- //! Returns the point on the seconde support.
+ //! Returns the point on the second support.
Standard_EXPORT const gp_Pnt& Pnt2() const Standard_OVERRIDE;
//! Returns the point on the first surface, at parameter
//! using a guide line.
//! The vector <X> used in Value, Values and Derivatives methods
//! may be the vector of the parametric coordinates U,V,
-//! W of the extremities of a section on the surface and
+//! W of the extremities of a section on the surface and
//! the curve.
class Blend_RstRstFunction : public Blend_AppFunction
{
Standard_EXPORT virtual Standard_Boolean IsSolution(const math_Vector& Sol,
const Standard_Real Tol) = 0;
- //! Returns the minimal Distance between two
+ //! Returns the minimal Distance between two
//! extremities of calculated sections.
Standard_EXPORT Standard_Real GetMinimalDistance() const;
//! Returns the point on the first support.
Standard_EXPORT const gp_Pnt& Pnt1() const;
- //! Returns the point on the seconde support.
+ //! Returns the point on the second support.
Standard_EXPORT const gp_Pnt& Pnt2() const;
//! Returns the point on the surface.
//! Returns U,V coordinates of the point on the surface.
Standard_EXPORT virtual const gp_Pnt2d& Pnt2dOnRst1() const = 0;
- //! Returns U,V coordinates of the point on the curve on
+ //! Returns U,V coordinates of the point on the curve on
//! surface.
Standard_EXPORT virtual const gp_Pnt2d& Pnt2dOnRst2() const = 0;
//! parametric space of the second surface.
Standard_EXPORT virtual const gp_Vec2d& Tangent2dOnRst2() const = 0;
- //! Enables to implement a criterion of decrochage
+ //! Enables to implement a criterion of decrochage
//! specific to the function.
- //! Warning: Can be called without previous call of issolution
- //! but the values calculated can be senseless.
+ //! Warning: Can be called without previous call of IsSolution
+ //! but the values calculated can be senseless.
Standard_EXPORT virtual Blend_DecrochStatus Decroch(const math_Vector& Sol,
gp_Vec& NRst1,
gp_Vec& TgRst1,
gp_Vec& NRst2,
gp_Vec& TgRst2) const = 0;
- //! Returns if the section is rational
+ //! Returns if the section is rational
Standard_EXPORT virtual Standard_Boolean IsRational() const = 0;
//! Returns the length of the maximum section
//! of all sections.
Standard_EXPORT virtual void GetMinimalWeight(TColStd_Array1OfReal& Weigths) const = 0;
- //! Returns the number of intervals for continuity
+ //! Returns the number of intervals for continuity
//! <S>. May be one if Continuity(me) >= <S>
Standard_EXPORT virtual Standard_Integer NbIntervals(const GeomAbs_Shape S) const = 0;
- //! Stores in <T> the parameters bounding the intervals
+ //! Stores in <T> the parameters bounding the intervals
//! of continuity <S>.
//!
- //! The array must provide enough room to accommodate
+ //! The array must provide enough room to accommodate
//! for the parameters. i.e. T.Length() > NbIntervals()
Standard_EXPORT virtual void Intervals(TColStd_Array1OfReal& T, const GeomAbs_Shape S) const = 0;
#include <math_Vector.hxx>
class math_Matrix;
-//! Deferred class for a function used to compute a
-//! blending surface between a surface and a curve, using
-//! a guide line. This function is used to find a
+//! Deferred class for a function used to compute a
+//! blending surface between a surface and a curve, using
+//! a guide line. This function is used to find a
//! solution on a done restriction of the surface.
//!
-//! The vector <X> used in Value, Values and Derivatives
-//! methods has to be the vector of the parametric
-//! coordinates wguide, wcurv, wrst where wguide is the
+//! The vector <X> used in Value, Values and Derivatives
+//! methods has to be the vector of the parametric
+//! coordinates wguide, wcurv, wrst where wguide is the
//! parameter on the guide line, wcurv is the parameter on
//! the curve, wrst is the parameter on the restriction on
//! the surface.
class math_Matrix;
class gp_Pnt;
-//! Deferred class for a function used to compute a
-//! blending surface between a surface and a curve, using
-//! a guide line. This function is used to find a
+//! Deferred class for a function used to compute a
+//! blending surface between a surface and a curve, using
+//! a guide line. This function is used to find a
//! solution on a done point of the curve.
//!
-//! The vector <X> used in Value, Values and Derivatives
-//! methods has to be the vector of the parametric
-//! coordinates w, U, V where w is the parameter on the
-//! guide line, U,V are the parametric coordinates of a
+//! The vector <X> used in Value, Values and Derivatives
+//! methods has to be the vector of the parametric
+//! coordinates w, U, V where w is the parameter on the
+//! guide line, U,V are the parametric coordinates of a
//! point on the partner surface.
class Blend_SurfPointFuncInv : public math_FunctionSetWithDerivatives
{
//! using a guide line.
//! The vector <X> used in Value, Values and Derivatives methods
//! may be the vector of the parametric coordinates U,V,
-//! W of the extremities of a section on the surface and
+//! W of the extremities of a section on the surface and
//! the curve.
class Blend_SurfRstFunction : public Blend_AppFunction
{
Standard_EXPORT virtual void Set(const Standard_Real First, const Standard_Real Last) = 0;
//! Returns in the vector Tolerance the parametric tolerance
- //! for each variable;
+ //! for each variable.
//! Tol is the tolerance used in 3d space.
Standard_EXPORT virtual void GetTolerance(math_Vector& Tolerance,
const Standard_Real Tol) const = 0;
//! Returns in the vector InfBound the lowest values allowed
- //! for each variables.
+ //! for each variable.
//! Returns in the vector SupBound the greatest values allowed
//! for each of the 3 variables.
Standard_EXPORT virtual void GetBounds(math_Vector& InfBound, math_Vector& SupBound) const = 0;
Standard_EXPORT virtual Standard_Boolean IsSolution(const math_Vector& Sol,
const Standard_Real Tol) = 0;
- //! Returns the minimal Distance between two
+ //! Returns the minimal Distance between two
//! extremities of calculated sections.
Standard_EXPORT Standard_Real GetMinimalDistance() const;
//! Returns the point on the first support.
Standard_EXPORT const gp_Pnt& Pnt1() const;
- //! Returns the point on the seconde support.
+ //! Returns the point on the second support.
Standard_EXPORT const gp_Pnt& Pnt2() const;
//! Returns the point on the surface.
//! Returns U,V coordinates of the point on the surface.
Standard_EXPORT virtual const gp_Pnt2d& Pnt2dOnS() const = 0;
- //! Returns U,V coordinates of the point on the curve on
+ //! Returns U,V coordinates of the point on the curve on
//! surface.
Standard_EXPORT virtual const gp_Pnt2d& Pnt2dOnRst() const = 0;
//! parametric space of the second surface.
Standard_EXPORT virtual const gp_Vec2d& Tangent2dOnRst() const = 0;
- //! Enables implementation of a criterion of decrochage
- //! specific to the function.
+ //! Enables implementation of a criterion of decrochage
+ //! specific to the function.
Standard_EXPORT virtual Standard_Boolean Decroch(const math_Vector& Sol,
gp_Vec& NS,
gp_Vec& TgS) const = 0;
- //! Returns if the section is rational
+ //! Returns if the section is rational
Standard_EXPORT virtual Standard_Boolean IsRational() const = 0;
//! Returns the length of the maximum section
//! of all sections.
Standard_EXPORT virtual void GetMinimalWeight(TColStd_Array1OfReal& Weigths) const = 0;
- //! Returns the number of intervals for continuity
+ //! Returns the number of intervals for continuity
//! <S>. May be one if Continuity(me) >= <S>
Standard_EXPORT virtual Standard_Integer NbIntervals(const GeomAbs_Shape S) const = 0;
- //! Stores in <T> the parameters bounding the intervals
+ //! Stores in <T> the parameters bounding the intervals
//! of continuity <S>.
//!
- //! The array must provide enough room to accommodate
+ //! The array must provide enough room to accommodate
//! for the parameters. i.e. T.Length() > NbIntervals()
Standard_EXPORT virtual void Intervals(TColStd_Array1OfReal& T, const GeomAbs_Shape S) const = 0;
const Standard_Real AngleMax,
TColStd_Array1OfReal& Weigths);
- //! Used to obtain the next level of continuity.
+ //! Used to obtain the next level of continuity.
Standard_EXPORT static GeomAbs_Shape NextShape(const GeomAbs_Shape S);
Standard_EXPORT static Standard_Boolean ComputeNormal(const Handle(Adaptor3d_Surface)& Surf,
DEFINE_STANDARD_ALLOC
//! Creates a function for a circular blending between
- //! a curve <C> and a surface <S>. The direction of
- //! the planes are given by <CGuide>. The position of
- //! the plane is determined on the curve <C>. <L>
- //! defines the change of parameter between <C> and
- //! <CGuide>. So, the planes are defined as described
- //! below :
+ //! a curve <C> and a surface <S>. The direction of
+ //! the planes are given by <CGuide>. The position of
+ //! the plane is determined on the curve <C>. <L>
+ //! defines the change of parameter between <C> and
+ //! <CGuide>. So, the planes are defined as described
+ //! below:
//! t is the current parameter on the guide line.
//! Pguide = C(L(t)); Nguide = CGuide'(t)/||CGuide'(t)||
Standard_EXPORT BlendFunc_CSCircular(const Handle(Adaptor3d_Surface)& S,
//! of all sections.
Standard_EXPORT void GetMinimalWeight(TColStd_Array1OfReal& Weigths) const Standard_OVERRIDE;
- //! Returns the number of intervals for continuity
+ //! Returns the number of intervals for continuity
//! <S>. May be one if Continuity(me) >= <S>
Standard_EXPORT Standard_Integer NbIntervals(const GeomAbs_Shape S) const Standard_OVERRIDE;
//! Stores in <T> the parameters bounding the intervals
//! of continuity <S>.
//!
- //! The array must provide enough room to accommodate
+ //! The array must provide enough room to accommodate
//! for the parameters. i.e. T.Length() > NbIntervals()
//! raises
//! OutOfRange from Standard
Standard_EXPORT void Set(const Standard_Real Radius, const Standard_Integer Choix);
- //! Sets the type of section generation for the
+ //! Sets the type of section generation for the
//! approximations.
Standard_EXPORT void Set(const BlendFunc_SectionShape TypeSection);
TColgp_Array1OfPnt& tabP,
TColgp_Array1OfVec& tabV);
- //! Returns if the section is rational
+ //! Returns if the section is rational
Standard_EXPORT Standard_Boolean IsRational() const Standard_OVERRIDE;
//! Returns the length of the maximum section
//! of all sections.
Standard_EXPORT void GetMinimalWeight(TColStd_Array1OfReal& Weigths) const Standard_OVERRIDE;
- //! Returns the number of intervals for continuity
+ //! Returns the number of intervals for continuity
//! <S>. May be one if Continuity(me) >= <S>
Standard_EXPORT Standard_Integer NbIntervals(const GeomAbs_Shape S) const Standard_OVERRIDE;
- //! Stores in <T> the parameters bounding the intervals
+ //! Stores in <T> the parameters bounding the intervals
//! of continuity <S>.
- //! The array must provide enough room to accommodate
+ //! The array must provide enough room to accommodate
//! for the parameters. i.e. T.Length() > NbIntervals()
//! raises
//! OutOfRange from Standard
Standard_EXPORT Standard_Boolean IsSolution(const math_Vector& Sol,
const Standard_Real Tol) Standard_OVERRIDE;
- //! Returns the minimal Distance between two
+ //! Returns the minimal Distance between two
//! extremities of calculated sections.
Standard_EXPORT Standard_Real GetMinimalDistance() const Standard_OVERRIDE;
//! of all sections.
Standard_EXPORT void GetMinimalWeight(TColStd_Array1OfReal& Weigths) const Standard_OVERRIDE;
- //! Returns the number of intervals for continuity
+ //! Returns the number of intervals for continuity
//! <S>. May be one if Continuity(me) >= <S>
Standard_EXPORT Standard_Integer NbIntervals(const GeomAbs_Shape S) const Standard_OVERRIDE;
- //! Stores in <T> the parameters bounding the intervals
+ //! Stores in <T> the parameters bounding the intervals
//! of continuity <S>.
//!
- //! The array must provide enough room to accommodate
+ //! The array must provide enough room to accommodate
//! for the parameters. i.e. T.Length() > NbIntervals()
Standard_EXPORT void Intervals(TColStd_Array1OfReal& T,
const GeomAbs_Shape S) const Standard_OVERRIDE;
Standard_EXPORT Standard_Boolean IsSolution(const math_Vector& Sol,
const Standard_Real Tol) Standard_OVERRIDE;
- //! Returns the minimal Distance between two
+ //! Returns the minimal Distance between two
//! extremities of calculated sections.
Standard_EXPORT Standard_Real GetMinimalDistance() const Standard_OVERRIDE;
//! Inits the value of radius, and the "quadrant".
Standard_EXPORT void Set(const Standard_Real Radius, const Standard_Integer Choix);
- //! Sets the type of section generation for the
+ //! Sets the type of section generation for the
//! approximations.
Standard_EXPORT void Set(const BlendFunc_SectionShape TypeSection);
- //! Utile pour une visu rapide et approximative de la surface.
+ //! Useful for a quick and approximate visualization of the surface area.
Standard_EXPORT void Section(const Standard_Real Param,
const Standard_Real U1,
const Standard_Real V1,
Standard_Real& Pfin,
gp_Circ& C);
- //! Returns if the section is rational
+ //! Returns if the section is rational
Standard_EXPORT Standard_Boolean IsRational() const Standard_OVERRIDE;
//! Returns the length of the maximum section
//! of all sections.
Standard_EXPORT void GetMinimalWeight(TColStd_Array1OfReal& Weigths) const Standard_OVERRIDE;
- //! Returns the number of intervals for continuity
+ //! Returns the number of intervals for continuity
//! <S>. May be one if Continuity(me) >= <S>
Standard_EXPORT Standard_Integer NbIntervals(const GeomAbs_Shape S) const Standard_OVERRIDE;
- //! Stores in <T> the parameters bounding the intervals
+ //! Stores in <T> the parameters bounding the intervals
//! of continuity <S>.
//!
- //! The array must provide enough room to accommodate
+ //! The array must provide enough room to accommodate
//! for the parameters. i.e. T.Length() > NbIntervals()
Standard_EXPORT void Intervals(TColStd_Array1OfReal& T,
const GeomAbs_Shape S) const Standard_OVERRIDE;
//! This function calculates point (pts) on the curve of
//! intersection between the normal to a curve (guide)
-//! in a chosen parameter and a surface (surf), so
+//! in a chosen parameter and a surface (surf), so
//! that pts was at a given distance from the guide.
//! X(1),X(2) are the parameters U,V of pts on surf.
class BlendFunc_Corde
Standard_EXPORT Standard_Boolean IsSolution(const math_Vector& Sol,
const Standard_Real Tol) Standard_OVERRIDE;
- //! Returns the minimal Distance between two
+ //! Returns the minimal Distance between two
//! extremities of calculated sections.
Standard_EXPORT Standard_Real GetMinimalDistance() const Standard_OVERRIDE;
//! of all sections.
Standard_EXPORT void GetMinimalWeight(TColStd_Array1OfReal& Weigths) const Standard_OVERRIDE;
- //! Returns the number of intervals for continuity
+ //! Returns the number of intervals for continuity
//! <S>. May be one if Continuity(me) >= <S>
Standard_EXPORT Standard_Integer NbIntervals(const GeomAbs_Shape S) const Standard_OVERRIDE;
- //! Stores in <T> the parameters bounding the intervals
+ //! Stores in <T> the parameters bounding the intervals
//! of continuity <S>.
//!
- //! The array must provide enough room to accommodate
+ //! The array must provide enough room to accommodate
//! for the parameters. i.e. T.Length() > NbIntervals()
Standard_EXPORT void Intervals(TColStd_Array1OfReal& T,
const GeomAbs_Shape S) const Standard_OVERRIDE;
Standard_EXPORT void GetBounds(math_Vector& InfBound,
math_Vector& SupBound) const Standard_OVERRIDE;
- //! Returns the minimal Distance between two
+ //! Returns the minimal Distance between two
//! extremities of calculated sections.
Standard_EXPORT Standard_Real GetMinimalDistance() const Standard_OVERRIDE;
//! of all sections.
Standard_EXPORT void GetMinimalWeight(TColStd_Array1OfReal& Weigths) const Standard_OVERRIDE;
- //! Returns the number of intervals for continuity
+ //! Returns the number of intervals for continuity
//! <S>. May be one if Continuity(me) >= <S>
Standard_EXPORT Standard_Integer NbIntervals(const GeomAbs_Shape S) const Standard_OVERRIDE;
- //! Stores in <T> the parameters bounding the intervals
+ //! Stores in <T> the parameters bounding the intervals
//! of continuity <S>.
//!
- //! The array must provide enough room to accommodate
+ //! The array must provide enough room to accommodate
//! for the parameters. i.e. T.Length() > NbIntervals()
//! raises
//! OutOfRange from Standard
Standard_EXPORT Standard_Boolean IsSolution(const math_Vector& Sol,
const Standard_Real Tol) Standard_OVERRIDE;
- //! Returns the minimal Distance between two
+ //! Returns the minimal Distance between two
//! extremities of calculated sections.
Standard_EXPORT Standard_Real GetMinimalDistance() const Standard_OVERRIDE;
//! of all sections.
Standard_EXPORT void GetMinimalWeight(TColStd_Array1OfReal& Weigths) const Standard_OVERRIDE;
- //! Returns the number of intervals for continuity
+ //! Returns the number of intervals for continuity
//! <S>. May be one if Continuity(me) >= <S>
Standard_EXPORT Standard_Integer NbIntervals(const GeomAbs_Shape S) const Standard_OVERRIDE;
- //! Stores in <T> the parameters bounding the intervals
+ //! Stores in <T> the parameters bounding the intervals
//! of continuity <S>.
//!
- //! The array must provide enough room to accommodate
+ //! The array must provide enough room to accommodate
//! for the parameters. i.e. T.Length() > NbIntervals()
- //! raises
- //! OutOfRange from Standard
+ //! raises OutOfRange from Standard
Standard_EXPORT void Intervals(TColStd_Array1OfReal& T,
const GeomAbs_Shape S) const Standard_OVERRIDE;
#include <math_NewtonMinimum.hxx>
class math_MultipleVarFunctionWithHessian;
-//! Algorithme of Optimization used to make "FairCurve"
+//! Algorithm of Optimization used to make "FairCurve"
class FairCurve_Newton : public math_NewtonMinimum
{
public:
DEFINE_STANDARD_ALLOC
- //! The tolerance required on the solution is given by Tolerance.
- //! Iteration are stopped if (!WithSingularity) and H(F(Xi)) is not definite
- //! positive (if the smaller eigenvalue of H < Convexity)
+ //! The tolerance required on the solution is given by Tolerance.
+ //! Iteration are stopped if (!WithSingularity) and H(F(Xi)) is not definite
+ //! positive (if the smaller eigenvalue of H < Convexity)
//! or IsConverged() returns True for 2 successives Iterations.
//! Warning: This constructor do not computation
Standard_EXPORT FairCurve_Newton(const math_MultipleVarFunctionWithHessian& theFunction,
const Standard_Real theConvexity = 1.0e-6,
const Standard_Boolean theWithSingularity = Standard_True);
- //! This method is called at the end of each
- //! iteration to check the convergence :
+ //! This method is called at the end of each
+ //! iteration to check the convergence:
//! || Xi+1 - Xi || < SpatialTolerance/100 Or
//! || Xi+1 - Xi || < SpatialTolerance and
//! |F(Xi+1) - F(Xi)| < CriteriumTolerance * |F(xi)|
{
public:
- //! Create a Blend with a constant radius with 2
- //! guide-line. <FShape> sets the type of fillet
- //! surface. The -- default value is Convert_TgtThetaOver2 (classical --
- //! nurbs -- representation of circles).
- //! ChFi3d_QuasiAngular -- corresponds to a nurbs
- //! representation of circles -- which
- //! parameterisation matches the circle one. --
- //! ChFi3d_Polynomial corresponds to a polynomial --
- //! representation of circles.
+ //! Create a Blend with a constant radius with 2
+ //! guide-line. <FShape> sets the type of fillet
+ //! surface. The default value is Convert_TgtThetaOver2
+ //! (classical nurbs representation of circles).
+ //! ChFi3d_QuasiAngular corresponds to a nurbs
+ //! representation of circles which parameterisation
+ //! matches the circle one. ChFi3d_Polynomial
+ //! corresponds to a polynomial representation of
+ //! circles.
Standard_EXPORT GeomFill_CircularBlendFunc(const Handle(Adaptor3d_Curve)& Path,
const Handle(Adaptor3d_Curve)& Curve1,
const Handle(Adaptor3d_Curve)& Curve2,
TColgp_Array1OfPnt2d& Poles2d,
TColStd_Array1OfReal& Weigths) Standard_OVERRIDE;
- //! compute the first derivative in v direction of the
+ //! compute the first derivative in v direction of the
//! section for v = param
Standard_EXPORT virtual Standard_Boolean D1(const Standard_Real Param,
const Standard_Real First,
TColStd_Array1OfReal& Weigths,
TColStd_Array1OfReal& DWeigths) Standard_OVERRIDE;
- //! compute the second derivative in v direction of the
- //! section for v = param
+ //! compute the second derivative in v direction of the
+ //! section for v = param
Standard_EXPORT virtual Standard_Boolean D2(const Standard_Real Param,
const Standard_Real First,
const Standard_Real Last,
TColStd_Array1OfReal& DWeigths,
TColStd_Array1OfReal& D2Weigths) Standard_OVERRIDE;
- //! get the number of 2d curves to approximate.
+ //! get the number of 2d curves to approximate.
Standard_EXPORT virtual Standard_Integer Nb2dCurves() const Standard_OVERRIDE;
- //! get the format of an section
+ //! get the format of an section
Standard_EXPORT virtual void SectionShape(Standard_Integer& NbPoles,
Standard_Integer& NbKnots,
Standard_Integer& Degree) const Standard_OVERRIDE;
//! Returns if the section is rational or not
Standard_EXPORT virtual Standard_Boolean IsRational() const Standard_OVERRIDE;
- //! Returns the number of intervals for continuity
+ //! Returns the number of intervals for continuity
//! <S>. May be one if Continuity(me) >= <S>
Standard_EXPORT virtual Standard_Integer NbIntervals(const GeomAbs_Shape S) const
Standard_OVERRIDE;
- //! Stores in <T> the parameters bounding the intervals
+ //! Stores in <T> the parameters bounding the intervals
//! of continuity <S>.
//!
- //! The array must provide enough room to accommodate
+ //! The array must provide enough room to accommodate
//! for the parameters. i.e. T.Length() > NbIntervals()
Standard_EXPORT virtual void Intervals(TColStd_Array1OfReal& T,
const GeomAbs_Shape S) const Standard_OVERRIDE;
const Standard_Real AngleTol,
TColStd_Array1OfReal& Tol3d) const Standard_OVERRIDE;
- //! Is usfull, if (me) have to be run numerical
- //! algorithme to perform D0, D1 or D2
+ //! Is useful, if (me) have to be run numerical
+ //! algorithm to perform D0, D1 or D2
Standard_EXPORT virtual void SetTolerance(const Standard_Real Tol3d,
const Standard_Real Tol2d) Standard_OVERRIDE;
- //! Get the barycentre of Surface. An very poor
+ //! Get the barycentre of Surface. An very poor
//! estimation is sufficient. This information is useful
//! to perform well conditioned rational approximation.
Standard_EXPORT virtual gp_Pnt BarycentreOfSurf() const Standard_OVERRIDE;
- //! Returns the length of the maximum section. This
+ //! Returns the length of the maximum section. This
//! information is useful to perform well conditioned rational
//! approximation.
Standard_EXPORT virtual Standard_Real MaximalSection() const Standard_OVERRIDE;
//! Compute the minimal value of weight for each poles
- //! of all sections. This information is useful to
+ //! of all sections. This information is useful to
//! perform well conditioned rational approximation.
Standard_EXPORT virtual void GetMinimalWeight(TColStd_Array1OfReal& Weigths) const
Standard_OVERRIDE;
class GeomFill_ConstantBiNormal;
DEFINE_STANDARD_HANDLE(GeomFill_ConstantBiNormal, GeomFill_TrihedronLaw)
-//! Defined an Trihedron Law where the BiNormal, is fixed
+//! Defined a Trihedron Law where the BiNormal, is fixed
class GeomFill_ConstantBiNormal : public GeomFill_TrihedronLaw
{
gp_Vec& Normal,
gp_Vec& BiNormal) Standard_OVERRIDE;
- //! Computes Triedrhon and derivative Trihedron on curve
+ //! Computes Triedrhon and derivative Trihedron on curve
//! at parameter <Param>
- //! Warning : It used only for C1 or C2 approximation
+ //! Warning: It used only for C1 or C2 approximation
Standard_EXPORT virtual Standard_Boolean D1(const Standard_Real Param,
gp_Vec& Tangent,
gp_Vec& DTangent,
gp_Vec& BiNormal,
gp_Vec& DBiNormal) Standard_OVERRIDE;
- //! compute Trihedron on curve
- //! first and seconde derivatives.
- //! Warning : It used only for C2 approximation
+ //! compute Trihedron on curve
+ //! first and second derivatives.
+ //! Warning: It used only for C2 approximation
Standard_EXPORT virtual Standard_Boolean D2(const Standard_Real Param,
gp_Vec& Tangent,
gp_Vec& DTangent,
gp_Vec& DBiNormal,
gp_Vec& D2BiNormal) Standard_OVERRIDE;
- //! Returns the number of intervals for continuity
- //! <S>.
+ //! Returns the number of intervals for continuity <S>.
//! May be one if Continuity(me) >= <S>
Standard_EXPORT virtual Standard_Integer NbIntervals(const GeomAbs_Shape S) const
Standard_OVERRIDE;
- //! Stores in <T> the parameters bounding the intervals
+ //! Stores in <T> the parameters bounding the intervals
//! of continuity <S>.
//!
- //! The array must provide enough room to accommodate
+ //! The array must provide enough room to accommodate
//! for the parameters. i.e. T.Length() > NbIntervals()
Standard_EXPORT virtual void Intervals(TColStd_Array1OfReal& T,
const GeomAbs_Shape S) const Standard_OVERRIDE;
- //! Gets average value of Tangent(t) and Normal(t) it is usfull to
- //! make fast approximation of rational surfaces.
+ //! Gets average value of Tangent(t) and Normal(t) it is useful to
+ //! make fast approximation of rational surfaces.
Standard_EXPORT virtual void GetAverageLaw(gp_Vec& ATangent,
gp_Vec& ANormal,
gp_Vec& ABiNormal) Standard_OVERRIDE;
//! the curve must be set by method SetCurve.
Standard_EXPORT GeomFill_Trihedron EvaluateBestMode();
- //! Get average value of Tangent(t) and Normal(t) it is usfull to
+ //! Get average value of Tangent(t) and Normal(t) it is useful to
//! make fast approximation of rational surfaces.
Standard_EXPORT virtual void GetAverageLaw(gp_Vec& ATangent,
gp_Vec& ANormal,
Standard_Real& Last) const Standard_OVERRIDE;
//! Get the maximum Norm of the matrix-location part. It
- //! is usful to find an good Tolerance to approx M(t).
+ //! is usful to find a good Tolerance to approx M(t).
Standard_EXPORT virtual Standard_Real GetMaximalNorm() Standard_OVERRIDE;
- //! Get average value of M(t) and V(t) it is usfull to
+ //! Get average value of M(t) and V(t) it is useful to
//! make fast approximation of rational surfaces.
Standard_EXPORT virtual void GetAverageLaw(gp_Mat& AM, gp_Vec& AV) Standard_OVERRIDE;
Standard_EXPORT virtual void Intervals(TColStd_Array1OfReal& T,
const GeomAbs_Shape S) const Standard_OVERRIDE;
- //! Get average value of Tangent(t) and Normal(t) it is usfull to
+ //! Get average value of Tangent(t) and Normal(t) it is useful to
//! make fast approximation of rational surfaces.
Standard_EXPORT virtual void GetAverageLaw(gp_Vec& ATangent,
gp_Vec& ANormal,
Standard_EXPORT virtual void Intervals(TColStd_Array1OfReal& T,
const GeomAbs_Shape S) const Standard_OVERRIDE;
- //! Get average value of Tangent(t) and Normal(t) it is usfull to
+ //! Get average value of Tangent(t) and Normal(t) it is useful to
//! make fast approximation of rational surfaces.
Standard_EXPORT virtual void GetAverageLaw(gp_Vec& ATangent,
gp_Vec& ANormal,
Standard_EXPORT virtual void Intervals(TColStd_Array1OfReal& T,
const GeomAbs_Shape S) const Standard_OVERRIDE;
- //! Get average value of Tangent(t) and Normal(t) it is usfull to
+ //! Get average value of Tangent(t) and Normal(t) it is useful to
//! make fast approximation of rational surfaces.
Standard_EXPORT virtual void GetAverageLaw(gp_Vec& ATangent,
gp_Vec& ANormal,
Standard_EXPORT virtual void SetInterval(const Standard_Real First,
const Standard_Real Last) Standard_OVERRIDE;
- //! Get average value of M(t) and V(t) it is usfull to
+ //! Get average value of M(t) and V(t) it is useful to
//! make fast approximation of rational surfaces.
Standard_EXPORT virtual void GetAverageLaw(gp_Vec& ATangent,
gp_Vec& ANormal,
Standard_EXPORT virtual void Intervals(TColStd_Array1OfReal& T,
const GeomAbs_Shape S) const Standard_OVERRIDE;
- //! Get average value of M(t) and V(t) it is usfull to
+ //! Get average value of M(t) and V(t) it is useful to
//! make fast approximation of rational surfaces.
Standard_EXPORT virtual void GetAverageLaw(gp_Vec& ATangent,
gp_Vec& ANormal,
Standard_Real& Last) const Standard_OVERRIDE;
//! Returns the resolutions in the sub-space 2d <Index>
- //! This information is usfull to find an good tolerance in
+ //! This information is useful to find a good tolerance in
//! 2d approximation.
//! Warning: Used only if Nb2dCurve > 0
Standard_EXPORT virtual void Resolution(const Standard_Integer Index,
Standard_Real& TolV) const Standard_OVERRIDE;
//! Get the maximum Norm of the matrix-location part. It
- //! is usful to find an good Tolerance to approx M(t).
+ //! is usful to find a good Tolerance to approx M(t).
Standard_EXPORT virtual Standard_Real GetMaximalNorm() Standard_OVERRIDE;
- //! Get average value of M(t) and V(t) it is usfull to
+ //! Get average value of M(t) and V(t) it is useful to
//! make fast approximation of rational surfaces.
Standard_EXPORT virtual void GetAverageLaw(gp_Mat& AM, gp_Vec& AV) Standard_OVERRIDE;
const Standard_Real Tol2d) Standard_OVERRIDE;
//! Returns the resolutions in the sub-space 2d <Index>
- //! This information is usfull to find an good tolerance in
+ //! This information is useful to find a good tolerance in
//! 2d approximation.
//! Warning: Used only if Nb2dCurve > 0
Standard_EXPORT virtual void Resolution(const Standard_Integer Index,
Standard_Real& TolV) const Standard_OVERRIDE;
//! Get the maximum Norm of the matrix-location part. It
- //! is usful to find an good Tolerance to approx M(t).
+ //! is usful to find a good Tolerance to approx M(t).
Standard_EXPORT virtual Standard_Real GetMaximalNorm() Standard_OVERRIDE;
- //! Get average value of M(t) and V(t) it is usfull to
+ //! Get average value of M(t) and V(t) it is useful to
//! make fast approximation of rational surfaces.
Standard_EXPORT virtual void GetAverageLaw(gp_Mat& AM, gp_Vec& AV) Standard_OVERRIDE;
Standard_EXPORT virtual void GetDomain(Standard_Real& First, Standard_Real& Last) const = 0;
//! Returns the resolutions in the sub-space 2d <Index>
- //! This information is usfull to find an good tolerance in
+ //! This information is useful to find a good tolerance in
//! 2d approximation.
Standard_EXPORT virtual void Resolution(const Standard_Integer Index,
const Standard_Real Tol,
Standard_EXPORT virtual void SetTolerance(const Standard_Real Tol3d, const Standard_Real Tol2d);
//! Get the maximum Norm of the matrix-location part. It
- //! is usful to find an good Tolerance to approx M(t).
+ //! is usful to find a good Tolerance to approx M(t).
Standard_EXPORT virtual Standard_Real GetMaximalNorm() = 0;
- //! Get average value of M(t) and V(t) it is usfull to
+ //! Get average value of M(t) and V(t) it is useful to
//! make fast approximation of rational surfaces.
Standard_EXPORT virtual void GetAverageLaw(gp_Mat& AM, gp_Vec& AV) = 0;
const Standard_Real Last) Standard_OVERRIDE;
//! Returns the resolutions in the sub-space 2d <Index>
- //! This information is usfull to find an good tolerance in
+ //! This information is useful to find a good tolerance in
//! 2d approximation.
//! Warning: Used only if Nb2dCurve > 0
Standard_EXPORT virtual void Resolution(const Standard_Integer Index,
const Standard_Real AngleTol,
TColStd_Array1OfReal& Tol3d) const Standard_OVERRIDE;
- //! Is usfull, if (me) have to be run numerical
+ //! Is useful, if (me) have to be run numerical
//! algorithme to perform D0, D1 or D2
Standard_EXPORT virtual void SetTolerance(const Standard_Real Tol3d,
const Standard_Real Tol2d) Standard_OVERRIDE;
//! the function
Standard_EXPORT void GetInterval(Standard_Real& First, Standard_Real& Last);
- //! Get average value of M(t) and V(t) it is usfull to
+ //! Get average value of M(t) and V(t) it is useful to
//! make fast approximation of rational surfaces.
Standard_EXPORT virtual void GetAverageLaw(gp_Vec& ATangent,
gp_Vec& ANormal,
//! not possible to have a direction with null length.
Standard_EXPORT void Cross(const Handle(Geom_Vector)& Other) Standard_OVERRIDE;
- //! Computes the triple vector product <me> ^(V1 ^ V2).
+ //! Computes the triple vector product <me> ^(V1 ^ V2).
//!
//! Raised if V1 and V2 are parallel or <me> and (V1 ^ V2) are
//! parallel
//! Scales a Geometry. S is the scaling value.
Standard_EXPORT void Scale(const gp_Pnt& P, const Standard_Real S);
- //! Translates a Geometry. V is the vector of the translation.
+ //! Translates a Geometry. V is the vector of the translation.
Standard_EXPORT void Translate(const gp_Vec& V);
//! Translates a Geometry from the point P1 to the point P2.
//! - the "Y Direction" of A2 defines the minor axis
//! of the hyperbola, i.e. the minor radius
//! MinorRadius is measured along this axis,
- //! - A2 is the local coordinate system of the hyperbola.
+ //! - A2 is the local coordinate system of the hyperbola.
//! Exceptions
//! Standard_ConstructionError if:
//! - MajorRadius is less than 0.0,
Standard_EXPORT Standard_Real FirstParameter() const Standard_OVERRIDE;
//! Returns the value of the last parameter of this
- //! line. This is Standard_Real::RealLast().
+ //! line. This is Standard_Real::RealLast().
Standard_EXPORT Standard_Real LastParameter() const Standard_OVERRIDE;
//! returns False
const gp_Trsf& T) const
Standard_OVERRIDE;
- //! Returns a coefficient to compute the parameter on
+ //! Returns a coefficient to compute the parameter on
//! the transformed curve for the transform of the
//! point on <me>.
//!
//! @endcode
//! This method does not change <U> and <V>
//!
- //! It can be redefined. For example on the Plane,
+ //! It can be redefined. For example on the Plane,
//! Cylinder, Cone, Revolved and Extruded surfaces.
Standard_EXPORT virtual void TransformParameters(Standard_Real& U,
Standard_Real& V,
class Approx_SweepFunction;
class AdvApprox_Cutting;
-//! Approximation of an Surface S(u,v)
-//! (and eventually associate 2d Curves) defined
+//! Approximation of an Surface S(u,v)
+//! (and eventually associate 2d Curves) defined
//! by section's law.
//!
//! This surface is defined by a function F(u, v)
//! where Ft(u) = F(u, t) is a bspline curve.
-//! To use this algorithme, you have to implement Ft(u)
-//! as a derivative class of Approx_SweepFunction.
+//! To use this algorithm, you have to implement Ft(u)
+//! as a derivative class of Approx_SweepFunction.
//! This algorithm can be used by blending, sweeping...
class Approx_SweepApproximation
{
//! 2d curve approximation.
Standard_EXPORT Standard_Real Average2dError(const Standard_Integer Index) const;
- //! returns the maximum 3d error of the <Index>
+ //! returns the maximum 3d error of the <Index>
//! 2d curve approximation on the Surface.
Standard_EXPORT Standard_Real TolCurveOnSurf(const Standard_Integer Index) const;
Standard_EXPORT virtual void SetInterval(const Standard_Real First, const Standard_Real Last) = 0;
//! Returns the resolutions in the sub-space 2d <Index>
- //! This information is usfull to find an good tolerance in
+ //! This information is useful to find a good tolerance in
//! 2d approximation.
Standard_EXPORT virtual void Resolution(const Standard_Integer Index,
const Standard_Real Tol,
public:
DEFINE_STANDARD_ALLOC
- //! Initialize the algorithme
+ //! Initialize the algorithm
//! - Parameterisation is used to convert
Standard_EXPORT Geom2dConvert_CompCurveToBSplineCurve(
const Convert_ParameterisationType Parameterisation = Convert_TgtThetaOver2);
- //! Initialize the algorithme with one curve
+ //! Initialize the algorithm with one curve
//! - Parameterisation is used to convert
Standard_EXPORT Geom2dConvert_CompCurveToBSplineCurve(
const Handle(Geom2d_BoundedCurve)& BasisCurve,
public:
DEFINE_STANDARD_ALLOC
- //! Initialize the algorithme
+ //! Initialize the algorithm
//! - Parameterisation is used to convert
Standard_EXPORT GeomConvert_CompCurveToBSplineCurve(
const Convert_ParameterisationType Parameterisation = Convert_TgtThetaOver2);
- //! Initialize the algorithme with one curve
+ //! Initialize the algorithm with one curve
//! - Parameterisation is used to convert
Standard_EXPORT GeomConvert_CompCurveToBSplineCurve(
const Handle(Geom_BoundedCurve)& BasisCurve,
const Convert_ParameterisationType Parameterisation = Convert_TgtThetaOver2);
- //! Append a curve in the BSpline Return False if the
- //! curve is not G0 with the BSplineCurve. Tolerance
- //! is used to check continuity and decrease
+ //! Append a curve in the BSpline Return False if the
+ //! curve is not G0 with the BSplineCurve. Tolerance
+ //! is used to check continuity and decrease
//! Multiplicity at the common Knot until MinM
//! if MinM = 0, the common Knot can be removed
//!
projects / occt.git / commitdiff