//! The feature structure is a tree used to bind
//! semantic information about each feature together.
//!
-//! The only one concrete attribute defined in this
+//! The only one concrete attribute defined in this
//! package is the TagSource attribute.This attribute
-//! is used for random creation of child labels under
+//! is used for random creation of child labels under
//! a given label. Tags are randomly delivered.
class TDF
{
//! ---------------
//!
//! An AttributeDelta is the difference between to
-//! attribute values states. These methods must be
+//! attribute values states. These methods must be
//! implemented by end use inheriting classes, to
//! profit from the delta services.
class TDF_Attribute : public Standard_Transient
//! Sets default ID defined in nested class (to be used for attributes having User ID feature).
virtual void SetID() {}
- //! Returns the label to which the attribute is
- //! attached. If the label is not included in a DF,
+ //! Returns the label to which the attribute is
+ //! attached. If the label is not included in a DF,
//! the label is null. See Label.
- //! Warning
+ //! Warning:
//! If the label is not included in a data
//! framework, it is null.
//! This function should not be redefined inline.
//! =================================================
Standard_Boolean IsForgotten() const;
- //! Returns true if it exists an associated attribute
+ //! Returns true if it exists an associated attribute
//! of <me> with <anID> as ID.
Standard_EXPORT Standard_Boolean IsAttribute(const Standard_GUID& anID) const;
- //! Finds an associated attribute of <me>, according
- //! to <anID>. the returned <anAttribute> is a valid
- //! one. The method returns True if found, False
- //! otherwise. A removed attribute cannot be found using
- //! this method.
+ //! Finds an associated attribute of <me>, according
+ //! to <anID>. the returned <anAttribute> is a valid
+ //! one. The method returns True if found, False
+ //! otherwise. A removed attribute cannot be found using
+ //! this method.
Standard_EXPORT Standard_Boolean FindAttribute(const Standard_GUID& anID,
Handle(TDF_Attribute)& anAttribute) const;
return FindAttribute(theID, anAttr) && !(theAttr = Handle(T)::DownCast(anAttr)).IsNull();
}
- //! Adds an Attribute <other> to the label of
- //! <me>.Raises if there is already one of the same
- //! GUID fhan <other>.
+ //! Adds an Attribute <other> to the label of <me>.
+ //! Raises if there is already one of the same GUID
+ //! than <other>.
Standard_EXPORT void AddAttribute(const Handle(TDF_Attribute)& other) const;
- //! Forgets
the Attribute of GUID <aguid> associated
- //! to the label of <me>. Be careful that if <me> is
+ //! Forgets
the Attribute of GUID <aguid> associated
+ //! to the label of <me>. Be careful that if <me> is
//! the attribute of <guid>, <me> will have a null label
- //! after this call. If the attribute doesn't exist
+ //! after this call. If the attribute doesn't exist
//! returns False. Otherwise returns True.
Standard_EXPORT Standard_Boolean ForgetAttribute(const Standard_GUID& aguid) const;
- //! Forgets all the attributes attached to the label
- //! of <me>. Does it on the sub-labels if
- //! <clearChildren> is set to true. Of course, this
- //! method is compatible with Transaction & Delta
- //! mechanisms. Be careful that if <me> will have a
+ //! Forgets all the attributes attached to the label
+ //! of <me>. Does it on the sub-labels if
+ //! <clearChildren> is set to true. Of course, this
+ //! method is compatible with Transaction & Delta
+ //! mechanisms. Be careful that if <me> will have a
//! null label after this call
Standard_EXPORT void ForgetAllAttributes(
const Standard_Boolean clearChildren = Standard_True) const;
public:
DEFINE_STANDARD_ALLOC
- //! Creates an empty iterator object to
+ //! Creates an empty iterator object to
//! explore the children of a label.
Standard_EXPORT TDF_ChildIterator();
//! Constructs the iterator object defined by
- //! the label aLabel. Iterates on the children of the given label. If
+ //! the label aLabel. Iterates on the children of the given label. If
//! <allLevels> option is set to true, it explores not
//! only the first, but all the sub label levels.
Standard_EXPORT TDF_ChildIterator(const TDF_Label& aLabel,
//! iteration process.
Standard_Boolean More() const;
- //! Move the current iteration to the next Item.
+ //! Move the current iteration to the next Item.
Standard_EXPORT void Next();
//! Moves this iteration to the next brother
//!
//! <anOption> may take the following values:
//! 1 : labels treatment only;
- //! 2 : attributes treatment only(default value);
+ //! 2 : attributes treatment only (default value);
//! 3 : both labels & attributes treatment.
Standard_EXPORT static Standard_Boolean TargetUnbound(
const Handle(TDF_DataSet)& aRefDataSet,
class TDF_RelocationTable;
class TDF_DataSet;
-//! This class gives copy of source label hierarchy
+//! This class gives copy of source label hierarchy
class TDF_CopyLabel
{
public:
DEFINE_STANDARD_ALLOC
- //! Empty constructor
+ //! Empty constructor
Standard_EXPORT TDF_CopyLabel();
//! CopyTool
Standard_EXPORT TDF_CopyLabel(const TDF_Label& aSource, const TDF_Label& aTarget);
- //! Loads src and tgt labels
+ //! Loads src and tgt labels
Standard_EXPORT void Load(const TDF_Label& aSource, const TDF_Label& aTarget);
- //! Sets filter
+ //! Sets filter
Standard_EXPORT void UseFilter(const TDF_IDFilter& aFilter);
- //! Check external references and if exist fills the aExternals Map
+ //! Check external references and if exist fills the aExternals Map
Standard_EXPORT static Standard_Boolean ExternalReferences(const TDF_Label& Lab,
TDF_AttributeMap& aExternals,
const TDF_IDFilter& aFilter);
- //! Check external references and if exist fills the aExternals Map
+ //! Check external references and if exist fills the aExternals Map
Standard_EXPORT static void ExternalReferences(const TDF_Label& aRefLab,
const TDF_Label& Lab,
TDF_AttributeMap& aExternals,
const TDF_IDFilter& aFilter,
Handle(TDF_DataSet)& aDataSet);
- //! performs algorithm of selfcontained copy
+ //! performs algorithm of selfcontained copy
Standard_EXPORT void Perform();
Standard_Boolean IsDone() const;
- //! returns relocation table
+ //! returns relocation table
Standard_EXPORT const Handle(TDF_RelocationTable)& RelocationTable() const;
protected:
public:
DEFINE_STANDARD_ALLOC
- //! Copy <aSourceDataSet> with using and updating
- //! <aRelocationTable>. This method ignores target
+ //! Copy <aSourceDataSet> with using and updating
+ //! <aRelocationTable>. This method ignores target
//! attributes privilege over source ones.
Standard_EXPORT static void Copy(const Handle(TDF_DataSet)& aSourceDataSet,
const Handle(TDF_RelocationTable)& aRelocationTable);
- //! Copy <aSourceDataSet> using and updating
+ //! Copy <aSourceDataSet> using and updating
//! <aRelocationTable>. Use <aPrivilegeFilter> to give
- //! a list of IDs for which the target attribute
+ //! a list of IDs for which the target attribute
//! prevails over the source one.
Standard_EXPORT static void Copy(const Handle(TDF_DataSet)& aSourceDataSet,
const Handle(TDF_RelocationTable)& aRelocationTable,
const TDF_IDFilter& aPrivilegeFilter);
- //! Copy <aSourceDataSet> using and updating
+ //! Copy <aSourceDataSet> using and updating
//! <aRelocationTable>. Use <aPrivilegeFilter> to give
- //! a list of IDs for which the target attribute
- //! prevails over the source one. If
- //! <setSelfContained> is set to true, every
- //! TDF_Reference will be replaced by the referenced
- //!
structure according to <aRefFilter>.
+ //! a list of IDs for which the target attribute
+ //! prevails over the source one. If <setSelfContained>
+ //! is set to true, every TDF_Reference will be
+ //! replaced by the referenced structure
+ //! according to <aRefFilter>.
//!
- //! NB: <aRefFilter> is used only if
- //! <setSelfContained> is true.
+ //! NB: <aRefFilter> is used only if <setSelfContained>
+ //! is true.
//! Internal root label copy recursive method.
Standard_EXPORT static void Copy(const Handle(TDF_DataSet)& aSourceDataSet,
const Handle(TDF_RelocationTable)& aRelocationTable,
{
public:
- //! Creates an empty DataSet object.
+ //! Creates an empty DataSet object.
Standard_EXPORT TDF_DataSet();
//! Clears all information.
//! attribute.
Standard_Boolean IsEmpty() const;
- //! Adds <aLabel> in the current data set.
+ //! Adds <aLabel> in the current data set.
void AddLabel(const TDF_Label& aLabel);
- //! Returns true if the label <alabel> is in the data set.
+ //! Returns true if the label <alabel> is in the data set.
Standard_Boolean ContainsLabel(const TDF_Label& aLabel) const;
//! Returns the map of labels in this data set.
//! This map can be used directly, or updated.
TDF_LabelMap& Labels();
- //! Adds <anAttribute> into the current data set.
+ //! Adds <anAttribute> into the current data set.
void AddAttribute(const Handle(TDF_Attribute)& anAttribute);
//! Returns true if <anAttribute> is in the data set.
Standard_Boolean ContainsAttribute(const Handle(TDF_Attribute)& anAttribute) const;
- //! Returns the map of attributes in the current data set.
+ //! Returns the map of attributes in the current data set.
//! This map can be used directly, or updated.
TDF_AttributeMap& Attributes();
class Standard_GUID;
class TDF_IDFilter;
-//! This class provides basic operations to define
+//! This class provides basic operations to define
//! a label in a data structure.
//! A label is a feature in the feature hierarchy. A
//! label is always connected to a Data from TDF.
Standard_EXPORT TDF_Label FindChild(const Standard_Integer aTag,
const Standard_Boolean create = Standard_True) const;
- //! Create a new child label of me using autoamtic
+ //! Create a new child label of me using automatic
//! delivery tags provided by TagSource.
TDF_Label NewChild() const;
class TDF_Reference;
DEFINE_STANDARD_HANDLE(TDF_Reference, TDF_Attribute)
-//! This attribute is used to store in the framework a
+//! This attribute is used to store in the framework a
//! reference to an other label.
class TDF_Reference : public TDF_Attribute
{
class TDF_TagSource;
DEFINE_STANDARD_HANDLE(TDF_TagSource, TDF_Attribute)
-//! This attribute manage a tag provider to create
+//! This attribute manage a tag provider to create
//! child labels of a given one.
class TDF_TagSource : public TDF_Attribute
{
//! =============
Standard_EXPORT static const Standard_GUID& GetID();
- //! Find, or create, a TagSource attribute. the TagSource
+ //! Find, or create, a TagSource attribute. the TagSource
//! attribute is returned.
Standard_EXPORT static Handle(TDF_TagSource) Set(const TDF_Label& label);
- //! Find (or create) a tagSource attribute located at <L>
+ //! Find (or create) a tagSource attribute located at <L>
//! and make a new child label.
//! TagSource methods
//! =================
#include <Standard_OStream.hxx>
#include <TDataStd_RealEnum.hxx>
-//! This package defines standard attributes for
+//! This package defines standard attributes for
//! modelling.
//! These allow you to create and modify labels
//! and attributes for many basic data types.
//! Relation attribute.
//! ==================
//!
-//! * Data Structure of the Expression is stored in a
+//! * Data Structure of the Expression is stored in a
//! string and references to variables used by the string
//!
-//! Warning: To be consistent, each Variable referenced by the
+//! Warning: To be consistent, each Variable referenced by the
//! relation must have its equivalent in the string
class TDataStd_Relation : public TDataStd_Expression
{
Standard_EXPORT static Standard_Boolean Find(const TDF_Label& L, Handle(TDataStd_TreeNode)& T);
//! Finds or Creates a TreeNode attribute on the label <L>
- //! with the default tree ID, returned by the method
- //! <GetDefaultTreeID>. Returns the created/found TreeNode
+ //! with the default tree ID, returned by the method
+ //! <GetDefaultTreeID>. Returns the created/found TreeNode
//! attribute.
Standard_EXPORT static Handle(TDataStd_TreeNode) Set(const TDF_Label& L);
- //! Finds or Creates a TreeNode attribute on the label
- //! <L>, with an explicit tree ID. <ExplicitTreeID> is
- //! the ID returned by <TDF_Attribute::ID> method.
+ //! Finds or Creates a TreeNode attribute on the label
+ //! <L>, with an explicit tree ID. <ExplicitTreeID> is
+ //! the ID returned by <TDF_Attribute::ID> method.
//! Returns the found/created TreeNode attribute.
Standard_EXPORT static Handle(TDataStd_TreeNode) Set(const TDF_Label& L,
const Standard_GUID& ExplicitTreeID);
- //! returns a default tree ID. this ID is used by the
+ //! returns a default tree ID. this ID is used by the
//! <Set> method without explicit tree ID.
//! Instance methods:
//! ================
Standard_EXPORT TDataStd_TreeNode();
- //! Insert the TreeNode <Child> as last child of <me>. If
+ //! Insert the TreeNode <Child> as last child of <me>. If
//! the insertion is successful <me> becomes the Father of <Child>.
Standard_EXPORT Standard_Boolean Append(const Handle(TDataStd_TreeNode)& Child);
- //! Insert the the TreeNode <Child> as first child of
+ //! Insert the the TreeNode <Child> as first child of
//! <me>. If the insertion is successful <me> becomes the Father of <Child>
Standard_EXPORT Standard_Boolean Prepend(const Handle(TDataStd_TreeNode)& Child);
- //! Inserts the TreeNode <Node> before <me>. If insertion is successful <me>
+ //! Inserts the TreeNode <Node> before <me>. If insertion is successful <me>
//! and <Node> belongs to the same Father.
Standard_EXPORT Standard_Boolean InsertBefore(const Handle(TDataStd_TreeNode)& Node);
- //! Inserts the TreeNode <Node> after <me>. If insertion is successful <me>
+ //! Inserts the TreeNode <Node> after <me>. If insertion is successful <me>
//! and <Node> belongs to the same Father.
Standard_EXPORT Standard_Boolean InsertAfter(const Handle(TDataStd_TreeNode)& Node);
//! Variable attribute.
//! ==================
//!
-//! * A variable is associated to a TDataStd_Real (which
-//! contains its current value) and a TDataStd_Name
-//! attribute (which contains its name). It contains a
+//! * A variable is associated to a TDataStd_Real (which
+//! contains its current value) and a TDataStd_Name
+//! attribute (which contains its name). It contains a
//! constant flag, and a Unit
//!
-//! * An expression may be assigned to a variable. In
-//! thatcase the expression is handled by the associated
-//! Expression Attribute and the Variable returns True to
+//! * An expression may be assigned to a variable. In
+//! thatcase the expression is handled by the associated
+//! Expression Attribute and the Variable returns True to
//! the method <IsAssigned>.
class TDataStd_Variable : public TDF_Attribute
{
//! =============
Standard_EXPORT static const Standard_GUID& GetID();
- //! Find, or create, a Variable attribute.
+ //! Find, or create, a Variable attribute.
//! Real methods
//! ============
Standard_EXPORT static Handle(TDataStd_Variable) Set(const TDF_Label& label);
Standard_EXPORT TDataStd_Variable();
- //! set or change the name of the variable, in myUnknown
+ //! set or change the name of the variable, in myUnknown
//! and my associated Name attribute.
Standard_EXPORT void Name(const TCollection_ExtendedString& string);
- //! returns string stored in the associated Name
+ //! returns string stored in the associated Name
//! attribute.
Standard_EXPORT const TCollection_ExtendedString& Name() const;
- //! retrieve or create the associated real attribute and
- //! set the value <value>.
+ //! retrieve or create the associated real attribute and
+ //! set the value <value>.
Standard_EXPORT void Set(const Standard_Real value) const;
//! Obsolete method that will be removed in next versions.
//! expression attribute.
Standard_EXPORT Standard_Boolean IsAssigned() const;
- //! create(if doesn't exist) and returns the assigned
+ //! create(if doesn't exist) and returns the assigned
//! expression attribute. fill it after.
Standard_EXPORT Handle(TDataStd_Expression) Assign() const;
- //! if <me> is assigned delete the associated expression
+ //! if <me> is assigned delete the associated expression
//! attribute.
Standard_EXPORT void Desassign() const;
- //! if <me> is assigned, returns associated Expression
+ //! if <me> is assigned, returns associated Expression
//! attribute.
Standard_EXPORT Handle(TDataStd_Expression) Expression() const;
//! ===================
Standard_EXPORT const TCollection_AsciiString& Unit() const;
- //! if <status> is True, this variable will not be
+ //! if <status> is True, this variable will not be
//! modified by the solver.
Standard_EXPORT void Constant(const Standard_Boolean status);
#include <TDF_IDList.hxx>
-//! This package define CAF main classes.
+//! This package define CAF main classes.
//!
//! * The standard application root class
//!
//! sum up, standard documents alone provide
//! access to the data framework. They also allow
//! you to:
-//! - Update external links
-//! - Manage the saving and opening of data
-//! - Manage undo/redo functionality.
+//! - Update external links
+//! - Manage the saving and opening of data
+//! - Manage undo/redo functionality.
//! Note
//! For information on the relations between this
//! component of OCAF and the others, refer to the
return Open(theIStream, theDoc, Handle(PCDM_ReaderFilter)(), theRange);
}
- //! Save the active document in the file <name> in the
- //! path <path> ; o verwrites the file if it already exists.
+ //! Save the active document in the file <name> in the
+ //! path <path>. overwrites the file if it already exists.
Standard_EXPORT PCDM_StoreStatus
SaveAs(const Handle(TDocStd_Document)& theDoc,
const TCollection_ExtendedString& path,
public:
//! Will Abort any execution, clear fields
- //! returns the document which contains <L>. raises an
+ //! returns the document which contains <L>. raises an
//! exception if the document is not found.
Standard_EXPORT static Handle(TDocStd_Document) Get(const TDF_Label& L);
//! raise if <me> is not saved.
Standard_EXPORT TCollection_ExtendedString GetName() const;
- //! returns the OS path of the file, in which one <me> is
+ //! returns the OS path of the file, in which one <me> is
//! saved. Raise an exception if <me> is not saved.
Standard_EXPORT TCollection_ExtendedString GetPath() const;
//! Returns True if a new delta has been added to myUndos.
Standard_EXPORT Standard_Boolean CommitCommand();
- //! Abort the Command transaction. Does nothing If there is
+ //! Abort the Command transaction. Does nothing If there is
//! no Command transaction open.
Standard_EXPORT void AbortCommand();
//! The current limit on the number of undos
Standard_EXPORT Standard_Integer GetUndoLimit() const;
- //! Set the limit on the number of Undo Delta stored 0
- //! will disable Undo on the document A negative value
+ //! Set the limit on the number of Undo Delta stored 0
+ //! will disable Undo on the document A negative value
//! means no limit. Note that by default Undo is disabled.
- //! Enabling it will take effect with the next call to
+ //! Enabling it will take effect with the next call to
//! NewCommand. Of course this limit is the same for Redo
Standard_EXPORT void SetUndoLimit(const Standard_Integer L);
//! can be used.
Standard_EXPORT Standard_Integer GetAvailableUndos() const;
- //! Will UNDO one step, returns False if no undo was
+ //! Will UNDO one step, returns False if no undo was
//! done (Undos == 0).
//! Otherwise, true is returned and one step in the
//! list of undoes is undone.
//! can be used.
Standard_EXPORT Standard_Integer GetAvailableRedos() const;
- //! Will REDO one step, returns False if no redo was
+ //! Will REDO one step, returns False if no redo was
//! done (Redos == 0).
//! Otherwise, true is returned, and one step in the list of redoes is done again.
Standard_EXPORT Standard_Boolean Redo();
//! till the last one to be one delta.
Standard_EXPORT Standard_Boolean PerformDeltaCompaction();
- //! Set modifications on labels impacted by external
- //! references to the entry. The document becomes invalid
+ //! Set modifications on labels impacted by external
+ //! references to the entry. The document becomes invalid
//! and must be recomputed.
Standard_EXPORT void UpdateReferences(const TCollection_AsciiString& aDocEntry);
- //! Recompute if the document was not valid and propagate
+ //! Recompute if the document was not valid and propagate
//! the recorded modification.
Standard_EXPORT void Recompute();
- //! This method Update will be called
- //! to signal the end of the modified references list.
- //! The document should be recomputed and
- //! UpdateFromDocuments should be called. Update should
- //! returns True in case of success, false otherwise. In
+ //! This method Update will be called
+ //! to signal the end of the modified references list.
+ //! The document should be recomputed and
+ //! UpdateFromDocuments should be called. Update should
+ //! returns True in case of success, false otherwise. In
//! case of Failure, additional information can be given in
//! ErrorString.
//! Update the document by propagation
//! ==================================
- //! Update the document from internal stored
- //! modifications. If you want to undoing this
+ //! Update the document from internal stored
+ //! modifications. If you want to undoing this
//! operation, please call NewCommand before.
//! to change format (advanced programming)
//! ================
//! add <L> as modified
Standard_EXPORT Standard_Boolean AddLabel(const TDF_Label& L);
- //! remove <L> as modified
+ //! remove <L> as modified
Standard_EXPORT Standard_Boolean RemoveLabel(const TDF_Label& L);
//! returns modified label map
class TDocStd_Owner;
DEFINE_STANDARD_HANDLE(TDocStd_Owner, TDF_Attribute)
-//! This attribute located at the root label of the
-//! framework contains a back reference to the owner
-//! TDocStd_Document, providing access to the document from
-//! any label. private class Owner;
+//! This attribute located at the root label of the
+//! framework contains a back reference to the owner
+//! TDocStd_Document, providing access to the document
+//! from any label. private class Owner;
class TDocStd_Owner : public TDF_Attribute
{
class TDF_RelocationTable;
class TDF_Label;
-//! This tool class is used to copy the content of
-//! source label under target label. Only child
-//! labels and attributes of source are copied.
-//! attributes located out of source scope are not
+//! This tool class is used to copy the content of
+//! source label under target label. Only child
+//! labels and attributes of source are copied.
+//! attributes located out of source scope are not
//! copied by this algorithm.
-//! Depending of the called method an external
-//! reference is set in the target document to
+//! Depending of the called method an external
+//! reference is set in the target document to
//! registered the externallink.
//! Provide services to set, update and perform
//! external references.
-//! Warning1: Nothing is provided in this class about the
-//! opportunity to copy, set a link or update it.
+//! Warning1: Nothing is provided in this class about the
+//! opportunity to copy, set a link or update it.
//! Such decisions must be under application control.
//! Warning2: If the document manages shapes, use after copy
//! TNaming::ChangeShapes(target,M) to make copy of
//! Copies the content of the label <fromsource> to the label <intarget>.
//! The link is registered with an XLink attribute by <intarget>
- //! label. if the content of <fromsource> is not
- //! self-contained, and/or <intarget> has already an XLink
+ //! label. if the content of <fromsource> is not
+ //! self-contained, and/or <intarget> has already an XLink
//! attribute, an exception is raised.
Standard_EXPORT void CopyWithLink(const TDF_Label& intarget, const TDF_Label& fromsource);
- //! Update the external reference set at <L>.
+ //! Update the external reference set at <L>.
//! Example
//! Handle(TDocStd_Document) aDoc;
//! if
//! Standard_DomainError if <L> has no XLink attribute.
Standard_EXPORT void UpdateLink(const TDF_Label& L);
- //! Copy the content of <fromsource> under
+ //! Copy the content of <fromsource> under
//! <intarget>. No link is registered. No check is done.
//! Example
//! Handle(TDocStd_Document) DOC, XDOC;
class TFunction_Driver;
DEFINE_STANDARD_HANDLE(TFunction_Driver, Standard_Transient)
-//! This driver class provide services around function
-//! execution. One instance of this class is built for
-//! the whole session. The driver is bound to the
+//! This driver class provide services around function
+//! execution. One instance of this class is built for
+//! the whole session. The driver is bound to the
//! DriverGUID in the DriverTable class.
//! It allows you to create classes which inherit from
//! this abstract class.
{
public:
- //! Initializes the label L for this function prior to its execution.
+ //! Initializes the label L for this function prior to its execution.
Standard_EXPORT void Init(const TDF_Label& L);
//! Returns the label of the driver for this function.
TDF_Label Label() const;
- //! Validates labels of a function in <log>.
+ //! Validates labels of a function in <log>.
//! This function is the one initialized in this function driver.
//! Warning
//! In regeneration mode, the solver must call this
const Standard_Boolean WithChildren = Standard_False);
Standard_EXPORT void SetValid(const TDF_LabelMap& Ls);
- //! Returns True if the label L is touched or impacted. This method
+ //! Returns True if the label L is touched or impacted. This method
//! is called by <TFunction_FunctionDriver::MustExecute>.
//! If <WithChildren> is set to true, the method checks
//! all the sublabels of <L> too.
//! Writes the data aggregated in theData object into the container defined by
//! theDriver. The storage format is compartible with legacy persistent one.
//! Note: - theData may aggregate several root objects to be stored together.
- //! - createion date specified in the srorage header will be overwritten.
+ //! - creation date specified in the storage header will be overwritten.
Standard_EXPORT static Storage_Error Write(const Handle(Storage_BaseDriver)& theDriver,
const Handle(StdStorage_Data)& theData);
};
//!
//! This is a base class for OCAF based TObj models
-//! with declared virtual methods
+//! with declared virtual methods
//!
class TObj_Application : public TDocStd_Application
{
//! transaction open.
Standard_EXPORT void CommitCommand() const;
- //! Abort the Command transaction. Do nothing If there is no Command
+ //! Abort the Command transaction. Do nothing If there is no Command
//! transaction open.
Standard_EXPORT void AbortCommand() const;
* Internal tools for work with OCAF data
*/
- //! Returns the theRank2-th sub label of the theRank1-th sublabel of the
+ //! Returns the theRank2-th sub label of the theRank1-th sublabel of the
//! Data label of the object.
//! If theRank2 is 0 (default), sub label theRank1 of Data label is returned.
//! If requested label does not exist, it is created.
Standard_EXPORT TDF_Label getDataLabel(const Standard_Integer theRank1,
const Standard_Integer theRank2 = 0) const;
- //! Returns the theRank2-th sub label of the theRank1-th sublabel of the
+ //! Returns the theRank2-th sub label of the theRank1-th sublabel of the
//! Reference label of the object.
//! If theRank2 is 0 (default), sub label theRank1 of Reference label is returned.
//! If requested label does not exist, it is created.
//! Generates and returns name for new object in partition.
//! if theIsToChangeCount is true partition increase own counter
- //! to generate new name next time starting from new counter value
+ //! to generate new name next time starting from new counter value
Standard_EXPORT Handle(TCollection_HExtendedString) GetNewName(
const Standard_Boolean theIsToChangeCount = Standard_True);
//! Returns the material setting for this presentation attribute.
Standard_EXPORT Graphic3d_NameOfMaterial Material() const;
- //! Sets the material aName for this presentation attribute.
+ //! Sets the material aName for this presentation attribute.
Standard_EXPORT void SetMaterial(const Graphic3d_NameOfMaterial aName);
//! Returns true if this presentation attribute already has a material setting.
//! =============
Standard_EXPORT static const Standard_GUID& GetID();
- //! returns True if there is an AISViewer attribute in
+ //! returns True if there is an AISViewer attribute in
//! <acces> Data Framework.
Standard_EXPORT static Standard_Boolean Has(const TDF_Label& acces);
- //! create and set an AISViewer at. Raise an exception if
+ //! create and set an AISViewer at. Raise an exception if
//! Has.
Standard_EXPORT static Handle(TPrsStd_AISViewer) New(
const TDF_Label& access,
const Handle(AIS_InteractiveContext)& selector);
- //! create and set an AISAttribute at root label. The
- //! interactive context is build. Raise an exception if
+ //! create and set an AISAttribute at root label. The
+ //! interactive context is build. Raise an exception if
//! Has.
Standard_EXPORT static Handle(TPrsStd_AISViewer) New(const TDF_Label& acces,
const Handle(V3d_Viewer)& viewer);
//! attributes. These attributes are those found on
//! the label given as an argument in the method Update.
//! true is returned if the interactive object was modified by the update.
-//! This class provide an algorithm to Build with its default
-//! values (if Null) or Update (if !Null) an AIS_InteractiveObject
-//! . Resources are found in attributes associated to a given
+//! This class provide an algorithm to Build with its default
+//! values (if Null) or Update (if !Null) an AIS_InteractiveObject.
+//! Resources are found in attributes associated to a given
//! label.
class TPrsStd_Driver : public Standard_Transient
{
class TPrsStd_DriverTable;
DEFINE_STANDARD_HANDLE(TPrsStd_DriverTable, Standard_Transient)
-//! This class is a container to record (AddDriver)
-//! binding between GUID and TPrsStd_Driver.
+//! This class is a container to record (AddDriver)
+//! binding between GUID and TPrsStd_Driver.
//! You create a new instance of TPrsStd_Driver
-//! and use the method AddDriver to load it into the driver table. the method
+//! and use the method AddDriver to load it into the driver table.
class TPrsStd_DriverTable : public Standard_Transient
{
//! Returns true if the driver has been removed successfully.
Standard_EXPORT Standard_Boolean RemoveDriver(const Standard_GUID& guid);
- //! Removes all drivers. Returns
- //! true if the driver has been removed successfully.
+ //! Removes all drivers.
+ //! Returns true if the driver has been removed successfully.
//! If this method is used, the InitStandardDrivers method should be
//! called to fill the table with standard drivers.
Standard_EXPORT void Clear();
TCollection_AsciiString Name; //!< material name
Quantity_ColorRGBA BaseColor; //!< base color (or scale factor to the texture); [1.0, 1.0, 1.0, 1.0] by default
Graphic3d_Vec3 EmissiveFactor; //!< emissive color; [0.0, 0.0, 0.0] by default
- Standard_ShortReal Metallic; //!< metalness (or scale factor to the texture) within range [0.0, 1.0]; 1.0 by default
- Standard_ShortReal Roughness; //!< roughness (or scale factor to the texture) within range [0.0, 1.0]; 1.0 by default
+ Standard_ShortReal Metallic; //!< metalness (or scale factor to the texture) within range [0.0, 1.0]; 1.0 by default
+ Standard_ShortReal Roughness; //!< roughness (or scale factor to the texture) within range [0.0, 1.0]; 1.0 by default
Standard_ShortReal AlphaCutOff; //!< alpha cutoff value; 0.5 by default
RWGltf_GltfAlphaMode AlphaMode; //!< alpha mode; RWGltf_GltfAlphaMode_Opaque by default
Standard_Boolean IsDoubleSided; //!< specifies whether the material is double sided; FALSE by default
Standard_EXPORT Handle(Transfer_FinderProcess) GetTransferProcess() const;
//! Returns the result of the transfert of any Shape
- //! If the transfer has failed, this member return a NullEntity.
+ //! If the transfer has failed, this member return a NullEntity.
Standard_EXPORT virtual Handle(IGESData_IGESEntity) TransferShape(
const TopoDS_Shape& start,
const Message_ProgressRange& theProgress = Message_ProgressRange());
Standard_EXPORT Standard_Boolean HasShapeResult(const TopoDS_Shape& start) const;
//! Returns the result of the transfer of the Shape "start" contained
- //! in "TheMap" . (if HasShapeResult is True).
+ //! in "TheMap". (if HasShapeResult is True).
Standard_EXPORT Handle(Standard_Transient) GetShapeResult(const TopoDS_Shape& start) const;
//! set in "TheMap" the result of the transfer of the Shape "start".
Standard_EXPORT Standard_Boolean HasShapeResult(const Handle(Standard_Transient)& start) const;
//! Returns the result of the transfer of the Transient "start" contained
- //! in "TheMap" . (if HasShapeResult is True).
+ //! in "TheMap". (if HasShapeResult is True).
Standard_EXPORT Handle(Standard_Transient) GetShapeResult(
const Handle(Standard_Transient)& start) const;
class TopoDS_Face;
//! This class implements the transfer of Shape Entities from Geom
-//! To IGES. These can be :
+//! To IGES. These can be:
//! . Vertex
//! . Edge
//! . Wire
Standard_EXPORT BRepToIGES_BRShell(const BRepToIGES_BREntity& BR);
- //! Transfert an Shape entity from TopoDS to IGES
+ //! Transfer an Shape entity from TopoDS to IGES
//! This entity must be a Face or a Shell.
//! If this Entity could not be converted, this member returns a NullEntity.
Standard_EXPORT Handle(IGESData_IGESEntity) TransferShell(
const TopoDS_Shape& start,
const Message_ProgressRange& theProgress = Message_ProgressRange());
- //! Transfert an Shell entity from TopoDS to IGES
+ //! Transfer an Shell entity from TopoDS to IGES
//! If this Entity could not be converted, this member returns a NullEntity.
Standard_EXPORT Handle(IGESData_IGESEntity) TransferShell(
const TopoDS_Shell& start,
const Message_ProgressRange& theProgress = Message_ProgressRange());
- //! Transfert a Face entity from TopoDS to IGES
+ //! Transfer a Face entity from TopoDS to IGES
//! If this Entity could not be converted, this member returns a NullEntity.
Standard_EXPORT Handle(IGESData_IGESEntity) TransferFace(
const TopoDS_Face& start,
class TopoDS_Compound;
//! This class implements the transfer of Shape Entities from Geom
-//! To IGES. These can be :
+//! To IGES. These can be:
//! . Vertex
//! . Edge
//! . Wire
Standard_EXPORT BRepToIGES_BRSolid(const BRepToIGES_BREntity& BR);
- //! Transfert a Shape entity from TopoDS to IGES
+ //! Transfer a Shape entity from TopoDS to IGES
//! this entity must be a Solid or a CompSolid or a Compound.
//! If this Entity could not be converted, this member returns a NullEntity.
Standard_EXPORT Handle(IGESData_IGESEntity) TransferSolid(
const TopoDS_Shape& start,
const Message_ProgressRange& theProgress = Message_ProgressRange());
- //! Transfert a Solid entity from TopoDS to IGES
+ //! Transfer a Solid entity from TopoDS to IGES
//! If this Entity could not be converted, this member returns a NullEntity.
Standard_EXPORT Handle(IGESData_IGESEntity) TransferSolid(
const TopoDS_Solid& start,
const Message_ProgressRange& theProgress = Message_ProgressRange());
- //! Transfert an CompSolid entity from TopoDS to IGES
+ //! Transfer an CompSolid entity from TopoDS to IGES
//! If this Entity could not be converted, this member returns a NullEntity.
Standard_EXPORT Handle(IGESData_IGESEntity) TransferCompSolid(
const TopoDS_CompSolid& start,
const Message_ProgressRange& theProgress = Message_ProgressRange());
- //! Transfert a Compound entity from TopoDS to IGES
+ //! Transfer a Compound entity from TopoDS to IGES
//! If this Entity could not be converted, this member returns a NullEntity.
Standard_EXPORT Handle(IGESData_IGESEntity) TransferCompound(
const TopoDS_Compound& start,
class TopoDS_Wire;
//! This class implements the transfer of Shape Entities
-//! from Geom To IGES. These can be :
+//! from Geom To IGES. These can be:
//! . Vertex
//! . Edge
//! . Wire
Standard_EXPORT BRepToIGES_BRWire(const BRepToIGES_BREntity& BR);
- //! Transfert a Shape entity from TopoDS to IGES
+ //! Transfer a Shape entity from TopoDS to IGES
//! this entity must be a Vertex or an Edge or a Wire.
//! If this Entity could not be converted,
//! this member returns a NullEntity.
Standard_EXPORT Handle(IGESData_IGESEntity) TransferWire(const TopoDS_Shape& start);
- //! Transfert a Vertex entity from TopoDS to IGES
+ //! Transfer a Vertex entity from TopoDS to IGES
//! If this Entity could not be converted,
//! this member returns a NullEntity.
Standard_EXPORT Handle(IGESData_IGESEntity) TransferVertex(const TopoDS_Vertex& myvertex);
- //! Transfert a Vertex entity on an Edge from TopoDS to IGES
+ //! Transfer a Vertex entity on an Edge from TopoDS to IGES
//! Returns the parameter of myvertex on myedge.
//! If this Entity could not be converted,
//! this member returns a NullEntity.
const TopoDS_Edge& myedge,
Standard_Real& parameter);
- //! Transfert a Vertex entity of an edge on a Face
+ //! Transfer a Vertex entity of an edge on a Face
//! from TopoDS to IGES
//! Returns the parameter of myvertex on the pcurve
//! of myedge on myface
const TopoDS_Face& myface,
Standard_Real& parameter);
- //! Transfert a Vertex entity of an edge on a Surface
+ //! Transfer a Vertex entity of an edge on a Surface
//! from TopoDS to IGES
//! Returns the parameter of myvertex on the pcurve
//! of myedge on mysurface
const TopLoc_Location& myloc,
Standard_Real& parameter);
- //! Transfert a Vertex entity on a Face from TopoDS to IGES
+ //! Transfer a Vertex entity on a Face from TopoDS to IGES
//! Returns the parameters of myvertex on myface
//! If this Entity could not be converted,
//! this member returns a NullEntity.
const TopoDS_Face& myface,
gp_Pnt2d& mypoint);
- //! Transfert an Edge 3d entity from TopoDS to IGES
+ //! Transfer an Edge 3d entity from TopoDS to IGES
//! If edge is REVERSED and isBRepMode is False 3D edge curve is reversed
//! @param[in] theEdge input edge to transfer
//! @param[in] theOriginMap shapemap contains the original shapes. Should be empty if face is not
const TopTools_DataMapOfShapeShape& theOriginMap,
const Standard_Boolean theIsBRepMode);
- //! Transfert an Edge 2d entity on a Face from TopoDS to IGES
+ //! Transfer an Edge 2d entity on a Face from TopoDS to IGES
//! @param[in] theEdge input edge to transfer
//! @param[in] theFace input face to get the surface and UV coordinates from it
//! @param[in] theOriginMap shapemap contains the original shapes. Should be empty if face is not
const Standard_Real theLength,
const Standard_Boolean theIsBRepMode);
- //! Transfert a Wire entity from TopoDS to IGES
+ //! Transfer a Wire entity from TopoDS to IGES
//! If this Entity could not be converted,
//! this member returns a NullEntity.
Standard_EXPORT Handle(IGESData_IGESEntity) TransferWire(const TopoDS_Wire& mywire);
- //! Transfert a Wire entity from TopoDS to IGES.
+ //! Transfer a Wire entity from TopoDS to IGES.
//! @param[in] theWire input wire
//! @param[in] theFace input face
//! @param[in] theOriginMap shapemap contains the original shapes. Should be empty if face is not
//! Returns the index of <myvertex>.
Standard_EXPORT Standard_Integer AddVertex(const TopoDS_Vertex& myvertex);
- //! Transfert an Edge entity from TopoDS to IGES
+ //! Transfer an Edge entity from TopoDS to IGES
Standard_EXPORT void TransferEdgeList();
//! Returns the index of <myedge> in "myEdges"
const Handle(IGESData_IGESEntity)& mycurve3d);
//! Returns the result of the transfert of any Shape
- //! If the transfer has failed, this member return a NullEntity.
+ //! If the transfer has failed, this member returns a NullEntity.
Standard_EXPORT virtual Handle(IGESData_IGESEntity) TransferShape(
const TopoDS_Shape& start,
const Message_ProgressRange& theProgress = Message_ProgressRange()) Standard_OVERRIDE;
- //! Transfert an Edge entity from TopoDS to IGES
+ //! Transfer an Edge entity from TopoDS to IGES
//! If this Entity could not be converted, this member returns a NullEntity.
Standard_EXPORT Handle(IGESData_IGESEntity) TransferEdge(const TopoDS_Edge& myedge);
- //! Transfert an Edge entity from TopoDS to IGES
+ //! Transfer an Edge entity from TopoDS to IGES
//! If this Entity could not be converted, this member returns a NullEntity.
Standard_EXPORT Handle(IGESData_IGESEntity) TransferEdge(const TopoDS_Edge& myedge,
const TopoDS_Face& myface,
const Standard_Real length);
- //! Transfert a Wire entity from TopoDS to IGES.
+ //! Transfer a Wire entity from TopoDS to IGES.
//! Returns the curve associated to mywire in the parametric space of myface.
//! If this Entity could not be converted, this member returns a NullEntity.
Standard_EXPORT Handle(IGESSolid_Loop) TransferWire(const TopoDS_Wire& mywire,
const TopoDS_Face& myface,
const Standard_Real length);
- //! Transfert a Face entity from TopoDS to IGES
+ //! Transfer a Face entity from TopoDS to IGES
//! If this Entity could not be converted, this member returns a NullEntity.
Standard_EXPORT Handle(IGESSolid_Face) TransferFace(const TopoDS_Face& start);
- //! Transfert an Shell entity from TopoDS to IGES
+ //! Transfer an Shell entity from TopoDS to IGES
//! If this Entity could not be converted, this member returns a NullEntity.
Standard_EXPORT Handle(IGESSolid_Shell) TransferShell(
const TopoDS_Shell& start,
const Message_ProgressRange& theProgress = Message_ProgressRange());
- //! Transfert a Solid entity from TopoDS to IGES
+ //! Transfer a Solid entity from TopoDS to IGES
//! If this Entity could not be converted, this member returns a NullEntity.
Standard_EXPORT Handle(IGESSolid_ManifoldSolid) TransferSolid(
const TopoDS_Solid& start,
const Message_ProgressRange& theProgress = Message_ProgressRange());
- //! Transfert an CompSolid entity from TopoDS to IGES
+ //! Transfer an CompSolid entity from TopoDS to IGES
//! If this Entity could not be converted, this member returns a NullEntity.
Standard_EXPORT Handle(IGESData_IGESEntity) TransferCompSolid(
const TopoDS_CompSolid& start,
const Message_ProgressRange& theProgress = Message_ProgressRange());
- //! Transfert a Compound entity from TopoDS to IGES
+ //! Transfer a Compound entity from TopoDS to IGES
//! If this Entity could not be converted, this member returns a NullEntity.
Standard_EXPORT Handle(IGESData_IGESEntity) TransferCompound(
const TopoDS_Compound& start,
class Geom2d_Curve;
//! This class implements the transfer of the Curve Entity from Geom2d
-//! To IGES. These can be :
+//! To IGES. These can be:
//! Curve
//! . BoundedCurve
//! * BSplineCurve
//! fields as G2dE's.
Standard_EXPORT Geom2dToIGES_Geom2dCurve(const Geom2dToIGES_Geom2dEntity& G2dE);
- //! Transfert an Entity from Geom2d to IGES. If this
+ //! Transfer an Entity from Geom2d to IGES. If this
//! Entity could not be converted, this member returns a NullEntity.
Standard_EXPORT Handle(IGESData_IGESEntity) Transfer2dCurve(const Handle(Geom2d_Curve)& start,
const Standard_Real Udeb,
class Geom2d_CartesianPoint;
//! This class implements the transfer of the Point Entity from Geom2d
-//! to IGES . These are :
+//! to IGES. These are:
//! . 2dPoint
//! * 2dCartesianPoint
class Geom2dToIGES_Geom2dPoint : public Geom2dToIGES_Geom2dEntity
//! fields as G2dE's.
Standard_EXPORT Geom2dToIGES_Geom2dPoint(const Geom2dToIGES_Geom2dEntity& G2dE);
- //! Transfert a Point from Geom to IGES. If this
+ //! Transfer a Point from Geom to IGES. If this
//! Entity could not be converted, this member returns a NullEntity.
Standard_EXPORT Handle(IGESGeom_Point) Transfer2dPoint(const Handle(Geom2d_Point)& start);
- //! Transfert a CartesianPoint from Geom to IGES. If this
+ //! Transfer a CartesianPoint from Geom to IGES. If this
//! Entity could not be converted, this member returns a NullEntity.
Standard_EXPORT Handle(IGESGeom_Point) Transfer2dPoint(
const Handle(Geom2d_CartesianPoint)& start);
class Geom2d_Direction;
//! This class implements the transfer of the Vector from Geom2d
-//! to IGES . These can be :
+//! to IGES. These can be:
//! . Vector
//! * Direction
//! * VectorWithMagnitude
//! fields as G2dE's.
Standard_EXPORT Geom2dToIGES_Geom2dVector(const Geom2dToIGES_Geom2dEntity& G2dE);
- //! Transfert a GeometryEntity which answer True to the
- //! member : BRepToIGES::IsGeomVector(Geometry). If this
+ //! Transfer a GeometryEntity which answer True to the
+ //! member : BRepToIGES::IsGeomVector(Geometry). If this
//! Entity could not be converted, this member returns a NullEntity.
Standard_EXPORT Handle(IGESGeom_Direction) Transfer2dVector(const Handle(Geom2d_Vector)& start);
class Geom_OffsetCurve;
//! This class implements the transfer of the Curve Entity from Geom
-//! To IGES. These can be :
+//! To IGES. These can be:
//! Curve
//! . BoundedCurve
//! * BSplineCurve
//! fields as GE's.
Standard_EXPORT GeomToIGES_GeomCurve(const GeomToIGES_GeomEntity& GE);
- //! Transfert a GeometryEntity which answer True to the
- //! member : BRepToIGES::IsGeomCurve(Geometry). If this
+ //! Transfer a GeometryEntity which answer True to the
+ //! member : BRepToIGES::IsGeomCurve(Geometry). If this
//! Entity could not be converted, this member returns a NullEntity.
Standard_EXPORT Handle(IGESData_IGESEntity) TransferCurve(const Handle(Geom_Curve)& start,
const Standard_Real Udeb,
class Geom_CartesianPoint;
//! This class implements the transfer of the Point Entity from Geom
-//! to IGES . These are :
+//! to IGES. These are:
//! . Point
//! * CartesianPoint
class GeomToIGES_GeomPoint : public GeomToIGES_GeomEntity
//! fields as GE's.
Standard_EXPORT GeomToIGES_GeomPoint(const GeomToIGES_GeomEntity& GE);
- //! Transfert a Point from Geom to IGES. If this
+ //! Transfer a Point from Geom to IGES. If this
//! Entity could not be converted, this member returns a NullEntity.
Standard_EXPORT Handle(IGESGeom_Point) TransferPoint(const Handle(Geom_Point)& start);
- //! Transfert a CartesianPoint from Geom to IGES. If this
+ //! Transfer a CartesianPoint from Geom to IGES. If this
//! Entity could not be converted, this member returns a NullEntity.
Standard_EXPORT Handle(IGESGeom_Point) TransferPoint(const Handle(Geom_CartesianPoint)& start);
class Geom_OffsetSurface;
//! This class implements the transfer of the Surface Entity from Geom
-//! To IGES. These can be :
+//! To IGES. These can be:
//! . BoundedSurface
//! * BSplineSurface
//! * BezierSurface
//! fields as GE's.
Standard_EXPORT GeomToIGES_GeomSurface(const GeomToIGES_GeomEntity& GE);
- //! Transfert a GeometryEntity which answer True to the
- //! member : BRepToIGES::IsGeomSurface(Geometry). If this
+ //! Transfer a GeometryEntity which answer True to the
+ //! member : BRepToIGES::IsGeomSurface(Geometry). If this
//! Entity could not be converted, this member returns a NullEntity.
Standard_EXPORT Handle(IGESData_IGESEntity) TransferSurface(const Handle(Geom_Surface)& start,
const Standard_Real Udeb,
class Geom_Direction;
//! This class implements the transfer of the Vector from Geom
-//! to IGES . These can be :
+//! to IGES. These can be:
//! . Vector
//! * Direction
//! * VectorWithMagnitude
//! fields as GE's.
Standard_EXPORT GeomToIGES_GeomVector(const GeomToIGES_GeomEntity& GE);
- //! Transfert a GeometryEntity which answer True to the
- //! member : BRepToIGES::IsGeomVector(Geometry). If this
+ //! Transfer a GeometryEntity which answer True to the
+ //! member : BRepToIGES::IsGeomVector(Geometry). If this
//! Entity could not be converted, this member returns a NullEntity.
Standard_EXPORT Handle(IGESGeom_Direction) TransferVector(const Handle(Geom_Vector)& start);
//! the Group.
Standard_EXPORT void Init(const Handle(IGESData_HArray1OfIGESEntity)& allEntities);
- //! Sets a Group to be, or not to be Ordered (according mode)
+ //! Sets a Group to be, or not to be Ordered (according mode)
Standard_EXPORT void SetOrdered(const Standard_Boolean mode);
- //! Sets a Group to be, or not to be WithoutBackP
+ //! Sets a Group to be, or not to be WithoutBackP
Standard_EXPORT void SetWithoutBackP(const Standard_Boolean mode);
//! Returns True if <me> is Ordered
//! IGESCAFControl_Writer writer();
//! Methods for writing IGES file:
//! writer.Transfer (Document);
-//! writer.Write("filename") or writer.Write(OStream) or
+//! writer.Write("filename") or writer.Write(OStream) or
//! writer.Perform(Document,"filename");
//! Methods for managing the writing of attributes.
//! Colors
Standard_EXPORT Standard_Integer FormNumber() const;
//! Returns the Entity which has been recorded for a given
- //! Field Number, i.e. without any cast. Maps with :
+ //! Field Number, i.e. without any cast. Maps with:
//! 3 : Structure 4 : LineFont 5 : LevelList 6 : View
//! 7 : Transf(ormation Matrix) 8 : LabelDisplay
//! 13 : Color. Other values give a null handle
//! gives Hierarchy status (0-1-2)
Standard_EXPORT Standard_Integer HierarchyStatus() const;
- //! Returns the LineWeight Number (0 not defined), see also LineWeight
+ //! Returns the LineWeight Number (0 not defined), see also LineWeight
Standard_EXPORT Standard_Integer LineWeightNumber() const;
//! Returns the true Line Weight, computed from LineWeightNumber and
//! Else, the file contained NO idencation at all about this list.
Standard_EXPORT Standard_Boolean ArePresentAssociativities() const;
- //! gives number of recorded associativities (0 no list defined)
+ //! gives number of recorded associativities (0 no list defined)
Standard_EXPORT Standard_Integer NbAssociativities() const;
//! Returns the Associativity List under the form of an EntityIterator.
//! Else, the file contained NO idencation at all about this list
Standard_EXPORT Standard_Boolean ArePresentProperties() const;
- //! Gives number of recorded properties (0 no list defined)
+ //! Gives number of recorded properties (0 no list defined)
Standard_EXPORT Standard_Integer NbProperties() const;
//! Returns Property List under the form of an EntityIterator
Standard_EXPORT void PrintLabel(const Handle(Standard_Transient)& ent,
Standard_OStream& S) const Standard_OVERRIDE;
- //! Prints label specific to IGES norm for a given -- --
- //! entity, i.e. its directory entry number (2*Number-1)
+ //! Prints label specific to IGES norm for a given -- --
+ //! entity, i.e. its directory entry number (2*Number-1)
//! in the log file format.
Standard_EXPORT virtual void PrintToLog(const Handle(Standard_Transient)& ent,
Standard_OStream& S) const Standard_OVERRIDE;
//! returns the current parameter number
//! This notion is involved by the organisation of an IGES list of
- //! parameter : it can be ended by two lists (Associativities and
+ //! parameters: it can be ended by two lists (Associativities and
//! Properties), which can be empty, or even absent. Hence, it is
//! necessary to know, at the end of specific reading, how many
//! parameters have been read : the optional lists follow
//! Remark : Negative or Null Pointers are ignored
//! Else ("ord" False), order is not guaranteed (faster mode)
//! If all params cannot be read as Entities, same as above
- //! Warning Give "ord" to False ONLY if order is not significant
+ //! Warning: Give "ord" to False ONLY if order is not significant
Standard_EXPORT Standard_Boolean ReadEntList(const Handle(IGESData_IGESReaderData)& IR,
const IGESData_ParamCursor& PC,
const Standard_CString mess,
//! Defines IGES Dimensioned Geometry, Type <402> Form <13>,
//! in package IGESDimen
-//! This entity has been replaced by the new form of Dimensioned
+//! This entity has been replaced by the new form of Dimensioned
//! Geometry Associativity Entity (Type 402, Form 21) and should no
//! longer be used by preprocessors.
class IGESDimen_DimensionedGeometry : public IGESData_IGESEntity
//! defines IGESViewsVisibleWithAttr, Type <402>, Form <4>
//! in package IGESDraw
//!
-//! This class is extension of Class ViewsVisible. It is used
+//! This class is extension of Class ViewsVisible. It is used
//! for those entities that are visible in multiple views, but
//! must have a different line font, color number, or
//! line weight in each view.
Standard_EXPORT Standard_Integer LineWeightItem(const Standard_Integer Index) const;
//! returns Index'th Display entity with this particular characteristics
- //! raises exception if Index <= 0 or Index > NbEntities()
+ //! raises exception if Index <= 0 or Index > NbEntities()
Standard_EXPORT Handle(IGESData_IGESEntity) DisplayedEntity(const Standard_Integer Index) const;
DEFINE_STANDARD_RTTIEXT(IGESDraw_ViewsVisibleWithAttr, IGESData_ViewKindEntity)
class IGESGeom_ConicArc;
DEFINE_STANDARD_HANDLE(IGESGeom_ConicArc, IGESData_IGESEntity)
-//! defines IGESConicArc, Type <104> Form <0-3> in package IGESGeom
+//! defines IGESConicArc, Type <104> Form <0-3> in package IGESGeom
//! A conic arc is a bounded connected portion of a parent
//! conic curve which consists of more than one point. The
//! parent conic curve is either an ellipse, a parabola, or
//! False otherwise.
Standard_EXPORT Standard_Boolean HasColorName() const;
- //! if HasColorName() is True returns the Verbal description of
+ //! if HasColorName() is True returns the Verbal description of
//! the Color.
Standard_EXPORT Handle(TCollection_HAsciiString) ColorName() const;
//! - aMirrorFlag : Mirror Flag
//! - aRotationFlag : Rotate internal text flag
//! - aCorner : Lower left corner coordinates(Form No. 0),
- //! Increments from coordinates (Form No. 1)
+ //! Increments from coordinates (Form No. 1)
Standard_EXPORT void Init(const Standard_Real aWidth,
const Standard_Real aHeight,
const Standard_Integer aFontCode,
//! or Basolute (Form 0) else
Standard_EXPORT void SetIncremental(const Standard_Boolean mode);
- //! returns True if entity is Incremental (Form 1).
- //! False if entity is Absolute (Form 0).
+ //! returns True if entity is Incremental (Form 1).
+ //! False if entity is Absolute (Form 0).
Standard_EXPORT Standard_Boolean IsIncremental() const;
//! returns Character Box Width.
//! returns pen status(True if 1, False if 0) of Motionnum'th motion
//! of Chnum'th character.
//! Exception raised if Chnum <= 0 or Chnum > NbCharacters or
- //! Motionnum <= 0 or Motionnum > NbPenMotions
+ //! Motionnum <= 0 or Motionnum > NbPenMotions
Standard_EXPORT Standard_Boolean IsPenUp(const Standard_Integer Chnum,
const Standard_Integer Motionnum) const;
//! Sets Format for Range to a new value with its range of
//! application.
//! To cancel it, give format as "" (empty string)
- //! Remark that if the condition (0. < Rmin < Rmax) is not
+ //! Remark that if the condition (0. < Rmin < Rmax) is not
//! verified, this secondary format will be ignored.
//! Moreover, this secondary format is intended to be used in a
//! range around 1.
//! IGESTypeForm is a Signature specific to the IGES Norm :
//! it gives the signature under two possible forms :
//! - as "mmm nnn", with "mmm" as IGES Type Number, and "nnn"
-//! as IGES From Number (even if = 0) [Default]
+//! as IGES From Number (even if = 0) [Default]
//! - as "mmm" alone, which gives only the IGES Type Number
class IGESSelect_IGESTypeForm : public IFSelect_Signature
{
// commercial license or contractual agreement.
//=======================================================================
-// purpose : Members to transfert any BRepEntity into TopoDS_Shape
+// purpose : Members to transfer any BRepEntity into TopoDS_Shape
//=======================================================================
// 21.12.98 rln, gka S4054
// #62 rln 10.01.99 PRO17015
public:
DEFINE_STANDARD_ALLOC
- //! Creates a tool BRepEntity ready to run, with
- //! epsilons set to 1.E-04, TheModeTopo to True, the
- //! optimization of the continuity to False.
+ //! Creates a tool BRepEntity ready to run, with
+ //! epsilons set to 1.E-04, TheModeTopo to True, the
+ //! optimization of the continuity to False.
Standard_EXPORT IGESToBRep_BRepEntity();
//! Creates a tool BRepEntity ready to run and sets its
//! Provides methods to transfer basic geometric curves entities
//! from IGES to CASCADE.
-//! These can be :
+//! These can be:
//! * Circular arc
//! * Conic arc
//! * Spline curve
public:
DEFINE_STANDARD_ALLOC
- //! Creates a tool BasicCurve ready to run, with
- //! epsilons set to 1.E-04, TheModeTopo to True, the
- //! optimization of the continuity to False.
+ //! Creates a tool BasicCurve ready to run, with
+ //! epsilons set to 1.E-04, TheModeTopo to True, the
+ //! optimization of the continuity to False.
Standard_EXPORT IGESToBRep_BasicCurve();
//! Creates a tool BasicCurve ready to run and sets its
const Standard_Boolean modeapprox,
const Standard_Boolean optimized);
- //! Transfert a IGESEntity which answer True to the
- //! member : IGESToBRep::IsBasicCurve(IGESEntity). If this
+ //! Transfer a IGESEntity which answer True to the
+ //! member : IGESToBRep::IsBasicCurve(IGESEntity). If this
//! Entity could not be converted, this member returns a NullEntity.
Standard_EXPORT Handle(Geom_Curve) TransferBasicCurve(const Handle(IGESData_IGESEntity)& start);
- //! Transfert a IGESEntity which answer True to the
+ //! Transfert a IGESEntity which answer True to the
//! member : IGESToBRep::IsBasicCurve(IGESEntity).
//! The IGESEntity must be a curve UV and its associed TRSF must
- //! be planar .If this Entity could not be converted, this member
+ //! be planar. If this Entity could not be converted, this member
//! returns a NullEntity.
Standard_EXPORT Handle(Geom2d_Curve) Transfer2dBasicCurve(
const Handle(IGESData_IGESEntity)& start);
//! Provides methods to transfer basic geometric surface entities
//! from IGES to CASCADE.
-//! These can be :
+//! These can be:
//! * Spline surface
//! * BSpline surface
class IGESToBRep_BasicSurface : public IGESToBRep_CurveAndSurface
public:
DEFINE_STANDARD_ALLOC
- //! Creates a tool BasicSurface ready to run, with
- //! epsilons set to 1.E-04, TheModeTopo to True, the
+ //! Creates a tool BasicSurface ready to run, with
+ //! epsilons set to 1.E-04, TheModeTopo to True, the
//! optimization of the continuity to False.
Standard_EXPORT IGESToBRep_BasicSurface();
const Standard_Boolean modeapprox,
const Standard_Boolean optimized);
- //! Returns Surface from Geom if the last transfer has succeeded.
+ //! Returns Surface from Geom if the last transfer has succeeded.
Standard_EXPORT Handle(Geom_Surface) TransferBasicSurface(
const Handle(IGESData_IGESEntity)& start);
Standard_EXPORT Handle(Geom_ToroidalSurface) TransferToroidalSurface(
const Handle(IGESSolid_ToroidalSurface)& start);
- //! Returns BSplineSurface from Geom if the transfer has succeeded.
+ //! Returns BSplineSurface from Geom if the transfer has succeeded.
Standard_EXPORT Handle(Geom_BSplineSurface) TransferSplineSurface(
const Handle(IGESGeom_SplineSurface)& start);
- //! Returns BSplineSurface from Geom if the transfer has succeeded.
+ //! Returns BSplineSurface from Geom if the transfer has succeeded.
Standard_EXPORT Handle(Geom_BSplineSurface) TransferBSplineSurface(
const Handle(IGESGeom_BSplineSurface)& start);
};
public:
DEFINE_STANDARD_ALLOC
- //! Creates a tool CurveAndSurface ready to run, with
- //! epsilons set to 1.E-04, myModeTopo to True, the
- //! optimization of the continuity to False.
+ //! Creates a tool CurveAndSurface ready to run, with
+ //! epsilons set to 1.E-04, myModeTopo to True, the
+ //! optimization of the continuity to False.
Standard_EXPORT IGESToBRep_CurveAndSurface();
//! Creates a tool CurveAndSurface ready to run.
// commercial license or contractual agreement.
//=======================================================================
-// purpose : Members to transfert any IGES Curves into TopoDS_Shape
+// purpose : Members to transfer any IGES Curves into TopoDS_Shape
//=======================================================================
// modif mjm du 23/09/97 : appel a ShapeTool en remplacement a PCurveLib
// 21.12.98 rln, gka S4054
public:
DEFINE_STANDARD_ALLOC
- //! Creates a tool TopoCurve ready to run, with
- //! epsilons set to 1.E-04, TheModeTopo to True, the
- //! optimization of the continuity to False.
+ //! Creates a tool TopoCurve ready to run, with
+ //! epsilons set to 1.E-04, TheModeTopo to True, the
+ //! optimization of the continuity to False.
Standard_EXPORT IGESToBRep_TopoCurve();
//! Creates a tool TopoCurve ready to run and sets its
public:
DEFINE_STANDARD_ALLOC
- //! Creates a tool TopoSurface ready to run, with
- //! epsilons set to 1.E-04, TheModeTopo to True, the
- //! optimization of the continuity to False.
+ //! Creates a tool TopoSurface ready to run, with
+ //! epsilons set to 1.E-04, TheModeTopo to True, the
+ //! optimization of the continuity to False.
Standard_EXPORT IGESToBRep_TopoSurface();
//! Creates a tool TopoSurface ready to run and sets its
class Interface_Protocol;
class TCollection_HAsciiString;
-//! This class allows to consult and prepare/edit data stored in
-//! a Step Model Header
+//! This class allows to consult and prepare/edit data stored in
+//! a Step Model Header
class APIHeaderSection_MakeHeader
{
public:
public:
DEFINE_STANDARD_ALLOC
- //! enforced the initialisation of the libraries
+ //! enforced the initialisation of the libraries
Standard_EXPORT static void Init();
};
public:
DEFINE_STANDARD_ALLOC
- //! enforced the initialisation of the libraries
+ //! enforced the initialisation of the libraries
Standard_HIDDEN static void Init();
};
Standard_EXPORT Standard_Real SolidAngleFactor() const;
//! Returns the Uncertainty value (for length)
- //! It has been converted with LengthFactor
+ //! It has been converted with LengthFactor
Standard_EXPORT Standard_Real Uncertainty() const;
//! Returns the areaFactor
//! Displays the statistics for the
//! last translation. what defines the kind of statistics that are displayed:
- //! - 0 gives general statistics (number of translated roots,
- //! number of warnings, number of fail messages),
+ //! - 0 gives general statistics (number of translated roots,
+ //! number of warnings, number of fail messages),
//! - 1 gives root results,
//! - 2 gives statistics for all checked entities,
//! - 3 gives the list of translated entities,
//! returns Value as a PropertyDefinition (Null if another type)
Standard_EXPORT virtual Handle(StepRepr_PropertyDefinition) PropertyDefinition() const;
- //! returns Value as a ShapeRepresentation (Null if another type)
+ //! returns Value as a ShapeRepresentation (Null if another type)
Standard_EXPORT virtual Handle(StepShape_ShapeRepresentation) ShapeRepresentation() const;
//! returns Value as a SecurityClassification (Null if another type)
//! returns Value as a Approval (Null if another type)
Standard_EXPORT Handle(StepBasic_Approval) Approval() const;
- //! returns Value as a (Null if another type)
+ //! returns Value as a (Null if another type)
Standard_EXPORT Handle(StepRepr_DescriptiveRepresentationItem) DescriptiveRepresentationItem()
const;
DEFINE_STANDARD_HANDLE(StepData_DefaultGeneral, StepData_GeneralModule)
//! DefaultGeneral defines a GeneralModule which processes
-//! Unknown Entity from StepData only
+//! Unknown Entity from StepData only
class StepData_DefaultGeneral : public StepData_GeneralModule
{
//! Sets a Logical Value (or predeclares a list as logical)
Standard_EXPORT void SetLogical(const StepData_Logical val = StepData_LFalse);
- //! Sets a Real Value (or predeclares a list as Real);
+ //! Sets a Real Value (or predeclares a list as Real);
Standard_EXPORT void SetReal(const Standard_Real val = 0.0);
//! Sets a String Value (or predeclares a list as String)
//! Warning : conflicts are not controlled
Standard_EXPORT Standard_Integer& LabelMode();
- //! TypeMode controls the type form to use :
+ //! TypeMode controls the type form to use :
//! 0 (D) for normal long form
//! 1 for short form (if a type name has no short form, normal
//! long form is then used)
//! returns Value as a Datum (Null if another type)
Standard_EXPORT Handle(StepDimTol_Datum) Datum() const;
- //! returns Value as a CommonDatumList (Null if another type)
+ //! returns Value as a CommonDatumList (Null if another type)
Standard_EXPORT Handle(StepDimTol_HArray1OfDatumReferenceElement) CommonDatumList() const;
};
#endif // _StepDimTol_DatumOrCommonDatum_HeaderFile
class StepElement_CurveElementFreedomMember;
DEFINE_STANDARD_HANDLE(StepElement_CurveElementFreedomMember, StepData_SelectNamed)
-//! Representation of member for STEP SELECT type CurveElementFreedom
+//! Representation of member for STEP SELECT type CurveElementFreedom
class StepElement_CurveElementFreedomMember : public StepData_SelectNamed
{
class StepElement_CurveElementPurposeMember;
DEFINE_STANDARD_HANDLE(StepElement_CurveElementPurposeMember, StepData_SelectNamed)
-//! Representation of member for STEP SELECT type CurveElementPurpose
+//! Representation of member for STEP SELECT type CurveElementPurpose
class StepElement_CurveElementPurposeMember : public StepData_SelectNamed
{
class StepElement_ElementAspectMember;
DEFINE_STANDARD_HANDLE(StepElement_ElementAspectMember, StepData_SelectNamed)
-//! Representation of member for STEP SELECT type ElementAspect
+//! Representation of member for STEP SELECT type ElementAspect
class StepElement_ElementAspectMember : public StepData_SelectNamed
{
class StepElement_MeasureOrUnspecifiedValueMember;
DEFINE_STANDARD_HANDLE(StepElement_MeasureOrUnspecifiedValueMember, StepData_SelectNamed)
-//! Representation of member for STEP SELECT type MeasureOrUnspecifiedValue
+//! Representation of member for STEP SELECT type MeasureOrUnspecifiedValue
class StepElement_MeasureOrUnspecifiedValueMember : public StepData_SelectNamed
{
class StepElement_SurfaceElementPurposeMember;
DEFINE_STANDARD_HANDLE(StepElement_SurfaceElementPurposeMember, StepData_SelectNamed)
-//! Representation of member for STEP SELECT type SurfaceElementPurpose
+//! Representation of member for STEP SELECT type SurfaceElementPurpose
class StepElement_SurfaceElementPurposeMember : public StepData_SelectNamed
{
class StepElement_VolumeElementPurposeMember;
DEFINE_STANDARD_HANDLE(StepElement_VolumeElementPurposeMember, StepData_SelectNamed)
-//! Representation of member for STEP SELECT type VolumeElementPurpose
+//! Representation of member for STEP SELECT type VolumeElementPurpose
class StepElement_VolumeElementPurposeMember : public StepData_SelectNamed
{
class StepFEA_DegreeOfFreedomMember;
DEFINE_STANDARD_HANDLE(StepFEA_DegreeOfFreedomMember, StepData_SelectNamed)
-//! Representation of member for STEP SELECT type CurveElementFreedom
+//! Representation of member for STEP SELECT type CurveElementFreedom
class StepFEA_DegreeOfFreedomMember : public StepData_SelectNamed
{
class StepFEA_SymmetricTensor23dMember;
DEFINE_STANDARD_HANDLE(StepFEA_SymmetricTensor23dMember, StepData_SelectArrReal)
-//! Representation of member for STEP SELECT type SymmetricTensor23d
+//! Representation of member for STEP SELECT type SymmetricTensor23d
class StepFEA_SymmetricTensor23dMember : public StepData_SelectArrReal
{
class StepFEA_SymmetricTensor43dMember;
DEFINE_STANDARD_HANDLE(StepFEA_SymmetricTensor43dMember, StepData_SelectArrReal)
-//! Representation of member for STEP SELECT type SymmetricTensor43d
+//! Representation of member for STEP SELECT type SymmetricTensor43d
class StepFEA_SymmetricTensor43dMember : public StepData_SelectArrReal
{
projects / occt.git / commitdiff