//! Returns True if the label is not used by any assembly, i.e.
//! contains sublabels which are assembly components
//! This is relevant only if IsShape() is True
- //! (There is no Father TreeNode on this <L>)
+ //! (There is no Father TreeNode on this <L>)
Standard_EXPORT static Standard_Boolean IsFree(const TDF_Label& L);
//! Returns True if the label represents a shape (simple shape,
const TDF_LabelSequence& theGDTs,
const TDF_Label& theViewL) const;
- //! Set Clipping planes to given View
+ //! Set Clipping planes to given View
Standard_EXPORT void SetClippingPlanes(const TDF_LabelSequence& theClippingPlaneLabels,
const TDF_Label& theViewL) const;
//! Performs a Read Operation from a file to a WorkSession
//! i.e. calls ReadFile, then ReadSession and ReadEnd
//! Returned Value is : 0 for OK, -1 File could not be opened,
- //! >0 Error during Read (see WriteSession)
+ //! >0 Error during Read (see WriteSession)
//! IsDone can be called too (will return True for OK)
Standard_EXPORT Standard_Integer Read(const Standard_CString filename);
//! -> such a command may be called :
//! - directly, it will add an item with no name
//! - by command xset, in the following form :
-//! xset name command ... calls the command and adds the item
+//! xset name command ... calls the command and adds the item
//! to the session under the specified name (if not yet known)
//!
//! Thus, to a specific Norm or way of working, only Activators
//! Changes the mode of working with the selection :
//! -1 just clears optimisation data and nothing else
- //! 0 clears it 1 inhibits it for computing (but no clearing)
+ //! 0 clears it
+ //! 1 inhibits it for computing (but no clearing)
//! 2 sets it active for computing
//! Default at creation is 0, after SetSelection (not null) is 2
Standard_EXPORT void SetSelMode(const Standard_Integer selmode);
//! Returns the predefined list of possible cases, filled by AddCase
//! Null Handle if no predefined list (hence, to be counted)
- //! Useful to filter on really possible vase, for instance, or
+ //! Useful to filter on really possible vase, for instance, or
//! for a help
Standard_EXPORT Handle(TColStd_HSequenceOfAsciiString) CaseList() const;
Standard_EXPORT IFSelect_TransformStandard();
//! Sets the Copy option to a new value :
- //! - True for StandardCopy - False for OnTheSpot
+ //! True for StandardCopy. False for OnTheSpot
Standard_EXPORT void SetCopyOption(const Standard_Boolean option);
//! Returns the Copy option
//! Drawing (Drawing, Views, Annotations, Pictures, Sketches ...)
//! Structure (Component & Part, Groups & Patterns ...)
//! Description (Meta-Data : Relations, Properties, Product ...)
-//! Auxiliary (those which do not enter in the above list)
+//! Auxiliary (those which do not enter in the above list)
//! and some dedicated categories
-//! FEA , Kinematics , Piping , etc...
-//! plus Professional for other dedicated non-classed categories
+//! FEA, Kinematics, Piping, etc...
+//! plus Professional for other dedicated non-classed categories
//!
//! In addition, this class provides a way to compute then quickly
//! query category numbers for an entire model.
Standard_EXPORT Interface_CheckStatus Status() const;
//! Tells if this check list complies with a given status :
- //! OK (i.e. empty), Warning (at least one Warning, but no Fail),
+ //! OK (i.e. empty), Warning (at least one Warning, but no Fail),
//! Fail (at least one), Message (not OK), NoFail, Any
Standard_EXPORT Standard_Boolean Complies(const Interface_CheckStatus status) const;
//! same as AddItem (kept for compatibility)
Standard_EXPORT void GetOneItem(const Handle(Standard_Transient)& anentity);
- //! Selects entities with are Kind of a given type, keep only
+ //! Selects entities with are Kind of a given type, keep only
//! them (is keep is True) or reject only them (if keep is False)
Standard_EXPORT void SelectType(const Handle(Standard_Type)& atype, const Standard_Boolean keep);
public:
DEFINE_STANDARD_ALLOC
- //! Creates a FloatWriter ready to work, with default options -
+ //! Creates a FloatWriter ready to work, with default options
//! - zero suppress option is set
//! - main format is set to "%E"
//! - secondary format is set to "%f" for values between 0.1 and
//! by an Interface) : Shared List, Check, Copy, Delete, Category
//!
//! To optimise processing (e.g. firstly bind an Entity to a Module
-//! then calls Module), each recognized Entity Type corresponds
+//! then calls Module), each recognized Entity Type corresponds
//! to a Case Number, determined by the Protocol each class of
//! GeneralModule belongs to.
class Interface_GeneralModule : public Standard_Transient
//! Same as above but directly on an Entity <ent> : if it is not
//! contained in the Model, returns False. Else calls
- //! IsPresent(num) with <num> given by EntityNumber
+ //! IsPresent(num) with <num> given by EntityNumber
Standard_EXPORT Standard_Boolean IsPresent(const Handle(Standard_Transient)& ent) const;
//! Returns mapped Entity given its no (if it is present)
//! Returns the Number of an Entity in the Model if it contains it.
//! Else returns 0. For a ReportEntity, looks at Concerned Entity.
- //! Returns the Directory entry Number of an Entity in
- //! the Model if it contains it. Else returns 0. For a
- //! ReportEntity, looks at Concerned Entity.
+ //! Returns the Directory entry Number of an Entity in
+ //! the Model if it contains it. Else returns 0.
+ //! For a ReportEntity, looks at Concerned Entity.
Standard_EXPORT Standard_Integer Number(const Handle(Standard_Transient)& anentity) const;
//! Returns an Entity identified by its number in the Model
//! with operator () attached to Value
//! Then, to have a translated message, write in C++ :
//!
- //! Interface_MSG("...mykey...") which returns a CString
+ //! Interface_MSG("...mykey...") which returns a CString
//! See also some help which follow
Standard_EXPORT Interface_MSG(const Standard_CString key);
//! then AddFail(mess);
//! replaced by AddFail (Interface_MSG("code",ival));
//!
- //! The basic message is intended to be in C-Sprintf format,
+ //! The basic message is intended to be in C-Sprintf format,
//! with one %d form in it
Standard_EXPORT Interface_MSG(const Standard_CString key, const Standard_Integer i1);
//! Translates a message which contains two integer variables
//! As for one integer, it is just a writing help
//!
- //! The basic message is intended to be in C-Sprintf format
+ //! The basic message is intended to be in C-Sprintf format
//! with two %d forms in it
Standard_EXPORT Interface_MSG(const Standard_CString key,
const Standard_Integer i1,
//! interval (see below, method Intervals)
//! As for one integer, it is just a writing help
//!
- //! The basic message is intended to be in C-Sprintf format
+ //! The basic message is intended to be in C-Sprintf format
//! with one %f form (or equivalent : %e etc) in it
Standard_EXPORT Interface_MSG(const Standard_CString key,
const Standard_Real r1,
//! Translates a message which contains one string variable
//! As for one integer, it is just a writing help
//!
- //! The basic message is intended to be in C-Sprintf format
+ //! The basic message is intended to be in C-Sprintf format
//! with one %s form in it
Standard_EXPORT Interface_MSG(const Standard_CString key, const Standard_CString str);
//! As for one integer, it is just a writing help
//! Used for instance to say "Param n0.<ival> i.e. <str> is not.."
//!
- //! The basic message is intended to be in C-Sprintf format
+ //! The basic message is intended to be in C-Sprintf format
//! with one %d then one %s forms in it
Standard_EXPORT Interface_MSG(const Standard_CString key,
const Standard_Integer ival,
const Standard_Boolean upper = Standard_False);
//! Codes a date as a text, from its numeric value (-> seconds) :
- //! YYYY-MM-DD:HH-MN-SS fixed format, completed by leading zeros
+ //! YYYY-MM-DD:HH-MN-SS fixed format, completed by leading zeros
//! Another format can be provided, as follows :
- //! C:%d ... C like format, preceded by C:
+ //! C:%d ... C like format, preceded by C:
//! S:... format to call system (not yet implemented)
Standard_EXPORT static void TDate(const Standard_CString text,
const Standard_Integer yy,
//! Assigns the value <Value> to the <Index>-th item of this array.
Standard_EXPORT void SetValue(const Standard_Integer Index, const Interface_FileParameter& Value);
- //! Return the value of the <Index>th element of the
+ //! Return the value of the <Index>th element of the
//! array.
Standard_EXPORT const Interface_FileParameter& Value(const Standard_Integer Index) const;
return Value(Index);
}
- //! return the value of the <Index>th element of the
+ //! return the value of the <Index>th element of the
//! array.
Standard_EXPORT Interface_FileParameter& ChangeValue(const Standard_Integer Index);
//! - Name
//! - Family,
//! - Wildcard (if it has one)
- //! - Current status (empty string if it was updated or
+ //! - Current status (empty string if it was updated or
//! if it is the original one)
//! - Value
Standard_EXPORT void PrintStatic(Standard_OStream& S) const;
const Standard_CString name = "");
//! Adds the CPU time between lastCPU and now
- //! if <curCPU> is given, the CPU amount is curCPU-lastCPU
+ //! if <curCPU> is given, the CPU amount is curCPU-lastCPU
//! else it is currently measured CPU - lastCPU
//! lastCPU has been read by call to GetCPU
//! See GetCPU to get amount, and LargeCPU to test large amount
//!
//! Transient from Standard defines the class to be keyed
//! MapTransientHasher from TColStd is the associated Hasher
-//! DataInfo from MoniTool is an additional class which helps to provide
+//! DataInfo from MoniTool is an additional class which helps to provide
//! information on the value (template : see DataInfo)
class MoniTool_TransientElem : public MoniTool_Element
{
//! For an enumeration, precises the starting value (default 0)
//! and the match condition : if True (D), the string value must
//! match the definition, else it may take another value : in that
- //! case, the Integer Value will be Start - 1.
+ //! case, the Integer Value will be Start - 1.
//! (empty value remains allowed)
Standard_EXPORT void StartEnum(const Standard_Integer start = 0,
const Standard_Boolean match = Standard_True);
#include <Standard_Handle.hxx>
//! FindHasher defines HashCode for Finder, which is : ask a
-//! Finder its HashCode ! Because this is the Finder itself which
+//! Finder its HashCode! Because this is the Finder itself which
//! brings the HashCode for its Key
//!
//! This class complies to the template given in TCollection by
// szv:{ return mySignType; }
//! Returns the WorkLibrary attached to the Norm. Remark that it
- //! has to be in phase with the Protocol (read from field)
+ //! has to be in phase with the Protocol (read from field)
const Handle(IFSelect_WorkLibrary)& WorkLibrary() const { return myAdaptorLibrary; }
//! Creates a new empty Model ready to receive data of the Norm
protected:
//! Initializing with names
- //! <theLongName> is for the complete, official, long name
+ //! <theLongName> is for the complete, official, long name
//! <theShortName> is for the short name used for resources
Standard_EXPORT XSControl_Controller(const Standard_CString theLongName,
const Standard_CString theShortName);
Standard_OStream& theS) const;
//! Sets a Transfer Reader, by internal ways, according mode :
- //! 0 recreates it clear, 1 clears it (does not recreate)
+ //! 0 recreates it clear
+ //! 1 clears it (does not recreate)
//! 2 aligns Roots of TransientProcess from final Results
//! 3 aligns final Results from Roots of TransientProcess
//! 4 begins a new transfer (by BeginTransfer)
class XmlXCAFDrivers
{
public:
- //! Depending from the ID, returns a list of storage
+ //! Depending from the ID, returns a list of storage
//! or retrieval attribute drivers. Used for plugin.
//!
//! Standard data model drivers
class XmlXCAFDrivers_DocumentStorageDriver;
DEFINE_STANDARD_HANDLE(XmlXCAFDrivers_DocumentStorageDriver, XmlDrivers_DocumentStorageDriver)
-//! storage driver of a XS document
+//! storage driver of a XS document
class XmlXCAFDrivers_DocumentStorageDriver : public XmlDrivers_DocumentStorageDriver
{
public:
DEFINE_STANDARD_ALLOC
- //! Search in draw directory the framewok identified
+ //! Search in draw directory the framewok identified
//! by its name <Name>. returns True if found. In that
//! case <DF> is set.
Standard_EXPORT static Standard_Boolean GetDF(Standard_CString& Name,
Handle(TDF_Data)& DF,
const Standard_Boolean Complain = Standard_True);
- //! Search in <DF> the label identified by its entry
- //! <Entry>. returns <True> if found. In that case
+ //! Search in <DF> the label identified by its entry
+ //! <Entry>. returns <True> if found. In that case
//! <Label> is set.
Standard_EXPORT static Standard_Boolean FindLabel(
const Handle(TDF_Data)& DF,
TDF_Label& Label,
const Standard_Boolean Complain = Standard_True);
- //! Search in <DF> the label identified by its entry
- //! <Entry>. if label doesn't exist, create and add
+ //! Search in <DF> the label identified by its entry
+ //! <Entry>. if label doesn't exist, create and add
//! the Label in <DF>. In that case return True.
Standard_EXPORT static Standard_Boolean AddLabel(const Handle(TDF_Data)& DF,
const Standard_CString Entry,
TDF_Label& Label);
- //! Search in <DF> the attribute identified by its
- //! <ID> and its <entry>. returns <True> if found. In
+ //! Search in <DF> the attribute identified by its
+ //! <ID> and its <entry>. returns <True> if found. In
//! that case A is set.
Standard_EXPORT static Standard_Boolean Find(const Handle(TDF_Data)& DF,
const Standard_CString Entry,
//! to set and get NamedShape
Standard_EXPORT static void NamedShapeCommands(Draw_Interpretor& I);
- //! to set and get Integer, Real, Reference, Geometry
+ //! to set and get Integer, Real, Reference, Geometry
Standard_EXPORT static void BasicCommands(Draw_Interpretor& I);
//! to set and get Datum attributes
Standard_EXPORT static void DatumCommands(Draw_Interpretor& I);
- //! to set and get Constraint and Constraint attributes
+ //! to set and get Constraint and Constraint attributes
Standard_EXPORT static void ConstraintCommands(Draw_Interpretor& I);
//! to set and get Objects attributes
Standard_EXPORT TDF_Label Label() const;
- //! Returns a string composed with the TreeNode of
+ //! Returns a string composed with the TreeNode of
//! <myLabel>.
Standard_EXPORT TCollection_AsciiString OpenRoot() const;
- //! Returns a string composed with the sub-TreeNodes of
+ //! Returns a string composed with the sub-TreeNodes of
//! <L>
Standard_EXPORT TCollection_AsciiString OpenNode(const TDF_Label& L) const;
class Standard_GUID;
class TDF_Attribute;
-//! This package provides Draw services to test CAF
+//! This package provides Draw services to test CAF
//! standard documents (see TDocStd package)
//!
//! It provides :
//! commands relatives to Naming
Standard_EXPORT static void SelectionCommands(Draw_Interpretor& DI);
- //! commands for testing Naming
+ //! commands for testing Naming
Standard_EXPORT static void ModelingCommands(Draw_Interpretor& DI);
};
class DNaming_BooleanOperationDriver;
DEFINE_STANDARD_HANDLE(DNaming_BooleanOperationDriver, TFunction_Driver)
-//! Driver for Fuse, Cut, Common
+//! Driver for Fuse, Cut, Common
class DNaming_BooleanOperationDriver : public TFunction_Driver
{
class DNaming_PointDriver;
DEFINE_STANDARD_HANDLE(DNaming_PointDriver, TFunction_Driver)
-//! Driver for PointXYZ and RelativePoint
+//! Driver for PointXYZ and RelativePoint
class DNaming_PointDriver : public TFunction_Driver
{
//! set/get position attribute
Standard_EXPORT static void BasicCommands(Draw_Interpretor& I);
- //! Loads all Draw commands of TKDCAF. Used for plugin.
+ //! Loads all Draw commands of TKDCAF. Used for plugin.
Standard_EXPORT static void Factory(Draw_Interpretor& theDI);
protected:
//! This package provides Drawable Dimensions.
//!
//! The classes PlanarDimension and subclasses provide
-//! services to build drawable dimensions between
+//! services to build drawable dimensions between
//! point line and circle in a given 3d plane.
//!
-//! The classes Dimension and subclasses provide
-//! services to build drawable dimensions between
+//! The classes Dimension and subclasses provide
+//! services to build drawable dimensions between
//! plane and cylindrical surfaces.
class DrawDim
{
#include <Draw_Interpretor.hxx>
#include <TopoDS_Shape.hxx>
-//! Used to display BRep objects using the DrawTrSurf
+//! Used to display BRep objects using the DrawTrSurf
//! package.
//! The DrawableShape is a Display object build from a
//! Shape.
class Poly_Triangulation;
class gp_Trsf;
-//! Drawable structure to display a shape. Contains a
+//! Drawable structure to display a shape. Contains a
//! list of edges and a list of faces.
class DBRep_DrawableShape : public Draw_Drawable3D
{
class Draw_Display;
class Draw_Color;
-//! This class stores all the information concerning
+//! This class stores all the information concerning
//! hidden lines on a view.
//!
//! * View number
//! * Type of projection, focal
//! * Arrays of 3d points
//!
-//! A drawable shape contains a list of such objects
-//! to store the hidden lines for each view. The
-//! IsSame method is used to check if hidden lines
+//! A drawable shape contains a list of such objects
+//! to store the hidden lines for each view. The
+//! IsSame method is used to check if hidden lines
//! must be recompiled.
class DBRep_HideData
{
//! This package supports the display of parametric curves and surfaces.
//!
-//! The Drawable deferred classes is inherited from
-//! the Drawable3D class from the package Draw, it
-//! adds methods to draw 3D Curves and Curves on 3D
+//! The Drawable deferred classes is inherited from
+//! the Drawable3D class from the package Draw, it
+//! adds methods to draw 3D Curves and Curves on 3D
//! Surfaces.
//!
//! The classes Curve Curve2d and Surface are drawable
-//! and can be used to draw a single curve from
+//! and can be used to draw a single curve from
//! packages Geom or Geom2d or a surface from Geom.
//!
//! The Triangulation and Polygon from the package Poly are also supported.
public:
DEFINE_STANDARD_ALLOC
- //! Sets <G> in the variable <Name>. Overwrite the
+ //! Sets <G> in the variable <Name>. Overwrite the
//! variable if already set.
Standard_EXPORT static void Set(const Standard_CString Name, const gp_Pnt& G);
- //! Sets <G> in the variable <Name>. Overwrite the
+ //! Sets <G> in the variable <Name>. Overwrite the
//! variable if already set.
Standard_EXPORT static void Set(const Standard_CString Name, const gp_Pnt2d& G);
- //! Sets <G> in the variable <Name>. Overwrite the
+ //! Sets <G> in the variable <Name>. Overwrite the
//! variable if already set.
//! isSenseMarker indicates whether to render the
//! sense glyph (arrow) for curves or not
Set(Name, (const Handle(Geom_Geometry)&)Arg);
}
- //! Sets <C> in the variable <Name>. Overwrite the
+ //! Sets <C> in the variable <Name>. Overwrite the
//! variable if already set.
//! isSenseMarker indicates whether to render the
//! sense glyph (arrow) for curves or not
Set(Name, (const Handle(Geom2d_Curve)&)Arg);
}
- //! Sets <T> in the variable <Name>. Overwrite the
+ //! Sets <T> in the variable <Name>. Overwrite the
//! variable if already set.
Standard_EXPORT static void Set(const Standard_CString Name, const Handle(Poly_Triangulation)& T);
- //! Sets <P> in the variable <Name>. Overwrite the
+ //! Sets <P> in the variable <Name>. Overwrite the
//! variable if already set.
Standard_EXPORT static void Set(const Standard_CString Name, const Handle(Poly_Polygon3D)& P);
- //! Sets <P> in the variable <Name>. Overwrite the
+ //! Sets <P> in the variable <Name>. Overwrite the
//! variable if already set.
Standard_EXPORT static void Set(const Standard_CString Name, const Handle(Poly_Polygon2D)& P);
-
- //! Get the variable <S>. Returns a null handle if
- //! none, and print a warning message.
+ //! Getthe variable <S>. Returns a null handle if
+ //! none, and print a warning message.
Standard_EXPORT static Handle(Geom_Geometry) Get(Standard_CString& Name);
//! Gets the variable. Returns False if none and print
//! a warning message.
Standard_EXPORT static Standard_Boolean GetPoint2d(Standard_CString& Name, gp_Pnt2d& P);
- //! Get the variable <S>. Returns a null handle if
+ //! Get the variable <S>. Returns a null handle if
//! none, and print a warning message.
Standard_EXPORT static Handle(Geom_Curve) GetCurve(Standard_CString& Name);
- //! Get the variable <S>. Returns a null handle if
+ //! Get the variable <S>. Returns a null handle if
//! none, and print a warning message.
Standard_EXPORT static Handle(Geom_BezierCurve) GetBezierCurve(Standard_CString& Name);
- //! Get the variable <S>. Returns a null handle if
+ //! Get the variable <S>. Returns a null handle if
//! none, and print a warning message.
Standard_EXPORT static Handle(Geom_BSplineCurve) GetBSplineCurve(Standard_CString& Name);
- //! Get the variable <S>. Returns a null handle if
+ //! Get the variable <S>. Returns a null handle if
//! none, and print a warning message.
Standard_EXPORT static Handle(Geom2d_Curve) GetCurve2d(Standard_CString& Name);
- //! Get the variable <S>. Returns a null handle if
+ //! Get the variable <S>. Returns a null handle if
//! none, and print a warning message.
Standard_EXPORT static Handle(Geom2d_BezierCurve) GetBezierCurve2d(Standard_CString& Name);
- //! Get the variable <S>. Returns a null handle if
+ //! Get the variable <S>. Returns a null handle if
//! none, and print a warning message.
Standard_EXPORT static Handle(Geom2d_BSplineCurve) GetBSplineCurve2d(Standard_CString& Name);
- //! Get the variable <S>. Returns a null handle if
+ //! Get the variable <S>. Returns a null handle if
//! none, and print a warning message.
Standard_EXPORT static Handle(Geom_Surface) GetSurface(Standard_CString& Name);
- //! Get the variable <S>. Returns a null handle if
+ //! Get the variable <S>. Returns a null handle if
//! none, and print a warning message.
Standard_EXPORT static Handle(Geom_BezierSurface) GetBezierSurface(Standard_CString& Name);
- //! Get the variable <S>. Returns a null handle if
+ //! Get the variable <S>. Returns a null handle if
//! none, and print a warning message.
Standard_EXPORT static Handle(Geom_BSplineSurface) GetBSplineSurface(Standard_CString& Name);
- //! Get the variable <S>. Returns a null handle if
+ //! Get the variable <S>. Returns a null handle if
//! none, and print a warning message.
Standard_EXPORT static Handle(Poly_Triangulation) GetTriangulation(Standard_CString& Name);
- //! Get the variable <S>. Returns a null handle if
+ //! Get the variable <S>. Returns a null handle if
//! none, and print a warning message.
Standard_EXPORT static Handle(Poly_Polygon3D) GetPolygon3D(Standard_CString& Name);
- //! Get the variable <S>. Returns a null handle if
+ //! Get the variable <S>. Returns a null handle if
//! none, and print a warning message.
Standard_EXPORT static Handle(Poly_Polygon2D) GetPolygon2D(Standard_CString& Name);
void ClearKnots() { drawKnots = Standard_False; }
- //! Returns in <Index> the index of the first pole of the
+ //! Returns in <Index> the index of the first pole of the
//! curve projected by the Display <D> at a distance lower
- //! than <Prec> from <X,Y>. If no pole is found index is
- //! set to 0, else index is always greater than the input
+ //! than <Prec> from <X,Y>. If no pole is found index is
+ //! set to 0, else index is always greater than the input
//! value of index.
Standard_EXPORT void FindPole(const Standard_Real X,
const Standard_Real Y,
void ClearKnots() { drawKnots = Standard_False; }
- //! Returns in <Index> the index of the first pole of the
+ //! Returns in <Index> the index of the first pole of the
//! curve projected by the Display <D> at a distance lower
- //! than <Prec> from <X,Y>. If no pole is found index is
- //! set to 0, else index is always greater than the input
+ //! than <Prec> from <X,Y>. If no pole is found index is
+ //! set to 0, else index is always greater than the input
//! value of index.
Standard_EXPORT void FindPole(const Standard_Real X,
const Standard_Real Y,
void ClearPoles() { drawPoles = Standard_False; }
- //! Returns in <Index> the index of the first pole of the
+ //! Returns in <Index> the index of the first pole of the
//! curve projected by the Display <D> at a distance lower
- //! than <Prec> from <X,Y>. If no pole is found index is
- //! set to 0, else index is always greater than the input
+ //! than <Prec> from <X,Y>. If no pole is found index is
+ //! set to 0, else index is always greater than the input
//! value of index.
Standard_EXPORT void FindPole(const Standard_Real X,
const Standard_Real Y,
void ClearPoles() { drawPoles = Standard_False; }
- //! Returns in <Index> the index of the first pole of the
+ //! Returns in <Index> the index of the first pole of the
//! curve projected by the Display <D> at a distance lower
- //! than <Prec> from <X,Y>. If no pole is found index is
- //! set to 0, else index is always greater than the input
+ //! than <Prec> from <X,Y>. If no pole is found index is
+ //! set to 0, else index is always greater than the input
//! value of index.
Standard_EXPORT void FindPole(const Standard_Real X,
const Standard_Real Y,
DEFINE_STANDARD_HANDLE(DrawTrSurf_Drawable, Draw_Drawable3D)
-//! this class adds to the Drawable3D methods to
+//! this class adds to the Drawable3D methods to
//! display Curves and Curves on Surface.
//!
-//! The discretisation, number of points on a Curve,
+//! The discretisation, number of points on a Curve,
//! is stored in this class.
class DrawTrSurf_Drawable : public Draw_Drawable3D
{
//! Draw a polygon of the curve on the Display
Standard_EXPORT void DrawCurveOn(Adaptor3d_Curve& C, Draw_Display& D) const;
- //! Load C with the specified iso and Draw a polygon
+ //! Load C with the specified iso and Draw a polygon
//! of the curve on the Display
Standard_EXPORT void DrawIsoCurveOn(Adaptor3d_IsoCurve& C,
const GeomAbs_IsoType T,
//! Save drawable into stream.
Standard_EXPORT virtual void Save(Standard_OStream& theStream) const Standard_OVERRIDE;
- //! For variable whatis command. Set as a result the
+ //! For variable whatis command. Set as a result the
//! type of the variable.
Standard_EXPORT virtual void Whatis(Draw_Interpretor& I) const Standard_OVERRIDE;
//! For variable dump.
Standard_EXPORT virtual void Dump(Standard_OStream& S) const Standard_OVERRIDE;
- //! For variable whatis command. Set as a result the
+ //! For variable whatis command. Set as a result the
//! type of the variable.
Standard_EXPORT virtual void Whatis(Draw_Interpretor& I) const Standard_OVERRIDE;
const Handle(TDF_Data)& Data,
TopTools_ListOfShape& Shapes);
- //! theStatus = 0 Not found,
- //! theStatus = 1 One shape,
+ //! theStatus = 0 Not found,
+ //! theStatus = 1 One shape,
//! theStatus = 2 More than one shape.
Standard_EXPORT static TCollection_AsciiString GetEntry(const TopoDS_Shape& Shape,
const Handle(TDF_Data)& Data,
//! Initializes all the functions
Standard_EXPORT static void Init(Draw_Interpretor& di);
- //! Loads all Draw commands of TKTObjDRAW. Used for plugin.
+ //! Loads all Draw commands of TKTObjDRAW. Used for plugin.
Standard_EXPORT static void Factory(Draw_Interpretor& theDI);
protected:
//! Defines the commands to build edges and wires.
Standard_EXPORT static void CurveCommands(Draw_Interpretor& DI);
- //! Defines the commands to perform add fillets on
- //! wires and edges.
+ //! Defines the commands to perform add fillets on
+ //! wires and edges.
Standard_EXPORT static void Fillet2DCommands(Draw_Interpretor& DI);
//! Defines the commands to build faces and shells.
//! Defines the commands to sweep shapes.
Standard_EXPORT static void SweepCommands(Draw_Interpretor& DI);
- //! Defines the commands to perform topological
+ //! Defines the commands to perform topological
//! operations.
Standard_EXPORT static void TopologyCommands(Draw_Interpretor& DI);
- //! Defines the commands to perform add fillets on
+ //! Defines the commands to perform add fillets on
//! shells.
Standard_EXPORT static void FilletCommands(Draw_Interpretor& DI);
- //! Defines the commands to perform add chamfers on
+ //! Defines the commands to perform add chamfers on
//! shells.
Standard_EXPORT static void ChamferCommands(Draw_Interpretor& DI);
//! Defines the checkshape command.
Standard_EXPORT static void CheckCommands(Draw_Interpretor& DI);
- //! Defines the placement command.
+ //! Defines the placement command.
Standard_EXPORT static void PlacementCommands(Draw_Interpretor& DI);
//! Defines the commands to project a wire on a shape.
#include <Draw_Interpretor.hxx>
-//! this package provides commands for curves and
+//! this package provides commands for curves and
//! surface.
class GeometryTest
{
//! continuity between curves or surfaces
Standard_EXPORT static void ContinuityCommands(Draw_Interpretor& I);
- //! defines command to test the polyhedral
+ //! defines command to test the polyhedral
//! triangulations and the polygons from the Poly package.
Standard_EXPORT static void PolyCommands(Draw_Interpretor& I);
//! For variable dump.
Standard_EXPORT virtual void Dump(Standard_OStream& S) const Standard_OVERRIDE;
- //! For variable whatis command. Set as a result the
+ //! For variable whatis command. Set as a result the
//! type of the variable.
Standard_EXPORT virtual void Whatis(Draw_Interpretor& I) const Standard_OVERRIDE;
#include <Draw_Interpretor.hxx>
-//! this package provides elementary commands for curves and
+//! this package provides elementary commands for curves and
//! surface.
class GeomliteTest
{
class TopoDS_Shape;
class HLRTopoBRep_OutLiner;
-//! This package is a test of the Hidden Lines
+//! This package is a test of the Hidden Lines
//! algorithms instantiated on the BRep Data Structure
//! and using the Draw package to display the results.
class HLRTest
//! For variable dump.
Standard_EXPORT virtual void Dump(Standard_OStream& S) const Standard_OVERRIDE;
- //! For variable whatis command. Set as a result the
+ //! For variable whatis command. Set as a result the
//! type of the variable.
Standard_EXPORT virtual void Whatis(Draw_Interpretor& I) const Standard_OVERRIDE;
//! Save drawable into stream.
Standard_EXPORT virtual void Save(Standard_OStream& theStream) const Standard_OVERRIDE;
- //! For variable whatis command. Set as a result the
+ //! For variable whatis command. Set as a result the
//! type of the variable.
Standard_EXPORT virtual void Whatis(Draw_Interpretor& I) const Standard_OVERRIDE;
public:
DEFINE_STANDARD_ALLOC
- //! Loads all Draw commands of V2d & V3d. Used for plugin.
+ //! Loads all Draw commands of V2d & V3d. Used for plugin.
Standard_EXPORT static void Factory(Draw_Interpretor& theDI);
//! Creates view with default or custom name and adds this name in map to manage multiple views.
//! waits until a shape of type <aType> is picked in the AIS Viewer and returns it.
//! if <aType> == TopAbs_Shape, any shape can be picked...
- //! MaxPick is the Max number before exiting, if no pick is successful
+ //! MaxPick is the Max number before exiting, if no pick is successful
Standard_EXPORT static TopoDS_Shape PickShape(const TopAbs_ShapeEnum aType,
const Standard_Integer MaxPick = 5);
//! wait until the array is filled with picked shapes.
//! returns True if the array is filled.
- //! exit if number of unsuccessful picks = <MaxPick>
+ //! exit if number of unsuccessful picks = <MaxPick>
Standard_EXPORT static Standard_Boolean PickShapes(const TopAbs_ShapeEnum aType,
Handle(TopTools_HArray1OfShape)& thepicked,
const Standard_Integer MaxPick = 5);
//! Initializes all the functions
Standard_EXPORT static void Init(Draw_Interpretor& di);
- //! Loads all Draw commands of TKXDEDRAW. Used for plugin.
+ //! Loads all Draw commands of TKXDEDRAW. Used for plugin.
Standard_EXPORT static void Factory(Draw_Interpretor& theDI);
};
//! In practice it should never be called because modern compilers
//! create such instances in place.
//! However note that if this constructor is called, the buffer
- //! content (string) will not be copied (move is not supported for
+ //! content (string) will not be copied (move is not supported for
//! std::stringstream class on old compilers such as gcc 4.4, msvc 9).
StreamBuffer(const StreamBuffer& theOther)
: myMessenger(theOther.myMessenger),
#include <NCollection_DataMap.hxx>
//!
-//! Class NCollection_AccAllocator - accumulating memory allocator. This
-//! class allocates memory on request returning the pointer to the allocated
-//! space. The allocation units are grouped in blocks requested from the
-//! system as required. This memory is returned to the system when all
+//! Class NCollection_AccAllocator - accumulating memory allocator. This
+//! class allocates memory on request returning the pointer to the allocated
+//! space. The allocation units are grouped in blocks requested from the
+//! system as required. This memory is returned to the system when all
//! allocations in a block are freed.
//!
-//! By comparison with the standard new() and malloc() calls, this method is
+//! By comparison with the standard new() and malloc() calls, this method is
//! faster and consumes very small additional memory to maintain the heap.
//!
-//! By comparison with NCollection_IncAllocator, this class requires some more
-//! additional memory and a little more time for allocation and deallocation.
+//! By comparison with NCollection_IncAllocator, this class requires some more
+//! additional memory and a little more time for allocation and deallocation.
//! Memory overhead for NCollection_IncAllocator is 12 bytes per block;
//! average memory overhead for NCollection_AccAllocator is 28 bytes per block.
//!
-//! All pointers returned by Allocate() are aligned to 4 byte boundaries.
-//! To define the size of memory blocks requested from the OS, use the
+//! All pointers returned by Allocate() are aligned to 4 byte boundaries.
+//! To define the sizeof memory blocks requested from the OS, use the
//! parameter of the constructor (measured in bytes).
class NCollection_AccAllocator : public NCollection_BaseAllocator
//!
//! Examples:
//! @code
-//! Item tab[100]; // an example with a C array
+//! Item tab[100]; // an example with a C array
//! NCollection_Array1<Item> ttab (tab[0], 1, 100);
//!
//! NCollection_Array1<Item> tttab (ttab(10), 10, 20); // a slice of ttab
//! The Vector is always created with 0 length. It can be enlarged by two means:
//! 1. Calling the method Append (val) - then "val" is added to the end of the
//! vector (the vector length is incremented)
-//! 2. Calling the method SetValue (i, val) - if "i" is greater than or equal
-//! to the current length of the vector, the vector is enlarged to accomo-
+//! 2. Calling the method SetValue (i, val) - if "i" is greater than or equal
+//! to the current length of the vector, the vector is enlarged to accomo-
//! date this index
//!
-//! The methods Append and SetValue return a non-const reference to the copied
-//! object inside the vector. This reference is guaranteed to be valid until
+//! The methods Append and SetValue return a non-const reference to the copied
+//! object inside the vector. This reference is guaranteed to be valid until
//! the vector is destroyed. It can be used to access the vector member directly
//! or to pass its address to other data structures.
//!
-//! The vector iterator remembers the length of the vector at the moment of the
-//! creation or initialisation of the iterator. Therefore the iteration begins
-//! at index 0 and stops at the index equal to (remembered_length-1). It is OK
+//! The vector iterator remembers the length of the vector at the moment of the
+//! creation or initialisation of the iterator. Therefore the iteration begins
+//! at index 0 and stops at the index equal to (remembered_length-1). It is OK
//! to enlarge the vector during the iteration.
template <class TheItemType>
class NCollection_DynamicArray
//! Class NCollection_Vector (dynamic array of objects)
//!
-//! This class is similar to NCollection_Vector though the indices always start
+//! This class is similar to NCollection_Vector though the indices always start
//! at 0 (in Array1 the first index must be specified)
//!
//! The Vector is always created with 0 length. It can be enlarged by two means:
//! 1. Calling the method Append (val) - then "val" is added to the end of the
//! vector (the vector length is incremented)
-//! 2. Calling the method SetValue (i, val) - if "i" is greater than or equal
-//! to the current length of the vector, the vector is enlarged to accomo-
+//! 2. Calling the method SetValue (i, val) - if "i" is greater than or equal
+//! to the current length of the vector, the vector is enlarged to accomo-
//! date this index
//!
-//! The methods Append and SetValue return a non-const reference to the copied
-//! object inside the vector. This reference is guaranteed to be valid until
+//! The methods Append and SetValue return a non-const reference to the copied
+//! object inside the vector. This reference is guaranteed to be valid until
//! the vector is destroyed. It can be used to access the vector member directly
//! or to pass its address to other data structures.
//!
-//! The vector iterator remembers the length of the vector at the moment of the
-//! creation or initialisation of the iterator. Therefore the iteration begins
-//! at index 0 and stops at the index equal to (remembered_length-1). It is OK
+//! The vector iterator remembers the length of the vector at the moment of the
+//! creation or initialisation of the iterator. Therefore the iteration begins
+//! at index 0 and stops at the index equal to (remembered_length-1). It is OK
//! to enlarge the vector during the iteration.
template <class TheItemType>
using NCollection_Vector = NCollection_DynamicArray<TheItemType>;
//! The DlOpen method provides an interface to the
//! dynamic library loader to allow shared libraries
- //! to be loaded and called at runtime. The DlOpen
+ //! to be loaded and called at runtime. The DlOpen
//! function attempts to load Filename, in the address
//! space of the process, resolving symbols as appropriate.
//! Any libraries that Filename depends upon are also loaded.
//! This function is portable and it measures ELAPSED
//! time and CPU time in seconds and microseconds.
//! Example: OSD_Timer aTimer;
-//! aTimer.Start(); // Start the timers (t1).
-//! ..... // Do something.
+//! aTimer.Start(); // Start the timers (t1).
+//! ..... // Do something.
//! aTimer.Stop(); // Stop the timers (t2).
//! aTimer.Show(); // Give the elapsed time between t1 and t2.
//! // Give also the process CPU time between
//! stopped.
Standard_EXPORT virtual void Show() const Standard_OVERRIDE;
- //! Shows both the elapsed time and CPU time on the
+ //! Shows both the elapsed time and CPU time on the
//! output stream <OS>.
Standard_EXPORT virtual void Show(Standard_OStream& os) const Standard_OVERRIDE;
//! returns both the elapsed time(seconds,minutes,hours)
- //! and CPU time.
+ //! and CPU time.
Standard_EXPORT void Show(Standard_Real& theSeconds,
Standard_Integer& theMinutes,
Standard_Integer& theHours,
//! algorithm, but this option might be costly.
static constexpr Standard_Real Approximation() { return Confusion() * 10.0; }
- //! Convert a real space precision to a parametric
- //! space precision. <T> is the mean value of the
+ //! Convert a real space precision to a parametric
+ //! space precision. <T> is the mean value of the
//! length of the tangent of the curve or the surface.
//!
//! Value is P / T
//! parameter u of this curve is ten times greater than the
//! previous one. This shows that for two different curves,
//! the distance between two points on the curve, resulting
- //! from the same variation of parameter du, may vary considerably.
+ //! from the same variation of parameter du, may vary considerably.
//! - Moreover, the variation of the parameter along the
//! curve is generally not proportional to the curvilinear
//! abscissa along the curve. So the distance between two
return Parametric(Approximation(), T);
}
- //! Convert a real space precision to a parametric
+ //! Convert a real space precision to a parametric
//! space precision on a default curve.
//!
//! Value is Parametric(P,1.e+2)
static constexpr Standard_Real Parametric(const Standard_Real P) { return P * 0.01; }
- //! Used to test distances in parametric space on a
+ //! Used to test distances in parametric space on a
//! default curve.
//!
//! This is Precision::Parametric(Precision::Confusion())
static constexpr Standard_Real PConfusion() { return Confusion() * 0.01; }
- //! Used for Intersections in parametric space on a
+ //! Used for Intersections in parametric space on a
//! default curve.
//!
//! This is Precision::Parametric(Precision::Intersection())
static constexpr Standard_Real PIntersection() { return Intersection() * 0.01; }
- //! Used for Approximations in parametric space on a
+ //! Used for Approximations in parametric space on a
//! default curve.
//!
//! This is Precision::Parametric(Precision::Approximation())
return Abs(R) >= (0.5 * Precision::Infinite());
}
- //! Returns True if R may be considered as a positive
+ //! Returns True if R may be considered as a positive
//! infinite number. Currently R > 1e100
static constexpr Standard_Boolean IsPositiveInfinite(const Standard_Real R)
{
return R >= (0.5 * Precision::Infinite());
}
- //! Returns True if R may be considered as a negative
+ //! Returns True if R may be considered as a negative
//! infinite number. Currently R < -1e100
static constexpr Standard_Boolean IsNegativeInfinite(const Standard_Real R)
{
return R <= -(0.5 * Precision::Infinite());
}
- //! Returns a big number that can be considered as
+ //! Returns a big number that can be considered as
//! infinite. Use -Infinite() for a negative big number.
static constexpr Standard_Real Infinite() { return 2.e+100; }
};
//!
//! FILE SYNTAX
//! The syntax of a resource file is a sequence of resource
- //! lines terminated by newline characters or end of file. The
+ //! lines terminated by newline characters or end of file. The
//! syntax of an individual resource line is:
Standard_EXPORT Resource_Manager(const Standard_CString aName,
const Standard_Boolean Verbose = Standard_False);
//! Converts Unicode ExtendedString <fromstr> to non-ASCII
//! CString <tostr> in ANSI format, limited to <maxsize>
//! characters. To translate the whole <fromstr>, use more
- //! than twice the length of <fromstr>. Returns true if
+ //! than twice the length of <fromstr>. Returns true if
//! <maxsize> has not been reached before end of conversion.
Standard_EXPORT static Standard_Boolean ConvertUnicodeToANSI(
const TCollection_ExtendedString& fromstr,
projects / occt.git / commitdiff