diff --git a/dox/FILES.txt b/dox/FILES.txt
index 50d4b4748d..77dd56c171 100644
--- a/dox/FILES.txt
+++ b/dox/FILES.txt
@@ -21,6 +21,11 @@ user_guides/ocaf/ocaf.md
user_guides/tobj/tobj.md
user_guides/shape_healing/shape_healing.md
user_guides/draw_test_harness.md
+user_guides/brep_wp/brep_wp.md
+user_guides/ocaf_functionmechanism_wp/ocaf_functionmechanism_wp.md
+user_guides/ocaf_tree_wp/ocaf_tree_wp.md
+user_guides/ocaf_wp/ocaf_wp.md
+user_guides/voxels_wp/voxels_wp.md
dev_guides/dev_guides.md
dev_guides/contribution/coding_rules.md
@@ -28,6 +33,9 @@ dev_guides/cdl/cdl.md
dev_guides/tests/tests.md
dev_guides/documentation/documentation.md
dev_guides/wok/wok.md
+dev_guides/contribution_workflow/contribution_workflow.md
+dev_guides/git_guide/git_guide.md
+
dev_guides/building/building.md
dev_guides/building/3rdparty/3rdparty_windows.md
diff --git a/dox/dev_guides/cdl/cdl.md b/dox/dev_guides/cdl/cdl.md
index 327170b442..a54a4be222 100644
--- a/dox/dev_guides/cdl/cdl.md
+++ b/dox/dev_guides/cdl/cdl.md
@@ -7,7 +7,7 @@
Please note that CDL is considered as obsolete and is to be removed in one of future releases of OCCT.
-@section occt_1819379591_354121062 CDL and Application Architecture
+@section occt_cdl_1 CDL and Application Architecture
CDL is the component definition language of the Open CASCADE Technology (**OCCT**) programming platform. Some components, which CDL allows you to create, are specific to OCCT application architecture. These and other components, which you can define using CDL include the following:
@@ -16,71 +16,61 @@ CDL is the component definition language of the Open CASCADE Technology (**OCCT
* Schema
* Executable
* Client.
+
A **class** is the fundamental software component in object-oriented development. Because of a very large number of resources used in large-scale applications, the **class** itself is too small to be used as a basic management unit.
-So, while the class is the basic data component defined in CDL, this language also provides a way to group classes, **enumerations**, and **exceptions **together – the **package**. A package groups together a number of classes, which have semantic links. For example, a geometry package would contain Point, Line, and Circle classes. A package can also contain enumerations, exceptions, and package methods. In practice, a class name is prefixed with the name of its package e.g. Geom_Circle.
+So, while the class is the basic data component defined in CDL, this language also provides a way to group classes, **enumerations**, and **exceptions** together – the **package**. A package groups together a number of classes, which have semantic links. For example, a geometry package would contain Point, Line, and Circle classes. A package can also contain enumerations, exceptions, and package methods. In practice, a class name is prefixed with the name of its package e.g. *Geom_Circle*.
Using the services described in the **packages**, you can construct an **executable**. You can also group together services provided by **packages**.
To save data in a file, you need to define persistent classes. Then, you group these classes in a schema, which provides the necessary read/write tools.
- @image html /dev_guides/cdl/images/cdl_image003.png
- @image latex /dev_guides/cdl/images/cdl_image003.png
-
-Figure 1. Building an Open CASCADE Technology application
-@section occt_1819379591_986437237 2. Introduction to CDL
-@subsection occt_1819379591_98643723721 Purposes of the Language
+@image html /dev_guides/cdl/images/cdl_image003.png "Building an Open CASCADE Technology application"
+@image latex /dev_guides/cdl/images/cdl_image003.png "Building an Open CASCADE Technology application"
+
+@section occt_cdl_2 Introduction to CDL
+@subsection occt_cdl_2_1 Purposes of the Language
+
You can use CDL to **define** **data** in the Open CASCADE Technology environment. CDL allows you to define various kinds of data types supporting the application architecture and development methodology, which you envision. CDL is neither an analysis formalism (e.g. Booch methodology) nor a data manipulation language (e.g. C++).
You use CDL in the **design** **phase** of a development process to define a set of software components which best model the concepts stated in the application specification.
- @image html /dev_guides/cdl/images/cdl_image004.png
- @image latex /dev_guides/cdl/images/cdl_image004.png
+@image html /dev_guides/cdl/images/cdl_image004.png "The Development Process"
+@image latex /dev_guides/cdl/images/cdl_image004.png "The Development Process"
-Figure 2. The Development Process
-From a structural point of view, CDL is an object-oriented language. It is centered on the notion of the **class **- a data type, which represents an elementary concept. CDL offers various means of organizing classes, mostly under the fundamental form of **packages**. A package contains a set of classes, which share some semantic relationship. This greatly simplifies your task of managing individual classes when confronted with a very large number of them.
+From a structural point of view, CDL is an object-oriented language. It is centered on the notion of the **class** - a data type, which represents an elementary concept. CDL offers various means of organizing classes, mostly under the fundamental form of **packages**. A package contains a set of classes, which share some semantic relationship. This greatly simplifies your task of managing individual classes when confronted with a very large number of them.
-Once you have defined the classes and packages using CDL, you can implement their **methods **- i.e., their functionality - in one of the data manipulation languages supported by the OCCT environment (currently C++).
+Once you have defined the classes and packages using CDL, you can implement their **methods** - i.e., their functionality - in one of the data manipulation languages supported by the OCCT environment (currently C++).
Even though you can describe classes directly in C++ and save them as header files (.hxx), to do so would forfeit all the advantages of using CDL. These are:
* Precise, complete, and easy-to-read description of the software components.
* Creation of a link with the database; object persistence forms part of the predefined environment of the language.
* Multi-language access to the services of an application engine – a specific architectural form created using the CDL tools, which serves as the motor of an application.
-@subsection occt_1819379591_98643723722 Overview of CDL
+
+@subsection occt_cdl_2_2 Overview of CDL
-CDL is an object-oriented language. In other words, it structures a system around data types rather than around the actions carried out on them. In this context, an **object **is an **instance **of a data type, and its definition determines how you can use it. Each data type is implemented by one or more classes, which make up the basic elements of the system.
-@subsubsection occt_1819379591_986437237221 Classes
+CDL is an object-oriented language. In other words, it structures a system around data types rather than around the actions carried out on them. In this context, an **object** is an **instance** of a data type, and its definition determines how you can use it. Each data type is implemented by one or more classes, which make up the basic elements of the system.
-A class is an implementation of a **data type**. It defines its **behavior **and its **representation**.
+@subsubsection occt_cdl_2_2_1 Classes
-The behavior of a class is its programming interface - the services offered by its **methods**. The representation of a class is its data structure - the **fields**,** **which store its data.
+A class is an implementation of a **data type**. It defines its **behavior** and its **representation**.
-Every object is an **instance **of its class. For example, the object *p *of the data type *Point *is an instance of the class Point.
+The behavior of a class is its programming interface - the services offered by its **methods**. The representation of a class is its data structure - the **fields**, which store its data.
+
+Every object is an **instance** of its class. For example, the object *p* of the data type *Point* is an instance of the class *Point*.
The class Point could be defined as in the example below:
@code
class Point from GeomPack
-@endcode
-@code
---Purpose: represents a point in 3D space.
-@endcode
-@code
is
-@endcode
-@code
Create returns Point;
-@endcode
-@code
fields
-@endcode
-@code
x, y, z : Real;
-@endcode
-@code
end Point;
@endcode
@@ -89,53 +79,59 @@ The definition of this class comprises two sections:
* one starting with the keywords **is**
* one starting with the keyword **fields**.
-The first section contains a list of methods available to the clients of the class. The second section defines the way in which instances are represented. Once this class has been compiled you could **instantiate **its data type in a C++ test program as in the example below:
+The first section contains a list of methods available to the clients of the class. The second section defines the way in which instances are represented. Once this class has been compiled you could **instantiate** its data type in a C++ test program as in the example below:
@code
GeomPack_Point p;
@endcode
-@subsubsection occt_1819379591_986437237222 Categories of Types
-You declare the variables of a **data manipulation language **as being of certain data types. These fall into two categories:
+
+@subsubsection occt_cdl_2_2_2 Categories of Types
+
+You declare the variables of a **data manipulation language** as being of certain data types. These fall into two categories:
* Data types manipulated by handle (or reference)
* Data types manipulated by value
- @image html /dev_guides/cdl/images/cdl_image005.png
- @image latex /dev_guides/cdl/images/cdl_image005.png
-
-Figure 3. Manipulation of data types
-
+ @image html /dev_guides/cdl/images/cdl_image005.png "Manipulation of data types"
+ @image latex /dev_guides/cdl/images/cdl_image005.png "Manipulation of data types"
As seen above, you implement data types using classes. However, classes not only define their data representation and methods available for their instances, but they also define how the instances will be manipulated:
* A data type manipulated by value contains the instance itself.
* A data type manipulated by handle contains a reference to the instance.
-The most obvious examples of data types manipulated by value are the predefined **primitive types**: Boolean, Character, Integer, Real ...
+The most obvious examples of data types manipulated by value are the predefined **primitive types**: Boolean, Character, Integer, Real...
A variable of a data type manipulated by handle, which is not attached to an object, is said to be **null**. To reference an object, you need to instantiate the class with one of its constructors. This is done in C++ as in the following syntax:
+~~~~~
+Handle(myClass) m = new myClass;
+~~~~~
-@subsubsection occt_1819379591_986437237223 Persistence
+@subsubsection occt_cdl_2_2_3 Persistence
-An object is called **persistent **if it can be permanently stored. In other words, you can use the object again at a later date, both in the application, which created it, and in another application.
+An object is called **persistent** if it can be permanently stored. In other words, you can use the object again at a later date, both in the application, which created it, and in another application.
-In order to make an object persistent, you need to declare it in CDL as inheriting from the **Persistent** class, or to have one of its parent classes inheriting from the **Persistent **class.
+In order to make an object persistent, you need to declare it in CDL as inheriting from the **Persistent** class, or to have one of its parent classes inheriting from the *Persistent* class.
-Note that the classes inheriting from the Persistent class are handled by reference.
+Note that the classes inheriting from the *Persistent* class are handled by reference.
**Example**
+~~~~~
+class Watch inherits Persistent
+~~~~~
-In this example, building the application, you add the Watch class to the corresponding schema of data types.
-If, running the application, you instantiate an object of the Watch class, you have the possibility of storing it in a file.
-You cannot store objects instantiated from classes, which inherit from the **Storable** class. However, you can store them as fields of an object, which inherits from Persistent.
+In this example, building the application, you add the *Watch* class to the corresponding schema of data types.
+If, running the application, you instantiate an object of the *Watch* class, you have the possibility of storing it in a file.
+You cannot store objects instantiated from classes, which inherit from the *Storable* class. However, you can store them as fields of an object, which inherits from *Persistent*.
Note that the objects inheriting from Storable are handled by value.
-**Example**
+**Example**
+~~~~~
If
class WatchSpring inherits Storable
//then this could be stored as a field of a Watch
@@ -146,31 +142,33 @@ fields
name : ConstructorName;
powersource : WatchSpring;
end;
+~~~~~
+@subsubsection occt_cdl_2_2_4 Packages
-@subsubsection occt_1819379591_986437237224 Packages
+In large-scale long-term development the task of marshalling potentially thousands of classes is likely to quickly prove unmanageable. CDL introduces the notion of **package** of classes containing a set of classes, which have some semantic or syntactic relationship. For example, all classes representing a particular set of electronic components might make up a package called Diode.
-In large-scale long-term development the task of marshalling potentially thousands of classes is likely to quickly prove unmanageable. CDL introduces the notion of **package **of classes containing a set of classes, which have some semantic or syntactic relationship. For example, all classes representing a particular set of electronic components might make up a package called Diode.
+As the package name prefixes the class name when implementing such class (in C++ for example), classes belonging to different packages can have the same name. For example, two packages, one dealing with finance and the other dealing with aircraft maneuvers, might both contain a class called *Bank*, without any possibility of confusion.
-As the package name prefixes the class name when implementing such class (in C++ for example), classes belonging to different packages can have the same name. For example, two packages, one dealing with finance and the other dealing with aircraft maneuvers, might both contain a class called Bank, without any possibility of confusion.
**Example**
-
+~~~~~
Finance_Bank
Attitude_Bank
+~~~~~
-
-@subsubsection occt_1819379591_986437237225 Inheritance
+@subsubsection occt_cdl_2_2_5 Inheritance
The purpose of inheritance is to reduce development workload. The inheritance mechanisms allow you to declare a new class as already containing the characteristics of an existing class. This new class can then be rapidly specialized for a task at hand. This eliminates the necessity of developing each component “from scratch”.
-For example, having already developed a class BankAccount, you can quickly specialize new classes - SavingsAccount, LongTermDepositAccount, MoneyMarketAccount, RevolvingCreditAccount, etc..
+For example, having already developed a class *BankAccount*, you can quickly specialize new classes - *SavingsAccount, LongTermDepositAccount, MoneyMarketAccount, RevolvingCreditAccount*, etc..
-As a consequence, when two or more classes inherit from a parent (or ancestor) class, all these classes surely inherit the behavior of their parent (or ancestor). For example, if the parent class BankAccount contains the method Print that tells it to print itself out, then all its descendent classes offer the same service.
+As a consequence, when two or more classes inherit from a parent (or ancestor) class, all these classes surely inherit the behavior of their parent (or ancestor). For example, if the parent class *BankAccount* contains the method *Print* that tells it to print itself out, then all its descendent classes offer the same service.
One way of ensuring the use of inheritance is to declare classes at the top of a hierarchy as being **deferred**. In such classes, the inherited methods are not implemented. This forces you to create a new class used to redefine the methods. In this way, you guarantee a certain minimum common behavior among descendent classes.
-**Example**
+**Example**
+~~~~~
deferred class BankAccount inherits Persistent
is
.......
@@ -178,36 +176,40 @@ fields
name : AccountHolderName;
balance : CreditBalance;
end;
+~~~~~
-
-@subsubsection occt_1819379591_986437237226 Genericity
+@subsubsection occt_cdl_2_2_6 Genericity
You will often wish to model a certain type of behavior as a class. For example, you will need a list modeled as a class.
-In order to be able to list different objects, the class **List **must be able to accept different data types as parameters. This is where genericity comes in: you first declare a list declared as the generic class **List**, willing to accept any data type (or only a particular set of acceptable data types). Then, when you want to make a list of a certain type of object, you instantiate the class **List **with the appropriate data type.
+In order to be able to list different objects, the class *List* must be able to accept different data types as parameters. This is where genericity comes in: you first declare a list declared as the generic class *List*, willing to accept any data type (or only a particular set of acceptable data types). Then, when you want to make a list of a certain type of object, you instantiate the class *List* with the appropriate data type.
+
**Example**
+~~~~~
generic class NewList (Item)
inherits OldList
is
.....
end ;
+~~~~~
Items may be of any type, an Integer or a Real for example.
When defining the package, add the following line:
**Example**
-
+~~~~~
class NewListOfInteger instantiates
NewList (Integer);
+~~~~~
-
-@subsubsection occt_1819379591_986437237227 Exceptions
+@subsubsection occt_cdl_2_2_7 Exceptions
The behavior of any object is implemented by methods, which you define in its class declaration. The definition of these methods includes not only their signature (their programming interface) but also their domain of validity.
In CDL, this domain is expressed by **exceptions**. Exceptions are raised under various error conditions. This mechanism is a safeguard of software quality.
-@subsubsection occt_1819379591_986437237228 Completeness
+
+@subsubsection occt_cdl_2_2_8 Completeness
You use CDL to define data types. Such definitions are not considered complete unless they contain the required amount of structured commentary.
@@ -216,67 +218,63 @@ The compiler does not enforce this required degree of completeness, so it is th
Completeness is regarded as an essential component of long-term viability of a software component.
-@subsection occt_1819379591_98643723723 Lexical Conventions
-@subsubsection occt_1819379591_986437237231 Syntax notation
+@subsection occt_cdl_2_3 Lexical Conventions
+@subsubsection occt_cdl_2_3_1 Syntax notation
In this manual, CDL declarations are described using a simple variant of the Backus-Naur formalism. Note the following:
- * Italicized words, which may also be hyphenated, denote syntactical categories, for example:
-
-*declaration-of-a-non-generic-class*
-
- * Keywords appear in bold type:
-
-**class**
-
- * Brackets enclose optional elements:
-
-identifier [**from **package-name]
-
- * Curly braces enclose repeated elements. The element may appear zero or many times:
-
-integer ::= digit{digit}
-
+ * Italicized words, which may also be hyphenated, denote syntactical categories, for example *declaration-of-a-non-generic-class* ;
+ * Keywords appear in bold type: **class** ;
+ * Brackets enclose optional elements:
+~~~~~
+ identifier [from package-name]
+~~~~~
+ * Curly braces enclose repeated elements. The element may appear zero or many times:
+~~~~~
+ integer ::= digit{digit}
+~~~~~
* Vertical bars separate alternatives:
-
-passing-method ::= [**in**] | **out **| **in out**
-
+~~~~~
+passing-method ::= [in] | out | in out
+~~~~~
* Two apostrophes enclose a character or a string of characters, which must appear:
-
+~~~~~
exponent ::= ’E’[’+’]integer | ’E-’ integer
-
-NOTE
-So as to introduce ideas progressively, the examples presented in this manual may be incomplete, and thus not compilable by the CDL compiler.
+~~~~~
+**NOTE** To introduce the ideas progressively, the examples presented in this manual may be incomplete, and thus not compilable by the CDL compiler.
-@subsubsection occt_1819379591_986437237232 Lexical elements
+@subsubsection occt_cdl_2_3_2 Lexical elements
A CDL source is composed of text from one or more compiled units. The text of each compiled unit is a string of separate lexical elements: **identifiers**, **keywords**, **constants**, and **separators**. The separators (blank spaces, end of line, format characters) are ignored by the CDL compiler, but these are often necessary for separating identifiers, keywords, and constants.
-@subsubsection occt_1819379591_986437237233 Comments
+@subsubsection occt_cdl_2_3_3 Comments
With CDL, you cannot use the expression of all useful information about a development unit. In particular, certain information is more easily expressed in natural language. You can add such information to the CDL description of a data type.
Rubrics and free comments are to be differentiated:
-**Free comments **are preceded by the characters “--” (two hyphens), and they terminate at the end of the line in which they appear.
+**Free comments** are preceded by the characters “--” (two hyphens), and they terminate at the end of the line in which they appear.
**Example**
-
+~~~~~
--This is a comment
+~~~~~
-Unlike rubrics, free comments can appear before or after any lexical element. The first written character of the comment itself *must not *be a hyphen. If a hyphen is necessary make sure it is preceded by a blank.
+Unlike rubrics, free comments can appear before or after any lexical element. The first written character of the comment itself *must not* be a hyphen. If a hyphen is necessary make sure it is preceded by a blank.
**Example**
-
+~~~~~
-- -List item
+~~~~~
+**Rubrics** are various types of comments attached to CDL components. A rubric is a comment made up of three hyphens, name of the rubric (without any intermediary space) and then a colon and a space. It is terminated by the beginning of the following rubric, or by the end of the commentary.
-**Rubrics **are various types of comments attached to CDL components. A rubric is a comment made up of three hyphens, name of the rubric (without any intermediary space) and then a colon and a space. It is terminated by the beginning of the following rubric, or by the end of the commentary.
**Example**
-
+~~~~~
---Purpose:This is an example of a
--rubric composed of a
--comment which extends to
--four lines.
+~~~~~
The different categories of rubrics and the form of their content do not depend on the Component Description Language, but on the tool for which it is intended.
@@ -291,33 +289,64 @@ These rubrics can be attached to:
* Executables
* Clients
-@subsubsection occt_1819379591_986437237234 Identifiers
+@subsubsection occt_cdl_2_3_4 Identifiers
An identifier is an arbitrary chain of characters, either letters or digits, but it must begin with a letter.
The underscore “_” is considered to be a letter as long as it doesn’t appear at the beginning or the end of an identifier.
+
Capital and small letters are not equivalent (i.e. AB, Ab, aB, ab are four different identifiers).
-@subsubsection occt_1819379591_986437237235 Keywords
+@subsubsection occt_cdl_2_3_5 Keywords
The following is a list of keywords.
-alias any as asynchronous
-class client deferred end
-enumeration exception executable external
-fields friends from generic
-immutable imported inherits instantiates
-is library like me
-mutable myclass out package
-pointer primitive private protected
-raises redefined returns schema
-static to uses virtual
+* alias
+* any
+* as
+* asynchronous
+* class
+* client
+* deferred
+* end
+* enumeration
+* exception
+* executable
+* external
+* fields
+* friends
+* from
+* generic
+* immutable
+* imported
+* inherits
+* instantiates
+* is
+* library
+* like
+* me
+* mutable
+* myclass
+* out
+* package
+* pointer
+* primitive
+* private
+* protected
+* raises
+* redefined
+* returns
+* schema
+* static
+* to
+* uses
+* virtual
In a CDL file, the following characters are used as punctuation:
; : , = ( ) [ ] ‘ “
-@subsubsection occt_1819379591_986437237236 Constants
+@subsubsection occt_cdl_2_3_6 Constants
There are three categories of constants:
@@ -325,123 +354,131 @@ There are three categories of constants:
* Literal
* Named
-***Numeric Constants***
+#### Numeric Constants
There are two types of numeric constants: integer and real.
-An **integer **constant consists of a string of digits, which may or may not be preceded by a sign. Integer constants express whole numbers.
-**Examples**
+An **integer** constant consists of a string of digits, which may or may not be preceded by a sign. Integer constants express whole numbers.
+
+**Examples**
+~~~~~
1995 0 -273 +78
+~~~~~
+A **real** constant may or may not be preceded by a sign, and consists of an integral part followed by a decimal point and a fractional part (either one or both parts may be null, but both parts must always be present). It may also be followed by the letter E to indicate that the following figures represent the exponent (also optionally signed).
-A **real **constant may or may not be preceded by a sign, and consists of an integral part followed by a decimal point and a fractional part (either one or both parts may be null, but both parts must always be present). It may also be followed by the letter E to indicate that the following figures represent the exponent (also optionally signed).
**Examples**
-
+~~~~~
5.0 0.0 -0.8E+3 5.67E-12
-
-***Literal Constants***
+~~~~~
+#### Literal Constants
Literal constants include individual characters and strings of characters.
-An **individual character **constant is a single printable character enclosed by two apostrophes. (See the definition of the class Character in the Standard Package).
-**Examples**
+An **individual character** constant is a single printable character enclosed by two apostrophes. (See the definition of the class Character in the Standard Package).
+**Examples**
+~~~~~
‘B’ ‘y’ ‘&’ ‘*’ ‘’’ ‘‘
+~~~~~
+A **string** constant is composed of printable characters enclosed by quotation marks.
-A **string **constant is composed of printable characters enclosed by quotation marks.
**Examples**
-
+~~~~~
’’G’’ ’’jjjj’’ ’’This is a character string, isn’t it?’’
+~~~~~
+The **quotation mark** can itself appear within a character string as long as it is preceded by a backslash.
-The **quotation mark **can itself appear within a character string as long as it is preceded by a backslash.
**Examples**
-
+~~~~~
’’This film was originally called \’’Gone with the Tide\’’.’’
+~~~~~
-***Named Constants***
+#### Named Constants
Named constants are sub-divided into two categories: Booleans and enumerations.
-**Booleans **can be of two types: True or False.
+**Booleans** can be of two types: True or False.
-An **enumeration **constant is an identifier, which appears in the description of an enumeration.
+An **enumeration** constant is an identifier, which appears in the description of an enumeration.
-@section occt_1819379591_1718435309 3. Software Components
+@section occt_cdl_3 Software Components
-
-
-@subsection occt_1819379591_171843530931 Predefined Resources
-@subsubsection occt_1819379591_1718435309311 Primitive types
+@subsection occt_cdl_3_1 Predefined Resources
+@subsubsection occt_cdl_3_1_1 Primitive types
Primitive types are predefined in the language and they are **manipulated by value**.
Four of these primitives are known to the schema of the database because they inherit from the class **Storable**. In other words, they can be used in the implementation of persistent objects, either when contained in entities declared within the methods of the object, or when they form part of the internal representation of the object.
-The primitives inheriting from Storable are the following:
+The primitives inheriting from **Storable** are the following:
-**Boolean **Is used to represent logical data. It has only two values:
-*True *and *False*.
-**Byte **8-bit number.
-**Character **Designates any ASCII character.
-**ExtCharacter **Is an extended character.
-**Integer **Is an integer number.
-**Real **Denotes a real number (i.e. one with a whole and a fractional part, either of which may be null).
-**ShortReal **Real with a smaller choice of values and memory size.
+* **Boolean** Is used to represent logical data. It has only two values: *True* and *False*.
+* **Byte** 8-bit number.
+* **Character** Designates any ASCII character.
+* **ExtCharacter** Is an extended character.
+* **Integer** Is an integer number.
+* **Real** Denotes a real number (i.e. one with a whole and a fractional part, either of which may be null).
+* **ShortReal** Real with a smaller choice of values and memory size.
There are also non-storable primitives. They are:
-**CString **Is used for literal constants.
-**ExtString **Is an extended string.
-**Address **Represents a byte address of undetermined size.
+* **CString** Is used for literal constants.
+* **ExtString** Is an extended string.
+* **Address** Represents a byte address of undetermined size.
The services offered by each of these types are described in the Standard Package.
-@subsubsection occt_1819379591_1718435309312 Manipulating types by reference (by handle)
+@subsubsection occt_cdl_3_1_2 Manipulating types by reference (by handle)
Two types are manipulated by handle:
- * Types defined using classes inheriting from the **Persistent **class are storable in a file.
-
- * Types defined using classes inheriting from the **Transient **class.
+ * Types defined using classes inheriting from the **Persistent** class are storable in a file.
+ * Types defined using classes inheriting from the **Transient** class.
+
These types are not storable as such in a file.
-@image html /dev_guides/cdl/images/cdl_image006.png
-@image latex /dev_guides/cdl/images/cdl_image006.png
-
-Figure 4. Manipulation of a data type by reference
+@image html /dev_guides/cdl/images/cdl_image006.png "Manipulation of a data type by reference"
+@image latex /dev_guides/cdl/images/cdl_image006.png "Manipulation of a data type by reference"
-@subsubsection occt_1819379591_1718435309313 Manipulating types by value
+@subsubsection occt_cdl_3_1_3 Manipulating types by value
Types, which are manipulated by value, behave in a more direct fashion than those manipulated by handle. As a consequence, they can be expected to perform operations faster, but they cannot be stored independently in a file.
You can store types known to the schema (i.e. either primitives or inheriting from Storable) and manipulated by value inside a persistent object as part of the representation. This is the only way for you to store objects “manipulated by value” in a file.
- @image html /dev_guides/cdl/images/cdl_image007.png
- @image latex /dev_guides/cdl/images/cdl_image007.png
-
-Figure 5. Manipulation of a data type by value
+@image html /dev_guides/cdl/images/cdl_image007.png "Manipulation of a data type by value"
+@image latex /dev_guides/cdl/images/cdl_image007.png "Manipulation of a data type by value"
+
Three types are manipulated by value:
* Primitive types
* Enumerated types
* Types defined by classes not inheriting from Persistent or Transient, whether directly or not
-@subsubsection occt_1819379591_1718435309314 Summary of properties
-
-**Figure 6. Summary of the relationship for the various data**
-**types between how they are handled and their storability.**
+@subsubsection occt_cdl_3_1_4 Summary of properties
-@subsection occt_1819379591_171843530932 Classes
+Here is a summary of how various data types are handled and their storability:
+
+| | Manipulated by handle | Manipulated by value |
+| :---- | :---- | :---- |
+| storable | Persistent | Primitive, Storable (storable if nested in a persistent class) |
+| temporary | Transient | Other |
-@subsubsection occt_1819379591_1718435309321 Class declaration
+
+
+
+@subsection occt_cdl_3_2 Classes
+
+@subsubsection occt_cdl_3_2_1 Class declaration
The class is the main system for creating data types under CDL. By analyzing any CDL-based software, you find that classes are the modular units that make up packages. When you describe a new class, you introduce a new data type.
Whatever the category of the described type (manipulated by value, Storable or not, manipulated by handle, Persistent or not) the structure of the class definition remains the same. The syntax below illustrates it:
-**Example**
+~~~~~
-- declaration-of-a-simple-class ::=
class class-name from package-name
[uses data-type { ’,’ data-type } ]
@@ -456,14 +493,15 @@ class-definition ::=
[{member-method}]
[declaration-of-fields]
[declaration-of-friends]
-
+~~~~~
Class name becomes a new data type, which you can use inside its own definition. Other types appearing in the definition must either be primitive types, previously declared classes, exceptions, or enumerations.
-Apart from the types defined in the Standard Package, which are **implicitly visible **everywhere, you need to declare the data types after the keyword **uses**. This concerns both the class behavior and its internal representation.
+Apart from the types defined in the Standard Package, which are **implicitly visible** everywhere, you need to declare the data types after the keyword **uses**. This concerns both the class behavior and its internal representation.
+
+**Exceptions** are declared after the word **raises**.
-**Exceptions **are declared after the word **raises**.
**Example**
-
+~~~~~
class Line from GeomPack
usesPoint, Direction, Transformation
raisesNullDirection, IdenticalPoints
@@ -473,180 +511,165 @@ is-- class definition follows here
-- NullDirection and Identical-
-- -Points exceptions.
end Line;
+~~~~~
The elements, which make up the definition of a class, are divided into four parts:
-
* the behavior
* the invariants
* the internal representation
* the friend methods and friend classes.
- @image html /dev_guides/cdl/images/cdl_image009.png
- @image latex /dev_guides/cdl/images/cdl_image009.png
-
-**Figure 7. Contents of a class**
-*** a deferred class does not have to contain a constructor**
+ @image html /dev_guides/cdl/images/cdl_image009.png "Contents of a class"
+ @image latex /dev_guides/cdl/images/cdl_image009.png "Contents of a class"
-
-@subsubsection occt_1819379591_1718435309322 Categories of classes
+@subsubsection occt_cdl_3_2_2 Categories of classes
Classes fall into three categories:
-
* Ordinary classes
* Deferred classes
* Generic classes
-
Deferred classes
+#### Deferred classes
-The principal characteristic of a **deferred class **is that you cannot instantiate it. Its purpose is to provide you with a given behavior shared by a hierarchy of classes and dependent on the implementation of the descendents. This allows you to guarantee a certain base of inherited behavior common to all classes based on a particular deferred class. Deferred classes are declared as in the following syntax:
-**Example**
+The principal characteristic of a **deferred class** is that you cannot instantiate it. Its purpose is to provide a given behavior shared by a hierarchy of classes and dependent on the implementation of the descendents. This allows guaranteeing a certain base of inherited behavior common to all classes based on a particular deferred class. Deferred classes are declared as in the following syntax:
--- declaration-of-a-deferred-class ::=
-deferred class class-name
+~~~~~
+-- declaration-of-a-deferred-class ::= deferred class class-name
[inherits class-name {’,’ class-name}]
[uses data-type {’,’ data-type}]
[raises exception-name {’,’ exception-name}]
-is class-definition
-end [class-name]’;’
-
+ is class-definition
+ end [class-name]’;’
+~~~~~
+Please, note that a deferred class does not have to contain a constructor
Generic classes
-The principal characteristic of a **generic class **is that it offers you a set of functional behavior allowing you to manipulate other data types. To instantiate a generic class you need to pass a data type in argument. Generic classes are declared as in the following syntax:
-**Example**
+The principal characteristic of a **generic class** is that it offers a set of functional behavior to manipulate other data types. To instantiate a generic class you need to pass a data type in argument. Generic classes are declared as in the following syntax:
--- declaration-of-a-generic-class ::=
-[deferred] generic class class-name ’(’generic-type
-{’,’ generic-type}’)’
+~~~~~
+-- declaration-of-a-generic-class ::= [deferred] generic class class-name ’(’generic-type {’,’generic-type}’)’
[inheritsclass-name {’,’ class-name}]
[usesdata-type {’,’ data-type}]
[raisesexception-name {’,’ exception-name}]
[{[visibility] declaration-of-a-class}]
-is class-definition
-end [class-name]’;’
+ is class-definition
+ end [class-name]’;’
generic-type ::= identifier as type-constraint
identifier ::= letter{[underscore]alphanumeric}
-type-constraint ::= any | class-name [’(’data-type {’,’
-data-type}’)’]
+type-constraint ::= any | class-name [’(’data-type {’,’ data-type}’)’]
+~~~~~
+@subsection occt_cdl_3_3 Packages
-@subsection occt_1819379591_171843530933 Packages
+@subsubsection occt_cdl_3_3_1 Package declaration
-@subsubsection occt_1819379591_1718435309331 Package declaration
+**Packages** are used to group classes, which have some logical coherence. For example, the Standard Package groups together all the predefined resources of the language. In its simplest form, a package contains the declaration of all data types, which it introduces. You may also use a package to offer public methods and hide its internal classes by declaring them private.
- **Packages** are used to group classes, which have some logical coherence. For example, the Standard Package groups together all the predefined resources of the language. In its simplest form, a package contains the declaration of all data types, which it introduces. You may also use a package to offer public methods and hide its internal classes by declaring them private.
-** **
**Example**
--- package-declaration ::=
-**package **package-name
-[**uses **package-name {’,’ package-name}]
-**is **package-definition
-**end **[package-name]’;’
--- package-name ::=
-identifier
+~~~~~
+-- package-declaration ::= package package-name
+ [uses package-name {’,’ package-name}]
+ is package-definition
+ end [package-name]’;’
+-- package-name ::= identifier
-- package-definition ::=
-[{type-declaration}]
-[{package-method}]
+ [{type-declaration}]
+ [{package-method}]
-- type-declaration ::=
-[**private**] declaration-of-an-enumeration |
-[**private**] declaration-of-a-class |
-declaration-of-an-exception
--- package-method ::=
-identifier [simple-formal-part][returned-type
--declaration]
+ [private] declaration-of-an-enumeration | [private] declaration-of-a-class | declaration-of-an-exception
+-- package-method ::= identifier [simple-formal-part][returned-type -declaration]
[error-declaration]
-[***is private***]’;’
-
-The data types described in a package *may *include one or more of the following data types:
+[is private]’;’
+~~~~~
+The data types described in a package *may* include one or more of the following data types:
* Enumerations
* Object classes
* Exceptions
* Pointers to other object classes.
-Inside a package, two data types *cannot *have the same name.
+Inside a package, two data types *cannot* have the same name.
You declare data types before using them in the definition of other data types.
-When two classes are **mutually recursive**, one of the two *must *be first declared in an incomplete fashion.
+When two classes are **mutually recursive**, one of the two must be first declared in an incomplete fashion.
-Grouped behind the keyword **uses **are the names of all the packages containing definitions of classes of which the newly introduced data types are clients.
+Grouped behind the keyword **uses** are the names of all the packages containing definitions of classes of which the newly introduced data types are clients.
-The methods you declare in a package do not belong to any particular class. **Package methods ***must *carry a name different from the data types contained in the package. Like any other method, they can be overloaded. With the exception of the keyword **me **and the visibility (a package method can *only *be either public or private) package methods are described in the same way as **instance methods**.
+The methods you declare in a package do not belong to any particular class. **Package methods** must carry a name different from the data types contained in the package. Like any other method, they can be overloaded. With the exception of the keyword **me** and the visibility (a package method can *only* be either public or private) package methods are described in the same way as **instance methods**.
-@image html /dev_guides/cdl/images/cdl_image010.png
-@image latex /dev_guides/cdl/images/cdl_image010.png
-Figure 8. Contents of a package
+@image html /dev_guides/cdl/images/cdl_image010.png "Contents of a package"
+@image latex /dev_guides/cdl/images/cdl_image010.png "Contents of a package"
-The example of the package below includes some of the basic data structures:
-**Example**
+The example of the package below includes some of the basic data structures:
+
+~~~~~
package Collection
-uses
-Standard
-is
+ uses
+ Standard
+ is
exception NoSuchObject inherits Failure;
exception NoMoreObject inherits Failure;
generic class SingleList;
generic class Set;
end Collection;
+~~~~~
-Note that the class Set is declared after the declarations of the NoSuchObject and NoMoreObject exceptions and the SingleList class of which Set is a client. In the same way, the classes Failure, Persistent, and the exception NoSuchObject are defined before they are used. They are defined in the Standard package, which appears after the keyword **uses**.
+Note that the class *Set* is declared after the declarations of the *NoSuchObject* and *NoMoreObject* exceptions and the *SingleList* class of which Set is a client. In the same way, the classes *Failure*, *Persistent*, and the exception *NoSuchObject* are defined before they are used. They are defined in the *Standard* package, which appears after the keyword **uses**.
-@subsubsection occt_1819379591_1718435309332 Name space
+@subsubsection occt_cdl_3_3_2 Name space
-The **name space **or **scope **of a class extends from the beginning of its declaration up to the end of the package in which it appears.
+The **name space** or **scope** of a class extends from the beginning of its declaration up to the end of the package in which it appears.
-Sometimes, two classes, which come from separate packages, are both visible to a third package and carry the same name. For example, there might be two different classes both called “Window” in a screen generator package and in an architectural package. As a client of a data type, you can find yourself in the position of having to remove the ambiguity over the origin of this type; you do this by means of the keyword **from**.
-**Example**
+Sometimes, two classes, which come from separate packages, are both visible to a third package and carry the same name. For example, there might be two different classes both called “Window” in a screen generator package and in an architectural package. As a client of a data type, you can find yourself in the position of having to remove the ambiguity over the origin of this type; you do this by means of the keyword **from**.
+
--- class-name ::=
-identifier [**from **package-name]
--- exception-name ::=
-identifier [**from **package-name]
--- enumeration-name ::=
-identifier [**from **package-name]
+~~~~~
+-- class-name ::= identifier [from package-name]
+-- exception-name ::= identifier [from package-name]
+-- enumeration-name ::= identifier [from package-name]
+~~~~~
-You can use the keyword **from **everywhere the name of a class, exception, or enumeration appears. As a consequence, as a client of the class “Window” you could write wherever necessary:
-**Example**
+You can use the keyword **from** everywhere the name of a class, exception, or enumeration appears. As a consequence, as a client of the class “Window” you could write wherever necessary:
+~~~~~
Window from ScreenGenerator
-- or
Window from ArchitecturalFeatures
+~~~~~
-NOTES
-***Within the description of a package the keyword *****from**** *must be used when referencing any data type that is not defined in this package.***
+**Note** that within the description of a package the keyword **from** must be used when referencing any data type that is not defined in this package.
Here is a further example:
-**Example**
+~~~~~
class Line from Geom
uses
-Point from Geom2d,
-Point from Geom3d
+ Point from Geom2d,
+ Point from Geom3d
is
--- class definition using
--- Point from AppropriatePackage
--- wherever Point appears
+ -- class definition using Point from AppropriatePackage wherever Point appears
end;
+~~~~~
-
-@subsubsection occt_1819379591_1718435309333 Declaration of classes
+@subsubsection occt_cdl_3_3_3 Declaration of classes
You cannot describe a package in one single file. You need to describe it in different units and send them separately to the CDL compiler. Each compilation unit can contain the declaration of a class or of a package. When you describe a class in a unit different than that, which describes its package, you need to specify which package the class belongs to. You do this using the keyword **from**.
-If the **from **clause appears in the **uses **clause of the package, it does not need to be repeated elsewhere.
+If the **from** clause appears in the **uses** clause of the package, it does not need to be repeated elsewhere.
The following example takes the package “Collection” which was presented above, but this time it is divided into three compilation units.
-**Example**
+~~~~~
-- First compilation unit, the package “Collection” :
package Collection
-uses
-Standard
-is
+ uses
+ Standard
+ is
exception NoMoreObject inherits Failure from Standard;
exception NoSuchObject inherits Failure from Standard;
generic class SingleList;
@@ -655,251 +678,264 @@ end Collection;
-- Second compilation unit, the class “SingleList” :
generic class SingleList from Collection (Item as
Storable)
-inherits
-Persistent from Standard
-raises
-NoSuchObject from Collection
-is
--- definition of the SingleList class
-end SingleList;
+ inherits
+ Persistent from Standard
+ raises
+ NoSuchObject from Collection
+ is
+ -- definition of the SingleList class
+ end SingleList;
-- Third compilation unit, the class “Set” :
generic class Set from Collection (Item as Storable)
- inherits
-Persistent from Standard;
-raises
-NoSuchObject from Collection,
-NoMoreObject from Collection
-private class Node instantiates SingleList
-from Collection (Item);
--- etc....
+ inherits
+ Persistent from Standard;
+ raises
+ NoSuchObject from Collection,
+ NoMoreObject from Collection
+ private class Node instantiates SingleList
+ from Collection (Item);
end Set;
-
+~~~~~
NOTE
-It is not explicitly stated that the “Node” class belongs to the “Collection” package. In fact any nested class necessarily belongs to the package of the class, which encompasses it.
+It is not explicitly stated that the *Node* class belongs to the *Collection* package. In fact any nested class necessarily belongs to the package of the class, which encompasses it.
+
+Note that a package can hide certain classes (just as it can hide methods) by declaring them **private**. To make a class private, you prefix its description with the keyword **private**. In the example of the *Collection* package, the *SingleList* class serves only to implement the *Set* class. It is recommended to make it private. You write this as in the following syntax:
+
-Note that a package can hide certain classes (just as it can hide methods) by declaring them **private**. To make a class private, you prefix its description with the keyword **private**. In the example of the “Collection” package, the “SingleList” class serves only to implement the “Set” class. It is recommended to make it private. You write this as in the following syntax:
**Example**
-
+~~~~~
package Collection
-uses
-Standard
-is
+ uses
+ Standard
+ is
generic class Set, Node, Iterator;
private generic class SingleList;
exception NoMoreObject inherits Failure from Standard;
end Collection;
+~~~~~
+@subsection occt_cdl_3_4 Other Data Types
-@subsection occt_1819379591_171843530934 Other Data Types
-
-These are:
-
+The other data types are:
* Enumerations
* Imports
* Aliases
* Exceptions
* Pointers
-@subsubsection occt_1819379591_1718435309341 Enumerations
+@subsubsection occt_cdl_3_4_1 Enumerations
+
+The **enumerated types** are the second type, which is manipulated by value. Unlike the primitive types they are extensible because they are defined by the user under the form of enumerations. An enumeration is an ordered sequence of named whole constant values called enumeration constants.
-The **enumerated types **are the second type, which is manipulated by value. Unlike the primitive types they are extensible because they are defined by the user under the form of enumerations. An enumeration is an ordered sequence of named whole constant values called enumeration constants.
**Example**
-
+~~~~~
declaration-of-an-enumeration ::=
-**numeration **enumeration-name
-**is **identifier {’,’ identifier}
-[**end **[enumeration-name]]’;’
+enumeration enumeration-name
+is identifier {’,’ identifier}
+[end [enumeration-name]]’;’
enumeration-name ::= identifier
-
+~~~~~
The declaration of an enumeration creates an enumerated type. An object of this type can successively take the value of any one of the constants cited in the list.
-**Example**
+**Example**
+~~~~~
enumeration MagnitudeSign is Negative, Null, Positive;
+~~~~~
-
-Inside a package, two enumeration constants cannot have the same name, even if they belong to different enumerated types.
+Inside a package, two enumeration constants cannot have the same name, even if they belong to different enumerated types.
+
**Example**
-
+~~~~~
enumeration Cars is
-Honda,
-Ford,
-Volkswagen,
-Renault
+ Honda,
+ Ford,
+ Volkswagen,
+ Renault
end;
enumeration AmericanPresidents is
-Nixon,
-Reagan,
-Ford, -- Error: ‘Ford’ already defined
-Carter
+ Nixon,
+ Reagan,
+ Ford, -- Error: ‘Ford’ already defined
+ Carter
end;
+~~~~~
+@subsubsection occt_cdl_3_4_2 Imports
-@subsubsection occt_1819379591_1718435309342 Imports
-
-An **imported type **is one of which which has not been defined in CDL. It is up to the supplier of this data type to ensure compatibility with the CDL language by providing services which allow CDL to recognize the imported data type.
+An **imported type** is one of which which has not been defined in CDL. It is up to the supplier of this data type to ensure compatibility with the CDL language by providing services which allow CDL to recognize the imported data type.
The CDL syntax for declaring an imported type is:
+~~~~~
+declaration-of-an-imported-type::=[private] imported typename ;
+~~~~~
-declaration-of-an-imported-type::=
-[**private**] **imported **typename ;
-**Example**
+Let us try to define an imported type:
--- You can define an imported type as follows:
--- In the MyPack.cdl file, you declare the imported
-type:
--- package MyPack
-....
-imported MyImport;
-....
-end Mypack;
--- In the MyPack_MyImport.hxx file, you write the
-following
--- C++ code:
+* In the *MyPack.cdl* file, you declare the imported type:
+~~~~~
+package MyPack
+ ....
+ imported MyImport;
+ ....
+ end Mypack;
+~~~~~
+* In the *MyPack_MyImport.hxx* file, you write the following C++ code:
+~~~~~
#ifndef _MyPack_MyImport_HeaderFile
#define _MyPack_MyImport_HeaderFile
#include Standard_Type.hxx
typedef unsigned long MyPack_MyImport;
extern const Handle(Standard_Type)& TYPE
(MyPack_MyImport);
--- In the MyPack_MyImport.cxx file, you write the
-following
--- C++ code:
+~~~~~
+* In the *MyPack_MyImport.cxx* file, you write the following C++ code:
+~~~~~
#ifndef _MyPack_MyImport_HeaderFile
#include MyPack_MyImport.hxx
#endif
const Handle(Standard_Type)& TYPE (MyPack_MyImport)
-
{
-static Handle(Standard_Type) _aType =
-new Standard_Type (“MyPack_MyImport”,sizeof
-(MyPack_MyImport))
- return _aType;
-}
+ static Handle(Standard_Type) _aType =
+ new Standard_Type (“MyPack_MyImport”,sizeof
+ (MyPack_MyImport))
+ return _aType;
+ }
+~~~~~
-Then, add the names of these two files (MyPack_MyImport.hxx, MyPack_MyImport.cxx) to a file called FILES in the src subdirectory of the package. If the file does not exist you must create it.
+Then, add the names of these two files (MyPack_MyImport.hxx, MyPack_MyImport.cxx) to a file called FILES in the src subdirectory of the package. If the file does not exist you must create it.
-@subsubsection occt_1819379591_1718435309343 Aliases
+@subsubsection occt_cdl_3_4_3 Aliases
-An **alias **is an extra name for a type, which is already known. It is declared as in the following syntax:
+An **alias** is an extra name for a type, which is already known. It is declared as in the following syntax:
+
+~~~~~
+declaration-of-an-alias::= [private] alias type1 is type2 [from apackage] ;
+~~~~~
-declaration-of-an-alias::=
-[**private**] **alias **type1 **is **type2 [**from **apackage] ;
**Example**
-
+~~~~~
alias Mass is Real;
---Purpose:
-- Defined as a quantity of matter.
-- Gives rise to the inertial and
-- gravitational properties of a body.
-- It is measured in kilograms.
+~~~~~
-Having defined *Mass *as a type of *Real*, you can use either *Mass *or *Real *to type an argument when defining a method.
+Having defined *Mass* as a type of *Real*, you can use either *Mass* or *Real* to type an argument when defining a method.
-@subsubsection occt_1819379591_1718435309344 Exceptions
+@subsubsection occt_cdl_3_4_4 Exceptions
In the model recommended by CDL, the principal characteristic of errors is that they are treated in a different place from the place where they appear. In other words, the methods recovering and those raising a given exception are written independently from each other.
Subsequently this poses the problem of communication between the two programs. The principle adopted consists in viewing the exception as both a class and an object. The exception class (by means of one of its instances) is used to take control of an exception, which has been raised.
-Consequently, error conditions are defined by means of **classes of exceptions**. Exception classes are arranged hierarchically so as to be able to recover them in groups. They are all descendents of a single root class called “Failure”, and it is at the level of this class that the behavior linked to the raising of exceptions is implemented.
+Consequently, error conditions are defined by means of **classes of exceptions**. Exception classes are arranged hierarchically so as to be able to recover them in groups. They are all descendents of a single root class called *Failure*, and it is at the level of this class that the behavior linked to the raising of exceptions is implemented.
+~~~~~
+declaration-of-an-exception ::=exception exception-name inherits exception-name
+~~~~~
-declaration-of-an-exception ::=
-**exception **exception-name **inherits **exception-name
-
-All exceptions share identical behavior, that of the class “Failure”. Here are some examples of exception classes:
+All exceptions share identical behavior, that of the class *Failure*. Here are some examples of exception classes:
+~~~~~
exception NumericError inherits Failure;
exception Overflow inherits NumericError;
exception Underflow inherits NumericError;
+~~~~~
-The use of exceptions as a means to interrupt the normal execution of one program and then take control of another one depends on the programming language used to implement the methods. See the following chapter “Defining the Software Components” on page 32.
+The use of exceptions as a means to interrupt the normal execution of one program and then take control of another one depends on the programming language used to implement the methods. See the following chapter “Defining the Software Components” on page 32.
-@subsection occt_1819379591_171843530935 Schemas
+@subsection occt_cdl_3_5 Schemas
-The purpose of a **schema **is to list persistent data types, which will be stored in files by the application. A schema groups together persistent packages. A persistent package is one, which contains at least one persistent class.
+The purpose of a **schema** is to list persistent data types, which will be stored in files by the application. A schema groups together persistent packages. A persistent package is one, which contains at least one persistent class.
+~~~~~
declaration-of-a-schema ::=
-**schema **SchemaName
+schema SchemaName
is
-{**package **PackageName;}
-{**class **ClassName;}
-**end**;
-**Example**
-
+{package PackageName;}
+{class ClassName;}
+end;
+~~~~~
+
+For example
+~~~~~
schema Bicycle
---Purpose: Defines the Bicycle schema.
is
package FrameComponents;
package WheelComponents;
end;
+~~~~~
-***NOTE***
-Note that it is unnecessary to specify all the dependencies of the packages. It is sufficient to specify the highest level ones. The others on which they depend are automatically supplied.
-@subsection occt_1819379591_171843530936 Executables
-The purpose of an **executable **is to make an executable program without a front-end. It can be used to test more than one package at a time. An executable is written in a .cdl file as a set of packages.
+**Note** that it is unnecessary to specify all the dependencies of the packages. It is sufficient to specify the highest level ones. The others on which they depend are automatically supplied.
+
+@subsection occt_cdl_3_6 Executables
+
+The purpose of an **executable** is to make an executable program without a front-end. It can be used to test more than one package at a time. An executable is written in a .cdl file as a set of packages.
**Example**
-
+~~~~~
definition-of-an-executable ::=
-executable ExecutableName
-is
+ executable ExecutableName
+ is
{
executable ExecutablePart
-[uses [Identifier as external]
-[{’,’ Identifier as external}]
-[UnitName as library]
-[{’,’ UnitName as library}]
-is
-{FileName [as C++|c|fortran|object];}
+ [uses [Identifier as external]
+ [{’,’ Identifier as external}]
+ [UnitName as library]
+ [{’,’ UnitName as library}]
+ is
+ {FileName [as C++|c|fortran|object];}
+ end;
+ }
end;
-}
-end;
-**Example**
+~~~~~
+**Example**
+~~~~~
executable MyExecUnit
----Purpose:
--- Describes the executable MyExecUnit
-is
-executable myexec
--- the binary file
-uses
-Tcl_Lib as external
-is
-myexec;
--- the C++ file
-end;
--- several binaries can be specified in one .cdl file.
-executable myex2
-is
-myex2;
+ ---Purpose:
+ -- Describes the executable MyExecUnit
+ is
+ executable myexec
+ -- the binary file
+ uses
+ Tcl_Lib as external
+ is
+ myexec;
+ -- the C++ file
+ end;
+ -- several binaries can be specified in one .cdl file.
+ executable myex2
+ is
+ myex2;
end;
end;
+~~~~~
-@section occt_1819379591_1972310108 4. Defining the Software Components
+@section occt_cdl_4 Defining the Software Components
-@subsection occt_1819379591_197231010841 Behavior
+@subsection occt_cdl_4_1 Behavior
-The behavior of an object class is defined by a list of **methods, **which are either **functions **or **procedures**. Functions return an object, whereas procedures only communicate by passing arguments. In both cases, when the transmitted object is an instance manipulated by a handle, its identifier is passed. There are three categories of methods:
+The behavior of an object class is defined by a list of **methods**, which are either **functions** or **procedures**. Functions return an object, whereas procedures only communicate by passing arguments. In both cases, when the transmitted object is an instance manipulated by a handle, its identifier is passed. There are three categories of methods:
-**Object constructor **Creates an instance of the described class. A class will have one or more object constructors with various arguments or none.
+* **Object constructor** Creates an instance of the described class. A class will have one or more object constructors with various arguments or none.
+* **Instance method** Operates on the instance which owns it.
+* **Class method** Does not work on individual instances, only on the class itself.
-**Instance method **Operates on the instance which owns it.
+@subsubsection occt_cdl_4_11 Object Constructors
-**Class method **Does not work on individual instances, only on the class itself.
-
-@subsubsection occt_1819379591_1972310108411 Object Constructors
-
-A constructor is a function, which allows the **creation of instances **of the class it describes.
-**Example**
+A constructor is a function, which allows the **creation of instances** of the class it describes.
+~~~~~
constructor-declaration ::=
-Create [ simple-formal-part ] declaration-ofconstructed-
-type
+Create [ simple-formal-part ] declaration-ofconstructed-type
[ exception-declarations ]
simple-formal-part ::=
’(’ initialization-parameter {’;’ initialization parameter}’)’
@@ -907,86 +943,84 @@ initialization-parameter ::=
identifier {’,’ identifier} ’:’ parameter-access datatype
[ ’=’ initial-value ]
parameter-access ::=
-**mutable **| [ **immutable **]
+mutable | [ immutable ]
initial_value ::=
numeric-constant | literal-constant | named-constant
declaration-of-constructed-type ::=
-**returns **[ **mutable **] class-name
+returns [ mutable ] class-name
+~~~~~
-The name of the constructors is fixed: “Create”. The object returned by a constructor is always of the type of the described class. If that type is manipulated by a handle, you *must *declare it as **mutable**, in which case the content of the instance it references is accessible for further modification.
+The name of the constructors is fixed: “Create”. The object returned by a constructor is always of the type of the described class. If that type is manipulated by a handle, you *must* declare it as **mutable**, in which case the content of the instance it references is accessible for further modification.
For example, the constructor of the class “Point”
-**Example**
-
+~~~~~
Create (X, Y, Z : Real)
returns mutable Point;
+~~~~~
-With the exception of the types predefined by the language, all types of initialization parameters *must *appear in the **uses **clause of the class of which the constructor is a member.
+With the exception of the types predefined by the language, all types of initialization parameters *must* appear in the **uses** clause of the class of which the constructor is a member.
-When an initialization parameter is of a type which is manipulated by a handle, an access right *must *be associated with it so as to express if the internal representation of the referenced object is modifiable (**mutable**) or not (**immutable**). The default option is **immutable**. For example, the constructor of the persistent class “Line”.
-**Example**
+When an initialization parameter is of a type which is manipulated by a handle, an access right *must* be associated with it so as to express if the internal representation of the referenced object is modifiable (**mutable**) or not (**immutable**). The default option is **immutable**. Let, for example, take the constructor of the persistent class “Line”.
+~~~~~
Create (P : mutable Point; D : mutable Direction)
returns mutable Line;
+~~~~~
In the above example “P” and “D” must be mutable because the constructor stores them in the internal representation of the created line, which is mutable itself. An alternative would be to accept immutable initialization parameters and then copy them into the constructor in a mutable form.
-The parameters of a native type can have a default value: this is expressed by assigning a constant of the same type to the parameter concerned. Parameters, which have a default value, may not be present when the call to the constructor is made, in which case they take the value specified in the declaration. For this reason, they must all be grouped at the end of the list. For example, the constructor of the persistent class “Vector”.
-**Example**
+The parameters of a native type can have a default value: this is expressed by assigning a constant of the same type to the parameter concerned. Parameters, which have a default value, may not be present when the call to the constructor is made, in which case they take the value specified in the declaration. For this reason, they must all be grouped at the end of the list. Let, for example, take the constructor of the persistent class “Vector”.
+~~~~~
Create (D : mutable Direction; M : Real = 1.0)
returns mutable Vector;
+~~~~~
A class can have many constructors (in this case, you say they are **overloaded**) provided that they differ in their syntax and that the presence of parameters having default values does not create ambiguities.
-The restrictions on their use are expressed by a list of **exceptions **against which each constructor is protected.
+The restrictions on their use are expressed by a list of **exceptions** against which each constructor is protected.
Each class must have at least one constructor to be able to create objects of its type.
-@subsubsection occt_1819379591_1972310108412 Instance Methods
+
+@subsubsection occt_cdl_4_1_2 Instance Methods
An instance method is a function or procedure, which applies to any instance of the class, which describes it.
-**Example**
-declaration-of-an-instance-method ::=
-identifier formal-part-of-instance-method
+**Example**
+~~~~~
+declaration-of-an-instance-method ::= identifier formal-part-of-instance-method
[ declaration-of-returned-type ]
[ exception-declaration ]
-formal-part-of-instance-method ::=
- ’(’ me [’:’ passing-mode parameter-access ] {’;’
-parameter}’)’
-parameter ::=
-identifier {’,’ identifier} ’:’ passing-mode
+formal-part-of-instance-method ::= ’(’ me [’:’ passing-mode parameter-access ] {’;’ parameter}’)’
+parameter ::= identifier {’,’ identifier} ’:’ passing-mode
parameter-access
data-type [ ’=’ initial-value ]
-passing-mode ::=
-[ in ] | out | in out
-parameter-access ::=
-mutable | [immutable]
-declaration-of-returned-type ::=
-returns return-access data-type
-return-access ::=
-mutable |[ immutable ]| any
+passing-mode ::= [ in ] | out | in out
+parameter-access ::= mutable | [immutable]
+declaration-of-returned-type ::= returns return-access data-type
+return-access ::= mutable |[ immutable ]| any
+~~~~~
-The name **me **denotes the object to which the method is applied: you call this the “principal object” of the method. The passing mode expresses whether the direct content of the principal object or a parameter is either:
+The name **me** denotes the object to which the method is applied: you call this the “principal object” of the method. The passing mode expresses whether the direct content of the principal object or a parameter is either:
* read
* created and returned
* read then updated and returned by the method.
-Remember that the direct content of an argument of a type which is manipulated by value contains the internal representation of the object itself. Thus, when the argument is of this type, **out **and **in out **mean that the content of the object will undergo a modification. When the method is a function (as is the case for constructors), all the arguments must be **in **(read). This is the default mode.
+Remember that the direct content of an argument of a type which is manipulated by value contains the internal representation of the object itself. Thus, when the argument is of this type, **out** and **in out** mean that the content of the object will undergo a modification. When the method is a function (as is the case for constructors), all the arguments must be **in** (read). This is the default mode.
-In case of an argument of a type manipulated by a handle, the direct content being an object identifier, the passing mode addresses itself to the handle, and no longer to the internal representation of the object, the modification of which is controlled by the access right. An argument of this type declared **mutable **may see its internal representation modified. If declared **immutable**, it is protected. When a parameter is both **in out **and **mutable**, the identifiers passed and returned denote two distinct modifiable objects.
+In case of an argument of a type manipulated by a handle, the direct content being an object identifier, the passing mode addresses itself to the handle, and no longer to the internal representation of the object, the modification of which is controlled by the access right. An argument of this type declared **mutable** may see its internal representation modified. If declared **immutable**, it is protected. When a parameter is both **in out** and **mutable**, the identifiers passed and returned denote two distinct modifiable objects.
When the returned object is manipulated by a handle it can be declared modifiable or not, or indeterminate (**any**). To return an object with an indeterminate access right means that the method transmits the identifier without changing its state and that the method has no right to alter the access right. This functionality is particularly useful in the case of collections; temporarily storing an object in a structure and unable to modify its state.
-With the exception of the types predefined by the language, all types of parameters and returned objects, whether manipulated by a handle or by value, *must *appear in the **uses **clause of the class of which the method is a member.
-As is the case for constructors, some parameters can have a default value, provided that they are of primitive or enumerated type. They are passed in the **in **mode, and they are found at the end of the list of arguments.
+With the exception of the types predefined by the language, all types of parameters and returned objects, whether manipulated by a handle or by value, *must* appear in the **uses** clause of the class of which the method is a member.
+As is the case for constructors, some parameters can have a default value, provided that they are of primitive or enumerated type. They are passed in the **in** mode, and they are found at the end of the list of arguments.
Overloading of instance methods and use of exceptions and post-conditions is allowed and respects the same rules than constructors.
Note the overloading of “Coord” in the following example of instance methods associated with the persistent class “Point”:
-**Example**
+~~~~~
Coord (me; X, Y, Z : out Real);
---Purpose: returns the coordinates of me
@@ -999,90 +1033,91 @@ SetCoord (me : mutable; X, Y, Z : Real);
Distance (me; P : Point) returns Real
---Purpose: returns the distance to a point
+~~~~~
-In all these cases, **me **is implicitly an object of type Point. Only “SetCoord” is able to modify the internal representation of a point.
+In all these cases, **me** is implicitly an object of type *Point*. Only “SetCoord” is able to modify the internal representation of a point.
-@subsubsection occt_1819379591_1972310108413 Class Methods
+@subsubsection occt_cdl_4_1_3 Class Methods
A class method is a function or procedure relative to the class it describes, but does not apply to a particular instance of the class.
-declaration-of-a-class-method ::=
-identifier formal-part-of-class-method
+~~~~~
+declaration-of-a-class-method ::= identifier formal-part-of-class-method
[ declaration-of-returned-type ]
[ exception-declaration ]
-formal-part-of-class-method ::=
-’(’ **myclass **{’;’ parameter}’)’
+formal-part-of-class-method ::= ’(’ myclass {’;’ parameter}’)’
+~~~~~
+
+The first parameter **myclass** indicates that the method does not apply to a previously created instance, but to the class itself. The rest of the syntax is identical to that of the instance methods. In particular, access rights (**mutable**, **immutable**, **any**) and the argument passing mode (**in**, **out**, **in out**) must remain unchanged. With the exception of the types predefined by the language, all types of parameters must appear in the **uses** clause of the class of which the method is a member. Overloading of class methods and the use of exceptions and post-conditions is allowed, and it follows the same rules as for constructors and instance methods.
-The first parameter **myclass **indicates that the method does not apply to a previously created instance, but to the class itself. The rest of the syntax is identical to that of the instance methods. In particular, access rights (**mutable**, **immutable**, **any**) and the argument passing mode (**in**, **out**, **in out**) must remain unchanged. With the exception of the types predefined by the language, all types of parameters must appear in the **uses **clause of the class of which the method is a member. Overloading of class methods and the use of exceptions and post-conditions is allowed, and it follows the same rules as for constructors and instance methods.
Examples of class methods associated with the class “Real”:
-**Example**
+~~~~~
First (myclass) returns Real;
---Purpose: returns lower limit of reals
Last (myclass) returns Real;
---Purpose: returns upper limit of reals
+~~~~~
-
-@subsubsection occt_1819379591_1972310108414 Package Methods
+@subsubsection occt_cdl_4_1_4 Package Methods
Package methods are methods which are members of a package. They are frequently used for library or application initialization, or for offering an application programming interface to the sources to the package. They are sometimes methods used for development purposes but which are not made available to final end-users of the package.
-package-method ::=
-identifier [simple-formal-part][returned-type-declaration]
+~~~~~
+package-method ::= identifier [simple-formal-part][returned-type-declaration]
[exception-declaration]
-[**is private**]’;’
+[is private]’;’
+~~~~~
-
-@subsubsection occt_1819379591_1972310108415 Sensitivity to Overloading
+@subsubsection occt_cdl_4_1_5 Sensitivity to Overloading
When there is more than one method of a class, several methods share the same name but have different syntax, you say the method is overloaded.
-In order that the methods can be considered distinct, they must differ either in the number of parameters, or one of their parameters must be of a different type. In particular, you *cannot *overload a method if you merely modify it as follows:
+In order that the methods can be considered distinct, they must differ either in the number of parameters, or one of their parameters must be of a different type. In particular, you *cannot* overload a method if you merely modify it as follows:
* The type of the returned object when the method behaves as a function
- * The name or the mode of passing a parameter
-(**in**, **out**, or **in out**)
- * The mutability of passed objects
-(**mutable**, **immutable**, **any**)
+ * The name or the mode of passing a parameter (**in**, **out**, or **in out**)
+ * The mutability of passed objects (**mutable**, **immutable**, **any**)
* Default value of a parameter.
-@subsection occt_1819379591_197231010842 Internal Representation
+
+@subsection occt_cdl_4_2 Internal Representation
+
+Each object contains its own state in a private space in the memory. This state consists of a set of **fields**, which include or reference other objects.
-Each object contains its own state in a private space in the memory. This state consists of a set of **fields**,** **which include or reference other objects.
**Example**
-
-declaration-of-the-internal-representation-of-a-class
-::=
-**fields **field {field}
-field ::=
-identifier {’,’ identifier} ’:’ data-type [’[’integer
-{’,’integer}’]’]’;’
+~~~~~
+declaration-of-the-internal-representation-of-a-class ::= fields field {field}
+field ::= identifier {’,’ identifier} ’:’ data-type [’[’integer {’,’integer}’]’]’;’
+~~~~~
A copy of all the defined fields exists locally in each instance of the class. This group of fields will be initialized by the class constructors when the object is instantiated.
-Fields *must not *have the same name as any method of the class in which they appear. When the field type is followed by a list of integer constants between square brackets, the data will take the form of a multi-dimensional array containing objects of this type.
+Fields *must not* have the same name as any method of the class in which they appear. When the field type is followed by a list of integer constants between square brackets, the data will take the form of a multi-dimensional array containing objects of this type.
The following example shows two equivalent ways of describing three fields of the “Real” type:
-**Example**
+**Example**
+~~~~~
fields
x, y, z: Real;
coord: Real[3];
+~~~~~
+
Depending on their type, Object fields have one of the two forms. When the field is of the “manipulated by handle” type, it corresponds to an identifier. In this case, the contents of the object can be shared by other objects or by a handle in a program. When the field is of a “manipulated by value” type, it contains the value of the object. In this case you say the object is **embedded**.
-@subsection occt_1819379591_197231010843 Exceptions
+@subsection occt_cdl_4_3 Exceptions
Exceptions describe exceptional situations, which can arise during the execution of a method. With the raising of an exception, the normal course of program execution is interrupted. The actions carried out in response to this situation are called treatment of exception.
-
-exception-treatment ::= **raises **exception-name {’,’
-exception-name}
-
-Each exception name corresponds to a class of exceptions previously defined as being susceptible to being raised by the method under which it appears. Exception classes must all appear in the **raises **clause of the class of which the method is a member. The class of exceptions is analogous to the class of objects described in this manual.
+~~~~~
+exception-treatment ::= raises exception-name {’,’ exception-name}
+~~~~~
+Each exception name corresponds to a class of exceptions previously defined as being susceptible to being raised by the method under which it appears. Exception classes must all appear in the **raises** clause of the class of which the method is a member. The class of exceptions is analogous to the class of objects described in this manual.
Take for example the method which returns the x, y, or z coordinate of a point.
-**Example**
+~~~~~
Coord (me; i : Integer) returns Real
---Purpose:
-- Returns the abscissa (i=1)
@@ -1091,112 +1126,117 @@ Coord (me; i : Integer) returns Real
-- of me.
raises OutOfRange;
-- if i is not equal to 1, 2, or 3.
+~~~~~
-Instance methods are likely to raise certain exceptions called **systematic exceptions **which do not have to appear. They are:
-**NullObject **Raised when the principal object does not exist.
+Instance methods are likely to raise certain exceptions called **systematic exceptions** which do not have to appear. They are:
-**ImmutableObject **Raised when a method tries to modify an immutable principal object.
-
-**TypeMismatch **Raised if an argument typed by association is of an unsuitable type.
+* *NullObject* - raised when the principal object does not exist.
+* *ImmutableObject* - raised when a method tries to modify an immutable principal object.
+* *TypeMismatch* - raised if an argument typed by association is of an unsuitable type.
These exceptions are described in the Standard Package (System Toolkits).
-@subsection occt_1819379591_197231010844 Inheritance
+@subsection occt_cdl_4_4 Inheritance
-@subsubsection occt_1819379591_1972310108441 Overview
+@subsubsection occt_cdl_4_4_1 Overview
The notion of inheritance comes from a development strategy according to which you begin by modeling data in the most general fashion. Then you specialize it more and more so as to correspond to more and more precise cases.
-For example, to develop a basic geometry, you can first of all consider the group of geometric objects, and then differentiate the points, vectors, and curves. You can specialize the latter into conic sections, and then decompose them into circles, ellipses, and hyperbolae. Then, the class of conics is considered as a sub-class of curves, and a super-class of circles.
+For example, to develop a basic geometry, you can first of all consider the group of geometric objects, and then differentiate the points, vectors, and curves. You can specialize the latter into conic sections, and then decompose them into circles, ellipses, and hyperbolas. Then, the class of conics is considered as a sub-class of curves, and a super-class of circles.
A sub-class has at least the behavior of its super-classes. Thus, a circle could be viewed as a conic, a curve, or even as a geometric object. In each case, the applicable methods belong to the level where you view the class. In this case, you say that the sub-class inherits the behavior from its super-classes.
-**Example**
-declaration-of-a-sub-class ::=
-**class **class-name
-**inherits **class-name
-[**uses **data-type {’,’ data-type}]
-[**raises **exception-name {’,’ exception-name}]
-**is **class-definition
-**end **[class-name]’;’
+
+**Example**
+~~~~~
+declaration-of-a-sub-class ::= class class-name
+inherits class-name
+[uses data-type {’,’ data-type}]
+[raises exception-name {’,’ exception-name}]
+is class-definition
+end [class-name]’;’
+~~~~~
A class cannot inherit one of its descendent classes; nor can it inherit a native type. All the classes of a system can be described in a non-cyclic diagram called the **inheritance graph**.
-The definition of a sub-class is identical to that of a simple class. Note that a super-class *must not *appear in the **uses **clause of the sub-class, even if it appears in the definition of the sub-class. The behavior of a sub-class includes as a minimum all instance methods and protected methods of its super-classes.
+The definition of a sub-class is identical to that of a simple class. Note that a super-class must not appear in the **uses** clause of the sub-class, even if it appears in the definition of the sub-class. The behavior of a sub-class includes as a minimum all instance methods and protected methods of its super-classes.
-NOTE
-Note that constructors and class methods are never inherited.
+**Note** that constructors and class methods are never inherited.
-
-@subsubsection occt_1819379591_1972310108442 Redefining methods
+@subsubsection occt_cdl_4_4_2 Redefining methods
Certain inherited methods can be redefined.
+
**Example**
-declaration-of-a-redefined-method ::=
-identifier formal-part-of-instance-method [returnedtype-
-declaration]
+~~~~~
+declaration-of-a-redefined-method ::= identifier formal-part-of-instance-method [returnedtype- declaration]
[declaration-of-exceptions]
-** is redefined **[visibility]’;’
+is redefined [visibility]’;’
+~~~~~
A redefined method must conform to the syntax described in the super-class where it appears. The exceptions contained in the super-class can be renewed, and others may be added as long as they inherit from an ancestor class.
-The **redefined **attribute can be applied neither to a constructor, nor to a class method, since neither of them can be inherited. If the redefined method is private or protected, the visibility must be exactly repeated in the redefinition. For further details on visibility, refer to “Visibility” on page 48.
-**Example**
+The redefined attribute can be applied neither to a constructor, nor to a class method, since neither of them can be inherited. If the redefined method is private or protected, the visibility must be exactly repeated in the redefinition. For further details on visibility, refer to Visibility section.
+
+**Example**
+~~~~~
SquareDistance (me; P : Point) returns Real
is redefined private;
+~~~~~
With regards to the internal representation, all fields defined in the super-classes are, by default, inherited, but they can also be redefined.
-@subsubsection occt_1819379591_1972310108443 Non-redefinable methods
+@subsubsection occt_cdl_4_4_3 Non-redefinable methods
-Instance methods, which are declared virtual are redefinable in descendent classes, and you can force this redefinition by making a method **deferred**. For more details, see the next section.
+Instance methods, which are declared virtual are redefinable in descendent classes, and you can force this redefinition by making a method **deferred**. For more details, see the next section.
+
**Example**
-declaration-of-a-non-redefinable-method ::=
-identifier formal-part-of-instance-method [returnedtype-
-declaration]
+~~~~~
+declaration-of-a-non-redefinable-method ::= identifier formal-part-of-instance-method [returnedtype- declaration]
[declaration-of-exceptions]
-** is virtual **[visibility]’;’
+ is virtual [visibility]’;’
+~~~~~
-All methods are static by default. To enable redefinition in all the child classes, add “**is virtual;**“ when declaring the method.
+All methods are static by default. To enable redefinition in all the child classes, add **is virtual** when declaring the method.
You must also be able to forbid redefinition. A redefinable method can become non-redefinable if you declare: **is redefined static**.
-@subsubsection occt_1819379591_1972310108444 Deferred Classes and Methods
+@subsubsection occt_cdl_4_4_4 Deferred Classes and Methods
The presence of certain classes in the inheritance graph can be justified purely by their ability to force certain behavior on other classes, in other words, to make other classes provide various services.
The CDL language allows you to describe a class, which introduces methods without implementing them, so as to force its descendent classes to define them. These are called **deferred classes**; the non-implemented methods are also termed **deferred methods**.
-**Example**
-declaration-of-a-deferred-class ::=
-**deferred class **class-name
- [**inherits **class-name
-[**uses **data-type {’,’ data-type}]
-[**raises **exception-name {’,’ exception-name}]
-**is **class-definition
-**end **[class-name]’;’
-declaration-of-a-deferred-method ::=
-identifier formal-part-of-instance-method [returnedtype-
-declaration]
+
+**Example**
+~~~~~
+declaration-of-a-deferred-class ::= deferred class class-name
+[inherits class-name [uses data-type {’,’ data-type}]
+[raises exception-name {’,’ exception-name}]
+is class-definition
+end [class-name]’;’
+declaration-of-a-deferred-method ::= identifier formal-part-of-instance-method [returnedtype- declaration]
[declaration-of-exceptions]
-**is deferred **[visibility]’;’
+is deferred [visibility]’;’
+~~~~~
Only instance methods can be deferred.
It is sufficient for a class to contain one deferred method for it to be a deferred class. It can contain any number of deferred methods (or none).
-A deferred class may still have an internal representation but one or more **non-** **protected **constructors would be necessary to initialize them. The constructors must be visible in the sub-classes.
+A deferred class may still have an internal representation but one or more **non-protected** constructors would be necessary to initialize them. The constructors must be visible in the sub-classes.
+
+The constructors of a deferred class are called **Initialize** (not **Create**). They are **protected** by default, and do not return any object. You cannot create an object of a deferred class type.
+For example, consider the class *Point*, and its declaration as deferred.
-The constructors of a deferred class are called **Initialize **(not **Create**). They are **protected **by default, and do not return any object. You cannot create an object of a deferred class type.
-For example, consider the class “Point”, and its declaration as deferred.
**Example**
-
+~~~~~
deferred class Point inherits Geometry is
Initialize;
---Purpose: Initializes the point.
@@ -1209,103 +1249,99 @@ is deferred;
Distance (me; P : Point) returns Real;
---Purpose: Returns the distance from the point P
end Point;
+~~~~~
-Notice that the function “Distance” is not deferred. Although this class contains no representation, this method is programmable by calling “Coord”.
+Notice that the function *Distance* is not deferred. Although this class contains no representation, this method is programmable by calling *Coord*.
-In a sub-class of a deferred class, all deferred methods, which have been inherited, *must *be implemented, then redeclared (the attribute **redefined **is useless for this purpose), unless the sub-class is itself deferred.
+In a sub-class of a deferred class, all deferred methods, which have been inherited, must be implemented, then redeclared (the attribute **redefined** is useless for this purpose), unless the sub-class is itself deferred.
A non-deferred method can be redefined as a deferred one, in which case it will be declared as follows: **is redefined deferred**.
-The notion of deferred class is very useful. The advantage of introducing it, as was previously shown in the deferred class “Point”, is that the corresponding resources will be available even before being implemented. Later, you can add different representations to Point (for example, spherical or Cartesian coordinates) without having to modify client programs.
+The notion of deferred class is very useful. The advantage of introducing it, as was previously shown in the deferred class *Point*, is that the corresponding resources will be available even before being implemented. Later, you can add different representations to Point (for example, spherical or Cartesian coordinates) without having to modify client programs.
Thanks to the possibility of redefining methods, this approach does not have any negative impact on performance: a method implemented at the level of a deferred class can be reprogrammed in one of its sub-classes while taking into account the data representation.
-@subsubsection occt_1819379591_1972310108445 Declaration by Association
-At the heart of a class hierarchy, object identifiers are compatible in the ascendant sense. Since the Conic class is descended from the Curve class, an identifier of type Curve can reference an object of type Conic (remember that the behavior of Curve is applicable to Conic). In other words, you can assign a reference to a Conic to an identifier of type Curve, but *not *vice versa.
+@subsubsection occt_cdl_4_4_5 Declaration by Association
+
+At the heart of a class hierarchy, object identifiers are compatible in the ascendant sense. Since the *Conic* class is descended from the *Curve* class, an identifier of type *Curve* can reference an object of type *Conic* (remember that the behavior of *Curve* is applicable to *Conic*). In other words, you can assign a reference to a *Conic* to an identifier of type *Curve*, but not vice versa.
For example, once the classes have been compiled you could write a C++ test program in which you instantiate a Conic but reference it with a handle to a Curve:
-
-**Example**
-
+~~~~~
Handle(Curve) c = new Conic
+~~~~~
+This same rule applies to parameters of methods; that is to say, you can call a method with identifiers corresponding to a sub-type of that specified in its declaration. To illustrate this, let us go back to the “Distance” method of the “Point” class:
-This same rule applies to parameters of methods; that is to say, you can call a method with identifiers corresponding to a sub-type of that specified in its declaration. To illustrate this, you go back to the “Distance” method of the “Point” class:
-**Example**
-
+~~~~~
Distance (me; P : point) returns Real;
-
+~~~~~
Conforming to the rule of type compatibility, you could make a call to the method “Distance” with reference to an object from a class descended from “Point”. Consequently, if “SphericPoint” is a sub-class of “Point” and therefore inherits this method, it will be possible to calculate the distance between two “SphericPoint”, or between a “SphericPoint” and a “Point”, without having to redefine the method.
On the other hand, sometimes you may want to force two parameters to be exactly of the same type, and thus not apply the rule of type compatibility. To do this, you need to associate the type of the concerned parameters in the method declaration.
-**Example**
-association-typing ::=
-**like **associated-parameter
-associated-parameter ::=
-**me **| identifier
+~~~~~
+association-typing ::= like associated-parameter
+associated-parameter ::= me | identifier
+~~~~~
-
-NOTE
-***Note that identifier is the name of a parameter, which appears***
-***first in the formal part of the declaration of the method.***
+Note that identifier is the name of a parameter, which appears first in the formal part of the declaration of the method.
You can use this technique, which consists in declaring by association, to declare a method that will exchange the content of two objects, or a method, which copies another object:
-**Example**
+~~~~~
Swap (me : mutable; With : mutable like me);
DeepCopy (me) returns mutable like me;
+~~~~~
-Make sure *not *to write the Swap method as in the syntax below:
+Make sure not to write the Swap method as in the syntax below:
-**Example**
+~~~~~
Swap (me : mutable; With : mutable Point);
+~~~~~
-In this case **me **may be a CartesianPoint or a SphericalPoint, while “With” can only be a Point.
-@subsubsection occt_1819379591_1972310108446 Redefinition of Fields
+In this case **me** may be a CartesianPoint or a SphericalPoint, while *With* can only be a Point.
+
+@subsubsection occt_cdl_4_4_6 Redefinition of Fields
The creation of a hierarchy of classes should be viewed as a means to specialize their behavior, (e.g. a circle is more specialized than a conic section). The more you specialize the object classes, the more it is justified to call into question the inherited fields in order to obtain greater optimization. So, in the description of the internal representation of a sub-class, it is possible not to inherit all of the fields of the super-classes. You then say the fields have been redefined.
-**Example**
-redefinition-of-the-representation-of-a-class ::=
-**redefined **redefinition-of-a-field {’,’ redefinition-of-a-
+~~~~~
+redefinition-of-the-representation-of-a-class ::= redefined redefinition-of-a-field {’,’ redefinition-of-a-
field}’,’
-redefinition-of-a-field ::=
-[field-name] **from **[**class**] class-name
+redefinition-of-a-field ::= [field-name] from [class] class-name
+~~~~~
-Redefinition of fields can *only *be done in classes manipulated by a handle.
+Redefinition of fields can only be done in classes manipulated by a handle.
This declaration appears at the beginning of the definition of the internal representation of the sub-class, which breaks the field inheritance. The non-inherited fields are all those which come from the class specified behind the rubric **from**.
-@subsection occt_1819379591_197231010845 Genericity
+@subsection occt_cdl_4_5 Genericity
-@subsubsection occt_1819379591_1972310108451 Overview
+@subsubsection occt_cdl_4_5_1 Overview
Inheritance is a powerful mechanism for extending a system, but it does not always allow you to avoid code duplication, particularly in the case where two classes differ only in the type of objects they manipulate (you certainly encounter this phenomenon in all basic structures). In such cases, it is convenient to send arbitrary parameters representing types to a class. Such a class is called a **generic class**. Its parameters are the generic types of the class.
Generic classes are implemented in two steps. You first declare the generic class to establish the model, and then instantiate this class by giving information about the generic types.
-@subsubsection occt_1819379591_1972310108452 Declaration of a Generic Class
+@subsubsection occt_cdl_4_5_2 Declaration of a Generic Class
The syntax is as follows:
-**Example**
-declaration-of-a-generic-class ::=
-[**deferred**] **generic class **class-name ’(’generic-type
-{’,’generic-type}’)’
-[**inherits **class-name
-[**uses **data-type {’,’ data-type}]
-[**raises **exception-name {’,’ exception-name}]
-**is **class-definition
-**end **[class-name]’;’
-generic-type ::=
-identifier **as **type-constraint
-type-constraint ::=
-**any **| class-name [’(’data-type {’,’data-type}’)’]
+~~~~~
+declaration-of-a-generic-class ::= [deferred] generic class class-name ’(’generic-type {’,’generic-type}’)’
+[inherits class-name
+[uses data-type {’,’ data-type}]
+[raises exception-name {’,’ exception-name}]
+ is class-definition
+ end [class-name]’;’
+generic-type ::= identifier as type-constraint
+type-constraint ::= any | class-name [’(’data-type {’,’data-type}’)’]
+~~~~~
The names of generic types become new types, which are usable in the definition of a class, both in its behavior (methods) and its representation (fields). The generic type is only visible inside the generic class introducing it. As a result, it is possible to have another generic class using the same generic type within the same package.
+
When you specify the type constraint under the form of a class name, you impose a minimum set of behavior on the manipulated object.
This shows that the generic type has as a minimum the services defined in the class. This can be any kind of a previously defined class, including another generic class, in which case you state exactly with what types they are instantiated.
@@ -1316,484 +1352,495 @@ No class can inherit from a generic class.
A generic class can be a deferred class. A generic class can also accept a deferred class as its argument. In both these cases any class instantiated from it will also be deferred. The resulting class can then be inherited by another class.
-Below is a partial example of a generic class: a persistent singly linked list.
-**Example**
-
+Below is a partial example of a generic class: a persistent singly linked list.
+
+~~~~~
generic class SingleList (Item as Storable)
-inherits Persistent
-raises NoSuchObject
-is
-Create returns mutable SingleList;
+ inherits Persistent
+ raises NoSuchObject
+ is
+ Create returns mutable SingleList;
---Purpose: Creates an empty list
-IsEmpty (me) returns Boolean;
- ---Purpose: Returns true if the list me is empty
-SwapTail (me : mutable; S : in out mutable
-SingleList)
- ---Purpose: Exchanges the tail of list me with S
--- Exception NoSuchObject raised when me is
-empty
-raises NoSuchObject;
- Value (me) returns Item
- ---Purpose: Returns first element of the list me
--- Exception NoSuchObject raised when me is
-empty
-raises NoSuchObject;
- Tail (me) returns mutable SingleList
----Purpose: Returns the tail of the list me
--- Exception NoSuchObject raised when me is
-empty
-raises NoSuchObject;
- fields
-Data : Item;
- Next : SingleList;
- end SingleList;
+ IsEmpty (me) returns Boolean;
+ ---Purpose: Returns true if the list me is empty
+ SwapTail (me : mutable; S : in out mutable
+ SingleList)
+ ---Purpose: Exchanges the tail of list me with S
+ -- Exception NoSuchObject raised when me is empty
+ raises NoSuchObject;
+ Value (me) returns Item
+ ---Purpose: Returns first element of the list me
+ -- Exception NoSuchObject raised when me is empty
+ raises NoSuchObject;
+ Tail (me) returns mutable SingleList
+ ---Purpose: Returns the tail of the list me
+ -- Exception NoSuchObject raised when me is empty
+ raises NoSuchObject;
+ fields
+ Data : Item;
+ Next : SingleList;
+ end SingleList;
+~~~~~
Even though no object of the type “SingleList” IS created, the class contains a constructor. This class constitutes a model, which will be recopied at instantiation time to create a new class which will generate objects. The constructor will then be required.
-**Example**
+**Example**
+~~~~~
generic class Sequence(Item as any, Node as
SingleList(Item))
inherits Object
. . .
end Sequence
+~~~~~
-In the above example, there are two generic types: Item & Node. The first imposes no restriction. The second must at least have available the services of the class SingleList instantiated with the type with which Sequence will itself be instantiated.
+In the above example, there are two generic types: *Item* and *Node*. The first imposes no restriction. The second must at least have available the services of the class *SingleList* instantiated with the type with which *Sequence* will itself be instantiated.
+
+In the incomplete declaration of a generic class, the keyword **generic** must appear.
-In the **incomplete declaration of a generic class**, the keyword **generic **must appear.
**Example**
-
+~~~~~
generic class SingleList;
generic class Sequence;
-@subsubsection occt_1819379591_1972310108453 Instantiation of a Generic Class
+~~~~~
+
+@subsubsection occt_cdl_4_5_3 Instantiation of a Generic Class
The syntax is as follows:
-**Example**
-instantiation-of-a-generic-class ::=
-[**deferred**] **class **class-name
-** instantiates **class-name ’(’data-type {’,’
-data-type}’);’
+~~~~~
+instantiation-of-a-generic-class ::= [deferred] class class-name
+ instantiates class-name ’(’data-type {’,’ data-type}’);’
+~~~~~
Instantiation is said to be **static**. In other words, it must take place before any use can be made of the type of the instantiated class. Each data type is associated term by term with those declared at the definition of the generic class. These latter ones, when they are not of the type **any**, restrict instantiation to those classes, which have a behavior at least equal to that of the class specified in the type constraint, including constructors. Note that this is not guaranteed by inheritance itself.
-For example, let’s instantiate the class “Sequence” for the type “Point”:
-**Example**
+For example, let’s instantiate the class *Sequence* for the type *Point*:
+~~~~~
class SingleListOfPoint instantiates SingleList(Point);
class Sequence instantiates
-Sequence(Point,SingleListOfPoint);
+ Sequence(Point,SingleListOfPoint);
+~~~~~
-The instantiation of a generic deferred class is a deferred class (the **deferred **attribute must be present during instantiation). An instantiated class cannot be declared in an incomplete fashion.
+The instantiation of a generic deferred class is a deferred class (the **deferred** attribute must be present during instantiation). An instantiated class cannot be declared in an incomplete fashion.
-@subsubsection occt_1819379591_1972310108454 Nested Generic Classes
+@subsubsection occt_cdl_4_5_4 Nested Generic Classes
+
+It often happens that many classes are linked by a common generic type. This is the case when a base structure provides an iterator, for example, in the class *Graph*. A graph is made up of arcs, which join together the nodes, which reference objects of any type. This type is generic both for the graph and for the node. In this context, it is necessary to make sure that the group of linked generic classes is indeed instantiated for the same type of object. So as to group the instantiation, CDL allows the declaration of certain classes to be nested.
-It often happens that many classes are linked by a common generic type. This is the case when a base structure provides an iterator, for example, in the class “Graph”. A graph is made up of arcs, which join together the nodes, which reference objects of any type. This type is generic both for the graph and for the node. In this context, it is necessary to make sure that the group of linked generic classes is indeed instantiated for the same type of object. So as to group the instantiation, CDL allows the declaration of certain classes to be nested.
**Example**
-declaration-of-a-generic-class ::=
- [**deferred**] **generic class **class-name ’(’generic-
-type{’,’generic-type}’)’
- [**inherits **class-name {’,’ class-name}]
- [**uses **data-type {’,’ data-type}]
- [**raises **exception-name {’,’ exception-name}]
+~~~~~
+declaration-of-a-generic-class ::= [deferred] generic class class-name ’(’generic-type{’,’generic-type}’)’
+ [inherits class-name {’,’ class-name}]
+ [uses data-type {’,’ data-type}]
+ [raises exception-name {’,’ exception-name}]
[{[visibility] class-declaration}]
-** is **class-definition
-**end **[class-name]’;’
- class-declaration ::=
- incomplete-declaration-of-a-class |
- declaration-of-a-non-generic-class |
- instantiation-of-a-generic-class
+ is class-definition
+end [class-name]’;’
+ class-declaration ::= incomplete-declaration-of-a-class | declaration-of-a-non-generic-class | instantiation-of-a-generic-class
+~~~~~
-**Nested classes**, even though they are described as non-generic classes, are generic by construction, being inside the class of which they are a part. As a consequence, the generic types introduced by the **encompassing class **can be used in the definition of the nested class. This is true even if the generic type is only used in a nested class. The generic types still* must *appear as an argument of the encompassing class. All other types used by a nested class *must *appear in its **uses **or **raises **clauses, just as if it were an independent class.
+**Nested classes**, even though they are described as non-generic classes, are generic by construction, being inside the class of which they are a part. As a consequence, the generic types introduced by the **encompassing class** can be used in the definition of the nested class. This is true even if the generic type is only used in a nested class. The generic types still must appear as an argument of the encompassing class. All other types used by a nested class must appear in its **uses** or **raises** clauses, just as if it were an independent class.
-Nested classes are, by default, **public**. In other words, they can be used by the clients of the encompassing class. On the other hand, when one of the nested classes is declared **private **or **protected**, this class *must not *appear in any of the public methods of the other classes. It cannot be used in a protected field because then it could be used in a sub-class, which implies it would not be private.
+Nested classes are, by default, **public**. In other words, they can be used by the clients of the encompassing class. On the other hand, when one of the nested classes is declared **private** or **protected**, this class must not appear in any of the public methods of the other classes. It cannot be used in a protected field because then it could be used in a sub-class, which implies it would not be private.
The following example shows how to write the Set class with its iterator.
-**Example**
+~~~~~
generic class Set (Item as Storable)
-inherits Persistent
-private class Node instantiates SingleList (Item);
-class Iterator
- uses Set, Node
- raises NoSuchObject, NoMoreObject
- is
- Create (S : Set) returns mutable Iterator;
----Purpose: Creates an iterator on the group S
- More (me) returns Boolean;
----Purpose: Returns true if there are still elements
- -- to explore
- Next (me) raises NoMoreObject;
----Purpose: Passes to the following element
- Value (me) returns any Item raises NoSuchObject;
----Purpose: Returns the current element
- fields
- Current : Node;
-end Iterator;
-is
- Create returns mutable Set;
----Purpose: Creates an empty group
- IsEmpty (me) returns Boolean;
----Purpose: Returns true if the group is empty
- Add (me : mutable; T : Item);
----Purpose: Adds an item to the group me
- Remove (me : mutable; T : item) raises
-NoSuchObject;
----Purpose: Removes an item from the group me
- etc.
- fields
- Head : Node;
-end Set;
+ inherits Persistent
+ private class Node instantiates SingleList (Item);
+ class Iterator
+ uses Set, Node
+ raises NoSuchObject, NoMoreObject
+ is
+ Create (S : Set) returns mutable Iterator;
+ ---Purpose: Creates an iterator on the group S
+ More (me) returns Boolean;
+ ---Purpose: Returns true if there are still elements
+ -- to explore
+ Next (me) raises NoMoreObject;
+ ---Purpose: Passes to the following element
+ Value (me) returns any Item raises NoSuchObject;
+ ---Purpose: Returns the current element
+ fields
+ Current : Node;
+ end Iterator;
+ is
+ Create returns mutable Set;
+ ---Purpose: Creates an empty group
+ IsEmpty (me) returns Boolean;
+ ---Purpose: Returns true if the group is empty
+ Add (me : mutable; T : Item);
+ ---Purpose: Adds an item to the group me
+ Remove (me : mutable; T : item) raises
+ NoSuchObject;
+ ---Purpose: Removes an item from the group me
+ etc.
+ fields
+ Head : Node;
+ end Set;
+~~~~~
-Note that in their fields, both “Set” and “Iterator” are clients of another class, “Node”. This last can be effectively declared **private **for it only appears in fields which are themselves private.
+Note that in their fields, both “Set” and “Iterator” are clients of another class, “Node”. This last can be effectively declared **private** for it only appears in fields which are themselves private.
The instantiation of a generic class containing nested classes remains unchanged. The same declaration is used to instantiate the encompassing class and the nested classes. These latter will have their name suffixed by the name supplied at instantiation, separated by “Of”. For example, you instantiate the class “Set” described above for the type “Point” as follows:
-**Example**
+~~~~~
class SetOfPoint instantiates Set(Point);
-
+~~~~~
In doing so, you implicitly describe the classes “NodeOfSetOfPoint” and “IteratorOfSetOfPoint”, which are respectively the result of the concatenation of “Node” and “Iterator” with “Of” then “SetOfPoint”.
-Note that in the incomplete declaration of an encompassing class, all the names of the nested classes *must *appear behind that of the encompassing class.
+Note that in the incomplete declaration of an encompassing class, all the names of the nested classes *must* appear behind that of the encompassing class.
-incomplete-declaration-of-a-generic-class ::=
-[**deferred**] **generic **class-name {’,’ class-name};
+~~~~~
+incomplete-declaration-of-a-generic-class ::= [deferred] generic class-name {’,’ class-name};
+~~~~~
For example, an incomplete declaration of the above class “Set” would be as in the example below:
-**Example**
+~~~~~
generic class Set, Node, Iterator;
+~~~~~
Only the encompassing class can be deferred. In the above example only the class “Set” can be deferred.
-@subsection occt_1819379591_197231010846 Visibility
+@subsection occt_cdl_4_6 Visibility
-@subsubsection occt_1819379591_1972310108461 Overview
+@subsubsection occt_cdl_4_6_1 Overview
A field, method, class, or package method is only available for use if it is **visible**.
Each of these components has a default visibility, which can be explicitly modified during class or package declaration. The three possible states of visibility are:
-
* Public
* Private
* Protected
-@subsubsection occt_1819379591_1972310108462 Visibility of Fields
+@subsubsection occt_cdl_4_6_2 Visibility of Fields
-A field is **private**. It can never be public - this would destroy the whole concept of data encapsulation. The attribute **private **is redundant when it is applied to a field. This means that a field is only visible to methods within its own class.
-A field can be declared **protected **which means that it becomes visible in subclasses of its own class. Its contents can be modified by methods in subclasses.
+A field is **private**. It can never be public - this would destroy the whole concept of data encapsulation. The attribute **private** is redundant when it is applied to a field. This means that a field is only visible to methods within its own class.
+A field can be declared **protected**, which means that it becomes visible in subclasses of its own class. Its contents can be modified by methods in subclasses.
-field ::=
-identifier {’,’ identifier} ’:’ data-type
+~~~~~
+field ::= identifier {’,’ identifier} ’:’ data-type
[’[’integer{’,’integer}’]’]
-[**is protected**]’;’
-Example
+[is protected]’;’
+~~~~~
+**Example**
+
+~~~~~
fields
Phi, Delta, Gamma : AngularMomenta [3]
is protected ;
+~~~~~
+@subsubsection occt_cdl_4_6_3 Visibility of Methods
-@subsubsection occt_1819379591_1972310108463 Visibility of Methods
+Methods act on fields. Only methods belonging to a class can act on the fields of the class; this stems from the principle of object encapsulation. Methods can be characterized in three ways: by default, methods are **public**. Methods can be declared **private** or **protected** to restrict their usage.
-Methods act on fields. Only methods belonging to a class can act on the fields of the class; this stems from the principle of object encapsulation. Methods can be characterized in three ways: by default, methods are **public**. Methods can be declared **private **or **protected **to restrict their usage.
-
-**Public methods **Are the default and are generally the most common. They describe the behavior of a class or a package, and they are callable by any part of a program.
-
-**Private methods **Exist only for the internal structuring of their class or their package. Private class methods can only be called by methods belonging to the same class. Private package methods can only be called by all methods belonging to the same package and its classes.
-
-**Protected methods **Are private methods, which are also callable from the interior of descendent classes.
+* **Public** methods are the default and generally the most common. They describe the behavior of a class or a package, and they are callable by any part of a program.
+* **Private** methods exist only for the internal structuring of their class or their package. Private class methods can only be called by methods belonging to the same class. Private package methods can only be called by all methods belonging to the same package and its classes.
+* **Protected** methods are private methods, which are also callable from the interior of descendent classes.
If you want to restrict the usage of a method, you associate with it a visibility as follows :
+~~~~~
+-- declaration-of-the-visibility ::= is visibility
+visibility ::= private | protected
+~~~~~
--- declaration-of-the-visibility ::=
-**is **visibility
-visibility ::= **private **| **protected**
-
-The declaration of the visibility of a method appears at the end of its definition, before the final semi-colon. The attribute **private **indicates that the method will only be visible to the behavior of the class of which the method is a member; **protected **will propagate the visibility among the sub-classes of this class.
+The declaration of the visibility of a method appears at the end of its definition, before the final semi-colon. The attribute **private** indicates that the method will only be visible to the behavior of the class of which the method is a member; **protected** will propagate the visibility among the sub-classes of this class.
For example, add to the class “Line” an internal method allowing the calculation of the perpendicular distance to the power of two, from the line to a point.
-**Example**
+~~~~~
SquareDistance (me; P : Point) returns Real
-@subsubsection occt_1819379591_1972310108464 Visibility of Classes, Exceptions, & Enumerations
+is private;
+~~~~~
-The visibility of a class is the facility to be able to use this class in the definition of another class. The visibility of a class extends from the beginning of its declaration up to the end of the package in which it appears. You have seen that the keyword **uses **allows extension of this visibility to other packages.
+@subsubsection occt_cdl_4_6_4 Visibility of Classes, Exceptions and Enumerations
-As was explained in the section on “Name Space”, any ambiguity, which arises from having two classes with the same name coming from different packages, is dealt with by the use of the keyword **from**.
+The visibility of a class is the facility to be able to use this class in the definition of another class. The visibility of a class extends from the beginning of its declaration up to the end of the package in which it appears. You have seen that the keyword **uses** allows extension of this visibility to other packages.
-A class declared **private **is only available within its own package.
+As was explained in the section on “Name Space”, any ambiguity, which arises from having two classes with the same name coming from different packages, is dealt with by the use of the keyword **from**.
-@subsubsection occt_1819379591_1972310108465 Friend Classes & Methods
+A class declared **private** is only available within its own package.
-In certain cases, methods need to have direct access to the private or protected parts of classes of which they are clients. Such a method is called a **friend **of the class, which is accessed. For example, you declare a method to be a friend when a service can only be obtained via the use of another non-descendent class, or perhaps when this will help to improve performance.
+@subsubsection occt_cdl_4_6_5 Friend Classes and Methods
+
+In certain cases, methods need to have direct access to the private or protected parts of classes of which they are clients. Such a method is called a **friend** of the class, which is accessed. For example, you declare a method to be a friend when a service can only be obtained via the use of another non-descendent class, or perhaps when this will help to improve performance.
Classes can also be declared friends of other classes. In this case all the methods of the friend class will have access to the fields and methods of the host class. The right is **not reciprocal**.
Friend classes or methods are declared inside the class, which reveals its private and protected data or methods to them. This helps in managing the continuing evolution of a class, helping to recognize and to avoid the creation of side effects.
+
**Example**
+~~~~~
+declaration-of-friends ::= friends friend {’,’friend}
+ friend ::= identifier from [class] class-name [formal-part] |
+-- Defining the Software Components 67
+identifier from [package] package-name [formal-part] | class] class-name
+ formal-part ::= simple-formal-part | formal-part-of-instance-method | formal-part-of-class-method
+~~~~~
-declaration-of-friends ::=
-**friends **friend {’,’friend}
- friend ::=
- identifier **from **[**class**] class-name [formal-part] |
-**Defining the Software Components 67**
-identifier **from **[**package**] package-name [formal-part] |
-** class**] class-name
- formal-part ::=
- simple-formal-part |
- formal-part-of-instance-method |
- formal-part-of-class-method
-
-The formal part *must *be presented if the method contains one; thus this can be overloaded without necessarily propagating the friend relationship among its homonyms. The keyword **class **allows you to avoid certain ambiguities. For example, it removes any confusion between “method M from class C” and “method M from package P”.
+The formal part must be present if the method contains one; thus this can be overloaded without necessarily propagating the friend relationship among its homonyms. The keyword **class** allows you to avoid certain ambiguities. For example, it removes any confusion between “method M from class C” and “method M from package P”.
As an example, take a method, which calculates the perpendicular distance between a line and a point. Suppose this method needs to access the fields of the point. In the class “Point” you would write:
-**Example**
+~~~~~
friends Distance from Line (me; P : Point)
+~~~~~
-A method can be a friend to many classes. The class to which the method belongs does *not *need to appear in the **uses **clause of other classes of which it is a friend.
-
- @image html /dev_guides/cdl/images/cdl_image011.png
- @image latex /dev_guides/cdl/images/cdl_image011.png
+A method can be a friend to many classes. The class to which the method belongs does not need to appear in the **uses** clause of other classes of which it is a friend.
When the methods of a class are all friends of another class, you can establish the friendship at the level of the class.
-Figure 9. Visibility of various components
-@section occt_1819379591_858765726 Appendix A. Syntax Summary
+
+| | Public | Private | Protected |
+| :---- | :---- | :---- | :----- |
+| Field | Does not exist | **Default** - Visible to methods in its own class and in friend classes | Visible to methods in its own class, sub-classes and friend classes |
+| Method | **Default** - Callable anywhere | Callable by methods in its own class and in friend classes | Callable by methods in its own class, sub-classes and friend classes |
+| Class | **Default** - Visible everywhere with the use of **from** rubric | Visible to classes in its own package | Does not exist |
+| Package method | **Default** - Callable everywhere with the use of **from** rubric | Visible to classes in its own package | Does not exist |
+| Nested Class | **Default** - Visible to the clients of the encompassing class | Visible to the encompassing class and other classes nested in the encompassing class | Does not exist |
-
-This summary of the CDL syntax will aid in the comprehension of the language, but does *not *constitute an exact definition thereof. In particular, the grammar described here accepts a super-set of CDL constructors semantically validated.
-
-(1) capital ::=
-’A’ | ’B’ | ’C’ | ’D’ | ’E’ | ’F’ | ’G’ | ’H’ |
-’I’ | ’J’ | ’K’ | ’L’ | ’M’ | ’N’ |
-’O’ | ’P’ | ’Q’ | ’R’ | ’S’ | ’T’ | ’U’ | ’V’ |
-’W’ | ’X’ | ’Y’ | ’Z’
-
-(2) non-capital ::=
-’a’ | ’b’ | ’c’ | ’d’ | ’e’ | ’f’ | ’g’ | ’h’ |
-’i’ | ’j’ | ’k’ | ’l’ | ’m’ | ’n’ |
-’o’ | ’p’ | ’q’ | ’r’ | ’s’ | ’t’ | ’u’ | ’v’ |
-’w’ | ’x’ | ’y’ | ’z’
-
-(3) digit ::=
-’0’ | ’1’ | ’2’ | ’3’ | ’4’ | ’5’ | ’6’ | ’7’ |
-’8’ | ’9’
-
-(4) underscore ::=
-’_’
-
-(5) special character ::=
-’ ’ | ’!’ | ’”’ | ’#’ | ’$’ | ’%’ | ’&’ | ’’’ |
-’(’ | ’)’ | ’*’ | ’+’ | ’,’ | ’-’ |
-’.’ | ’/’ | ’:’ | ’;’ | ’’ | ’=’ | ’’ | ’?’ |
-’@’ | ’[’ | ’\’ | ’]’ | ’^’ | ’‘’ |
-’{’ | ’|’ | ’}’ | ’~’
-
-(6) printable character::=
-capitals | non-capitals | digits | underscore |
-special characters
-
-(7) letter ::=
-capital | non-capital
-
-(8) alphanumeric ::=
-letter | digit
-
-(9) identifier ::=
-letter{[underscore]alphanumeric}
-
-(10) integer ::=
-digit{digit}
-
-(11) exponent ::=
-’E’[’+’]integer | ’E-’integer
-
-(12) numeric-constant ::=
-[’+’]integer ’.’ integer[exponent] | ’-’integer
-’.’ integer[exponent]
+@section occt_cdl_5 Appendix A. Syntax Summary
-(13) literal-constant ::=
-’’’printable character’’’ | ’~’{printable
+This summary of the CDL syntax will aid in the comprehension of the language, but does *not* constitute an exact definition thereof. In particular, the grammar described here accepts a super-set of CDL constructors semantically validated.
+
+(1) capital ::= ’A’ | ’B’ | ’C’ | ’D’ | ’E’ | ’F’ | ’G’ | ’H’ | ’I’ | ’J’ | ’K’ | ’L’ | ’M’ | ’N’ |
+’O’ | ’P’ | ’Q’ | ’R’ | ’S’ | ’T’ | ’U’ | ’V’ | ’W’ | ’X’ | ’Y’ | ’Z’
+
+(2) non-capital ::= ’a’ | ’b’ | ’c’ | ’d’ | ’e’ | ’f’ | ’g’ | ’h’ | ’i’ | ’j’ | ’k’ | ’l’ | ’m’ | ’n’ |
+’o’ | ’p’ | ’q’ | ’r’ | ’s’ | ’t’ | ’u’ | ’v’ | ’w’ | ’x’ | ’y’ | ’z’
+
+(3) digit ::= ’0’ | ’1’ | ’2’ | ’3’ | ’4’ | ’5’ | ’6’ | ’7’ | ’8’ | ’9’
+
+(4) underscore ::= ’_’
+
+(5) special character ::= ’ ’ | ’!’ | ’”’ | ’#’ | ’$’ | ’%’ | ’&’ | ’’’ | ’(’ | ’)’ | ’*’ | ’+’ | ’,’ | ’-’ | ’.’ | ’/’ | ’:’ | ’;’ | ’’ | ’=’ | ’’ | ’?’ | ’@’ | ’[’ | ’\’ | ’]’ | ’^’ | ’‘’ | ’{’ | ’|’ | ’}’ | ’~’
+
+(6) printable character::= capitals | non-capitals | digits | underscore | special characters
+
+(7) letter ::= capital | non-capital
+
+(8) alphanumeric ::= letter | digit
+
+(9) identifier ::= letter{[underscore]alphanumeric}
+
+(10) integer ::= digit{digit}
+
+(11) exponent ::= ’E’[’+’]integer | ’E-’integer
+
+(12) numeric-constant ::= [’+’]integer ’.’ integer[exponent] | ’-’integer ’.’ integer[exponent]
+
+
+(13) literal-constant ::= ’’’printable character’’’ | ’~’{printable
character}’~’
-(14) package-name ::=
-identifier
+(14) package-name ::= identifier
-(15) enumeration-name ::=
-identifier [**from**** **package-name]
+(15) enumeration-name ::= identifier [**from** package-name]
-(16) class-name ::=
-identifier [**from**** **package-name]
+(16) class-name ::= identifier [**from** package-name]
-(17) exception-name ::=
-identifier [**from**** **package-name]
+(17) exception-name ::= identifier [**from** package-name]
-(18) constructor-name ::=
-’Create’ | ’Initialize’
+(18) constructor-name ::= ’Create’ | ’Initialize’
-(19) primitive-type ::=
-’Boolean’ | ’Character’ | ’Integer’ | ’Real’
+(19) primitive-type ::= ’Boolean’ | ’Character’ | ’Integer’ | ’Real’
-(20) data-type ::=
-enumeration-name | class-name | exception-name
-| primitive-type
+(20) data-type ::= enumeration-name | class-name | exception-name | primitive-type
-(21) passed-type ::=
-data-type | **like me**** **| **like**** **identifier
+(21) passed-type ::= data-type | **like me** | **like** identifier
-(22) passing-mode ::=
-[**in**] | **out**** **| **in out**
+(22) passing-mode ::= [**in**] | **out** | **in out**
-(23) parameter-access ::=
-**mutable**** **| [**immutable**]
+(23) parameter-access ::= **mutable** | [**immutable**]
-(23A) return-access ::=
-**mutable**** **| [**immutable**]| **any**
+(23A) return-access ::= **mutable** | [**immutable**]| **any**
-(24) value ::=
-numeric-constant | literal-constant |
-identifier
+(24) value ::= numeric-constant | literal-constant | identifier
-(25) parameter ::=
-identifier {’,’ identifier} ’:’ passing-mode
-access-right passed-type [’=’ value]
+(25) parameter ::= identifier {’,’ identifier} ’:’ passing-mode access-right passed-type [’=’ value]
-(26) simple-formal-part ::=
-’(’parameter {’;’ parameter}’)’
+(26) simple-formal-part ::= ’(’parameter {’;’ parameter}’)’
-(27) formal-part-of-instance-method ::=
-’(’**me**** **[’:’ passing-mode access-right] {’;’
-parameter}’)’
+(27) formal-part-of-instance-method ::= ’(’ **me** [’:’ passing-mode access-right] {’;’ parameter}’)’
-(28) formal-part-of-class-method ::=
-’(’**myclass**** **{’;’ parameter}’)’
+(28) formal-part-of-class-method ::= ’(’ **myclass** {’;’ parameter}’)’
-(29) visibility ::=
-**private**** **| **protected**
-(30) redefinition ::=
-**static**** **| **deferred**
-(31) definition-level ::=
-redefinition |** ****redefined**** **[redefinition]
+(29) visibility ::= **private** | **protected**
-(32) declaration-of-constructed-type ::=
-**returns**** **[**mutable**] class-name
+(30) redefinition ::= **static** | **deferred**
-(33) declaration-of-returned-type ::=
-**returns**** **return-access passed-type
+(31) definition-level ::= redefinition | **redefined** [redefinition]
-(34) declaration-of-errors ::=
-**raises**** **exception-name {’,’ exception-name}
+(32) declaration-of-constructed-type ::= **returns** [**mutable**] class-name
-(35) declaration-of-visibility ::=
-**is**** **visibility
+(33) declaration-of-returned-type ::= **returns** return-access passed-type
-(36) declaration-of-attributes-of-instance-method ::=
-**is**** **visibility | **is **definition-of-level
-[visibility]
+(34) declaration-of-errors ::= **raises** exception-name {’,’ exception-name}
-(37) constructor ::=
-constructor-name [simple-formal-part]
+(35) declaration-of-visibility ::= **is** visibility
+
+(36) declaration-of-attributes-of-instance-method ::= **is** visibility | **is** definition-of-level [visibility]
+
+(37) constructor ::= constructor-name [simple-formal-part]
[declaration-of-constructed-type]
[declaration-of-errors]
[declaration-of-visibility]’;’
-(38) instance-method ::=
-identifier formal-part-of-instance-method
+(38) instance-method ::= identifier formal-part-of-instance-method
[declaration of returned type]
[declaration-of-errors]
[declaration-of-attributes-of-instancemethod]’;’
-(39) class-method ::=
-identifier formal-part-of-the-class-method
+(39) class-method ::= identifier formal-part-of-the-class-method
[declaration of returned type]
[declaration-of-errors]
[declaration-of-visibility]’;’
-(40) package-method ::=
-identifier [simple-formal-part]
+(40) package-method ::= identifier [simple-formal-part]
[declaration-of-returned-type]
[declaration-of-errors]
[**is private**]’;’
-(41) member-method ::=
-constructor | instance-method | class-method
+(41) member-method ::= constructor | instance-method | class-method
-(42) formal-part ::=
-simple-formal-part |
-formal-part-of-instance-method|
-formal-part-of-class-method
+(42) formal-part ::= simple-formal-part | formal-part-of-instance-method| formal-part-of-class-method
-(43) friend ::=
-identifier **from**** **[**class**] class-name [formal-part]
-|
-identifier **from**** **[**package**] package-name [formal-
-part] |
+(43) friend ::= identifier **from** [**class**] class-name [formal-part]
+| identifier **from** [**package**] package-name [formal-part] |
[**class**] class-name
-(44) field ::=
-identifier {’,’ identifier} ’:’ data-type
+(44) field ::= identifier {’,’ identifier} ’:’ data-type
[’[’integer {’,’ integer}’]’]
[**is protected**]’;’
-45) redefinition-of-field ::=
-[field-name] **from**** **[**class**] class-name
+45) redefinition-of-field ::= [field-name] **from** [**class**] class-name
-(46) declaration-of-fields ::=
-**fields**** **[**redefined**** **redefinition-of-field {’,’
-redefinition-of-field}’;’]
+(46) declaration-of-fields ::= **fields** [**redefined** redefinition-of-field {’,’ redefinition-of-field}’;’]
field {field}
-(47) declaration-of-an-alias::=
-[**private**] **alias**** **class-name1 **is**** **class-name2 [**from**
-package-name]
+(47) declaration-of-an-alias::= [**private**] **alias** class-name1 **is** class-name2 [**from** package-name]
-(48) declaration-of-friends ::=
-**friends**** **friend {’,’ friend}
+(48) declaration-of-friends ::= **friends** friend {’,’ friend}
-(49) class-definition ::=
-[{member-method}]
+(49) class-definition ::= [{member-method}]
[declaration-of-fields]
[declaration-of-friends]
-(50) declaration-of-an-exception ::=
-**exception**** **exception-name
-**inherits**** **exception-name
+(50) declaration-of-an-exception ::= **exception** exception-name **inherits** exception-name
-(51) declaration-of-an-enumeration ::=
-**enumeration**** **enumeration-name
-**is**** **identifier {’,’ identifier}
-[**end**** **[enumeration-name]]’;’
+(51) declaration-of-an-enumeration ::= **enumeration** enumeration-name
+**is** identifier {’,’ identifier}
+[**end** [enumeration-name]]’;’
(52) incomplete-declaration-of-a-non-generic-class ::=
-[**deferred**] **class**** **class-name’;’
+[**deferred**] **class** class-name’;’
(53) incomplete-declaration-of-a-generic-class ::=
-[**deferred**] **generic class**** **class-name {’,’ class-name}’;’
+[**deferred**] **generic class** class-name {’,’ class-name}’;’
(54) declaration-of-a-non-generic-class ::=
-[**deferred**] **class**** **class-name
-[**inherits**** **class-name
-[**uses**** **data-type {’,’ data-type}]
-[**raises**** **exception-name {’,’ exception-name}]
-** is **definition-of-a-class
-**end **[class-name]’;’
+[**deferred**] **class** class-name
+[**inherits** class-name
+[**uses** data-type {’,’ data-type}]
+[**raises** exception-name {’,’ exception-name}]
+**is** definition-of-a-class
+**end** [class-name]’;’
-(55) type-constraint ::=
-**any**** **| class-name [’(’data-type {’,’ data-type}’)’]
+(55) type-constraint ::= **any** | class-name [’(’data-type {’,’ data-type}’)’]
-(56) generic-type ::=
-identifier **as**** **type-constraint
-@section occt_1819379591_2139552861 Appendix B.
+(56) generic-type ::= identifier **as** type-constraint
+
+(57) declaration-of-a-generic-class ::=
+[**deferred**] **generic class** class-name ’(’generic-type
+{’,’ generic-type}’)’
+[**inherits** class-name
+[**uses** data-type {’,’ data-type}]
+[**raises** exception-name {’,’ exception-name}]
+[{[visibility] declaration-of-a-class}]
+**is** class-definition
+**end** [class-name]’;’
+
+(58) instantiation-of-a-generic-class::=
+[**deferred**] **class** class-name
+**instantiates** class-name ’(’data-type
+{’,’ data-type}’);’
+
+(59) declaration-of-a-class::=
+incomplete-declaration-of-a-non-generic-class
+|
+incomplete-declaration-of-a-generic-class |
+declaration-of-a-non-generic-class |
+declaration-of-a-generic-class |
+instantiation-of-a-generic-class
+
+(60) type-declaration ::=
+[private] declaration-of-an-enumeration | [**private**] class-declaration | declaration-of-an-exception
+
+(61) package-definition ::=
+[{type-declaration}]
+[{package-method}]
+
+(62) package-declaration ::= **package** package-name
+[**uses** package-name {’,’ package-name}]
+ **is** package-definition
+**end** [package-name]’;’
+
+(63) executable-declaration ::=
+ **executable** executable-name
+ **is**
+ {
+ **executable** executable-part
+[**uses** [identifier **as external**]
+ [{’,’ identifier **as external**}]
+ [unit-name **as library**]
+ [{’,’ unit-name **as library**}]
+ **is**
+ {file-name [as C++|c|fortran|object];}
+ **end** ’;’
+ }
+ **end** ’;’
+
+(64) schema-declaration ::=
+ **schema** schema-name
+ **is**
+[{**package** package-name ’;’ }]
+[{**class** class-name ’;’ }]
+**end** ’;’
-@subsection occt_1819379591_213955286151 Comparison of CDL & C++ Syntax for Data Types manipulated by Handle and by Value
- @image html /dev_guides/cdl/images/cdl_image012.png
- @image latex /dev_guides/cdl/images/cdl_image012.png
-
\ No newline at end of file
+
+@section occt_cdl_6 Appendix B Comparison of CDL and C++
+
+## Syntax for Data Types manipulated by Handle and by Value in CDL
+
+| | Handle | Value |
+| :---- | :---- | :---- |
+| Permanent | Persistent | Storable |
+| Temporary | Transient | Any |
+| Reading | Immutable | In |
+| Writing | Mutable | Out |
+| Read/Write | Mutable | In out |
+| Return | Not specified : any | Without copy: --C++ return const& |
+
+## Syntax for Data Types manipulated by Handle and by Value in C++
+
+| | Handle | Value |
+| :---- | :---- | :--- |
+| C++ Declaration | Handle(PGeom_Point) p1; | gp_Pnt p2; |
+| C++ Constructor | p1 = newPGeom_Point(p2); | p2(0.,0.,0.); |
+| C++ Method | x=p1 -> XCoord(); | x=p2.XCoord(); |
+
+
+
+
\ No newline at end of file
diff --git a/dox/dev_guides/contribution_workflow/contribution_workflow.md b/dox/dev_guides/contribution_workflow/contribution_workflow.md
new file mode 100644
index 0000000000..8db8e35c85
--- /dev/null
+++ b/dox/dev_guides/contribution_workflow/contribution_workflow.md
@@ -0,0 +1,283 @@
+Contribution Workflow {#dev_guides_contribution_workflow}
+====================================
+@tableofcontents
+
+@section occt_contribution_workflow_1 Introduction
+
+The purpose of this document is to describe standard workflow for processing contributions to certified version of OCCT.
+
+@subsection occt_contribution_workflow_1_1 Use of issue tracker system
+
+Each contribution should have corresponding issue (bug, or feature, or integration request)
+registered in the MantisBT issue tracker system accessible by URL
+http://tracker.dev.opencascade.org.
+The issue is processed further according to the described workflow.
+
+@subsection occt_contribution_workflow_1_2 Access Levels
+
+ Access level defines the permissions of the user to view,
+ register and modify issues in a Mantis bugtracker.
+ The correspondence of access level and user permissions
+ is defined in accordance with the table below.
+
+| Access level | Granted to | Permissions | Can set statuses |
+|:------------- | :--------- | :-------------- | :----------------------- |
+| Viewer | Everyone (anonymous access) | View public issues only | No |
+| Reporter | Users registered on dev.opencascade.com | View, report, and comment issues | New, Resolved |
+| Updater | Users of dev.opencascade.com in publicly visible projects | View and comment issues | New, Resolved |
+| Developer | OCC developers and external contributors who signed the CLA | View, report, modify, and handle issues | New, Assigned, Resolved, Reviewed |
+| Tester | OCC engineer devoted to certification testing | View, report, modify, and handle issues | Assigned, Tested |
+| Manager | Person responsible for a project or OCCT component | View, report, modify, and handle issues | New, Resolved, Reviewed, Tested, Closed |
+
+According to his access level, the user can participate in the issue handling process under different roles, as described below.
+
+@section occt_contribution_workflow_2 Typical workflow for an issue
+
+@subsection occt_contribution_workflow_2_1 General scheme
+
+@image html OCCT_ContributionWorkflow_V3_image001.png "Standard life cycle of an issue"
+@image latex OCCT_ContributionWorkflow_V3_image001.png "Standard life cycle of an issue"
+
+@subsection occt_contribution_workflow_2_2 Issue registration
+
+An issue is registered in Mantis bugtracker by the Reporter with definition of the necessary attributes.
+The definition of the following attributes is obligatory:
+
+ * **Category** - indicates component of OCCT to which the issue relates. If in doubt, assign OCCT:Foundation Classes.
+ * **Reproducibility**
+ * **Severity**
+ * **Priority**
+ * **Profile** - allows defining the platform on which the problem was detected from the list of predefined platforms. If a platform is absent in the list of predefined platforms it is possible to use Or Fill In option to define the platform manually.
+ * **Platform**
+ * **OS**
+ * **OS Version**
+ * **Products Version** - defines the version of Open CASCADE on which the problem has been detected.
+ * **Summary** - a short, one sentence description of the issue. It has a limit of 128 characters. It should be informative and useful for the developers. It is advisable to avoid vague or misleading phrases, such as "it doesn't work" or "it crashed". It is not allowed to mention the issue originator, and in particular the customer, in the name of the registered issue.
+ * **Description** - should contain a detailed definition of the nature of the registered issue depending on its type. For a bug it is required to submit a detailed description of the incorrect behavior, including the indication of the cause of the problem (if possible at this stage) or any inputs from the originator. For a feature or integration request it is recommended to describe the proposed feature in details (as possible at that stage), including the changes required for its implementation and the main features of the new functionality. Filling the bug description is obligatory.
+ * **Steps To Reproduce** - in this field it is possible to describe in detail how to reproduce the issue. This field considerably helps to find the cause of the problem, to eliminate it and to create the test case.
+ * *Upload File* field allows attaching the shapes, scripts or modified source files of OCCT. It is recommended to attach a prototype test case in form of a Tcl script for DRAW, using either existing DRAW commands, or a C++ code which can be organized in DRAW commands, as well as sample shapes or other input data (if applicable), immediately after the issue registration.
+
+ The newly registered issue gets status **NEW** and is assigned to the developer responsible for the OCCT component indicated in the Category field (Maintainer).
+
+@subsection occt_contribution_workflow_2_3 Assigning the issue
+
+ The description of the new issue is checked by the **Maintainer** and if it is feasible,
+ he may assign the issue to a **Developer**. Alternatively, any user with **Developer** access level
+ or higher can assign the issue to himself if he wants to provide a solution.
+
+ The recommended way to handle contributions is that the **Reporter** assigns the issue to himself and provides a solution.
+
+ The **Maintainer, Technical Project Manager,** or **Bugmaster** can close or reassign the issue
+ (in **FEEDBACK** state) to the **Reporter** after it has been registered, if its description does not contain sufficient details to reproduce the bug or explain the purpose of the new feature.
+ That decision shall be documented in the comments to the issue in the Bugtracker.
+
+ The assigned issue should have state **ASSIGNED**.
+
+@subsection occt_contribution_workflow_2_4 Resolving the issue
+
+ The **Developer** responsible for the issue assigned to him provides a solution
+ as a change on the version of OCCT indicated in the issue attributes, or the last development version.
+
+ The modified sources should be submitted for review and testing to the dedicated branch of the official OCCT Git repository:
+
+ * Branch should be created for the issue with name composed of letters ‘CR’ followed by issue ID number (without leading zeroes).
+ Optional suffix can be added to the branch name after issue ID,
+ e.g. to distinguish between several version of the fix.
+ * The branch should be based on recent version of the master branch
+ (not later than commit tagged as last OCCT release).
+ * The first line of the first commit message should contain
+ the Summary of the issue (starting with its ID followed by colon, e.g. "0022943: Bug TDataXtd_PatternStd").
+ The consequent lines should contain a description of the changes made.
+ If more than one commit has been made, the commit messages should contain description of the changes made.
+ * The amount of the code affected by the change should be limited
+ to only the changes required for the bug fix or improvement.
+ Change of layout or re-formatting of the existing code is allowed
+ only in the parts where meaningful changes related to the issue have been made.
+ * The name of the branch where the fix is submitted should be given
+ in the note to the Mantis issue
+ (providing the direct link to relevant branch view in GitWeb is encouraged).
+ * The description of the changes made should be put to the field
+ "Additional information and documentation updates" of the Mantis issue.
+
+ In some cases (if Git is not accessible for the contributor),
+ external contributions can be submitted as patch (diff) files or sources
+ attached to the Mantis issue, with indication of OCCT version on which the fix is made.
+ Such contributions should be put to Git for processing by someone else,
+ and hence they have less priority in processing than the ones submitted directly through Git.
+
+ The issue for which solution is provided should be switched to **RESOLVED** state
+ and assigned to the developer who is expected to make a code review
+ (the **Reviewer**; by default, can be set to the **Maintainer** of the component).
+
+@subsection occt_contribution_workflow_2_5 Code review
+
+ The **Reviewer** analyzes the proposed solution for applicability in accordance with OCCT Code reviewing rules and examines all changes in the sources to detect obvious and possible errors, misprints, conformity to coding style.
+
+ * If Reviewer detects some problems, he can either:
+ * Fix these issues and provide new solution, reassigning the issue (in **RESOLVED** state) to the **Developer**, who then becomes a **Reviewer**.
+ Possible disagreements should be resolved through discussion, which is done normally within issue notes (or on the OCCT developer’s forum if necessary).
+ * Reassign the issue back to the **Developer**, providing detailed list of remarks. The issue then gets status **ASSIGNED** and a new solution should be provided.
+ * If Reviewer does not detect any problems, he changes status to **REVIEWED**.
+
+@subsection occt_contribution_workflow_2_6 Testing
+
+ The issues that are in **REVIEWED** state are subject of certification (non-regression) testing.
+ The issue is assigned to OCC **Tester** when he starts processing it.
+ The results of tests are checked by the **Tester**:
+ * If the **Tester** detects build problems or regressions, he changes the status to **ASSIGNED** and reassigns the issue to the **Developer** with a detailed description of the problem. The **Developer** should produce a new solution.
+ * If the **Tester** does not detect build problems or regressions, he changes the status to **TESTED** for further integration.
+
+@subsection occt_contribution_workflow_2_7 Integration of a solution
+
+ Before integration into the master branch of the repository the **Integrator** checks the following conditions:
+ * the change has been reviewed;
+ * the change has been tested without regressions (or with regressions treated properly);
+ * the test case has been created for this issue (when applicable), and the change has been rechecked on this test case;
+ * "Additional information and documentation updates" field is filled by the developer;
+ * the change does not conflict with other changes integrated previously.
+
+ If the result of check is successful the Integrator integrates solution
+ into the master branch of the repository. Each change is integrated into the master branch
+ as a single commit without preserving the history of changes made in the branch
+ (by rebase, squashing all intermediate commits), however, preserving the author when possible.
+ This is done to have the master branch history plain and clean.
+ The following picture illustrates the process:
+
+@image html OCCT_ContributionWorkflow_V3_image002.jpg "Integration of several branches"
+@image latex OCCT_ContributionWorkflow_V3_image002.jpg "Integration of several branches"
+
+ The new master branch is tested against possible regressions that might appear due to interference between separate changes. When the tests are Ok, the new master is pushed to the official repository
+ and the original branches are removed from it.
+ The issue status is set then to **VERIFIED** and is assigned to the **Reporter** so that he could check the fix as-integrated.
+
+@subsection occt_contribution_workflow_2_8 Closing a bug
+
+ The **Bugmaster** closes the issue after regular OCCT Release provided that the issue status is **VERIFIED** and that issue was really solved in that release, by rechecking the corresponding test case. The final issue state is **CLOSED**.
+
+@subsection occt_contribution_workflow_2_9 Reopening a bug
+
+ If a regression is detected, the **Bugmaster** may reopen and reassign the **CLOSED** issue to the appropriate developer with comprehensive comments about the reason of reopening. The issue then becomes **ASSIGNED** again.
+
+@section occt_contribution_workflow_3 Appendix
+
+@subsection occt_contribution_workflow_3_1 Issue attributes
+
+@subsubsection occt_contribution_workflow_3_1_1 Severity
+
+ Severity shows at which extent the issue affects the product.
+ The list of used severities is given in the table below in the descending order.
+
+ | Severity | Description | Weight for Bug Score |
+ | :---------- | :------------------------------------------------ | :------------------: |
+ | crash | Crash of the application or OS, loss of data | 5 |
+ | block | Regression corresponding to the previously delivered official version. Impossible operation of a function on any data with no work-around. Missing function previously requested in software requirements specification. Destroyed data. | 4 |
+ | major | Impossible operation of a function with existing work-around. Incorrect operation of a function on a particular dataset. Impossible operation of a function after intentional input of incorrect data. Incorrect behavior of a function after intentional input of incorrect data. | 3 |
+ | minor | Incorrect behavior of a function corresponding to the description in software requirements specification. Insufficient performance of a function. | 2 |
+ | tweak | Ergonomic inconvenience, need of light updates. | 1 |
+ | text | Inconsistence of program code to the Coding Standard. Errors in source text (e.g. unnecessary variable declarations, missing comments, grammatical errors in user manuals). | 1 |
+ | trivial | Cosmetic bugs. | 1 |
+ | feature | Bug fix, new feature, improvement that requires workload estimation and validation. | 1 |
+ | integration request | Requested integration of an existing feature into the product. | 0 |
+ | Just a question | A question to be processed, without need of any changes in the product. | 0 |
+
+@subsubsection occt_contribution_workflow_3_1_2 Statuses of issues
+
+ The bug statuses that can be applied to the issues are listed in the table below.
+
+ | Status | Description |
+ | :------------------- | :----------------------------------------- |
+ | New | New just registered issue. Testing case should be created by Reporter. |
+ | Feedback | The issue requires more information; the original posters should pay attention. |
+ | Assigned | Assigned to a developer. |
+ | Resolved + a resolution | The issue has been fixed, and now is waiting for revision. |
+ |Revised + a resolution | The issue has been revised, and now is waiting for testing. |
+ | Tested | The fix has been internally tested by the tester with success on the full non-regression database or its part and a test case has been created for this issue. |
+ | Verified | The fix has been integrated into the master of the corresponding repository |
+ | Closed | The fix has been integrated to the master. The corresponding test case has been executed successfully. The issue is no longer reproduced. |
+
+@subsubsection occt_contribution_workflow_3_1_3 Resolutions
+
+ **Resolution** is set when the bug is resolved. "Reopen" resolution is added automatically when the bug is reopened.
+
+ | Resolution | Description |
+ |:--------------------- | :--------------------------------------------------------------------------- |
+ | Open | The issue is being processed. |
+ | Fixed | The issue has been successfully fixed. |
+ | Reopened | The bug has been reopened because of insufficient fix or regression. |
+ | | Unable to reproduceThe bug is not reproduced. |
+ | Not fixable | The bug cannot be fixed because it is a bug of third party software, or because it requires more workload than it can be allowed. |
+ | Duplicate | The bug for the same issue already exists in the tracker. |
+ | Not a bug | It is a normal behavior in accordance with the specification of the product |
+ | No change required | The issue didn’t require any change of the product, such as a question issue |
+ | Suspended | This resolution is set for Acknowledged status only. It means that the issue is waiting for fix until a special administrative decision is taken (e.g. a budget is not yet set in accordance with the contract) |
+ | Documentation updated | The issue was a normal behavior of the product, but the actions of the user were wrong. The specification and the user manual have been updated to reflect this issue. |
+ | Won’t fix | An administrative/contractual decision has been taken to not fix the bug |
+
+@subsection occt_contribution_workflow_3_2 Update and evolution of documentation
+
+ The documentation on Open CASCADE Technology currently exists in three forms:
+
+ * OCCT Technical Documentation generated automatically with Doxygen tool on the basis of comments in CDL or HXX files.
+ * User’s Reference Documentation on OCCT packages and Products supplied in the form of PDF User’s guides
+ * OCCT Release Documentation supplied in the form of Release Notes with each release.
+
+ It is strictly required to properly report the improvements and changes introduced in OCCT in all three forms of Documentation.
+
+@subsubsection occt_contribution_workflow_3_2_1 Maintenance of CDL files
+
+ Every developer providing a contribution to the source code of OCC
+ should make a relevant change in the corresponding header file, including CDL.
+
+ Making the appropriate comments is mandatory in the following cases:
+
+ * Development of a new package / class / method / enumeration;
+ * Modification of an existing package / class / method / enumeration that changes its behavior;
+ * Modification / new development impacts at other packages / classes / methods / enumerations, the documentation which of should be modified correspondingly.
+
+ The only case when the comments may be not required is introducing
+ a modification that does not change the existing behavior in any noticeable way
+ or brings the behavior in accordance with the existing description.
+
+ CDL description must be in good English, containing as much relevant
+ information and as clear as possible. If the developer is unable to properly formulate
+ his ideas in English or suspects that his description can be misunderstood,
+ he should address to the Documentation Engineer for language assistance.
+ Such action is completely subject to the discretion of the developer; however,
+ the Documentation Engineer can require that the developer should provide a relevant
+ technical documentation and reopen a bug until all documentation satisfies the requirements above.
+
+@subsubsection occt_contribution_workflow_3_2_2 Maintenance of the User’s Reference Documentation
+
+ The User’s Reference Documentation is distributed among a number of User’s Guides,
+ each describing a certain module of OCCT.
+ The User's Guides do not cover the entire functionality of OCCT;
+ however, they describe most widely used and important packages.
+
+ In most aspects the User's Guides present the information that is contained in CDL descriptions for methods, classes, etc., only from a different point of view. Thus, it is required that any developer who implements a new or modifies an existing package / class / method / enumeration and adds a description of new development or changes in the corresponding CDL file should also check if this class package / class / method / enumeration or the package / class, to which the added class / method belongs is already described in the documentation and update the User’s Reference Documentation correspondingly.
+
+3.2.3. Preparation of the Release Documentation
+
+ Before changing the bug Status to RESOLVED, the developer should provide a description of the implemented work using the "Additional information and documentation updates" field of Mantis bugtracker.
+
+ This description is used for the Release Documentation and has the following purposes:
+
+ * to inform the OCCT users about the main features and improvements implemented in the platform in the release;
+ * to give a complete and useable list of changes introduced into the OCCT since the latest version.
+
+ The changes should be described from the user’s viewpoint so that the text
+ could be comprehensible even for beginners having a very vague idea about OCCT.
+ If the developer is unable to properly formulate his ideas in English or suspects
+ that his description can be misunderstood, he should address to the Documentation Engineer
+ for language assistance. Such action is completely subject to the discretion of the developer;
+ however, the Documentation Engineer can require that the developer
+ should provide a relevant technical documentation and reopen a bug
+ until all documentation satisfies the requirements.
+
+ **Note**, that it is required to single out the changes in the OCCT behavior as compared to the previous versions and especially the changes to be considered when porting from the previous version of OCCT.
+
+For example:
+* If global macros XXX() was used in the code of your application, revise it for direct use of the argument stream object.
+* You might need to revise the code related to text display in 3d viewer to take into account new approach of using system fonts via XXX library.
+
+ The **Documentation Engineer** is responsible for preparation of the version Release Notes
+ and update of the User’s Guides. If the **Documentation Engineer** considers that the description currently provided by the **Developer** is somehow inadequate or unsatisfactory he can demand the **Developer** to rewrite the documentation with the **Documentation Engineer’s** assistance.
diff --git a/dox/dev_guides/contribution_workflow/images/OCCT_ContributionWorkflow_V3_image001.png b/dox/dev_guides/contribution_workflow/images/OCCT_ContributionWorkflow_V3_image001.png
new file mode 100644
index 0000000000..110b38a6b3
Binary files /dev/null and b/dox/dev_guides/contribution_workflow/images/OCCT_ContributionWorkflow_V3_image001.png differ
diff --git a/dox/dev_guides/contribution_workflow/images/OCCT_ContributionWorkflow_V3_image002.jpg b/dox/dev_guides/contribution_workflow/images/OCCT_ContributionWorkflow_V3_image002.jpg
new file mode 100644
index 0000000000..c362ec4614
Binary files /dev/null and b/dox/dev_guides/contribution_workflow/images/OCCT_ContributionWorkflow_V3_image002.jpg differ
diff --git a/dox/dev_guides/dev_guides.md b/dox/dev_guides/dev_guides.md
index ec7b3ae9b6..327cc39f46 100644
--- a/dox/dev_guides/dev_guides.md
+++ b/dox/dev_guides/dev_guides.md
@@ -8,7 +8,7 @@ The following documents provide information on OCCT building, development and te
* @subpage dev_guides__coding_rules "Coding Rules"
* Contribution Workflow
* Guide to installing and using Git for OCCT development
-* @subpage dev_guides__tests "Automatic Testing system"
+ @subpage dev_guides__tests "Automatic Testing system"
Two other documents provide details on obsolete technologies used by OCCT,
to be removed in future releases:
diff --git a/dox/dev_guides/git_guide/git_guide.md b/dox/dev_guides/git_guide/git_guide.md
new file mode 100644
index 0000000000..1daf4f1cdc
--- /dev/null
+++ b/dox/dev_guides/git_guide/git_guide.md
@@ -0,0 +1,602 @@
+Guide to installing and using Git for OCCT development {#dev_guides_git_guide}
+=================================
+
+@tableofcontents
+
+@section occt_gitguide_1 Overview
+
+@subsection occt_gitguide_1_1 Purpose
+
+ The purpose of this document is to provide a practical introduction to Git
+ to OCCT developers who are not familiar with this tool
+ and to facilitate the use of the official OCCT Git repository for code contribution to OCCT.
+
+ Reading this document does not exempt from the need to learn Git concepts and tools.
+ Please consult a book or manual describing Git to get acquainted with this tool.
+ Many good books on Git can be found at http://git-scm.com/documentation
+
+ For the experienced Git users it can be enough to read sections 1 and 3
+ of this document to start working with the repository.
+
+ Please make sure to get familiar with the Contribution Workflow document
+ that describes how Git is used for processing contributions to OCCT.
+
+ This and related documents are available at the Resources page
+ of the OCCT development portal at http://dev.opencascade.org/index.php?q=home/resources.
+
+@subsection occt_gitguide_1_2 Git URL
+
+ URL of the official OCCT source code Git repository (accessed by SSH protocol) is:
+
+ gitolite@git.dev.opencascade.org:occt
+
+ or
+
+ ssh://gitolite@git.opencascade.org/occt.git
+
+@subsection occt_gitguide_1_3 Content
+
+The official repository contains:
+
+ * The current certified version of OCCT: the "master" branch. This branch is updated by the Bugmaster only. Official OCCT releases are marked by tags.
+ * Topic branches created by contributors to submit changes for review / testing or for collaborative development. The topic branches should be named by the pattern "CR12345" where 12345 is the ID of the relevant issue registered in Mantis (without leading zeroes), and "CR" stands for "Change Request". The name can have an additional postfix used if more than one branch was created for the same issue.
+ * Occasionally topic branches with non-standard names can be created by the Bugmaster for special needs.
+
+@subsection occt_gitguide_1_4 Short rules of use
+
+ The name specified in the user.name field in Git configuration should correspond
+ to your login name on the OCCT development portal.
+ This is important to clearly identify the authorship of commits.
+ (The full real name can be used as well; in this case add the login username in parentheses.)
+
+ By default, contributors are allowed to push branches only with the names starting with CR
+ (followed by the relevant Mantis issue ID).
+ Possibility to work with other branches can be enabled by the Bugmaster on request.
+
+ The branch is created by the developer in his local repository when the development of a contribution starts.
+ The branch for new developments is to be created from the current master.
+ The branch for integration of patches or developments based on an obsolete version
+ is created from a relevant tag or commit. The branch should be pushed to the official repo
+ only when sharing with other people (for collaborative work or review / testing) is needed.
+
+ Rebasing the local branch to the current master is encouraged before the first submission
+ to the official repository. If rebasing was needed after the branch is pushed to the official repo,
+ the rebased branch should have a different name (use suffix).
+
+ Integration of contributions that have passed certification testing is made exclusively by the Bugmaster.
+ Normally this is made by rebasing the contribution branch on the current master
+ and squashing it into a single commit. This is made to have the master branch history plain and clean,
+ following the general rule “one issue – one commit”.
+ The description of the commit integrated to the master branch is taken from the Mantis issue
+ (ID, 'Summary', followed by the information from 'Documentation' field if present).
+
+ In special cases when it is important to save the commits history in the branch
+ (e.g. in case of a long-term development integration) it can be integrated by merge (no fast-forward).
+
+ The authorship of the contribution is respected by preserving the Author field of the commit when integrating.
+ Branches are removed from the official repository when integrated to the master.
+ The Bugmaster can also remove branches which have no commits during one-month period.
+
+ The Bugmaster may ask the developer (normally the one who produced the contribution)
+ to rebase a branch on the current master, in the case if merge conflicts appear during integration.
+
+@subsection occt_gitguide_1_5 Version of Git
+
+ The repository is tested to work with Git 1.7.6 to 1.7.9.
+ Please do not use versions below 1.7.1 as they are known to cause troubles.
+
+@section occt_gitguide_2 Installing Tools for Work with Git
+
+@subsection occt_gitguide_2_1 Windows platform
+
+ Installation of Git for Windows (provided by MSysGit project) is required.
+
+ In addition, it is recommended to install TortoiseGit to work with Git on Windows.
+ If you do not install TortoiseGit or any other GUI tool,
+ you can use GitGui and Gitk GUI tools delivered with Git and available on all platforms.
+
+@subsubsection occt_gitguide_2_1_1 Installation of Git for Windows
+
+ Download Git for Windows distributive from http://code.google.com/p/msysgit/downloads/list.
+ During the installation:
+
+ * Select Windows Explorer integration options:
+ * Git Bash Here
+ * Git GUI Here
+
+@image html OCCT_GitGuide_V2_image001.png
+@image latex OCCT_GitGuide_V2_image001.png
+
+ * To avoid a mess in your PATH, we recommend selecting ‘Run Git from Windows Prompt’ in the environment settings dialog:
+
+@image html OCCT_GitGuide_V2_image002.png
+@image latex OCCT_GitGuide_V2_image002.png
+
+ * In "Configuring the line ending conversions" dialog, select "Checkout Windows-style, commit Unix style endings".
+
+@image html OCCT_GitGuide_V2_image003.png
+@image latex OCCT_GitGuide_V2_image003.png
+
+ Note that by default Git user interface is localized to the system default language.
+ If you prefer to work with the English interface, remove or rename .msg localization file
+ in subdirectories *share/git-gui/lib/msgs* and *share/gitk/lib/msgs* of the Git installation directory.
+
+ Before the first commit to the OCCT repository, make sure that your User Name in the Git configuration file (file *.gitconfig* in the $HOME directory) is equal to your username on the OCCT development portal.
+
+@subsubsection occt_gitguide_2_1_2 Installation and configuration of TortoiseGit
+
+ Download TortoiseGit distributive from http://code.google.com/p/tortoisegit/downloads/list.
+ Launch the installation.
+
+ * Select your SSH client. Choose OpenSSH if you prefer to use command-line tools
+ for SSH keys generation, or TortoisePLink if you prefer to use GUI tool (PuttyGen, see 3.2):
+
+@image html OCCT_GitGuide_V2_image004.png
+@image latex OCCT_GitGuide_V2_image004.png
+
+ * Complete the installation.
+
+@image html OCCT_GitGuide_V2_image005.png
+@image latex OCCT_GitGuide_V2_image005.png
+
+ TortoiseGit integrates to Windows Explorer, thus it is possible to use popup menu in Windows Explorer to access its functionality:
+
+ Note that if you have installed MSysGit or have Git installed in non-default path,
+ on the first time you use TortoiseGit you may get the message demanding to define path to Git.
+ In such case, click on **Set MSysGit path** button and add the path to git.exe
+ and path to MigGW libraries in the Settings dialog.
+
+ * After the installation select Start -> Programs -> TortoiseGit Settings to configure TortoiseGit.
+
+ Select Git->Config to add your user name and Email address to the local .gitconfig file
+
+ @image html OCCT_GitGuide_V2_image006.png
+ @image latex OCCT_GitGuide_V2_image006.png
+
+@subsection occt_gitguide_2_2 Linux platform
+
+ We assume that Linux users have Git already installed and available in the PATH.
+
+ Make sure to configure Git so that the user name is equal to your username
+ on the OCCT development portal, and set SafeCrLf option to true:
+
+~~~~~
+ > git config --global user.name "Your User Name"
+ > git config --global user.email your@mail.address
+ > git config --global your@mail.address
+~~~~~
+
+@section occt_gitguide_3 Getting access to the repository
+
+@subsection occt_gitguide_3_1 Prerequisites
+
+ Access to the repository is granted to the users who have signed the Contributor License Agreement.
+
+ The repository is accessed by SSH protocol, thus you need to register your public SSH key
+ on the development portal to get access to the repository.
+
+ SSH keys are used for secure authentication of the user when accessing the Git server.
+ Private key is the one stored on the user workstation (optionally encrypted).
+ Open (or public) key is stored in the user account page on the web site.
+ When Git client accesses the remote repository through SSH,
+ it uses this key pair to identify the user and acquire relevant access rights.
+
+ Normally when you have Git installed, you should have also SSH client available.
+ On Unix/Linux it is installed by default in the system.
+ On Windows it is typical to have several SSH clients installed;
+ in particular they are included with Cygwin, Git, TortoiseGit.
+
+ It is highly recommended to use the tools that come
+ with the chosen Git client for generation of SSH keys.
+ Using incompatible tools (e.g. ssh-keygen.exe from Cygwin for code generation,
+ and TortoiseGit GUI with a default Putty client for connection to server)
+ may lead to authentication problems.
+
+@subsection occt_gitguide_3_2 How to generate a key
+
+@subsubsection occt_gitguide_3_2_1 Generating key with Putty
+
+ Use this option if you have installed TortoiseGit (or other GUI Git client on Windows)
+ and have chosen “TortoisePLink” (or other Putty client) as SSH client during installation.
+
+ To generate the key with this client, run Puttygen (e.g. from Start menu -> TortoiseGit -> Puttygen),
+ then click Generate and move mouse cursor over the blank area until the key is generated.
+
+@image html OCCT_GitGuide_V2_image007.png "Putty key generator"
+@image latex OCCT_GitGuide_V2_image007.png "Putty key generator"
+
+ After the key is generated, you will see GUI controls to define the public key comment
+ and / or specify the password for the private key protection.
+ When done, save both the public and the private key to the files of your choice
+ (make sure to store your private key in a secure place!).
+
+ Copy the public key as shown by Puttygen to the clipboard to add it in your account.
+ Do not copy the Putty public key file content -- it is formatted in a way not suitable for the web site.
+
+@subsubsection occt_gitguide_3_2_2 Generating key with command-line tools
+
+ Use this option if you work on Linux or if you have chosen “OpenSSH” as SSH client
+ during installation of TortoiseGit (or other Windows tool).
+
+ Make sure that you have *ssh* and *ssh-keygen* commands in the path.
+ On Windows, you might need to start 'Git Bash' command prompt window provided by Git for Windows.
+
+ Use the following command to generate SSH keys:
+~~~~~
+ > ssh-keygen -t rsa -C "your@mail.address"
+~~~~~
+
+ The last argument is an optional comment, which can be included with the public key and used to distinguish between different keys (if you have many). The common practice is to put here your mail address or workstation name.
+
+ The command will ask you where to store the keys. It is recommended to accept the default path *$HOME/.ssh/id_rsa*. Just press Enter for that. You will be warned if a key is already present in the specified file; you can either overwrite it by the new one, or stop generation and use the old key.
+
+ If you want to be on the safe side, enter password to encrypt the private key. You will be asked to enter this password each time you use that key (e.g. access a remote Git repository), unless you use the tool that caches the key (like TortoiseGit). If you do not want to bother, enter an empty string.
+
+ On Windows, make sure to note the complete path to the generated files (the location of your $HOME might be not obvious). Two key files will be created in the specified location (by default in $HOME/.ssh/):
+
+ * *id_rsa* - private key
+ * id_rsa.pub - public key
+
+ The content of the public key file (one text line) is the key to be added to the user account on the site (see below).
+
+@subsubsection occt_gitguide_3_2_3 Generating key with Git GUI
+
+ GitGUI (standard GUI interface included with Git) provides the option
+ to either generate the SSH key (if not present yet) or show the existing one.
+ Click Help/Show SSH key and copy the public key content for adding to the user account page (see below).
+
+@subsection occt_gitguide_3_3 Adding public key in your account
+
+ Log in on the portal http://dev.opencascade.org and click on 'My account' link to the right.
+ If you have a Contributor status, you will see 'SSH keys' tab to the right.
+ Click on that tab, then click 'Add a public key', and paste the text of the public key
+ (see above sections on how to generate the key) into the text box.
+ Click "Save" to input the key to the system.
+
+ Note that a user can have several SSH keys.
+ You can distinguish between these keys by the Title field ID; by default it is taken from SSH key comment.
+ It is typical to use your e-mail address or workstation name for this field; no restrictions are set by the portal.
+
+@image html OCCT_GitGuide_V2_image008.png
+@image latex OCCT_GitGuide_V2_image008.png
+
+ Please note that some time (5-10 min) is needed for the system
+ to update the configuration after the new key is added.
+ After that time, you can try accessing Git.
+
+@section occt_gitguide_4 WORK WITH REPOSITORY: DEVELOPER OPERATIONS
+
+@subsection occt_gitguide_4_1 General workflow
+
+ To start working with OCCT source repository, you need to create its clone in your local system.
+ This cloned repository will manage your working copy of the sources
+ and provide you the means to exchange code between your clone and the origin.
+
+ In most cases it is sufficient to have one clone of the repository;
+ your working copy will be updated automatically by Git when you switch branches.
+
+ The typical development cycle for an issue is as follows:
+
+ * Create a new branch for your development, basing on the selected version of the sources
+ (usually the current master) and switch your working copy to it
+ * Develop and test your change. Note that for the first time, and after any changes
+ made in CDL files you will have to re-generate build scripts or Visual Studio projects using WOK.
+ * Do as many commits in your branch as you feel convenient;
+ the general recommendation is to commit every stable state (even incomplete), to record the history of your development.
+ * Push your branch to the repository when your development is complete or when you need to share it with other people (e.g. for review)
+ * Before the first push, rebase your local branch on the latest master;
+ consider collapsing the history in one commit unless you think the history of your commits is interesting for others.
+ Make sure to provide a good commit message.
+ * Do not amend the commits that have been already pushed in the remote repository,
+ If you need to rebase your branch, commit the rebased branch under a different name, and remove the old branch.
+
+ You can switch to another branch at any moment
+ (unless you have some uncommitted changes in the working copy)
+ and return back to the branch when necessary (e.g. to take into account review remarks).
+ Note that only the sources that are different between the switched branches will be modified,
+ thus required recompilation should be reasonably small in most cases.
+
+@subsection occt_gitguide_4_2 Cloning official repository
+
+ Clone the official OCCT repository in one of following ways:
+
+ * From command line by command:
+
+~~~~~
+ > git clone gitolite@git.dev.opencascade.org:occt
+~~~~~
+
+ where is the path to the new folder which will be created for the repository.
+
+ * In TortoiseGit: right-click in the Explorer window, then choose "Git Clone":
+
+@image html OCCT_GitGuide_V2_image009.png
+@image latex OCCT_GitGuide_V2_image009.png
+
+ If you have chosen Putty as SSH client during TortoiseGit installation, check the “Load Putty Key” option and specify the location of the private key file saved by PuttyGen (see 3.2.1). This shall be done for the first time only.
+
+ Note that on the first connection to the repository server you may be requested to enter a password for your private SSH key; further you can get a message that the authenticity of the host cannot be established and will be asked if you want to continue connecting or not:
+
+@image html OCCT_GitGuide_V2_image010.png
+@image latex OCCT_GitGuide_V2_image010.png
+
+ Choose “Yes” to continue. Then the host’s key will be stored in $HOME/.ssh/known_hosts file.
+
+@subsection occt_gitguide_4_3 Branch creation
+
+ You need to create a branch when you are going to start development of a new change,
+ apply a patch, etc. It is recommended to fetch updates from the remote repository
+ before this operation, to make sure you work with the up-to-date version.
+
+ Create a branch from the current master branch unless you need to base your development on a particular version or revision.
+
+In the console:
+
+~~~~~
+ > git checkout -b CR12345 origin/master
+~~~~~
+
+In TortoiseGit:
+ * Go to the local copy of the repository.
+ * Right-click in the Explorer window, then choose "Git Create Branch".
+
+@image html OCCT_GitGuide_V2_image011.png
+@image latex OCCT_GitGuide_V2_image011.png
+
+ * Select “Base On” Branch remotes/origin/master
+
+@image html OCCT_GitGuide_V2_image012.png
+@image latex OCCT_GitGuide_V2_image012.png
+
+ Check option ‘Switch to new branch’ if you are going to start working with the newly created branch immediately.
+
+@subsection occt_gitguide_4_4 Branch switching
+
+ If you need to switch to another branch, use Git command checkout for that.
+ In the console:
+
+~~~~~
+ > git checkout CR12345
+~~~~~
+
+ In TortoiseGit: right-click, TortoiseGit -> Checkout/switch
+
+@image html OCCT_GitGuide_V2_image013.png
+@image latex OCCT_GitGuide_V2_image013.png
+
+ Note that in order to work with the branch locally you need to set option
+ “Create new branch” when you checkout the branch from the remote repository for the first time.
+ Option “Track” stores association between the local branch and the original branch in a remote repository.
+
+@subsection occt_gitguide_4_5 Committing branch changes
+
+ Commit your changes locally as soon as a stable status of the work is reached.
+ Make sure to review carefully the committed changes beforehand to avoid unintentional commit of a wrong code.
+
+ * In the console:
+
+~~~~~
+ > git diff
+ …
+ > git commit -a -m "Write meaningful commit message here"
+~~~~~
+
+ Option –a tells the command to automatically include (stage) files
+ that have been modified or deleted, but it will omit the new files that might have been added by you.
+ To commit such new files, you must add (stage) them before commit command.
+
+ To find new unstaged files and them to commit, use commands:
+
+~~~~~
+ > git status -s
+ ?? file1.hxx
+ ?? file2.cxx
+ > git add file1.hxx file2.cxx
+~~~~~
+
+ * In TortoiseGit: right-click, choose “Git Commit -> CR…”:
+
+@image html OCCT_GitGuide_V2_image014.png
+@image latex OCCT_GitGuide_V2_image014.png
+
+ Unstaged files will be shown if you check the option ‘Show Unversioned Files’.
+ Double-clock on each modified file to see the changes to be committed (as a difference vs. the base version).
+
+@subsection occt_gitguide_4_6 Pushing branch to the remote repository
+
+ When the code developed in your local branch is ready for review,
+ or you need to share it with others, push your local changes to the remote repository.
+
+ * In the console:
+
+~~~~~
+ > git push "origin" CR12345:CR12345
+~~~~~
+
+ * In TortoiseGit: right-click, TortoiseGit -> Push
+
+@image html OCCT_GitGuide_V2_image015.png
+@image latex OCCT_GitGuide_V2_image015.png
+
+Note that Git will forbid pushing a branch if the corresponding remote branch already exists and has some changes, which are not in the history of your local branch. This may happen in different situations:
+ * You have amended the last commit which is already in the remote repository.
+ If you are sure that nobody else uses your branch, push again with ‘force’ option.
+ * You have rebased your branch, so that now it is completely different
+ from the branch in the remote repository. In this case, push it under a different name (add a suffix):
+
+@image html OCCT_GitGuide_V2_image016.png
+@image latex OCCT_GitGuide_V2_image016.png
+
+ Then remove the original remote branch so that other people recognize that it has been replaced by the new one. For that, select TortoiseGit -> Push again, then select an empty line for your local branch name,
+ and enter the name of the branch to be removed in ‘Remote’ field:
+
+@image html OCCT_GitGuide_V2_image017.png
+@image latex OCCT_GitGuide_V2_image017.png
+
+ * The other developer has committed some changes in the remote branch.
+ In this case, pull changes from the remote repository to have them merged
+ with your version, and push your branch after it is successfully merged.
+
+@subsection occt_gitguide_4_7 Synchronizing with remote repository
+
+ Maintain your repository synchronized with the remote one and clean unnecessary stuff regularly.
+ Use Git command fetch with option prune to get update of all branches
+ from the remote repository and to clean your local repository from the remote branches that have been deleted.
+
+ * In the console:
+
+~~~~~
+ > git fetch --prune
+~~~~~
+
+ * In TortoiseGit:
+
+@image html OCCT_GitGuide_V2_image018.png
+@image latex OCCT_GitGuide_V2_image018.png
+
+ If some changes have been made to the branch you are working with in the remote repository,
+ use Git command pull to get the remote changes and merge them with your local branch.
+ This operation is required in particular to update your local master branch when the remote master changes.
+
+ * In console:
+~~~~~
+ > git pull
+~~~~~
+ * In TortoiseGit:
+
+@image html OCCT_GitGuide_V2_image019.png
+@image latex OCCT_GitGuide_V2_image019.png
+
+ Note that the local branches of your repository are the primary place
+ where your changes are stored until they get integrated to the official version
+ of OCCT (master branch). The branches submitted to official repository
+ are for collaborative work, review, and integration;
+ that repository should not be used for long-term storage of incomplete changes.
+
+Remove the local branches that you do not need any more. Note that you cannot delete the current branch, thus you need to switch to another one (e.g. master) if the branch you are going to delete is the current one.
+
+ * In the console:
+~~~~~
+ > git branch -d CR12345
+~~~~~
+
+ * In TortoiseGit: right-click, select TortoiseGit -> Show log
+
+@image html OCCT_GitGuide_V2_image020.png
+@image latex OCCT_GitGuide_V2_image020.png
+
+ Select “All branches” to view all branches.
+ Right-click on the branch you want to delete and select Delete… menu item corresponding to this branch.
+
+ Note that the log view in TortoiseGit is a convenient tool
+ to visualize and manage branches; it provides short-cuts to many functions described above.
+
+@subsection occt_gitguide_4_8 Applying a fix made on older version of OCCT
+
+ If you have a fix made on a previous version of OCCT,
+ perform the following sequence of operations to prepare it
+ for testing and integration to the current development version.
+
+ * Identify the version of OCCT on which the fix has been made.
+ In most cases, this will be an OCCT release, e.g. OCCT 6.7.0.;
+ then just find a tag or a commit corresponding to this version in the Git history log of the master branch.
+ * Create a branch basing on this tag or commit. In TortoiseGit history log: right-click on the base commit, then select **Create branch at this version**.
+
+@image html OCCT_GitGuide_V2_image021.png
+@image latex OCCT_GitGuide_V2_image021.png
+
+ Check option **Switch to the new branch** to start working within the new branch immediately, or switch to it separately afterwards.
+
+ * Put your fix in the working copy, build and check that it works, then commit to the branch.
+ * Rebase the branch on the current master.
+
+ In TortoiseGit: right-click on the working directory,
+ then choose TortoiseGit->Rebase; then select *remotes/origin/master* as UpStream revision, and click **Start**:
+
+@image html OCCT_GitGuide_V2_image022.png
+@image latex OCCT_GitGuide_V2_image022.png
+
+ Note that you can get some conflicts during rebase.
+ To resolve the conflicts double-click on each conflicted file
+ (highlighted by red in the file list) to open visual merge tool.
+ Switch between conflicting fragments by red arrows, and for each one
+ decide if the code of one or both conflicting versions is to be taken.
+ Use the toolbar.
+
+@subsection occt_gitguide_4_9 Rebasing with history clean-up
+
+ At some moments you might need to rebase your branch on the latest version of the master.
+
+ We recommend rebasing before the first submission of the branch
+ for review or when the master has diverged substantially from your branch.
+
+ Rebasing is a good occasion to clean-up the history of commits in the branch.
+ Consider collapsing (squashing, in terms of Git) the history of your branch
+ into a single commit unless you deem that having separate commits is important
+ for your future work with the branch or its code reviewing.
+ Git also allows you to change the order of commits, edit commit contents and messages, etc.
+
+ Here is the sequence of actions to rebase your branch into a single commit:
+
+ * Switch to your branch (e.g. “CR12345”)
+ * In TortoiseGit history log, select a branch to rebase on (usually remotes/origin/master)
+ and in the context menu choose **Rebase “CR12345” onto this**.
+ * In the Rebase dialog, check **Squash All**.
+
+@image html OCCT_GitGuide_V2_image023.png
+@image latex OCCT_GitGuide_V2_image023.png
+
+ **Note** that you can also change the order of commits and define for each commit
+ whether it should be kept (“pick”), edited, or just skipped.
+
+ * Click **Start**.
+ * The process will stop if a conflict is detected.
+ In such case, find files with status ‘Conflicted’ in the list (marked by red),
+ and double-click on them to resolve the conflict.
+ When all conflicts are resolved, click ‘Continue’.
+
+@image html OCCT_GitGuide_V2_image024.png
+@image latex OCCT_GitGuide_V2_image024.png
+
+ * At the end of the process, edit the final commit message (it should start from the issue ID and a description from Mantis in the first line, followed by a summary of actual changes), and click **Commit**.
+
+@image html OCCT_GitGuide_V2_image025.png
+@image latex OCCT_GitGuide_V2_image025.png
+
+@section occt_gitguide_5 Work with repository: Reviewer operations
+
+@subsection occt_gitguide_5_1 Review branch changes using GitWeb
+
+ The changes made in the branch can be reviewed without direct access to Git, using GitWeb interface:
+
+ * Open GitWeb in your web browser: http://git.dev.opencascade.org/gitweb/?p=occt.git
+ * Locate the branch you want to review among heads (click ‘…’ at the bottom of the page to see the full list).
+ * Click log (or shortlog) to see the history of the branch.
+
+ **Note** that the branch can contain more than one commit, and you need to distinguish commits
+ that belong to that branch (those to be reviewed) from the commits
+ corresponding to the previous state of the master branch.
+ Normally the first commit in the list that starts from the ID
+ of the other issue indicates the branching point;
+ commits above it are the ones to be reviewed.
+
+ * Click *commitdiff* on each log entry to review the changes (highlighted with color format).
+
+@subsection occt_gitguide_5_2 Review branch changes with TortoiseGit
+
+ Use of TortoiseGit is recommended for convenient code review:
+
+ * Fetch the changes from the remote repository as described in 4.7;
+ * Right-click on the repository, choose TortoiseGit -> Show log;
+ * Locate the remote branch you need to review;
+ * To review commits one-by-one, select each commit in the log.
+ The list of changed files is shown at the bottom of the window;
+ double-click on the file will open visual compare tool.
+ * To review all changes made in the branch at once, or to compare
+ two arbitrary revisions, select the corresponding commits in the log
+ (e.g. the last commit in the branch and the branching point),
+ right-click for the context menu, and choose **Compare revisions**.
+
+@image html OCCT_GitGuide_V2_image026.png
+@image latex OCCT_GitGuide_V2_image026.png
+
diff --git a/dox/dev_guides/git_guide/images/OCCT_GitGuide_V2_image001.png b/dox/dev_guides/git_guide/images/OCCT_GitGuide_V2_image001.png
new file mode 100644
index 0000000000..8152cc9dff
Binary files /dev/null and b/dox/dev_guides/git_guide/images/OCCT_GitGuide_V2_image001.png differ
diff --git a/dox/dev_guides/git_guide/images/OCCT_GitGuide_V2_image002.png b/dox/dev_guides/git_guide/images/OCCT_GitGuide_V2_image002.png
new file mode 100644
index 0000000000..33894e21c9
Binary files /dev/null and b/dox/dev_guides/git_guide/images/OCCT_GitGuide_V2_image002.png differ
diff --git a/dox/dev_guides/git_guide/images/OCCT_GitGuide_V2_image003.png b/dox/dev_guides/git_guide/images/OCCT_GitGuide_V2_image003.png
new file mode 100644
index 0000000000..ab44c52cb3
Binary files /dev/null and b/dox/dev_guides/git_guide/images/OCCT_GitGuide_V2_image003.png differ
diff --git a/dox/dev_guides/git_guide/images/OCCT_GitGuide_V2_image004.png b/dox/dev_guides/git_guide/images/OCCT_GitGuide_V2_image004.png
new file mode 100644
index 0000000000..7c13d47605
Binary files /dev/null and b/dox/dev_guides/git_guide/images/OCCT_GitGuide_V2_image004.png differ
diff --git a/dox/dev_guides/git_guide/images/OCCT_GitGuide_V2_image005.png b/dox/dev_guides/git_guide/images/OCCT_GitGuide_V2_image005.png
new file mode 100644
index 0000000000..c57045660d
Binary files /dev/null and b/dox/dev_guides/git_guide/images/OCCT_GitGuide_V2_image005.png differ
diff --git a/dox/dev_guides/git_guide/images/OCCT_GitGuide_V2_image006.png b/dox/dev_guides/git_guide/images/OCCT_GitGuide_V2_image006.png
new file mode 100644
index 0000000000..953143c45a
Binary files /dev/null and b/dox/dev_guides/git_guide/images/OCCT_GitGuide_V2_image006.png differ
diff --git a/dox/dev_guides/git_guide/images/OCCT_GitGuide_V2_image007.png b/dox/dev_guides/git_guide/images/OCCT_GitGuide_V2_image007.png
new file mode 100644
index 0000000000..9ed5e9d13a
Binary files /dev/null and b/dox/dev_guides/git_guide/images/OCCT_GitGuide_V2_image007.png differ
diff --git a/dox/dev_guides/git_guide/images/OCCT_GitGuide_V2_image008.png b/dox/dev_guides/git_guide/images/OCCT_GitGuide_V2_image008.png
new file mode 100644
index 0000000000..c5c73e5ee3
Binary files /dev/null and b/dox/dev_guides/git_guide/images/OCCT_GitGuide_V2_image008.png differ
diff --git a/dox/dev_guides/git_guide/images/OCCT_GitGuide_V2_image009.png b/dox/dev_guides/git_guide/images/OCCT_GitGuide_V2_image009.png
new file mode 100644
index 0000000000..6ad161e62c
Binary files /dev/null and b/dox/dev_guides/git_guide/images/OCCT_GitGuide_V2_image009.png differ
diff --git a/dox/dev_guides/git_guide/images/OCCT_GitGuide_V2_image010.png b/dox/dev_guides/git_guide/images/OCCT_GitGuide_V2_image010.png
new file mode 100644
index 0000000000..277eebc472
Binary files /dev/null and b/dox/dev_guides/git_guide/images/OCCT_GitGuide_V2_image010.png differ
diff --git a/dox/dev_guides/git_guide/images/OCCT_GitGuide_V2_image011.png b/dox/dev_guides/git_guide/images/OCCT_GitGuide_V2_image011.png
new file mode 100644
index 0000000000..41cf51cd40
Binary files /dev/null and b/dox/dev_guides/git_guide/images/OCCT_GitGuide_V2_image011.png differ
diff --git a/dox/dev_guides/git_guide/images/OCCT_GitGuide_V2_image012.png b/dox/dev_guides/git_guide/images/OCCT_GitGuide_V2_image012.png
new file mode 100644
index 0000000000..438f752414
Binary files /dev/null and b/dox/dev_guides/git_guide/images/OCCT_GitGuide_V2_image012.png differ
diff --git a/dox/dev_guides/git_guide/images/OCCT_GitGuide_V2_image013.png b/dox/dev_guides/git_guide/images/OCCT_GitGuide_V2_image013.png
new file mode 100644
index 0000000000..7de58e708d
Binary files /dev/null and b/dox/dev_guides/git_guide/images/OCCT_GitGuide_V2_image013.png differ
diff --git a/dox/dev_guides/git_guide/images/OCCT_GitGuide_V2_image014.png b/dox/dev_guides/git_guide/images/OCCT_GitGuide_V2_image014.png
new file mode 100644
index 0000000000..9f0c119d10
Binary files /dev/null and b/dox/dev_guides/git_guide/images/OCCT_GitGuide_V2_image014.png differ
diff --git a/dox/dev_guides/git_guide/images/OCCT_GitGuide_V2_image015.png b/dox/dev_guides/git_guide/images/OCCT_GitGuide_V2_image015.png
new file mode 100644
index 0000000000..3d634ae88d
Binary files /dev/null and b/dox/dev_guides/git_guide/images/OCCT_GitGuide_V2_image015.png differ
diff --git a/dox/dev_guides/git_guide/images/OCCT_GitGuide_V2_image016.png b/dox/dev_guides/git_guide/images/OCCT_GitGuide_V2_image016.png
new file mode 100644
index 0000000000..8a4d8d692a
Binary files /dev/null and b/dox/dev_guides/git_guide/images/OCCT_GitGuide_V2_image016.png differ
diff --git a/dox/dev_guides/git_guide/images/OCCT_GitGuide_V2_image017.png b/dox/dev_guides/git_guide/images/OCCT_GitGuide_V2_image017.png
new file mode 100644
index 0000000000..6dbeea83ad
Binary files /dev/null and b/dox/dev_guides/git_guide/images/OCCT_GitGuide_V2_image017.png differ
diff --git a/dox/dev_guides/git_guide/images/OCCT_GitGuide_V2_image018.png b/dox/dev_guides/git_guide/images/OCCT_GitGuide_V2_image018.png
new file mode 100644
index 0000000000..ebc5d7ff66
Binary files /dev/null and b/dox/dev_guides/git_guide/images/OCCT_GitGuide_V2_image018.png differ
diff --git a/dox/dev_guides/git_guide/images/OCCT_GitGuide_V2_image019.png b/dox/dev_guides/git_guide/images/OCCT_GitGuide_V2_image019.png
new file mode 100644
index 0000000000..0fba94f230
Binary files /dev/null and b/dox/dev_guides/git_guide/images/OCCT_GitGuide_V2_image019.png differ
diff --git a/dox/dev_guides/git_guide/images/OCCT_GitGuide_V2_image020.png b/dox/dev_guides/git_guide/images/OCCT_GitGuide_V2_image020.png
new file mode 100644
index 0000000000..02cf386fb0
Binary files /dev/null and b/dox/dev_guides/git_guide/images/OCCT_GitGuide_V2_image020.png differ
diff --git a/dox/dev_guides/git_guide/images/OCCT_GitGuide_V2_image021.png b/dox/dev_guides/git_guide/images/OCCT_GitGuide_V2_image021.png
new file mode 100644
index 0000000000..078be9b2b5
Binary files /dev/null and b/dox/dev_guides/git_guide/images/OCCT_GitGuide_V2_image021.png differ
diff --git a/dox/dev_guides/git_guide/images/OCCT_GitGuide_V2_image022.png b/dox/dev_guides/git_guide/images/OCCT_GitGuide_V2_image022.png
new file mode 100644
index 0000000000..0f2993a0fe
Binary files /dev/null and b/dox/dev_guides/git_guide/images/OCCT_GitGuide_V2_image022.png differ
diff --git a/dox/dev_guides/git_guide/images/OCCT_GitGuide_V2_image023.png b/dox/dev_guides/git_guide/images/OCCT_GitGuide_V2_image023.png
new file mode 100644
index 0000000000..47c3532f2c
Binary files /dev/null and b/dox/dev_guides/git_guide/images/OCCT_GitGuide_V2_image023.png differ
diff --git a/dox/dev_guides/git_guide/images/OCCT_GitGuide_V2_image024.png b/dox/dev_guides/git_guide/images/OCCT_GitGuide_V2_image024.png
new file mode 100644
index 0000000000..976e0ae35d
Binary files /dev/null and b/dox/dev_guides/git_guide/images/OCCT_GitGuide_V2_image024.png differ
diff --git a/dox/dev_guides/git_guide/images/OCCT_GitGuide_V2_image025.png b/dox/dev_guides/git_guide/images/OCCT_GitGuide_V2_image025.png
new file mode 100644
index 0000000000..06ab464781
Binary files /dev/null and b/dox/dev_guides/git_guide/images/OCCT_GitGuide_V2_image025.png differ
diff --git a/dox/dev_guides/git_guide/images/OCCT_GitGuide_V2_image026.png b/dox/dev_guides/git_guide/images/OCCT_GitGuide_V2_image026.png
new file mode 100644
index 0000000000..1ff096355a
Binary files /dev/null and b/dox/dev_guides/git_guide/images/OCCT_GitGuide_V2_image026.png differ
diff --git a/dox/overview/Overview.md b/dox/overview/Overview.md
index d730f88b30..02313c8f3f 100644
--- a/dox/overview/Overview.md
+++ b/dox/overview/Overview.md
@@ -456,17 +456,17 @@ Remarks:
**On Linux:**
-1. If OCCT was built by Code::Blocks * use $CASROOT/draw_cbp.sh file to launch DRAWEXE executable;
-2. If OCCT was built by Automake * use $CASROOT/draw_amk.sh file to launch DRAWEXE executable;
+1. If OCCT was built by Code::Blocks use $CASROOT/draw_cbp.sh file to launch *DRAWEXE* executable;
+2. If OCCT was built by Automake use $CASROOT/draw_amk.sh file to launch *DRAWEXE* executable;
Draw[1]> prompt appears in the command window
-Type pload ALL
+Type *pload ALL*
**On Windows:**
Launch Draw executable from Open CASCADE Technology\\Test Harness\\Draw Test Harness
-item of the Start\\Programs menu or Use $CASROOT\\draw.bat file to launch DRAWEXE executable.
+item of the Start\\Programs menu or Use $CASROOT\\draw.bat file to launch *DRAWEXE* executable.
Draw[1]> prompt appears in the command window
@@ -474,36 +474,33 @@ Type pload ALL
**Creating your first geometric objects**
-1. In the command window, type axo to create an axonometric view
-2. Type box b -10 -10 -10 20 20 20 to create a cube b of size 20,
- parallel to the X Y Z axis and centered on the origin.
- The cube will be displayed in the axonometric view in wireframe mode
-3. Type fit to fill the viewer with the cube
-4. Type pcylinder c 2 30 to create a cylinder c of radius 2 and height 30.
- The cylinder will be displayed in addition to the cube
+1. In the command window, type *axo* to create an axonometric view
+2. Type *box b -10 -10 -10 20 20 20* to create a cube *b* of size 20, parallel to the X Y Z axis and centered on the origin. The cube will be displayed in the axonometric view in wireframe mode.
+3. Type *fit* to fill the viewer with the cube
+4. Type *pcylinder c 2 30* to create a cylinder *c* of radius 2 and height 30. The cylinder will be displayed in addition to the cube
**Manipulating the view**
-1. Type clear to erase the view
-2. Type donly c to display the cylinder only
-3. Type donly b to display the cube only
-4. Type hlr hlr b to display the cube in the hidden line removal mode
+1. Type *clear* to erase the view
+2. Type *donly c* to display the cylinder only
+3. Type *donly b* to display the cube only
+4. Type *hlr hlr b* to display the cube in the hidden line removal mode
**Running demonstration files**
-1. Type cd ../.. to return to the root directory
-2. Type cd src/DrawResources to reach the DrawResources directory
-3. Type source "Available Demo File" to run the demonstration provided with Open CASCADE
-4. The following demonstration files are available:
+1. Type *cd ../..* to return to the root directory
+2. Type *cd samples/tcl* to reach the *DrawResources* directory
+3. Type *source * to run the demonstration file provided with Open CASCADE. The following demonstration files are available:
+ * bottle.tcl
+ * challenge.tcl
* DataExchangeDemo.tcl
* ModelingDemo.tcl
- * OCAFDemo.tcl
* VisualizationDemo.tcl
**Getting Help**
-1. Type help to see all available commands
-2. Type help command-name to find out the arguments for a given command
+1. Type *help* to see all available commands
+2. Type *help * to find out the arguments for a given command
@subsection OCCT_OVW_SECTION_7_3 Programming Samples
diff --git a/dox/user_guides/brep_wp/brep_wp.md b/dox/user_guides/brep_wp/brep_wp.md
new file mode 100644
index 0000000000..13404b0aac
--- /dev/null
+++ b/dox/user_guides/brep_wp/brep_wp.md
@@ -0,0 +1,2221 @@
+ BRep Format Description {#occt_brep_format}
+========================
+
+@tableofcontents
+
+@section occt_brep_format_1 Introduction
+
+ BREP format is used to store 3D models and allows to store a model which consists
+ of vertices, edges, wires, faces, shells, solids, compsolids, compounds, edge triangulations,
+ face triangulations, polylines on triangulations, space location and orientation.
+ Any set of such models may be stored as a single model which is a compound of the models.
+
+ The format is described in an order which is convenient for understanding
+ rather than in the order the format parts follow each other.
+ BNF-like definitions are used in this document.
+ Most of the chapters contain BREP format descriptions in the following order:
+
+ * format file fragment to illustrate the part;
+ * BNF-like definition of the part;
+ * detailed description of the part.
+
+@section occt_brep_format_2 Format Common Structure
+
+ ASCII encoding is used to read/write BREP format from/to file. The format data are stored in a file as text data.
+
+ BREP format uses the following BNF terms:
+
+ * <\n>;
+ * <_\n>;
+ * <_>;
+ * ;
+ * ;
+ * ;
+ * <2D point>;
+ * <3D point>;
+ * <2D direction>;
+ * <3D direction>;
+ * <+>;
+
+ * \n is the operating-system-dependent ASCII character sequence which separates ASCII text strings in the operating system used.
+ * _\n = " "* \n;
+ * _ = " "+;
+ * _ is a not empty sequence of space characters with ASCII code 21h.
+ * flag = "0" | "1";
+ * int is an integer number from @image html brep_wp_image003.gif to @image html brep_wp_image004.gif which is written in denary system.
+ * real is a real from @image html brep_wp_image005.gif to @image html brep_wp_image006.gif
+ which is written in decimal or E form with base 10.
+
+ The point is used as a delimiter of the integer and fractional parts.
+
+ * 2D point = real _ real;
+ * 3D point = real (_ real) ^ 2;
+ * 2D direction is a 2D point @image html brep_wp_image007.gif so that @image html brep_wp_image008.gif.
+ * 3D direction is a 3D point @image html brep_wp_image009.gif so that @image html brep_wp_image010.gif.
+ + is an arithmetic operation of addition.
+
+ The format consists of the following sections:
+
+ * content type;
+ * version;
+ * locations;
+ * geometry;
+ * shapes.
+
+ content type = "DBRep_DrawableShape" _\n _\n;
+ content type have other values [1].
+
+ version = ("CASCADE Topology V1, (c) Matra-Datavision" | "CASCADE Topology V2, (c) Matra-Datavision") _\n;
+
+ The difference of the versions is described in the document.
+
+ Sections , and are described below in separate chapters of the document.
+
+@section occt_brep_format_3 Section locations
+
+**Example**
+
+@verbatim
+ Locations 3
+ 1
+ 0 0 1 0
+ 1 0 0 0
+ 0 1 0 0
+ 1
+ 1 0 0 4
+ 0 1 0 5
+ 0 0 1 6
+ 2 1 1 2 1 0
+@endverbatim
+
+**BNF-like Definition**
+
+@verbatim
+ locations = location header _\n location records;
+ location header = "Locations" _ location record count;
+ location record count = int;
+ location records = location record ^ location record count;
+ location record = location record 1 | location record 2;
+ location record 1 = "1" _\n location data 1;
+ location record 2 = "2" _ location data 2;
+ location data 1 = ((_ real) ^ 4 _\n) ^ 3;
+ location data 2 = (int _ int _)* "0" _\n;
+@endverbatim
+
+****Description****
+
+*location data 1* is interpreted as a 3 x 4 matrix @image html brep_wp_image011.gif
+which describes transformation of 3 dimensional space and satisfies the following constraints:
+
+ * @image html brep_wp_image012.gif where @image html brep_wp_image013.gif where @image html brep_wp_image014.gif;
+ * @image html brep_wp_image015.gif where @image html brep_wp_image016.gif.
+
+The transformation transforms a point
+
+@image html brep_wp_image017.gif
+
+to another point
+
+@image html brep_wp_image018.gif
+
+by the rule:
+
+@image html brep_wp_image019.gif.
+@image html brep_wp_image020.gif
+
+may be a composition of matrices for the following elementary transformations:
+
+ * parallel translation – @image html brep_wp_image021.gif;
+ * rotation around an axis with a direction @image html brep_wp_image022.gif by an angle @image html brep_wp_image023.gif –
+
+@image html brep_wp_image024.gif;
+
+ * scaling – @image html brep_wp_image025.gif where @image html brep_wp_image026.gif;
+ * central symmetry – @image html brep_wp_image027.gif;
+ * axis symmetry – @image html brep_wp_image028.gif;
+ * plane symmetry – @image html brep_wp_image029.gif.
+
+*location data 2* is interpreted as a composition of locations raised to a power and placed above this location data 2 in the section locations. location data 2 is a sequence @image html brep_wp_image030.gif of @image html brep_wp_image031.gif integer pairs @image html brep_wp_image032.gif (@image html brep_wp_image033.gif). flag 0 is the indicator of the sequence end. The sequence is interpreted as a composition @image html brep_wp_image034.gif where @image html brep_wp_image035.gif is a location from @image html brep_wp_image036.gif-th location record in the section locations. location record numbering starts from1.
+
+
+@section occt_brep_format_4 Section geometry
+
+@verbatim
+ geometry =
+ 2D curves
+ 3D curves
+ 3D polygons
+ polygons on triangulations
+ surfaces
+ triangulations;
+@endverbatim
+
+@subsection occt_brep_format_4_1 Subsection 3D curves
+
+**Example**
+
+@verbatim
+ Curves 13
+ 1 0 0 0 0 0 1
+ 1 0 0 3 -0 1 0
+ 1 0 2 0 0 0 1
+ 1 0 0 0 -0 1 0
+ 1 1 0 0 0 0 1
+ 1 1 0 3 0 1 0
+ 1 1 2 0 0 0 1
+ 1 1 0 0 -0 1 0
+ 1 0 0 0 1 0 -0
+ 1 0 0 3 1 0 -0
+ 1 0 2 0 1 0 -0
+ 1 0 2 3 1 0 -0
+ 1 1 0 0 1 0 0
+@endverbatim
+
+**BNF-like Definition**
+
+@verbatim
+ 3D curves = 3D curve header _\n 3D curve records;
+
+ 3D curve header = "Curves" _ 3D curve count;
+
+ 3D curve count = int;
+
+ 3D curve records = 3D curve record ^ 3D curve count;
+
+ 3D curve record =
+ 3D curve record 1 |
+ 3D curve record 2 |
+ 3D curve record 3 |
+ 3D curve record 4 |
+ 3D curve record 5 |
+ 3D curve record 6 |
+ 3D curve record 7 |
+ 3D curve record 8 |
+ 3D curve record 9;
+
+
+@subsubsection occt_brep_format_4_1_1 3D curve record 1 – Line
+
+**Example**
+
+@verbatim
+ 1 1 0 3 0 1 0
+@endverbatim
+
+**BNF-like Definition**
+
+@verbatim
+ 3D curve record 1 = "1" _ 3D point _ 3D direction _\n;
+@endverbatim
+
+**Description**
+
+3D curve record 1 describes a line. The line data consist of a 3D point @image html brep_wp_image037.gif and a 3D direction @image html brep_wp_image038.gif. The line passes through the point @image html brep_wp_image037.gif, has the direction @image html brep_wp_image038.gif and is defined by the following parametric equation:
+
+@image html brep_wp_image039.gif, @image html brep_wp_image040.gif.
+
+The **Example** record is interpreted as a line which passes through a point @image html brep_wp_image041.gif, has a direction @image html brep_wp_image042.gif and is defined by the following parametric equation: @image html brep_wp_image043.gif.
+
+
+@subsubsection occt_brep_format_4_1_2 3D curve record 2 – Circle
+
+**Example**
+
+@verbatim
+ 2 1 2 3 0 0 1 1 0 -0 -0 1 0 4
+@endverbatim
+
+**BNF-like Definition**
+
+@verbatim
+ 3D curve record 2 = "2" _ 3D circle center _ 3D circle N _ 3D circle Dx _ 3D circle Dy _ 3D circle radius _\n;
+
+ 3D circle center = 3D point;
+
+ 3D circle N = 3D direction;
+
+ 3D circle Dx = 3D direction;
+
+ 3D circle Dy = 3D direction;
+
+ 3D circle radius = real;
+@endverbatim
+
+**Description**
+
+3D curve record 2 describes a circle. The circle data consist of a 3D point @image html brep_wp_image037.gif, pairwise orthogonal 3D directions @image html brep_wp_image044.gif, @image html brep_wp_image045.gif and @image html brep_wp_image046.gif and a non-negative real @image html brep_wp_image047.gif. The circle has a center @image html brep_wp_image037.gif and is located in a plane with a normal @image html brep_wp_image044.gif. The circle has a radius @image html brep_wp_image047.gif and is defined by the following parametric equation:
+
+@image html brep_wp_image048.gif, @image html brep_wp_image049.gif.
+
+The example record is interpreted as a circle which has its center @image html brep_wp_image050.gif, is located in plane with a normal @image html brep_wp_image051.gif. Directions for the circle are @image html brep_wp_image052.gif and @image html brep_wp_image053.gif. The circle has a radius @image html brep_wp_image054.gif and is defined by the following parametric equation: @image html brep_wp_image055.gif.
+
+
+@subsubsection occt_brep_format_4_1_3 3D curve record 3 – Ellipse
+
+**Example**
+
+@verbatim
+ 3 1 2 3 0 0 1 1 0 -0 -0 1 0 5 4
+@endverbatim
+
+**BNF-like Definition**
+
+@verbatim
+ 3D curve record 3 = "3" _ 3D ellipse center _ 3D ellipse N _ 3D ellipse Dmaj _ 3D ellipse Dmin _ 3D ellipse Rmaj _ 3D ellipse Rmin _\n;
+
+ 3D ellipse center = 3D point;
+
+ 3D ellipse N = 3D direction;
+
+ 3D ellipse Dmaj = 3D direction;
+
+ 3D ellipse Dmin = 3D direction;
+
+ 3D ellipse Rmaj = real;
+
+ 3D ellipse Rmin = real;
+@endverbatim
+
+**Description**
+
+3D curve record 3 describes an ellipse. The ellipse data consist of a 3D point @image html brep_wp_image037.gif, pairwise orthogonal 3D directions @image html brep_wp_image044.gif, @image html brep_wp_image056.gif and @image html brep_wp_image057.gif and non-negative reals @image html brep_wp_image058.gif and @image html brep_wp_image059.gif so that @image html brep_wp_image060.gif. The ellipse has its center @image html brep_wp_image037.gif, is located in plane with the normal @image html brep_wp_image044.gif, has major and minor axis directions @image html brep_wp_image056.gif and @image html brep_wp_image057.gif, major and minor radii @image html brep_wp_image058.gif and @image html brep_wp_image059.gif and is defined by the following parametric equation:
+
+@image html brep_wp_image061.gif, @image html brep_wp_image049.gif.
+
+The example record is interpreted as an ellipse which has its center @image html brep_wp_image050.gif, is located in plane with a normal @image html brep_wp_image051.gif, has major and minor axis directions @image html brep_wp_image062.gif and @image html brep_wp_image063.gif, major and minor radii @image html brep_wp_image064.gif and @image html brep_wp_image065.gif and is defined by the following parametric equation: @image html brep_wp_image066.gif.
+
+
+@subsubsection occt_brep_format_4_1_4 3D curve record 4 – Parabola
+
+**Example**
+
+@verbatim
+ 4 1 2 3 0 0 1 1 0 -0 -0 1 0 16
+@endverbatim
+
+**BNF-like Definition**
+
+@verbatim
+ 3D curve record 4 = "4" _ 3D parabola origin _ 3D parabola N _ 3D parabola Dx _ 3D parabola Dy _ 3D parabola focal length _\n;
+
+ 3D parabola origin = 3D point;
+
+ 3D parabola N = 3D direction;
+
+ 3D parabola Dx = 3D direction;
+
+ 3D parabola Dy = 3D direction;
+
+ 3D parabola focal length = real;
+@endverbatim
+
+**Description**
+
+3D curve record 4 describes a parabola. The parabola data consist of a 3D point @image html brep_wp_image037.gif, pairwise orthogonal 3D directions @image html brep_wp_image044.gif, @image html brep_wp_image045.gif and @image html brep_wp_image046.gif and a non-negative real @image html brep_wp_image067.gif. The parabola is located in plane which passes through the point @image html brep_wp_image037.gif and has the normal @image html brep_wp_image044.gif. The parabola has a focus length @image html brep_wp_image067.gif and is defined by the following parametric equation:
+
+@image html brep_wp_image068.gif, @image html brep_wp_image069.gif Ü @image html brep_wp_image070.gif;
+
+@image html brep_wp_image071.gif, @image html brep_wp_image069.gif Ü @image html brep_wp_image072.gif (degenerated case).
+
+The example record is interpreted as a parabola in plane which passes through a point @image html brep_wp_image073.gif and has a normal @image html brep_wp_image074.gif. Directions for the parabola are @image html brep_wp_image075.gif and @image html brep_wp_image076.gif. The parabola has a focus length @image html brep_wp_image077.gif and is defined by the following parametric equation: @image html brep_wp_image078.gif.
+
+
+@subsubsection occt_brep_format_4_1_5 3D curve record 5 – Hyperbola
+
+**Example**
+
+@verbatim
+ 5 1 2 3 0 0 1 1 0 -0 -0 1 0 5 4
+@verbatim
+
+**BNF-like Definition**
+
+@verbatim
+ 3D curve record 5 = "5" _ 3D hyperbola origin _ 3D hyperbola N _ 3D hyperbola Dx _ 3D hyperbola Dy _ 3D hyperbola Kx _ 3D hyperbola Ky _\n;
+
+ 3D hyperbola origin = 3D point;
+
+ 3D hyperbola N = 3D direction;
+
+ 3D hyperbola Dx = 3D direction;
+
+ 3D hyperbola Dy = 3D direction;
+
+ 3D hyperbola Kx = real;
+
+ 3D hyperbola Ky = real;
+@endverbatim
+
+Descripton
+
+3D curve record 5 describes a hyperbola. The hyperbola data consist of a 3D point @image html brep_wp_image037.gif, pairwise orthogonal 3D directions @image html brep_wp_image044.gif, @image html brep_wp_image045.gif and @image html brep_wp_image046.gif and non-negative reals @image html brep_wp_image079.gif and @image html brep_wp_image080.gif. The hyperbola is located in plane which passes through the point @image html brep_wp_image037.gif and has the normal @image html brep_wp_image044.gif. The hyperbola is defined by the following parametric equation:
+
+@image html brep_wp_image081.gif, @image html brep_wp_image069.gif.
+
+The example record is interpreted as a hyperbola in plane which passes through a point @image html brep_wp_image073.gif and has a normal @image html brep_wp_image074.gif. Other hyperbola data are @image html brep_wp_image075.gif, @image html brep_wp_image076.gif, @image html brep_wp_image082.gif and @image html brep_wp_image083.gif. The hyperbola is defined by the following parametric equation: @image html brep_wp_image084.gif.
+
+
+@subsubsection occt_brep_format_4_1_6 3D curve record 6 – Bezier Curve
+
+**Example**
+
+@verbatim
+ 6 1 2 0 1 0 4 1 -2 0 5 2 3 0 6
+@verbatim
+
+**BNF-like Definition**
+
+@verbatim
+ 3D curve record 6 = "6" _ 3D Bezier rational flag _ 3D Bezier degree 3D Bezier weight poles _\n;
+
+ 3D Bezier rational flag = flag;
+
+ 3D Bezier degree = int;
+
+ 3D Bezier weight poles = (_ 3D Bezier weight pole) ^ (3D Bezier degree + "1");
+
+ 3D Bezier weight pole = 3D point [_ real];
+@verbatim
+
+**Description**
+
+3D curve record 6 describes a Bezier curve. The curve data consist of a rational flag @image html brep_wp_image047.gif, a degree @image html brep_wp_image085.gif and weight poles.
+
+The weight poles are @image html brep_wp_image086.gif 3D points @image html brep_wp_image087.gif if the flag @image html brep_wp_image047.gif is 0. The weight poles are @image html brep_wp_image086.gif pairs @image html brep_wp_image088.gif if flag @image html brep_wp_image047.gif is 1. Here @image html brep_wp_image089.gif is a 3D point and @image html brep_wp_image090.gif is a positive real (@image html brep_wp_image091.gif). @image html brep_wp_image092.gif (@image html brep_wp_image093.gif) if the flag @image html brep_wp_image047.gif is 0.
+
+The Bezier curve is defined by the following parametric equation:
+
+@image html brep_wp_image094.gif, @image html brep_wp_image095.gif
+
+where @image html brep_wp_image096.gif.
+
+The example record is interpreted as a Bezier curve with a rational flag @image html brep_wp_image097.gif, degree @image html brep_wp_image098.gif and weight poles @image html brep_wp_image099.gif, @image html brep_wp_image100.gif, @image html brep_wp_image101.gif, @image html brep_wp_image102.gif and @image html brep_wp_image103.gif, @image html brep_wp_image104.gif. The Bezier curve is defined by the following parametric equation:
+
+@image html brep_wp_image105.gif.
+
+
+@subsubsection occt_brep_format_4_1_7 3D curve record 7 – B-spline Curve
+
+**Example**
+
+@verbatim
+ 7 1 0 1 3 5 0 1 0 4 1 -2 0 5 2 3 0 6
+ 0 1 0.25 1 0.5 1 0.75 1 1 1
+@endverbatim
+
+**BNF-like Definition**
+
+@verbatim
+ 3D curve record 7 = "7" _ 3D B-spline rational flag _ "0" _ 3D B-spline degree _ 3D B-spline pole count _ 3D B-spline multiplicity knot count 3D B-spline weight poles _\n 3D B-spline multiplicity knots _\n;
+
+ 3D B-spline rational flag = flag;
+
+ 3D B-spline degree = int;
+
+ 3D B-spline pole count = int;
+
+ 3D B-spline multiplicity knot count = int;
+
+ 3D B-spline weight poles = (_ 3D B-spline weight pole) ^ 3D B-spline pole count;
+
+ 3D B-spline weight pole = 3D point [_ real];
+
+ 3D B-spline multiplicity knots =
+ (_ 3D B-spline multiplicity knot) ^ 3D B-spline multiplicity knot count;
+
+ 3D B-spline multiplicity knot = real _ int;
+@endverbatim
+
+**Description**
+
+3D curve record 7 describes a B-spline curve. The curve data consist of a rational flag @image html brep_wp_image047.gif, a degree @image html brep_wp_image085.gif, pole count @image html brep_wp_image106.gif, multiplicity knot count @image html brep_wp_image107.gif, weight poles and multiplicity knots.
+
+The weight poles are @image html brep_wp_image108.gif 3D points @image html brep_wp_image109.gif if the flag @image html brep_wp_image047.gif is 0. The weight poles are @image html brep_wp_image108.gif pairs @image html brep_wp_image110.gif if the flag @image html brep_wp_image047.gif is 1. Here @image html brep_wp_image089.gif is a 3D point and @image html brep_wp_image090.gif is a positive real (@image html brep_wp_image111.gif). @image html brep_wp_image092.gif (@image html brep_wp_image111.gif) if the flag @image html brep_wp_image047.gif is 0.
+
+The multiplicity knots are @image html brep_wp_image107.gif pairs @image html brep_wp_image112.gif. Here @image html brep_wp_image113.gif is a knot with a multiplicity @image html brep_wp_image114.gif (@image html brep_wp_image115.gif) so that
+
+@image html brep_wp_image116.gif (@image html brep_wp_image117.gif),
+@image html brep_wp_image118.gif, @image html brep_wp_image119.gif, @image html brep_wp_image120.gif (@image html brep_wp_image121.gif), @image html brep_wp_image122.gif.
+
+The B-spline curve is defined by the following parametric equation:
+
+@image html brep_wp_image123.gif, @image html brep_wp_image124.gif
+
+where functions @image html brep_wp_image125.gif have the following recursion definition by @image html brep_wp_image126.gif
+
+@image html brep_wp_image127.gif, @image html brep_wp_image128.gif (@image html brep_wp_image129.gif)
+
+where
+
+@image html brep_wp_image130.gif (@image html brep_wp_image131.gif, @image html brep_wp_image132.gif).
+
+The example record is interpreted as a B-spline curve with a rational flag @image html brep_wp_image097.gif, a degree @image html brep_wp_image133.gif, pole count @image html brep_wp_image134.gif, multiplicity knot count @image html brep_wp_image135.gif, weight poles @image html brep_wp_image136.gif, @image html brep_wp_image137.gif, @image html brep_wp_image138.gif, @image html brep_wp_image139.gif and @image html brep_wp_image140.gif, @image html brep_wp_image141.gif, multiplicity knots @image html brep_wp_image142.gif, @image html brep_wp_image143.gif, @image html brep_wp_image144.gif, @image html brep_wp_image145.gif, @image html brep_wp_image146.gif, @image html brep_wp_image147.gif, @image html brep_wp_image148.gif, @image html brep_wp_image149.gif and @image html brep_wp_image150.gif, @image html brep_wp_image151.gif. The B-spline curve is defined by the following parametric equation:
+
+@image html brep_wp_image152.gif.
+
+
+@subsubsection occt_brep_format_4_1_8 3D curve record 8 – Trimmed Curve
+
+**Example**
+
+@verbatim
+ 8 4 -5
+ 1 1 2 3 1 0 0
+@endverbatim
+
+**BNF-like Definition**
+
+@verbatim
+ 3D curve record 8 = "8" _ 3D trimmed curve u min _ 3D trimmed curve u max _\n 3D curve record;
+
+ 3D trimmed curve u min = real;
+
+ 3D trimmed curve u max = real;
+@endverbatim
+
+**Description**
+
+3D curve record 8 describes a trimmed curve. The trimmed curve data consist of reals @image html brep_wp_image153.gif and @image html brep_wp_image154.gif and 3D curve record so that @image html brep_wp_image155.gif. The trimmed curve is a restriction of the base curve @image html brep_wp_image156.gif described in the record to the segment @image html brep_wp_image157.gif. The trimmed curve is defined by the following parametric equation:
+
+@image html brep_wp_image158.gif, @image html brep_wp_image159.gif.
+
+The example record is interpreted as a trimmed curve with @image html brep_wp_image160.gif and @image html brep_wp_image161.gif for the base curve @image html brep_wp_image162.gif. The trimmed curve is defined by the following parametric equation: @image html brep_wp_image163.gif, @image html brep_wp_image164.gif.
+
+
+@subsubsection occt_brep_format_4_1_9 3D curve record 9 – Offset Curve
+
+**Example**
+
+@verbatim
+ 9 2
+ 0 1 0
+ 1 1 2 3 1 0 0
+@endverbatim
+
+**BNF-like Definition**
+
+@verbatim
+ 3D curve record 9 = "9" _ 3D offset curve distance _\n
+ 3D offset curve direction _\n
+ 3D curve record;
+
+ 3D offset curve distance = real;
+
+ 3D offset curve direction = 3D direction;
+@endverbatim
+
+**Description**
+
+3D curve record 9 describes an offset curve. The offset curve data consist of a distance @image html brep_wp_image165.gif, a 3D direction @image html brep_wp_image038.gif and a 3D curve record. The offset curve is the result of offsetting the base curve @image html brep_wp_image156.gif described in the record to the distance @image html brep_wp_image165.gif along the vector @image html brep_wp_image166.gif. The offset curve is defined by the following parametric equation:
+
+@image html brep_wp_image167.gif, @image html brep_wp_image168.gif.
+
+The example record is interpreted as an offset curve with a distance @image html brep_wp_image169.gif, direction @image html brep_wp_image170.gif, base curve @image html brep_wp_image162.gif and defined by the following parametric equation: @image html brep_wp_image171.gif.
+
+@subsection occt_brep_format_4_2 Subsection surfaces
+
+**Example**
+
+@verbatim
+ Surfaces 6
+ 1 0 0 0 1 0 -0 0 0 1 0 -1 0
+ 1 0 0 0 -0 1 0 0 0 1 1 0 -0
+ 1 0 0 3 0 0 1 1 0 -0 -0 1 0
+ 1 0 2 0 -0 1 0 0 0 1 1 0 -0
+ 1 0 0 0 0 0 1 1 0 -0 -0 1 0
+ 1 1 0 0 1 0 -0 0 0 1 0 -1 0
+@endverbatim
+
+**BNF-like Definition**
+
+@verbatim
+ surfaces = surface header _\n surface records;
+
+ surface header = "Surfaces" _ surface count;
+
+ surface records = surface record ^ surface count;
+
+ surface record =
+ surface record 1 |
+ surface record 2 |
+ surface record 3 |
+ surface record 4 |
+ surface record 5 |
+ surface record 6 |
+ surface record 7 |
+ surface record 8 |
+ surface record 9 |
+ surface record 10 |
+ surface record 11;
+@verbatim
+
+@subsubsection occt_brep_format_4_2_1 surface record 1 – Plane
+
+**Example**
+
+@verbatim
+ 1 0 0 3 0 0 1 1 0 -0 -0 1 0
+@endverbatim
+
+**BNF-like Definition**
+
+@verbatim
+surface record 1 = "1" _ 3D point (_ 3D direction) ^ 3 _\n;
+@endverbatim
+
+**Description**
+
+surface record 1 describes a plane. The plane data consist of a 3D point @image html brep_wp_image037.gif and pairwise orthogonal 3D directions @image html brep_wp_image044.gif, @image html brep_wp_image172.gif and @image html brep_wp_image173.gif. The plane passes through the point @image html brep_wp_image037.gif, has the normal @image html brep_wp_image174.gif and is defined by the following parametric equation:
+
+@image html brep_wp_image175.gif, @image html brep_wp_image176.gif.
+
+The example record is interpreted as a plane which passes through a point @image html brep_wp_image177.gif, has a normal @image html brep_wp_image074.gif and is defined by the following parametric equation: @image html brep_wp_image178.gif.
+
+
+@subsubsection occt_brep_format_4_2_2 surface record 2 – Cylinder
+
+**Example**
+
+@verbatim
+ 2 1 2 3 0 0 1 1 0 -0 -0 1 0 4
+@endverbatim
+
+**BNF-like Definition**
+
+@verbatim
+ surface record 2 = "2" _ 3D point (_ 3D direction) ^ 3 _ real _\n;
+@endverbatim
+
+**Description**
+
+surface record 2 describes a cylinder. The cylinder data consist of a 3D point @image html brep_wp_image037.gif, pairwise orthogonal 3D directions @image html brep_wp_image173.gif, @image html brep_wp_image045.gif and @image html brep_wp_image046.gif and a non-negative real @image html brep_wp_image047.gif. The cylinder axis passes through the point @image html brep_wp_image037.gif and has the direction @image html brep_wp_image173.gif. The cylinder has the radius @image html brep_wp_image179.gif and is defined by the following parametric equation:
+
+@image html brep_wp_image180.gif, @image html brep_wp_image181.gif.
+
+The example record is interpreted as a cylinder which axis passes through a point @image html brep_wp_image073.gif and has a direction @image html brep_wp_image182.gif. Directions for the cylinder are @image html brep_wp_image075.gif and @image html brep_wp_image076.gif. The cylinder has a radius @image html brep_wp_image054.gif and is defined by the following parametric equation: @image html brep_wp_image183.gif.
+
+
+@subsubsection occt_brep_format_4_2_3 surface record 3 – Cone
+
+**Example**
+
+@verbatim
+ 3 1 2 3 0 0 1 1 0 -0 -0 1 0 4
+ 0.75
+@endverbatim
+
+
+**BNF-like Definition**
+
+@verbatim
+ surface record 3 = "3" _ 3D point (_ 3D direction) ^ 3 (_ real) ^ 2 _\n;
+@endverbatim
+
+**Description**
+
+surface record 3 describes a cone. The cone data consist of a 3D point @image html brep_wp_image037.gif, pairwise orthogonal 3D directions @image html brep_wp_image184.gif, @image html brep_wp_image045.gif and @image html brep_wp_image046.gif, a non-negative real @image html brep_wp_image047.gif and a real @image html brep_wp_image185.gif. The cone axis passes through the point @image html brep_wp_image037.gif and has the direction @image html brep_wp_image184.gif. The plane which passes through the point @image html brep_wp_image037.gif and is parallel to directions @image html brep_wp_image045.gif and @image html brep_wp_image046.gif is the cone referenced plane. The cone section by the plane is a circle with the radius @image html brep_wp_image047.gif. The direction from the point @image html brep_wp_image037.gif to the cone apex is @image html brep_wp_image186.gif. The cone has a half-angle @image html brep_wp_image187.gif and is defined by the following parametric equation:
+
+@image html brep_wp_image188.gif, @image html brep_wp_image189.gif.
+
+The example record is interpreted as a cone with an axis which passes through a point @image html brep_wp_image073.gif and has a direction @image html brep_wp_image190.gif. Other cone data are @image html brep_wp_image075.gif, @image html brep_wp_image076.gif, @image html brep_wp_image191.gif and @image html brep_wp_image192.gif. The cone is defined by the following parametric equation:
+@image html brep_wp_image193.gif.
+
+
+@subsubsection occt_brep_format_4_2_4 surface record 4 – Sphere
+
+**Example**
+
+@verbatim
+ 4 1 2 3 0 0 1 1 0 -0 -0 1 0 4
+@endverbatim
+
+**BNF-like Definition**
+
+@verbatim
+ surface record 4 = "4" _ 3D point (_ 3D direction) ^ 3 _ real _\n;
+@endverbatim
+
+**Description**
+
+surface record 4 describes a sphere. The sphere data consist of a 3D point @image html brep_wp_image037.gif, pairwise orthogonal 3D directions @image html brep_wp_image184.gif, @image html brep_wp_image045.gif and @image html brep_wp_image046.gif and a non-negative real @image html brep_wp_image047.gif. The sphere has the center @image html brep_wp_image194.gif, radius @image html brep_wp_image179.gif and is defined by the following parametric equation:
+
+@image html brep_wp_image195.gif, @image html brep_wp_image196.gif.
+
+The example record is interpreted as a sphere with its center @image html brep_wp_image073.gif. Directions for the sphere are @image html brep_wp_image190.gif, @image html brep_wp_image075.gif and @image html brep_wp_image076.gif. The sphere has a radius @image html brep_wp_image191.gif and is defined by the following parametric equation:
+@image html brep_wp_image197.gif.
+
+
+@subsubsection occt_brep_format_4_2_5 surface record 5 – Torus
+
+**Example**
+
+@verbatim
+ 5 1 2 3 0 0 1 1 0 -0 -0 1 0 8 4
+@endverbatim
+
+**BNF-like Definition**
+
+@verbatim
+ surface record 5 = "5" _ 3D point (_ 3D direction) ^ 3 (_ real) ^ 2 _\n;
+@endverbatim
+
+**Description**
+
+surface record 5 describes a torus. The torus data consist of a 3D point @image html brep_wp_image037.gif, pairwise orthogonal 3D directions @image html brep_wp_image184.gif, @image html brep_wp_image045.gif and @image html brep_wp_image046.gif and non-negative reals @image html brep_wp_image198.gif and @image html brep_wp_image199.gif. The torus axis passes through the point @image html brep_wp_image037.gif and has the direction @image html brep_wp_image184.gif. @image html brep_wp_image198.gif is the distance from the torus circle center to the axis. The torus circle has the radius @image html brep_wp_image199.gif. The torus is defined by the following parametric equation:
+
+@image html brep_wp_image200.gif, @image html brep_wp_image201.gif.
+
+The example record is interpreted as a torus with an axis which passes through a point @image html brep_wp_image073.gif and has a direction @image html brep_wp_image190.gif. @image html brep_wp_image075.gif, @image html brep_wp_image076.gif, @image html brep_wp_image202.gif and @image html brep_wp_image203.gif for the torus. The torus is defined by the following parametric equation:
+@image html brep_wp_image204.gif.
+
+
+@subsubsection occt_brep_format_4_2_6 surface record 6 – Linear Extrusion
+
+**Example**
+
+@verbatim
+ 6 0 0.6 0.8
+ 2 1 2 3 0 0 1 1 0 -0 -0 1 0 4
+@endverbatim
+
+**BNF-like Definition**
+
+@verbatim
+ surface record 6 = "6" _ 3D direction _\n 3D curve record;
+@endverbatim
+
+**Description**
+
+surface record 6 describes a linear extrusion surface. The surface data consist of a 3D direction @image html brep_wp_image173.gif and a 3D curve record. The linear extrusion surface has the direction @image html brep_wp_image173.gif, the base curve @image html brep_wp_image205.gif described in the record and is defined by the following parametric equation:
+
+@image html brep_wp_image206.gif, @image html brep_wp_image207.gif.
+
+The example record is interpreted as a linear extrusion surface with a direction @image html brep_wp_image208.gif. The base curve is a circle for the surface. The surface is defined by the following parametric equation: @image html brep_wp_image209.gif, @image html brep_wp_image189.gif.
+
+
+@subsubsection occt_brep_format_4_2_7 surface record 7 – Revolution Surface
+
+**Example**
+
+@verbatim
+ 7 -4 0 3 0 1 0
+ 2 1 2 3 0 0 1 1 0 -0 -0 1 0 4
+@endverbatim
+
+**BNF-like Definition**
+
+@verbatim
+ surface record 7 = "7" _ 3D point _ 3D direction _\n 3D curve record;
+@endverbatim
+
+**Description**
+
+surface record 7 describes a revolution surface. The surface data consist of a 3D point @image html brep_wp_image037.gif, a 3D direction @image html brep_wp_image038.gif and a 3D curve record. The surface axis passes through the point @image html brep_wp_image037.gif and has the direction @image html brep_wp_image038.gif. The base curve @image html brep_wp_image210.gif described by the record and the axis are coplanar. The surface is defined by the following parametric equation:
+
+@image html brep_wp_image211.gif, @image html brep_wp_image212.gif
+
+where @image html brep_wp_image213.gif, @image html brep_wp_image214.gif.
+
+The example record is interpreted as a revolution surface with an axis which passes through a point @image html brep_wp_image215.gif and has a direction @image html brep_wp_image170.gif. The base curve is a circle for the surface. The surface is defined by the following parametric equation:
+@image html brep_wp_image216.gif, @image html brep_wp_image201.gif where @image html brep_wp_image217.gif, @image html brep_wp_image218.gif.
+
+
+@subsubsection occt_brep_format_4_2_8 surface record 8 – Bezier Surface
+
+**Example**
+
+@verbatim
+ 8 1 1 2 1 0 0 1 7 1 0 -4 10
+ 0 1 -2 8 1 1 5 11
+ 0 2 3 9 1 2 6 12
+@endverbatim
+
+**BNF-like Definition**
+
+@verbatim
+ surface record 8 = "8" _ Bezier surface u rational flag _ Bezier surface v rational flag _ Bezier surface u degree _ Bezier surface v degree _ Bezier surface weight poles;
+
+ Bezier surface u rational flag = flag;
+
+ Bezier surface v rational flag = flag;
+
+ Bezier surface u degree = int;
+
+ Bezier surface v degree = int;
+
+ Bezier surface weight poles =
+ (Bezier surface weight pole group _\n) ^ (Bezier surface u degree + "1");
+
+ Bezier surface weight pole group = Bezier surface weight pole
+ (_ Bezier surface weight pole) ^ Bezier surface v degree;
+
+ Bezier surface weight pole = 3D point [_ real];
+ @endverbatim
+
+**Description**
+
+surface record 8 describes a Bezier surface. The surface data consist of a u rational flag @image html brep_wp_image219.gif, v rational flag @image html brep_wp_image220.gif, u degree @image html brep_wp_image221.gif, v degree @image html brep_wp_image222.gif and weight poles.
+
+The weight poles are @image html brep_wp_image223.gif 3D points @image html brep_wp_image224.gif (@image html brep_wp_image225.gif) if @image html brep_wp_image226.gif. The weight poles are @image html brep_wp_image223.gif pairs @image html brep_wp_image227.gif (@image html brep_wp_image225.gif) if @image html brep_wp_image228.gif. Here @image html brep_wp_image224.gif is a 3D point and @image html brep_wp_image229.gif is a positive real (@image html brep_wp_image225.gif). @image html brep_wp_image230.gif (@image html brep_wp_image225.gif) if @image html brep_wp_image226.gif.
+
+The Bezier surface is defined by the following parametric equation:
+
+@image html brep_wp_image231.gif, @image html brep_wp_image232.gif
+
+where @image html brep_wp_image096.gif.
+
+The example record is interpreted as a Bezier surface with a u rational flag @image html brep_wp_image233.gif, v rational flag @image html brep_wp_image234.gif, u degree @image html brep_wp_image235.gif, v degree @image html brep_wp_image236.gif, weight poles @image html brep_wp_image237.gif, @image html brep_wp_image238.gif, @image html brep_wp_image239.gif, @image html brep_wp_image240.gif, @image html brep_wp_image241.gif, @image html brep_wp_image242.gif, @image html brep_wp_image243.gif, @image html brep_wp_image244.gif, @image html brep_wp_image245.gif, @image html brep_wp_image246.gif and @image html brep_wp_image247.gif, @image html brep_wp_image248.gif. The surface is defined by the following parametric equation:
+
+@image html brep_wp_image249.gif
+
+
+@subsubsection occt_brep_format_4_2_9 surface record 9 – B-spline Surface
+
+**Example**
+
+@verbatim
+ 9 1 1 0 0 1 1 3 2 5 4 0 0 1 7 1 0 -4 10
+ 0 1 -2 8 1 1 5 11
+ 0 2 3 9 1 2 6 12
+
+ 0 1
+ 0.25 1
+ 0.5 1
+ 0.75 1
+ 1 1
+
+ 0 1
+ 0.3 1
+ 0.7 1
+ 1 1
+@endverbatim
+
+**BNF-like Definition**
+
+@verbatim
+ surface record 9 = "9" _ B-spline surface u rational flag _ B-spline surface v rational flag _ "0" _ "0" _ B-spline surface u degree _ B-spline surface v degree _ B-spline surface u pole count _ B-spline surface v pole count _ B-spline surface u multiplicity knot count _ B-spline surface v multiplicity knot count _ B-spline surface weight poles _\n B-spline surface u multiplicity knots _\n B-spline surface v multiplicity knots;
+
+ B-spline surface u rational flag = flag;
+
+ B-spline surface v rational flag = flag;
+
+ B-spline surface u degree = int;
+
+ B-spline surface v degree = int;
+
+ B-spline surface u pole count = int;
+
+ B-spline surface v pole count = int;
+
+ B-spline surface u multiplicity knot count = int;
+
+ B-spline surface v multiplicity knot count = int;
+
+ B-spline surface weight poles =
+ (B-spline surface weight pole group _\n) ^ B-spline surface u pole count;
+
+ B-spline surface weight pole group =
+ (B-spline surface weight pole _) ^ B-spline surface v pole count;
+
+ B-spline surface weight pole = 3D point [_ real];
+
+ B-spline surface u multiplicity knots =
+ (B-spline surface u multiplicity knot _\n) ^ B-spline surface u multiplicity knot count;
+
+ B-spline surface u multiplicity knot = real _ int;
+
+ B-spline surface v multiplicity knots =
+ (B-spline surface v multiplicity knot _\n) ^ B-spline surface v multiplicity knot count;
+
+ B-spline surface v multiplicity knot = real _ int;
+@endverbatim
+
+**Description**
+
+surface record 9 describes a B-spline surface. The surface data consist of a u rational flag @image html brep_wp_image219.gif, v rational flag @image html brep_wp_image220.gif, u degree @image html brep_wp_image221.gif, v degree @image html brep_wp_image222.gif, u pole count @image html brep_wp_image250.gif, v pole count @image html brep_wp_image251.gif, u multiplicity knot count @image html brep_wp_image252.gif, v multiplicity knot count @image html brep_wp_image253.gif, weight poles, u multiplicity knots, v multiplicity knots.
+
+The weight poles are @image html brep_wp_image254.gif 3D points @image html brep_wp_image224.gif (@image html brep_wp_image255.gif) if @image html brep_wp_image226.gif. The weight poles are @image html brep_wp_image254.gif pairs @image html brep_wp_image227.gif (@image html brep_wp_image255.gif) if @image html brep_wp_image228.gif. Here @image html brep_wp_image224.gif is a 3D point and @image html brep_wp_image229.gif is a positive real (@image html brep_wp_image255.gif). @image html brep_wp_image230.gif (@image html brep_wp_image255.gif) if @image html brep_wp_image226.gif.
+
+The u multiplicity knots are @image html brep_wp_image252.gif pairs @image html brep_wp_image256.gif. Here @image html brep_wp_image113.gif is a knot with multiplicity @image html brep_wp_image114.gif (@image html brep_wp_image257.gif) so that
+
+@image html brep_wp_image116.gif (@image html brep_wp_image258.gif),
+@image html brep_wp_image259.gif, @image html brep_wp_image260.gif, @image html brep_wp_image261.gif (@image html brep_wp_image262.gif), @image html brep_wp_image263.gif.
+
+The v multiplicity knots are @image html brep_wp_image253.gif pairs @image html brep_wp_image264.gif. Here @image html brep_wp_image265.gif is a knot with multiplicity @image html brep_wp_image266.gif (@image html brep_wp_image267.gif) so that
+
+@image html brep_wp_image268.gif (@image html brep_wp_image269.gif),
+@image html brep_wp_image270.gif, @image html brep_wp_image271.gif, @image html brep_wp_image272.gif (@image html brep_wp_image273.gif), @image html brep_wp_image274.gif.
+
+The B-spline surface is defined by the following parametric equation:
+
+@image html brep_wp_image275.gif, @image html brep_wp_image276.gif
+
+where functions @image html brep_wp_image277.gif and @image html brep_wp_image278.gif have the following recursion definition by @image html brep_wp_image279.gif
+
+@image html brep_wp_image127.gif, @image html brep_wp_image128.gif (@image html brep_wp_image280.gif);
+
+@image html brep_wp_image281.gif, @image html brep_wp_image282.gif (@image html brep_wp_image283.gif);
+where
+
+@image html brep_wp_image284.gif (@image html brep_wp_image285.gif,@image html brep_wp_image286.gif),
+
+@image html brep_wp_image287.gif (@image html brep_wp_image288.gif,@image html brep_wp_image289.gif).
+
+The example record is interpreted as a B-spline surface with a u rational flag @image html brep_wp_image233.gif, v rational flag @image html brep_wp_image234.gif, u degree @image html brep_wp_image290.gif, v degree @image html brep_wp_image236.gif, u pole count @image html brep_wp_image291.gif, v pole count @image html brep_wp_image292.gif, u multiplicity knot count @image html brep_wp_image293.gif, v multiplicity knot count @image html brep_wp_image294.gif, weight poles @image html brep_wp_image295.gif, @image html brep_wp_image296.gif, @image html brep_wp_image297.gif, @image html brep_wp_image298.gif, @image html brep_wp_image299.gif, @image html brep_wp_image300.gif, @image html brep_wp_image301.gif, @image html brep_wp_image302.gif, @image html brep_wp_image303.gif, @image html brep_wp_image304.gif and @image html brep_wp_image305.gif, @image html brep_wp_image306.gif, u multiplicity knots @image html brep_wp_image142.gif, @image html brep_wp_image143.gif, @image html brep_wp_image144.gif, @image html brep_wp_image145.gif, @image html brep_wp_image146.gif, @image html brep_wp_image147.gif, @image html brep_wp_image148.gif, @image html brep_wp_image149.gif and @image html brep_wp_image150.gif, @image html brep_wp_image151.gif, v multiplicity knots @image html brep_wp_image307.gif, @image html brep_wp_image308.gif, @image html brep_wp_image309.gif, @image html brep_wp_image310.gif, @image html brep_wp_image311.gif, @image html brep_wp_image312.gif and @image html brep_wp_image313.gif, @image html brep_wp_image314.gif. The B-spline surface is defined by the following parametric equation:
+
+@image html brep_wp_image315.gif
+
+
+@subsubsection occt_brep_format_4_2_10 surface record 10 – Rectangular Trim Surface
+
+**Example**
+
+@verbatim
+ 10 -1 2 -3 4
+ 1 1 2 3 0 0 1 1 0 -0 -0 1 0
+@endverbatim
+
+**BNF-like Definition**
+
+@verbatim
+ surface record 10 = "10" _ trim surface u min _ trim surface u max _ trim surface v min _ trim surface v max _\n surface record;
+
+ trim surface u min = real;
+
+ trim surface u max = real;
+
+ trim surface v min = real;
+
+ trim surface v max = real;
+@verbatim
+
+**Description**
+
+surface record 10 describes a rectangular trim surface. The surface data consist of reals @image html brep_wp_image153.gif, @image html brep_wp_image154.gif, @image html brep_wp_image316.gif and @image html brep_wp_image317.gif and a surface record so that @image html brep_wp_image155.gif and @image html brep_wp_image318.gif. The rectangular trim surface is a restriction of the base surface @image html brep_wp_image156.gif described in the record to the set @image html brep_wp_image319.gif. The rectangular trim surface is defined by the following parametric equation:
+
+@image html brep_wp_image320.gif, @image html brep_wp_image321.gif.
+
+The example record is interpreted as a rectangular trim surface to the set @image html brep_wp_image322.gif for the base surface @image html brep_wp_image323.gif. The rectangular trim surface is defined by the following parametric equation: @image html brep_wp_image324.gif, @image html brep_wp_image325.gif.
+
+
+@subsubsection occt_brep_format_4_2_11 surface record 11 – Offset Surface
+
+**Example**
+
+@verbatim
+ 11 -2
+ 1 1 2 3 0 0 1 1 0 -0 -0 1 0
+@verbatim
+
+**BNF-like Definition**
+
+@verbatim
+ surface record 11 = "11" _ surface record distance _\n surface record;
+
+ surface record distance = real;
+@verbatim
+
+**Description**
+
+surface record 11 describes an offset surface.
+The offset surface data consist of a distance @image html brep_wp_image165.gif and a surface record. The offset surface is the result of offsetting the base surface @image html brep_wp_image326.gif described in the record to the distance @image html brep_wp_image165.gif along the normal @image html brep_wp_image044.gif of surface @image html brep_wp_image156.gif. The offset surface is defined by the following parametric equation:
+
+@image html brep_wp_image327.gif, @image html brep_wp_image328.gif.
+
+@image html brep_wp_image329.gif
+if @image html brep_wp_image330.gif.
+
+The example record is interpreted as an offset surface with a distance @image html brep_wp_image331.gif and base surface @image html brep_wp_image323.gif. The offset surface is defined by the following parametric equation: @image html brep_wp_image332.gif.
+
+
+@subsection occt_brep_format_4_3 Subsection 2D curves
+
+**Example**
+
+@verbatim
+ Curve2ds 24
+ 1 0 0 1 0
+ 1 0 0 1 0
+ 1 3 0 0 -1
+ 1 0 0 0 1
+ 1 0 -2 1 0
+ 1 0 0 1 0
+ 1 0 0 0 -1
+ 1 0 0 0 1
+ 1 0 0 1 0
+ 1 0 1 1 0
+ 1 3 0 0 -1
+ 1 1 0 0 1
+ 1 0 -2 1 0
+ 1 0 1 1 0
+ 1 0 0 0 -1
+ 1 1 0 0 1
+ 1 0 0 0 1
+ 1 0 0 1 0
+ 1 3 0 0 1
+ 1 0 0 1 0
+ 1 0 0 0 1
+ 1 0 2 1 0
+ 1 3 0 0 1
+ 1 0 2 1 0
+@endverbatim
+
+**BNF-like Definition**
+
+@verbatim
+ 2D curves = 2D curve header _\n 2D curve records;
+
+ 2D curve header = "Curve2ds" _ 2D curve count;
+
+ 2D curve count = int;
+
+ 2D curve records = 2D curve record ^ 2D curve count;
+
+ 2D curve record =
+ 2D curve record 1 |
+ 2D curve record 2 |
+ 2D curve record 3 |
+ 2D curve record 4 |
+ 2D curve record 5 |
+ 2D curve record 6 |
+ 2D curve record 7 |
+ 2D curve record 8 |
+ 2D curve record 9;
+@endverbatim
+
+@subsubsection occt_brep_format_4_3_1 2D curve record 1 – Line
+
+**Example**
+
+@verbatim
+ 1 3 0 0 -1
+@verbatim
+
+**BNF-like Definition**
+
+@verbatim
+ 2D curve record 1 = "1" _ 2D point _ 2D direction _\n;
+@endverbatim
+
+**Description**
+
+2D curve record 1 describes a line. The line data consist of a 2D point @image html brep_wp_image037.gif and a 2D direction @image html brep_wp_image038.gif. The line passes through the point @image html brep_wp_image037.gif, has the direction @image html brep_wp_image038.gif and is defined by the following parametric equation:
+
+@image html brep_wp_image333.gif, @image html brep_wp_image069.gif.
+
+The example record is interpreted as a line which passes through a point@image html brep_wp_image334.gif, has a direction @image html brep_wp_image335.gif and is defined by the following parametric equation: @image html brep_wp_image336.gif.
+
+
+@subsubsection occt_brep_format_4_3_2 2D curve record 2 – Circle
+
+**Example**
+
+@verbatim
+ 2 1 2 1 0 -0 1 3
+@endverbatim
+
+**BNF-like Definition**
+
+@verbatim
+ 2D curve record 2 = "2" _ 2D circle center _ 2D circle Dx _ 2D circle Dy _ 2D circle radius _\n;
+
+ 2D circle center = 2D point;
+
+ 2D circle Dx = 2D direction;
+
+ 2D circle Dy = 2D direction;
+
+ 2D circle radius = real;
+@endverbatim
+
+**Description**
+
+2D curve record 2 describes a circle. The circle data consist of a 2D point @image html brep_wp_image037.gif, orthogonal 2D directions @image html brep_wp_image045.gif and @image html brep_wp_image046.gif and a non-negative real @image html brep_wp_image047.gif. The circle has a center @image html brep_wp_image037.gif. The circle plane is parallel to directions @image html brep_wp_image045.gif and @image html brep_wp_image046.gif. The circle has a radius @image html brep_wp_image047.gif and is defined by the following parametric equation:
+
+@image html brep_wp_image337.gif, @image html brep_wp_image338.gif.
+
+The example record is interpreted as a circle which has a center @image html brep_wp_image339.gif. The circle plane is parallel to directions @image html brep_wp_image340.gif and @image html brep_wp_image341.gif. The circle has a radius @image html brep_wp_image342.gif and is defined by the following parametric equation: @image html brep_wp_image343.gif.
+
+
+@subsubsection occt_brep_format_4_3_3 2D curve record 3 – Ellipse
+
+**Example**
+
+@verbatim
+ 3 1 2 1 0 -0 1 4 3
+@verbatim
+
+**BNF-like Definition**
+
+@verbatim
+ 2D curve record 3 = "3" _ 2D ellipse center _ 2D ellipse Dmaj _ 2D ellipse Dmin _ 2D ellipse Rmaj _ 2D ellipse Rmin _\n;
+
+ 2D ellipse center = 2D point;
+
+ 2D ellipse Dmaj = 2D direction;
+
+ 2D ellipse Dmin = 2D direction;
+
+ 2D ellipse Rmaj = real;
+
+ 2D ellipse Rmin = real;
+@endverbatim
+
+**Description**
+
+2D curve record 3 describes an ellipse. The ellipse data are 2D point @image html brep_wp_image037.gif, orthogonal 2D directions @image html brep_wp_image056.gif and @image html brep_wp_image057.gif and non-negative reals @image html brep_wp_image344.gif and @image html brep_wp_image345.gif that @image html brep_wp_image346.gif. The ellipse has a center @image html brep_wp_image037.gif, major and minor axis directions @image html brep_wp_image056.gif and @image html brep_wp_image057.gif, major and minor radii @image html brep_wp_image058.gif and @image html brep_wp_image345.gif and is defined by the following parametric equation:
+
+@image html brep_wp_image347.gif, @image html brep_wp_image338.gif.
+
+The example record is interpreted as an ellipse which has a center @image html brep_wp_image339.gif, major and minor axis directions @image html brep_wp_image348.gif and @image html brep_wp_image349.gif, major and minor radii @image html brep_wp_image350.gif and @image html brep_wp_image351.gif and is defined by the following parametric equation: @image html brep_wp_image352.gif.
+
+
+@subsubsection occt_brep_format_4_3_4 2D curve record 4 – Parabola
+
+**Example**
+
+@verbatim
+ 4 1 2 1 0 -0 1 16
+@endverbatim
+
+**BNF-like Definition**
+
+@verbatim
+ 2D curve record 4 = "4" _ 2D parabola origin _ 2D parabola Dx _ 2D parabola Dy _ 2D parabola focal length _\n;
+
+ 2D parabola origin = 2D point;
+
+ 2D parabola Dx = 2D direction;
+
+ 2D parabola Dy = 2D direction;
+
+ 2D parabola focal length = real;
+@endverbatim
+
+**Description**
+
+2D curve record 4 describes a parabola. The parabola data consist of a 2D point @image html brep_wp_image037.gif, orthogonal 2D directions @image html brep_wp_image045.gif and @image html brep_wp_image046.gif and a non-negative real @image html brep_wp_image067.gif. The parabola coordinate system has its origin @image html brep_wp_image037.gif and axis directions @image html brep_wp_image045.gif and @image html brep_wp_image046.gif. The parabola has a focus length @image html brep_wp_image067.gif and is defined by the following parametric equation:
+
+@image html brep_wp_image068.gif, @image html brep_wp_image069.gif Ü @image html brep_wp_image070.gif;
+
+@image html brep_wp_image071.gif, @image html brep_wp_image069.gif Ü @image html brep_wp_image072.gif (degenerated case).
+
+The example record is interpreted as a parabola in plane which passes through a point @image html brep_wp_image339.gif and is parallel to directions @image html brep_wp_image340.gif and @image html brep_wp_image341.gif. The parabola has a focus length @image html brep_wp_image077.gif and is defined by the following parametric equation: @image html brep_wp_image353.gif.
+
+
+@subsubsection occt_brep_format_4_3_5 2D curve record 5 – Hyperbola
+
+**Example**
+
+5 1 2 1 0 -0 1 3 4
+
+
+**BNF-like Definition**
+
+@verbatim
+ 2D curve record 5 = "5" _ 2D hyperbola origin _ 2D hyperbola Dx _ 2D hyperbola Dy _ 2D hyperbola Kx _ 2D hyperbola Ky _\n;
+
+ 2D hyperbola origin = 2D point;
+
+ 2D hyperbola Dx = 2D direction;
+
+ 2D hyperbola Dy = 2D direction;
+
+ 2D hyperbola Kx = real;
+
+ 2D hyperbola Ky = real;
+@endverbatim
+
+**Description**
+
+2D curve record 5 describes a hyperbola. The hyperbola data consist of a 2D point @image html brep_wp_image037.gif, orthogonal 2D directions @image html brep_wp_image045.gif and @image html brep_wp_image046.gif and non-negative reals @image html brep_wp_image079.gif and @image html brep_wp_image080.gif. The hyperbola coordinate system has origin @image html brep_wp_image037.gif and axis directions @image html brep_wp_image045.gif and @image html brep_wp_image046.gif. The hyperbola is defined by the following parametric equation:
+
+@image html brep_wp_image081.gif, @image html brep_wp_image069.gif.
+
+The example record is interpreted as a hyperbola with coordinate system which has origin @image html brep_wp_image339.gif and axis directions @image html brep_wp_image354.gif and @image html brep_wp_image341.gif. Other data for the hyperbola are @image html brep_wp_image082.gif and @image html brep_wp_image083.gif. The hyperbola is defined by the following parametric equation: @image html brep_wp_image355.gif.
+
+
+@subsubsection occt_brep_format_4_3_6 2D curve record 6 – Bezier Curve
+
+**Example**
+
+@verbatim
+6 1 2 0 1 4 1 -2 5 2 3 6
+@endverbatim
+
+**BNF-like Definition**
+
+@verbatim
+2D curve record 6 = "6" _ 2D Bezier rational flag _ 2D Bezier degree 2D Bezier weight poles _\n;
+
+2D Bezier rational flag = flag;
+
+2D Bezier degree = int;
+
+2D Bezier weight poles = (_ 2D Bezier weight pole) ^ (2D Bezier degree + "1");
+
+2D Bezier weight pole = 2D point [_ real];
+@endverbatim
+
+**Description**
+
+2D curve record 6 describes a Bezier curve. The curve data consist of a rational flag @image html brep_wp_image047.gif, a degree @image html brep_wp_image085.gif and weight poles.
+
+The weight poles are @image html brep_wp_image086.gif 2D points @image html brep_wp_image087.gif if the flag @image html brep_wp_image047.gif is 0. The weight poles are @image html brep_wp_image086.gif pairs @image html brep_wp_image088.gif if the flag @image html brep_wp_image047.gif is 1. Here @image html brep_wp_image089.gif is a 2D point and @image html brep_wp_image090.gif is a positive real (@image html brep_wp_image093.gif). @image html brep_wp_image092.gif (@image html brep_wp_image093.gif) if the flag @image html brep_wp_image047.gif is 0.
+
+The Bezier curve is defined by the following parametric equation:
+
+@image html brep_wp_image094.gif, @image html brep_wp_image095.gif
+
+where @image html brep_wp_image096.gif.
+
+The example record is interpreted as a Bezier curve with a rational flag @image html brep_wp_image097.gif, a degree @image html brep_wp_image098.gif and weight poles @image html brep_wp_image356.gif, @image html brep_wp_image100.gif, @image html brep_wp_image357.gif, @image html brep_wp_image102.gif and @image html brep_wp_image358.gif, @image html brep_wp_image104.gif. The Bezier curve is defined by the following parametric equation:
+
+@image html brep_wp_image359.gif.
+
+
+@subsubsection occt_brep_format_4_3_7 2D curve record 7 – B-spline Curve
+
+**Example**
+
+@verbatim
+7 1 0 1 3 5 0 1 4 1 -2 5 2 3 6
+ 0 1 0.25 1 0.5 1 0.75 1 1 1
+@endverbatim
+
+**BNF-like Definition**
+
+@verbatim
+ 2D curve record 7 = "7" _ 2D B-spline rational flag _ "0" _ 2D B-spline degree _ 2D B-spline pole count _ 2D B-spline multiplicity knot count 2D B-spline weight poles _\n 2D B-spline multiplicity knots _\n;
+
+ 2D B-spline rational flag = flag;
+
+ 2D B-spline degree = int;
+
+ 2D B-spline pole count = int;
+
+ 2D B-spline multiplicity knot count = int;
+
+ 2D B-spline weight poles = 2D B-spline weight pole ^ 2D B-spline pole count;
+
+ 2D B-spline weight pole = _ 2D point [_ real];
+
+ 2D B-spline multiplicity knots =
+ 2D B-spline multiplicity knot ^ 2D B-spline multiplicity knot count;
+
+ 2D B-spline multiplicity knot = _ real _ int;
+@endverbatim
+
+**Description**
+
+2D curve record 7 describes a B-spline curve. The curve data consist of a rational flag @image html brep_wp_image047.gif, a degree @image html brep_wp_image085.gif, a pole count @image html brep_wp_image106.gif, a multiplicity knot count @image html brep_wp_image107.gif, weight poles and multiplicity knots.
+
+The weight poles are @image html brep_wp_image108.gif 2D points @image html brep_wp_image109.gif if the flag @image html brep_wp_image047.gif is 0. The weight poles are @image html brep_wp_image108.gif pairs @image html brep_wp_image110.gif if the flag @image html brep_wp_image047.gif is 1. Here @image html brep_wp_image089.gif is a 2D point and @image html brep_wp_image090.gif is a positive real (@image html brep_wp_image111.gif). @image html brep_wp_image092.gif (@image html brep_wp_image111.gif) if the flag @image html brep_wp_image047.gif is 0.
+
+The multiplicity knots are @image html brep_wp_image107.gif pairs @image html brep_wp_image112.gif. Here @image html brep_wp_image113.gif is a knot with multiplicity @image html brep_wp_image114.gif (@image html brep_wp_image115.gif) so that
+
+@image html brep_wp_image360.gif (@image html brep_wp_image361.gif),
+@image html brep_wp_image362.gif, @image html brep_wp_image363.gif, @image html brep_wp_image364.gif (@image html brep_wp_image365.gif), @image html brep_wp_image366.gif.
+
+The B-spline curve is defined by the following parametric equation:
+
+@image html brep_wp_image367.gif, @image html brep_wp_image368.gif
+
+where functions @image html brep_wp_image125.gif have the following recursion definition by @image html brep_wp_image126.gif
+
+@image html brep_wp_image127.gif, @image html brep_wp_image128.gif (@image html brep_wp_image129.gif)
+
+where
+
+@image html brep_wp_image284.gif (@image html brep_wp_image369.gif,@image html brep_wp_image286.gif).
+
+The example record is interpreted as a B-spline curve with a rational flag @image html brep_wp_image097.gif, a degree @image html brep_wp_image133.gif, a pole count @image html brep_wp_image134.gif, a multiplicity knot count @image html brep_wp_image135.gif, weight poles @image html brep_wp_image370.gif, @image html brep_wp_image137.gif, @image html brep_wp_image371.gif, @image html brep_wp_image139.gif and @image html brep_wp_image372.gif, @image html brep_wp_image141.gif and multiplicity knots @image html brep_wp_image373.gif, @image html brep_wp_image374.gif, @image html brep_wp_image375.gif, @image html brep_wp_image376.gif, @image html brep_wp_image377.gif, @image html brep_wp_image378.gif, @image html brep_wp_image379.gif, @image html brep_wp_image380.gif and @image html brep_wp_image381.gif, @image html brep_wp_image382.gif. The B-spline curve is defined by the following parametric equation:
+
+@image html brep_wp_image383.gif.
+
+
+@subsubsection occt_brep_format_4_3_8 2D curve record 8 – Trimmed Curve
+
+**Example**
+
+@verbatim
+ 8 -4 5
+ 1 1 2 1 0
+@endverbatim
+
+**BNF-like Definition**
+
+@verbatim
+ 2D curve record 8 = "8" _ 2D trimmed curve u min _ 2D trimmed curve u max _\n 2D curve record;
+
+ 2D trimmed curve u min = real;
+
+ 2D trimmed curve u max = real;
+@endverbatim
+
+**Description**
+
+2D curve record 8 describes a trimmed curve. The trimmed curve data consist of reals @image html brep_wp_image153.gif and @image html brep_wp_image154.gif and a 2D curve record so that @image html brep_wp_image155.gif. The trimmed curve is a restriction of the base curve @image html brep_wp_image326.gif described in the record to the segment @image html brep_wp_image157.gif. The trimmed curve is defined by the following parametric equation:
+
+@image html brep_wp_image158.gif, @image html brep_wp_image159.gif.
+
+The example record is interpreted as a trimmed curve with @image html brep_wp_image160.gif, @image html brep_wp_image161.gif and base curve @image html brep_wp_image384.gif. The trimmed curve is defined by the following parametric equation: @image html brep_wp_image385.gif, @image html brep_wp_image164.gif.
+
+
+@subsubsection occt_brep_format_4_3_9 2D curve record 9 – Offset Curve
+
+**Example**
+
+@verbatim
+ 9 2
+ 1 1 2 1 0
+@endverbatim
+
+**BNF-like Definition**
+
+@verbatim
+2D curve record 9 = "9" _ 2D offset curve distance _\n 2D curve record;
+
+2D offset curve distance = real;
+@endverbatim
+
+**Description**
+
+2D curve record 9 describes an offset curve. The offset curve data consist of a distance @image html brep_wp_image165.gif and a 2D curve record. The offset curve is the result of offsetting the base curve @image html brep_wp_image156.gif described in the record to the distance @image html brep_wp_image165.gif along the vector @image html brep_wp_image386.gif where @image html brep_wp_image387.gif. The offset curve is defined by the following parametric equation:
+
+@image html brep_wp_image388.gif, @image html brep_wp_image168.gif.
+
+The example record is interpreted as an offset curve with a distance
+@image html brep_wp_image169.gif and base curve @image html brep_wp_image384.gif and
+is defined by the following parametric equation: @image html brep_wp_image389.gif.
+
+@subsection occt_brep_format_4_4 Subsection 3D polygons
+
+**Example**
+
+@verbatim
+ Polygon3D 1
+ 2 1
+ 0.1
+ 1 0 0 2 0 0
+ 0 1
+@endverbatim
+
+**BNF-like Definition**
+
+@verbatim
+ 3D polygons = 3D polygon header _\n 3D polygon records;
+
+ 3D polygon header = "Polygon3D" _ 3D polygon record count;
+
+ 3D polygon records = 3D polygon record ^ 3D polygon record count;
+
+ 3D polygon record =
+ 3D polygon node count _ 3D polygon flag of parameter presence _\n
+ 3D polygon deflection _\n
+ 3D polygon nodes _\n
+ [3D polygon parameters _\n];
+
+ 3D polygon node count = int;
+
+ 3D polygon flag of parameter presence = flag;
+
+ 3D polygon deflection = real;
+
+ 3D polygon nodes = (3D polygon node _) ^ 3D polygon node count;
+
+ 3D polygon node = 3D point;
+
+ 3D polygon u parameters = (3D polygon u parameter _) ^ 3D polygon node count;
+
+ 3D polygon u parameter = real;
+@endverbatim
+
+**Description**
+
+3D polygon record describes a 3D polyline @image html brep_wp_image390.gif which approximates a 3D curve @image html brep_wp_image205.gif. The polyline data consist of a node count @image html brep_wp_image391.gif, a parameter presence flag @image html brep_wp_image392.gif, a deflection @image html brep_wp_image393.gif, nodes @image html brep_wp_image394.gif (@image html brep_wp_image395.gif) and parameters @image html brep_wp_image113.gif (@image html brep_wp_image395.gif). The parameters are present only if@image html brep_wp_image396.gif. The polyline @image html brep_wp_image390.gif passes through the nodes. The deflection @image html brep_wp_image165.gif describes the deflection of polyline @image html brep_wp_image390.gif from the curve @image html brep_wp_image205.gif:
+
+@image html brep_wp_image397.gif.
+
+The parameter @image html brep_wp_image113.gif (@image html brep_wp_image395.gif) is the parameter of the node @image html brep_wp_image394.gif on the curve @image html brep_wp_image205.gif:
+
+@image html brep_wp_image398.gif.
+
+The example record describes a polyline from @image html brep_wp_image098.gif nodes with a parameter presence flag @image html brep_wp_image396.gif, a deflection @image html brep_wp_image399.gif, nodes @image html brep_wp_image400.gif and @image html brep_wp_image401.gif and parameters @image html brep_wp_image142.gif and @image html brep_wp_image402.gif.
+
+
+@subsection occt_brep_format_4_5 Subsection triangulations
+
+**Example**
+
+@verbatim
+ Triangulations 6
+ 4 2 1 0
+ 0 0 0 0 0 3 0 2 3 0 2 0 0 0 3 0 3 -2 0 -2 2 4 3 2 1 4
+ 4 2 1 0
+ 0 0 0 1 0 0 1 0 3 0 0 3 0 0 0 1 3 1 3 0 3 2 1 3 1 4
+ 4 2 1 0
+ 0 0 3 0 2 3 1 2 3 1 0 3 0 0 0 2 1 2 1 0 3 2 1 3 1 4
+ 4 2 1 0
+ 0 2 0 1 2 0 1 2 3 0 2 3 0 0 0 1 3 1 3 0 3 2 1 3 1 4
+ 4 2 1 0
+ 0 0 0 0 2 0 1 2 0 1 0 0 0 0 0 2 1 2 1 0 3 2 1 3 1 4
+ 4 2 1 0
+ 1 0 0 1 0 3 1 2 3 1 2 0 0 0 3 0 3 -2 0 -2 2 4 3 2 1 4
+@endverbatim
+
+**BNF-like Definition**
+
+@verbatim
+ triangulations = triangulation header _\n triangulation records;
+
+ triangulation header = "Triangulations" _ triangulation count;
+
+ triangulation records = triangulation record ^ triangulation count;
+
+ triangulation record = triangulation node count _ triangulation triangle count _ triangulation parameter presence flag _ triangulation deflection _\n triangulation nodes [_ triangulation u v parameters] _ triangulation triangles _\n;
+
+ triangulation node count = int;
+
+ triangulation triangle count = int;
+
+ triangulation parameter presence flag = flag;
+
+ triangulation deflection = real;
+
+ triangulation nodes = (triangulation node _) ^ triangulation node count;
+
+ triangulation node = 3D point;
+
+ triangulation u v parameters = (triangulation u v parameter pair _) ^ triangulation node count;
+
+ triangulation u v parameter pair = real _ real;
+
+ triangulation triangles = (triangulation triangle _) ^ triangulation triangle count;
+
+ triangulation triangle = int _ int _ int.
+@endverbatim
+
+**Description**
+
+triangulation record describes a triangulation @image html brep_wp_image403.gif which approximates a surface @image html brep_wp_image404.gif. The triangulation data consist of a node count @image html brep_wp_image405.gif, a triangle count @image html brep_wp_image406.gif, a parameter presence flag @image html brep_wp_image392.gif, a deflection @image html brep_wp_image393.gif, nodes @image html brep_wp_image394.gif (@image html brep_wp_image395.gif), parameter pairs @image html brep_wp_image407.gif (@image html brep_wp_image395.gif), triangles @image html brep_wp_image408.gif (@image html brep_wp_image131.gif, @image html brep_wp_image409.gif (@image html brep_wp_image410.gif)). The parameters are present only if @image html brep_wp_image396.gif. The deflection describes the triangulation deflection from the surface:
+
+@image html brep_wp_image411.gif.
+
+The parameter pair @image html brep_wp_image407.gif (@image html brep_wp_image395.gif) describes the parameters of node @image html brep_wp_image394.gif on the surface:
+
+@image html brep_wp_image412.gif.
+
+The triangle @image html brep_wp_image408.gif (@image html brep_wp_image131.gif) is interpreted as a triangle of nodes @image html brep_wp_image413.gif, @image html brep_wp_image414.gif and @image html brep_wp_image415.gif with circular traversal of the nodes in the order @image html brep_wp_image413.gif, @image html brep_wp_image414.gif and @image html brep_wp_image415.gif. From any side of the triangulation @image html brep_wp_image403.gif all its triangles have the same direction of the node circular traversal: either clockwise or counterclockwise.
+
+Triangulation record
+
+@verbatim
+ 4 2 1 0
+ 0 0 0 0 0 3 0 2 3 0 2 0 0 0 3 0 3 -2 0 -2 2 4 3 2 1 4
+@endverbatim
+
+describes a triangulation with @image html brep_wp_image416.gif nodes, @image html brep_wp_image417.gif triangles, parameter presence flag @image html brep_wp_image396.gif, deflection @image html brep_wp_image418.gif, nodes @image html brep_wp_image419.gif, @image html brep_wp_image420.gif, @image html brep_wp_image421.gif and @image html brep_wp_image422.gif, parameters @image html brep_wp_image423.gif, @image html brep_wp_image424.gif, @image html brep_wp_image425.gif and @image html brep_wp_image426.gif, and triangles @image html brep_wp_image427.gif and @image html brep_wp_image428.gif. From the point @image html brep_wp_image429.gif (@image html brep_wp_image430.gif) the triangles have clockwise (counterclockwise) direction of the node circular traversal.
+
+
+@subsection occt_brep_format_4_6 Subsection polygons on triangulations
+
+**Example**
+
+@verbatim
+ PolygonOnTriangulations 24
+ 2 1 2
+ p 0.1 1 0 3
+ 2 1 4
+ p 0.1 1 0 3
+ 2 2 3
+ p 0.1 1 0 2
+ 2 1 2
+ p 0.1 1 0 2
+ 2 4 3
+ p 0.1 1 0 3
+ 2 1 4
+ p 0.1 1 0 3
+ 2 1 4
+ p 0.1 1 0 2
+ 2 1 2
+ p 0.1 1 0 2
+ 2 1 2
+ p 0.1 1 0 3
+ 2 2 3
+ p 0.1 1 0 3
+ 2 2 3
+ p 0.1 1 0 2
+ 2 4 3
+ p 0.1 1 0 2
+ 2 4 3
+ p 0.1 1 0 3
+ 2 2 3
+ p 0.1 1 0 3
+ 2 1 4
+ p 0.1 1 0 2
+ 2 4 3
+ p 0.1 1 0 2
+ 2 1 2
+ p 0.1 1 0 1
+ 2 1 4
+ p 0.1 1 0 1
+ 2 4 3
+ p 0.1 1 0 1
+ 2 1 4
+ p 0.1 1 0 1
+ 2 1 2
+ p 0.1 1 0 1
+ 2 2 3
+ p 0.1 1 0 1
+ 2 4 3
+ p 0.1 1 0 1
+ 2 2 3
+ p 0.1 1 0 1
+@endverbatim
+
+**BNF-like Definition**
+
+@verbatim
+ polygons on triangulations = polygons on triangulations header _\n
+ polygons on triangulations records;
+
+ polygons on triangulations header =
+ "PolygonOnTriangulations" _ polygons on triangulations record count;
+
+ polygons on triangulations record count = int;
+
+ polygons on triangulations records =
+ polygons on triangulations record ^ polygons on triangulations record count;
+
+ polygons on triangulations record =
+ polygons on triangulations node count _ polygons on triangulations node numbers _\n
+ "p" _ polygons on triangulations deflection _
+ polygons on triangulations parameter presence flag
+ [_ polygons on triangulations u parameters] _\n;
+
+ polygons on triangulations node count = int;
+
+ polygons on triangulations node numbers =
+ polygons on triangulations node number ^ polygons on triangulations node count;
+
+ polygons on triangulations node number = int;
+
+ polygons on triangulations deflection = real;
+
+ polygons on triangulations parameter presence flag = flag;
+
+ polygons on triangulations u parameters =
+ (polygons on triangulations u parameter _) ^ polygons on triangulations node count;
+
+ polygons on triangulations u parameter = real;
+@endverbatim
+
+**Description**
+
+polygons on triangulations describes a polyline @image html brep_wp_image390.gif on a triangulation which approximates a curve @image html brep_wp_image205.gif. The polyline data consist of a node count @image html brep_wp_image391.gif, node numbers @image html brep_wp_image431.gif, deflection @image html brep_wp_image393.gif, a parameter presence flag @image html brep_wp_image392.gif and parameters @image html brep_wp_image432.gif (@image html brep_wp_image395.gif). The parameters are present only if @image html brep_wp_image396.gif. The deflection @image html brep_wp_image165.gif describes the deflection of polyline @image html brep_wp_image390.gif from the curve @image html brep_wp_image205.gif:
+
+@image html brep_wp_image397.gif.
+
+Parameter @image html brep_wp_image113.gif (@image html brep_wp_image395.gif) is @image html brep_wp_image433.gif-th node @image html brep_wp_image434.gif parameter on curve @image html brep_wp_image205.gif.
+
+
+@subsection occt_brep_format_4_7 Geometric Sense of a Curve
+
+Geometric sense of curve @image html brep_wp_image210.gif described above is determined by the direction of parameter @image html brep_wp_image435.gif increasing.
+
+
+@section occt_brep_format_5 Section shapes
+
+An example of section shapes and a whole *.brep file are given in chapter 7 "Appendix".
+
+
+**BNF-like Definition**
+
+@verbatim
+ shapes = shape header _\n shape records _\n shape final record;
+
+ shape header = "TShapes" _ shape count;
+
+ shape count = int;
+
+ shape records = shape record ^ shape count;
+
+ shape record = shape subrecord _\n shape flag word _\n shape subshapes _\n;
+
+ shape flag word = flag ^ 7;
+
+ shape subshapes = (shape subshape _)* "*";
+
+ shape subshape =
+ shape subshape orientation shape subshape number _ shape location number;
+
+ shape subshape orientation = "+" | "-" | "i" | "e";
+
+ shape subshape number = int;
+
+ shape location number = int;
+
+ shape final record = shape subshape;
+
+ shape subrecord =
+ ("Ve" _\n vertex data _\n) |
+ ("Ed" _\n edge data _\n) |
+ ("Wi" _\n _\n) |
+ ("Fa" _\n face data) |
+ ("Sh" _\n _\n) |
+ ("So" _\n _\n) |
+ ("CS" _\n _\n) |
+ ("Co" _\n _\n);
+@endverbatim
+
+**Description**
+
+shape flag word @image html brep_wp_image436.gif flags @image html brep_wp_image437.gif
+(@image html brep_wp_image438.gif) are interpreted as shape flags in the following way:
+
+ * @image html brep_wp_image439.gif – free;
+ * @image html brep_wp_image440.gif – modified;
+ * @image html brep_wp_image441.gif – IGNORED (version * / checked (version * ;
+ * @image html brep_wp_image442.gif – orientable;
+ * @image html brep_wp_image443.gif – closed;
+ * @image html brep_wp_image444.gif – infinite;
+ * @image html brep_wp_image445.gif – convex.
+
+The flags are used in a special way [1].
+
+shape subshape orientation is interpreted in the following way:
+
+ * + – forward;
+ * - – reversed;
+ * i – internal;
+ * e – external.
+
+shape subshape orientation is used in a special way [1].
+
+shape subshape number is the number of a shape record which is located in this section above the shape subshape number. shape record numbering is backward and starts from 1.
+
+shape subrecord types are interpreted in the following way:
+
+ * "Ve" – vertex;
+ * "Ed" – edge;
+ * "Wi" – wire;
+ * "Fa" – face;
+ * "Sh" – shell;
+ * "So" – solid;
+ * "CS" – compsolid;
+ * "Co" – compound.
+
+shape final record determines the orientation and location for the whole model.
+
+@subsection occt_brep_format_5_1 Common Terms
+
+The terms below are used by vertex data, edge data and face data.
+
+
+**BNF-like Definition**
+
+@verbatim
+ location number = int;
+
+ 3D curve number = int;
+
+ surface number = int;
+
+ 2D curve number = int;
+
+ 3D polygon number = int;
+
+ triangulation number = int;
+
+ polygon on triangulation number = int;
+
+ curve parameter minimal and maximal values = real _ real;
+
+ curve values for parameter minimal and maximal values =
+ real _ real _ real _ real;
+@endverbatim
+
+**Description**
+
+location number is the number of location record from section locations. location record numbering starts from 1. location number 0 is interpreted as the identity location.
+
+3D curve number is the number of a 3D curve record from subsection 3D curves of section geometry. 3D curve record numbering starts from 1.
+
+surface number is the number of a surface record from subsection surfaces of section geometry. surface record numbering starts from 1.
+
+2D curve number is the number of a 2D curve record from subsection 2D curves of section geometry. 2D curve record numbering starts from 1.
+
+3D polygon number is the number of a 3D polygon record from subsection 3D polygons of section geometry. 3D polygon record numbering starts from 1.
+
+triangulation number is the number of a triangulation record from subsection triangulations of section geometry. triangulation record numbering starts from 1.
+
+polygon on triangulation number is the number of a polygons on triangulations record from subsection polygons on triangulations of section geometry.
+polygons on triangulations record numbering starts from 1.
+
+curve parameter minimal and maximal values @image html brep_wp_image446.gif and @image html brep_wp_image447.gif are the curve parameter@image html brep_wp_image448.gif bounds: @image html brep_wp_image449.gif.
+
+curve values for parameter minimal and maximal values @image html brep_wp_image446.gif and @image html brep_wp_image447.gif are real pairs @image html brep_wp_image450.gif and @image html brep_wp_image451.gif that @image html brep_wp_image452.gif and @image html brep_wp_image453.gif where @image html brep_wp_image205.gif is a parametric equation of the curve.
+
+
+@subsection occt_brep_format_5_2 vertex data
+
+**BNF-like Definition**
+
+@verbatim
+ vertex data = vertex data tolerance _\n vertex data 3D representation _\n vertex data representations;
+
+ vertex data tolerance = real;
+
+ vertex data 3D representation = 3D point;
+
+ vertex data representations = (vertex data representation _\n)* "0 0";
+
+ vertex data representation = vertex data representation u parameter _
+ vertex data representation data _ location number;
+
+ vertex data representation u parameter = real;
+
+ vertex data representation data =
+ ("1" _ vertex data representation data * |
+ ("2" _ vertex data representation data * |
+ ("3" _ vertex data representation data * ;
+
+ vertex data representation data 1 = 3D curve number;
+
+ vertex data representation data 2 = 2D curve number _ surface number;
+
+ vertex data representation data 3 =
+ vertex data representation v parameter _ surface number;
+
+ vertex data representation v parameter = real;
+@endverbatim
+
+**Description**
+
+The usage of vertex data representation u parameter @image html brep_wp_image448.gif is described below.
+
+vertex data representation data 1 and parameter @image html brep_wp_image448.gif describe the position of the vertex @image html brep_wp_image454.gif on a 3D curve @image html brep_wp_image205.gif. Parameter @image html brep_wp_image448.gif is a parameter of the vertex @image html brep_wp_image454.gif on the curve @image html brep_wp_image205.gif: @image html brep_wp_image455.gif.
+
+vertex data representation data 2 and parameter @image html brep_wp_image448.gif describe the position of the vertex @image html brep_wp_image454.gif on a 2D curve @image html brep_wp_image205.gif which is located on a surface. Parameter @image html brep_wp_image448.gif is a parameter of the vertex @image html brep_wp_image454.gif on the curve @image html brep_wp_image205.gif: @image html brep_wp_image455.gif.
+
+vertex data representation data 3 and parameter @image html brep_wp_image435.gif describe the position of the vertex @image html brep_wp_image454.gif on a surface @image html brep_wp_image404.gif through vertex data representation v parameter @image html brep_wp_image456.gif: @image html brep_wp_image457.gif.
+
+vertex data tolerance @image html brep_wp_image458.gif describes the maximum distance from the vertex @image html brep_wp_image454.gif to the set @image html brep_wp_image459.gif* *of vertex @image html brep_wp_image454.gif representations:
+
+@image html brep_wp_image460.gif.
+
+
+@subsection occt_brep_format_5_3 edge data
+
+**BNF-like Definition**
+
+@verbatim
+ edge data = _ edge data tolerance _ edge data same parameter flag _ edge data same range flag _ edge data degenerated flag _\n edge data representations;
+
+ edge data tolerance = real;
+
+ edge data same parameter flag = flag;
+
+ edge data same range flag = flag;
+
+ edge data degenerated flag = flag;
+
+ edge data representations = (edge data representation _\n)* "0";
+
+ edge data representation =
+ "1" _ edge data representation data 1
+ "2" _ edge data representation data 2
+ "3" _ edge data representation data 3
+ "4" _ edge data representation data 4
+ "5" _ edge data representation data 5
+ "6" _ edge data representation data 6
+ "7" _ edge data representation data 7;
+
+ edge data representation data 1 = 3D curve number _ location number _
+ curve parameter minimal and maximal values;
+
+ edge data representation data 2 = 2D curve number _ surface number _ location number _ curve parameter minimal and maximal values
+ [_\n curve values for parameter minimal and maximal values];
+
+ edge data representation data 3 = (2D curve number _) ^ 2 continuity order _ surface number _ location number _ curve parameter minimal and maximal values \n curve values for parameter minimal and maximal values];
+
+ continuity order = "C0" | "C1" | "C2" | "C3" | "CN" | "G1" | "G2".
+
+ edge data representation data 4 =
+ continuity order (_ surface number _ location number) ^ 2;
+
+ edge data representation data 5 = 3D polygon number _ location number;
+
+ edge data representation data 6 =
+ polygon on triangulation number _ triangulation number _ location number;
+
+ edge data representation data 7 = (polygon on triangulation number _) ^ 2 triangulation number _ location number;
+@endverbatim
+
+**Description**
+
+Flags edge data same parameter flag, edge data same range flag and edge data degenerated flag are used in a special way [1].
+
+edge data representation data 1 describes a 3D curve.
+
+edge data representation data 2 describes a 2D curve on a surface.
+curve values for parameter minimal and maximal values are used only in version 2.
+
+edge data representation data 3 describes a 2D curve on a closed surface.
+curve values for parameter minimal and maximal values are used only in version 2.
+
+edge data representation data 5 describes a 3D polyline.
+
+edge data representation data 6 describes a polyline on a triangulation.
+
+edge data tolerance @image html brep_wp_image458.gif describes the maximum distance from the edge @image html brep_wp_image461.gif to the set @image html brep_wp_image459.gif of edge @image html brep_wp_image461.gif representations:
+
+@image html brep_wp_image462.gif.
+
+
+@subsection occt_brep_format_5_4 face data
+
+**BNF-like Definition**
+
+@verbatim
+ face data = face data natural restriction flag _ face data tolerance _ surface number _ location number \n ["2" _ triangulation number];
+
+ face data natural restriction flag = flag;
+
+ face data tolerance = real;
+@endverbatim
+
+**Description**
+
+face data describes a surface @image html brep_wp_image404.gif of face @image html brep_wp_image463.gif and a triangulation @image html brep_wp_image403.gif of face @image html brep_wp_image463.gif. The surface @image html brep_wp_image404.gif may be empty: surface number = 0.
+
+face data tolerance @image html brep_wp_image458.gif describes the maximum distance from the face @image html brep_wp_image463.gif to the surface @image html brep_wp_image404.gif:
+
+@image html brep_wp_image464.gif.
+
+ Flag face data natural restriction flag is used in a special way [1].
+
+@section occt_brep_format_6 References
+
+ The format is part of Open CASCADE Technology (OCCT).
+ Some data fields of the format have additional values which are used in OCCT.
+ Some data fields of the format are specific for OCCT.
+
+@section occt_brep_format_7 Appendix
+
+ This chapter contains a *.brep file example.
+
+@verbatim
+ DBRep_DrawableShape
+
+ CASCADE Topology V1, (c) Matra-Datavision
+ Locations 3
+ 1
+ 0 0 1 0
+ 1 0 0 0
+ 0 1 0 0
+ 1
+ 1 0 0 4
+ 0 1 0 5
+ 0 0 1 6
+ 2 1 1 2 1 0
+ Curve2ds 24
+ 1 0 0 1 0
+ 1 0 0 1 0
+ 1 3 0 0 -1
+ 1 0 0 0 1
+ 1 0 -2 1 0
+ 1 0 0 1 0
+ 1 0 0 0 -1
+ 1 0 0 0 1
+ 1 0 0 1 0
+ 1 0 1 1 0
+ 1 3 0 0 -1
+ 1 1 0 0 1
+ 1 0 -2 1 0
+ 1 0 1 1 0
+ 1 0 0 0 -1
+ 1 1 0 0 1
+ 1 0 0 0 1
+ 1 0 0 1 0
+ 1 3 0 0 1
+ 1 0 0 1 0
+ 1 0 0 0 1
+ 1 0 2 1 0
+ 1 3 0 0 1
+ 1 0 2 1 0
+ Curves 13
+ 1 0 0 0 0 0 1
+ 1 0 0 3 -0 1 0
+ 1 0 2 0 0 0 1
+ 1 0 0 0 -0 1 0
+ 1 1 0 0 0 0 1
+ 1 1 0 3 0 1 0
+ 1 1 2 0 0 0 1
+ 1 1 0 0 -0 1 0
+ 1 0 0 0 1 0 -0
+ 1 0 0 3 1 0 -0
+ 1 0 2 0 1 0 -0
+ 1 0 2 3 1 0 -0
+ 1 1 0 0 1 0 0
+ Polygon3D 1
+ 2 1
+ 0.1
+ 1 0 0 2 0 0
+ 0 1
+ PolygonOnTriangulations 24
+ 2 1 2
+ p 0.1 1 0 3
+ 2 1 4
+ p 0.1 1 0 3
+ 2 2 3
+ p 0.1 1 0 2
+ 2 1 2
+ p 0.1 1 0 2
+ 2 4 3
+ p 0.1 1 0 3
+ 2 1 4
+ p 0.1 1 0 3
+ 2 1 4
+ p 0.1 1 0 2
+ 2 1 2
+ p 0.1 1 0 2
+ 2 1 2
+ p 0.1 1 0 3
+ 2 2 3
+ p 0.1 1 0 3
+ 2 2 3
+ p 0.1 1 0 2
+ 2 4 3
+ p 0.1 1 0 2
+ 2 4 3
+ p 0.1 1 0 3
+ 2 2 3
+ p 0.1 1 0 3
+ 2 1 4
+ p 0.1 1 0 2
+ 2 4 3
+ p 0.1 1 0 2
+ 2 1 2
+ p 0.1 1 0 1
+ 2 1 4
+ p 0.1 1 0 1
+ 2 4 3
+ p 0.1 1 0 1
+ 2 1 4
+ p 0.1 1 0 1
+ 2 1 2
+ p 0.1 1 0 1
+ 2 2 3
+ p 0.1 1 0 1
+ 2 4 3
+ p 0.1 1 0 1
+ 2 2 3
+ p 0.1 1 0 1
+ Surfaces 6
+ 1 0 0 0 1 0 -0 0 0 1 0 -1 0
+ 1 0 0 0 -0 1 0 0 0 1 1 0 -0
+ 1 0 0 3 0 0 1 1 0 -0 -0 1 0
+ 1 0 2 0 -0 1 0 0 0 1 1 0 -0
+ 1 0 0 0 0 0 1 1 0 -0 -0 1 0
+ 1 1 0 0 1 0 -0 0 0 1 0 -1 0
+ Triangulations 6
+ 4 2 1 0
+ 0 0 0 0 0 3 0 2 3 0 2 0 0 0 3 0 3 -2 0 -2 2 4 3 2 1 4
+ 4 2 1 0
+ 0 0 0 1 0 0 1 0 3 0 0 3 0 0 0 1 3 1 3 0 3 2 1 3 1 4
+ 4 2 1 0
+ 0 0 3 0 2 3 1 2 3 1 0 3 0 0 0 2 1 2 1 0 3 2 1 3 1 4
+ 4 2 1 0
+ 0 2 0 1 2 0 1 2 3 0 2 3 0 0 0 1 3 1 3 0 3 2 1 3 1 4
+ 4 2 1 0
+ 0 0 0 0 2 0 1 2 0 1 0 0 0 0 0 2 1 2 1 0 3 2 1 3 1 4
+ 4 2 1 0
+ 1 0 0 1 0 3 1 2 3 1 2 0 0 0 3 0 3 -2 0 -2 2 4 3 2 1 4
+
+ TShapes 39
+ Ve
+ 1e-007
+ 0 0 3
+ 0 0
+
+ 0101101
+ *
+ Ve
+ 1e-007
+ 0 0 0
+ 0 0
+
+ 0101101
+ *
+ Ed
+ 1e-007 1 1 0
+ 1 1 0 0 3
+ 2 1 1 0 0 3
+ 2 2 2 0 0 3
+ 6 1 1 0
+ 6 2 2 0
+ 0
+
+ 0101000
+ -39 0 +38 0 *
+ Ve
+ 1e-007
+ 0 2 3
+ 0 0
+
+ 0101101
+ *
+ Ed
+ 1e-007 1 1 0
+ 1 2 0 0 2
+ 2 3 1 0 0 2
+ 2 4 3 0 0 2
+ 6 3 1 0
+ 6 4 3 0
+ 0
+
+ 0101000
+ -36 0 +39 0 *
+ Ve
+ 1e-007
+ 0 2 0
+ 0 0
+
+ 0101101
+ *
+ Ed
+ 1e-007 1 1 0
+ 1 3 0 0 3
+ 2 5 1 0 0 3
+ 2 6 4 0 0 3
+ 6 5 1 0
+ 6 6 4 0
+ 0
+
+ 0101000
+ -36 0 +34 0 *
+ Ed
+ 1e-007 1 1 0
+ 1 4 0 0 2
+ 2 7 1 0 0 2
+ 2 8 5 0 0 2
+ 6 7 1 0
+ 6 8 5 0
+ 0
+
+ 0101000
+ -34 0 +38 0 *
+ Wi
+
+ 0101000
+ -37 0 -35 0 +33 0 +32 0 *
+ Fa
+ 0 1e-007 1 0
+ 2 1
+ 0101000
+ +31 0 *
+ Ve
+ 1e-007
+ 1 0 3
+ 0 0
+
+ 0101101
+ *
+ Ve
+ 1e-007
+ 1 0 0
+ 0 0
+
+ 0101101
+ *
+ Ed
+ 1e-007 1 1 0
+ 1 5 0 0 3
+ 2 9 6 0 0 3
+ 2 10 2 0 0 3
+ 6 9 6 0
+ 6 10 2 0
+ 0
+
+ 0101000
+ -29 0 +28 0 *
+ Ve
+ 1e-007
+ 1 2 3
+ 0 0
+
+ 0101101
+ *
+ Ed
+ 1e-007 1 1 0
+ 1 6 0 0 2
+ 2 11 6 0 0 2
+ 2 12 3 0 0 2
+ 6 11 6 0
+ 6 12 3 0
+ 0
+
+ 0101000
+ -26 0 +29 0 *
+ Ve
+ 1e-007
+ 1 2 0
+ 0 0
+
+ 0101101
+ *
+ Ed
+ 1e-007 1 1 0
+ 1 7 0 0 3
+ 2 13 6 0 0 3
+ 2 14 4 0 0 3
+ 6 13 6 0
+ 6 14 4 0
+ 0
+
+ 0101000
+ -26 0 +24 0 *
+ Ed
+ 1e-007 1 1 0
+ 1 8 0 0 2
+ 2 15 6 0 0 2
+ 2 16 5 0 0 2
+ 6 15 6 0
+ 6 16 5 0
+ 0
+
+ 0101000
+ -24 0 +28 0 *
+ Wi
+
+ 0101000
+ -27 0 -25 0 +23 0 +22 0 *
+ Fa
+ 0 1e-007 6 0
+ 2 6
+ 0101000
+ +21 0 *
+ Ed
+ 1e-007 1 1 0
+ 1 9 0 0 1
+ 2 17 2 0 0 1
+ 2 18 5 0 0 1
+ 6 17 2 0
+ 6 18 5 0
+ 0
+
+ 0101000
+ -28 0 +38 0 *
+ Ed
+ 1e-007 1 1 0
+ 1 10 0 0 1
+ 2 19 2 0 0 1
+ 2 20 3 0 0 1
+ 6 19 2 0
+ 6 20 3 0
+ 0
+
+ 0101000
+ -29 0 +39 0 *
+ Wi
+
+ 0101000
+ -19 0 -27 0 +18 0 +37 0 *
+ Fa
+ 0 1e-007 2 0
+ 2 2
+ 0101000
+ +17 0 *
+ Ed
+ 1e-007 1 1 0
+ 1 11 0 0 1
+ 2 21 4 0 0 1
+ 2 22 5 0 0 1
+ 6 21 4 0
+ 6 22 5 0
+ 0
+
+ 0101000
+ -24 0 +34 0 *
+ Ed
+ 1e-007 1 1 0
+ 1 12 0 0 1
+ 2 23 4 0 0 1
+ 2 24 3 0 0 1
+ 6 23 4 0
+ 6 24 3 0
+ 0
+
+ 0101000
+ -26 0 +36 0 *
+ Wi
+
+ 0101000
+ -15 0 -23 0 +14 0 +33 0 *
+ Fa
+ 0 1e-007 4 0
+ 2 4
+ 0101000
+ +13 0 *
+ Wi
+
+ 0101000
+ -32 0 -15 0 +22 0 +19 0 *
+ Fa
+ 0 1e-007 5 0
+ 2 5
+ 0101000
+ +11 0 *
+ Wi
+
+ 0101000
+ -35 0 -14 0 +25 0 +18 0 *
+ Fa
+ 0 1e-007 3 0
+ 2 3
+ 0101000
+ +9 0 *
+ Sh
+
+ 0101100
+ -30 0 +20 0 -16 0 +12 0 -10 0 +8 0 *
+ So
+
+ 0100000
+ +7 0 *
+ CS
+
+ 0101000
+ +6 3 *
+ Ve
+ 1e-007
+ 1 0 0
+ 0 0
+
+ 0101101
+ *
+ Ve
+ 1e-007
+ 2 0 0
+ 0 0
+
+ 0101101
+ *
+ Ed
+ 1e-007 1 1 0
+ 1 13 0 0 1
+ 5 1 0
+ 0
+
+ 0101000
+ +4 0 -3 0 *
+ Co
+
+ 1100000
+ +5 0 +2 0 *
+
+ +1 0
+ 0
+@endverbatim
\ No newline at end of file
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image003.gif b/dox/user_guides/brep_wp/images/brep_wp_image003.gif
new file mode 100644
index 0000000000..4904e8ae6f
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image003.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image004.gif b/dox/user_guides/brep_wp/images/brep_wp_image004.gif
new file mode 100644
index 0000000000..e0887f65e3
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image004.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image005.gif b/dox/user_guides/brep_wp/images/brep_wp_image005.gif
new file mode 100644
index 0000000000..e26aad3478
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image005.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image006.gif b/dox/user_guides/brep_wp/images/brep_wp_image006.gif
new file mode 100644
index 0000000000..36bb2d68c1
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image006.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image007.gif b/dox/user_guides/brep_wp/images/brep_wp_image007.gif
new file mode 100644
index 0000000000..61e6743951
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image007.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image008.gif b/dox/user_guides/brep_wp/images/brep_wp_image008.gif
new file mode 100644
index 0000000000..167d290c4a
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image008.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image009.gif b/dox/user_guides/brep_wp/images/brep_wp_image009.gif
new file mode 100644
index 0000000000..c4ae9d4431
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image009.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image010.gif b/dox/user_guides/brep_wp/images/brep_wp_image010.gif
new file mode 100644
index 0000000000..432acf7c7b
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image010.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image011.gif b/dox/user_guides/brep_wp/images/brep_wp_image011.gif
new file mode 100644
index 0000000000..103b6fa22f
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image011.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image012.gif b/dox/user_guides/brep_wp/images/brep_wp_image012.gif
new file mode 100644
index 0000000000..e15c45d852
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image012.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image013.gif b/dox/user_guides/brep_wp/images/brep_wp_image013.gif
new file mode 100644
index 0000000000..79ffd6995b
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image013.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image014.gif b/dox/user_guides/brep_wp/images/brep_wp_image014.gif
new file mode 100644
index 0000000000..6bfa8c09cc
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image014.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image015.gif b/dox/user_guides/brep_wp/images/brep_wp_image015.gif
new file mode 100644
index 0000000000..e48e03bb57
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image015.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image016.gif b/dox/user_guides/brep_wp/images/brep_wp_image016.gif
new file mode 100644
index 0000000000..dd24febffd
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image016.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image017.gif b/dox/user_guides/brep_wp/images/brep_wp_image017.gif
new file mode 100644
index 0000000000..0f56ea1ec4
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image017.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image018.gif b/dox/user_guides/brep_wp/images/brep_wp_image018.gif
new file mode 100644
index 0000000000..30b8c65164
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image018.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image019.gif b/dox/user_guides/brep_wp/images/brep_wp_image019.gif
new file mode 100644
index 0000000000..5de35fd6db
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image019.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image020.gif b/dox/user_guides/brep_wp/images/brep_wp_image020.gif
new file mode 100644
index 0000000000..6db267fb64
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image020.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image021.gif b/dox/user_guides/brep_wp/images/brep_wp_image021.gif
new file mode 100644
index 0000000000..8c067a6009
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image021.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image022.gif b/dox/user_guides/brep_wp/images/brep_wp_image022.gif
new file mode 100644
index 0000000000..e141d28b7a
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image022.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image023.gif b/dox/user_guides/brep_wp/images/brep_wp_image023.gif
new file mode 100644
index 0000000000..9ddc5bba7d
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image023.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image024.gif b/dox/user_guides/brep_wp/images/brep_wp_image024.gif
new file mode 100644
index 0000000000..af04679239
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image024.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image025.gif b/dox/user_guides/brep_wp/images/brep_wp_image025.gif
new file mode 100644
index 0000000000..1733b5ea64
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image025.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image026.gif b/dox/user_guides/brep_wp/images/brep_wp_image026.gif
new file mode 100644
index 0000000000..f9666a2c07
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image026.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image027.gif b/dox/user_guides/brep_wp/images/brep_wp_image027.gif
new file mode 100644
index 0000000000..7d38cd9344
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image027.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image028.gif b/dox/user_guides/brep_wp/images/brep_wp_image028.gif
new file mode 100644
index 0000000000..37c70d66e5
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image028.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image029.gif b/dox/user_guides/brep_wp/images/brep_wp_image029.gif
new file mode 100644
index 0000000000..0c7e8260e4
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image029.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image030.gif b/dox/user_guides/brep_wp/images/brep_wp_image030.gif
new file mode 100644
index 0000000000..dcf9078a71
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image030.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image031.gif b/dox/user_guides/brep_wp/images/brep_wp_image031.gif
new file mode 100644
index 0000000000..8eec53e2ee
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image031.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image032.gif b/dox/user_guides/brep_wp/images/brep_wp_image032.gif
new file mode 100644
index 0000000000..aa6ae3bc24
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image032.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image033.gif b/dox/user_guides/brep_wp/images/brep_wp_image033.gif
new file mode 100644
index 0000000000..089c2373e5
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image033.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image034.gif b/dox/user_guides/brep_wp/images/brep_wp_image034.gif
new file mode 100644
index 0000000000..4b34751275
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image034.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image035.gif b/dox/user_guides/brep_wp/images/brep_wp_image035.gif
new file mode 100644
index 0000000000..f697b7bbae
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image035.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image036.gif b/dox/user_guides/brep_wp/images/brep_wp_image036.gif
new file mode 100644
index 0000000000..6d630b269b
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image036.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image037.gif b/dox/user_guides/brep_wp/images/brep_wp_image037.gif
new file mode 100644
index 0000000000..d11f90565c
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image037.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image038.gif b/dox/user_guides/brep_wp/images/brep_wp_image038.gif
new file mode 100644
index 0000000000..e5e7f242fb
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image038.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image039.gif b/dox/user_guides/brep_wp/images/brep_wp_image039.gif
new file mode 100644
index 0000000000..e158bc4e42
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image039.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image040.gif b/dox/user_guides/brep_wp/images/brep_wp_image040.gif
new file mode 100644
index 0000000000..fd4cd1e778
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image040.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image041.gif b/dox/user_guides/brep_wp/images/brep_wp_image041.gif
new file mode 100644
index 0000000000..f08fd4d5cc
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image041.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image042.gif b/dox/user_guides/brep_wp/images/brep_wp_image042.gif
new file mode 100644
index 0000000000..48886178de
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image042.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image043.gif b/dox/user_guides/brep_wp/images/brep_wp_image043.gif
new file mode 100644
index 0000000000..c0e004ca88
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image043.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image044.gif b/dox/user_guides/brep_wp/images/brep_wp_image044.gif
new file mode 100644
index 0000000000..fb7c768672
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image044.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image045.gif b/dox/user_guides/brep_wp/images/brep_wp_image045.gif
new file mode 100644
index 0000000000..3b6396c9ef
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image045.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image046.gif b/dox/user_guides/brep_wp/images/brep_wp_image046.gif
new file mode 100644
index 0000000000..14c608e127
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image046.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image047.gif b/dox/user_guides/brep_wp/images/brep_wp_image047.gif
new file mode 100644
index 0000000000..8daced138a
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image047.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image048.gif b/dox/user_guides/brep_wp/images/brep_wp_image048.gif
new file mode 100644
index 0000000000..55dbdd570b
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image048.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image049.gif b/dox/user_guides/brep_wp/images/brep_wp_image049.gif
new file mode 100644
index 0000000000..2dcbb7bcd1
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image049.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image050.gif b/dox/user_guides/brep_wp/images/brep_wp_image050.gif
new file mode 100644
index 0000000000..d586fad5d0
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image050.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image051.gif b/dox/user_guides/brep_wp/images/brep_wp_image051.gif
new file mode 100644
index 0000000000..767b1e210e
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image051.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image052.gif b/dox/user_guides/brep_wp/images/brep_wp_image052.gif
new file mode 100644
index 0000000000..eb35ac0941
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image052.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image053.gif b/dox/user_guides/brep_wp/images/brep_wp_image053.gif
new file mode 100644
index 0000000000..0aa8f81cdb
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image053.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image054.gif b/dox/user_guides/brep_wp/images/brep_wp_image054.gif
new file mode 100644
index 0000000000..86afbae2b5
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image054.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image055.gif b/dox/user_guides/brep_wp/images/brep_wp_image055.gif
new file mode 100644
index 0000000000..ccfc77d3e3
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image055.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image056.gif b/dox/user_guides/brep_wp/images/brep_wp_image056.gif
new file mode 100644
index 0000000000..2ce1a563a1
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image056.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image057.gif b/dox/user_guides/brep_wp/images/brep_wp_image057.gif
new file mode 100644
index 0000000000..246f27d82c
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image057.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image058.gif b/dox/user_guides/brep_wp/images/brep_wp_image058.gif
new file mode 100644
index 0000000000..ca27a0ebc1
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image058.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image059.gif b/dox/user_guides/brep_wp/images/brep_wp_image059.gif
new file mode 100644
index 0000000000..423f48f29e
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image059.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image060.gif b/dox/user_guides/brep_wp/images/brep_wp_image060.gif
new file mode 100644
index 0000000000..170ec57c02
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image060.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image061.gif b/dox/user_guides/brep_wp/images/brep_wp_image061.gif
new file mode 100644
index 0000000000..afb6b1a78b
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image061.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image062.gif b/dox/user_guides/brep_wp/images/brep_wp_image062.gif
new file mode 100644
index 0000000000..4ecf7c8ce8
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image062.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image063.gif b/dox/user_guides/brep_wp/images/brep_wp_image063.gif
new file mode 100644
index 0000000000..352fc0164e
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image063.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image064.gif b/dox/user_guides/brep_wp/images/brep_wp_image064.gif
new file mode 100644
index 0000000000..7ccd175cbf
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image064.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image065.gif b/dox/user_guides/brep_wp/images/brep_wp_image065.gif
new file mode 100644
index 0000000000..4c19057598
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image065.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image066.gif b/dox/user_guides/brep_wp/images/brep_wp_image066.gif
new file mode 100644
index 0000000000..a4f990e0e2
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image066.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image067.gif b/dox/user_guides/brep_wp/images/brep_wp_image067.gif
new file mode 100644
index 0000000000..341bcf7f92
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image067.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image068.gif b/dox/user_guides/brep_wp/images/brep_wp_image068.gif
new file mode 100644
index 0000000000..c66622a8ae
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image068.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image069.gif b/dox/user_guides/brep_wp/images/brep_wp_image069.gif
new file mode 100644
index 0000000000..cf4b15c526
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image069.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image070.gif b/dox/user_guides/brep_wp/images/brep_wp_image070.gif
new file mode 100644
index 0000000000..b6d310af0b
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image070.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image071.gif b/dox/user_guides/brep_wp/images/brep_wp_image071.gif
new file mode 100644
index 0000000000..fe6af2531c
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image071.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image072.gif b/dox/user_guides/brep_wp/images/brep_wp_image072.gif
new file mode 100644
index 0000000000..13cafcd182
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image072.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image073.gif b/dox/user_guides/brep_wp/images/brep_wp_image073.gif
new file mode 100644
index 0000000000..8c85b26eb5
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image073.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image074.gif b/dox/user_guides/brep_wp/images/brep_wp_image074.gif
new file mode 100644
index 0000000000..c8738b8cbe
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image074.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image075.gif b/dox/user_guides/brep_wp/images/brep_wp_image075.gif
new file mode 100644
index 0000000000..c03e0ea236
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image075.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image076.gif b/dox/user_guides/brep_wp/images/brep_wp_image076.gif
new file mode 100644
index 0000000000..9be8a7c59b
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image076.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image077.gif b/dox/user_guides/brep_wp/images/brep_wp_image077.gif
new file mode 100644
index 0000000000..d889dd505c
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image077.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image078.gif b/dox/user_guides/brep_wp/images/brep_wp_image078.gif
new file mode 100644
index 0000000000..f28a9ff32f
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image078.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image079.gif b/dox/user_guides/brep_wp/images/brep_wp_image079.gif
new file mode 100644
index 0000000000..2b61bd2136
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image079.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image080.gif b/dox/user_guides/brep_wp/images/brep_wp_image080.gif
new file mode 100644
index 0000000000..bc5ae3b745
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image080.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image081.gif b/dox/user_guides/brep_wp/images/brep_wp_image081.gif
new file mode 100644
index 0000000000..b30936c004
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image081.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image082.gif b/dox/user_guides/brep_wp/images/brep_wp_image082.gif
new file mode 100644
index 0000000000..c837cd560a
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image082.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image083.gif b/dox/user_guides/brep_wp/images/brep_wp_image083.gif
new file mode 100644
index 0000000000..21a8376be0
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image083.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image084.gif b/dox/user_guides/brep_wp/images/brep_wp_image084.gif
new file mode 100644
index 0000000000..809d0fb0e4
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image084.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image085.gif b/dox/user_guides/brep_wp/images/brep_wp_image085.gif
new file mode 100644
index 0000000000..62c4ab0460
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image085.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image086.gif b/dox/user_guides/brep_wp/images/brep_wp_image086.gif
new file mode 100644
index 0000000000..8118667a67
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image086.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image087.gif b/dox/user_guides/brep_wp/images/brep_wp_image087.gif
new file mode 100644
index 0000000000..c6cbda409f
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image087.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image088.gif b/dox/user_guides/brep_wp/images/brep_wp_image088.gif
new file mode 100644
index 0000000000..b99d4ec8f8
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image088.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image089.gif b/dox/user_guides/brep_wp/images/brep_wp_image089.gif
new file mode 100644
index 0000000000..e8555ef282
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image089.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image090.gif b/dox/user_guides/brep_wp/images/brep_wp_image090.gif
new file mode 100644
index 0000000000..ba92415066
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image090.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image091.gif b/dox/user_guides/brep_wp/images/brep_wp_image091.gif
new file mode 100644
index 0000000000..d9be2eda1e
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image091.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image092.gif b/dox/user_guides/brep_wp/images/brep_wp_image092.gif
new file mode 100644
index 0000000000..16a455edbe
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image092.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image093.gif b/dox/user_guides/brep_wp/images/brep_wp_image093.gif
new file mode 100644
index 0000000000..f219445c05
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image093.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image094.gif b/dox/user_guides/brep_wp/images/brep_wp_image094.gif
new file mode 100644
index 0000000000..e55ee5915a
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image094.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image095.gif b/dox/user_guides/brep_wp/images/brep_wp_image095.gif
new file mode 100644
index 0000000000..37e1bc7f78
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image095.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image096.gif b/dox/user_guides/brep_wp/images/brep_wp_image096.gif
new file mode 100644
index 0000000000..d62c7fa1c2
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image096.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image097.gif b/dox/user_guides/brep_wp/images/brep_wp_image097.gif
new file mode 100644
index 0000000000..2dc04d3d40
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image097.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image098.gif b/dox/user_guides/brep_wp/images/brep_wp_image098.gif
new file mode 100644
index 0000000000..6b60f011f3
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image098.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image099.gif b/dox/user_guides/brep_wp/images/brep_wp_image099.gif
new file mode 100644
index 0000000000..d2c3e81c5a
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image099.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image100.gif b/dox/user_guides/brep_wp/images/brep_wp_image100.gif
new file mode 100644
index 0000000000..8249688215
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image100.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image101.gif b/dox/user_guides/brep_wp/images/brep_wp_image101.gif
new file mode 100644
index 0000000000..4261ad1e49
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image101.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image102.gif b/dox/user_guides/brep_wp/images/brep_wp_image102.gif
new file mode 100644
index 0000000000..3165884692
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image102.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image103.gif b/dox/user_guides/brep_wp/images/brep_wp_image103.gif
new file mode 100644
index 0000000000..ff875bc452
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image103.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image104.gif b/dox/user_guides/brep_wp/images/brep_wp_image104.gif
new file mode 100644
index 0000000000..d3a40f306f
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image104.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image105.gif b/dox/user_guides/brep_wp/images/brep_wp_image105.gif
new file mode 100644
index 0000000000..2a5c64e53b
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image105.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image106.gif b/dox/user_guides/brep_wp/images/brep_wp_image106.gif
new file mode 100644
index 0000000000..1c6d0e355f
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image106.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image107.gif b/dox/user_guides/brep_wp/images/brep_wp_image107.gif
new file mode 100644
index 0000000000..3f5fed97d6
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image107.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image108.gif b/dox/user_guides/brep_wp/images/brep_wp_image108.gif
new file mode 100644
index 0000000000..e7aa928d3f
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image108.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image109.gif b/dox/user_guides/brep_wp/images/brep_wp_image109.gif
new file mode 100644
index 0000000000..26827bf94a
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image109.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image110.gif b/dox/user_guides/brep_wp/images/brep_wp_image110.gif
new file mode 100644
index 0000000000..1bbf5ca7be
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image110.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image111.gif b/dox/user_guides/brep_wp/images/brep_wp_image111.gif
new file mode 100644
index 0000000000..961997b19e
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image111.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image112.gif b/dox/user_guides/brep_wp/images/brep_wp_image112.gif
new file mode 100644
index 0000000000..e5d4c71b80
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image112.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image113.gif b/dox/user_guides/brep_wp/images/brep_wp_image113.gif
new file mode 100644
index 0000000000..b1bcdcb11f
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image113.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image114.gif b/dox/user_guides/brep_wp/images/brep_wp_image114.gif
new file mode 100644
index 0000000000..d77290cd48
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image114.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image115.gif b/dox/user_guides/brep_wp/images/brep_wp_image115.gif
new file mode 100644
index 0000000000..0bb9b4190a
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image115.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image116.gif b/dox/user_guides/brep_wp/images/brep_wp_image116.gif
new file mode 100644
index 0000000000..6448835d84
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image116.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image117.gif b/dox/user_guides/brep_wp/images/brep_wp_image117.gif
new file mode 100644
index 0000000000..9167eaf576
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image117.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image118.gif b/dox/user_guides/brep_wp/images/brep_wp_image118.gif
new file mode 100644
index 0000000000..22b0eb0110
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image118.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image119.gif b/dox/user_guides/brep_wp/images/brep_wp_image119.gif
new file mode 100644
index 0000000000..9c42fecdd3
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image119.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image120.gif b/dox/user_guides/brep_wp/images/brep_wp_image120.gif
new file mode 100644
index 0000000000..e68cc5b642
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image120.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image121.gif b/dox/user_guides/brep_wp/images/brep_wp_image121.gif
new file mode 100644
index 0000000000..ef52134258
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image121.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image122.gif b/dox/user_guides/brep_wp/images/brep_wp_image122.gif
new file mode 100644
index 0000000000..5f66c94f2d
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image122.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image123.gif b/dox/user_guides/brep_wp/images/brep_wp_image123.gif
new file mode 100644
index 0000000000..1ea40353a9
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image123.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image124.gif b/dox/user_guides/brep_wp/images/brep_wp_image124.gif
new file mode 100644
index 0000000000..29313688bf
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image124.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image125.gif b/dox/user_guides/brep_wp/images/brep_wp_image125.gif
new file mode 100644
index 0000000000..a5e0375fa3
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image125.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image126.gif b/dox/user_guides/brep_wp/images/brep_wp_image126.gif
new file mode 100644
index 0000000000..96e0be12ad
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image126.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image127.gif b/dox/user_guides/brep_wp/images/brep_wp_image127.gif
new file mode 100644
index 0000000000..e6fe57769c
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image127.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image128.gif b/dox/user_guides/brep_wp/images/brep_wp_image128.gif
new file mode 100644
index 0000000000..f80bf20fe2
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image128.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image129.gif b/dox/user_guides/brep_wp/images/brep_wp_image129.gif
new file mode 100644
index 0000000000..4ff8e09c44
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image129.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image130.gif b/dox/user_guides/brep_wp/images/brep_wp_image130.gif
new file mode 100644
index 0000000000..7d45b7eb93
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image130.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image131.gif b/dox/user_guides/brep_wp/images/brep_wp_image131.gif
new file mode 100644
index 0000000000..001a1f2c04
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image131.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image132.gif b/dox/user_guides/brep_wp/images/brep_wp_image132.gif
new file mode 100644
index 0000000000..e9e8bd073f
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image132.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image133.gif b/dox/user_guides/brep_wp/images/brep_wp_image133.gif
new file mode 100644
index 0000000000..71a719ca12
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image133.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image134.gif b/dox/user_guides/brep_wp/images/brep_wp_image134.gif
new file mode 100644
index 0000000000..28446dec7e
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image134.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image135.gif b/dox/user_guides/brep_wp/images/brep_wp_image135.gif
new file mode 100644
index 0000000000..399b853c41
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image135.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image136.gif b/dox/user_guides/brep_wp/images/brep_wp_image136.gif
new file mode 100644
index 0000000000..ef9c89a7a5
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image136.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image137.gif b/dox/user_guides/brep_wp/images/brep_wp_image137.gif
new file mode 100644
index 0000000000..e49604efdb
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image137.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image138.gif b/dox/user_guides/brep_wp/images/brep_wp_image138.gif
new file mode 100644
index 0000000000..9e2b49409e
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image138.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image139.gif b/dox/user_guides/brep_wp/images/brep_wp_image139.gif
new file mode 100644
index 0000000000..8e9def62b2
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image139.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image140.gif b/dox/user_guides/brep_wp/images/brep_wp_image140.gif
new file mode 100644
index 0000000000..1633fcd794
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image140.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image141.gif b/dox/user_guides/brep_wp/images/brep_wp_image141.gif
new file mode 100644
index 0000000000..87235f2d51
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image141.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image142.gif b/dox/user_guides/brep_wp/images/brep_wp_image142.gif
new file mode 100644
index 0000000000..dbbfd6ce19
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image142.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image143.gif b/dox/user_guides/brep_wp/images/brep_wp_image143.gif
new file mode 100644
index 0000000000..65ba219213
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image143.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image144.gif b/dox/user_guides/brep_wp/images/brep_wp_image144.gif
new file mode 100644
index 0000000000..816202d4eb
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image144.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image145.gif b/dox/user_guides/brep_wp/images/brep_wp_image145.gif
new file mode 100644
index 0000000000..2a78698942
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image145.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image146.gif b/dox/user_guides/brep_wp/images/brep_wp_image146.gif
new file mode 100644
index 0000000000..de1cbbb365
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image146.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image147.gif b/dox/user_guides/brep_wp/images/brep_wp_image147.gif
new file mode 100644
index 0000000000..2b5e008546
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image147.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image148.gif b/dox/user_guides/brep_wp/images/brep_wp_image148.gif
new file mode 100644
index 0000000000..0f1b8f55cd
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image148.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image149.gif b/dox/user_guides/brep_wp/images/brep_wp_image149.gif
new file mode 100644
index 0000000000..5642fd293f
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image149.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image150.gif b/dox/user_guides/brep_wp/images/brep_wp_image150.gif
new file mode 100644
index 0000000000..235582b007
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image150.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image151.gif b/dox/user_guides/brep_wp/images/brep_wp_image151.gif
new file mode 100644
index 0000000000..2c77f842c1
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image151.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image152.gif b/dox/user_guides/brep_wp/images/brep_wp_image152.gif
new file mode 100644
index 0000000000..6bf99fd2d3
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image152.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image153.gif b/dox/user_guides/brep_wp/images/brep_wp_image153.gif
new file mode 100644
index 0000000000..04da828135
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image153.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image154.gif b/dox/user_guides/brep_wp/images/brep_wp_image154.gif
new file mode 100644
index 0000000000..1af9fdb276
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image154.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image155.gif b/dox/user_guides/brep_wp/images/brep_wp_image155.gif
new file mode 100644
index 0000000000..8a0f2e7e0f
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image155.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image156.gif b/dox/user_guides/brep_wp/images/brep_wp_image156.gif
new file mode 100644
index 0000000000..ec29521345
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image156.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image157.gif b/dox/user_guides/brep_wp/images/brep_wp_image157.gif
new file mode 100644
index 0000000000..a14f5327cd
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image157.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image158.gif b/dox/user_guides/brep_wp/images/brep_wp_image158.gif
new file mode 100644
index 0000000000..fc5ef41623
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image158.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image159.gif b/dox/user_guides/brep_wp/images/brep_wp_image159.gif
new file mode 100644
index 0000000000..8bacc99d6f
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image159.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image160.gif b/dox/user_guides/brep_wp/images/brep_wp_image160.gif
new file mode 100644
index 0000000000..efe443ca15
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image160.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image161.gif b/dox/user_guides/brep_wp/images/brep_wp_image161.gif
new file mode 100644
index 0000000000..8f45cfb067
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image161.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image162.gif b/dox/user_guides/brep_wp/images/brep_wp_image162.gif
new file mode 100644
index 0000000000..2d4f5901d0
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image162.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image163.gif b/dox/user_guides/brep_wp/images/brep_wp_image163.gif
new file mode 100644
index 0000000000..8d2211a76a
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image163.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image164.gif b/dox/user_guides/brep_wp/images/brep_wp_image164.gif
new file mode 100644
index 0000000000..6edd64d00f
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image164.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image165.gif b/dox/user_guides/brep_wp/images/brep_wp_image165.gif
new file mode 100644
index 0000000000..fb6493f554
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image165.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image166.gif b/dox/user_guides/brep_wp/images/brep_wp_image166.gif
new file mode 100644
index 0000000000..96cfd054e4
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image166.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image167.gif b/dox/user_guides/brep_wp/images/brep_wp_image167.gif
new file mode 100644
index 0000000000..55e706bb11
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image167.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image168.gif b/dox/user_guides/brep_wp/images/brep_wp_image168.gif
new file mode 100644
index 0000000000..4399a6b2ab
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image168.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image169.gif b/dox/user_guides/brep_wp/images/brep_wp_image169.gif
new file mode 100644
index 0000000000..ebbcfca112
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image169.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image170.gif b/dox/user_guides/brep_wp/images/brep_wp_image170.gif
new file mode 100644
index 0000000000..2525ecca95
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image170.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image171.gif b/dox/user_guides/brep_wp/images/brep_wp_image171.gif
new file mode 100644
index 0000000000..24b6b70034
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image171.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image172.gif b/dox/user_guides/brep_wp/images/brep_wp_image172.gif
new file mode 100644
index 0000000000..a054917e51
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image172.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image173.gif b/dox/user_guides/brep_wp/images/brep_wp_image173.gif
new file mode 100644
index 0000000000..e9527fe6c8
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image173.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image174.gif b/dox/user_guides/brep_wp/images/brep_wp_image174.gif
new file mode 100644
index 0000000000..f6e939d033
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image174.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image175.gif b/dox/user_guides/brep_wp/images/brep_wp_image175.gif
new file mode 100644
index 0000000000..dbe89a6e24
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image175.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image176.gif b/dox/user_guides/brep_wp/images/brep_wp_image176.gif
new file mode 100644
index 0000000000..1eed5a1950
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image176.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image177.gif b/dox/user_guides/brep_wp/images/brep_wp_image177.gif
new file mode 100644
index 0000000000..86d8bed6ff
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image177.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image178.gif b/dox/user_guides/brep_wp/images/brep_wp_image178.gif
new file mode 100644
index 0000000000..e4de25f5ca
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image178.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image179.gif b/dox/user_guides/brep_wp/images/brep_wp_image179.gif
new file mode 100644
index 0000000000..9711b7a5dc
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image179.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image180.gif b/dox/user_guides/brep_wp/images/brep_wp_image180.gif
new file mode 100644
index 0000000000..614c50a6b6
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image180.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image181.gif b/dox/user_guides/brep_wp/images/brep_wp_image181.gif
new file mode 100644
index 0000000000..94eab9b6bb
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image181.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image182.gif b/dox/user_guides/brep_wp/images/brep_wp_image182.gif
new file mode 100644
index 0000000000..260634a856
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image182.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image183.gif b/dox/user_guides/brep_wp/images/brep_wp_image183.gif
new file mode 100644
index 0000000000..ca794818ad
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image183.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image184.gif b/dox/user_guides/brep_wp/images/brep_wp_image184.gif
new file mode 100644
index 0000000000..4d65ca3c9c
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image184.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image185.gif b/dox/user_guides/brep_wp/images/brep_wp_image185.gif
new file mode 100644
index 0000000000..052217cf39
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image185.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image186.gif b/dox/user_guides/brep_wp/images/brep_wp_image186.gif
new file mode 100644
index 0000000000..42493cb841
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image186.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image187.gif b/dox/user_guides/brep_wp/images/brep_wp_image187.gif
new file mode 100644
index 0000000000..7c8c6bac03
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image187.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image188.gif b/dox/user_guides/brep_wp/images/brep_wp_image188.gif
new file mode 100644
index 0000000000..d400ff17fa
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image188.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image189.gif b/dox/user_guides/brep_wp/images/brep_wp_image189.gif
new file mode 100644
index 0000000000..8872f68d87
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image189.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image190.gif b/dox/user_guides/brep_wp/images/brep_wp_image190.gif
new file mode 100644
index 0000000000..32c5c1f6ec
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image190.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image191.gif b/dox/user_guides/brep_wp/images/brep_wp_image191.gif
new file mode 100644
index 0000000000..7fca6fadbf
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image191.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image192.gif b/dox/user_guides/brep_wp/images/brep_wp_image192.gif
new file mode 100644
index 0000000000..c3f92576c1
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image192.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image193.gif b/dox/user_guides/brep_wp/images/brep_wp_image193.gif
new file mode 100644
index 0000000000..cb333f234b
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image193.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image194.gif b/dox/user_guides/brep_wp/images/brep_wp_image194.gif
new file mode 100644
index 0000000000..6a6e09e382
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image194.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image195.gif b/dox/user_guides/brep_wp/images/brep_wp_image195.gif
new file mode 100644
index 0000000000..1a63ddf922
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image195.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image196.gif b/dox/user_guides/brep_wp/images/brep_wp_image196.gif
new file mode 100644
index 0000000000..3ca8845116
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image196.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image197.gif b/dox/user_guides/brep_wp/images/brep_wp_image197.gif
new file mode 100644
index 0000000000..caa2f6d04f
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image197.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image198.gif b/dox/user_guides/brep_wp/images/brep_wp_image198.gif
new file mode 100644
index 0000000000..68488f767f
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image198.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image199.gif b/dox/user_guides/brep_wp/images/brep_wp_image199.gif
new file mode 100644
index 0000000000..ccd0a8542e
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image199.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image200.gif b/dox/user_guides/brep_wp/images/brep_wp_image200.gif
new file mode 100644
index 0000000000..658b86b8de
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image200.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image201.gif b/dox/user_guides/brep_wp/images/brep_wp_image201.gif
new file mode 100644
index 0000000000..e6c0e31f27
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image201.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image202.gif b/dox/user_guides/brep_wp/images/brep_wp_image202.gif
new file mode 100644
index 0000000000..71457ff8f4
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image202.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image203.gif b/dox/user_guides/brep_wp/images/brep_wp_image203.gif
new file mode 100644
index 0000000000..8cdd2f8aa9
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image203.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image204.gif b/dox/user_guides/brep_wp/images/brep_wp_image204.gif
new file mode 100644
index 0000000000..2b9ebfde2c
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image204.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image205.gif b/dox/user_guides/brep_wp/images/brep_wp_image205.gif
new file mode 100644
index 0000000000..ee6c39ef7d
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image205.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image206.gif b/dox/user_guides/brep_wp/images/brep_wp_image206.gif
new file mode 100644
index 0000000000..a1a4aeb820
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image206.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image207.gif b/dox/user_guides/brep_wp/images/brep_wp_image207.gif
new file mode 100644
index 0000000000..ef74285684
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image207.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image208.gif b/dox/user_guides/brep_wp/images/brep_wp_image208.gif
new file mode 100644
index 0000000000..07a51aac7b
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image208.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image209.gif b/dox/user_guides/brep_wp/images/brep_wp_image209.gif
new file mode 100644
index 0000000000..3d5f4374bc
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image209.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image210.gif b/dox/user_guides/brep_wp/images/brep_wp_image210.gif
new file mode 100644
index 0000000000..a717cb41db
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image210.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image211.gif b/dox/user_guides/brep_wp/images/brep_wp_image211.gif
new file mode 100644
index 0000000000..bfa0f9afb0
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image211.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image212.gif b/dox/user_guides/brep_wp/images/brep_wp_image212.gif
new file mode 100644
index 0000000000..8a16e1afba
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image212.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image213.gif b/dox/user_guides/brep_wp/images/brep_wp_image213.gif
new file mode 100644
index 0000000000..02fc03a051
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image213.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image214.gif b/dox/user_guides/brep_wp/images/brep_wp_image214.gif
new file mode 100644
index 0000000000..c12bf606b3
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image214.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image215.gif b/dox/user_guides/brep_wp/images/brep_wp_image215.gif
new file mode 100644
index 0000000000..636975af39
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image215.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image216.gif b/dox/user_guides/brep_wp/images/brep_wp_image216.gif
new file mode 100644
index 0000000000..0712549528
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image216.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image217.gif b/dox/user_guides/brep_wp/images/brep_wp_image217.gif
new file mode 100644
index 0000000000..0d40993549
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image217.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image218.gif b/dox/user_guides/brep_wp/images/brep_wp_image218.gif
new file mode 100644
index 0000000000..d96dea901d
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image218.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image219.gif b/dox/user_guides/brep_wp/images/brep_wp_image219.gif
new file mode 100644
index 0000000000..5340547b18
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image219.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image220.gif b/dox/user_guides/brep_wp/images/brep_wp_image220.gif
new file mode 100644
index 0000000000..c23b31530b
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image220.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image221.gif b/dox/user_guides/brep_wp/images/brep_wp_image221.gif
new file mode 100644
index 0000000000..9e9e83bfb1
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image221.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image222.gif b/dox/user_guides/brep_wp/images/brep_wp_image222.gif
new file mode 100644
index 0000000000..9cf2e89679
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image222.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image223.gif b/dox/user_guides/brep_wp/images/brep_wp_image223.gif
new file mode 100644
index 0000000000..6b8fd84d92
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image223.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image224.gif b/dox/user_guides/brep_wp/images/brep_wp_image224.gif
new file mode 100644
index 0000000000..2b7bd9cbda
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image224.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image225.gif b/dox/user_guides/brep_wp/images/brep_wp_image225.gif
new file mode 100644
index 0000000000..4c11bfb78e
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image225.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image226.gif b/dox/user_guides/brep_wp/images/brep_wp_image226.gif
new file mode 100644
index 0000000000..fa2132c88c
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image226.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image227.gif b/dox/user_guides/brep_wp/images/brep_wp_image227.gif
new file mode 100644
index 0000000000..d67dc610ef
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image227.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image228.gif b/dox/user_guides/brep_wp/images/brep_wp_image228.gif
new file mode 100644
index 0000000000..c619ce8cfc
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image228.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image229.gif b/dox/user_guides/brep_wp/images/brep_wp_image229.gif
new file mode 100644
index 0000000000..1faf82bd20
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image229.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image230.gif b/dox/user_guides/brep_wp/images/brep_wp_image230.gif
new file mode 100644
index 0000000000..e0eacabc74
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image230.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image231.gif b/dox/user_guides/brep_wp/images/brep_wp_image231.gif
new file mode 100644
index 0000000000..be8d33e49d
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image231.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image232.gif b/dox/user_guides/brep_wp/images/brep_wp_image232.gif
new file mode 100644
index 0000000000..f00598614c
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image232.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image233.gif b/dox/user_guides/brep_wp/images/brep_wp_image233.gif
new file mode 100644
index 0000000000..a8e533a7ae
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image233.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image234.gif b/dox/user_guides/brep_wp/images/brep_wp_image234.gif
new file mode 100644
index 0000000000..7cf0e11f29
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image234.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image235.gif b/dox/user_guides/brep_wp/images/brep_wp_image235.gif
new file mode 100644
index 0000000000..80f7d5e92f
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image235.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image236.gif b/dox/user_guides/brep_wp/images/brep_wp_image236.gif
new file mode 100644
index 0000000000..99df89ccdb
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image236.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image237.gif b/dox/user_guides/brep_wp/images/brep_wp_image237.gif
new file mode 100644
index 0000000000..22916b06b1
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image237.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image238.gif b/dox/user_guides/brep_wp/images/brep_wp_image238.gif
new file mode 100644
index 0000000000..bc85a9a1f2
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image238.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image239.gif b/dox/user_guides/brep_wp/images/brep_wp_image239.gif
new file mode 100644
index 0000000000..b7dc93338c
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image239.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image240.gif b/dox/user_guides/brep_wp/images/brep_wp_image240.gif
new file mode 100644
index 0000000000..db1ed4bf31
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image240.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image241.gif b/dox/user_guides/brep_wp/images/brep_wp_image241.gif
new file mode 100644
index 0000000000..0b08c76faa
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image241.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image242.gif b/dox/user_guides/brep_wp/images/brep_wp_image242.gif
new file mode 100644
index 0000000000..9a6394986d
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image242.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image243.gif b/dox/user_guides/brep_wp/images/brep_wp_image243.gif
new file mode 100644
index 0000000000..c08ff6804d
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image243.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image244.gif b/dox/user_guides/brep_wp/images/brep_wp_image244.gif
new file mode 100644
index 0000000000..d8e51bed70
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image244.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image245.gif b/dox/user_guides/brep_wp/images/brep_wp_image245.gif
new file mode 100644
index 0000000000..a86044cf35
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image245.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image246.gif b/dox/user_guides/brep_wp/images/brep_wp_image246.gif
new file mode 100644
index 0000000000..d67a75dfab
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image246.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image247.gif b/dox/user_guides/brep_wp/images/brep_wp_image247.gif
new file mode 100644
index 0000000000..2e2ab05caf
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image247.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image248.gif b/dox/user_guides/brep_wp/images/brep_wp_image248.gif
new file mode 100644
index 0000000000..5fcd6f8d31
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image248.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image249.gif b/dox/user_guides/brep_wp/images/brep_wp_image249.gif
new file mode 100644
index 0000000000..25d4deab60
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image249.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image250.gif b/dox/user_guides/brep_wp/images/brep_wp_image250.gif
new file mode 100644
index 0000000000..2d0bcbd1b2
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image250.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image251.gif b/dox/user_guides/brep_wp/images/brep_wp_image251.gif
new file mode 100644
index 0000000000..adac275e62
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image251.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image252.gif b/dox/user_guides/brep_wp/images/brep_wp_image252.gif
new file mode 100644
index 0000000000..84ad879dd8
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image252.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image253.gif b/dox/user_guides/brep_wp/images/brep_wp_image253.gif
new file mode 100644
index 0000000000..598bdeea73
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image253.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image254.gif b/dox/user_guides/brep_wp/images/brep_wp_image254.gif
new file mode 100644
index 0000000000..83d27eba89
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image254.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image255.gif b/dox/user_guides/brep_wp/images/brep_wp_image255.gif
new file mode 100644
index 0000000000..148e55291e
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image255.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image256.gif b/dox/user_guides/brep_wp/images/brep_wp_image256.gif
new file mode 100644
index 0000000000..47463404b9
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image256.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image257.gif b/dox/user_guides/brep_wp/images/brep_wp_image257.gif
new file mode 100644
index 0000000000..cd163a0943
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image257.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image258.gif b/dox/user_guides/brep_wp/images/brep_wp_image258.gif
new file mode 100644
index 0000000000..4a60b17c7f
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image258.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image259.gif b/dox/user_guides/brep_wp/images/brep_wp_image259.gif
new file mode 100644
index 0000000000..07d7903d10
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image259.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image260.gif b/dox/user_guides/brep_wp/images/brep_wp_image260.gif
new file mode 100644
index 0000000000..ea97124eb2
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image260.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image261.gif b/dox/user_guides/brep_wp/images/brep_wp_image261.gif
new file mode 100644
index 0000000000..d3378681db
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image261.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image262.gif b/dox/user_guides/brep_wp/images/brep_wp_image262.gif
new file mode 100644
index 0000000000..e5dcacfc89
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image262.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image263.gif b/dox/user_guides/brep_wp/images/brep_wp_image263.gif
new file mode 100644
index 0000000000..b16e50fec8
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image263.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image264.gif b/dox/user_guides/brep_wp/images/brep_wp_image264.gif
new file mode 100644
index 0000000000..79c729cbe1
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image264.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image265.gif b/dox/user_guides/brep_wp/images/brep_wp_image265.gif
new file mode 100644
index 0000000000..fac688036e
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image265.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image266.gif b/dox/user_guides/brep_wp/images/brep_wp_image266.gif
new file mode 100644
index 0000000000..d4793a0eb7
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image266.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image267.gif b/dox/user_guides/brep_wp/images/brep_wp_image267.gif
new file mode 100644
index 0000000000..38d0900164
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image267.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image268.gif b/dox/user_guides/brep_wp/images/brep_wp_image268.gif
new file mode 100644
index 0000000000..3ebe24d890
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image268.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image269.gif b/dox/user_guides/brep_wp/images/brep_wp_image269.gif
new file mode 100644
index 0000000000..51d8c67dff
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image269.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image270.gif b/dox/user_guides/brep_wp/images/brep_wp_image270.gif
new file mode 100644
index 0000000000..0dc99e76da
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image270.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image271.gif b/dox/user_guides/brep_wp/images/brep_wp_image271.gif
new file mode 100644
index 0000000000..2abdb89695
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image271.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image272.gif b/dox/user_guides/brep_wp/images/brep_wp_image272.gif
new file mode 100644
index 0000000000..b574cdd4ef
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image272.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image273.gif b/dox/user_guides/brep_wp/images/brep_wp_image273.gif
new file mode 100644
index 0000000000..89a4394820
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image273.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image274.gif b/dox/user_guides/brep_wp/images/brep_wp_image274.gif
new file mode 100644
index 0000000000..5b1d4770e9
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image274.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image275.gif b/dox/user_guides/brep_wp/images/brep_wp_image275.gif
new file mode 100644
index 0000000000..efbb11b6e2
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image275.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image276.gif b/dox/user_guides/brep_wp/images/brep_wp_image276.gif
new file mode 100644
index 0000000000..4f59f63b7c
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image276.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image277.gif b/dox/user_guides/brep_wp/images/brep_wp_image277.gif
new file mode 100644
index 0000000000..12245584db
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image277.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image278.gif b/dox/user_guides/brep_wp/images/brep_wp_image278.gif
new file mode 100644
index 0000000000..0f298f2b2a
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image278.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image279.gif b/dox/user_guides/brep_wp/images/brep_wp_image279.gif
new file mode 100644
index 0000000000..5b63d806b7
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image279.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image280.gif b/dox/user_guides/brep_wp/images/brep_wp_image280.gif
new file mode 100644
index 0000000000..682fbf5c05
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image280.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image281.gif b/dox/user_guides/brep_wp/images/brep_wp_image281.gif
new file mode 100644
index 0000000000..93cd61c5d3
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image281.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image282.gif b/dox/user_guides/brep_wp/images/brep_wp_image282.gif
new file mode 100644
index 0000000000..24ab4e25cd
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image282.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image283.gif b/dox/user_guides/brep_wp/images/brep_wp_image283.gif
new file mode 100644
index 0000000000..f1d27cdd6f
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image283.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image284.gif b/dox/user_guides/brep_wp/images/brep_wp_image284.gif
new file mode 100644
index 0000000000..5cbeabd7ab
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image284.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image285.gif b/dox/user_guides/brep_wp/images/brep_wp_image285.gif
new file mode 100644
index 0000000000..544f76d53e
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image285.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image286.gif b/dox/user_guides/brep_wp/images/brep_wp_image286.gif
new file mode 100644
index 0000000000..0822ca9508
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image286.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image287.gif b/dox/user_guides/brep_wp/images/brep_wp_image287.gif
new file mode 100644
index 0000000000..7a9bef0d6f
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image287.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image288.gif b/dox/user_guides/brep_wp/images/brep_wp_image288.gif
new file mode 100644
index 0000000000..a523965d80
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image288.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image289.gif b/dox/user_guides/brep_wp/images/brep_wp_image289.gif
new file mode 100644
index 0000000000..2a93b0999f
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image289.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image290.gif b/dox/user_guides/brep_wp/images/brep_wp_image290.gif
new file mode 100644
index 0000000000..d214296077
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image290.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image291.gif b/dox/user_guides/brep_wp/images/brep_wp_image291.gif
new file mode 100644
index 0000000000..46c81152b3
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image291.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image292.gif b/dox/user_guides/brep_wp/images/brep_wp_image292.gif
new file mode 100644
index 0000000000..e2483b2640
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image292.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image293.gif b/dox/user_guides/brep_wp/images/brep_wp_image293.gif
new file mode 100644
index 0000000000..0383e520cc
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image293.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image294.gif b/dox/user_guides/brep_wp/images/brep_wp_image294.gif
new file mode 100644
index 0000000000..c522b449dc
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image294.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image295.gif b/dox/user_guides/brep_wp/images/brep_wp_image295.gif
new file mode 100644
index 0000000000..90c2bce3a1
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image295.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image296.gif b/dox/user_guides/brep_wp/images/brep_wp_image296.gif
new file mode 100644
index 0000000000..3fb2a4926b
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image296.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image297.gif b/dox/user_guides/brep_wp/images/brep_wp_image297.gif
new file mode 100644
index 0000000000..a5bc5016d4
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image297.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image298.gif b/dox/user_guides/brep_wp/images/brep_wp_image298.gif
new file mode 100644
index 0000000000..beb413c6ea
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image298.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image299.gif b/dox/user_guides/brep_wp/images/brep_wp_image299.gif
new file mode 100644
index 0000000000..e070ebe283
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image299.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image300.gif b/dox/user_guides/brep_wp/images/brep_wp_image300.gif
new file mode 100644
index 0000000000..91785c9bc5
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image300.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image301.gif b/dox/user_guides/brep_wp/images/brep_wp_image301.gif
new file mode 100644
index 0000000000..3c244f548e
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image301.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image302.gif b/dox/user_guides/brep_wp/images/brep_wp_image302.gif
new file mode 100644
index 0000000000..1e1f4bc6cf
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image302.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image303.gif b/dox/user_guides/brep_wp/images/brep_wp_image303.gif
new file mode 100644
index 0000000000..e97bb4c8cd
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image303.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image304.gif b/dox/user_guides/brep_wp/images/brep_wp_image304.gif
new file mode 100644
index 0000000000..798ee1722f
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image304.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image305.gif b/dox/user_guides/brep_wp/images/brep_wp_image305.gif
new file mode 100644
index 0000000000..1be37b72d6
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image305.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image306.gif b/dox/user_guides/brep_wp/images/brep_wp_image306.gif
new file mode 100644
index 0000000000..739bc116a2
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image306.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image307.gif b/dox/user_guides/brep_wp/images/brep_wp_image307.gif
new file mode 100644
index 0000000000..82ca0bf43a
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image307.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image308.gif b/dox/user_guides/brep_wp/images/brep_wp_image308.gif
new file mode 100644
index 0000000000..f8f7ec577f
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image308.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image309.gif b/dox/user_guides/brep_wp/images/brep_wp_image309.gif
new file mode 100644
index 0000000000..f93d515b5b
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image309.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image310.gif b/dox/user_guides/brep_wp/images/brep_wp_image310.gif
new file mode 100644
index 0000000000..b452148f09
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image310.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image311.gif b/dox/user_guides/brep_wp/images/brep_wp_image311.gif
new file mode 100644
index 0000000000..c640673717
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image311.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image312.gif b/dox/user_guides/brep_wp/images/brep_wp_image312.gif
new file mode 100644
index 0000000000..0242f5f4a9
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image312.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image313.gif b/dox/user_guides/brep_wp/images/brep_wp_image313.gif
new file mode 100644
index 0000000000..724e7f0331
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image313.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image314.gif b/dox/user_guides/brep_wp/images/brep_wp_image314.gif
new file mode 100644
index 0000000000..49262c46e8
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image314.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image315.gif b/dox/user_guides/brep_wp/images/brep_wp_image315.gif
new file mode 100644
index 0000000000..e1821682df
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image315.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image316.gif b/dox/user_guides/brep_wp/images/brep_wp_image316.gif
new file mode 100644
index 0000000000..ee2b6af396
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image316.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image317.gif b/dox/user_guides/brep_wp/images/brep_wp_image317.gif
new file mode 100644
index 0000000000..abff43897f
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image317.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image318.gif b/dox/user_guides/brep_wp/images/brep_wp_image318.gif
new file mode 100644
index 0000000000..fba85b44be
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image318.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image319.gif b/dox/user_guides/brep_wp/images/brep_wp_image319.gif
new file mode 100644
index 0000000000..4c00bccba5
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image319.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image320.gif b/dox/user_guides/brep_wp/images/brep_wp_image320.gif
new file mode 100644
index 0000000000..81f0a10399
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image320.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image321.gif b/dox/user_guides/brep_wp/images/brep_wp_image321.gif
new file mode 100644
index 0000000000..dd4d017aa5
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image321.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image322.gif b/dox/user_guides/brep_wp/images/brep_wp_image322.gif
new file mode 100644
index 0000000000..fd73c338dc
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image322.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image323.gif b/dox/user_guides/brep_wp/images/brep_wp_image323.gif
new file mode 100644
index 0000000000..ccb0c90801
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image323.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image324.gif b/dox/user_guides/brep_wp/images/brep_wp_image324.gif
new file mode 100644
index 0000000000..28039ce3e0
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image324.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image325.gif b/dox/user_guides/brep_wp/images/brep_wp_image325.gif
new file mode 100644
index 0000000000..914384e082
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image325.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image326.gif b/dox/user_guides/brep_wp/images/brep_wp_image326.gif
new file mode 100644
index 0000000000..16870adabe
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image326.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image327.gif b/dox/user_guides/brep_wp/images/brep_wp_image327.gif
new file mode 100644
index 0000000000..e224b44aac
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image327.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image328.gif b/dox/user_guides/brep_wp/images/brep_wp_image328.gif
new file mode 100644
index 0000000000..93a787f7af
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image328.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image329.gif b/dox/user_guides/brep_wp/images/brep_wp_image329.gif
new file mode 100644
index 0000000000..a4e41a9890
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image329.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image330.gif b/dox/user_guides/brep_wp/images/brep_wp_image330.gif
new file mode 100644
index 0000000000..2ccd647e86
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image330.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image331.gif b/dox/user_guides/brep_wp/images/brep_wp_image331.gif
new file mode 100644
index 0000000000..ab6f2c9fff
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image331.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image332.gif b/dox/user_guides/brep_wp/images/brep_wp_image332.gif
new file mode 100644
index 0000000000..848bc902a3
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image332.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image333.gif b/dox/user_guides/brep_wp/images/brep_wp_image333.gif
new file mode 100644
index 0000000000..b4b4f77da2
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image333.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image334.gif b/dox/user_guides/brep_wp/images/brep_wp_image334.gif
new file mode 100644
index 0000000000..fd8f0ea347
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image334.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image335.gif b/dox/user_guides/brep_wp/images/brep_wp_image335.gif
new file mode 100644
index 0000000000..7622d5fe5d
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image335.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image336.gif b/dox/user_guides/brep_wp/images/brep_wp_image336.gif
new file mode 100644
index 0000000000..dbf0cca5d4
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image336.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image337.gif b/dox/user_guides/brep_wp/images/brep_wp_image337.gif
new file mode 100644
index 0000000000..a08328168c
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image337.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image338.gif b/dox/user_guides/brep_wp/images/brep_wp_image338.gif
new file mode 100644
index 0000000000..faa78f1df4
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image338.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image339.gif b/dox/user_guides/brep_wp/images/brep_wp_image339.gif
new file mode 100644
index 0000000000..7c893c4cd7
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image339.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image340.gif b/dox/user_guides/brep_wp/images/brep_wp_image340.gif
new file mode 100644
index 0000000000..8452797edf
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image340.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image341.gif b/dox/user_guides/brep_wp/images/brep_wp_image341.gif
new file mode 100644
index 0000000000..9a542c2a87
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image341.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image342.gif b/dox/user_guides/brep_wp/images/brep_wp_image342.gif
new file mode 100644
index 0000000000..e4787e1945
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image342.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image343.gif b/dox/user_guides/brep_wp/images/brep_wp_image343.gif
new file mode 100644
index 0000000000..deeea52a8d
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image343.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image344.gif b/dox/user_guides/brep_wp/images/brep_wp_image344.gif
new file mode 100644
index 0000000000..058ff97425
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image344.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image345.gif b/dox/user_guides/brep_wp/images/brep_wp_image345.gif
new file mode 100644
index 0000000000..f0ddbed28b
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image345.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image346.gif b/dox/user_guides/brep_wp/images/brep_wp_image346.gif
new file mode 100644
index 0000000000..cc0bd835c0
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image346.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image347.gif b/dox/user_guides/brep_wp/images/brep_wp_image347.gif
new file mode 100644
index 0000000000..23361ee500
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image347.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image348.gif b/dox/user_guides/brep_wp/images/brep_wp_image348.gif
new file mode 100644
index 0000000000..1e7a2421d4
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image348.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image349.gif b/dox/user_guides/brep_wp/images/brep_wp_image349.gif
new file mode 100644
index 0000000000..387614b7bf
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image349.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image350.gif b/dox/user_guides/brep_wp/images/brep_wp_image350.gif
new file mode 100644
index 0000000000..20cc996e86
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image350.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image351.gif b/dox/user_guides/brep_wp/images/brep_wp_image351.gif
new file mode 100644
index 0000000000..adb1f70a51
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image351.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image352.gif b/dox/user_guides/brep_wp/images/brep_wp_image352.gif
new file mode 100644
index 0000000000..b4d9310e2a
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image352.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image353.gif b/dox/user_guides/brep_wp/images/brep_wp_image353.gif
new file mode 100644
index 0000000000..096925e603
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image353.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image354.gif b/dox/user_guides/brep_wp/images/brep_wp_image354.gif
new file mode 100644
index 0000000000..90bb6ce003
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image354.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image355.gif b/dox/user_guides/brep_wp/images/brep_wp_image355.gif
new file mode 100644
index 0000000000..dfaf65ae7b
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image355.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image356.gif b/dox/user_guides/brep_wp/images/brep_wp_image356.gif
new file mode 100644
index 0000000000..eec7e19e16
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image356.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image357.gif b/dox/user_guides/brep_wp/images/brep_wp_image357.gif
new file mode 100644
index 0000000000..e37f2ff9be
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image357.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image358.gif b/dox/user_guides/brep_wp/images/brep_wp_image358.gif
new file mode 100644
index 0000000000..b4b556c369
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image358.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image359.gif b/dox/user_guides/brep_wp/images/brep_wp_image359.gif
new file mode 100644
index 0000000000..9989a96b8e
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image359.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image360.gif b/dox/user_guides/brep_wp/images/brep_wp_image360.gif
new file mode 100644
index 0000000000..cc16d4ddd3
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image360.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image361.gif b/dox/user_guides/brep_wp/images/brep_wp_image361.gif
new file mode 100644
index 0000000000..0014bcc2bc
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image361.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image362.gif b/dox/user_guides/brep_wp/images/brep_wp_image362.gif
new file mode 100644
index 0000000000..f6a755e74f
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image362.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image363.gif b/dox/user_guides/brep_wp/images/brep_wp_image363.gif
new file mode 100644
index 0000000000..775a919dfe
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image363.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image364.gif b/dox/user_guides/brep_wp/images/brep_wp_image364.gif
new file mode 100644
index 0000000000..8dc42cc077
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image364.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image365.gif b/dox/user_guides/brep_wp/images/brep_wp_image365.gif
new file mode 100644
index 0000000000..c30e8bec20
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image365.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image366.gif b/dox/user_guides/brep_wp/images/brep_wp_image366.gif
new file mode 100644
index 0000000000..926a183cb6
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image366.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image367.gif b/dox/user_guides/brep_wp/images/brep_wp_image367.gif
new file mode 100644
index 0000000000..e1b65a6676
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image367.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image368.gif b/dox/user_guides/brep_wp/images/brep_wp_image368.gif
new file mode 100644
index 0000000000..94cdefb876
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image368.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image369.gif b/dox/user_guides/brep_wp/images/brep_wp_image369.gif
new file mode 100644
index 0000000000..2c3c9649c9
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image369.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image370.gif b/dox/user_guides/brep_wp/images/brep_wp_image370.gif
new file mode 100644
index 0000000000..82d1f65197
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image370.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image371.gif b/dox/user_guides/brep_wp/images/brep_wp_image371.gif
new file mode 100644
index 0000000000..a8e43d7b95
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image371.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image372.gif b/dox/user_guides/brep_wp/images/brep_wp_image372.gif
new file mode 100644
index 0000000000..c2a5396e30
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image372.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image373.gif b/dox/user_guides/brep_wp/images/brep_wp_image373.gif
new file mode 100644
index 0000000000..01c6a76f38
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image373.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image374.gif b/dox/user_guides/brep_wp/images/brep_wp_image374.gif
new file mode 100644
index 0000000000..d2d0326c23
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image374.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image375.gif b/dox/user_guides/brep_wp/images/brep_wp_image375.gif
new file mode 100644
index 0000000000..2ec6cbc2e9
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image375.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image376.gif b/dox/user_guides/brep_wp/images/brep_wp_image376.gif
new file mode 100644
index 0000000000..09ecd0a6b7
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image376.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image377.gif b/dox/user_guides/brep_wp/images/brep_wp_image377.gif
new file mode 100644
index 0000000000..0c1a0b17f1
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image377.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image378.gif b/dox/user_guides/brep_wp/images/brep_wp_image378.gif
new file mode 100644
index 0000000000..0f5aff915c
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image378.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image379.gif b/dox/user_guides/brep_wp/images/brep_wp_image379.gif
new file mode 100644
index 0000000000..4e65d0c57b
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image379.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image380.gif b/dox/user_guides/brep_wp/images/brep_wp_image380.gif
new file mode 100644
index 0000000000..12c79c5c24
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image380.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image381.gif b/dox/user_guides/brep_wp/images/brep_wp_image381.gif
new file mode 100644
index 0000000000..2c953441f6
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image381.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image382.gif b/dox/user_guides/brep_wp/images/brep_wp_image382.gif
new file mode 100644
index 0000000000..9b1b27b50b
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image382.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image383.gif b/dox/user_guides/brep_wp/images/brep_wp_image383.gif
new file mode 100644
index 0000000000..495923cedd
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image383.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image384.gif b/dox/user_guides/brep_wp/images/brep_wp_image384.gif
new file mode 100644
index 0000000000..e444c5a321
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image384.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image385.gif b/dox/user_guides/brep_wp/images/brep_wp_image385.gif
new file mode 100644
index 0000000000..072d48f779
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image385.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image386.gif b/dox/user_guides/brep_wp/images/brep_wp_image386.gif
new file mode 100644
index 0000000000..523f043b54
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image386.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image387.gif b/dox/user_guides/brep_wp/images/brep_wp_image387.gif
new file mode 100644
index 0000000000..396e338b12
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image387.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image388.gif b/dox/user_guides/brep_wp/images/brep_wp_image388.gif
new file mode 100644
index 0000000000..2891aaec3a
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image388.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image389.gif b/dox/user_guides/brep_wp/images/brep_wp_image389.gif
new file mode 100644
index 0000000000..98b6dc9a00
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image389.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image390.gif b/dox/user_guides/brep_wp/images/brep_wp_image390.gif
new file mode 100644
index 0000000000..a992761c7f
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image390.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image391.gif b/dox/user_guides/brep_wp/images/brep_wp_image391.gif
new file mode 100644
index 0000000000..15f9cb0ccc
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image391.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image392.gif b/dox/user_guides/brep_wp/images/brep_wp_image392.gif
new file mode 100644
index 0000000000..b1a324a49a
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image392.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image393.gif b/dox/user_guides/brep_wp/images/brep_wp_image393.gif
new file mode 100644
index 0000000000..2f9aad70b4
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image393.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image394.gif b/dox/user_guides/brep_wp/images/brep_wp_image394.gif
new file mode 100644
index 0000000000..e32e21d41d
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image394.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image395.gif b/dox/user_guides/brep_wp/images/brep_wp_image395.gif
new file mode 100644
index 0000000000..69e667b5ae
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image395.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image396.gif b/dox/user_guides/brep_wp/images/brep_wp_image396.gif
new file mode 100644
index 0000000000..a25c03f21c
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image396.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image397.gif b/dox/user_guides/brep_wp/images/brep_wp_image397.gif
new file mode 100644
index 0000000000..01a4277ac9
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image397.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image398.gif b/dox/user_guides/brep_wp/images/brep_wp_image398.gif
new file mode 100644
index 0000000000..85bd6f332f
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image398.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image399.gif b/dox/user_guides/brep_wp/images/brep_wp_image399.gif
new file mode 100644
index 0000000000..945499839d
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image399.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image400.gif b/dox/user_guides/brep_wp/images/brep_wp_image400.gif
new file mode 100644
index 0000000000..d32e1b3c7d
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image400.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image401.gif b/dox/user_guides/brep_wp/images/brep_wp_image401.gif
new file mode 100644
index 0000000000..42679fe3b1
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image401.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image402.gif b/dox/user_guides/brep_wp/images/brep_wp_image402.gif
new file mode 100644
index 0000000000..650ff3c7b1
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image402.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image403.gif b/dox/user_guides/brep_wp/images/brep_wp_image403.gif
new file mode 100644
index 0000000000..bf02952aab
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image403.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image404.gif b/dox/user_guides/brep_wp/images/brep_wp_image404.gif
new file mode 100644
index 0000000000..4a560c6330
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image404.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image405.gif b/dox/user_guides/brep_wp/images/brep_wp_image405.gif
new file mode 100644
index 0000000000..7f66e4a02e
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image405.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image406.gif b/dox/user_guides/brep_wp/images/brep_wp_image406.gif
new file mode 100644
index 0000000000..537f465960
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image406.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image407.gif b/dox/user_guides/brep_wp/images/brep_wp_image407.gif
new file mode 100644
index 0000000000..6c0485bdcf
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image407.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image408.gif b/dox/user_guides/brep_wp/images/brep_wp_image408.gif
new file mode 100644
index 0000000000..7c513c3b10
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image408.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image409.gif b/dox/user_guides/brep_wp/images/brep_wp_image409.gif
new file mode 100644
index 0000000000..4027616f15
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image409.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image410.gif b/dox/user_guides/brep_wp/images/brep_wp_image410.gif
new file mode 100644
index 0000000000..7b5e9098d8
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image410.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image411.gif b/dox/user_guides/brep_wp/images/brep_wp_image411.gif
new file mode 100644
index 0000000000..fa139d15d2
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image411.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image412.gif b/dox/user_guides/brep_wp/images/brep_wp_image412.gif
new file mode 100644
index 0000000000..05b8ae5214
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image412.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image413.gif b/dox/user_guides/brep_wp/images/brep_wp_image413.gif
new file mode 100644
index 0000000000..bac8febaee
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image413.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image414.gif b/dox/user_guides/brep_wp/images/brep_wp_image414.gif
new file mode 100644
index 0000000000..62ef92a7d4
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image414.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image415.gif b/dox/user_guides/brep_wp/images/brep_wp_image415.gif
new file mode 100644
index 0000000000..b8a23c9934
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image415.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image416.gif b/dox/user_guides/brep_wp/images/brep_wp_image416.gif
new file mode 100644
index 0000000000..57dd5ed624
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image416.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image417.gif b/dox/user_guides/brep_wp/images/brep_wp_image417.gif
new file mode 100644
index 0000000000..cb8c76c1ee
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image417.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image418.gif b/dox/user_guides/brep_wp/images/brep_wp_image418.gif
new file mode 100644
index 0000000000..12d6b076ac
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image418.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image419.gif b/dox/user_guides/brep_wp/images/brep_wp_image419.gif
new file mode 100644
index 0000000000..71e3165536
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image419.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image420.gif b/dox/user_guides/brep_wp/images/brep_wp_image420.gif
new file mode 100644
index 0000000000..a7efb4285f
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image420.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image421.gif b/dox/user_guides/brep_wp/images/brep_wp_image421.gif
new file mode 100644
index 0000000000..00cf9023db
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image421.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image422.gif b/dox/user_guides/brep_wp/images/brep_wp_image422.gif
new file mode 100644
index 0000000000..4117219470
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image422.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image423.gif b/dox/user_guides/brep_wp/images/brep_wp_image423.gif
new file mode 100644
index 0000000000..0f4a6803c3
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image423.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image424.gif b/dox/user_guides/brep_wp/images/brep_wp_image424.gif
new file mode 100644
index 0000000000..7523bba574
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image424.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image425.gif b/dox/user_guides/brep_wp/images/brep_wp_image425.gif
new file mode 100644
index 0000000000..f5885b0b20
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image425.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image426.gif b/dox/user_guides/brep_wp/images/brep_wp_image426.gif
new file mode 100644
index 0000000000..d362cade84
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image426.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image427.gif b/dox/user_guides/brep_wp/images/brep_wp_image427.gif
new file mode 100644
index 0000000000..2e958e1a21
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image427.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image428.gif b/dox/user_guides/brep_wp/images/brep_wp_image428.gif
new file mode 100644
index 0000000000..fe834be060
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image428.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image429.gif b/dox/user_guides/brep_wp/images/brep_wp_image429.gif
new file mode 100644
index 0000000000..bc867c58f7
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image429.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image430.gif b/dox/user_guides/brep_wp/images/brep_wp_image430.gif
new file mode 100644
index 0000000000..6c51bd5f82
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image430.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image431.gif b/dox/user_guides/brep_wp/images/brep_wp_image431.gif
new file mode 100644
index 0000000000..a1b5047346
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image431.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image432.gif b/dox/user_guides/brep_wp/images/brep_wp_image432.gif
new file mode 100644
index 0000000000..6d55f57d00
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image432.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image433.gif b/dox/user_guides/brep_wp/images/brep_wp_image433.gif
new file mode 100644
index 0000000000..93813b5fa6
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image433.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image434.gif b/dox/user_guides/brep_wp/images/brep_wp_image434.gif
new file mode 100644
index 0000000000..8463b66786
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image434.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image435.gif b/dox/user_guides/brep_wp/images/brep_wp_image435.gif
new file mode 100644
index 0000000000..e261f1a5ae
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image435.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image436.gif b/dox/user_guides/brep_wp/images/brep_wp_image436.gif
new file mode 100644
index 0000000000..de39d8a6d7
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image436.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image437.gif b/dox/user_guides/brep_wp/images/brep_wp_image437.gif
new file mode 100644
index 0000000000..abdfcf3ce2
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image437.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image438.gif b/dox/user_guides/brep_wp/images/brep_wp_image438.gif
new file mode 100644
index 0000000000..8057726b11
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image438.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image439.gif b/dox/user_guides/brep_wp/images/brep_wp_image439.gif
new file mode 100644
index 0000000000..c7e25bd140
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image439.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image440.gif b/dox/user_guides/brep_wp/images/brep_wp_image440.gif
new file mode 100644
index 0000000000..de8615be60
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image440.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image441.gif b/dox/user_guides/brep_wp/images/brep_wp_image441.gif
new file mode 100644
index 0000000000..6104894d9c
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image441.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image442.gif b/dox/user_guides/brep_wp/images/brep_wp_image442.gif
new file mode 100644
index 0000000000..ad4409fec2
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image442.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image443.gif b/dox/user_guides/brep_wp/images/brep_wp_image443.gif
new file mode 100644
index 0000000000..d7766a05f4
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image443.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image444.gif b/dox/user_guides/brep_wp/images/brep_wp_image444.gif
new file mode 100644
index 0000000000..dd89e8c9f4
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image444.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image445.gif b/dox/user_guides/brep_wp/images/brep_wp_image445.gif
new file mode 100644
index 0000000000..8bd45f4f08
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image445.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image446.gif b/dox/user_guides/brep_wp/images/brep_wp_image446.gif
new file mode 100644
index 0000000000..457180f6bd
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image446.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image447.gif b/dox/user_guides/brep_wp/images/brep_wp_image447.gif
new file mode 100644
index 0000000000..db65da9a51
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image447.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image448.gif b/dox/user_guides/brep_wp/images/brep_wp_image448.gif
new file mode 100644
index 0000000000..344e457ab0
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image448.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image449.gif b/dox/user_guides/brep_wp/images/brep_wp_image449.gif
new file mode 100644
index 0000000000..a766744646
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image449.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image450.gif b/dox/user_guides/brep_wp/images/brep_wp_image450.gif
new file mode 100644
index 0000000000..62a3b32005
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image450.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image451.gif b/dox/user_guides/brep_wp/images/brep_wp_image451.gif
new file mode 100644
index 0000000000..4976ad45db
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image451.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image452.gif b/dox/user_guides/brep_wp/images/brep_wp_image452.gif
new file mode 100644
index 0000000000..9123136690
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image452.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image453.gif b/dox/user_guides/brep_wp/images/brep_wp_image453.gif
new file mode 100644
index 0000000000..c9af736b4e
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image453.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image454.gif b/dox/user_guides/brep_wp/images/brep_wp_image454.gif
new file mode 100644
index 0000000000..acec4b594c
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image454.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image455.gif b/dox/user_guides/brep_wp/images/brep_wp_image455.gif
new file mode 100644
index 0000000000..2e641acddd
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image455.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image456.gif b/dox/user_guides/brep_wp/images/brep_wp_image456.gif
new file mode 100644
index 0000000000..88107884ea
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image456.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image457.gif b/dox/user_guides/brep_wp/images/brep_wp_image457.gif
new file mode 100644
index 0000000000..592885a615
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image457.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image458.gif b/dox/user_guides/brep_wp/images/brep_wp_image458.gif
new file mode 100644
index 0000000000..c19f26daed
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image458.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image459.gif b/dox/user_guides/brep_wp/images/brep_wp_image459.gif
new file mode 100644
index 0000000000..67815e00b8
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image459.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image460.gif b/dox/user_guides/brep_wp/images/brep_wp_image460.gif
new file mode 100644
index 0000000000..b11b446de9
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image460.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image461.gif b/dox/user_guides/brep_wp/images/brep_wp_image461.gif
new file mode 100644
index 0000000000..bff564fa1f
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image461.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image462.gif b/dox/user_guides/brep_wp/images/brep_wp_image462.gif
new file mode 100644
index 0000000000..7a0b9d278e
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image462.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image463.gif b/dox/user_guides/brep_wp/images/brep_wp_image463.gif
new file mode 100644
index 0000000000..59bcbf9cfc
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image463.gif differ
diff --git a/dox/user_guides/brep_wp/images/brep_wp_image464.gif b/dox/user_guides/brep_wp/images/brep_wp_image464.gif
new file mode 100644
index 0000000000..f467f05e0a
Binary files /dev/null and b/dox/user_guides/brep_wp/images/brep_wp_image464.gif differ
diff --git a/dox/user_guides/draw_test_harness.md b/dox/user_guides/draw_test_harness.md
index 1e0b85a929..7babc2826c 100644
--- a/dox/user_guides/draw_test_harness.md
+++ b/dox/user_guides/draw_test_harness.md
@@ -103,10 +103,9 @@ To load a plug-in declared in the resource file and to activate the commands the
pload [-PluginFileName] [[Key1] [Key2]...]
~~~~~
-, where:
+where:
-* *-PluginFileName* - defines the name of a plug-in resource file (prefix "-" is mandatory) described above.
-If this parameter is omitted then the default name DrawPlugin is used.
+* -PluginFileName - defines the name of a plug-in resource file (prefix "-" is mandatory) described above. If this parameter is omitted then the default name *DrawPlugin* is used.
* *Key…* - defines the key(s) enumerating plug-ins to be loaded. If no keys are specified then the key named *DEFAULT* is used (if there is no such key in the file then no plug-ins are loaded).
According to the OCCT resource file management rules, to access the resource file the environment variable *CSF_PluginFileNameDefaults* (and optionally *CSF_PluginFileNameUserDefaults*) must be set and point to the directory storing the resource file. If it is omitted then the plug-in resource file will be searched in the $CASROOT/src/DrawResources directory.
@@ -255,11 +254,11 @@ TCL variables have only string values. Note that even numeric values are stored
TCL provides a mechanism to link user data to variables. Using this functionality, Draw defines its variables as TCL variables with associated data.
-The string value of a Draw variable is meaningless. It is usually set to the name of the variable itself. Consequently, preceding a Draw variable with a *$* does not change the result of a command. The content of a Draw variable is accessed using appropriate commands.
+The string value of a Draw variable is meaningless. It is usually set to the name of the variable itself. Consequently, preceding a Draw variable with a $ does not change the result of a command. The content of a Draw variable is accessed using appropriate commands.
There are many kinds of Draw variables, and new ones may be added with C++. Geometric and topological variables are described below.
-Draw numeric variables can be used within an expression anywhere a Draw command requires a numeric value. The **expr** command is useless in this case as the variables are stored not as strings but as floating point values.
+Draw numeric variables can be used within an expression anywhere a Draw command requires a numeric value. The *expr* command is useless in this case as the variables are stored not as strings but as floating point values.
**Example:**
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.cpp}
@@ -268,7 +267,7 @@ Draw numeric variables can be used within an expression anywhere a Draw command
dset angle pi/3 radius 10
point p radius*cos(angle) radius*sin(angle) 0
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-It is recommended that you use TCL variables only for strings and Draw for numerals. That way, you will avoid the **expr** command. As a rule, Geometry and Topology require numbers but no strings.
+It is recommended that you use TCL variables only for strings and Draw for numerals. That way, you will avoid the *expr* command. As a rule, Geometry and Topology require numbers but no strings.
@subsubsection occt_draw_2_3_1 set, unset
@@ -279,11 +278,11 @@ set varname [value]
unset varname [varname varname ...]
~~~~~
-**set** assigns a string value to a variable. If the variable does not already exist, it is created.
+*set* assigns a string value to a variable. If the variable does not already exist, it is created.
-Without a value, **set** returns the content of the variable.
+Without a value, *set* returns the content of the variable.
-**unset** deletes variables. It is is also used to delete Draw variables.
+*unset* deletes variables. It is is also used to delete Draw variables.
**Example:**
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.cpp}
@@ -762,34 +761,34 @@ restore theBox
@subsection occt_draw_3_3 User defined commands
-*DrawTrSurf* provides commands to create and display a Draw **geometric** variable from a Geom_Geometry object and also get a Geom_Geometry object from a Draw geometric variable name.
+*DrawTrSurf* provides commands to create and display a Draw **geometric** variable from a *Geom_Geometry* object and also get a *Geom_Geometry* object from a Draw geometric variable name.
-*DBRep* provides commands to create and display a Draw **topological** variable from a TopoDS_Shape object and also get a TopoDS_Shape object from a Draw topological variable name.
+*DBRep* provides commands to create and display a Draw **topological** variable from a *TopoDS_Shape* object and also get a *TopoDS_Shape* object from a Draw topological variable name.
@subsubsection occt_draw_3_3_1 set
#### In *DrawTrSurf* package:
~~~~~
-void Set(Standard_CString& Name,const gp_Pnt& G) ;
-void Set(Standard_CString& Name,const gp_Pnt2d& G) ;
-void Set(Standard_CString& Name,
-const Handle(Geom_Geometry)& G) ;
-void Set(Standard_CString& Name,
-const Handle(Geom2d_Curve)& C) ;
-void Set(Standard_CString& Name,
-const Handle(Poly_Triangulation)& T) ;
-void Set(Standard_CString& Name,
-const Handle(Poly_Polygon3D)& P) ;
-void Set(Standard_CString& Name,
-const Handle(Poly_Polygon2D)& P) ;
+void Set(Standard_CString& Name,const gp_Pnt& G) ;
+void Set(Standard_CString& Name,const gp_Pnt2d& G) ;
+void Set(Standard_CString& Name,
+const Handle(Geom_Geometry)& G) ;
+void Set(Standard_CString& Name,
+const Handle(Geom2d_Curve)& C) ;
+void Set(Standard_CString& Name,
+const Handle(Poly_Triangulation)& T) ;
+void Set(Standard_CString& Name,
+const Handle(Poly_Polygon3D)& P) ;
+void Set(Standard_CString& Name,
+const Handle(Poly_Polygon2D)& P) ;
~~~~~
#### In *DBRep* package:
~~~~~
void Set(const Standard_CString Name,
-const TopoDS_Shape& S) ;
+const TopoDS_Shape& S) ;
~~~~~
Example of *DrawTrSurf*
@@ -813,13 +812,13 @@ DBRep::Set(char*,B);
#### In *DrawTrSurf* package:
~~~~~
-Handle_Geom_Geometry Get(Standard_CString& Name) ;
+Handle_Geom_Geometry Get(Standard_CString& Name) ;
~~~~~
#### In *DBRep* package:
~~~~~
-TopoDS_Shape Get(Standard_CString& Name,
+TopoDS_Shape Get(Standard_CString& Name,
const TopAbs_ShapeEnum Typ = TopAbs_SHAPE,
const Standard_Boolean Complain
= Standard_True) ;
@@ -829,7 +828,7 @@ Example of *DrawTrSurf*
~~~~~
Standard_Integer MyCommand
-(Draw_Interpretor& theCommands,
+(Draw_Interpretor& theCommands,
Standard_Integer argc, char** argv)
{......
// Creation of a Geom_Geometry from a Draw geometric
@@ -842,7 +841,7 @@ Example of *DBRep*
~~~~~
Standard_Integer MyCommand
-(Draw_Interpretor& theCommands,
+(Draw_Interpretor& theCommands,
Standard_Integer argc, char** argv)
{......
// Creation of a TopoDS_Shape from a Draw topological
@@ -875,8 +874,8 @@ Type selects from the following range:
* *AXON* : Axonometric view
* *PERS* : Perspective view
- * *+X+Y* : View on both axes (i.e. a top view), other codes are *-X+Y, +Y-Z*, etc.
- * *-2D-* : 2d view
+ * +X+Y : View on both axes (i.e. a top view), other codes are -X+Y, +Y-Z, etc.
+ * -2D- : 2d view
The index, the type, the current zoom are displayed in the window title .
@@ -949,22 +948,23 @@ See also: **fit**, **2dfit**
@subsubsection occt_draw_4_14 pu, pd, pl, pr, 2dpu, 2dpd, 2dpl, 2dpr
-Syntax: pu [index]
+Syntax:
+
+~~~~~
+pu [index]
pd [index]
+~~~~~
-The **p_ **commands are used to pan. **pu **and **pd **pan up and down respectively;**pl **and **pr **pan left and right respectively. Each time the view is displaced by 40 pixels.When no index is given, all views will pan in the direction specified.
+The p_ commands are used to pan. **pu** and **pd** pan up and down respectively; **pl** and **pr** pan to the left and to the right respectively. Each time the view is displaced by 40 pixels. When no index is given, all views will pan in the direction specified.
+~~~~~
+# you have selected one anonometric view
+pu
+# or
+pu 1
-**Example:**
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.cpp}
-# you have selected one anonometric view
-pu
-# or
-pu 1
-
-# you have selected an mu4 view; the object in the third
-# view will pan up
-pu 3
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+# you have selected an mu4 view; the object in the third view will pan up
+pu 3
+~~~~~
See also: **fit**, **2dfit**
@@ -1274,15 +1274,10 @@ When an object is modified or erased, the whole view must be repainted. To avoid
Graphic operations are buffered by Draw (and also by the X system). Usually the buffer is flushed at the end of a command and before graphic selection. If you want to flush the buffer from inside a script, use the **dflush** command.
-**Example:**
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.cpp}
-# See the example with the pick command
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.cpp}
-See also: **pick**
+See also: pick command.
@subsection occt_draw_4_2 AIS viewer – view commands
-
@subsubsection occt_draw_4_2_1 vinit
Syntax:
@@ -1402,8 +1397,8 @@ vselect x1 y1 [x2 y2 [x3 y3 ... xn yn]] [shift_selection = 0|1]
Emulates different types of selection:
* single mouse click selection
- * selection with a rectangle having the upper left and bottom right corners in *(x1,y1)* and *(x2,y2)* respectively
- * selection with a polygon having the corners in pixel positions *(x1,y1), (x2,y2),…, (xn,yn)*
+ * selection with a rectangle having the upper left and bottom right corners in (x1,y1) and (x2,y2) respectively
+ * selection with a polygon having the corners in pixel positions (x1,y1), (x2,y2),…, (xn,yn)
* any of these selections if shift_selection is set to 1.
@subsubsection occt_draw_4_2_12 vmoveto
@@ -1484,7 +1479,7 @@ vhlrtype algo_type={algo|polyalgo} [shape_1 ... shape_n]
Changes the type of HLR algorithm used for shapes.
If the algo_type is algo, the exact HLR algorithm is used, otherwise the polygonal algorithm is used for defined shapes.
-If no shape is specified through the command arguments, the given HLR algorithm_type is applied to all *AIS_Shape* instances in the current context, and the command also changes the default HLR algorithm type.
+If no shape is specified through the command arguments, the given HLR algorithm_type is applied to all *AIS_Shape* isntances in the current context, and the command also changes the default HLR algorithm type.
**Note** that this command works with instances of *AIS_Shape* or derived classes only, other interactive object types are ignored.
@@ -1493,62 +1488,64 @@ If no shape is specified through the command arguments, the given HLR algorithm_
@subsubsection occt_draw_4_3_1 vdisplay
-Syntax:
-~~~~~
+Syntax:
+~~~~~
vdisplay name1 [name2] … [name n]
~~~~~
+
Displays named objects.
**Example:**
-~~~~~
+~~~~~
vinit
box b 40 40 40 10 10 10
psphere s 20
vdisplay s b
vfit
-~~~~~
+~~~~~
@subsubsection occt_draw_4_3_2 vdonly
Syntax:
~~~~~
-vdonly [name1] … [name n]
-~~~~~
+vdonly [name1] … [name n]
+~~~~~
+
Displays only selected or named objects. If there are no selected or named objects, nothing is done.
**Example:**
-~~~~~
+~~~~~
vinit
box b 40 40 40 10 10 10
psphere s 20
vdonly b
-vfit
-~~~~~
-
+vfit
+~~~~~
+
@subsubsection occt_draw_4_3_3 vdisplayall
Syntax:
-~~~~~
+~~~~~
vdisplayall
-~~~~~
+~~~~~
+
Displays all created objects.
-
**Example:**
-~~~~~
+~~~~~
vinit
box b 40 40 40 10 10 10
psphere s 20
vdisplayall
vfit
-~~~~~
+~~~~~
@subsubsection occt_draw_4_3_4 verase
-Syntax:
-~~~~~
-verase [name1] [name2] … [name n]
+Syntax:
~~~~~
+verase [name1] [name2] … [name n]
+~~~~~
Erases some selected or named objects. If there are no selected or named objects, the whole viewer is erased.
@@ -1560,239 +1557,319 @@ box b2 -40 -40 -40 10 10 10
psphere s 20
vdisplayall
vfit
-# erase only the first box
+# erase only first box
verase b1
-# erase the second box and sphere
-verase
-~~~~~
+# erase second box and sphere
+verase
+~~~~~
@subsubsection occt_draw_4_3_5 veraseall
Syntax:
~~~~~
-veraseall
-~~~~~
+veraseall
+~~~~~
+
Erases all objects displayed in the viewer.
-**Example:**
-
-~~~~~
+**Example:**
+~~~~~
vinit
box b1 40 40 40 10 10 10
box b2 -40 -40 -40 10 10 10
psphere s 20
vdisplayall
vfit
-# erase only the first box
+# erase only first box
verase b1
-# erase the second box and sphere
-verseall
-~~~~~
+# erase second box and sphere
+verseall
+~~~~~
@subsubsection occt_draw_4_3_6 vsetdispmode
Syntax:
-
-~~~~~
-vsetdispmode [name] mode(0,1,2,3)
~~~~~
+vsetdispmode [name] mode(0,1,2,3)
+~~~~~
-Sets display mode for all, selected or named objects to the following values:
-* **0** - WireFrame,
-* **1** - Shading,
-* **2** - Quick HideLineremoval,
-* **3** - Exact HideLineremoval.
+Sets display mode for all, selected or named objects.
+* *0* (*WireFrame*),
+* *1* (*Shading*),
+* *2* (*Quick HideLineremoval*),
+* *3* (*Exact HideLineremoval*).
**Example:**
-
~~~~~
vinit
box b 10 10 10
vdisplay b
vsetdispmode 1
-vfit
+vfit
~~~~~
-@subsubsection occt_draw_4_39 vtypes
-
-Syntax: vtypes
-
-Makes a list of known types and signatures in AIS.
-
+
@subsubsection occt_draw_4_3_7 vdisplaytype
Syntax:
~~~~~
-vdisplaytype type
-~~~~~
+vdisplaytype type
+~~~~~
-Displays all objects of a given type. The following types are possible: **Point, Axis, Trihedron, PlaneTrihedron, Line, Circle, Plane, Shape, ConnectedShape, MultiConn.Shape, ConnectedInter., MultiConn., Constraint** and **Dimension**.
+Displays all objects of a given type.
+The following types are possible: *Point*, *Axis*, *Trihedron*, *PlaneTrihedron*, *Line*, *Circle*, *Plane*, *Shape*, *ConnectedShape*, *MultiConn.Shape*, *ConnectedInter.*, *MultiConn.*, *Constraint* and *Dimension*.
@subsubsection occt_draw_4_3_8 verasetype
-Syntax: verasetype type
+Syntax:
+~~~~~
+verasetype type
+~~~~~
Erases all objects of a given type.
-Possible** type**s are **;Point;, ;Axis;, ;Trihedron;, ;PlaneTrihedron;, ;Line;, ;Circle;, ;Plane;, ;Shape;, ;ConnectedShape;, ;MultiConn.Shape;, ;ConnectedInter.;, ;MultiConn.;, ;Constraint; **and **;Dimension; **(see **vtypes**).
+Possible type is *Point*, *Axis*, *Trihedron*, *PlaneTrihedron*, *Line*, *Circle*, *Plane*, *Shape*, *ConnectedShape*, *MultiConn.Shape*, *ConnectedInter.*, *MultiConn.*, *Constraint* and *Dimension*.
+@subsubsection occt_draw_4_3_9 vtypes
+Syntax:
+~~~~~
+vtypes
+~~~~~
-@subsubsection occt_draw_4_310 vsetcolor
+Makes a list of known types and signatures in AIS.
-Syntax: vsetcolor [shapename] colorname
+@subsubsection occt_draw_4_3_10 vsetcolor
+
+Syntax:
+~~~~~
+vsetcolor [shapename] colorname
+~~~~~
Sets color for all, selected or named shapes.
-Possible **colorname**s are: ;BLACK;, ;MATRAGRAY;, ;MATRABLUE;, ;ALICEBLUE;, ;ANTIQUEWHITE;, ;ANTIQUEWHITE1;, ;ANTIQUEWHITE2;, ;ANTIQUEWHITE3;, ;ANTIQUEWHITE4;, ;AQUAMARINE1;, ;AQUAMARINE2;, ;AQUAMARINE4;, ;AZURE;, ;AZURE2;, ;AZURE3;, ;AZURE4;, ;BEIGE;, ;BISQUE;, ;BISQUE2;, ;BISQUE3;, ;BISQUE4;, ;BLANCHEDALMOND;, ;BLUE1;, ;BLUE2;, ;BLUE3;, ;BLUE4;, ;BLUEVIOLET;, ;BROWN;, ;BROWN1;, ;BROWN2;, ;BROWN3;, ;BROWN4;, ;BURLYWOOD;, ;BURLYWOOD1;, ;BURLYWOOD2;, ;BURLYWOOD3;, ;BURLYWOOD4;, ;CADETBLUE;, ;CADETBLUE1;, ;CADETBLUE2;, ;CADETBLUE3;, ;CADETBLUE4;, ;CHARTREUSE;, ;CHARTREUSE1;, ;CHARTREUSE2;, ;CHARTREUSE3;, ;CHARTREUSE4;, ;CHOCOLATE;, ;CHOCOLATE1;, ;CHOCOLATE2;, ;CHOCOLATE3;, ;CHOCOLATE4;, ;CORAL;, ;CORAL1;, ;CORAL2;, ;CORAL3;, ;CORAL4;, ;CORNFLOWERBLUE;, ;CORNSILK1;, ;CORNSILK2;, ;CORNSILK3;, ;CORNSILK4;, ;CYAN1;, ;CYAN2;, ;CYAN3;, ;CYAN4;, ;DARKGOLDENROD;, ;DARKGOLDENROD1;, ;DARKGOLDENROD2;, ;DARKGOLDENROD3;, ;DARKGOLDENROD4;, ;DARKGREEN;, ;DARKKHAKI;, ;DARKOLIVEGREEN;, ;DARKOLIVEGREEN1;, ;DARKOLIVEGREEN2;, ;DARKOLIVEGREEN3;, ;DARKOLIVEGREEN4;, ;DARKORANGE;, ;DARKORANGE1;, ;DARKORANGE2;, ;DARKORANGE3;, ;DARKORANGE4;, ;DARKORCHID;, ;DARKORCHID1;, ;DARKORCHID2;, ;DARKORCHID3;, ;DARKORCHID4;, ;DARKSALMON;, ;DARKSEAGREEN;, ;DARKSEAGREEN1;, ;DARKSEAGREEN2;, ;DARKSEAGREEN3;, ;DARKSEAGREEN4;, ;DARKSLATEBLUE;, ;DARKSLATEGRAY1;, ;DARKSLATEGRAY2;, ;DARKSLATEGRAY3;, ;DARKSLATEGRAY4;, ;DARKSLATEGRAY;, ;DARKTURQUOISE;, ;DARKVIOLET;, ;DEEPPINK;, ;DEEPPINK2;, ;DEEPPINK3;, ;DEEPPINK4;, ;DEEPSKYBLUE1;, ;DEEPSKYBLUE2;, ;DEEPSKYBLUE3;, ;DEEPSKYBLUE4;, ;DODGERBLUE1;, ;DODGERBLUE2;, ;DODGERBLUE3;, ;DODGERBLUE4;, ;FIREBRICK;, ;FIREBRICK1;, ;FIREBRICK2;, ;FIREBRICK3;, ;FIREBRICK4;, ;FLORALWHITE;, ;FORESTGREEN;, ;GAINSBORO;, ;GHOSTWHITE;, ;GOLD;, ;GOLD1;, ;GOLD2;, ;GOLD3;, ;GOLD4;, ;GOLDENROD;, ;GOLDENROD1;, ;GOLDENROD2;, ;GOLDENROD3;, ;GOLDENROD4;, ;GRAY;, ;GRAY0;, ;GRAY1;, ;GRAY10;, ;GRAY11;, ;GRAY12;, ;GRAY13;, ;GRAY14;, ;GRAY15;, ;GRAY16;, ;GRAY17;, ;GRAY18;, ;GRAY19;, ;GRAY2;, ;GRAY20;, ;GRAY21;, ;GRAY22;, ;GRAY23;, ;GRAY24;, ;GRAY25;, ;GRAY26;, ;GRAY27;, ;GRAY28;, ;GRAY29;, ;GRAY3;, ;GRAY30;, ;GRAY31;, ;GRAY32;, ;GRAY33;, ;GRAY34;, ;GRAY35;, ;GRAY36;, ;GRAY37;, ;GRAY38;, ;GRAY39;, ;GRAY4;, ;GRAY40;, ;GRAY41;, ;GRAY42;, ;GRAY43;, ;GRAY44;, ;GRAY45;, ;GRAY46;, ;GRAY47;, ;GRAY48;, ;GRAY49;, ;GRAY5;, ;GRAY50;, ;GRAY51;, ;GRAY52;, ;GRAY53;, ;GRAY54;, ;GRAY55;, ;GRAY56;, ;GRAY57;, ;GRAY58;, ;GRAY59;, ;GRAY6;, ;GRAY60;, ;GRAY61;, ;GRAY62;, ;GRAY63;, ;GRAY64;, ;GRAY65;, ;GRAY66;, ;GRAY67;, ;GRAY68;, ;GRAY69;, ;GRAY7;, ;GRAY70;, ;GRAY71;, ;GRAY72;, ;GRAY73;, ;GRAY74;, ;GRAY75;, ;GRAY76;, ;GRAY77;, ;GRAY78;, ;GRAY79;, ;GRAY8;, ;GRAY80;, ;GRAY81;, ;GRAY82;, ;GRAY83;, ;GRAY85;, ;GRAY86;, ;GRAY87;, ;GRAY88;, ;GRAY89;, ;GRAY9;, ;GRAY90;, ;GRAY91;, ;GRAY92;, ;GRAY93;, ;GRAY94;, ;GRAY95;, ;GREEN;, ;GREEN1;, ;GREEN2;, ;GREEN3;, ;GREEN4;, ;GREENYELLOW;, ;GRAY97;, ;GRAY98;, ;GRAY99;, ;HONEYDEW;, ;HONEYDEW2;, ;HONEYDEW3;, ;HONEYDEW4;, ;HOTPINK;, ;HOTPINK1;, ;HOTPINK2;, ;HOTPINK3;, ;HOTPINK4;, ;INDIANRED;, ;INDIANRED1;, ;INDIANRED2;, ;INDIANRED3;, ;INDIANRED4;, ;IVORY;, ;IVORY2;, ;IVORY3;, ;IVORY4;, ;KHAKI;, ;KHAKI1;, ;KHAKI2;, ;KHAKI3;, ;KHAKI4;, ;LAVENDER;, ;LAVENDERBLUSH1;, ;LAVENDERBLUSH2;, ;LAVENDERBLUSH3;, ;LAVENDERBLUSH4;, ;LAWNGREEN;, ;LEMONCHIFFON1;, ;LEMONCHIFFON2;, ;LEMONCHIFFON3;, ;LEMONCHIFFON4;, ;LIGHTBLUE;, ;LIGHTBLUE1;, ;LIGHTBLUE2;, ;LIGHTBLUE3;, ;LIGHTBLUE4;, ;LIGHTCORAL;, ;LIGHTCYAN1;, ;LIGHTCYAN2;, ;LIGHTCYAN3;, ;LIGHTCYAN4;, ;LIGHTGOLDENROD;, ;LIGHTGOLDENROD1;, ;LIGHTGOLDENROD2;, ;LIGHTGOLDENROD3;, ;LIGHTGOLDENROD4;, ;LIGHTGOLDENRODYELLOW;, ;LIGHTGRAY;, ;LIGHTPINK;, ;LIGHTPINK1;, ;LIGHTPINK2;, ;LIGHTPINK3;, ;LIGHTPINK4;, ;LIGHTSALMON1;, ;LIGHTSALMON2;, ;LIGHTSALMON3;, ;LIGHTSALMON4;, ;LIGHTSEAGREEN;, ;LIGHTSKYBLUE;, ;LIGHTSKYBLUE1;, ;LIGHTSKYBLUE2;, ;LIGHTSKYBLUE3;, ;LIGHTSKYBLUE4;, ;LIGHTSLATEBLUE;, ;LIGHTSLATEGRAY;, ;LIGHTSTEELBLUE;, ;LIGHTSTEELBLUE1;, ;LIGHTSTEELBLUE2;, ;LIGHTSTEELBLUE3;, ;LIGHTSTEELBLUE4;, ;LIGHTYELLOW;, ;LIGHTYELLOW2;, ;LIGHTYELLOW3;, ;LIGHTYELLOW4;, ;LIMEGREEN;, ;LINEN;, ;MAGENTA1;, ;MAGENTA2;, ;MAGENTA3;, ;MAGENTA4;, ;MAROON;, ;MAROON1;, ;MAROON2;, ;MAROON3;, ;MAROON4;, ;MEDIUMAQUAMARINE;, ;MEDIUMORCHID;, ;MEDIUMORCHID1;, ;MEDIUMORCHID2;, ;MEDIUMORCHID3;, ;MEDIUMORCHID4;, ;MEDIUMPURPLE;, ;MEDIUMPURPLE1;, ;MEDIUMPURPLE2;, ;MEDIUMPURPLE3;, ;MEDIUMPURPLE4;, ;MEDIUMSEAGREEN;, ;MEDIUMSLATEBLUE;, ;MEDIUMSPRINGGREEN;, ;MEDIUMTURQUOISE;, ;MEDIUMVIOLETRED;, ;MIDNIGHTBLUE;, ;MINTCREAM;, ;MISTYROSE;, ;MISTYROSE2;, ;MISTYROSE3;, ;MISTYROSE4;, ;MOCCASIN;, ;NAVAJOWHITE1;, ;NAVAJOWHITE2;, ;NAVAJOWHITE3;, ;NAVAJOWHITE4;, ;NAVYBLUE;, ;OLDLACE;, ;OLIVEDRAB;, ;OLIVEDRAB1;, ;OLIVEDRAB2;, ;OLIVEDRAB3;, ;OLIVEDRAB4;, ;ORANGE;, ;ORANGE1;, ;ORANGE2;, ;ORANGE3;, ;ORANGE4;, ;ORANGERED;, ;ORANGERED1;, ;ORANGERED2;, ;ORANGERED3;, ;ORANGERED4;, ;ORCHID;, ;ORCHID1;, ;ORCHID2;, ;ORCHID3;, ;ORCHID4;, ;PALEGOLDENROD;, ;PALEGREEN;, ;PALEGREEN1;, ;PALEGREEN2;, ;PALEGREEN3;, ;PALEGREEN4;, ;PALETURQUOISE;, ;PALETURQUOISE1;, ;PALETURQUOISE2;, ;PALETURQUOISE3;, ;PALETURQUOISE4;, ;PALEVIOLETRED;, ;PALEVIOLETRED1;, ;PALEVIOLETRED2;, ;PALEVIOLETRED3;, ;PALEVIOLETRED4;, ;PAPAYAWHIP;, ;PEACHPUFF;, ;PEACHPUFF2;, ;PEACHPUFF3;, ;PEACHPUFF4;, ;PERU;, ;PINK;, ;PINK1;, ;PINK2;, ;PINK3;, ;PINK4;, ;PLUM;, ;PLUM1;, ;PLUM2;, ;PLUM3;, ;PLUM4;, ;POWDERBLUE;, ;PURPLE;, ;PURPLE1;, ;PURPLE2;, ;PURPLE3;, ;PURPLE4;, ;RED;, ;RED1;, ;RED2;, ;RED3;, ;RED4;, ;ROSYBROWN;, ;ROSYBROWN1;, ;ROSYBROWN2;, ;ROSYBROWN3;, ;ROSYBROWN4;, ;ROYALBLUE;, ;ROYALBLUE1;, ;ROYALBLUE2;, ;ROYALBLUE3;, ;ROYALBLUE4;, ;SADDLEBROWN;, ;SALMON;, ;SALMON1;, ;SALMON2;, ;SALMON3;, ;SALMON4;, ;SANDYBROWN;, ;SEAGREEN;, ;SEAGREEN1;, ;SEAGREEN2;, ;SEAGREEN3;, ;SEAGREEN4;, ;SEASHELL;, ;SEASHELL2;, ;SEASHELL3;, ;SEASHELL4;, ;BEET;, ;TEAL;, ;SIENNA;, ;SIENNA1;, ;SIENNA2;, ;SIENNA3;, ;SIENNA4;, ;SKYBLUE;, ;SKYBLUE1;, ;SKYBLUE2;, ;SKYBLUE3;, ;SKYBLUE4;, ;SLATEBLUE;, ;SLATEBLUE1;, ;SLATEBLUE2;, ;SLATEBLUE3;, ;SLATEBLUE4;, ;SLATEGRAY1;, ;SLATEGRAY2;, ;SLATEGRAY3;, ;SLATEGRAY4;, ;SLATEGRAY;, ;SNOW;, ;SNOW2;, ;SNOW3;, ;SNOW4;, ;SPRINGGREEN;, ;SPRINGGREEN2;, ;SPRINGGREEN3;, ;SPRINGGREEN4;, ;STEELBLUE;, ;STEELBLUE1;, ;STEELBLUE2;, ;STEELBLUE3;, ;STEELBLUE4;, ;TAN;, ;TAN1;, ;TAN2;, ;TAN3;, ;TAN4;, ;THISTLE;, ;THISTLE1;, ;THISTLE2;, ;THISTLE3;, ;THISTLE4;, ;TOMATO;, ;TOMATO1;, ;TOMATO2;, ;TOMATO3;, ;TOMATO4;, ;TURQUOISE;, ;TURQUOISE1;, ;TURQUOISE2;, ;TURQUOISE3;, ;TURQUOISE4;, ;VIOLET;, ;VIOLETRED;, ;VIOLETRED1;, ;VIOLETRED2;, ;VIOLETRED3;, ;VIOLETRED4;, ;WHEAT;, ;WHEAT1;, ;WHEAT2;, ;WHEAT3;, ;WHEAT4;, ;WHITE;, ;WHITESMOKE;, ;YELLOW;, ;YELLOW1;, ;YELLOW2;, ;YELLOW3;, ;YELLOW4; and ;YELLOWGREEN;**.
+Possible *colorname* is: *BLACK*, *MATRAGRAY*, *MATRABLUE*, *ALICEBLUE*, *ANTIQUEWHITE*, *ANTIQUEWHITE1*, *ANTIQUEWHITE2*, *ANTIQUEWHITE3*, *ANTIQUEWHITE4*, *AQUAMARINE1*, *AQUAMARINE2*, *AQUAMARINE4*, *AZURE*, *AZURE2*, *AZURE3*, *AZURE4*, *BEIGE*, *BISQUE*, *BISQUE2*, *BISQUE3*, *BISQUE4*, *BLANCHEDALMOND*, *BLUE1*, *BLUE2*, *BLUE3*, *BLUE4*, *BLUEVIOLET*, *BROWN*, *BROWN1*, *BROWN2*, *BROWN3*, *BROWN4*, *BURLYWOOD*, *BURLYWOOD1*, *BURLYWOOD2*, *BURLYWOOD3*, *BURLYWOOD4*, *CADETBLUE*, *CADETBLUE1*, *CADETBLUE2*, *CADETBLUE3*, *CADETBLUE4*, *CHARTREUSE*, *CHARTREUSE1*, *CHARTREUSE2*, *CHARTREUSE3*, *CHARTREUSE4*, *CHOCOLATE*, *CHOCOLATE1*, *CHOCOLATE2*, *CHOCOLATE3*, *CHOCOLATE4*, *CORAL*, *CORAL1*, *CORAL2*, *CORAL3*, *CORAL4*, *CORNFLOWERBLUE*, *CORNSILK1*, *CORNSILK2*, *CORNSILK3*, *CORNSILK4*, *CYAN1*, *CYAN2*, *CYAN3*, *CYAN4*, *DARKGOLDENROD*, *DARKGOLDENROD1*, *DARKGOLDENROD2*, *DARKGOLDENROD3*, *DARKGOLDENROD4*, *DARKGREEN*, *DARKKHAKI*, *DARKOLIVEGREEN*, *DARKOLIVEGREEN1*, *DARKOLIVEGREEN2*, *DARKOLIVEGREEN3*, *DARKOLIVEGREEN4*, *DARKORANGE*, *DARKORANGE1*, *DARKORANGE2*, *DARKORANGE3*, *DARKORANGE4*, *DARKORCHID*, *DARKORCHID1*, *DARKORCHID2*, *DARKORCHID3*, *DARKORCHID4*, *DARKSALMON*, *DARKSEAGREEN*, *DARKSEAGREEN1*, *DARKSEAGREEN2*, *DARKSEAGREEN3*, *DARKSEAGREEN4*, *DARKSLATEBLUE*, *DARKSLATEGRAY1*, *DARKSLATEGRAY2*, *DARKSLATEGRAY3*, *DARKSLATEGRAY4*, *DARKSLATEGRAY*, *DARKTURQUOISE*, *DARKVIOLET*, *DEEPPINK*, *DEEPPINK2*, *DEEPPINK3*, *DEEPPINK4*, *DEEPSKYBLUE1*, *DEEPSKYBLUE2*, *DEEPSKYBLUE3*, *DEEPSKYBLUE4*, *DODGERBLUE1*, *DODGERBLUE2*, *DODGERBLUE3*, *DODGERBLUE4*, *FIREBRICK*, *FIREBRICK1*, *FIREBRICK2*, *FIREBRICK3*, *FIREBRICK4*, *FLORALWHITE*, *FORESTGREEN*, *GAINSBORO*, *GHOSTWHITE*, *GOLD*, *GOLD1*, *GOLD2*, *GOLD3*, *GOLD4*, *GOLDENROD*, *GOLDENROD1*, *GOLDENROD2*, *GOLDENROD3*, *GOLDENROD4*, *GRAY*, *GRAY0*, *GRAY1*, *GRAY10*, *GRAY11*, *GRAY12*, *GRAY13*, *GRAY14*, *GRAY15*, *GRAY16*, *GRAY17*, *GRAY18*, *GRAY19*, *GRAY2*, *GRAY20*, *GRAY21*, *GRAY22*, *GRAY23*, *GRAY24*, *GRAY25*, *GRAY26*, *GRAY27*, *GRAY28*, *GRAY29*, *GRAY3*, *GRAY30*, *GRAY31*, *GRAY32*, *GRAY33*, *GRAY34*, *GRAY35*, *GRAY36*, *GRAY37*, *GRAY38*, *GRAY39*, *GRAY4*, *GRAY40*, *GRAY41*, *GRAY42*, *GRAY43*, *GRAY44*, *GRAY45*, *GRAY46*, *GRAY47*, *GRAY48*, *GRAY49*, *GRAY5*, *GRAY50*, *GRAY51*, *GRAY52*, *GRAY53*, *GRAY54*, *GRAY55*, *GRAY56*, *GRAY57*, *GRAY58*, *GRAY59*, *GRAY6*, *GRAY60*, *GRAY61*, *GRAY62*, *GRAY63*, *GRAY64*, *GRAY65*, *GRAY66*, *GRAY67*, *GRAY68*, *GRAY69*, *GRAY7*, *GRAY70*, *GRAY71*, *GRAY72*, *GRAY73*, *GRAY74*, *GRAY75*, *GRAY76*, *GRAY77*, *GRAY78*, *GRAY79*, *GRAY8*, *GRAY80*, *GRAY81*, *GRAY82*, *GRAY83*, *GRAY85*, *GRAY86*, *GRAY87*, *GRAY88*, *GRAY89*, *GRAY9*, *GRAY90*, *GRAY91*, *GRAY92*, *GRAY93*, *GRAY94*, *GRAY95*, *GREEN*, *GREEN1*, *GREEN2*, *GREEN3*, *GREEN4*, *GREENYELLOW*, *GRAY97*, *GRAY98*, *GRAY99*, *HONEYDEW*, *HONEYDEW2*, *HONEYDEW3*, *HONEYDEW4*, *HOTPINK*, *HOTPINK1*, *HOTPINK2*, *HOTPINK3*, *HOTPINK4*, *INDIANRED*, *INDIANRED1*, *INDIANRED2*, *INDIANRED3*, *INDIANRED4*, *IVORY*, *IVORY2*, *IVORY3*, *IVORY4*, *KHAKI*, *KHAKI1*, *KHAKI2*, *KHAKI3*, *KHAKI4*, *LAVENDER*, *LAVENDERBLUSH1*, *LAVENDERBLUSH2*, *LAVENDERBLUSH3*, *LAVENDERBLUSH4*, *LAWNGREEN*, *LEMONCHIFFON1*, *LEMONCHIFFON2*, *LEMONCHIFFON3*, *LEMONCHIFFON4*, *LIGHTBLUE*, *LIGHTBLUE1*, *LIGHTBLUE2*, *LIGHTBLUE3*, *LIGHTBLUE4*, *LIGHTCORAL*, *LIGHTCYAN1*, *LIGHTCYAN2*, *LIGHTCYAN3*, *LIGHTCYAN4*, *LIGHTGOLDENROD*, *LIGHTGOLDENROD1*, *LIGHTGOLDENROD2*, *LIGHTGOLDENROD3*, *LIGHTGOLDENROD4*, *LIGHTGOLDENRODYELLOW*, *LIGHTGRAY*, *LIGHTPINK*, *LIGHTPINK1*, *LIGHTPINK2*, *LIGHTPINK3*, *LIGHTPINK4*, *LIGHTSALMON1*, *LIGHTSALMON2*, *LIGHTSALMON3*, *LIGHTSALMON4*, *LIGHTSEAGREEN*, *LIGHTSKYBLUE*, *LIGHTSKYBLUE1*, *LIGHTSKYBLUE2*, *LIGHTSKYBLUE3*, *LIGHTSKYBLUE4*, *LIGHTSLATEBLUE*, *LIGHTSLATEGRAY*, *LIGHTSTEELBLUE*, *LIGHTSTEELBLUE1*, *LIGHTSTEELBLUE2*, *LIGHTSTEELBLUE3*, *LIGHTSTEELBLUE4*, *LIGHTYELLOW*, *LIGHTYELLOW2*, *LIGHTYELLOW3*, *LIGHTYELLOW4*, *LIMEGREEN*, *LINEN*, *MAGENTA1*, *MAGENTA2*, *MAGENTA3*, *MAGENTA4*, *MAROON*, *MAROON1*, *MAROON2*, *MAROON3*, *MAROON4*, *MEDIUMAQUAMARINE*, *MEDIUMORCHID*, *MEDIUMORCHID1*, *MEDIUMORCHID2*, *MEDIUMORCHID3*, *MEDIUMORCHID4*, *MEDIUMPURPLE*, *MEDIUMPURPLE1*, *MEDIUMPURPLE2*, *MEDIUMPURPLE3*, *MEDIUMPURPLE4*, *MEDIUMSEAGREEN*, *MEDIUMSLATEBLUE*, *MEDIUMSPRINGGREEN*, *MEDIUMTURQUOISE*, *MEDIUMVIOLETRED*, *MIDNIGHTBLUE*, *MINTCREAM*, *MISTYROSE*, *MISTYROSE2*, *MISTYROSE3*, *MISTYROSE4*, *MOCCASIN*, *NAVAJOWHITE1*, *NAVAJOWHITE2*, *NAVAJOWHITE3*, *NAVAJOWHITE4*, *NAVYBLUE*, *OLDLACE*, *OLIVEDRAB*, *OLIVEDRAB1*, *OLIVEDRAB2*, *OLIVEDRAB3*, *OLIVEDRAB4*, *ORANGE*, *ORANGE1*, *ORANGE2*, *ORANGE3*, *ORANGE4*, *ORANGERED*, *ORANGERED1*, *ORANGERED2*, *ORANGERED3*, *ORANGERED4*, *ORCHID*, *ORCHID1*, *ORCHID2*, *ORCHID3*, *ORCHID4*, *PALEGOLDENROD*, *PALEGREEN*, *PALEGREEN1*, *PALEGREEN2*, *PALEGREEN3*, *PALEGREEN4*, *PALETURQUOISE*, *PALETURQUOISE1*, *PALETURQUOISE2*, *PALETURQUOISE3*, *PALETURQUOISE4*, *PALEVIOLETRED*, *PALEVIOLETRED1*, *PALEVIOLETRED2*, *PALEVIOLETRED3*, *PALEVIOLETRED4*, *PAPAYAWHIP*, *PEACHPUFF*, *PEACHPUFF2*, *PEACHPUFF3*, *PEACHPUFF4*, *PERU*, *PINK*, *PINK1*, *PINK2*, *PINK3*, *PINK4*, *PLUM*, *PLUM1*, *PLUM2*, *PLUM3*, *PLUM4*, *POWDERBLUE*, *PURPLE*, *PURPLE1*, *PURPLE2*, *PURPLE3*, *PURPLE4*, *RED*, *RED1*, *RED2*, *RED3*, *RED4*, *ROSYBROWN*, *ROSYBROWN1*, *ROSYBROWN2*, *ROSYBROWN3*, *ROSYBROWN4*, *ROYALBLUE*, *ROYALBLUE1*, *ROYALBLUE2*, *ROYALBLUE3*, *ROYALBLUE4*, *SADDLEBROWN*, *SALMON*, *SALMON1*, *SALMON2*, *SALMON3*, *SALMON4*, *SANDYBROWN*, *SEAGREEN*, *SEAGREEN1*, *SEAGREEN2*, *SEAGREEN3*, *SEAGREEN4*, *SEASHELL*, *SEASHELL2*, *SEASHELL3*, *SEASHELL4*, *BEET*, *TEAL*, *SIENNA*, *SIENNA1*, *SIENNA2*, *SIENNA3*, *SIENNA4*, *SKYBLUE*, *SKYBLUE1*, *SKYBLUE2*, *SKYBLUE3*, *SKYBLUE4*, *SLATEBLUE*, *SLATEBLUE1*, *SLATEBLUE2*, *SLATEBLUE3*, *SLATEBLUE4*, *SLATEGRAY1*, *SLATEGRAY2*, *SLATEGRAY3*, *SLATEGRAY4*, *SLATEGRAY*, *SNOW*, *SNOW2*, *SNOW3*, *SNOW4*, *SPRINGGREEN*, *SPRINGGREEN2*, *SPRINGGREEN3*, *SPRINGGREEN4*, *STEELBLUE*, *STEELBLUE1*, *STEELBLUE2*, *STEELBLUE3*, *STEELBLUE4*, *TAN*, *TAN1*, *TAN2*, *TAN3*, *TAN4*, *THISTLE*, *THISTLE1*, *THISTLE2*, *THISTLE3*, *THISTLE4*, *TOMATO*, *TOMATO1*, *TOMATO2*, *TOMATO3*, *TOMATO4*, *TURQUOISE*, *TURQUOISE1*, *TURQUOISE2*, *TURQUOISE3*, *TURQUOISE4*, *VIOLET*, *VIOLETRED*, *VIOLETRED1*, *VIOLETRED2*, *VIOLETRED3*, *VIOLETRED4*, *WHEAT*, *WHEAT1*, *WHEAT2*, *WHEAT3*, *WHEAT4*, *WHITE*, *WHITESMOKE*, *YELLOW*, *YELLOW1*, *YELLOW2*, *YELLOW3*, *YELLOW4* and *YELLOWGREEN*.
+@subsubsection occt_draw_4_3_11 vunsetcolor
-
-@subsubsection occt_draw_4_311 vunsetcolor
-
-Syntax: vunsetcolor [shapename]
+Syntax:
+~~~~~
+vunsetcolor [shapename]
+~~~~~
Sets default color for all, selected or named shapes.
-@subsubsection occt_draw_4_312 vsettransparency
+@subsubsection occt_draw_4_3_12 vsettransparency
-Syntax: vsettransparency [shapename] coeficient
+Syntax:
+~~~~~
+vsettransparency [shapename] coeficient
+~~~~~
-Sets transparency for all selected or named shapes. The **Coefficient** may be between 0.0 (opaque) and 1.0 (fully transparent). Warning: at 1.0 the shape becomes invisible.
+Sets transparency for all selected or named shapes. The *coefficient* may be between 0.0 (opaque) and 1.0 (fully transparent).
+
+**Warning**: at 1.0 the shape becomes invisible.
+
**Example:**
-
+~~~~~
vinit
box b 10 10 10
psphere s 20
vdisplay b s
vfit
vsetdispmode 1
-vsettransparency b 0.5
+vsettransparency b 0.5
+~~~~~
-@subsubsection occt_draw_4_313 vunsettransparency
+@subsubsection occt_draw_4_3_13 vunsettransparency
-Syntax: vunsettransparency [shapename]
+Syntax:
+~~~~~
+vunsettransparency [shapename]
+~~~~~
Sets default transparency (0.0) for all selected or named shapes.
-@subsubsection occt_draw_4_314 vsetmaterial
+@subsubsection occt_draw_4_3_14 vsetmaterial
-Syntax: vsetmaterial [shapename] materialname
+Syntax:
+~~~~~
+vsetmaterial [shapename] materialname
+~~~~~
Sets material for all selected or named shapes.
-**materialname** is ***BRASS*, *BRONZE*, *COPPER*, *GOLD*, *PEWTER*, *PLASTER*, *PLASTIC*, *SILVER*, *STEEL*, *STONE*, *SHINY_PLASTIC*, *SATIN*, *METALIZED*, *NEON_GNC*, *CHROME*, *ALUMINIUM*, *OBSIDIAN*, *NEON_PHC*, *JADE*.**
-**Example:**
+**materialname** can be *BRASS*, *BRONZE*, *COPPER*, *GOLD*, *PEWTER*, *PLASTER*, *PLASTIC*, *SILVER*, *STEEL*, *STONE*, *SHINY_PLASTIC*, *SATIN*, *METALIZED*, *NEON_GNC*, *CHROME*, *ALUMINIUM*, *OBSIDIAN*, *NEON_PHC* or *JADE*.
+
+**Example:**
+~~~~~
vinit
psphere s 20
vdisplay s
vfit
vsetdispmode 1
vsetmaterial s JADE
+~~~~~
-@subsubsection occt_draw_4_315 vunsetmaterial
+@subsubsection occt_draw_4_3_15 vunsetmaterial
-Syntax: vunsetmaterial [shapename]
+Syntax:
+~~~~~
+vunsetmaterial [shapename]
+~~~~~
Sets default material for all selected or named shapes.
-@subsubsection occt_draw_4_316 vsetwidth
+@subsubsection occt_draw_4_3_16 vsetwidth
-Syntax: vsetwidth [shapename] coeficient
+Syntax:
+~~~~~
+vsetwidth [shapename] coeficient
+~~~~~
Sets width of the edges for all selected or named shapes.
-The **Coefficient** may be between 0.0 and 10.0.
+The *coefficient* may be between 0.0 and 10.0.
+
**Example:**
-
+~~~~~
vinit
box b 10 10 10
vdisplay b
vfit
-vsetwidth b 5
+vsetwidth b 5
+~~~~~
-@subsubsection occt_draw_4_317 vunsetwidth
+@subsubsection occt_draw_4_3_17 vunsetwidth
-Syntax: vunsetwidth [shapename]
+Syntax:
+~~~~~
+vunsetwidth [shapename]
+~~~~~
Sets default width of edges (0.0) for all selected or named shapes.
-@subsubsection occt_draw_4_318 vsetshading
+@subsubsection occt_draw_4_3_18 vsetshading
-Syntax: vsetshading shapename [coefficient]
+Syntax:
+~~~~~
+vsetshading shapename [coefficient]
+~~~~~
Sets deflection coefficient that defines the quality of the shape’s representation in the shading mode. Default coefficient is 0.0008.
-**Example:**
+**Example:**
+~~~~~
vinit
psphere s 20
vdisplay s
vfit
vsetdispmode 1
-vsetshading s 0.005
-@subsubsection occt_draw_4_319 vunsetshading
+vsetshading s 0.005
+~~~~~
+
+@subsubsection occt_draw_4_3_19 vunsetshading
-Syntax: vunsetshading [shapename]
+Syntax:
+~~~~~
+vunsetshading [shapename]
+~~~~~
Sets default deflection coefficient (0.0008) that defines the quality of the shape’s representation in the shading mode. Default coefficient is 0.0008.
-@subsubsection occt_draw_4_320 vsetam
+@subsubsection occt_draw_4_3_20 vsetam
-Syntax: vsetam [shapename] mode
+Syntax:
+~~~~~
+vsetam [shapename] mode
+~~~~~
-Activates selection mode for all selected or named shapes.
-**mode** is **0** for **shape** itself, **1** for **vertices**, **2** for **edges**, **3** for **wires**, **4** for **faces**, **5** for **shells**, **6** for **solids**, **7** for **compounds**.
+Activates selection mode for all selected or named shapes:
+* *0* for *shape* itself,
+* *1* (*vertices*),
+* *2* (*edges*),
+* *3* (*wires*),
+* *4* (*faces*),
+* *5* (*shells*),
+* *6* (*solids*),
+* *7* (*compounds*).
+
**Example:**
-
+~~~~~
vinit
box b 10 10 10
vdisplay b
vfit
-vsetam b 2
-@subsubsection occt_draw_4_321 vunsetam
+vsetam b 2
+~~~~~
+
+@subsubsection occt_draw_4_3_21 vunsetam
-Syntax: vunsetam
+Syntax:
+~~~~~
+vunsetam
+~~~~~
Deactivates all selection modes for all shapes.
-@subsubsection occt_draw_4_322 vdump
+@subsubsection occt_draw_4_3_22 vdump
-Syntax: vdump filename.{png|xwd|bmp}
+Syntax:
+~~~~~
+vdump .{png|xwd|bmp}
+~~~~~
Extracts the contents of the viewer window to a png, XWD or BMP file.
-@subsubsection occt_draw_4_323 vdir
+@subsubsection occt_draw_4_3_23 vdir
-Syntax: vdir
+Syntax:
+~~~~~
+vdir
+~~~~~
Displays the list of displayed objects.
-@subsubsection occt_draw_4_324 vsub
+@subsubsection occt_draw_4_3_24 vsub
-Syntax: vsub 0/1(on/off)[shapename]
+Syntax:
+~~~~~
+vsub 0/1(on/off)[shapename]
+~~~~~
-Hilights/unhilights named or selected objects which are displayed at neutral state with subintensity color.
+Hilights/unhilights named or selected objects which are displayed at neutral state with subintensity color.
+
**Example:**
-
+~~~~~
vinit
box b 10 10 10
psphere s 20
vdisplay b s
vfit
vsetdispmode 1
-vsub b 1
+vsub b 1
+~~~~~
-@subsubsection occt_draw_4_325 vardis
+@subsubsection occt_draw_4_3_25 vardis
-Syntax: vardis
+Syntax:
+~~~~~
+vardis
+~~~~~
Displays active areas (for each activated sensitive entity, one or several 2D bounding boxes are displayed, depending on the implementation of a particular entity).
-@subsubsection occt_draw_4_326 varera
+@subsubsection occt_draw_4_3_26 varera
-Syntax: varera
+Syntax:
+~~~~~
+varera
+~~~~~
Erases active areas.
-@subsubsection occt_draw_4_327 vsensdis
+@subsubsection occt_draw_4_3_27 vsensdis
-Syntax: vsensdis
+Syntax:
+~~~~~
+vsensdis
+~~~~~
Displays active entities (sensitive entities of one of the standard types corresponding to active selection modes).
@@ -1807,1345 +1884,1581 @@ Standard entity types are those defined in Select3D package:
* sensitive triangle
Custom (application-defined) sensitive entity types are not processed by this command.
-@subsubsection occt_draw_4_328 vsensera
+@subsubsection occt_draw_4_3_28 vsensera
-Syntax: vsensera
+Syntax:
+~~~~~
+vsensera
+~~~~~
Erases active entities.
-@subsubsection occt_draw_4_329 vperf
+@subsubsection occt_draw_4_3_29 vperf
-Syntax: vperf shapename 1/0 (Transformation/Loacation) 1/0 (Primitives sensibles ON/OFF)
+Syntax:
+~~~~~
+vperf shapename 1/0 (Transformation/Loacation) 1/0 (Primitives sensibles ON/OFF)
+~~~~~
Tests the animation of an object along a predefined trajectory.
-**Example:**
+**Example:**
+~~~~~
vinit
box b 10 10 10
psphere s 20
vdisplay b s
vfit
vsetdispmode 0
-vperf b 1 1
-@subsubsection occt_draw_4_330 vr
+vperf b 1 1
+~~~~~
+
+@subsubsection occt_draw_4_3_30 vr
-Syntax: vr filename
+Syntax:
+~~~~~
+vr filename
+~~~~~
Reads shape from BREP-format file and displays it in the viewer.
+
**Example:**
-
+~~~~~
vinit
-vr myshape.brep
-@subsubsection occt_draw_4_330331 vstate
+vr myshape.brep
+~~~~~
+
+@subsubsection occt_draw_4_3_31 vstate
-Syntax: vstate [name1] … [name n]
+Syntax:
+~~~~~
+vstate [name1] … [name n]
+~~~~~
Makes a list of the status (**Displayed** or **Not Displayed**) of some selected or named objects.
+@subsection occt_draw_4_4 AIS viewer – object commands
-@subsection occt_draw_4_3304 AIS viewer – object commands
+@subsubsection occt_draw_4_4_1 vtrihedron
-@subsubsection occt_draw_4_33041 vtrihedron
+Syntax:
+~~~~~
+vtrihedron name [X0] [Y0] [Z0] [Zu] [Zv] [Zw] [Xu] [Xv] [Xw]
+~~~~~
-Syntax: vtrihedron name [X0] [Y0] [Z0] [Zu] [Zv] [Zw] [Xu] [Xv] [Xw]
-
-Creates a new AIS_Trihedron object. If no argument is set, the default trihedron (0XYZ) is created.
+Creates a new *AIS_Trihedron* object. If no argument is set, the default trihedron (0XYZ) is created.
+
**Example:**
-
+~~~~~
vinit
-vtrihedron tr
+vtrihedron tr
+~~~~~
-@subsubsection occt_draw_4_33042 vplanetri
+@subsubsection occt_draw_4_4_2 vplanetri
-Syntax: vplanetri name
+Syntax:
+~~~~~
+vplanetri name
+~~~~~
Creates a plane from a trihedron selection.
-@subsubsection occt_draw_4_33043 vsize
+@subsubsection occt_draw_4_4_3 vsize
-Syntax: vsize [name] [size]
+Syntax:
+~~~~~
+vsize [name] [size]
+~~~~~
-Changes the size of a named or selected trihedron. If the name is not defined: it affects the selected trihedrons otherwise nothing is done. If the value is not defined, it is set to 100 by default.
+Changes the size of a named or selected trihedron. If the name is not defined: it affects the selected trihedrons otherwise nothing is done. If the value is not defined, it is set to 100 by default.
+
**Example:**
-
+~~~~~
vinit
vtrihedron tr1
vtrihedron tr2 0 0 0 1 0 0 1 0 0
-vsize tr2 400
+vsize tr2 400
+~~~~~
-@subsubsection occt_draw_4_33044 vaxis
+@subsubsection occt_draw_4_4_4 vaxis
-Syntax: vaxis name [Xa Ya Za Xb Yb Zb]
+Syntax:
+~~~~~
+vaxis name [Xa Ya Za Xb Yb Zb]
+~~~~~
-Creates an axis. If the values are not defined, an axis is created by interactive selection of two vertices or one edge
+Creates an axis. If the values are not defined, an axis is created by interactive selection of two vertices or one edge
+
**Example:**
-
+~~~~~
vinit
vtrihedron tr
vaxis axe1 0 0 0 1 0 0
+~~~~~
-@subsubsection occt_draw_4_33045 vaxispara
+@subsubsection occt_draw_4_4_5 vaxispara
-Syntax: vaxispara nom
+Syntax:
+~~~~~
+vaxispara nom
+~~~~~
Creates an axis by interactive selection of an edge and a vertex.
-@subsubsection occt_draw_4_33046 vaxisortho
+@subsubsection occt_draw_4_4_6 vaxisortho
-Syntax: vaxisotrho name
+Syntax:
+~~~~~
+vaxisotrho name
+~~~~~
Creates an axis by interactive selection of an edge and a vertex. The axis will be orthogonal to the selected edge.
-@subsubsection occt_draw_4_33047 vpoint
+@subsubsection occt_draw_4_4_7 vpoint
-Syntax: vpoint name [Xa Ya Za]
+Syntax:
+~~~~~
+vpoint name [Xa Ya Za]
+~~~~~
Creates a point from coordinates. If the values are not defined, a point is created by interactive selection of a vertice or an edge (in the center of the edge).
-**Example:**
+**Example:**
+~~~~~
vinit
vpoint p 0 0 0
+~~~~~
-@subsubsection occt_draw_4_33048 vplane
+@subsubsection occt_draw_4_4_8 vplane
-Syntax: vplane name [AxisName] [PointName]
- vplane name [PointName] [PointName] [PointName]
- vplane name [PlaneName] [PointName]
+Syntax:
+~~~~~
+vplane name [AxisName] [PointName]
+vplane name [PointName] [PointName] [PointName]
+vplane name [PlaneName] [PointName]
+~~~~~
-Creates a plane from named or interactively selected entities.
+Creates a plane from named or interactively selected entities.
+
**Example:**
-
+~~~~~
vinit
vpoint p1 0 50 0
vaxis axe1 0 0 0 0 0 1
vtrihedron tr
vplane plane1 axe1 p1
+~~~~~
-@subsubsection occt_draw_4_33049 vplanepara
+@subsubsection occt_draw_4_4_9 vplanepara
-Syntax: vplanepara name
+Syntax:
+~~~~~
+vplanepara name
+~~~~~
Creates a plane from interactively selected vertex and face.
-@subsubsection occt_draw_4_330410 vplaneortho
+@subsubsection occt_draw_4_4_10 vplaneortho
-Syntax: vplaneortho name
+Syntax:
+~~~~~
+vplaneortho name
+~~~~~
Creates a plane from interactive selected face and coplanar edge.
-@subsubsection occt_draw_4_330411 vline
+@subsubsection occt_draw_4_4_11 vline
-Syntax: vline name [PointName] [PointName]
- vline name [Xa Ya Za Xb Yb Zb]
+Syntax:
+~~~~~
+vline name [PointName] [PointName]
+vline name [Xa Ya Za Xb Yb Zb]
+~~~~~
Creates a line from coordinates, named or interactively selected vertices.
-**Example:**
+**Example:**
+~~~~~
vinit
vtrihedron tr
vpoint p1 0 50 0
vpoint p2 50 0 0
vline line1 p1 p2
vline line2 0 0 0 50 0 1
+~~~~~
-@subsubsection occt_draw_4_330412 vcircle
+@subsubsection occt_draw_4_4_12 vcircle
-Syntax: vcircle name [PointName PointName PointName IsFilled]
+Syntax:
+~~~~~
+vcircle name [PointName PointName PointName IsFilled]
vcircle name [PlaneName PointName Radius IsFilled]
+~~~~~
-Creates a circle from named or interactively selected entities. Parameter IsFilled is defined as 0 or 1.
+Creates a circle from named or interactively selected entities. Parameter IsFilled is defined as 0 or 1.
+
**Example:**
-
+~~~~~
vinit
vtrihedron tr
vpoint p1 0 50 0
vpoint p2 50 0 0
vpoint p3 0 0 0
-vcircle circle1 p1 p2 p3 1
+vcircle circle1 p1 p2 p3 1
+~~~~~
+@subsubsection occt_draw_4_4_13 vtri2d
-@subsubsection occt_draw_4_330413 vtri2d
-
-Syntax: vtri2d name
+Syntax:
+~~~~~
+vtri2d name
+~~~~~
Creates a plane with a 2D trihedron from an interactively selected face.
-@subsubsection occt_draw_4_330414 vselmode
+@subsubsection occt_draw_4_4_14 vselmode
-Syntax: vselmode [object] mode On/Off
+Syntax:
+~~~~~
+vselmode [object] mode On/Off
+~~~~~
Sets the selection mode for an object. If the object value is not defined, the selection mode is set for all displayed objects.
-Value On is defined as 1 and Off – as 0.
-**Example:**
+Value *On* is defined as 1 and *Off* – as 0.
+**Example:**
+~~~~~
vinit
vpoint p1 0 0 0
vpoint p2 50 0 0
vpoint p3 25 40 0
vtriangle triangle1 p1 p2 p3
-@subsubsection occt_draw_4_330415 vconnect, vconnectsh
+~~~~~
-Syntax: vconnect name object Xo Yo Zo Xu Xv Xw Zu Zv Zw
- vconnectsh name shape Xo Yo Zo Xu Xv Xw Zu Zv Zw
+@subsubsection occt_draw_4_4_15 vconnect, vconnectsh
+
+Syntax:
+~~~~~
+vconnect name object Xo Yo Zo Xu Xv Xw Zu Zv Zw
+vconnectsh name shape Xo Yo Zo Xu Xv Xw Zu Zv Zw
+~~~~~
Creates and displays an object with input location connected to a named entity.
-The difference between these two commands is that the object created by vconnect does not support the selection modes differrent from 0.
-**Example:**
+The difference between these two commands is that the object created by *vconnect* does not support the selection modes different from 0.
+**Example:**
+~~~~~
Vinitvinit
vpoint p1 0 0 0
vpoint p2 50 0 0
vsegment segment p1 p2
restore CrankArm.brep obj
vdisplay obj
-vconnectsh new obj 100100100 1 0 0 0 0 1
+vconnectsh new obj 100100100 1 0 0 0 0 1
+~~~~~
+@subsubsection occt_draw_4_4_16 vtriangle
-
-@subsubsection occt_draw_4_330416 vtriangle
-
-Syntax: vtriangle name PointName PointName PointName
+Syntax:
+~~~~~
+vtriangle name PointName PointName PointName
+~~~~~
Creates and displays a filled triangle from named points.
-**Example:**
+**Example:**
+~~~~~
vinit
vpoint p1 0 0 0
vpoint p2 50 0 0
vpoint p3 25 40 0
-vtriangle triangle1 p1 p2 p3
+vtriangle triangle1 p1 p2 p3
+~~~~~
-@subsubsection occt_draw_4_330417 vsegment
+@subsubsection occt_draw_4_4_17 vsegment
-Syntax: vsegment name PointName PointName
+Syntax:
+~~~~~
+vsegment name PointName PointName
+~~~~~
Creates and displays a segment from named points.
-**Example:**
+**Example:**
+~~~~~
Vinit
vpoint p1 0 0 0
vpoint p2 50 0 0
vsegment segment p1 p2
+~~~~~
+@subsection occt_draw_4_5 AIS viewer – Mesh Visualization Service
-**MeshVS **(Mesh Visualization Service) component provides flexible means of displaying meshes with associated pre- and post- processor data.
+**MeshVS** (Mesh Visualization Service) component provides flexible means of displaying meshes with associated pre- and post- processor data.
+@subsubsection occt_draw_4_5_1 meshfromstl
+Syntax:
+~~~~~
+meshfromstl meshname file
+~~~~~
-@subsection occt_draw_4_3305 AIS viewer – Mesh Visualization Service
+Creates a *MeshVS_Mesh* object based on STL file data. The object will be displayed immediately.
+
+**Example:**
+~~~~~
+meshfromstl mesh myfile.stl
+~~~~~
-@subsubsection occt_draw_4_33051 meshfromstl
+@subsubsection occt_draw_4_5_2 meshdispmode
-Syntax: meshfromstl meshname file
+Syntax:
+~~~~~
+meshdispmode meshname displaymode
+~~~~~
+
+Changes the display mode of object **meshname**. The **displaymode** is integer, which can be:
+* *1* for *wireframe*,
+* *2* for *shading* mode, or
+* *3* for *shrink* mode.
-Creates a MeshVS_Mesh object based on STL file data. The object will be displayed immediately.
**Example:**
-
-meshfromstl mesh myfile.stl
-
-@subsubsection occt_draw_4_33052 meshdispmode
-
-Syntax: meshdispmode meshname displaymode
-
-Changes the display mode of object **meshname**. The **displaymode** is integer, which can be **1** (for wireframe), **2** (for shading mode) or **3** (for shrink mode).
-**Example:**
-
+~~~~~
vinit
meshfromstl mesh myfile.stl
-meshdispmode mesh 2
+meshdispmode mesh 2
+~~~~~
-@subsubsection occt_draw_4_33053 meshselmode
+@subsubsection occt_draw_4_5_3 meshselmode
-Syntax: meshselmode meshname selectionmode
+Syntax:
+~~~~~
+meshselmode meshname selectionmode
+~~~~~
-Changes the selection mode of object **meshname**. The **selectionmode** is integer OR-combination of mode flags. The basic flags are the following:
-**1** – node selection,
-**2** – 0D elements (not suppored in STL)
-**4** – links (not supported in STL)
-**8** – faces
+Changes the selection mode of object **meshname**. The *selectionmode* is integer OR-combination of mode flags. The basic flags are the following:
+* *1* – node selection;
+* *2* – 0D elements (not supported in STL);
+* *4* – links (not supported in STL);
+* *8* – faces.
+
**Example:**
-
+~~~~~
vinit
meshfromstl mesh myfile.stl
-meshselmode mesh 1
+meshselmode mesh 1
+~~~~~
-@subsubsection occt_draw_4_33054 meshshadcolor
+@subsubsection occt_draw_4_5_4 meshshadcolor
-Syntax: meshshadcolor meshname red green blue
+Syntax:
+~~~~~
+meshshadcolor meshname red green blue
+~~~~~
-Changes the face interior color of object **meshname**. The **red**, **green** and **blue** are real values between **0** and **1**.
+Changes the face interior color of object **meshname**. The *red*, *green** and *blue* are real values between *0* and *1*.
+
**Example:**
-
+~~~~~
vinit
meshfromstl mesh myfile.stl
-meshshadcolormode mesh 0.5 0.5 0.5
+meshshadcolormode mesh 0.5 0.5 0.5
+~~~~~
-@subsubsection occt_draw_4_33055 meshlinkcolor
+@subsubsection occt_draw_4_5_5 meshlinkcolor
-Syntax: meshlinkcolor meshname red green blue
+Syntax:
+~~~~~
+meshlinkcolor meshname red green blue
+~~~~~
-Changes the color of face borders for object **meshname**. The **red**, **green** and **blue** are real values between **0** and **1**.
+Changes the color of face borders for object **meshname**. The *red*, *green* and *blue* are real values between *0* and *1*.
+
**Example:**
-
+~~~~~
vinit
meshfromstl mesh myfile.stl
-meshlinkcolormode mesh 0.5 0.5 0.5
+meshlinkcolormode mesh 0.5 0.5 0.5
+~~~~~
-@subsubsection occt_draw_4_33056 meshmat
+@subsubsection occt_draw_4_5_6 meshmat
-Syntax: meshmat meshname material
+Syntax:
+~~~~~
+meshmat meshname material
+~~~~~
-Changes the material of object **meshname**. **material** is represented with an integer value as follows (equivalent to enumeration Graphic3d_NameOfMaterial):
-**0 – BRASS,**
-**1 – BRONZE,**
-**2 - COPPER,**
-**3 - GOLD,**
-**4 - PEWTER,**
-**5 - PLASTER,**
-**6 - PLASTIC,**
-**7 - SILVER,**
-**8 - STEEL,**
-**9 - STONE,**
-**10 - SHINY_PLASTIC,**
-**11 - SATIN,**
-**12 - METALIZED,**
-**13 - NEON_GNC,**
-**14 - CHROME,**
-**15 - ALUMINIUM,**
-**16 - OBSIDIAN,**
-**17 - NEON_PHC,**
-**18 - JADE,**
-**19 - DEFAULT,**
-**20 - UserDefined**
+Changes the material of object **meshname**.
+
+*material* is represented with an integer value as follows (equivalent to enumeration *Graphic3d_NameOfMaterial*):
+* *0 – BRASS,*
+* *1 – BRONZE,*
+* *2 - COPPER,*
+* *3 - GOLD,*
+* *4 - PEWTER,*
+* *5 - PLASTER,*
+* *6 - PLASTIC,*
+* *7 - SILVER,*
+* *8 - STEEL,*
+* *9 - STONE,*
+* *10 - SHINY_PLASTIC,*
+* *11 - SATIN,*
+* *12 - METALIZED,*
+* *13 - NEON_GNC,*
+* *14 - CHROME,*
+* *15 - ALUMINIUM,*
+* *16 - OBSIDIAN,*
+* *17 - NEON_PHC,*
+* *18 - JADE,*
+* *19 - DEFAULT,*
+* *20 - UserDefined*
+
**Example:**
-
+~~~~~
vinit
meshfromstl mesh myfile.stl
meshmat mesh JADE
+~~~~~
-@subsubsection occt_draw_4_33057 meshshrcoef
+@subsubsection occt_draw_4_5_7 meshshrcoef
-Syntax: meshshrcoef meshname shrinkcoefficient
+Syntax:
+~~~~~
+meshshrcoef meshname shrinkcoefficient
+~~~~~
-Changes the value of shrink coefficient used in the shrink mode. In the shrink mode the face is shown as a congruent part of a usual face, so that **shrinkcoefficient** controls the value of this part. The **shrinkcoefficient** is a positive real number.
+Changes the value of shrink coefficient used in the shrink mode. In the shrink mode the face is shown as a congruent part of a usual face, so that *shrinkcoefficient* controls the value of this part. The *shrinkcoefficient* is a positive real number.
+
**Example:**
-
+~~~~~
vinit
meshfromstl mesh myfile.stl
-meshshrcoef mesh 0.05
+meshshrcoef mesh 0.05
+~~~~~
-@subsubsection occt_draw_4_33058 meshshow
+@subsubsection occt_draw_4_5_8 meshshow
-Syntax: meshshow meshname
+Syntax:
+~~~~~
+meshshow meshname
+~~~~~
-Displays **meshname** in the viewer (if it is erased).
+Displays **meshname** in the viewer (if it is erased).
+
**Example:**
-
+~~~~~
vinit
meshfromstl mesh myfile.stl
-meshshow mesh
+meshshow mesh
+~~~~~
-@subsubsection occt_draw_4_33059 meshhide
+@subsubsection occt_draw_4_5_9 meshhide
-Syntax: meshhide meshname
+Syntax:
+~~~~~
+meshhide meshname
+~~~~~
Hides **meshname** in the viewer.
-**Example:**
+**Example:**
+~~~~~
vinit
meshfromstl mesh myfile.stl
-meshhide mesh
+meshhide mesh
+~~~~~
-@subsubsection occt_draw_4_330510 meshhidesel
+@subsubsection occt_draw_4_5_10 meshhidesel
-Syntax: meshhidesel meshname
+Syntax:
+~~~~~
+meshhidesel meshname
+~~~~~
Hides only selected entities. The other part of **meshname** remains visible.
-@subsubsection occt_draw_4_330511 meshshowsel
+@subsubsection occt_draw_4_5_11 meshshowsel
-Syntax: meshshowsel meshname
+Syntax:
+~~~~~
+meshshowsel meshname
+~~~~~
Shows only selected entities. The other part of **meshname** becomes invisible.
-@subsubsection occt_draw_4_330512 meshshowall
+@subsubsection occt_draw_4_5_12 meshshowall
-Syntax: meshshowall meshname
+Syntax:
+~~~~~
+meshshowall meshname
+~~~~~
Changes the state of all entities to visible for **meshname**.
-@subsubsection occt_draw_4_330513 meshdelete
+@subsubsection occt_draw_4_5_13 meshdelete
-Syntax: meshdelete meshname
+Syntax:
+~~~~~
+meshdelete meshname
+~~~~~
Deletes MeshVS_Mesh object **meshname**.
-**Example:**
+**Example:**
+~~~~~
vinit
meshfromstl mesh myfile.stl
meshdelete mesh
+~~~~~
-
-
-
-@subsection occt_draw_4_3306 AIS viewer – 2D viewer – view commands
-
-@subsubsection occt_draw_4_33061 v2dinit
-
-Syntax: v2dinit
-
-**v2dinit **creates the 2D viewer window.
-
-@subsubsection occt_draw_4_33062 v2dsetbg
-
-Syntax: v2dsetbg imagefile [filletype]
-
-**v2dsetbg** loads **imagefile** as background. **filletype** is **NONE**, **CENTERED**, **TILED**, **STRETCH**.
-**Example:**
-
-v2dinit
-v2dsetbg myimage.brep CENTERED
-
-@subsubsection occt_draw_4_33063 v2dfit
-
-Syntax: v2dfit
-
-Fits all shapes to the size of the window.
-
-@subsubsection occt_draw_4_33064 v2drepaint
-
-Syntax: v2drepaint
-
-Forcedly repaints all shapes.
-
-@subsubsection occt_draw_4_33065 v2dclear
-
-Syntax: v2dclear
-
-Clears the 2D viewer window
-
-@subsubsection occt_draw_4_33066 v2dtext
-
-Syntax: v2dtext text x y [angle scale fontindex]
-
-Creates a new object with the name **text_i** (i – integer value) and displays **text** at the position** x**, **y.** The text can be displayed at a certain **angle**, on a certain **scale** and with a certain **fontindex**.
-Default values are: **angle=0.0, scale=1.0, fontindex=0**.
-**Example:**
-
-v2dinit
-v2dtext *My text* 10 10
-@subsubsection occt_draw_4_33067 v2dsettextcolor
-
-Syntax: v2dsettextcolor text_name colorindex
-
-Changes the color of **text_name** object (**name** must be an integer value).
-**Example:**
-
-v2dinit
-v2dtext *My text* 10 10
-# Change color to red
-v2dsettextcolor text_0 3
-@subsubsection occt_draw_4_33068 v2dpick
-
-Syntax: v2dpick
-
-Displays mouse coordinates and color after clicking the mouse button in the 2D viewer window.
-
-
-@subsubsection occt_draw_4_33069 v2dgrid
-
-Syntax: v2dgrid [type x y xstep ystep angle [drawmode]]
- v2dgrid [type x y radiusstep division angle [drawmode]]
-
-Loads a grid in the 2D viewer window.
-**type** is **Rect** or **Circ**.
-**drawmode** is **Lines**, **Points** or **None**.
-**Example:**
-
-v2dinit
-v2dgrid Circ 0 0 250 12 0 Lines
-v2drmgrid
-v2dgrid Rect 0 0 200 200 0 Lines
-@subsubsection occt_draw_4_330610 v2rmgrid
-
-Syntax: v2rmgrid
-
-Unloads a grid from the window.
-
-@subsubsection occt_draw_4_330611 v2dpickgrid
-
-Syntax: v2dpickgrid [mouse_x mouse_y [grid_x grid_y]]
-
-Gets coordinates of a grid point near the mouse button click in the 2D viewer window and sets it to **grid_x**, **grid_y** variables.
-
-@subsubsection occt_draw_4_330612 v2dpsout
-
-Syntax: v2dpsout imagefile [scale colorspace]
- [width height [xcenter ycenter]]
-
-Exports **imagefile**. You can set its the scale, width, height and colorspace.
-**colorspace** can be **RGB, BlackAndWhite, GreyScale**.
-
-@subsubsection occt_draw_4_330612613 v2ddir
-
-Syntax: v2ddir
-
-Makes aLlist of the displayed objects.
-
-
-@subsection occt_draw_4_3306127 Ais viewer – 2D viewer – display commands
-
-@subsubsection occt_draw_4_33061271 v2ddisplay
-
-Syntax: v2ddisplay name [projection]
-
-Projection: origin_x origin_y origin_z normal_x normal_y normal_z dx_x dx_y dx_z.
-
-Displays named objects.
-**Example:**
-
-v2dinit
-box b 10 10 10
-psphere s 20
-v2ddisplay s
-v2ddisplay b
-v2dfit
-@subsubsection occt_draw_4_33061272 v2ddonly
-
-Syntax: v2ddonly [name1] … [name n]
-
-Displays only selected or named objects. If there are no selected or named objects, nothing is done.
-**Example:**
-
-v2dinit
-box b 10 10 10
-psphere s 20
-v2ddisplay b
-v2ddisplay s
-v2ddonly s
-v2dfit
-@subsubsection occt_draw_4_33061273 v2ddisplayall
-
-Syntax: v2ddisplayall
-
-Displays all created objects.
-**Example:**
-
-v2dinit
-box b 10 10 10
-psphere s 20
-v2ddisplay b
-v2ddisplay s
-v2ddonly
-v2ddisplayall
-v2dfit
-@subsubsection occt_draw_4_33061274 v2derase
-
-Syntax: v2derase name1 [name2] … [name n]
-
-Erases some selected or named objects. If there are no selected or named objects, the whole viewer is erased.
-**Example:**
-
-v2dinit
-box b 10 10 10
-psphere s 20
-v2ddisplay b
-v2ddisplay s
-v2derase b
-v2dfit
-@subsubsection occt_draw_4_33061275 v2deraseall
-
-Syntax: v2deraseall
-
-Erases all objects displayed in the viewer.
-**Example:**
-
-v2dinit
-box b 10 10 10
-psphere s 20
-v2ddisplay b
-v2ddisplay s
-v2deraseall
-v2dfit
-@subsubsection occt_draw_4_33061276 v2dsetcolor
-
-Syntax: v2dsetcolor [shapename] colorname
-
-Sets color for all, selected or named shapes.
-Values of **colorname** see **vsetcolor**.
-**Example:**
-
-v2dinit
-box b 10 10 10
-v2ddisplay b
-v2ddisplay s
-v2dsetcolor b RED
-v2dfit
-@subsubsection occt_draw_4_33061277 v2dunsetcolor
-
-Syntax: v2dunsetcolor [shapename]
-
-Sets default color for all, selected or named shapes.
-**Example:**
-
-v2dinit
-box b 10 10 10
-v2ddisplay b
-v2ddisplay s
-v2dsetcolor RED
-v2dunsetcolor b
-v2dfit
-@subsubsection occt_draw_4_33061278 v2dsetbgcolor
-
-Syntax: v2dsetbgcolor colorname
-
-Sets background color.
-See **vsetcolor** for the values of **colorname.**.
-**Example:**
-
-v2dinit
-box b 10 10 10
-v2ddisplay b
-v2ddisplay s
-v2dsetbgcolor RED
-v2dfit
-@subsubsection occt_draw_4_33061279 v2dsetwidth
-
-Syntax: v2dsetwidth [shapename] widthenum
-
-Set width of the edges for all, selected or named shapes.
-**widthenum** may be one of: **THIN, MEDIUM, THICK, VERYTHICK**.
-**Example:**
-
-v2dinit
-box b 10 10 10
-v2ddisplay b
-v2ddisplay s
-v2dsetwidth b THICK
-v2dfit
-@subsubsection occt_draw_4_330612710 v2dunsetwidth
-
-Syntax: vunsetwidth [shapename]
-
-Sets default width of the edges for all, selected or named shapes.
-**Example:**
-
-v2dinit
-box b 10 10 10
-v2ddisplay b
-v2ddisplay s
-v2dsetwidth THICK
-v2dunsetwidth b
-v2dfit
-
-@section occt_2142243456_930384826 OCAF commands
+@section occt_draw_5 OCAF commands
This chapter contains a set of commands for Open CASCADE Technology Application Framework (OCAF).
-@subsection occt_2142243456_9303848261 Application commands
+@subsection occt_draw_5_1 Application commands
-@subsubsection occt_2142243456_93038482611 NewDocument
+@subsubsection occt_draw_5_1_1 NewDocument
-Syntax: NewDocument docname [format]
+Syntax:
+~~~~~
+NewDocument docname [format]
+~~~~~
Creates a new **docname** document with MDTV-Standard or described format.
-**Example:**
+**Example:**
+~~~~~
# Create new document with default (MDTV-Standard) format
NewDocument D
# Create new document with BinOcaf format
NewDocument D2 BinOcaf
+~~~~~
-@subsubsection occt_2142243456_93038482612 IsInSession
+@subsubsection occt_draw_5_1_2 IsInSession
-Syntax: IsInSession path
+Syntax:
+~~~~~
+IsInSession path
+~~~~~
+
+Returns *0*, if **path** document is managed by the application session, *1* – otherwise.
-**I**Returns **0**, if **path** document is managed by the application session, **1** – otherwise.
**Example:**
-
+~~~~~
IsInSession /myPath/myFile.std
+~~~~~
-@subsubsection occt_2142243456_93038482613 ListDocuments
+@subsubsection occt_draw_5_1_3 ListDocuments
-Syntax: ListDocuments
+Syntax:
+~~~~~
+ListDocuments
+~~~~~
Makes a list of documents handled during the session of the application.
-@subsubsection occt_2142243456_93038482614 Open
+@subsubsection occt_draw_5_1_4 Open
-Syntax: Open path docname
+Syntax:
+~~~~~
+Open path docname
+~~~~~
Retrieves the document of file **docname** in the path **path**. Overwrites the document, if it is already in session.
+
**Example:**
+~~~~~
+Open /myPath/myFile.std D
+~~~~~
-Open /myPath/myFile.std D
+@subsubsection occt_draw_5_1_5 Close
-@subsubsection occt_2142243456_93038482615 Close
-
-Syntax: Close docname
+Syntax:
+~~~~~
+Close docname
+~~~~~
Closes **docname** document. The document is no longer handled by the applicative session.
+
**Example:**
-
+~~~~~
Close D
+~~~~~
-@subsubsection occt_2142243456_93038482616 Save
+@subsubsection occt_draw_5_1_6 Save
-Syntax: Save docname
+Syntax:
+~~~~~
+Save docname
+~~~~~
Saves **docname** active document.
+
**Example:**
-
+~~~~~
Save D
+~~~~~
-@subsubsection occt_2142243456_93038482617 SaveAs
+@subsubsection occt_draw_5_1_7 SaveAs
-Syntax: SaveAs docname path
+Syntax:
+~~~~~
+SaveAs docname path
+~~~~~
Saves the active document in the file **docname** in the path **path**. Overwrites the file if it already exists.
+
**Example:**
+~~~~~
+SaveAs D /myPath/myFile.std
+~~~~~
-SaveAs D /myPath/myFile.std
+@subsection occt_draw_5_2 Basic commands
-@subsection occt_2142243456_9303848262 Basic commands
+@subsubsection occt_draw_5_2_1 Label
+
+Syntax:
+
+~~~~~
+Label docname entry
+~~~~~
+
+Creates the label expressed by if it does not exist.
+
+Example
+~~~~~
+Label D 0:2
+~~~~~
+
+@subsubsection occt_draw_5_2_2 NewChild
+
+Syntax:
+
+~~~~~
+NewChild docname [taggerlabel = Root label]
+~~~~~
+Finds (or creates) a *TagSource* attribute located at father label of and makes a new child label.
+
+Example
+~~~~~
+# Create new child of root label
+NewChild D
+
+# Create new child of existing label
+Label D 0:2
+NewChild D 0:2
+~~~~~
+
+@subsubsection occt_draw_5_2_3 Children
+
+Syntax:
+~~~~~
+Children docname label
+~~~~~
+Returns the list of attributes of label.
+
+Example
+~~~~~
+Children D 0:2
+~~~~~
+
+@subsubsection occt_draw_5_2_4 ForgetAll
+
+Syntax:
+~~~~~
+ForgetAll docname label
+~~~~~
+Forgets all attributes of the label.
+
+Example
+~~~~~
+ForgetAll D 0:2
+~~~~~
-@subsubsection occt_2142243456_930384826521 Label
+@subsubsection occt_draw_5_3 Application commands
-Syntax: Label docname entry
+@subsubsection occt_draw_5_3_1 Main
-Creates the label expressed by **entry** if it does not exist.
-**Example:**
-
-Label D 0:2
-
-@subsubsection occt_2142243456_930384826522 NewChild
-
-Syntax: NewChild docname [taggerlabel = Root label]
-
-Finds (or creates) a TagSource attribute located at father label of **taggerlabel** and makes a new child label.
-**Example:**
-
-# Create new child of root label
-NewChild D
-
-# Create new child of existing label
-Label D 0:2
-NewChild D 0:2
-
-@subsubsection occt_2142243456_930384826523 Children
-
-Syntax: Children docname label
-
-Returns the list of attributes of **label**.
-**Example:**
-
-Children D 0:2
-
-@subsubsection occt_2142243456_930384826524 ForgetAll
-
-Syntax: ForgetAll docname label
-
-Forgets all attributes of the label.
-**Example:**
-
-ForgetAll D 0:2
-
-@subsection occt_2142243456_93038482653 Application commands
-
-
-@subsubsection occt_2142243456_930384826531 Main
-
-Syntax: Main docname
+Syntax:
+~~~~~
+Main docname
+~~~~~
Returns the main label of the framework.
-**Example:**
+**Example:**
+~~~~~
Main D
+~~~~~
-@subsubsection occt_2142243456_930384826532 UndoLimit
+@subsubsection occt_draw_5_3_2 UndoLimit
-Syntax: UndoLimit docname [value=0]
+Syntax:
+~~~~~
+UndoLimit docname [value=0]
+~~~~~
-Sets the limit on the number of Undo Delta stored. 0 will disable Undo on the document. A negative **value** means that there is no limit. Note that by default Undo is disabled. Enabling it will take effect with the next call to NewCommand. Of course, this limit is the same for Redo
+Sets the limit on the number of Undo Delta stored. **0** will disable Undo on the document. A negative *value* means that there is no limit. Note that by default Undo is disabled. Enabling it will take effect with the next call to *NewCommand*. Of course, this limit is the same for Redo
+
**Example:**
-
+~~~~~
UndoLimit D 100
+~~~~~
-@subsubsection occt_2142243456_930384826533 Undo
+@subsubsection occt_draw_5_3_3 Undo
-Syntax: Undo docname [value=1]
+Syntax:
+~~~~~
+Undo docname [value=1]
+~~~~~
Undoes **value** steps.
-**Example:**
+**Example:**
+~~~~~
Undo D
+~~~~~
-@subsubsection occt_2142243456_930384826534 Redo
+@subsubsection occt_draw_5_3_4 Redo
-Syntax: Redo docname [value=1]
+Syntax:
+~~~~~
+Redo docname [value=1]
+~~~~~
-Redoes **value** steps.
+Redoes **value** steps.
+
**Example:**
-
+~~~~~
Redo D
+~~~~~
-@subsubsection occt_2142243456_930384826535 OpenCommand
+@subsubsection occt_draw_5_3_5 OpenCommand
-Syntax: OpenCommand docname
+Syntax:
+~~~~~
+OpenCommand docname
+~~~~~
Opens a new command transaction.
-**Example:**
-OpenCommand D
+**Example:**
+~~~~~
+OpenCommand D
+~~~~~
-@subsubsection occt_2142243456_930384826536 CommitCommand
+@subsubsection occt_draw_5_3_6 CommitCommand
-Syntax: CommitCommand docname
+Syntax:
+~~~~~
+CommitCommand docname
+~~~~~
Commits the Command transaction.
+
**Example:**
+~~~~~
+CommitCommand D
+~~~~~
-CommitCommand D
+@subsubsection occt_draw_5_3_7 NewCommand
-@subsubsection occt_2142243456_930384826537 NewCommand
-
-Syntax: NewCommand docname
+Syntax:
+~~~~~
+NewCommand docname
+~~~~~
This is a short-cut for Commit and Open transaction.
-**Example:**
+**Example:**
+~~~~~
NewCommand D
+~~~~~
-@subsubsection occt_2142243456_930384826538 AbortCommand
+@subsubsection occt_draw_5_3_8 AbortCommand
-Syntax: AbortCommand docname
+Syntax:
+~~~~~
+AbortCommand docname
+~~~~~
Aborts the Command transaction.
-**Example:**
+**Example:**
+~~~~~
AbortCommand D
+~~~~~
-@subsubsection occt_2142243456_930384826539 Copy
+@subsubsection occt_draw_5_3_9 Copy
-Syntax: Copy docname entry Xdocname Xentry
+Syntax:
+~~~~~
+Copy docname entry Xdocname Xentry
+~~~~~
+
+Copies the contents of *entry* to *Xentry*. No links are registered.
-Copies the contents of **entry** to **Xentry**. No links are registred.
**Example:**
-
+~~~~~
Copy D1 0:2 D2 0:4
+~~~~~
-@subsubsection occt_2142243456_9303848265310 UpdateLink
+@subsubsection occt_draw_5_3_10 UpdateLink
-Syntax: UpdateLink docname [entry]
+Syntax:
+~~~~~
+UpdateLink docname [entry]
+~~~~~
+
+Updates external reference set at *entry*.
-Updates external reference set at **entry**.
**Example:**
-
+~~~~~
UpdateLink D
+~~~~~
-@subsubsection occt_2142243456_9303848265311 CopyWithLink
+@subsubsection occt_draw_5_3_11 CopyWithLink
-Syntax: CopyWithLink docname entry Xdocname Xentry
+Syntax:
+~~~~~
+CopyWithLink docname entry Xdocname Xentry
+~~~~~
Aborts the Command transaction.
-Copies the content of **entry** to **Xentry**. The link is registred with an Xlink attribute at ** Xentry** label.
+Copies the content of *entry* to *Xentry*. The link is registered with an *Xlink* attribute at *Xentry* label.
+
**Example:**
+~~~~~
+CopyWithLink D1 0:2 D2 0:4
+~~~~~
-CopyWithLink D1 0:2 D2 0:4
+@subsubsection occt_draw_5_3_12 UpdateXLinks
-@subsubsection occt_2142243456_9303848265312 UpdateXLinks
+Syntax:
+~~~~~
+UpdateXLinks docname entry
+~~~~~
-Syntax: UpdateXLinks docname entry
+Sets modifications on labels impacted by external references to the *entry*. The *document* becomes invalid and must be recomputed
-Sets modifications on labels impacted by external references to the **entry**. The **document** becomes invalid and must be recomputed
**Example:**
-
+~~~~~
UpdateXLinks D 0:2
+~~~~~
-@subsubsection occt_2142243456_9303848265313 DumpDocument
+@subsubsection occt_draw_5_3_13 DumpDocument
-Syntax: DumpDocument docname
+Syntax:
+~~~~~
+DumpDocument docname
+~~~~~
+
+Displays parameters of *docname* document.
-Displays parameters of **docname** document.
**Example:**
-
+~~~~~
DumpDocument D
-
-@subsection occt_2142243456_93038482654 Data Framework commands
+~~~~~
-@subsubsection occt_2142243456_930384826541 MakeDF
+@subsection occt_draw_5_4 Data Framework commands
-Syntax: MakeDF dfname
+
+@subsubsection occt_draw_5_4_1 MakeDF
+
+Syntax:
+~~~~~
+MakeDF dfname
+~~~~~
Creates a new data framework.
+
**Example:**
-
+~~~~~
MakeDF D
+~~~~~
-@subsubsection occt_2142243456_930384826542 ClearDF
+@subsubsection occt_draw_5_4_2 ClearDF
-Syntax: ClearDF dfname
+Syntax:
+~~~~~
+ClearDF dfname
+~~~~~
Clears a data framework.
+
**Example:**
-
+~~~~~
ClearDF D
+~~~~~
-@subsubsection occt_2142243456_930384826543 CopyDF
+@subsubsection occt_draw_5_4_3 CopyDF
-Syntax: CopyDF dfname1 entry1 [dfname2] entry2
+Syntax:
+~~~~~
+CopyDF dfname1 entry1 [dfname2] entry2
+~~~~~
Copies a data framework.
+
**Example:**
-
+~~~~~
CopyDF D 0:2 0:4
+~~~~~
-@subsubsection occt_2142243456_930384826544 CopyLabel
+@subsubsection occt_draw_5_4_4 CopyLabel
-Syntax: CopyLabel dfname fromlabel tolablel
+Syntax:
+~~~~~
+CopyLabel dfname fromlabel tolablel
+~~~~~
Copies a label.
+
**Example:**
-
+~~~~~
CopyLabel D1 0:2 0:4
+~~~~~
-@subsubsection occt_2142243456_930384826545 MiniDumpDF
+@subsubsection occt_draw_5_4_5 MiniDumpDF
-Syntax: MiniDumpDF dfname
+Syntax:
+~~~~~
+MiniDumpDF dfname
+~~~~~
Makes a mini-dump of a data framework.
+
**Example:**
-
+~~~~~
MiniDumpDF D
+~~~~~
-@subsubsection occt_2142243456_930384826546 XDumpDF
+@subsubsection occt_draw_5_4_6 XDumpDF
-Syntax: XDumpDF dfname
+Syntax:
+~~~~~
+XDumpDF dfname
+~~~~~
Makes an extended dump of a data framework.
+
**Example:**
+~~~~~
+XDumpDF D
+~~~~~
-XDumpDF D
-
-@subsection occt_2142243456_93038482655 General attributes commands
+@subsection occt_draw_5_5 General attributes commands
-@subsubsection occt_2142243456_930384826551 SetInteger
+@subsubsection occt_draw_5_5_1 SetInteger
-Syntax: SetInteger dfname entry value
+Syntax:
+~~~~~
+SetInteger dfname entry value
+~~~~~
+
+Finds or creates an Integer attribute at *entry* label and sets *value*.
-Finds or creates an Integer attribute at **entry** label and sets **value**.
**Example:**
-
+~~~~~
SetInteger D 0:2 100
+~~~~~
-@subsubsection occt_2142243456_930384826552 GetInteger
+@subsubsection occt_draw_5_5_2 GetInteger
-Syntax: GetInteger dfname entry [drawname]
+Syntax:
+~~~~~
+GetInteger dfname entry [drawname]
+~~~~~
+
+Gets a value of an Integer attribute at *entry* label and sets it to *drawname* variable, if it is defined.
-Gets a value of an Integer attribute at **entry** label and sets it to **drawname** variable, if it is defined.
**Example:**
-
+~~~~~
GetInteger D 0:2 Int1
+~~~~~
-@subsubsection occt_2142243456_930384826553 SetReal
+@subsubsection occt_draw_5_5_3 SetReal
-Syntax: SetReal dfname entry value
+Syntax:
+~~~~~
+SetReal dfname entry value
+~~~~~
+
+Finds or creates a Real attribute at *entry* label and sets *value*.
-Finds or creates a Real attribute at **entry** label and sets **value**.
**Example:**
-
+~~~~~
SetReal D 0:2 100.
+~~~~~
-@subsubsection occt_2142243456_930384826554 GetReal
+@subsubsection occt_draw_5_5_4 GetReal
-Syntax: GetReal dfname entry [drawname]
+Syntax:
+~~~~~
+GetReal dfname entry [drawname]
+~~~~~
+
+Gets a value of a Real attribute at *entry* label and sets it to *drawname* variable, if it is defined.
-Gets a value of a Real attribute at **entry** label and sets it to **drawname** variable, if it is defined.
**Example:**
-
+~~~~~
GetReal D 0:2 Real1
+~~~~~
-@subsubsection occt_2142243456_930384826555 SetIntArray
+@subsubsection occt_draw_5_5_5 SetIntArray
-Syntax: SetIntArray dfname entry lower upper value1 value2 …
+Syntax:
+~~~~~
+SetIntArray dfname entry lower upper value1 value2 …
+~~~~~
+
+Finds or creates an IntegerArray attribute at *entry* label with lower and upper bounds and sets **value1*, *value2*...
-Finds or creates an IntegerArray attribute at **entry** label with lower and upper bounds and sets **value1, **.** value2…**
**Example:**
+~~~~~
+SetIntArray D 0:2 1 4 100 200 300 400
+~~~~~
-SetIntArray D 0:2 1 4 100 200 300 400
+@subsubsection occt_draw_5_5_6 GetIntArray
-@subsubsection occt_2142243456_930384826556 GetIntArray
+Syntax:
+~~~~~
+GetIntArray dfname entry
+~~~~~
-Syntax: GetIntArray dfname entry
+Gets a value of an *IntegerArray* attribute at *entry* label.
-Gets a value of an IntegerArray attribute at **entry** label.
**Example:**
+~~~~~
+GetIntArray D 0:2
+~~~~~
-GetIntArray D 0:2
+@subsubsection occt_draw_5_5_7 SetRealArray
-@subsubsection occt_2142243456_930384826557 SetRealArray
+Syntax:
+~~~~~
+SetRealArray dfname entry lower upper value1 value2 …
+~~~~~
-Syntax: SetRealArray dfname entry lower upper value1 value2 …
+Finds or creates a RealArray attribute at *entry* label with lower and upper bounds and sets *value1*, *value2*…
-Finds or creates a RealArray attribute at **entry** label with lower and upper bounds and sets **value1, **.** value2…**
**Example:**
-
+~~~~~
GetRealArray D 0:2 1 4 100. 200. 300. 400.
+~~~~~
-@subsubsection occt_2142243456_930384826558 GetRealArray
+@subsubsection occt_draw_5_5_8 GetRealArray
-Syntax: GetRealArray dfname entry
+Syntax:
+~~~~~
+GetRealArray dfname entry
+~~~~~
+
+Gets a value of a RealArray attribute at *entry* label.
-Gets a value of a RealArray attribute at **entry** label.
**Example:**
-
+~~~~~
GetRealArray D 0:2
+~~~~~
-@subsubsection occt_2142243456_930384826559 SetComment
+@subsubsection occt_draw_5_5_9 SetComment
-Syntax: SetComment dfname entry value
+Syntax:
+~~~~~
+SetComment dfname entry value
+~~~~~
+
+Finds or creates a Comment attribute at *entry* label and sets *value*.
-Finds or creates a Comment attribute at **entry** label and sets **value**.
**Example:**
+~~~~~
+SetComment D 0:2 "My comment"
+~~~~~
-SetComment D 0:2 *My comment*
+@subsubsection occt_draw_5_5_10 GetComment
-@subsubsection occt_2142243456_9303848265510 GetComment
+Syntax:
+~~~~~
+GetComment dfname entry
+~~~~~
-Syntax: GetComment dfname entry
+Gets a value of a Comment attribute at *entry* label.
-Gets a value of a Comment attribute at **entry** label.
**Example:**
+~~~~~
+GetComment D 0:2
+~~~~~
-GetComment D 0:2
+@subsubsection occt_draw_5_5_11 SetExtStringArray
-@subsubsection occt_2142243456_9303848265511 SetExtStringArray
+Syntax:
+~~~~~
+SetExtStringArray dfname entry lower upper value1 value2 …
+~~~~~
-Syntax: SetExtStringArray dfname entry lower upper value1 value2 …
+Finds or creates an *ExtStringArray* attribute at *entry* label with lower and upper bounds and sets *value1*, *value2*…
-Finds or creates an ExtStringArray attribute at **entry** label with lower and upper bounds and sets **value1, **.** value2…**
**Example:**
+~~~~~
+SetExtStringArray D 0:2 1 3 *string1* *string2* *string3*
+~~~~~
-SetExtStringArray D 0:2 1 3 *string1* *string2* *string3*
+@subsubsection occt_draw_5_5_12 GetExtStringArray
-@subsubsection occt_2142243456_9303848265512 GetExtStringArray
+Syntax:
+~~~~~
+GetExtStringArray dfname entry
+~~~~~
-Syntax: GetExtStringArray dfname entry
+Gets a value of an ExtStringArray attribute at *entry* label.
-Gets a value of an ExtStringArray attribute at **entry** label.
**Example:**
-
+~~~~~
GetExtStringArray D 0:2
+~~~~~
-@subsubsection occt_2142243456_9303848265513 SetName
+@subsubsection occt_draw_5_5_13 SetName
-Syntax: SetName dfname entry value
+Syntax:
+~~~~~
+SetName dfname entry value
+~~~~~
+
+Finds or creates a Name attribute at *entry* label and sets *value*.
-Finds or creates a Name attribute at **entry** label and set **value**.
**Example:**
-
+~~~~~
SetName D 0:2 *My name*
+~~~~~
-@subsubsection occt_2142243456_9303848265514 GetName
+@subsubsection occt_draw_5_5_14 GetName
-Syntax: GetName dfname entry
+Syntax:
+~~~~~
+GetName dfname entry
+~~~~~
+
+Gets a value of a Name attribute at *entry* label.
-Gets a value of a Name attribute at **entry** label.
**Example:**
-
+~~~~~
GetName D 0:2
+~~~~~
-@subsubsection occt_2142243456_9303848265515 SetReference
+@subsubsection occt_draw_5_5_15 SetReference
-Syntax: SetReference dfname entry reference
+Syntax:
+~~~~~
+SetReference dfname entry reference
+~~~~~
+
+Creates a Reference attribute at *entry* label and sets *reference*.
-Creates a Reference attribute at **entry** label and sets **reference**.
**Example:**
-
+~~~~~
SetReference D 0:2 0:4
+~~~~~
-@subsubsection occt_2142243456_9303848265516 GetReference
+@subsubsection occt_draw_5_5_16 GetReference
-Syntax: GetReference dfname entry
+Syntax:
+~~~~~
+GetReference dfname entry
+~~~~~
+
+Gets a value of a Reference attribute at *entry* label.
-Gets a value of a Reference attribute at **entry** label.
**Example:**
-
+~~~~~
GetReference D 0:2
+~~~~~
-@subsubsection occt_2142243456_9303848265517 SetUAttribute
+@subsubsection occt_draw_5_5_17 SetUAttribute
-Syntax: SetUAttribute dfname entry localGUID
+Syntax:
+~~~~~
+SetUAttribute dfname entry localGUID
+~~~~~
+
+Creates a UAttribute attribute at *entry* label with *localGUID*.
-Creates a UAttribute attribute at **entry** label with **localGUID**.
**Example:**
-
-set localGUID *c73bd076-22ee-11d2-acde-080009dc4422*
+~~~~~
+set localGUID "c73bd076-22ee-11d2-acde-080009dc4422"
SetUAttribute D 0:2 ${localGUID}
+~~~~~
-@subsubsection occt_2142243456_9303848265518 GetUAttribute
+@subsubsection occt_draw_5_5_18 GetUAttribute
-Syntax: GetUAttribute dfname entry loacalGUID
+Syntax:
+~~~~~
+GetUAttribute dfname entry loacalGUID
+~~~~~
+
+Finds a *UAttribute* at *entry* label with *localGUID*.
-Finds a UAttribute at **entry** label with **localGUID**.
**Example:**
-
-set localGUID *c73bd076-22ee-11d2-acde-080009dc4422*
+~~~~~
+set localGUID "c73bd076-22ee-11d2-acde-080009dc4422"
GetUAttribute D 0:2 ${localGUID}
+~~~~~
-@subsubsection occt_2142243456_9303848265519 SetFunction
+@subsubsection occt_draw_5_5_19 SetFunction
-Syntax: SetFunction dfname entry ID failure
+Syntax:
+~~~~~
+SetFunction dfname entry ID failure
+~~~~~
+
+Finds or creates a *Function* attribute at *entry* label with driver ID and *failure* index.
-Finds or creates a Function attribute at **entry** label with driver ID and **failure** index.
**Example:**
-
-set ID *c73bd076-22ee-11d2-acde-080009dc4422*
+~~~~~
+set ID "c73bd076-22ee-11d2-acde-080009dc4422"
SetFunction D 0:2 ${ID} 1
+~~~~~
-@subsubsection occt_2142243456_9303848265520 GetFunction
+@subsubsection occt_draw_5_5_20 GetFunction
-Syntax: GetFunction dfname entry ID failure
+Syntax:
+~~~~~
+GetFunction dfname entry ID failure
+~~~~~
+
+Finds a Function attribute at *entry* label and sets driver ID to *ID* variable and failure index to *failure* variable.
-Finds a Function attribute at **entry** label and sets driver ID to **ID** variable and failure index to **failure** variable.
**Example:**
-
+~~~~~
GetFunction D 0:2 ID failure
+~~~~~
-@subsubsection occt_2142243456_9303848265521 NewShape
+@subsubsection occt_draw_5_5_21 NewShape
-Syntax: NewShape dfname entry [shape]
+Syntax:
+~~~~~
+NewShape dfname entry [shape]
+~~~~~
+Finds or creates a Shape attribute at *entry* label. Creates or updates the associated *NamedShape* attribute by *shape* if *shape* is defined.
-Finds or creates a Shape attribute at **entry** label. Creates or updates the associated NamedShape attribute by **shape** if **shape** is defined.
**Example:**
-
+~~~~~
box b 10 10 10
NewShape D 0:2 b
+~~~~~
-@subsubsection occt_2142243456_9303848265522 SetShape
+@subsubsection occt_draw_5_5_22 SetShape
-Syntax: SetShape dfname entry shape
+Syntax:
+~~~~~
+SetShape dfname entry shape
+~~~~~
+
+Creates or updates a *NamedShape* attribute at *entry* label by *shape*.
-Creates or updates a NamedShape attribute at **entry** label by **shape**.
**Example:**
-
+~~~~~
box b 10 10 10
SetShape D 0:2 b
+~~~~~
-@subsubsection occt_2142243456_9303848265523 GetShape
+@subsubsection occt_draw_5_5_23 GetShape
-Syntax: GetShape2 dfname entry shape
+Syntax:
+~~~~~
+GetShape2 dfname entry shape
+~~~~~
+
+Sets a shape from NamedShape attribute associated with *entry* label to *shape* draw variable.
-Sets a shape from NamedShape attribute associated with **entry** label to **shape** draw variable.
**Example:**
-
+~~~~~
GetShape2 D 0:2 b
+~~~~~
-@subsection occt_2142243456_93038482656 Geometric attributes commands
+@subsection occt_draw_5_6 Geometric attributes commands
-@subsubsection occt_2142243456_930384826561 SetPoint
+@subsubsection occt_draw_5_6_1 SetPoint
-Syntax: SetPoint dfname entry point
+Syntax:
+~~~~~
+SetPoint dfname entry point
+~~~~~
+
+Finds or creates a Point attribute at *entry* label and sets *point* as generated in the associated *NamedShape* attribute.
-Finds or creates a Point attribute at **entry** label and sets **point** as generated in the associated NamedShape attribute.
**Example:**
-
+~~~~~
point p 10 10 10
SetPoint D 0:2 p
+~~~~~
-@subsubsection occt_2142243456_930384826562 GetPoint
+@subsubsection occt_draw_5_6_2 GetPoint
-Syntax: GetPoint dfname entry [drawname]
+Syntax:
+~~~~~
+GetPoint dfname entry [drawname]
+~~~~~
+
+Gets a vertex from *NamedShape* attribute at *entry* label and sets it to *drawname* variable, if it is defined.
-Gets a vertex from NamedShape attribute at **entry** label and sets it to **drawname** variable, if it is defined.
**Example:**
-
+~~~~~
GetPoint D 0:2 p
+~~~~~
-@subsubsection occt_2142243456_930384826563 SetAxis
+@subsubsection occt_draw_5_6_3 SetAxis
-Syntax: SetAxis dfname entry axis
+Syntax:
+~~~~~
+SetAxis dfname entry axis
+~~~~~
+
+Finds or creates an Axis attribute at *entry* label and sets *axis* as generated in the associated *NamedShape* attribute.
-Finds or creates an Axis attribute at **entry** label and sets **axis** as generated in the associated NamedShape attribute.
**Example:**
-
+~~~~~
line l 10 20 30 100 200 300
SetAxis D 0:2 l
+~~~~~
-@subsubsection occt_2142243456_930384826564 GetAxis
+@subsubsection occt_draw_5_6_4 GetAxis
-Syntax: GetAxis dfname entry [drawname]
+Syntax:
+~~~~~
+GetAxis dfname entry [drawname]
+~~~~~
+
+Gets a line from *NamedShape* attribute at *entry* label and sets it to *drawname* variable, if it is defined.
-Gets a line from NamedShape attribute at **entry** label and sets it to **drawname** variable, if it is defined.
**Example:**
-
+~~~~~
GetAxis D 0:2 l
+~~~~~
-@subsubsection occt_2142243456_930384826565 SetPlane
+@subsubsection occt_draw_5_6_5 SetPlane
-Syntax: SetPlane dfname entry plane
+Syntax:
+~~~~~
+SetPlane dfname entry plane
+~~~~~
+
+Finds or creates a Plane attribute at *entry* label and sets *plane* as generated in the associated *NamedShape* attribute.
-Finds or creates a Plane attribute at **entry** label and sets **plane** as generated in the associated NamedShape attribute.
**Example:**
-
+~~~~~
plane pl 10 20 30 –1 0 0
SetPlane D 0:2 pl
+~~~~~
-@subsubsection occt_2142243456_930384826566 GetPlane
+@subsubsection occt_draw_5_6_6 GetPlane
-Syntax: GetPlane dfname entry [drawname]
+Syntax:
+~~~~~
+GetPlane dfname entry [drawname]
+~~~~~
+
+Gets a plane from *NamedShape* attribute at *entry* label and sets it to *drawname* variable, if it is defined.
-Gets a plane from NamedShape attribute at **entry** label and sets it to **drawname** variable, if it is defined.
**Example:**
-
+~~~~~
GetPlane D 0:2 pl
+~~~~~
-@subsubsection occt_2142243456_930384826567 SetGeometry
+@subsubsection occt_draw_5_6_7 SetGeometry
-Syntax: SetGeometry dfname entry [type] [shape]
+Syntax:
+~~~~~
+SetGeometry dfname entry [type] [shape]
+~~~~~
+Creates a Geometry attribute at *entry* label and sets *type* and *shape* as generated in the associated *NamedShape* attribute if they are defined. *type* must be one of the following: *any, pnt, lin, cir, ell, spl, pln, cyl*.
-Creates a Geometry attribute at **entry** label and sets **type** and **shape** as generated in the associated NamedShape attribute if they are defined. **type** must be one of the following: **any/pnt/lin/cir/ell/spl/pln/cyl**.
**Example:**
-
+~~~~~
point p 10 10 10
SetGeometry D 0:2 pnt p
+~~~~~
-@subsubsection occt_2142243456_930384826568 GetGeometryType
+@subsubsection occt_draw_5_6_8 GetGeometryType
-Syntax: GetGeometryType dfname entry
+Syntax:
+~~~~~
+GetGeometryType dfname entry
+~~~~~
+
+Gets a geometry type from Geometry attribute at *entry* label.
-Gets a geometry type from Geometry attribute at **entry** label.
**Example:**
-
+~~~~~
GetGeometryType D 0:2
+~~~~~
-@subsubsection occt_2142243456_930384826569 SetConstraint
+@subsubsection occt_draw_5_6_9 SetConstraint
-Syntax: SetConstraint dfname entry keyword geometrie [geometrie …]
- SetConstraint dfname entry *plane* geometrie
- SetConstraint dfname entry *value* value
-
-1. Creates a Constraint attribute at **entry** label and sets **keyword** constraint between geometry(ies).
-**keyword** must be one of the following:
-**rad/dia/minr/majr/tan/par/perp/concentric/equal/dist/angle/eqrad/symm/midp/ eqdist/fix/rigid**
-or
-**from/axis/mate/alignf/aligna/axesa/facesa/round/offset**
+Syntax:
+~~~~~
+SetConstraint dfname entry keyword geometrie [geometrie …]
+SetConstraint dfname entry "plane" geometrie
+SetConstraint dfname entry "value" value
+~~~~~
+1. Creates a Constraint attribute at *entry* label and sets *keyword* constraint between geometry(ies).
+*keyword* must be one of the following:
+*rad, dia, minr, majr, tan, par, perp, concentric, equal, dist, angle, eqrad, symm, midp, eqdist, fix, rigid,* or *from, axis, mate, alignf, aligna, axesa, facesa, round, offset*
2. Sets plane for the existing constraint.
-
3. Sets value for the existing constraint.
+
**Example:**
+~~~~~
+SetConstraint D 0:2 "value" 5
+~~~~~
-SetConstraint D 0:2 *value* 5
+@subsubsection occt_draw_5_6_10 GetConstraint
-@subsubsection occt_2142243456_9303848265610 GetConstraint
+Syntax:
+~~~~~
+GetConstraint dfname entry
+~~~~~
-Syntax: GetConstraint dfname entry
+Dumps a Constraint attribute at *entry* label
-Dumps a Constraint attribute at **entry** label
**Example:**
-
+~~~~~
GetConstraint D 0:2
+~~~~~
-@subsubsection occt_2142243456_9303848265611 SetVariable
+@subsubsection occt_draw_5_6_11 SetVariable
-Syntax: SetVariable dfname entry isconstant(0/1) units
+Syntax:
+~~~~~
+SetVariable dfname entry isconstant(0/1) units
+~~~~~
+
+Creates a Variable attribute at *entry* label and sets *isconstant* flag and *units* as a string.
-Creates a Variable attribute at **entry** label and sets **isconstant** flag and **units** as a string.
**Example:**
+~~~~~
+SetVariable D 0:2 1 "mm"
+~~~~~
-SetVariable D 0:2 1 *mm*
+@subsubsection occt_draw_5_6_12 GetVariable
-@subsubsection occt_2142243456_9303848265612 GetVariable
+Syntax:
+~~~~~
+GetVariable dfname entry isconstant units
+~~~~~
-Syntax: GetVariable dfname entry isconstant units
+Gets an *isconstant* flag and units of a Variable attribute at *entry* label.
-Gets an **isconstant** flag and **units** of a Variable attribute at **entry** label.
**Example:**
-
+~~~~~
GetVariable D 0:2 isconstant units
-puts *IsConstant=${isconstant}*
-puts *Units=${units}*
+puts "IsConstant=${isconstant}"
+puts "Units=${units}"
+~~~~~
+
+@subsection occt_draw_5_7 Tree attributes commands
-@subsection occt_2142243456_93038482657 Tree attributes commands
+@subsubsection occt_draw_5_7_1 RootNode
+
+Syntax:
+~~~~~
+RootNode dfname treenodeentry [ID]
+~~~~~
+
+Returns the ultimate father of *TreeNode* attribute identified by its *treenodeentry* and its *ID* (or default ID, if *ID* is not defined).
-@subsubsection occt_2142243456_930384826571 RootNode
+@subsubsection occt_draw_5_7_2 SetNode
-Syntax: RootNode dfname treenodeentry [ID]
+Syntax:
+~~~~~
+SetNode dfname treenodeentry [ID]
+~~~~~
-Returns ultimate father of TreeNode attribute identified by its **treenodeentry** and its **ID** (or default ID, if **ID** is not defined).
+Creates a *TreeNode* attribute on the *treenodeentry* label with its tree *ID* (or assigns a default ID, if the *ID* is not defined).
-@subsubsection occt_2142243456_930384826572 SetNode
+@subsubsection occt_draw_5_7_3 AppendNode
-Syntax: SetNode dfname treenodeentry [ID]
-
-Creates a TreeNode attribute on the **treenodeentry** label with its tree **ID** (or assigns a default ID, if the **ID** is not defined).
+Syntax:
+~~~~~
+AppendNode dfname fatherentry childentry [fatherID]
+~~~~~
-@subsubsection occt_2142243456_930384826573 AppendNode
-
-Syntax: AppendNode dfname fatherentry childentry [fatherID]
-
-
-Inserts a TreeNode attribute with its tree **fatherID** (or default ID, if **fatherID** is not defined) on **childentry** as last child of **fatherentry**.
+Inserts a *TreeNode* attribute with its tree *fatherID* (or default ID, if *fatherID* is not defined) on *childentry* as last child of *fatherentry*.
-@subsubsection occt_2142243456_930384826574 PrependNode
+@subsubsection occt_draw_5_7_4 PrependNode
-Syntax: PrependNode dfname fatherentry childentry [fatherID]
+Syntax:
+~~~~~
+PrependNode dfname fatherentry childentry [fatherID]
+~~~~~
-Inserts a TreeNode attribute with its tree **fatherID** (or default ID, if **fatherID** is not defined) on **childentry** as first child of **fatherentry**.
+Inserts a *TreeNode* attribute with its tree *fatherID* (or default ID, if *fatherID* is not defined) on *childentry* as first child of *fatherentry*.
-@subsubsection occt_2142243456_930384826575 InsertNodeBefore
+@subsubsection occt_draw_5_7_5 InsertNodeBefore
-Syntax: InsertNodeBefore dfname treenodeentry beforetreenode [ID]
+Syntax:
+~~~~~
+InsertNodeBefore dfname treenodeentry beforetreenode [ID]
+~~~~~
-Inserts a TreeNode attribute with tree **ID** (or default ID, if **ID** is not defined) **beforetreenode** before **treenodeentry**.
+Inserts a *TreeNode* attribute with tree *ID* (or default ID, if *ID* is not defined) *beforetreenode* before *treenodeentry*.
-@subsubsection occt_2142243456_930384826576 InsertNodeAfter
+@subsubsection occt_draw_5_7_6 InsertNodeAfter
-Syntax: InsertNodeAfter dfname treenodeentry aftertreenode [ID]
+Syntax:
+~~~~~
+InsertNodeAfter dfname treenodeentry aftertreenode [ID]
+~~~~~
-Inserts a TreeNode attribute with tree **ID** (or default ID, if **ID** is not defined) **aftertreenode** after **treenodeentry**.
+Inserts a *TreeNode* attribute with tree *ID* (or default ID, if *ID* is not defined) *aftertreenode* after *treenodeentry*.
-@subsubsection occt_2142243456_930384826577 DetachNode
+@subsubsection occt_draw_5_7_7 DetachNode
-Syntax: DetachNode dfname treenodeentry [ID]
+Syntax:
+~~~~~
+DetachNode dfname treenodeentry [ID]
+~~~~~
-Removes a TreeNode attribute with tree **ID** (or default ID, if **ID** is not defined) from **treenodeentry**.
+Removes a *TreeNode* attribute with tree *ID* (or default ID, if *ID* is not defined) from *treenodeentry*.
-@subsubsection occt_2142243456_930384826578 ChildNodeIterate
+@subsubsection occt_draw_5_7_8 ChildNodeIterate
-Syntax: ChildNodeIterate dfname treenodeentry alllevels(0/1) [ID]
+Syntax:
+~~~~~
+ChildNodeIterate dfname treenodeentry alllevels(0/1) [ID]
+~~~~~
-Iterates on the tree of TreeNode attributes with tree **ID** (or default ID, if **ID** is not defined). If **alllevels** is set to **1** it explores not only the first, but all the sub Step levels.
+Iterates on the tree of *TreeNode* attributes with tree *ID* (or default ID, if *ID* is not defined). If *alllevels* is set to *1* it explores not only the first, but all the sub Step levels.
+
**Example:**
-
+~~~~~
Label D 0:2
Label D 0:3
Label D 0:4
@@ -3188,15 +3501,20 @@ ChildNodeIterate D 0:2 1
==0:7
==0:6
==0:5
+~~~~~
-@subsubsection occt_2142243456_930384826579 InitChildNodeIterator
+@subsubsection occt_draw_5_7_9 InitChildNodeIterator
-Syntax: InitChildNodeIterator dfname treenodeentry alllevels(0/1) [ID]
+Syntax:
+~~~~~
+InitChildNodeIterator dfname treenodeentry alllevels(0/1) [ID]
+~~~~~
-Initializes the iteration on the tree of TreeNode attributes with tree **ID** (or default ID, if **ID** is not defined). If **alllevels** is set to **1** it explores not only the first, but also all sub Step levels.
+Initializes the iteration on the tree of *TreeNode* attributes with tree *ID* (or default ID, if *ID* is not defined). If *alllevels* is set to *1* it explores not only the first, but also all sub Step levels.
+
**Example:**
-
+~~~~~
InitChildNodeIterate D 0:5 1
set aChildNumber 0
for {set i 1} {$i 100} {incr i} {
@@ -3206,193 +3524,276 @@ for {set i 1} {$i 100} {incr i} {
ChildNodeNext
}
}
-puts *aChildNumber=$aChildNumber*
+puts "aChildNumber=$aChildNumber"
+~~~~~
-@subsubsection occt_2142243456_9303848265710 ChildNodeMore
+@subsubsection occt_draw_5_7_10 ChildNodeMore
-Syntax: ChildNodeMore
+Syntax:
+~~~~~
+ChildNodeMore
+~~~~~
Returns TRUE if there is a current item in the iteration.
-@subsubsection occt_2142243456_9303848265711 ChildNodeNext
+@subsubsection occt_draw_5_7_11 ChildNodeNext
-Syntax: ChildNodeNext
+Syntax:
+~~~~~
+ChildNodeNext
+~~~~~
Moves to the next Item.
-@subsubsection occt_2142243456_9303848265712 ChildNodeValue
+@subsubsection occt_draw_5_7_12 ChildNodeValue
-Syntax: ChildNodeValue
+Syntax:
+~~~~~
+ChildNodeValue
+~~~~~
-Returns the current treenode of ChildNodeIterator.
+Returns the current treenode of *ChildNodeIterator*.
-@subsubsection occt_2142243456_9303848265713 ChildNodeNextBrother
+@subsubsection occt_draw_5_7_13 ChildNodeNextBrother
-Syntax: ChildNodeNextBrother
+Syntax:
+~~~~~
+ChildNodeNextBrother
+~~~~~
-Moves to the next Brother. If there is none, goes up. This method is interesting only with ;allLevels; behavior.
+Moves to the next *Brother*. If there is none, goes up. This method is interesting only with *allLevels* behavior.
-@subsection occt_2142243456_93038482658 Standard presentation commands
+@subsection occt_draw_5_8 Standard presentation commands
-@subsubsection occt_2142243456_930384826581 AISInitViewer
+@subsubsection occt_draw_5_8_1 AISInitViewer
-Syntax: AISInitViewer docname
+Syntax:
+~~~~~
+AISInitViewer docname
+~~~~~
+
+Creates and sets *AISViewer* attribute at root label, creates AIS viewer window.
-Creates and sets AISViewer attribute at root label, creates AIS viewer window.
**Example:**
-
+~~~~~
AISInitViewer D
+~~~~~
-@subsubsection occt_2142243456_930384826582 AISRepaint
+@subsubsection occt_draw_5_8_2 AISRepaint
-Syntax: AISRepaint docname
+Syntax:
+~~~~~
+AISRepaint docname
+~~~~~
Updates the AIS viewer window.
-**Example:**
+**Example:**
+~~~~~
AISRepaint D
+~~~~~
-@subsubsection occt_2142243456_930384826583 AISDisplay
+@subsubsection occt_draw_5_8_3 AISDisplay
-Syntax: AISDisplay docname entry [not_update]
+Syntax:
+~~~~~
+AISDisplay docname entry [not_update]
+~~~~~
+Displays a presantation of *AISobject* from *entry* label in AIS viewer. If *not_update* is not defined then *AISobject* is recomputed and all visualization settings are applied.
-Displays a presantation of AISobject from **entry** label in AIS viewer. If **not_update** is not defined then AISobject is recomputed and all visualization settings are applied.
**Example:**
-
+~~~~~
AISDisplay D 0:5
+~~~~~
-@subsubsection occt_2142243456_930384826584 AISUpdate
+@subsubsection occt_draw_5_8_4 AISUpdate
-Syntax: AISUpdate docname entry
+Syntax:
+~~~~~
+AISUpdate docname entry
+~~~~~
+
+Recomputes a presentation of *AISobject* from *entry* label and applies the visualization setting in AIS viewer.
-Recomputes a presantation of AISobject from **entry** label and applies the visualization setting in AIS viewer.
**Example:**
-
+~~~~~
AISUpdate D 0:5
+~~~~~
-@subsubsection occt_2142243456_930384826585 AISErase
+@subsubsection occt_draw_5_8_5 AISErase
-Syntax: AISErase docname entry
+Syntax:
+~~~~~
+AISErase docname entry
+~~~~~
+
+Erases *AISobject* of *entry* label in AIS viewer.
-Erases AISobject of **entry** label in AIS viewer.
**Example:**
-
+~~~~~
AISErase D 0:5
+~~~~~
-@subsubsection occt_2142243456_930384826586 AISRemove
+@subsubsection occt_draw_5_8_6 AISRemove
-Syntax: AISRemove docname entry
+Syntax:
+~~~~~
+AISRemove docname entry
+~~~~~
+
+Erases *AISobject* of *entry* label in AIS viewer, then *AISobject* is removed from *AIS_InteractiveContext*.
-Erases AISobject of **entry** label in AIS viewer, then AISobject is removed from AIS_InteractiveContext.
**Example:**
-
+~~~~~
AISRemove D 0:5
+~~~~~
-@subsubsection occt_2142243456_930384826587 AISSet
+@subsubsection occt_draw_5_8_7 AISSet
-Syntax: AISSet docname entry ID
+Syntax:
+~~~~~
+AISSet docname entry ID
+~~~~~
+Creates *AISPresentation* attribute at *entry* label and sets as driver ID. ID must be one of the following: *A* (*axis*), *C* (*constraint*), *NS* (*namedshape*), *G* (*geometry*), *PL* (*plane*), *PT* (*point*).
-Creates AISPresentation attribute at **entry** label and sets as driver ID. ID must be one of the following: **A** (axis), **C** (constraint), **NS** (namedshape), **G** (geometry), **PL** (plane), **PT** (point).
**Example:**
-
+~~~~~
AISSet D 0:5 NS
+~~~~~
-@subsubsection occt_2142243456_930384826588 AISDriver
+@subsubsection occt_draw_5_8_8 AISDriver
-Syntax: AISDriver docname entry [ID]
+Syntax:
+~~~~~
+AISDriver docname entry [ID]
+~~~~~
+Returns DriverGUID stored in *AISPresentation* attribute of an *entry* label or sets a new one. ID must be one of the following: *A* (*axis*), *C* (*constraint*), *NS* (*namedshape*), *G* (*geometry*), *PL* (*plane*), *PT* (*point*).
-Returns DriverGUID stored in AISPresentation attribute of an **entry** label or sets a new one. ID must be one of the following: **A** (axis), **C** (constraint), **NS** (namedshape), **G** (geometry), **PL** (plane), **PT** (point).
**Example:**
-
+~~~~~
# Get Driver GUID
AISDriver D 0:5
+~~~~~
-@subsubsection occt_2142243456_930384826589 AISUnset
+@subsubsection occt_draw_5_8_9 AISUnset
-Syntax: AISUnset docname entry
+Syntax:
+~~~~~
+AISUnset docname entry
+~~~~~
+
+Deletes *AISPresentation* attribute (if it exists) of an *entry* label.
-Deletes AISPresentation attribute (if it exists) of an **entry** label.
**Example:**
-
+~~~~~
AISUnset D 0:5
+~~~~~
-@subsubsection occt_2142243456_9303848265810 AISTransparency
+@subsubsection occt_draw_5_8_10 AISTransparency
-Syntax: AISTransparency docname entry [transparency]
+Syntax:
+~~~~~
+AISTransparency docname entry [transparency]
+~~~~~
+
+Sets (if *transparency* is defined) or gets the value of transparency for *AISPresentation* attribute of an *entry* label.
-Sets (if **transparency** is defined) or gets the value of transparency for AISPresentation attribute of an **entry** label.
**Example:**
-
+~~~~~
AISTransparency D 0:5 0.5
+~~~~~
-@subsubsection occt_2142243456_9303848265811 AISHasOwnTransparency
+@subsubsection occt_draw_5_8_11 AISHasOwnTransparency
-Syntax: AISHasOwnTransparency docname entry
+Syntax:
+~~~~~
+AISHasOwnTransparency docname entry
+~~~~~
+
+Tests *AISPresentation* attribute of an *entry* label by own transparency.
-Tests AISPresentation attribute of an **entry** label by own transparency.
**Example:**
-
+~~~~~
AISHasOwnTransparency D 0:5
+~~~~~
-@subsubsection occt_2142243456_9303848265812 AISMaterial
+@subsubsection occt_draw_5_8_12 AISMaterial
-Syntax: AISMaterial docname entry [material]
+Syntax:
+~~~~~
+AISMaterial docname entry [material]
+~~~~~
+Sets (if *material* is defined) or gets the value of transparency for *AISPresentation* attribute of an *entry* label. *material* is integer from 0 to 20 (see meshmat command).
-Sets (if **material** is defined) or gets the value of transparency for AISPresentation attribute of an **entry** label. **material** is integer from 0 to 20 (see **meshmat**).
**Example:**
-
+~~~~~
AISMaterial D 0:5 5
+~~~~~
-@subsubsection occt_2142243456_9303848265813 AISHasOwnMaterial
+@subsubsection occt_draw_5_8_13 AISHasOwnMaterial
-Syntax: AISHasOwnMaterial docname entry
+Syntax:
+~~~~~
+AISHasOwnMaterial docname entry
+~~~~~
+
+Tests *AISPresentation* attribute of an *entry* label by own material.
-Tests AISPresentation attribute of an **entry** label by own material.
**Example:**
-
+~~~~~
AISHasOwnMaterial D 0:5
+~~~~~
-@subsubsection occt_2142243456_9303848265814 AISColor
+@subsubsection occt_draw_5_8_14 AISColor
-Syntax: AISColor docname entry [color]
+Syntax:
+~~~~~
+AISColor docname entry [color]
+~~~~~
+
+Sets (if *color* is defined) or gets value of color for *AISPresentation* attribute of an *entry* label. *color* is integer from 0 to 516 (see color names in *vsetcolor*).
-Sets (if **color** is defined) or gets value of color for AISPresentation attribute of an **entry** label. **color** is integer from 0 to 516 (see color names in **vsetcolor**).
**Example:**
-
+~~~~~
AISColor D 0:5 25
+~~~~~
-@subsubsection occt_2142243456_9303848265815 AISHasOwnColor
+@subsubsection occt_draw_5_8_15 AISHasOwnColor
-Syntax: AISHasOwnColor docname entry
+Syntax:
+~~~~~
+AISHasOwnColor docname entry
+~~~~~
+
+Tests *AISPresentation* attribute of an *entry* label by own color.
-Tests AISPresentation attribute of an **entry** label by own color.
**Example:**
-
+~~~~~
AISHasOwnColor D 0:5
+~~~~~
+@section occt_draw_6 Geometry commands
-@section occt_2142243456_1101404852 Geometry commands
+@subsection occt_draw_6_1 Overview
-@subsection occt_2142243456_110140485261 Overview
-
-Draw provides a set of commands to test geometry libraries. These commands are found in the TGEOMETRY executable, or in any Draw executable which includes GeometryTest commands.
+Draw provides a set of commands to test geometry libraries. These commands are found in the TGEOMETRY executable, or in any Draw executable which includes *GeometryTest* commands.
In the context of Geometry, Draw includes the following types of variable:
* 2d and 3d points
- * The 2d curve, which corresponds to *Curve *in *Geom2d*.
- * The 3d curve and surface, which correspond to *Curve *and *Surface *in *Geom *[2].
+ * The 2d curve, which corresponds to *Curve* in *Geom2d*.
+ * The 3d curve and surface, which correspond to *Curve* and *Surface* in Geom package.
-Draw geometric variables never share data; the **copy **command will always make a complete copy of the content of the variable.
+Draw geometric variables never share data; the *copy* command will always make a complete copy of the content of the variable.
The following topics are covered in the nine sections of this chapter:
@@ -3406,72 +3807,80 @@ The following topics are covered in the nine sections of this chapter:
* **Constraints** concerns construction of 2d circles and lines by constraints such as tangency.
* **Display** describes commands to control the display of curves and surfaces.
-Where possible, the commands have been made broad in application, i.e. they apply to 2d curves, 3d curves and surfaces. For instance, the **circle **command may create a 2d or a 3d circle depending on the number of arguments given.
+Where possible, the commands have been made broad in application, i.e. they apply to 2d curves, 3d curves and surfaces. For instance, the *circle* command may create a 2d or a 3d circle depending on the number of arguments given.
-Likewise, the **translate **command will process points, curves or surfaces, depending on argument type. You may not always find the specific command you are looking for in the section where you expect it to be. In that case, look in another section. The **trim **command, for example, is described in the surface section. It can, nonetheless, be used with curves as well.
+Likewise, the *translate* command will process points, curves or surfaces, depending on argument type. You may not always find the specific command you are looking for in the section where you expect it to be. In that case, look in another section. The *trim* command, for example, is described in the surface section. It can, nonetheless, be used with curves as well.
-@subsection occt_2142243456_110140485262 Curve creation
+@subsection occt_draw_6_2 Curve creation
This section deals with both points and curves. Types of curves are:
* Analytical curves such as lines, circles, ellipses, parabolas, and hyperbolas.
* Polar curves such as bezier curves and bspline curves.
- * Trimmed curves and offset curves made from other curves with the **trim **and **offset **commands. Because they are used on both curves and surfaces, the **trim** and **offset** commands are described in the *surface creation *section.
- * NURBS can be created from other curves using **convert **in the *Surface Creation *section.
- * Curves can be created from the isoparametric lines of surfaces by the **uiso **and **viso **commands.
- * 3d curves can be created from 2d curves and vice versa using the **to3d **and **to2d **commands. The **project **command computes a 2d curve on a 3d surface.
+ * Trimmed curves and offset curves made from other curves with the *trim* and *offset* commands. Because they are used on both curves and surfaces, the *trim* and *offset* commands are described in the *surface creation* section.
+ * NURBS can be created from other curves using *convert* in the *Surface Creation* section.
+ * Curves can be created from the isoparametric lines of surfaces by the *uiso* and *viso* commands.
+ * 3d curves can be created from 2d curves and vice versa using the *to3d* and *to2d* commands. The *project* command computes a 2d curve on a 3d surface.
Curves are displayed with an arrow showing the last parameter.
-@subsubsection occt_2142243456_1101404852621 point
+@subsubsection occt_draw_6_2_1 point
- @verbatim
- Syntax: point name x y [z]
- @endverbatim
+Syntax:
+~~~~~
+point name x y [z]
+~~~~~
-**point** creates a 2d or 3d point, depending on the number of arguments. **Example:**
+Creates a 2d or 3d point, depending on the number of arguments.
- @verbatim
- # 2d point
- point p1 1 2
+**Example:**
+~~~~~
+# 2d point
+point p1 1 2
- # 3d point
- point p2 10 20 -5
- @endverbatim
+# 3d point
+point p2 10 20 -5
+~~~~~
-@subsubsection occt_2142243456_1101404852622 line
+@subsubsection occt_draw_6_2_2 line
+
+Syntax:
+~~~~~
+line name x y [z] dx dy [dz]
+~~~~~
- @verbatim
- Syntax: line name x y [z] dx dy [dz]
- @endverbatim
-**line** creates a 2d or 3d line. x y z are the coordinates of the line’s point of origin; dx, dy, dz give the direction vector.
+Creates a 2d or 3d line. *x y z* are the coordinates of the line’s point of origin; *dx, dy, dz* give the direction vector.
-A 2d line will be represented asl x y dx dy, and a 3d line asl x y z dx dy dz. A line is parameterized along its length starting from the point of origin along the direction vector. The direction vector is normalized and must not be null. Lines are infinite, even though their representation is not. **Example:**
+A 2d line will be represented as *x y dx dy*, and a 3d line as *x y z dx dy dz* . A line is parameterized along its length starting from the point of origin along the direction vector. The direction vector is normalized and must not be null. Lines are infinite, even though their representation is not.
- @verbatim
- # a 2d line at 45 degrees of the X axis
- line l 2 0 1 1
+**Example:**
+~~~~~
+# a 2d line at 45 degrees of the X axis
+line l 2 0 1 1
- # a 3d line through the point 10 0 0 and parallel to Z
- line l 10 0 0 0 0 1
- @endverbatim
+# a 3d line through the point 10 0 0 and parallel to Z
+line l 10 0 0 0 0 1
+~~~~~
-@subsubsection occt_2142243456_1101404852623 circle
+@subsubsection occt_draw_6_2_3 circle
-Syntax: circle name x y [z [dx dy dz]] [ux uy [uz]] radius
+Syntax:
+~~~~~
+circle name x y [z [dx dy dz]] [ux uy [uz]] radius
+~~~~~
-**circle **creates a 2d or a 3d circle.
+Creates a 2d or a 3d circle.
-In 2d, x, y are the coordinates of the center and ux, uy define the vector towards the point of origin of the parameters. By default, this direction is (1,0). The X Axis of the local coordinate system defines the origin of the parameters of the circle. Use another vector than the x axis to change the origin of parameters.
+In 2d, *x, y* are the coordinates of the center and *ux, uy* define the vector towards the point of origin of the parameters. By default, this direction is (1,0). The X Axis of the local coordinate system defines the origin of the parameters of the circle. Use another vector than the x axis to change the origin of parameters.
-In 3d, x, y, z are the coordinates of the center; dx, dy, dz give the vector normal to the plane of the circle. By default, this vector is (0,0,1) i.e. the Z axis (it must not be null). ux, uy, uz is the direction of the origin; if not given, a default direction will be computed. This vector must neither be null nor parallel to dx, dy, dz.
+In 3d, *x, y, z* are the coordinates of the center; *dx, dy, dz* give the vector normal to the plane of the circle. By default, this vector is (0,0,1) i.e. the Z axis (it must not be null). *ux, uy, uz* is the direction of the origin; if not given, a default direction will be computed. This vector must neither be null nor parallel to *dx, dy, dz*.
The circle is parameterized by the angle in [0,2*pi] starting from the origin and. Note that the specification of origin direction and plane is the same for all analytical curves and surfaces.
**Example:**
-
+~~~~~
# A 2d circle of radius 5 centered at 10,-2
circle c1 10 -2 5
@@ -3488,20 +3897,27 @@ circle c4 10 20 -5 0 1 0 17
# full 3d circle, axis X, origin on Z
circle c5 10 20 -5 1 0 0 0 0 1 17
+~~~~~
+@subsubsection occt_draw_6_2_4 ellipse
-@subsubsection occt_2142243456_1101404852624 ellipse
+Syntax:
+~~~~~
+ellipse name x y [z [dx dy dz]] [ux uy [uz]] firstradius secondradius
+~~~~~
-Syntax: ellipse name x y [z [dx dy dz]] [ux uy [uz]] firstradius secondradius **ellipse **creates a 2d or 3d ellipse. In a 2d ellipse, the first two arguments define the center; in a 3d ellipse, the first three. The axis system is given by *firstradius*, the major radius, and *secondradius*, the minor radius. The parameter range of the ellipse is [0,2.*pi] starting from the X axis and going towards the Y axis. The Draw ellipse is parameterized by an angle:
+Creates a 2d or 3d ellipse. In a 2d ellipse, the first two arguments define the center; in a 3d ellipse, the first three. The axis system is given by *firstradius*, the major radius, and *secondradius*, the minor radius. The parameter range of the ellipse is [0,2.*pi] starting from the X axis and going towards the Y axis. The Draw ellipse is parameterized by an angle:
+~~~~~
P(u) = O + firstradius*cos(u)*Xdir + secondradius*sin(u)*Ydir
-
+~~~~~
where:
- * P is the point of parameter u,
- * O, Xdir and Ydir are respectively the origin, *X Direction* and *Y Direction* of its local coordinate system.
+ * P is the point of parameter *u*,
+ * *O, Xdir* and *Ydir* are respectively the origin, *X Direction* and *Y Direction* of its local coordinate system.
+
**Example:**
-
+~~~~~
# default 2d ellipse
ellipse e1 10 5 20 10
@@ -3513,26 +3929,28 @@ ellipse e3 0 0 0 25 5
# 3d ellipse in the X,Z plane with axis 1, 0 ,1
ellipse e4 0 0 0 0 1 0 1 0 1 25 5
+~~~~~
-See also: **circle**
-@subsubsection occt_2142243456_1101404852625 hyperbola
+@subsubsection occt_draw_6_2_5 hyperbola
-Syntax: hyperbola name x y [z [dx dy dz]] [ux uy [uz]] firstradius secondradius
+Syntax:
+~~~~~
+hyperbola name x y [z [dx dy dz]] [ux uy [uz]] firstradius secondradius
+~~~~~
-**hyperbola **creates a 2d or 3d conic. The first arguments define the center. The axis system is given by *firstradius*, the major radius, and *secondradius*, the minor radius. Note that the hyperbola has only one branch, that in the X direction.
+Creates a 2d or 3d conic. The first arguments define the center. The axis system is given by *firstradius*, the major radius, and *secondradius*, the minor radius. Note that the hyperbola has only one branch, that in the X direction.
The Draw hyperbola is parameterized as follows:
-
+~~~~~
P(U) = O + firstradius*Cosh(U)*XDir + secondradius*Sinh(U)*YDir
-
+~~~~~
where:
- * P is the point of parameter U,
- * O, XDir and YDir are respectively the origin, *X Direction* and *Y
+ * *P* is the point of parameter *U*,
+ * *O, XDir* and *YDir* are respectively the origin, *X Direction* and *YDirection* of its local coordinate system.
-Direction* of its local coordinate system.
**Example:**
-
+~~~~~
# default 2d hyperbola, with asymptotes 1,1 -1,1
hyperbola h1 0 0 30 30
@@ -3541,26 +3959,30 @@ hyperbola h2 0 0 1 2 20 20
# 3d hyperbola, in the XY plane
hyperbola h3 0 0 0 50 50
+~~~~~
-See also: **circle**
+@subsubsection occt_draw_6_2_6 parabola
+Syntax:
+~~~~~
+parabola name x y [z [dx dy dz]] [ux uy [uz]] FocalLength
+~~~~~
-@subsubsection occt_2142243456_1101404852626 parabola
+Creates a 2d or 3d parabola. in the axis system defined by the first arguments. The origin is the apex of the parabola.
-Syntax: parabola name x y [z [dx dy dz]] [ux uy [uz]] FocalLength
-
-**parabola **creates a 2d or 3d parabola. in the axis system defined by the first arguments.The origin is the apex of the parabola.
-
-The Geom_Parabola parabola is parameterized as follows:
+The *Geom_Parabola* is parameterized as follows:
+~~~~~
P(u) = O + u*u/(4.*F)*XDir + u*YDir
+~~~~~
where:
- * P is the point of parameter u,
- * O, XDir and YDir are respectively the origin, *X Direction* and *Y Direction* of its local coordinate system,
- * F is the focal length of the parabola.
-**Example:**
+ * *P* is the point of parameter *u*,
+ * *O, XDir* and *YDir* are respectively the origin, *X Direction* and *Y Direction* of its local coordinate system,
+ * *F* is the focal length of the parabola.
+**Example:**
+~~~~~
# 2d parabola
parabola p1 0 0 50
@@ -3569,31 +3991,37 @@ parabola p2 0 0 0 1 50
# 3d parabola in the Y-Z plane, convexity +Z
parabola p3 0 0 0 1 0 0 0 0 1 50
+~~~~~
-See also: **circle**
+@subsubsection occt_draw_6_2_7 beziercurve, dbeziercurve
+Syntax:
+~~~~~
+beziercurve name nbpole pole, [weight]
+2dbeziercurve name nbpole pole, [weight]
+~~~~~
-@subsubsection occt_2142243456_1101404852627 beziercurve, dbeziercurve
+Creates a 3d rational or non-rational Bezier curve. Give the number of poles (control points,) and the coordinates of the poles *(x1 y1 z1 [w1] x2 y2 z2 [w2])*. The degree will be *nbpoles-1*. To create a rational curve, give weights with the poles. You must give weights for all poles or for none. If the weights of all the poles are equal, the curve is polynomial, and therefore non-rational.
-Syntax: beziercurve name nbpole pole, [weight]
-2dbeziercurve name nbpole pole, [weight]
-
-**beziercurve **creates a 3d rational or non-rational Bezier curve. Give the number of poles (control points,) and the coordinates of the poles (x1 y1 z1 [w1] x2 y2 z2 [w2]). The degree will be nbpoles-1. To create a rational curve, give weights with the poles. You must give weights for all poles or for none. If the weights of all the poles are equal, the curve is polynomial, and therefore non-rational.
**Example:**
-
+~~~~~
# a rational 2d bezier curve (arc of circle)
2dbeziercurve ci 3 0 0 1 10 0 sqrt(2.)/2. 10 10 1
# a 3d bezier curve, not rational
beziercurve cc 4 0 0 0 10 0 0 10 0 10 10 10 10
+~~~~~
+@subsubsection occt_draw_6_2_8 bsplinecurve, dbsplinecurve, pbsplinecurve, dpbsplinecurve
-@subsubsection occt_2142243456_1101404852628 bsplinecurve, dbsplinecurve, pbsplinecurve, dpbsplinecurve
+Syntax:
+~~~~~
+bsplinecurve name degree nbknots knot, umult pole, weight 2dbsplinecurve name degree nbknots knot, umult pole, weight pbsplinecurve name degree nbknots knot, umult pole, weight(periodic)
-Syntax: bsplinecurve name degree nbknots knot, umult pole, weight 2dbsplinecurve name degree nbknots knot, umult pole, weight pbsplinecurve name degree nbknots knot, umult pole, weight(periodic)
2dpbsplinecurve name degree nbknots knot, umult pole, weight (periodic)
+~~~~~
-**bsplinecurve **creates 2d or 3d bspline curves; the **pbsplinecurve **and **2dpbsplinecurve **commands create periodic bspline curves.
+Creates 2d or 3d bspline curves; the **pbsplinecurve** and **2dpbsplinecurve** commands create periodic bspline curves.
A bspline curve is defined by its degree, its periodic or non-periodic nature, a table of knots and a table of poles (i.e. control points). Consequently, specify the degree, the number of knots, and for each knot, the multiplicity, for each pole, the weight. In the syntax above, the commas link the adjacent arguments which they fall between: knot and multiplicities, pole and weight.
@@ -3604,8 +4032,9 @@ The poles must be given with their weights, use weights of 1 for a non rational
* For a non periodic curve: Sum of multiplicities - degree + 1
* For a periodic curve: Sum of multiplicities - last multiplicity
-**Example:**
+**Example:**
+~~~~~
# a bspline curve with 4 poles and 3 knots
bsplinecurve bc 2 3 0 3 1 1 2 3 \
10 0 7 1 7 0 7 1 3 0 8 1 0 0 7 1
@@ -3620,39 +4049,45 @@ dset h sqrt(3)/2
-0.25 h/6 1 \
-0.5 -h/3 0.5 \
0 -h/3 1
+~~~~~
-
NOTE
-*You can create the **NURBS **subset of bspline curves and*
-*surfaces by trimming analytical curves and surfaces and*
-*executing the command *convert*; see below.*
+**Note** that you can create the **NURBS** subset of bspline curves and surfaces by trimming analytical curves and surfaces and executing the command *convert*.
-@subsubsection occt_2142243456_1101404852629 uiso, viso
+@subsubsection occt_draw_6_2_9 uiso, viso
-Syntax: uiso name surface u
+Syntax:
+~~~~~
+uiso name surface u
viso name surface u
+~~~~~
+
+Creates a U or V isoparametric curve from a surface.
-Use these commands to create a U or V isoparametric curve from a surface.
**Example:**
-
+~~~~~
# create a cylinder and extract iso curves
cylinder c 10
uiso c1 c pi/6
viso c2 c
+~~~~~
-*NOTE*
-*Cannot be done from offset surfaces.*
+**Note** that this cannot be done from offset surfaces.
-@subsubsection occt_2142243456_11014048526210 tod, tod
+@subsubsection occt_draw_6_2_10 tod, tod
-Syntax: to3d name curve2d [plane]
+Syntax:
+~~~~~
+to3d name curve2d [plane]
to2d name curve3d [plane]
+~~~~~
+
+Create respectively a 3d curve from a 2d curve and a 2d curve from a 3d curve. The transformation uses a planar surface to define the XY plane in 3d (by default this plane is the default OXYplane). **to3d** always gives a correct result, but as **to2d** is not a projection, it may surprise you. It is always correct if the curve is planar and parallel to the plane of projection. The points defining the curve are projected on the plane. A circle, however, will remain a circle and will not be changed to an ellipse.
-The **to3d **and **to2d **commands are used to create respectively a 3d curve from a 2d curve and a 2d curve from a 3d curve. The transformation uses a planar surface to define the XY plane in 3d (by default this plane is the default OXYplane). **to3d **always gives a correct result, but as **to2d **is not a projection, it may surprise you. It is always correct if the curve is planar and parallel to the plane of projection. The points defining the curve are projected on the plane. A circle, however, will remain a circle and will not be changed to an ellipse.
**Example:**
-
+~~~~~
# the following commands
circle c 0 0 5
plane p -2 1 0 1 2 3
@@ -3660,61 +4095,78 @@ to3d c c p
# will create the same circle as
circle c -2 1 0 1 2 3 5
+~~~~~
See also: **project**
-@subsubsection occt_2142243456_11014048526211 project
+@subsubsection occt_draw_6_2_11 project
-Syntax: project name curve3d surface
+Syntax:
+~~~~~
+project name curve3d surface
+~~~~~
-**project **computes a 2d curve in the parametric space of a surface corresponding to a 3d curve. This can only be used on analytical surfaces.
-**Example:**
+Computes a 2d curve in the parametric space of a surface corresponding to a 3d curve. This can only be used on analytical surfaces.
-# intersect a cylinder and a plane
-# and project the resulting ellipse on the cylinder
-# this will create a 2d sinusoid-like bspline
+If we, for example, intersect a cylinder and a plane and project the resulting ellipse on the cylinder, this will create a 2d sinusoid-like bspline.
+
+~~~~~
cylinder c 5
plane p 0 0 0 0 1 1
intersect i c p
project i2d i c
+~~~~~
-@subsection occt_2142243456_110140485263 Surface creation
+@subsection occt_draw_6_3 Surface creation
-Types of surfaces are:
-
- * Analytical surfaces: plane, cylinder, cone, sphere, torus.
- * Polar surfaces: bezier surfaces, bspline surfaces
- * Trimmed and Offset surfaces; see **trim**, **trimu**, **trimv**, **offset**.
- * Surfaces produced by Revolution and Extrusion, created from curves with the **revsurf **and **extsurf**.
+The following types of surfaces exist:
+ * Analytical surfaces: plane, cylinder, cone, sphere, torus;
+ * Polar surfaces: bezier surfaces, bspline surfaces;
+ * Trimmed and Offset surfaces;
+ * Surfaces produced by Revolution and Extrusion, created from curves with the *revsurf* and *extsurf*;
* NURBS surfaces.
Surfaces are displayed with isoparametric lines. To show the parameterization, a small parametric line with a length 1/10 of V is displayed at 1/10 of U.
+@subsubsection occt_draw_6_3_1 plane
-@subsubsection occt_2142243456_1101404852631 plane
+Syntax:
+~~~~~
+plane name [x y z [dx dy dz [ux uy uz]]]
+~~~~~
-Syntax: plane name [x y z [dx dy dz [ux uy uz]]]
+Creates an infinite plane.
+
+A plane is the same as a 3d coordinate system, *x,y,z* is the origin, *dx, dy, dz* is the Z direction and *ux, uy, uz* is the X direction.
+
+The plane is perpendicular to Z and X is the U parameter. *dx,dy,dz* and *ux,uy,uz* must not be null or collinear. *ux,uy,uz* will be modified to be orthogonal to *dx,dy,dz*.
+
+There are default values for the coordinate system. If no arguments are given, the global system (0,0,0), (0,0,1), (1,0,0). If only the origin is given, the axes are those given by default(0,0,1), (1,0,0). If the origin and the Z axis are given, the X axis is generated perpendicular to the Z axis.
+
+Note that this definition will be used for all analytical surfaces.
-Uses this command to create an infinite plane. A plane is the same as a 3d coordinate system, x,y,z is the origin, dx, dy, dz is the Z direction and ux, uy, uz is the X direction. The plane is perpendicular to Z and X is the U parameter. dx,dy,dz and ux,uy,uz must not be null and not colinear. ux,uy,uz will be modified to be orthogonal to dx,dy,dz. There are default values for the coordinate system. If no arguments are given, the global system (0,0,0), (0,0,1), (1,0,0). If only the origin is given, the axes are those given by default(0,0,1), (1,0,0). If the origin and the Z axis are given, the X axis is generated perpendicular to the Z axis. Note that this definition will be used for all analytical surfaces.
**Example:**
-
+~~~~~
# a plane through the point 10,0,0 perpendicular to X
# with U direction on Y
plane p1 10 0 0 1 0 0 0 1 0
# an horixontal plane with origin 10, -20, -5
plane p2 10 -20 -5
+~~~~~
+@subsubsection occt_draw_6_3_2 cylinder
-@subsubsection occt_2142243456_1101404852632 cylinder
-
-Syntax: cylinder name [x y z [dx dy dz [ux uy uz]]] radius
+Syntax:
+~~~~~
+cylinder name [x y z [dx dy dz [ux uy uz]]] radius
+~~~~~
A cylinder is defined by a coordinate system, and a radius. The surface generated is an infinite cylinder with the Z axis as the axis. The U parameter is the angle starting from X going in the Y direction.
-See also: **plane**
-**Example:**
+**Example:**
+~~~~~
# a cylinder on the default Z axis, radius 10
cylinder c1 10
@@ -3727,87 +4179,110 @@ cylinder c2 5 10 -3 10
dset lo pi/3. la pi/4.
cylinder c3 0 0 0 cos(la)*cos(lo) cos(la)*sin(lo)
sin(la) 10
+~~~~~
+@subsubsection occt_draw_6_3_3 cone
-@subsubsection occt_2142243456_1101404852633 cone
-
-Syntax: cone name [x y z [dx dy dz [ux uy uz]]] semi-angle radius
-
+Syntax:
+~~~~~
+cone name [x y z [dx dy dz [ux uy uz]]] semi-angle radius
+~~~~~
Creates a cone in the infinite coordinate system along the Z-axis. The radius is that of the circle at the intersection of the cone and the XY plane. The semi-angle is the angle formed by the cone relative to the axis; it should be between –90 and 90. If the radius is 0, the vertex is the origin.
-See also: **plane**
-**Example:**
+**Example:**
+~~~~~
# a cone at 45 degrees at the origin on Z
cone c1 45 0
# a cone on axis Z with radius r1 at z1 and r2 at z2
cone c2 0 0 z1 180.*atan2(r2-r1,z2-z1)/pi r1
+~~~~~
-@subsubsection occt_2142243456_1101404852634 sphere
+@subsubsection occt_draw_6_3_4 sphere
-Syntax: sphere name [x y z [dx dy dz [ux uy uz]]] radius
+Syntax:
+~~~~~
+sphere name [x y z [dx dy dz [ux uy uz]]] radius
+~~~~~
-Creates a sphere in the local coordinate system defined in the **plane **command. The sphere is centered at the origin. To parameterize the sphere, u is the angle from X to Y, between o and 2*pi. v is the angle in the half-circle at angle u in the plane containing the Z axis. v is between -pi/2 and pi/2. The poles are the points Z = +/- radius; their parameters are u,+/-pi/2 for any u in 0,2*pi.
-**Example:**
+Creates a sphere in the local coordinate system defined in the **plane** command. The sphere is centered at the origin.
+
+To parameterize the sphere, *u* is the angle from X to Y, between 0 and 2*pi. *v* is the angle in the half-circle at angle *u* in the plane containing the Z axis. *v* is between -pi/2 and pi/2. The poles are the points Z = +/- radius; their parameters are u,+/-pi/2 for any u in 0,2*pi.
+
+**Example:**
+~~~~~
# a sphere at the origin
sphere s1 10
# a sphere at 10 10 10, with poles on the axis 1,1,1
sphere s2 10 10 10 1 1 1 10
+~~~~~
-See also: **plane**
+@subsubsection occt_draw_6_3_5 torus
+Syntax:
+~~~~~
+torus name [x y z [dx dy dz [ux uy uz]]] major minor
+~~~~~
-@subsubsection occt_2142243456_1101404852635 torus
+Creates a torus in the local coordinate system with the given major and minor radii. *Z* is the axis for the major radius. The major radius may be lower in value than the minor radius.
-Syntax: torus name [x y z [dx dy dz [ux uy uz]]] major minor
+To parameterize a torus, *u* is the angle from X to Y; *v* is the angle in the plane at angle *u* from the XY plane to Z. *u* and *v* are in 0,2*pi.
-Creates a torus in the local coordinate system with the given major and minor radii. Z is the axis for the major radius. The major radius may be lower in value than the minor radius.
-
-To parameterize a torus, u is the angle from X to Y; v is the angle in the plane at angle u from the XY plane to Z. u and v are in 0,2*pi.
**Example:**
-
+~~~~~
# a torus at the origin
torus t1 20 5
# a torus in another coordinate system
torus t2 10 5 -2 2 1 0 20 5
-
-See also: **plane**
+~~~~~
-@subsubsection occt_2142243456_1101404852636 beziersurf
+@subsubsection occt_draw_6_3_6 beziersurf
-Syntax: beziersurf name nbupoles nbvolpes pole, [weight]
+Syntax:
+~~~~~
+beziersurf name nbupoles nbvolpes pole, [weight]
+~~~~~
Use this command to create a bezier surface, rational or non-rational. First give the numbers of poles in the u and v directions.
-Then give the poles in the following order: pole(1, 1), pole(nbupoles, 1), pole(1, nbvpoles) and pole(nbupoles, nbvpoles).
+Then give the poles in the following order: *pole(1, 1), pole(nbupoles, 1), pole(1, nbvpoles)* and *pole(nbupoles, nbvpoles)*.
Weights may be omitted, but if you give one weight you must give all of them.
-**Example:**
+**Example:**
+~~~~~
# a non-rational degree 2,3 surface
beziersurf s 3 4 \
0 0 0 10 0 5 20 0 0 \
0 10 2 10 10 3 20 10 2 \
0 20 10 10 20 20 20 20 10 \
0 30 0 10 30 0 20 30 0
+~~~~~
-See also: **beziercurve**
+@subsubsection occt_draw_6_3_7 bsplinesurf, upbsplinesurf, vpbsplinesurf, uvpbsplinesurf
-@subsubsection occt_2142243456_1101404852637 bsplinesurf, upbsplinesurf, vpbsplinesurf, uvpbsplinesurf
-
-Syntax: bsplinesurf name udegree nbuknots uknot umult ... nbvknot vknot
+Syntax:
+~~~~~
+bsplinesurf name udegree nbuknots uknot umult ... nbvknot vknot
vmult ... x y z w ...
upbsplinesurf ...
vpbsplinesurf ...
uvpbsplinesurf ...
+~~~~~
-**bsplinesurf **generates bspline surfaces. **upbsplinesurf **creates a bspline surface periodic in u; **vpbsplinesurf **creates one periodic in v; and **uvpbsplinesurf **creates one periodic in uv.
+* **bsplinesurf** generates bspline surfaces;
+* **upbsplinesurf** creates a bspline surface periodic in u;
+* **vpbsplinesurf** creates one periodic in v;
+* **uvpbsplinesurf** creates one periodic in uv.
+
+The syntax is similar to the *bsplinecurve* command. First give the degree in u and the knots in u with their multiplicities, then do the same in v. The poles follow. The number of poles is the product of the number in u and the number in v.
+
+See *bsplinecurve* to compute the number of poles, the poles are first given in U as in the *beziersurf* command. You must give weights if the surface is rational.
-The syntax is similar to the **bsplinecurve **command. First give the degree in u and the knots in u with their multiplicities, then do the same in v. The poles follow. The number of poles is the product of the number in u and the number in v. See **bsplinecurve **to compute the number of poles, the poles are first given in U as in the beziersurf command. You must give weights if the surface is rational.
**Example:**
-
+~~~~~
# create a bspline surface of degree 1 2
# with two knots in U and three in V
bsplinesurf s \
@@ -3817,24 +4292,29 @@ bsplinesurf s \
0 10 2 1 10 10 3 1 \
0 20 10 1 10 20 20 1 \
0 30 0 1 10 30 0 1
-
-See also: **bsplinecurve**, **beziersurf**, **convert**
+~~~~~
-@subsubsection occt_2142243456_1101404852638 trim, trimu, trimv
+@subsubsection occt_draw_6_3_8 trim, trimu, trimv
-Syntax: trim newname name [u1 u2 [v1 v2]]
+Syntax:
+~~~~~
+trim newname name [u1 u2 [v1 v2]]
trimu newname name
trimv newname name
+~~~~~
+
+The **trim** commands create trimmed curves or trimmed surfaces. Note that trimmed curves and surfaces are classes of the *Geom* package.
+* *trim* creates either a new trimmed curve from a curve or a new trimmed surface in u and v from a surface.
+* *trimu* creates a u-trimmed surface,
+* *trimv* creates a v-trimmed surface.
+
+After an initial trim, a second execution with no parameters given recreates the basis curve. The curves can be either 2d or 3d. If the trimming parameters decrease and if the curve or surface is not periodic, the direction is reversed.
+
+**Note** that a trimmed curve or surface contains a copy of the basis geometry: modifying that will not modify the trimmed geometry. Trimming trimmed geometry will not create multiple levels of trimming. The basis geometry will be used.
-The **trim **commands create trimmed curves or trimmed surfaces. Note that trimmed curves and surfaces are classes of the *Geom *package. The **trim **command creates either a new trimmed curve from a curve or a new trimmed surface in u and v from a surface. **trimu **creates a u-trimmed surface, and **trimv **a v-trimmed surface. After an initial trim, a second execution with no parameters given recreates the basis curve. The curves can be either 2d or 3d. If the trimming parameters decrease and if the curve or surface is not periodic, the direction is reversed.
-
NOTE
-*Note that a trimmed curve or surface contains a copy of the*
-*basis geometry: modifying that will not modify the trimmed*
-*geometry. Trimming trimmed geometry will not create*
-*multiple levels of trimming. The basis geometry will be used.*
**Example:**
-
+~~~~~
# create a 3d circle
circle c 0 0 0 10
@@ -3859,21 +4339,23 @@ trim cc c pi/2 2*pi
# trim an infinite cylinder
cylinder cy 10
trimv cy cy 0 50
+~~~~~
-See also: **reverse**
+@subsubsection occt_draw_6_3_9 offset
-
-@subsubsection occt_2142243456_1101404852639 offset
-
-Syntax: offset name basename distance [dx dy dz]
+Syntax:
+~~~~~
+offset name basename distance [dx dy dz]
+~~~~~
Creates offset curves or surfaces at a given distance from a basis curve or surface. Offset curves and surfaces are classes from the *Geom *package.
-The curve can be a 2d or a 3d curve. To compute the offsets for a 3d curve, you must also give a vector dx,dy,dz. For a planar curve, this vector is usually the normal to the plane containing the curve.
+The curve can be a 2d or a 3d curve. To compute the offsets for a 3d curve, you must also give a vector *dx,dy,dz*. For a planar curve, this vector is usually the normal to the plane containing the curve.
The offset curve or surface copies the basic geometry, which can be modified later.
-**Example:**
+**Example:**
+~~~~~
# graphic demonstration that the outline of a torus
# is the offset of an ellipse
smallview +X+Y
@@ -3883,39 +4365,61 @@ fit
ellipse e 0 0 0 50 50*sin(angle)
# note that the distance can be negative
offset l1 e 20 0 0 1
-@subsubsection occt_2142243456_11014048526310 revsurf
+~~~~~
-Syntax: revsurf name curvename x y z dx dy dz
+@subsubsection occt_draw_6_3_10 revsurf
+
+Syntax:
+~~~~~
+revsurf name curvename x y z dx dy dz
+~~~~~
+
+Creates a surface of revolution from a 3d curve.
+
+A surface of revolution or revolved surface is obtained by rotating a curve (called the *meridian*) through a complete revolution about an axis (referred to as the *axis of revolution*). The curve and the axis must be in the same plane (the *reference plane* of the surface). Give the point of origin x,y,z and the vector dx,dy,dz to define the axis of revolution.
+
+To parameterize a surface of revolution: u is the angle of rotation around the axis. Its origin is given by the position of the meridian on the surface. v is the parameter of the meridian.
-Creates a surface of revolution from a 3d curve. A surface of revolution or revolved surface is obtained by rotating a curve (called the *meridian*) through a complete revolution about an axis (referred to as the *axis of revolution*). The curve and the axis must be in the same plane (the *reference plane* of the surface). Give the point of origin x,y,z and the vector dx,dy,dz to define the axis of revolution. To parameterize a surface of revolution: u is the angle of rotation around the axis. Its origin is given by the position of the meridian on the surface. v is the parameter of the meridian.
**Example:**
-
+~~~~~
# another way of creating a torus like surface
circle c 50 0 0 20
revsurf s c 0 0 0 0 1 0
+~~~~~
+@subsubsection occt_draw_6_3*11 extsurf
-@subsubsection occt_2142243456_11014048526311 extsurf
+Syntax:
+~~~~~
+extsurf newname curvename dx dy dz
+~~~~~
-Syntax: extsurf newname curvename dx dy dz
+Creates a surface of linear extrusion from a 3d curve. The basis curve is swept in a given direction,the *direction of extrusion* defined by a vector.
+
+In the syntax, *dx,dy,dz* gives the direction of extrusion.
+
+To parameterize a surface of extrusion: *u* is the parameter along the extruded curve; the *v* parameter is along the direction of extrusion.
-Use the **extsurf **command to create a surface of linear extrusion from a 3d curve. The basis curve is swept in a given direction,the *direction of extrusion* defined by a vector. In the syntax, dx,dy,dz gives the direction of extrusion. To parameterize a surface of extrusion: u is the parameter along the extruded curve; the v parameter is along the direction of extrusion.
**Example:**
-
+~~~~~
# an elliptic cylinder
ellipse e 0 0 0 10 5
extsurf s e 0 0 1
# to make it finite
trimv s s 0 10
+~~~~~
+@subsubsection occt_draw_6_3_12 convert
-@subsubsection occt_2142243456_11014048526312 convert
+Syntax:
+~~~~~
+convert newname name
+~~~~~
-Syntax: convert newname name
-
-**convert **creates a 2d or 3d NURBS curve or a NURBS surface from any 2d curve, 3d curve or surface. In other words, conics, beziers and bsplines are turned into NURBS. Offsets are not processed.
+Creates a 2d or 3d NURBS curve or a NURBS surface from any 2d curve, 3d curve or surface. In other words, conics, beziers and bsplines are turned into NURBS. Offsets are not processed.
+
**Example:**
-
+~~~~~
# turn a 2d arc of a circle into a 2d NURBS
circle c 0 0 5
trim c c 0 pi/3
@@ -3925,13 +4429,11 @@ convert c1 c
plane p
trim p p -1 1 -1 1
convert p1 p
+~~~~~
-
NOTE
-*Offset curves and surfaces are not treated by this command.*
+**Note** that offset curves and surfaces are not processed by this command.
-
-
-@subsection occt_2142243456_110140485264 Curve and surface modifications
+@subsection occt_draw_6_4 Curve and surface modifications
Draw provides commands to modify curves and surfaces, some of them are general, others restricted to bezier curves or bsplines.
@@ -3957,22 +4459,24 @@ Modifications for bspline:
+@subsubsection occt_draw_6_4_1 reverse, ureverse, vreverse
-@subsubsection occt_2142243456_1101404852641 reverse, ureverse, vreverse
-
-
-Syntax: reverse curvename
+Syntax:
+~~~~~
+reverse curvename
ureverse surfacename
vreverse surfacename
+~~~~~
-The **reverse **command reverses the parameterization and inverses the orientation of a 2d or 3d curve. Note that the geometry is modified. To keep the curve or the surface, you must copy it before modification.
+The **reverse** command reverses the parameterization and inverses the orientation of a 2d or 3d curve. Note that the geometry is modified. To keep the curve or the surface, you must copy it before modification.
-**ureverse **or **vreverse **reverse the u or v parameter of a surface. Note that the new parameters of the curve may change according to the type of curve. For instance, they will change sign on a line or stay 0,1 on a bezier.
+**ureverse** or **vreverse** reverse the u or v parameter of a surface. Note that the new parameters of the curve may change according to the type of curve. For instance, they will change sign on a line or stay 0,1 on a bezier.
Reversing a parameter on an analytical surface may create an indirect coordinate system.
-**Example:**
+**Example:**
+~~~~~
# reverse a trimmed 2d circle
circle c 0 0 5
trim c c pi/4 pi/2
@@ -3980,69 +4484,86 @@ reverse c
# dumping c will show that it is now trimmed between
# 3*pi/2 and 7*pi/4 i.e. 2*pi-pi/2 and 2*pi-pi/4
+~~~~~
+@subsubsection occt_draw_6_4_2 exchuv
-@subsubsection occt_2142243456_1101404852642 exchuv
-
-Syntax: exchuv surfacename
+Syntax:
+~~~~~
+exchuv surfacename
+~~~~~
For a bezier or bspline surface this command exchanges the u and v parameters.
-**Example:**
+**Example:**
+~~~~~
# exchanging u and v on a spline (made from a cylinder)
cylinder c 5
trimv c c 0 10
convert c1 c
exchuv c1
+~~~~~
+@subsubsection occt_draw_6_4_3 segment, segsur
-@subsubsection occt_2142243456_1101404852643 segment, segsur
-
-Syntax: segment curve Ufirst Ulast
+Syntax:
+~~~~~
+segment curve Ufirst Ulast
segsur surface Ufirst Ulast Vfirst Vlast
+~~~~~
-**segment **and **segsur **segment a bezier curve and a bspline curve or surface respectively. These commands modify the curve to restrict it between the new parameters: the starting point of the modified curve, Ufirst, and the end point, Ulast. Ufirst is less than Ulast.
+**segment** and **segsur** segment a bezier curve and a bspline curve or surface respectively.
-This command must not be confused with **trim **which creates new geometry.
+These commands modify the curve to restrict it between the new parameters: *Ufirst*, the starting point of the modified curve, and *Ulast*, the end point. *Ufirst* is less than *Ulast*.
+
+This command must not be confused with **trim** which creates a new geometry.
**Example:**
-
+~~~~~
# segment a bezier curve in half
beziercurve c 3 0 0 0 10 0 0 10 10 0
segment c ufirst ulast
+~~~~~
+@subsubsection occt_draw_6_4_4 iincudeg, incvdeg
-@subsubsection occt_2142243456_1101404852644 iincudeg, incvdeg
-
-Syntax: incudeg surfacename newdegree
+Syntax:
+~~~~~
+incudeg surfacename newdegree
incvdeg surfacename newdegree
+~~~~~
-**incudeg **and **incvdeg **increase the degree in the U or V parameter of a bezier or bspline surface.
+**incudeg** and **incvdeg** increase the degree in the U or V parameter of a bezier or bspline surface.
+
**Example:**
-
+~~~~~
# make a planar bspline and increase the degree to 2 3
plane p
trim p p -1 1 -1 1
convert p1 p
incudeg p1 2
incvdeg p1 3
+~~~~~
-
NOTE
-*The geometry is modified.*
+**Note** that the geometry is modified.
-@subsubsection occt_2142243456_1101404852645 cmovep, movep, movecolp, moverowp
+@subsubsection occt_draw_6_4_5 cmovep, movep, movecolp, moverowp
-Syntax: cmovep curve index dx dy [dz]
+Syntax:
+~~~~~
+cmovep curve index dx dy [dz]
movep surface uindex vindex dx dy dz
movecolp surface uindex dx dy dz
moverowp surface vindex dx dy dz
+~~~~~
-**move **methods translate poles of a bezier curve, a bspline curve or a bspline surface. **cmovep **and **movep **translate one pole with a given index.
+**move** methods translate poles of a bezier curve, a bspline curve or a bspline surface.
+* **cmovep** and **movep** translate one pole with a given index.
+* **movecolp** and **moverowp** translate a whole column (expressed by the *uindex*) or row (expressed by the *vindex*) of poles.
-**movecolp **and **moverowp **translate a whole column (expressed by the uindex) or row (expressed by the vindex) of poles.
**Example:**
-
+~~~~~
# start with a plane
# transform to bspline, raise degree and add relief
plane p
@@ -4053,134 +4574,167 @@ incvd p1 2
movecolp p1 2 0 0 5
moverowp p1 2 0 0 5
movep p1 2 2 0 0 5
+~~~~~
+@subsubsection occt_draw_6_4_6 insertpole, rempole, remcolpole, remrowpole
-@subsubsection occt_2142243456_1101404852646 insertpole, rempole, remcolpole, remrowpole
-
-Syntax: insertpole curvename index x y [z] [weight]
+Syntax:
+~~~~~
+insertpole curvename index x y [z] [weight]
rempole curvename index
remcolpole surfacename index
-remrowpole surfacename index
+remrowpole surfacename index
+~~~~~
-**insertpole **inserts a new pole into a 2d or 3d bezier curve. You may add a weight for the pole. The default value for the weight is 1. The pole is added at the position after that of the index pole. Use an index 0 to insert the new pole before the first one already existing in your drawing.
+**insertpole** inserts a new pole into a 2d or 3d bezier curve. You may add a weight for the pole. The default value for the weight is 1. The pole is added at the position after that of the index pole. Use an index 0 to insert the new pole before the first one already existing in your drawing.
-**rempole **removes a pole from a 2d or 3d bezier curve. Leave at least two poles in the curves.
+**rempole** removes a pole from a 2d or 3d bezier curve. Leave at least two poles in the curves.
+
+**remcolpole** and **remrowpole** remove a column or a row of poles from a bezier surface. A column is in the v direction and a row in the u direction The resulting degree must be at least 1; i.e there will be two rows and two columns left.
-**remcolpole **and **remrowpole **remove a column or a row of poles from a bezier surface. A column is in the v direction and a row in the u direction The resulting degree must be at least 1; i.e there will be two rows and two columns left.
**Example:**
-
+~~~~~
# start with a segment, insert a pole at end
# then remove the central pole
beziercurve c 2 0 0 0 10 0 0
insertpole c 2 10 10 0
rempole c 2
+~~~~~
+@subsubsection occt_draw_6_4_7 insertknot, insertuknot, insertvknot
-@subsubsection occt_2142243456_1101404852647 insertknot, insertuknot, insertvknot
-
-Syntax: insertknot name knot [mult = 1] [knot mult ...]
+Syntax:
+~~~~~
+insertknot name knot [mult = 1] [knot mult ...]
insertuknot surfacename knot mult
insertvknot surfacename knot mult
+~~~~~
-**insertknot **inserts knots in the knot sequence of a bspline curve. You must give a knot value and a target multiplicity. The default multiplicity is 1. If there is already a knot with the given value and a multiplicity lower than the target one, its multiplicity will be raised. **insertuknot **and **insertvknot **insert knots in a surface.
-
-
+**insertknot** inserts knots in the knot sequence of a bspline curve. You must give a knot value and a target multiplicity. The default multiplicity is 1. If there is already a knot with the given value and a multiplicity lower than the target one, its multiplicity will be raised.
+**insertuknot** and **insertvknot** insert knots in a surface.
**Example:**
-
+~~~~~
# create a cylindrical surface and insert a knot
cylinder c 10
trim c c 0 pi/2 0 10
convert c1 c
insertuknot c1 pi/4 1
+~~~~~
-@subsubsection occt_2142243456_1101404852648 remknot, remuknot, remvknot
+@subsubsection occt_draw_6_4_8 remknot, remuknot, remvknot
-Syntax: remknot index [mult] [tol]
+Syntax:
+~~~~~
+remknot index [mult] [tol]
remuknot index [mult] [tol]
remvknot index [mult] [tol]
+~~~~~
-**remknot **removes a knot from the knot sequence of a curve or a surface. Give the index of the knot and optionally, the target multiplicity. If the target multiplicity is not 0, the multiplicity of the knot will be lowered. As the curve may be modified, you are allowed to set a tolerance to control the process. If the tolerance is low, the knot will only be removed if the curve will not be modified.
+**remknot** removes a knot from the knot sequence of a curve or a surface. Give the index of the knot and optionally, the target multiplicity. If the target multiplicity is not 0, the multiplicity of the knot will be lowered. As the curve may be modified, you are allowed to set a tolerance to control the process. If the tolerance is low, the knot will only be removed if the curve will not be modified.
By default, if no tolerance is given, the knot will always be removed.
-**Example:**
+**Example:**
+~~~~~
# bspline circle, remove a knot
circle c 0 0 5
convert c1 c
incd c1 5
remknot c1 2
+~~~~~
-*NOTE*
-*Curves or Surfaces may be modified.*
+**Note** that Curves or Surfaces may be modified.
-@subsubsection occt_2142243456_1101404852649 setperiodic, setnotperiodic, setuperiodic, setunotperiodic, setvperiodic, setvnotperiodic
+@subsubsection occt_draw_6_4_9 setperiodic, setnotperiodic, setuperiodic, setunotperiodic, setvperiodic, setvnotperiodic
-Syntax: setperiodic curve
+Syntax:
+~~~~~
+setperiodic curve
setnotperiodic curve
setuperiodic surface
setunotperiodic surface
setvperiodic surface
-setvnotperiodic surface
+setvnotperiodic surface
+~~~~~
-**setperiodic **turns a bspline curve into a periodic bspline curve; the knot vector stays the same and excess poles are truncated. The curve may be modified if it has not been closed. **setnotperiodic **removes the periodicity of a periodic curve. The pole table mau be modified. Note that knots are added at the beginning and the end of the knot vector and the multiplicities are knots set to degree+1 at the start and the end.
+**setperiodic** turns a bspline curve into a periodic bspline curve; the knot vector stays the same and excess poles are truncated. The curve may be modified if it has not been closed. **setnotperiodic** removes the periodicity of a periodic curve. The pole table mau be modified. Note that knots are added at the beginning and the end of the knot vector and the multiplicities are knots set to degree+1 at the start and the end.
+
+**setuperiodic** and **setvperiodic** make the u or the v parameter of bspline surfaces periodic; **setunotperiodic**, and **setvnotperiodic** remove periodicity from the u or the v parameter of bspline surfaces.
-**setuperiodic **and **setvperiodic **make the u or the v parameter of bspline surfaces periodic; **setunotperiodic**, and **setvnotperiodic **remove periodicity from the u or the v parameter of bspline surfaces.
**Example:**
-
+~~~~~
# a circle deperiodicized
circle c 0 0 5
convert c1 c
setnotperiodic c1
-@subsubsection occt_2142243456_11014048526410 setorigin, setuorigin, setvorigin
+~~~~~
-Syntax: setorigin curvename index
+@subsubsection occt_draw_6_4_10 setorigin, setuorigin, setvorigin
+
+Syntax:
+~~~~~
+setorigin curvename index
setuorigin surfacename index
setuorigin surfacename index
+~~~~~
+
+These commands change the origin of the parameters on periodic curves or surfaces. The new origin must be an existing knot. To set an origin other than an existing knot, you must first insert one with the *insertknot* command.
-These commands change the origin of the parameters on periodic curves or surfaces. The new origin must be an existing knot. To set an origin other than an existing knot, you must first insert one with the **insertknot **command.
**Example:**
-
+~~~~~
# a torus with new U and V origins
torus t 20 5
convert t1 t
setuorigin t1 2
-setvorigin t1 2
+setvorigin t1 2
+~~~~~
-@subsection occt_2142243456_110140485265 Transformations
+@subsection occt_draw_6_5 Transformations
Draw provides commands to apply linear transformations to geometric objects: they include translation, rotation, mirroring and scaling.
-@subsubsection occt_2142243456_1101404852651 translate, dtranslate
+@subsubsection occt_draw_6_5_1 translate, dtranslate
-Syntax: translate name [names ...] dx dy dz
+Syntax:
+~~~~~
+translate name [names ...] dx dy dz
2dtranslate name [names ...] dx dy
+~~~~~
-The **Translate **command translates 3d points, curves and surfaces along a vector dx,dy,dz. You can translate more than one object with the same command.
+The **Translate** command translates 3d points, curves and surfaces along a vector *dx,dy,dz*. You can translate more than one object with the same command.
+
+For 2d points or curves, use the **2dtranslate** command.
-For 2d points or curves, use the **2dtranslate **command.
**Example:**
-
+~~~~~
# 3d tranlation
point p 10 20 30
circle c 10 20 30 5
torus t 10 20 30 5 2
-translate p c t 0 0 15
+translate p c t 0 0 15
+~~~~~
+
*NOTE*
*Objects are modified by this command.*
-@subsubsection occt_2142243456_1101404852652 rotate, drotate
+@subsubsection occt_draw_6_5_2 rotate, 2drotate
-Syntax: rotate name [name ...] x y z dx dy dz angle
-2drotate name [name ...] x y angle
-The **rotate **command rotates a 3d point curve or surface. You must give an axis of rotation with a point x,y,z, a vector dx,dy,dz, and an angle in degrees.
+Syntax:
+~~~~~
+rotate name [name ...] x y z dx dy dz angle
+2drotate name [name ...] x y angle
+~~~~~
+
+The **rotate** command rotates a 3d point curve or surface. You must give an axis of rotation with a point *x,y,z*, a vector *dx,dy,dz* and an angle in degrees.
For a 2d rotation, you need only give the center point and the angle. In 2d or 3d, the angle can be negative.
-**Example:**
+**Example:**
+~~~~~
# make a helix of circles. create a scripte file with
this code and execute it using **source**.
circle c0 10 0 0 3
@@ -4189,22 +4743,29 @@ copy c[expr $i-1] c$i
translate c$i 0 0 3
rotate c$i 0 0 0 0 0 1 36
}
+~~~~~
-@subsubsection occt_2142243456_1101404852653 pmirror, lmirror, smirror, dpmirror, dlmirror
+@subsubsection occt_draw_6_5_3 pmirror, lmirror, smirror, dpmirror, dlmirror
-Syntax: pmirror name [names ...] x y z
+Syntax:
+~~~~~
+pmirror name [names ...] x y z
lmirror name [names ...] x y z dx dy dz
smirror name [names ...] x y z dx dy dz
2dpmirror name [names ...] x y
2dlmirror name [names ...] x y dx dy
+~~~~~
The mirror commands perform a mirror transformation of 2d or 3d geometry.
-**pmirror **is the point mirror, mirroring 3d curves and surfaces about a point of symmetry. **lmirror **is the line mirror commamd, mirroring 3d curves and surfaces about an axis of symmetry. **smirror **is the surface mirror, mirroring 3d curves and surfaces about a plane of symmetry. In the last case, the plane of symmetry is perpendicular to dx,dy,dz.
+* **pmirror** is the point mirror, mirroring 3d curves and surfaces about a point of symmetry.
+* **lmirror** is the line mirror commamd, mirroring 3d curves and surfaces about an axis of symmetry.
+* **smirror** is the surface mirror, mirroring 3d curves and surfaces about a plane of symmetry. In the last case, the plane of symmetry is perpendicular to dx,dy,dz.
+* **2dpmirror** is the point mirror in 2D.
+* **2dlmirror** is the axis symmetry mirror in 2D.
-In 2d, only **2dpmirror**, point symmetry mirroring, and **2dlmirror**, axis symmetry mirroring, are available.
**Example:**
-
+~~~~~
# build 3 images of a torus
torus t 10 10 10 1 2 3 5 1
copy t t1
@@ -4213,199 +4774,257 @@ copy t t2
lmirror t2 0 0 0 1 0 0
copy t t3
smirror t3 0 0 0 1 0 0
+~~~~~
-@subsubsection occt_2142243456_1101404852654 pscale, dpscale
+@subsubsection occt_draw_6_5_4 pscale, dpscale
-Syntax: pscale name [name ...] x y z s
+Syntax:
+~~~~~
+pscale name [name ...] x y z s
2dpscale name [name ...] x y s
-The **pscale **and **2dpscale **commands transform an object by point scaling. You must give the center and the scaling factor. Because other scalings modify the type of the object, they are not provided. For example, a sphere may be transformed into an ellipsoid. Using a scaling factor of -1 is similar to using **pmirror**.
-**Example:**
+~~~~~
+The **pscale** and **2dpscale** commands transform an object by point scaling. You must give the center and the scaling factor. Because other scalings modify the type of the object, they are not provided. For example, a sphere may be transformed into an ellipsoid. Using a scaling factor of -1 is similar to using **pmirror**.
+
+
+**Example:**
+~~~~~
# double the size of a sphere
sphere s 0 0 0 10
pscale s 0 0 0 2
+~~~~~
-@subsection occt_2142243456_110140485266 Curve and surface analysis
+@subsection occt_draw_6_6 Curve and surface analysis
-**Draw **provides methods to compute information about curves and surfaces:
+**Draw** provides methods to compute information about curves and surfaces:
- * **coord **to find the coordinates of a point.
- * **cvalue **and **2dcvalue **to compute points and derivatives on curves.
- * **svalue **to compute points and derivatives on a surface.
- * **localprop **and **minmaxcurandif **to compute the curvature on a curve.
- * **parameters **to compute (u,v) values for a point on a surface.
- * **proj **and **2dproj **to project a point on a curve or a surface.
- * **surface_radius **to compute the curvature on a surface.
+ * **coord** to find the coordinates of a point.
+ * **cvalue** and **2dcvalue** to compute points and derivatives on curves.
+ * **svalue** to compute points and derivatives on a surface.
+ * **localprop** and **minmaxcurandif** to compute the curvature on a curve.
+ * **parameters** to compute (u,v) values for a point on a surface.
+ * **proj** and **2dproj** to project a point on a curve or a surface.
+ * **surface_radius** to compute the curvature on a surface.
-@subsubsection occt_2142243456_1101404852661 coord
+@subsubsection occt_draw_6_6_1 coord
-Syntax: coord P x y [z]
+Syntax:
+~~~~~
+coord P x y [z]
+~~~~~
+
+Sets the x, y (and optionally z) coordinates of the point P.
-The **coord **command will set the coordinates of the point P. x, y (and optionally z)
**Example:**
-
+~~~~~
# translate a point
point p 10 5 5
translate p 5 0 0
coord p x y z
# x value is 15
-See also: **point**
-@subsubsection occt_2142243456_1101404852662 cvalue, dcvalue
+~~~~~
-Syntax: cvalue curve U x y z [d1x d1y d1z [d2x d2y d2z]]
+
+@subsubsection occt_draw_6_6_2 cvalue, 2dcvalue
+
+Syntax:
+~~~~~
+cvalue curve U x y z [d1x d1y d1z [d2x d2y d2z]]
2dcvalue curve U x y [d1x d1y [d2x d2y]]
+~~~~~
+
+For a curve at a given parameter, and depending on the number of arguments, **cvalue** computes the coordinates in *x,y,z*, the first derivative in *d1x,d1y,d1z* and the second derivative in *d2x,d2y,d2z*.
-For a curve at a given parameter, and depending on the number of arguments, **cvalue **computes: the coordinates in x,y,z, the first derivative in d1x,d1y,d1z and the second derivative in d2x,d2y,d2z.
**Example:**
-# on a bezier curve at parameter 0
-# the point is the first pole
-# the derivative is the vector first to second pole
-# multiplied by the degree
-# the second derivative is the difference
-# first to second pole, second to third pole
-# multipied by degree * degree-1
+Let on a bezier curve at parameter 0 the point is the first pole; the first derivative is the vector to the second pole multiplied by the degree; the second derivative is the difference first to the second pole, second to the third pole multipied by *degree-1* :
+
+~~~~~
2dbeziercurve c 4 0 0 1 1 2 1 3 0
2dcvalue c 0 x y d1x d1y d2x d2y
# values of x y d1x d1y d2x d2y
# are 0 0 3 3 0 -6
+~~~~~
+@subsubsection occt_draw_6_6_3 svalue
-@subsubsection occt_2142243456_1101404852663 svalue
+Syntax:
+~~~~~
+svalue surfname U v x y z [dux duy duz dvx dvy dvz [d2ux d2uy d2uz d2vx d2vy d2vz d2uvx d2uvy d2uvz]]
+~~~~~
-Syntax: svalue surfname U v x y z [dux duy duz dvx dvy dvz [d2ux d2uy d2uz d2vx d2vy d2vz d2uvx d2uvy d2uvz]]
+Computes points and derivatives on a surface for a pair of parameter values. The result depends on the number of arguments. You can compute the first and the second derivatives.
-**svalue **computes points and derivatives on a surface for a pair of parameter values. The result depends on the number of arguments. You can compute first and second derivatives.
**Example:**
-
+~~~~~
# display points on a sphere
sphere s 10
for {dset t 0} {[dval t] = 1} {dset t t+0.01} {
svalue s t*2*pi t*pi-pi/2 x y z
point . x y z
}
+~~~~~
+@subsubsection occt_draw_6_6_4 localprop, minmaxcurandinf
-@subsubsection occt_2142243456_1101404852664 localprop, minmaxcurandinf
+Syntax:
+~~~~~
+localprop curvename U
+minmaxcurandinf curve
+~~~~~
-Syntax: localprop curvename U
-minmaxcurandinf curve
+**localprop** computes the curvature of a curve.
+**minmaxcurandinf** computes and prints the parameters of the points where the curvature is minimum and maximum on a 2d curve.
-The **localprop **command computes the curvature of a curve.
-**minmaxcurandinf **computes and prints the parameters of the points where the curvature is minimum and maximum on a 2d curve.
**Example:**
-
+~~~~~
# show curvature at the center of a bezier curve
beziercurve c 3 0 0 0 10 2 0 20 0 0
localprop c 0.5
== Curvature : 0.02
+~~~~~
-See also: **surface_radius**
+@subsubsection occt_draw_6_6_5 parameters
+Syntax:
+~~~~~
+parameters surf/curve x y z U [V]
+~~~~~
-@subsubsection occt_2142243456_1101404852665 parameters
+Returns the parameters on the surface of the 3d point *x,y,z* in variables *u* and *v*. This command may only be used on analytical surfaces: plane, cylinder, cone, sphere and torus.
-Syntax: parameters surf/curve x y z U [V]
-
-The **parameters **command returns the parameters on the surface of the 3d point x,y,z in variables u and v . This command may only be used on analytical surfaces: plane, cylinder, cone, sphere and torus.
**Example:**
-
+~~~~~
# Compute parameters on a plane
plane p 0 0 10 1 1 0
parameters p 5 5 5 u v
# the values of u and v are : 0 5
+~~~~~
+@subsubsection occt_draw_6_6_6 proj, dproj
-@subsubsection occt_2142243456_1101404852666 proj, dproj
-
-Syntax: proj name x y z
+Syntax:
+~~~~~
+proj name x y z
2dproj name xy
+~~~~~
-Use **proj **to project a point on a 3d curve or a surface and **2dproj **for a 2d curve.
+Use **proj** to project a point on a 3d curve or a surface and **2dproj** for a 2d curve.
+
+The command will compute and display all points in the projection. The lines joining the point to the projections are created with the names *ext_1, ext_2, ... *
-The command will compute and display all points in the projection. The lines joining the point to the projections are created with the names ext_1, ext_2, ...
**Example:**
-# project point on a torus
+Let us project a point on a torus
+
+~~~~~
torus t 20 5
proj t 30 10 7
== ext_1 ext_2 ext_3 ext_4
+~~~~~
+@subsubsection occt_draw_6_6_7 surface_radius
-@subsubsection occt_2142243456_1101404852667 surface_radius
+Syntax:
+~~~~~
+surface_radius surface u v [c1 c2]
+~~~~~
-Syntax: surface_radius surface u v [c1 c2]
+Computes the main curvatures of a surface at parameters *(u,v)*. If there are extra arguments, their curvatures are stored in variables *c1* and *c2*.
-The **surface_radius **command computes the main curvatures of a surface at parameters (u,v). If there are extra arguments, their curvatures are stored in variables c1 and c2.
**Example:**
-# computes curvatures of a cylinder
+Let us compute curvatures of a cylinder:
+
+~~~~~
cylinder c 5
surface_radius c pi 3 c1 c2
== Min Radius of Curvature : -5
== Min Radius of Curvature : infinite
+~~~~~
+@subsection occt_draw_6_7 Intersections
-@subsection occt_2142243456_110140485267 Intersections
+* **intersect** computes intersections of surfaces;
+* **2dintersect** computes intersections of 2d curves.
-The **intersect **command computes intersections of surfaces; the **2dintersect **command, intersections of 2d curves.
+@subsubsection occt_draw_6_7_1 intersect
+Syntax:
+~~~~~
+intersect name surface1 surface2
+~~~~~
-@subsubsection occt_2142243456_1101404852671 intersect
+Intersects two surfaces; if there is one intersection curve it will be named *name*, if there are more than one they will be named *name_1*, *name_2*, ...
-Syntax: intersect name surface1 surface2
-
-The **intersect **command intersects two surfaces. If there is one intersection curve it will be named ;name;, if there are more than one they will be named ;name_1;, ;name_2;, ...
**Example:**
-
+~~~~~
# create an ellipse
cone c 45 0
plane p 0 0 40 0 1 5
intersect e c p
+~~~~~
+@subsubsection occt_draw_6_7_2 dintersect
-@subsubsection occt_2142243456_1101404852672 dintersect
+Syntax:
+~~~~~
+2dintersect curve1 curve2
+~~~~~
-Syntax: 2dintersect curve1 curve2
+Displays the intersection points between two 2d curves.
-**2dintersect **displays the intersection points between two 2d curves.
**Example:**
-
+~~~~~
# intersect two 2d ellipses
ellipse e1 0 0 5 2
ellipse e2 0 0 0 1 5 2
2dintersect e1 e2
-@subsection occt_2142243456_110140485268 Approximations
+~~~~~
+
+@subsection occt_draw_6_8 Approximations
Draw provides command to create curves and surfaces by approximation.
-**2dapprox **fits a curve through 2d points, **appro **fits a curve through 3d points, **surfapp **and **grilapp **fits a surface through 3d points, **2dinterpolate **may be used to interpolate a curve.
+* **2dapprox** fits a curve through 2d points;
+* **appro** fits a curve through 3d points;
+* **surfapp** and **grilapp** fit a surface through 3d points;
+* **2dinterpolate** interpolates a curve.
-@subsubsection occt_2142243456_1101404852681 appro, dapprox
+@subsubsection occt_draw_6_8_1 appro, dapprox
-Syntax: appro result nbpoint [curve]
-2dapprox result nbpoint [curve / x1 y1 x2 y2]
+Syntax:
+~~~~~
+appro result nbpoint [curve]
+2dapprox result nbpoint [curve / x1 y1 x2 y2]
+~~~~~
These commands fit a curve through a set of points. First give the number of points, then choose one of the three ways available to get the points. If you have no arguments, click on the points. If you have a curve argument or a list of points, the command launches computation of the points on the curve.
+
**Example:**
-# pick points and they will be fitted
+Let us pick points and they will be fitted
+
+~~~~~
2dapprox c 10
+~~~~~
+
+@subsubsection occt_draw_6_8_2 surfapp, grilapp
-@subsubsection occt_2142243456_1101404852682 surfapp, grilapp
-
-
-Syntax: surfapp name nbupoints nbvpoints x y z ....
+Syntax:
+~~~~~
+surfapp name nbupoints nbvpoints x y z ....
grilapp name nbupoints nbvpoints xo dx yo dy z11 z12 ...
+~~~~~
-**surfapp **fits a surface through an array of u and v points, nbupoints*nbvpoints.
+* **surfapp** fits a surface through an array of u and v points, nbupoints*nbvpoints.
+* **grilapp** has the same function, but the x,y coordinates of the points are on a grid starting at x0,y0 with steps dx,dy.
-**grilapp **has the same function, but the x,y coordinates of the points are on a grid starting at x0,y0 with steps dx,dy.
**Example:**
-
+~~~~~
# a surface using the same data as in the beziersurf
example sect 4.4
surfapp s 3 4 \
@@ -4413,37 +5032,43 @@ surfapp s 3 4 \
0 10 2 10 10 3 20 10 2 \
0 20 10 10 20 20 20 20 10 \
0 30 0 10 30 0 20 30 0
+~~~~~
+
+@subsection occt_draw_6_9 Constraints
+
+* **cirtang** constructs 2d circles tangent to curves;
+* **lintan** constructs 2d lines tangent to curves.
+@subsubsection occt_draw_6_9_1 cirtang
+Syntax:
+~~~~~
+cirtang cname curve/point/radius curve/point/radius curve/point/radius
+~~~~~
+Builds all circles satisfying the three constraints which are either a curve (the circle must be tangent to that curve), a point (the circle must pass through that point), or a radius for the circle. Only one constraint can be a radius. The solutions will be stored in variables *name_1*, *name_2*, etc.
-@subsection occt_2142243456_110140485269 Constraints
-
-The **cirtang **command is used to construct 2d circles tangent to curves and **lintan **to construct 2d lines tangent to curves.
-
-
-@subsubsection occt_2142243456_1101404852691 cirtang
-
-Syntax: cirtang cname curve/point/radius curve/point/radius curve/point/radius
-
-The **cirtang **command will build all circles satisfying the three constraints which are either a curve (the circle must be tangent to that curve), a point (the circle must pass through that point), or a radius for the circle. Only one constraint can be a radius. The solutions will be stored in variables *name_1*, *name_2*, etc.
**Example:**
-
+~~~~~
# a point, a line and a radius. 2 solutions
point p 0 0
line 1 10 0 -1 1
cirtang c p 1 4
== c_1 c_2
+~~~~~
+@subsubsection occt_draw_6_9_2 lintan
-@subsubsection occt_2142243456_1101404852692 lintan
+Syntax:
+~~~~~
+lintan name curve curve [angle]
+~~~~~
-Syntax: lintan name curve curve [angle]
+Builds all 2d lines tangent to two curves. If the third angle argument is given the second curve must be a line and **lintan** will build all lines tangent to the first curve and forming the given angle with the line. The angle is given in degrees. The solutions are named *name_1*, *name_2*, etc.
-The **lintan **command will build all 2d lines tangent to two curves. If a third angle argument is given the second curve must be a line and **lintan **will build all lines tangent to the first curve and forming the given angle with the line. The angle is given in degrees. The solutions are named name_1, name_2, etc.
**Example:**
-
+~~~~~
# lines tangent to 2 circles, 4 solutions
circle c1 -10 0 10
circle c2 10 0 5
@@ -4454,107 +5079,120 @@ solutions: l1_1 l1_2
circle c1 -10 0 1
line l 2 0 1 1
lintan l1 c1 l 15
+~~~~~
-
-
-
-@subsection occt_2142243456_1101404852610 Display
+@subsection occt_draw_6_10 Display
Draw provides commands to control the display of geometric objects. Some display parameters are used for all objects, others are valid for surfaces only, some for bezier and bspline only, and others for bspline only.
-On curves and surfaces, you can control the mode of representation with the **dmode **command. You can control the parameters for the mode with the **defle **command and the **discr **command, which control deflection and discretization respectively.
+On curves and surfaces, you can control the mode of representation with the **dmode** command. You can control the parameters for the mode with the **defle** command and the **discr** command, which control deflection and discretization respectively.
-On surfaces, you can control the number of isoparametric curves displayed on the surface with the **nbiso **commands.
+On surfaces, you can control the number of isoparametric curves displayed on the surface with the **nbiso** command.
-On bezier and bspline curve and surface you can toggle the display of the control points with the **clpoles **and **shpoles **commands.
+On bezier and bspline curve and surface you can toggle the display of the control points with the **clpoles** and **shpoles** commands.
-On bspline curves and surfaces you can toggle the display of the knots with the **shknots **and **clknots **commands.
+On bspline curves and surfaces you can toggle the display of the knots with the **shknots** and **clknots** commands.
-@subsubsection occt_2142243456_11014048526101 dmod, discr, defle
+@subsubsection occt_draw_6_10_1 dmod, discr, defle
-Syntax: dmode name [name ...] u/d
+Syntax:
+~~~~~
+dmode name [name ...] u/d
discr name [name ...] nbintervals
defle name [name ...] deflection
+~~~~~
-**dmode **allows you to choose the display mode for a curve or a surface.
+**dmod** command allows choosing the display mode for a curve or a surface.
-In mode ;u;, or *uniform deflection*, the points are computed to keep the polygon at a distance lower than the deflection of the geometry. The deflection is set with the **defle **command. This mode involves intensive use of computational power.
+In mode *u*, or *uniform deflection*, the points are computed to keep the polygon at a distance lower than the deflection of the geometry. The deflection is set with the *defle* command. This mode involves intensive use of computational power.
-In ;d;, or discretization mode, a fixed number of points is computed. This number is set with the **discr **command. This is the default mode. On a bspline, the fixed number of points is computed for each span of the curve. (A span is the interval between two knots).
+In *d*, or discretization mode, a fixed number of points is computed. This number is set with the *discr* command. This is the default mode. On a bspline, the fixed number of points is computed for each span of the curve. (A span is the interval between two knots).
If the curve or the isolines seem to present too many angles, you can either increase the discretization or lower the deflection, depending on the mode. This will increase the number of points.
-**Example:**
+**Example:**
+~~~~~
# increment the number of points on a big circle
circle c 0 0 50 50
discr 100
# change the mode
dmode c u
+~~~~~
+@subsubsection occt_draw_6_10_2 nbiso
-@subsubsection occt_2142243456_11014048526102 nbiso
+Syntax:
+~~~~~
+nbiso name [names...] nuiso nviso
+~~~~~
-Syntax: nbiso name [names...] nuiso nviso
+Changes the number of isoparametric curves displayed on a surface in the U and V directions. On a bspline surface, isoparametric curves are displayed by default at knot values. Use *nbiso* to turn this feature off.
-**nbiso **changes the number of isoparametric curves displayed on a surface in the U and V directions. On a bspline surface, isoparametric curves are displayed by default at knot values. Use **nbiso **to turn this feature off.
**Example:**
-# display 35 meridians and 15 parallels on a spere
+Let us display 35 meridians and 15 parallels on a sphere:
+~~~~~
sphere s 20
nbiso s 35 15
+~~~~~
+@subsubsection occt_draw_6_10_3 clpoles, shpoles
-@subsubsection occt_2142243456_11014048526103 clpoles, shpoles
-
-Syntax: clpoles name
+Syntax:
+~~~~~
+clpoles name
shpoles name
+~~~~~
+
+On bezier and bspline curves and surfaces, the control polygon is displayed by default: *clpoles* erases it and *shpoles* restores it.
-On bezier and bspline curves and surfaces, the control polygon is displayed by default: **clpoles **erases it and **shpoles **restores it.
**Example:**
-# make a bezier curve and erase the poles
+Let us make a bezier curve and erase the poles
+
+~~~~~
beziercurve c 3 0 0 0 10 0 0 10 10 0
clpoles c
+~~~~~
+@subsubsection occt_draw_6_10_4 clknots, shknots
-@subsubsection occt_2142243456_11014048526104 clknots, shknots
-
-Syntax: clknots name
+Syntax:
+~~~~~
+clknots name
shknots name
+~~~~~
+
+By default, knots on a bspline curve or surface are displayed with markers at the points with parametric value equal to the knots. *clknots* removes them and *shknots* restores them.
-By default, knots on a bspline curve or surface are displayed with markers at the points with parametric value equal to the knots. **clknots **removes them and **shknots **restores them.
**Example:**
-
+~~~~~
# hide the knots on a bspline curve
bsplinecurve bc 2 3 0 3 1 1 2 3 \
10 0 7 1 7 0 7 1 3 0 8 1 0 0 7 1
-clknots bc
-@section occt_2142243456_1869436669 Topology commands
-
-
-
-
-
-
+clknots bc
+~~~~~
+
+@section occt_draw_7 Topology commands
Draw provides a set of commands to test OCCT Topology libraries. The Draw commands are found in the DRAWEXE executable or in any executable including the BRepTest commands.
Topology defines the relationship between simple geometric entities, which can thus be linked together to represent complex shapes. The type of variable used by Topology in Draw is the shape variable.
-The different topological shapes[3] include:
+The different topological shapes include:
- * COMPOUND: A group of any type of topological object.
- * COMPSOLID: A set of solids connected by their faces. This expands the notions of WIRE and SHELL to solids.
- * SOLID: A part of space limited by shells. It is three dimensional.
- * SHELL: A set of faces connected by their edges. A shell can be open or closed.
- * FACE: In 2d, a plane; in 3d, part of a surface. Its geometry is constrained (trimmed) by contours. It is two dimensional.
- * WIRE: A set of edges connected by their vertices. It can be open or closed depending on whether the edges are linked or not.
- * EDGE: A topological element corresponding to a restrained curve. An edge is generally limited by vertices. It has one dimension.
- * VERTEX: A topological element corresponding to a point. It has a zero dimension.
+ * **COMPOUND**: A group of any type of topological object.
+ * **COMPSOLID**: A set of solids connected by their faces. This expands the notions of WIRE and SHELL to solids.
+ * **SOLID**: A part of space limited by shells. It is three dimensional.
+ * **SHELL**: A set of faces connected by their edges. A shell can be open or closed.
+ * **FACE**: In 2d, a plane; in 3d, part of a surface. Its geometry is constrained (trimmed) by contours. It is two dimensional.
+ * **WIRE**: A set of edges connected by their vertices. It can be open or closed depending on whether the edges are linked or not.
+ * **EDGE**: A topological element corresponding to a restrained curve. An edge is generally limited by vertices. It has one dimension.
+ * **VERTEX**: A topological element corresponding to a point. It has a zero dimension.
-Shapes are usually shared. **copy **will create a new shape which shares its representation with the original. Nonetheless, two shapes sharing the same topology can be moved independently (see the section on **transformation**).
+Shapes are usually shared. **copy** will create a new shape which shares its representation with the original. Nonetheless, two shapes sharing the same topology can be moved independently (see the section on **transformation**).
The following topics are covered in the eight sections of this chapter:
@@ -4568,15 +5206,14 @@ The following topics are covered in the eight sections of this chapter:
* Analysis of shapes.
-
-@subsection occt_2142243456_186943666971 Basic topology
+@subsection occt_draw_7_1 Basic topology
The set of basic commands allows simple operations on shapes, or step-by-step construction of objects. These commands are useful for analysis of shape structure and include:
- * **isos **and **discretisation **to control display of shape faces by isoparametric curves .
- * **orientation**, **complement **and **invert **to modify topological attributes such as orientation.
- * **explode**, **exwire **and **nbshapes **to analyze the structure of a shape.
- * **emptycopy**, **add**, **compound **to create shapes by stepwise construction.
+ * **isos** and **discretisation** to control display of shape faces by isoparametric curves .
+ * **orientation**, **complement** and **invert** to modify topological attributes such as orientation.
+ * **explode**, **exwire** and **nbshapes** to analyze the structure of a shape.
+ * **emptycopy**, **add**, **compound** to create shapes by stepwise construction.
In Draw, shapes are displayed using isoparametric curves. There is color coding for the edges:
@@ -4585,45 +5222,49 @@ In Draw, shapes are displayed using isoparametric curves. There is color coding
* a yellow edge is a shared edge, which belongs to at least two faces.
-@subsubsection occt_2142243456_1869436669711 isos, discretisation
+@subsubsection occt_draw_7_1_1 isos, discretisation
-Syntax: isos [name ...][nbisos]
-discretisation nbpoints
-**isos **determines or changes the number of isoparametric curves on shapes.
+Syntax:
+~~~~~
+isos [name ...][nbisos]
+discretisation nbpoints
+~~~~~
+
+Determines or changes the number of isoparametric curves on shapes.
-The same number is used for the u and v directions. With no arguments, **isos **prints the current default value. To determine, the number of isos for a shape, give it name as the first argument.
+The same number is used for the u and v directions. With no arguments, *isos* prints the current default value. To determine, the number of isos for a shape, give it name as the first argument.
+
+*discretisation* changes the default number of points used to display the curves. The default value is 30.
-**discretisation **changes the default number of points used to display the curves. The default value is 30.
**Example:**
-
+~~~~~
# Display only the edges (the wireframe)
isos 0
+~~~~~
-
NOTE
-Don’t confuse *isos* and *discretisation* with the geometric
-*commands *nbisos* and *discr*.*
+**Warning**: don’t confuse *isos* and *discretisation* with the geometric commands *nbisos* and *discr*.
-@subsubsection occt_2142243456_1869436669712 orientation, complement, invert, normals, range
+@subsubsection occt_draw_7_1_2 orientation, complement, invert, normals, range
-Syntax: orientation name [name ...] F/R/E/I
+Syntax:
+~~~~~
+orientation name [name ...] F/R/E/I
complement name [name ...]
invert name
normals s (length = 10), disp normals
range name value value
+~~~~~
-**orientation **assigns the orientation of shapes - simple and complex - to one of the following four values: FORWARD, REVERSED, INTERNAL, EXTERNAL.
-
-**complement **changes the current orientation of shapes to its complement, FORWARD - REVERSED, INTERNAL - EXTERNAL.
-
-**invert **creates a new shape which is a copy of the original with the orientation all subshapes reversed. For example, it may be useful to reverse the normals of a solid.
-
-**normals **returns the assignment of colors to orientation values.
-
-**range **defines the length of a selected edge by defining the values of a starting point and an end point.
+* **orientation** assigns the orientation of shapes - simple and complex - to one of the following four values: *FORWARD, REVERSED, INTERNAL, EXTERNAL*.
+* **complement** changes the current orientation of shapes to its complement, *FORWARD - REVERSED, INTERNAL - EXTERNAL*.
+* **invert** creates a new shape which is a copy of the original with the orientation all subshapes reversed. For example, it may be useful to reverse the normals of a solid.
+* *normals** returns the assignment of colors to orientation values.
+* **range** defines the length of a selected edge by defining the values of a starting point and an end point.
+
**Example:**
-
-# invert normals of a box
+~~~~~
+# to invert normals of a box
box b 10 20 30
normals b 5
invert b
@@ -4639,23 +5280,27 @@ makedge e 1
# to define the length of the edge as starting from 0
and finishing at 1
range e 0 1
+~~~~~
+@subsubsection occt_draw_7_1_3 explode, exwire, nbshapes
-@subsubsection occt_2142243456_1869436669713 explode, exwire, nbshapes
-
-Syntax: explode name [C/So/Sh/F/W/E/V]
+Syntax:
+~~~~~
+explode name [C/So/Sh/F/W/E/V]
exwire name
nbshapes name
+~~~~~
-**explode **extracts subshapes from an entity. The subshapes will be named *name_1*, *name_2*, ... Note that they are not copied but shared with the original.
+**explode** extracts subshapes from an entity. The subshapes will be named *name_1*, *name_2*, ... Note that they are not copied but shared with the original.
-With name only, **explode **will extract the first sublevel of shapes: the shells of a solid or the edges of a wire, for example. With one argument, **explode **will extract all subshapes of that type: *C *for compounds, *So *for solids, *Sh *for shells, *F *for faces, *W *for wires, *E *for edges, *V *for vertices.
+With name only, **explode** will extract the first sublevel of shapes: the shells of a solid or the edges of a wire, for example. With one argument, **explode** will extract all subshapes of that type: *C* for compounds, *So* for solids, *Sh* for shells, *F* for faces, *W* for wires, *E* for edges, *V* for vertices.
-**exwire **is a special case of **explode **for wires, which extracts the edges in an ordered way,if possible. Each edge, for example, is connected to the following one by a vertex.
+**exwire** is a special case of **explode** for wires, which extracts the edges in an ordered way, if possible. Each edge, for example, is connected to the following one by a vertex.
+
+**nbshapes** counts the number of shapes of each type in an entity.
-**nbshapes **counts the number of shapes of each type in an entity.
**Example:**
-
+~~~~~
# on a box
box b 10 20 30
@@ -4686,100 +5331,110 @@ SOLID : 1
COMPSOLID : 0
COMPOUND : 0
SHAPE : 34
+~~~~~
+@subsubsection occt_draw_7_1_4 emptycopy, add, compound
-@subsubsection occt_2142243456_1869436669714 emptycopy, add, compound
-
-Syntax: emptycopy [newname] name
+Syntax:
+~~~~~
+emptycopy [newname] name
add name toname
compound [name ...] compoundname
+~~~~~
-**emptycopy **returns an empty shape with the same orientation, location, and geometry as the target shape, but with no sub-shapes. If the newname argument is not given, the new shape is stored with the same name. This command is used to modify a frozen shape. A frozen shape is a shape used by another one. To modify it, you must emptycopy it. Its subshape may be reinserted with the **add **command.
+**emptycopy** returns an empty shape with the same orientation, location, and geometry as the target shape, but with no sub-shapes. If the newname argument is not given, the new shape is stored with the same name. This command is used to modify a frozen shape. A frozen shape is a shape used by another one. To modify it, you must emptycopy it. Its subshape may be reinserted with the **add** command.
-**add **inserts shape C into shape S. Verify that C and S reference compatible types of objects:
-
- * Any *Shape *can be added to a *Compound*.
- * Only a *Solid *can be added to a *CompSolid*.
- * Only a *Shell*, an *Edge *or a *Vertex *can be added into a *Solid*.
- * Only a *Face *can be added to a *Shell*.
- * Only a *Wire *and *Vertex *can be added in a *Solid*.
- * Only an *Edge *can be added to a *Wire*.
- * Only a *Vertex *can be added to an *Edge*.
+**add** inserts shape *C* into shape *S*. Verify that *C* and *S* reference compatible types of objects:
+ * Any *Shape* can be added to a *Compound*.
+ * Only a *Solid* can be added to a *CompSolid*.
+ * Only a *Shell* can *Edge* or a *Vertex* can be added into a *Solid*.
+ * Only a *Face* can be added to a *Shell*.
+ * Only a *Wire* and *Vertex* can be added in a *Solid*.
+ * Only an *Edge* can be added to a *Wire*.
+ * Only a *Vertex* can be added to an *Edge*.
* Nothing can be added to a *Vertex*.
-Care should be taken using **emptycopy **and **add**.
+**emptycopy** and **add** should be used with care.
+
+On the other hand, **compound** is a safe way to achieve a similar result. It creates a compound from shapes. If no shapes are given, the compound is empty.
-On the other hand, **compound **is a safe way to achieve a similar result. It creates a compound from shapes. If no shapes are given, the compound is empty.
**Example:**
-
+~~~~~
# a compound with three boxes
box b1 0 0 0 1 1 1
box b2 3 0 0 1 1 1
box b3 6 0 0 1 1 1
compound b1 b2 b3 c
+~~~~~
+@subsubsection occt_draw_7_1_5 checkshape
-@subsubsection occt_2142243456_1869436669715 checkshape
-
-Syntax: checkshape [-top] shape [result] [-short]
+Syntax:
+~~~~~
+checkshape [-top] shape [result] [-short]
+~~~~~
Where:
-*-top* – check only topological validity of a shape.
-*shape *– the only required parameter which represents the name of the shape to check.
-*result* – optional parameter which is the prefix of the output shape names.
-*-short* – short description of check.
+* *top* – optional parameter, which allows checking only topological validity of a shape.
+* *shape*– the only required parameter which represents the name of the shape to check.
+* *result* – optional parameter which is the prefix of the output shape names.
+* *short* – a short description of the check.
+**checkshape** examines the selected object for topological and geometric coherence. The object should be a three dimensional shape.
-**checkshape **examines the selected object for topological and geometric coherence. The object should be a three dimensional shape.
**Example:**
-
+~~~~~
# checkshape returns a comment valid or invalid
box b1 0 0 0 1 1 1
checkshape b1
# returns the comment
this shape seems to be valid
+~~~~~
-
NOTE
-*This test is performed using the tolerance set in the algorithm.*
+**Note** that this test is performed using the tolerance set in the algorithm.
-
-
-
-@subsection occt_2142243456_186943666972 Curve and surface topology
+@subsection occt_draw_7_2 Curve and surface topology
This group of commands is used to create topology from shapes and to extract shapes from geometry.
- * To create vertices, use the **vertex **command.
- * To create edges use, the **edge**, **mkedge **commands.
- * To create wires, use the **wire**, **polyline**, **polyvertex **commands.
- * To create faces, use the **mkplane**, **mkface **commands.
- * To extract the geometry from edges or faces, use the **mkcurve **and **mkface **commands.
- * To extract the 2d curves from edges or faces, use the **pcurve **command.
+ * To create vertices, use the **vertex** command.
+ * To create edges use, the **edge**, **mkedge** commands.
+ * To create wires, use the **wire**, **polyline**, **polyvertex** commands.
+ * To create faces, use the **mkplane**, **mkface** commands.
+ * To extract the geometry from edges or faces, use the **mkcurve** and **mkface** commands.
+ * To extract the 2d curves from edges or faces, use the **pcurve** command.
-@subsubsection occt_2142243456_1869436669721 vertex
+@subsubsection occt_draw_7_2_1 vertex
-Syntax: vertex name [x y z / p edge]
+Syntax:
+~~~~~
+vertex name [x y z / p edge]
+~~~~~
Creates a vertex at either a 3d location x,y,z or the point at parameter p on an edge.
+
**Example:**
-
+~~~~~
vertex v1 10 20 30
+~~~~~
+@subsubsection occt_draw_7_2_2 edge, mkedge, uisoedge, visoedge
-@subsubsection occt_2142243456_1869436669722 edge, mkedge, uisoedge, visoedge
-
-Syntax: edge name vertex1 vertex2
+Syntax:
+~~~~~
+edge name vertex1 vertex2
mkedge edge curve [surface] [pfirst plast] [vfirst [pfirst] vlast [plast]]
uisoedge edge face u v1 v2
visoedge edge face v u1 u2
+~~~~~
-**edge **creates a straight line edge between two vertices.
+* **edge** creates a straight line edge between two vertices.
+* **mkedge** generates edges from curves<.Two parameters can be given for the vertices: the first and last parameters of the curve are given by default. Vertices can also be given with their parameters, this option allows blocking the creation of new vertices. If the parameters of the vertices are not given, they are computed by projection on the curve. Instead of a 3d curve, a 2d curve and a surface can be given.
-**mkedge **generates edges from curves[4].Two parameters can be given for the vertices: the first and last parameters of the curve are given by default. Vertices can also be given with their parameters, this option allows you to block the creation of new vertices. If the parameters of the vertices are not given, they are computed by projection on the curve. Instead of a 3d curve, a 2d curve and a surface can be given.
**Example:**
-
+~~~~~
# straight line edge
vertex v1 10 0 0
vertex v2 10 10 0
@@ -4793,12 +5448,12 @@ mkedge e2 c 0 pi/2
# The trimming is removed by mkedge
trim c c 0 pi/2
mkedge e2 c
+~~~~~
-**visoedge **and **uisoedge **are commands that generate a uiso parameter edge
-or a viso parameter edge.
+* **visoedge** and **uisoedge** are commands that generate a *uiso* parameter edge or a *viso* parameter edge.
**Example:**
-
+~~~~~
# to create an edge between v1 and v2 at point u
# to create the example plane
plane p
@@ -4812,72 +5467,86 @@ mkface p p
# to create the edge in the plane at the u axis point
0.5, and between the v axis points v=0.2 and v =0.8
uisoedge e p 0.5 0.20 0.8
+~~~~~
+@subsubsection occt_draw_7_2_3 wire, polyline, polyvertex
-@subsubsection occt_2142243456_1869436669723 wire, polyline, polyvertex
-
-Syntax: wire wirename e1/w1 [e2/w2 ...]
+Syntax:
+~~~~~
+wire wirename e1/w1 [e2/w2 ...]
polyline name x1 y1 z1 x2 y2 z2 ...
polyvertex name v1 v2 ...
+~~~~~
-**wire **creates a wire from edges or wires. The order of the elements should ensure that the wire is connected, and vertex locations will be compared to detect connection. If the vertices are different, new edges will be created to ensure topological connectivity. The original edge may be copied in the new one.
+**wire** creates a wire from edges or wires. The order of the elements should ensure that the wire is connected, and vertex locations will be compared to detect connection. If the vertices are different, new edges will be created to ensure topological connectivity. The original edge may be copied in the new one.
-**polyline **creates a polygonal wire from point coordinates. To make a closed wire, you should give the first point again at the end of the argument list.
+**polyline** creates a polygonal wire from point coordinates. To make a closed wire, you should give the first point again at the end of the argument list.
+
+**polyvertex** creates a polygonal wire from vertices.
-**polyvertex **creates a polygonal wire from vertices.
**Example:**
-
+~~~~~
# create two polygonal wires
# glue them and define as a single wire
polyline w1 0 0 0 10 0 0 10 10 0
polyline w2 10 10 0 0 10 0 0 0 0
wire w w1 w2
+~~~~~
+
+@subsubsection occt_draw_7_2_4 profile
+
+Syntax
+~~~~~
+profile name [code values] [code values] ...
+~~~~~
-@subsubsection occt_2142243456_1869436669724 profile
-
-Syntax profile name [code values] [code values] ...
-
-**Code** **Values ** **Action**
-O X Y Z Sets the origin of the plane
-P DX DY DZ UX UY UZ Sets the normal and X of the plane
-F X Y Sets the first point
-X DX Translates a point along X
-Y DY Translates a point along Y
-L DL Translates a point along direction
-XX X Sets point X coordinate
-YY Y Sets point Y coordinate
-T DX DY Translates a point
-TT X Y Sets a point
-R Angle Rotates direction
-RR Angle Sets direction
-D DX DY Sets direction
-IX X Intersects with vertical
-IY Y Intersects with horizontal
-C Radius Angle Arc of circle tangent to direction
-
-
Suffix
-No suffix Makes a closed face
-W Make a closed wire
-WW Make an open wire
+**profile** builds a profile in a plane using a moving point and direction. By default, the profile is closed and a face is created. The original point is 0 0, and direction is 1 0 situated in the XY plane.
-**profile **builds a profile in a plane using a moving point and direction. By default, the profile is closed and a face is created. The original point is 0 0, and direction is 1 0 situated in the XY plane.
+| **Code** | **Values ** | **Action** |
+| :------------ | :------------- | :---------------- |
+| O | X Y Z | Sets the origin of the plane |
+| P | DX DY DZ UX UY UZ | Sets the normal and X of the plane |
+| F | X Y | Sets the first point |
+| X | DX | Translates a point along X |
+| Y | DY | Translates a point along Y |
+| L | DL | Translates a point along direction |
+| XX | X | Sets point X coordinate |
+| YY | Y | Sets point Y coordinate |
+| T | DX DY | Translates a point |
+| TT | X Y | Sets a point |
+| R | Angle | Rotates direction |
+| RR | Angle | Sets direction |
+| D | DX DY | Sets direction |
+| IX | X | Intersects with vertical |
+| IY | Y | Intersects with horizontal |
+| C | Radius Angle | Arc of circle tangent to direction |
+
Codes and values are used to define the next point or change the direction. When the profile changes from a straight line to a curve, a tangent is created. All angles are in degrees and can be negative.
The point [code values] can be repeated any number of times and in any order to create the profile contour.
-The profile shape definition is the suffix; no suffix produces a face, **w **is a closed wire, **ww **is an open wire.
+| Suffix | Action |
+| :----- | :----- |
+| No suffix | Makes a closed face |
+| W | Make a closed wire |
+| WW | Make an open wire |
+
+The profile shape definition is the suffix; no suffix produces a face, *w* is a closed wire, *ww* is an open wire.
Code letters are not case-sensitive.
-**Example:**
+**Example:**
+~~~~~
# to create a trianglular plane using a vertex at the
origin, in the xy plane
profile p O 0 0 0 X 1 Y 0 x 1 y 1
-**Example:**
+~~~~~
+**Example:**
+~~~~~
# to create a contour using the different code
possibilities
@@ -4916,26 +5585,26 @@ profile p F 1 0 x 2 y 1 c 1 45 l 1 tt 1.5 1.5 xx 0.2 yy 2 c 1 290 ix 0 r 90 ix -
# to create the plane with the same contour
profile p F 1 0 x 2 y 1 c 1 45 l 1 tt 1.5 1.5 xx 0.2 yy 2 c 1 290 ix 0 r 90 ix -0.3
+~~~~~
+@subsubsection occt_draw_7_2_5 bsplineprof
-@subsubsection occt_2142243456_1869436669725 bsplineprof
+Syntax:
+~~~~~
+bsplineprof name [S face] [W WW]
+~~~~~
-Syntax: bsplineprof name [S face] [W WW]
+* for an edge : ...
+* to end profile :
-for an edge : digitizes ... mouse button 2
-to end profile : mouse button 3
+Builds a profile in the XY plane from digitizes. By default the profile is closed and a face is built.
-Build a profile in the XY plane from digitizes
-By default the profile is closed and a face is built.
+**bsplineprof** creates a 2d profile from bspline curves using the mouse as the input. *MB1* creates the points, *MB2* finishes the current curve and starts the next curve, *MB3* closes the profile.
-W Make a closed wire
-WW Make an open wires
+The profile shape definition is the suffix; no suffix produces a face, **w** is a closed wire, **ww** is an open wire.
-**bsplineprof **creates a 2d profile from bspline curves using the mouse as the input. MB1 creates the points, MB2 finishes the current curve and starts the next curve, MB3 closes the profile.
-
-The profile shape definition is the suffix; no suffix produces a face, **w **is a closed wire, **ww **is an open wire.
**Example:**
-
+~~~~~
#to view the xy plane
top
#to create a 2d curve with the mouse
@@ -4948,17 +5617,21 @@ bsplineprof res
==
# click mb1 to create the second curve
# click mb3 to create the face
+~~~~~
+@subsubsection occt_draw_7_2_6 mkoffset
-@subsubsection occt_2142243456_1869436669726 mkoffset
+Syntax:
+~~~~~
+mkoffset result face/compound of wires nboffset stepoffset
+~~~~~
-Syntax: mkoffset result face/compound of wires nboffset stepoffset
+**mkoffset** creates a parallel wire in the same plane using a face or an existing continuous set of wires as a reference. The number of occurences is not limited.
-**mkoffset **creates a parallel wire in the same plane using a face or an existing continuous set of wires as a reference. The number of occurences is not limited.
+The offset distance defines the spacing and the positioning of the occurences.
-The offset distance defines the spacing and the positionning of the occurences.
**Example:**
-
+~~~~~
#Create a box and select a face
box b 1 2 3
explode b f
@@ -4969,11 +5642,12 @@ Create one interior parallel contour with an offset
value of
0.4
mkoffset r b_1 1 -0.4
+~~~~~
+
+**Note** that *mkoffset* command must be used with prudence, as angular contours produce offset contours with fillets. Interior parallel contours can produce more than one wire, normally these are refused. In the following example, any increase in the offset value is refused.
-NOTE
-*The mkoffset command must be used with prudence, angular contours produce offset contours with fillets. Interior parallel contours can produce more than one wire, normally these are refused. In the following example, any increase in the offset value is refused*
**Example:**
-
+~~~~~
# to create the example contour
profile p F 0 0 x 2 y 4 tt 1 1 tt 0 4 w
# to create an incoherent interior offset
@@ -4982,18 +5656,22 @@ mkoffset r p 1 -0.50
BRepFill_TrimEdgeTool: incoherent intersection
# to create two incoherent wires
mkoffset r p 1 -0.50
+~~~~~
+@subsubsection occt_draw_7_2_7 mkplane, mkface
-@subsubsection occt_2142243456_1869436669727 mkplane, mkface
-
-Syntax: mkplane name wire
+Syntax:
+~~~~~
+mkplane name wire
mkface name surface [ufirst ulast vfirst vlast]
+~~~~~
-**mkplane **generates a face from a planar wire. The planar surface will be constructed with an orientation which keeps the face inside the wire.
+**mkplane** generates a face from a planar wire. The planar surface will be constructed with an orientation which keeps the face inside the wire.
+
+**mkface** generates a face from a surface. Parameter values can be given to trim a rectangular area. The default boundaries are those of the surface.
-**mkface **generates a face from a surface. Parameter values can be given to trim a rectangular area. The default boundaries are those of the surface.
**Example:**
-
+~~~~~
# make a polygonal face
polyline f 0 0 0 20 0 0 20 10 0 10 10 0 10 20 0 0 20 0 0 0 0
mkplane f f
@@ -5002,31 +5680,40 @@ mkplane f f
cylinder g 10
trim g g -pi/3 pi/2 0 15
mkface g g
+~~~~~
+@subsubsection occt_draw_7_2_8 mkcurve, mksurface
-@subsubsection occt_2142243456_1869436669728 mkcurve, mksurface
-
-Syntax: mkcurve curve edge
+Syntax:
+~~~~~
+mkcurve curve edge
mksurface name face
+~~~~~
-**mkcurve **creates a 3d curve from an edge. The curve will be trimmed to the edge boundaries.
+**mkcurve** creates a 3d curve from an edge. The curve will be trimmed to the edge boundaries.
+
+**mksurface** creates a surface from a face. The surface will not be trimmed.
-**mksurface **creates a surface from a face. The surface will not be trimmed.
**Example:**
-
+~~~~~
# make a line
vertex v1 0 0 0
vertex v2 10 0 0
edge e v1 v2
+~~~~~
+@subsubsection occt_draw_7_2_9 pcurve
-@subsubsection occt_2142243456_1869436669729 pcurve
+Syntax:
-Syntax: pcurve [name edgename] facename
+~~~~~
+pcurve [name edgename] facename
+~~~~~
+
+Extracts the 2d curve of an edge on a face. If only the face is specified, the command extracts all the curves and colors them according to their orientation. This is useful in checking to see if the edges in a face are correctly oriented, i.e. they turn counter-clockwise. To make curves visible, use a fitted 2d view.
-**pcurve **extracts the 2d curve of an edge on a face. If only the face is specified, the command extracts all the curves and colors them according to their orientation. This is useful in checking to see if the edges in a face are correctly oriented, i.e. they turn counterclockwise. To make curves visible, use a fitted 2d view.
**Example:**
-
+~~~~~
# view the pcurves of a face
plane p
trim p p -1 1 -1 1
@@ -5034,14 +5721,17 @@ mkface p p
av2d; # a 2d view
pcurve p
2dfit
+~~~~~
+
+@subsubsection occt_draw_7_2_10 chfi2d
+
+Syntax:
+~~~~~
+chfi2d result face [edge1 edge2 (F radius/CDD d1 d2/CDA d ang) ....
+~~~~~
-@subsubsection occt_2142243456_18694366697210 chfid
-
-Syntax: chfi2d result face [edge1 edge2 (F radius/CDD d1 d2/CDA d ang) ....
-
-chfi2d creates chamfers and fillets on 2D objects. Select t:wo adjacent edges and:
-
+Creates chamfers and fillets on 2D objects. Select two adjacent edges and:
* a radius value
* two respective distance values
* a distance value and an angle
@@ -5052,7 +5742,9 @@ The distance is the length value from the edge between the two selected faces in
**Example:**
-# to create a 2d fillet
+Let us create a 2d fillet:
+
+~~~~~
top
profile p x 2 y 2 x -2
chfi2d cfr p . . F 0.3
@@ -5060,19 +5752,22 @@ chfi2d cfr p . . F 0.3
#select an edge
==Pick an object
#select an edge
-**Example:**
+~~~~~
-# to create a 2d chamfer using two distances
+Let us create a 2d chamfer using two distances:
+
+~~~~~
profile p x 2 y 2 x -2
chfi2d cfr p . . CDD 0.3 0.6
==Pick an object
#select an edge
==Pick an object
#select an edge
-**Example:**
+~~~~~
-# to create a 2d chamfer using a defined distance and
-angle
+Let us create a 2d chamfer using a defined distance and angle
+
+~~~~~
top
profile p x 2 y 2 x -2
chfi2d cfr p . . CDA 0.3 75
@@ -5080,16 +5775,20 @@ chfi2d cfr p . . CDA 0.3 75
#select an edge
==Pick an object
#select an edge
+~~~~~
+@subsubsection occt_draw_7_2_11 nproject
-@subsubsection occt_2142243456_18694366697211 nproject
-
-Syntax: nproject pj e1 e2 e3 ... surf -g -d [dmax] [Tol
+Syntax:
+~~~~~
+nproject pj e1 e2 e3 ... surf -g -d [dmax] [Tol
[continuity [maxdeg [maxseg]]]
+~~~~~
+
+Creates a shape projection which is normal to the target surface.
-**nproject **creates a shape projection which is normal to the target surface.
**Example:**
-
+~~~~~
# create a curved surface
line l 0 0 0 1 0 0
trim l l 0 2
@@ -5114,30 +5813,34 @@ mkedge e c
donly p e
# create the normal projection of the shape(circle)
nproject r e p
+~~~~~
-
-@subsection occt_2142243456_186943666973 Primitives
+@subsection occt_draw_7_3 Primitives
Primitive commands make it possible to create simple shapes. They include:
- * **box **and **wedge **commands.
- * **pcylinder**, **pcone**, **psphere**, **ptorus **commands.
- * **halfspace **command
+ * **box** and **wedge** commands.
+ * **pcylinder**, **pcone**, **psphere**, **ptorus** commands.
+ * **halfspace** command
-@subsubsection occt_2142243456_1869436669731 box, wedge
+@subsubsection occt_draw_7_3_1 box, wedge
-Syntax: box name [x y z] dx dy dz
+Syntax:
+~~~~~
+box name [x y z] dx dy dz
wedge name dx dy dz ltx / xmin zmin xmax xmax
+~~~~~
-**box **creates a box parallel to the axes with dimensions dx,dy,dz. x,y,z is the corner of the box. It is the default origin.
+**box** creates a box parallel to the axes with dimensions *dx,dy,dz*. *x,y,z* is the corner of the box. It is the default origin.
-**wedge **creates a box with five faces called a wedge. One face is in the OXZ plane, and has dimensions dx,dz while the other face is in the plane y = dy. This face either has dimensions ltx, dz or is bounded by xmin,zmin,xmax,zmax.
+**wedge** creates a box with five faces called a wedge. One face is in the OXZ plane, and has dimensions *dx,dz* while the other face is in the plane *y = dy*. This face either has dimensions *ltx, dz* or is bounded by *xmin,zmin,xmax,zmax*.
+
+The other faces are defined between these faces. The face in the *y=yd* plane may be degenerated into a line if *ltx = 0*, or a point if *xmin = xmax* and *ymin = ymax*. In these cases, the line and the point both have 5 faces each. To position the wedge use the *ttranslate* and *trotate* commands.
-The other faces are defined between these faces. The face in the y=yd plane may be degenerated into a line if ltx = 0, or a point if xmin = xmax and ymin = ymax. In these cases, the line and the point both have 5 faces each. To position the wedge use the **ttranslate **and **trotate **commands.
**Example:**
-
+~~~~~
# a box at the origin
box b1 10 20 30
@@ -5152,27 +5855,31 @@ wedge w2 10 20 30 0
# a pyramid
wedge w3 20 20 20 10 10 10 10
+~~~~~
+@subsubsection occt_draw_7_3_2 pcylinder, pcone, psphere, ptorus
-@subsubsection occt_2142243456_1869436669732 pcylinder, pcone, psphere, ptorus
-
-Syntax: pcylinder name [plane] radius height [angle]
+Syntax:
+~~~~~
+pcylinder name [plane] radius height [angle]
pcone name [plane] radius1 radius2 height [angle]
pcone name [plane] radius1 radius2 height [angle]
psphere name [plane] radius1 [angle1 angle2] [angle]
ptorus name [plane] radius1 radius2 [angle1 angle2] [angle]
+~~~~~
-All these commands create solid blocks in the default coordinate system, using the Z axis as the axis of revolution and the X axis as the origin of the angles. To use another system, translate and rotate the resulting solid or use a plane as first argument to specify a coordinate system. All primitives have an optional last argument which is an angle expreesed in degrees and located on the Z axis, starting from the X axis. The default angle is 360.
+All these commands create solid blocks in the default coordinate system, using the Z axis as the axis of revolution and the X axis as the origin of the angles. To use another system, translate and rotate the resulting solid or use a plane as first argument to specify a coordinate system. All primitives have an optional last argument which is an angle expressed in degrees and located on the Z axis, starting from the X axis. The default angle is 360.
-**pcylinder **creates a cylindrical block with the given radius and height.
+**pcylinder** creates a cylindrical block with the given radius and height.
-**pcone **creates a truncated cone of the given height with radius1 in the plane z = 0 and radius2 in the plane z = height. Neither radius can be negative, but one of them can be null.
+**pcone** creates a truncated cone of the given height with radius1 in the plane z = 0 and radius2 in the plane z = height. Neither radius can be negative, but one of them can be null.
-**psphere **creates a solid sphere centered on the origin. If two angles, *angle1 *and *angle2, *are given, the solid will be limited by two planes at latitude *angle1 *and *angle2*. The angles must be increasing and in the range -90,90.
+**psphere** creates a solid sphere centered on the origin. If two angles, *angle1* and *angle2*, are given, the solid will be limited by two planes at latitude *angle1* and *angle2*. The angles must be increasing and in the range -90,90.
+
+**ptorus** creates a solid torus with the given radii, centered on the origin, which is a point along the z axis. If two angles increasing in degree in the range 0 – 360 are given, the solid will be bounded by two planar surfaces at those positions on the circle.
-**ptorus **creates a solid torus with the given radii, centered on the origin, which is a point along the z axis. If two angles increasing in degree in the range 0 – 360 are given, the solid will be bounded by two planar surfaces at those positions on the circle.
**Example:**
-
+~~~~~
# a can shape
pcylinder cy 5 10
@@ -5184,65 +5891,83 @@ psphere sp 10 270
# half torus
ptorus to 20 5 0 90
-@subsubsection occt_2142243456_1869436669733 halfspace
+~~~~~
-Syntax: halfspace result face/shell x y z
+@subsubsection occt_draw_7_3_3 halfspace
+
+Syntax:
+~~~~~
+halfspace result face/shell x y z
+~~~~~
+
+**halfspace** creates an infinite solid volume based on a face in a defined direction. This volume can be used to perform the boolean operation of cutting a solid by a face or plane.
-**halfspace **creates an infinite solid volume based on a face in a defined direction. This volume can be used to perform the boolean operation of cutting a solid by a face or plane.
**Example:**
-
+~~~~~
box b 0 0 0 1 2 3
explode b f
==b_1 b_2 b_3 b_4 b_5 b_6
halfspace hr b_3 0.5 0.5 0.5
+~~~~~
-
-@subsection occt_2142243456_186943666974 Sweeping
+@subsection occt_draw_7_4 Sweeping
Sweeping creates shapes by sweeping out a shape along a defined path:
- * **prism **sweeps along a direction.
- * **revol **sweeps around an axis.
- * **pipe **sweeps along a wire.
- * **mksweep **and **buildsweep **are commands to create sweeps by defining the arguments and algorithms.
- * **thrusections **creates a sweep from wire in different planes.
+ * **prism** sweeps along a direction.
+ * **revol** sweeps around an axis.
+ * **pipe** sweeps along a wire.
+ * **mksweep** and **buildsweep** are commands to create sweeps by defining the arguments and algorithms.
+ * **thrusections** creates a sweep from wire in different planes.
-@subsubsection occt_2142243456_1869436669741 prism
+@subsubsection occt_draw_7_4_1 prism
-Syntax: prism result base dx dy dz [Copy | Inf | SemiInf]
+Syntax:
+~~~~~
+prism result base dx dy dz [Copy | Inf | SemiInf]
+~~~~~
-**prism **creates a new shape by sweeping a shape in a direction. Any shape can be swept: a vertex gives an edge; an edge gives a face; and a face gives a solid.
+Creates a new shape by sweeping a shape in a direction. Any shape can be swept: a vertex gives an edge; an edge gives a face; and a face gives a solid.
+
+The shape is swept along the vector *dx dy dz*. The original shape will be shared in the result unless *Copy* is specified. If *Inf* is specified the prism is infinite in both directions. If *SemiInf* is specified the prism is infinite in the *dx,dy,dz* direction, and the length of the vector has no importance.
-The shape is swept along the vector dx dy dz. The original shape will be shared in the result unless *Copy *is specified. If *Inf *is specified the prism is infinite in both directions. If *SemiInf *is specified the prism is infinite in the dx,dy,dz direction, and the length of the vector has no importance.
**Example:**
-
+~~~~~
# sweep a planar face to make a solid
polyline f 0 0 0 10 0 0 10 5 0 5 5 0 5 15 0 0 15 0 0 0 0
mkplane f f
+~~~~~
+@subsubsection occt_draw_7_4_2 revol
-@subsubsection occt_2142243456_1869436669742 revol
+Syntax:
+~~~~~
+revol result base x y z dx dy dz angle [Copy]
+~~~~~
-Syntax: revol result base x y z dx dy dz angle [Copy]
+Creates a new shape by sweeping a base shape through an angle along the axis *x,y,z dx,dy,dz*. As with the prism command, the shape can be of any type and is not shared if *Copy* is specified.
-**revol **creates a new shape by sweeping a base shape through an angle along the axis x,y,z dx,dy,dz. As with the prism command, the shape can be of any type and is not shared if *Copy *is specified.
**Example:**
-
+~~~~~
# shell by wire rotation
polyline w 0 0 0 10 0 0 10 5 0 5 5 0 5 15 0 0 15 0
revol s w 20 0 0 0 1 0 90
+~~~~~
+@subsubsection occt_draw_7_4_3 pipe
-@subsubsection occt_2142243456_1869436669743 pipe
+Syntax:
+~~~~~
+pipe name wire_spine Profile
+~~~~~
-Syntax: pipe name wire_spine Profile
+Creates a new shape by sweeping a shape known as the profile along a wire known as the spine.
-**pipe **creates a new shape by sweeping a shape known as the profile along a wire known as the spine.
**Example:**
-
+~~~~~
# sweep a circle along a bezier curve to make a solid
pipe
@@ -5254,42 +5979,38 @@ mkedge profile profile
wire profile profile
mkplane profile profile
pipe p spine profile
+~~~~~
+@subsubsection occt_draw_7_4_4 mksweep, addsweep, setsweep, deletesweep, buildsweep, simulsweep
-@subsubsection occt_2142243456_1869436669744 mksweep, deletesweep, buildsweep, simulsweep
-
-Syntax: mksweep wire
-addsweep wire[vertex][-M][-C] [auxiilaryshapedeletesweep wire
+Syntax:
+~~~~~
+mksweep wire
+addsweep wire[vertex][-M][-C] [auxiilaryshape]
+deletesweep wire
setsweep options [arg1 [arg2 [...]]]
-
-options are :
-
--FR : Tangent and Normal are defined by a Frenet trihedron
--CF : Tangent is given by Frenet,
-the Normal is computed to minimize the torsion
--DX Surf : Tangent and Normal are given by Darboux trihedron,
-Surf must be a shell or a face
--CN dx dy dz : BiNormal is given by dx dy dz
--FX Tx Ty TZ [Nx Ny Nz] : Tangent and Normal are fixed
--G guide 0|1(AC
simulsweep r [n] [option]
buildsweep [r] [option] [Tol]
+~~~~~
+
+options are :
+ * *-FR* : Tangent and Normal are defined by a Frenet trihedron
+ * *-CF* : Tangent is given by Frenet, the Normal is computed to minimize the torsion
+ * *-DX Surf* : Tangent and Normal are given by Darboux trihedron, surf must be a shell or a face
+ * *-CN dx dy dz* : BiNormal is given by *dx dy dz*
+ * *-FX Tx Ty TZ [Nx Ny Nz]* : Tangent and Normal are fixed
+ * *-G guide*
These commands are used to create a shape from wires. One wire is designated as the contour that defines the direction; it is called the spine. At least one other wire is used to define the the sweep profile.
+* **mksweep** initializes the sweep creation and defines the wire to be used as the spine.
+* **addsweep** defines the wire to be used as the profile.
+* **deletesweep** cancels the choice of profile wire, without leaving the mksweep mode. You can re-select a profile wire.
+* **setsweep** commands the algorithms used for the construction of the sweep.
+* **simulsweep** can be used to create a preview of the shape. [n] is the number of sections that are used to simulate the sweep.
+* **buildsweep** creates the sweep using the arguments defined by all the commands.
-**mksweep **initializes the sweep creation and defines the wire to be used as the spine.
-
-**addsweep **defines the wire to be used as the profile.
-
-**deletesweep **cancels the choice of profile wire, without leaving the mksweep mode. You can re-select a profile wire.
-
-**setsweep **commands the algorithms used for the construction of the sweep.
-
-**simulsweep **can be used to create a preview of the shape. [n] is the number of sections that are used to simulate the sweep.
-
-**buildsweep **creates the sweep using the arguments defined by all the commands.
**Example:**
-
+~~~~~
#create a sweep based on a semi-circular wire using the
Frenet algorithm
#create a circular figure
@@ -5308,16 +6029,20 @@ setsweep -CF
addsweep w -R
# to simulate the sweep with a visual approximation
simulsweep w 3
+~~~~~
+@subsubsection occt_draw_7_4_5 thrusections
-@subsubsection occt_2142243456_1869436669745 thrusections
+Syntax:
+~~~~~
+thrusections [-N] result issolid isruled wire1 wire2 [..wire..]
+~~~~~
-Syntax: thrusections [-N] result issolid isruled wire1 wire2 [..wire..]
+**thrusections** creates a shape using wires that are positioned in different planes. Each wire selected must have the same number of edges and vertices.
+A bezier curve is generated between the vertices of each wire. The option *[-N]* means that no check is made on wires for direction.
-**thrusections **creates a shape using wires that are positioned in different planes. Each wire selected must have the same number of edges and vertices.
-A bezier curve is generated between the vertices of each wire. The option [-N] means no check is made on wires for direction.
**Example:**
-
+~~~~~
#create three wires in three planes
polyline w1 0 0 0 5 0 0 5 5 0 2 3 0
polyline w2 0 1 3 4 1 3 4 4 3 1 3 3
@@ -5327,27 +6052,29 @@ thrusections th issolid isruled w1 w2 w3
==thrusections th issolid isruled w1 w2 w3
Tolerances obtenues -- 3d : 0
-- 2d : 0
+~~~~~
+@subsection occt_draw_7_5 Topological transformation
+
+Transformations are applications of matrices. When the transformation is nondeforming, such as translation or rotation, the object is not copied. The topology localcoordinate system feature is used. The copy can be enforced with the **tcopy** command.
+
+ * **tcopy** makes a copy of the structure of a shape.
+ * **ttranslate**, **trotate**, **tmove**, **reset** move a shape.
+ * **tmirror**, **tscale** always modify the shape.
+@subsubsection occt_draw_7_5_1 tcopy
-@subsection occt_2142243456_186943666975 Topological transformation
-
-Transformations are applications of matrices. When the transformation is nondeforming, such as translation or rotation, the object is not copied. The topology localcoordinate system feature is used. The copy can be enforced with the **tcopy **command.
-
- * **tcopy **makes a copy of the structure of a shape.
- * **ttranslate**, **trotate**, **tmove**, **reset **move a shape.
- * **tmirror**, **tscale **always modify the shape.
-
-
-@subsubsection occt_2142243456_1869436669751 tcopy
-
-Syntax: tcopy name toname [name toname ...]
+Syntax:
+~~~~~
+tcopy name toname [name toname ...]
+~~~~~
Copies the structure of one shape, including the geometry, into another, newer shape.
-**Example:**
+**Example:**
+~~~~~
# create an edge from a curve and copy it
beziercurve c 3 0 0 0 10 0 0 20 10 0
mkedge e1 c
@@ -5355,17 +6082,22 @@ ttranslate e1 0 5 0
tcopy e1 e2
ttranslate e2 0 5 0
# now modify the curve, only e1 and e2 will be modified
+~~~~~
-@subsubsection occt_2142243456_1869436669752 tmove, treset
+@subsubsection occt_draw_7_5_2 tmove, treset
-Syntax: tmove name [name ...] shape
+Syntax:
+~~~~~
+tmove name [name ...] shape
reset name [name ...]
+~~~~~
-**tmove **and **reset **modify the location, or the local coordinate system of a shape.
+**tmove** and **reset** modify the location, or the local coordinate system of a shape.
+
+**tmove** applies the location of a given shape to other shapes. **reset** restores one or several shapes it to its or their original coordinate system(s).
-**tmove **applies the location of a given shape to other shapes. **reset **restores one or several shapes it to its or their original coordinate system(s).
**Example:**
-
+~~~~~
# create two boxes
box b1 10 10 10
box b2 20 0 0 10 10 10
@@ -5375,18 +6107,23 @@ ttranslate b1 0 10 0
tmove b2 b1
# return to original positions
reset b1 b2
+~~~~~
+@subsubsection occt_draw_7_5_3 ttranslate, trotate
-@subsubsection occt_2142243456_1869436669753 ttranslate, trotate
-
-Syntax: ttranslate [name ...] dx dy dz
+Syntax:
+~~~~~
+ttranslate [name ...] dx dy dz
trotate [name ...] x y z dx dy dz angle
+~~~~~
-**ttranslate **translates a set of shapes by a given vector, and **trotate **rotates them by a given angle around an axis. Both commands only modify the location of the shape.
-When creating multiple shapes, the same location is used for all the shapes. (See toto.tcl example below. Note that the code of this file can also be directly executed in interactive mode.)
+**ttranslate** translates a set of shapes by a given vector, and **trotate** rotates them by a given angle around an axis. Both commands only modify the location of the shape.
+When creating multiple shapes, the same location is used for all the shapes. (See *toto.tcl* example below. Note that the code of this file can also be directly executed in interactive mode.)
Locations are very economic in the data structure because multiple occurences of an object share the topological description.
+
**Example:**
+~~~~~
# make rotated copies of a sphere in between two cylinders
# create a file source toto.tcl
# toto.tcl code:
@@ -5406,47 +6143,55 @@ ttranslate s 25 0 12.5
# call the source file for multiple copies
source toto.tcl
+~~~~~
+@subsubsection occt_draw_7_5_4 tmirror, tscale
-@subsubsection occt_2142243456_1869436669754 tmirror, tscale
-
-Syntax: tmirror name x y z dx dy dz
+Syntax:
+~~~~~
+tmirror name x y z dx dy dz
tscale name x y z scale
+~~~~~
+
+* **tmirror** makes a mirror copy of a shape about a plane x,y,z dx,dy,dz.
+
+* **Tscale** applies a central homotopic mapping to a shape.
-**tmirror **makes a mirror copy of a shape about a plane x,y,z dx,dy,dz. **Tscale **applies a central homotopic mapping to a shape.
**Example:**
-
+~~~~~
# mirror a portion of cylinder about the YZ plane
pcylinder c1 10 10 270
copy c1 c2
tmirror c2 15 0 0 1 0 0
# and scale it
tscale c1 0 0 0 0.5
+~~~~~
+@subsection occt_draw_7_6 Old Topological operations
-@subsection occt_2142243456_186943666976 Old Topological operations
+ * **fuse**, **cut**, **common** are boolean operations.
+ * **section**, **psection** compute sections.
+ * **sewing** joins two or more shapes.
+@subsubsection occt_draw_7_6_1 fuse, cut, common
- * **fuse**, **cut**, **common **are boolean operations.
- * **section**, **psection **compute sections.
- * **sewing **joins two or more shapes.
-
-
-@subsubsection occt_2142243456_1869436669761 fuse, cut, common
-
-Syntax: fuse name shape1 shape2
+Syntax:
+~~~~~
+fuse name shape1 shape2
cut name shape1 shape2
common name shape1 shape2
+~~~~~
-**fuse **creates a new shape by a boolean operation on two existing shapes. The new shape contains both originals intact.
+**fuse** creates a new shape by a boolean operation on two existing shapes. The new shape contains both originals intact.
-**cut **creates a new shape which contains all parts of the second shape but only the first shape without the intersection of the two shapes.
+**cut** creates a new shape which contains all parts of the second shape but only the first shape without the intersection of the two shapes.
+
+**common** creates a new shape which contains only what is in common between the two original shapes in their intersection.
-**common **creates a new shape which contains only what is in common between the two original shapes in their intersection.
**Example:**
-
+~~~~~
# all four boolean operations on a box and a cylinder
box b 0 -10 5 20 20 10
@@ -5463,19 +6208,23 @@ ttranslate s3 0 40 0
common s4 b c
ttranslate s4 0 -40 0
+~~~~~
+@subsubsection occt_draw_7_6_2 section, psection
-@subsubsection occt_2142243456_1869436669762 section, psection
-
-Syntax: section result shape1 shape2
+Syntax:
+~~~~~
+section result shape1 shape2
psection name shape plane
+~~~~~
-**section **creates a compound object consisting of the edges for the intersection curves on the faces of two shapes.
+**section** creates a compound object consisting of the edges for the intersection curves on the faces of two shapes.
+
+**psection** creates a planar section consisting of the edges for the intersection curves on the faces of a shape and a plane.
-**psection **creates a planar section consisting of the edges for the intersection curves on the faces of a shape and a plane.
**Example:**
-
+~~~~~
# section line between a cylinder and a box
pcylinder c 10 20
box b 0 0 5 15 15 15
@@ -5486,63 +6235,73 @@ section s b c
pcone c 10 30 30
plane p 0 0 15 1 1 2
psection s c p
+~~~~~
+@subsubsection occt_draw_7_6_3 sewing
-@subsubsection occt_2142243456_1869436669763 sewing
+Syntax:
+~~~~~
+sewing result [tolerance] shape1 shape2 ...
+~~~~~
-Syntax: sewing result [tolerance] shape1 shape2 ...
-
-**Sewing **joins shapes by connecting their adjacent or near adjacent edges. Adjacency can be redefined by modifying the tolerance value.
+**Sewing** joins shapes by connecting their adjacent or near adjacent edges. Adjacency can be redefined by modifying the tolerance value.
**Example:**
-
+~~~~~
# create two adjacent boxes
box b 0 0 0 1 2 3
box b2 0 2 0 1 2 3
sewing sr b b2
whatis sr
sr is a shape COMPOUND FORWARD Free Modified
+~~~~~
-
-@subsection occt_2142243456_186943666977 New Topological operations
+@subsection occt_draw_7_7 New Topological operations
The new algorithm of Boolean operations avoids a large number of weak points and limitations presented in the old boolean operation algorithm.
-@subsubsection occt_2142243456_1869436669771 bop, bopfuse, bopcut, boptuc, bopcommon,
+@subsubsection occt_draw_7_7_1 bop, bopfuse, bopcut, boptuc, bopcommon,
-**bop** defines **shape1** and **shape2** subject to ulterior Boolean operations
+* **bop** defines *shape1* and *shape2* subject to ulterior Boolean operations
+* **bopfuse** creates a new shape by a boolean operation on two existing shapes. The new shape contains both originals intact.
+* **bopcut** creates a new shape which contains all parts of the second shape but only the first shape without the intersection of the two shapes.
+* **boptuc** is a reverced **bopcut**.
+* **bopcommon** creates a new shape which contains only whatever is in common between the two original shapes in their intersection.
-**bopfuse **creates a new shape by a boolean operation on two existing shapes. The new shape contains both originals intact.
-
-**bopcut **creates a new shape which contains all parts of the second shape but only the first shape without the intersection of the two shapes.
-
-**boptuc **is a reverced** bopcut**.
-
-**bopcommon **creates a new shape which contains only whatever is in common between the two original shapes in their intersection.
-
-
-Syntax: bop shape1 shape2
+Syntax:
+~~~~~
+bop shape1 shape2
bopcommon result
bopfuse result
bopcut result
boptuc result
+~~~~~
These commands have short variants:
+~~~~~
bcommon result shape1 shape2
bfuse result shape1 shape2
bcut result shape1 shape2
+~~~~~
-**bop** fills data structure (DS) of boolean operation for **shape1** and **shape2**.
-**bopcommon, bopfuse, bopcut, boptuc **commands used after **bop** command. After one **bop** command it is possible to call several commands from the list above. For example: **bop** S1 S2; **bopfuse** R.
+**bop** fills data structure (DS) of boolean operation for *shape1* and *shape2*.
+**bopcommon, bopfuse, bopcut, boptuc** commands are used after **bop** command. After one **bop** command it is possible to call several commands from the list above. For example:
+
+~~~~~
+bop S1 S2
+bopfuse R
+~~~~~
+
**Example:**
-# all four boolean operations on a box and a cylinder
+Let us produce all four boolean operations on a box and a cylinder:
+~~~~~
box b 0 -10 5 20 20 10
pcylinder c 5 20
@@ -5560,10 +6319,11 @@ ttranslate s3 0 40 0
bopcommon s4
ttranslate s4 0 -40 0
+~~~~~
+Now use short variants of the commands:
-Short variants of commands:
-
+~~~~~
bfuse s11 b c
ttranslate s11 40 0 100
@@ -5572,34 +6332,34 @@ ttranslate s12 -40 0 100
bcommon s14 b c
ttranslate s14 0 -40 100
+~~~~~
-@subsubsection occt_2142243456_1869436669772 bopsection
+@subsubsection occt_draw_7_7_2 bopsection
-**bopsection **creates a compound object consisting of the edges for the intersection curves on the faces of two shapes.
-
-
-Syntax: bop shape1 shape2
+Syntax:
+~~~~~
+bop shape1 shape2
bopsection result
+~~~~~
-
-
-Short variant:
-
+* **bopsection** creates a compound object consisting of the edges for the intersection curves on the faces of two shapes.
+* **bop** fills data structure (DS) of boolean operation for *shape1* and *shape2*.
+* **bopsection** command used after **bop** command.
+
+Short variant syntax:
+~~~~~
bsection result shape1 shape2 [-2d/-2d1/-2s2] [-a]
+~~~~~
-
-**bop** fills data structure (DS) of boolean operation for **shape1** and **shape2**.
-**bopsection** command used after **bop** command.
-
-**-2d** - PCurves are computed on both parts.
-**-2d1** - PCurves are computed on first part.
-**-2d2 **- PCurves are computed on second part.
-**-a** - geometries built are approximated.
-
+* -2d - PCurves are computed on both parts.
+* -2d1 - PCurves are computed on first part.
+* -2d2 - PCurves are computed on second part.
+* -a - built geometries are approximated.
**Example:**
-# section line between a cylinder and a box
+Let us build a section line between a cylinder and a box
+~~~~~
pcylinder c 10 20
box b 0 0 5 15 15 15
trotate b 0 0 0 1 1 1 20
@@ -5607,46 +6367,43 @@ bop b c
bopsection s
# Short variant:
bsection s2 b c
+~~~~~
+@subsubsection occt_draw_7_7_3 bopcheck, bopargshape
-@subsubsection occt_2142243456_1869436669773 bopcheck, bopargshape
-
-Syntax: bopcheck shape
+Syntax:
+~~~~~
+bopcheck shape
bopargcheck shape1 [[shape2] [-F/O/C/T/S/U] [/R|F|T|V|E|I|P]] [#BF]
-
+~~~~~
**bopcheck** checks a shape for self-interference.
**bopargcheck** checks the validity of argument(s) for boolean operations.
--Boolean Operation
- **F** (fuse)
- **O** (common)
- **C** (cut)
- **T** (cut21)
- **S** (section)
- **U** (unknown)
-By default a section is made.
+* Boolean Operation - (by default a section is made) :
+ * **F** (fuse)
+ * **O** (common)
+ * **C** (cut)
+ * **T** (cut21)
+ * **S** (section)
+ * **U** (unknown)
+* Test Options - (by default all options are enabled) :
+ * **R** (disable small edges (shrank range) test)
+ * **F** (disable faces verification test)
+ * **T** (disable tangent faces searching test)
+ * **V** (disable test possibility to merge vertices)
+ * **E** (disable test possibility to merge edges)
+ * **I** (disable self-interference test)
+ * **P** (disable shape type test)
+* Additional Test Options :
+ * **B** (stop test on first faulty found) - by default it is off;
+ * **F** (full output for faulty shapes) - by default the output is made in a short format.
- /Test Options
- **R** (disable small edges (shrank range) test)
- **F** (disable faces verification test)
- **T** (disable tangent faces searching test)
- **V** (disable test possibility to merge vertices)
- **E** (disable test possibility to merge edges)
- **I** (disable self-interference test)
- **P** (disable shape type test)
-By default all options are enabled.
-
- #Additional Test Options
- **B** (stop test on first faulty found); default OFF
- **F** (full output for faulty shapes);
-**By **default the output is made in a short format.
-
- NOTE: Boolean Operation and Test Options are used only for a couple of argument shapes, except for **I** and **P** options that are always used to test a couple of shapes as well as a single shape.
+**Note** that Boolean Operation and Test Options are used only for a couple of argument shapes, except for I and P options that are always used to test a couple of shapes as well as a single shape.
**Example:**
-
+~~~~~
# checks a shape on self-interference
box b1 0 0 0 1 1 1
bopcheck b1
@@ -5654,54 +6411,63 @@ bopcheck b1
# checks the validity of argument for boolean cut operations
box b2 0 0 0 10 10 10
bopargcheck b1 b2 -C
+~~~~~
-
-@subsection occt_2142243456_186943666978 Drafting and blending
+@subsection occt_draw_7_8 Drafting and blending
Drafting is creation of a new shape by tilting faces through an angle.
Blending is the creation of a new shape by rounding edges to create a fillet.
- * Use the **depouille **command for drafting.
- * Use the **chamf **command to add a chamfer to an edge
- * Use the **blend **command for simple blending.
- * Use **fubl **for a fusion + blending operation.
- * Use **buildevol**, **mkevol**, **updatevol **to realize varying radius blending.
+ * Use the **depouille** command for drafting.
+ * Use the **chamf** command to add a chamfer to an edge
+ * Use the **blend** command for simple blending.
+ * Use **fubl** for a fusion + blending operation.
+ * Use **buildevol**, **mkevol**, **updatevol** to realize varying radius blending.
-@subsubsection occt_2142243456_1869436669781 depouille
+@subsubsection occt_draw_7_8_1 depouille
-Syntax: dep result shape dirx diry dirz face angle x y x dx dy dz [face angle...]
+Syntax:
+~~~~~
+dep result shape dirx diry dirz face angle x y x dx dy dz [face angle...]
+~~~~~
-**depouille **creates a new shape by drafting one or more faces of a shape.
+Creates a new shape by drafting one or more faces of a shape.
Identify the shape(s) to be drafted, the drafting direction, and the face(s) with an angle and an axis of rotation for each face. You can use dot syntax to identify the faces.
+
**Example:**
+~~~~~
# draft a face of a box
box b 10 10 10
explode b f
== b_1 b_2 b_3 b_4 b_5 b_6
dep a b 0 0 1 b_2 10 0 10 0 1 0 5
+~~~~~
+@subsubsection occt_draw_7_8_2 chamf
-@subsubsection occt_2142243456_1869436669782 chamf
-
-Syntax: chamf newname shape edge face S dist
+Syntax:
+~~~~~
+chamf newname shape edge face S dist
chamf newname shape edge face dist1 dist2
chamf newname shape edge face A dist angle
+~~~~~
-**chamf **creates a chamfer along the edge between faces using:
+Creates a chamfer along the edge between faces using:
* a equal distances from the edge
* the edge, a face and distance, a second distance
* the edge, a reference face and an angle
Use the dot syntax to select the faces and edges.
-**Example:**
-# to create a chamfer based on equal distances from the
-edge (45 degree angle)
+**Examples:**
+
+Let us create a chamfer based on equal distances from the edge (45 degree angle):
+~~~~~
# create a box
box b 1 2 3
chamf ch b . . S 0.5
@@ -5709,35 +6475,40 @@ chamf ch b . . S 0.5
# select an edge
==Pick an object
# select an adjacent face
-**Example:**
+~~~~~
-# to create a chamfer based on different distances from
-the selected edge
+Let us create a chamfer based on different distances from the selected edge:
+~~~~~
box b 1 2 3
chamf ch b . . 0.3 0.4
==Pick an object
# select an edge
==Pick an object
-# select an adjacent face
-**Example:**
-
-# to create a chamfer based on a distance from the edge
-and an angle
+# select an adjacent face
+~~~~~
+
+Let us create a chamfer based on a distance from the edge and an angle:
+
+~~~~~
box b 1 2 3
chamf ch b . . A 0.4 30
==Pick an object
# select an edge
==Pick an object
# select an adjacent face
+~~~~~
+@subsubsection occt_draw_7_8_3 blend
-@subsubsection occt_2142243456_1869436669783 blend
+Syntax:
+~~~~~
+blend result object rad1 ed1 rad2 ed2 ... [R/Q/P]
+~~~~~
-Syntax: blend result object rad1 ed1 rad2 ed2 ... [R/Q/P]
+Creates a new shape by filleting the edges of an existing shape. The edge must be inside the shape. You may use the dot syntax. Note that the blend is propagated to the edges of tangential planar, cylindrical or conical faces.
-**blend **creates a new shape by filleting the edges of an existing shape. The edge must be inside the shape. You may use the dot syntax. Note that the blend is propagated to the edges of tangential planar, cylindrical or conical faces.
**Example:**
-
+~~~~~
# blend a box, click on an edge
box b 20 20 20
blend b b 2 .
@@ -5756,38 +6527,44 @@ blend b b 2 .
==- FilDS 0s
==- Reconstruction 0.06s
==- SetRegul 0s
+~~~~~
+@subsubsection occt_draw_7_8_4 fubl
-@subsubsection occt_2142243456_1869436669784 fubl
+Syntax:
+~~~~~
+fubl name shape1 shape2 radius
+~~~~~
+
+Creates a boolean fusion of two shapes and then blends (fillets) the intersection edges using the given radius.
-Syntax: fubl name shape1 shape2 radius
-** **
-**fubl **creates a boolean fusion of two shapes and then blends (fillets) the intersection edges using the given radius.
**Example:**
-
+~~~~~
# fuse-blend two boxes
box b1 20 20 5
copy b1 b2
ttranslate b2 -10 10 3
fubl a b1 b2 1
-See also: **fuse**, **blend**
+~~~~~
-@subsubsection occt_2142243456_1869436669785 mkevol, updatevol, buildevol
+@subsubsection occt_draw_7_8_5 mkevol, updatevol, buildevol
-Syntax: mkevol result object (then use updatevol) [R/Q/P]
+Syntax:
+~~~~~
+mkevol result object (then use updatevol) [R/Q/P]
updatevol edge u1 radius1 [u2 radius2 ...]
buildevol
+~~~~~
These three commands work together to create fillets with evolving radii.
-**mkevol **allows you to specify the shape and the name of the result. It returns the tolerances of the fillet.
+* **mkevol** allows specifying the shape and the name of the result. It returns the tolerances of the fillet.
+* **updatevol** allows describing the filleted edges you want to create. For each edge, you give a set of coordinates: parameter and radius and the command prompts you to pick the edge of the shape which you want to modify. The parameters will be calculated along the edges and the radius function applied to the whole edge.
+* **buildevol** produces the result described previously in **mkevol** and **updatevol**.
-**updatevol **allows you to describe the filleted edges you want to create. For each edge, you give a set of coordinates: parameter and radius and the command prompts you to pick the edge of the shape which you want to modify. The parameters will be calculated along the edges and the radius function applied to the whole edge.
-
-**buildevol **produces the result described previously in **mkevol **and **updatevol**.
**Example:**
-
+~~~~~
# makes an evolved radius on a box
box b 10 10 10
mkevol b b
@@ -5815,31 +6592,35 @@ buildevol
==- FilDS 0.01s
==- Reconstruction 0.04s
==- SetRegul 0s
+~~~~~
-
-@subsection occt_2142243456_186943666979 Topological analysis
+@subsection occt_draw_7_9 Topological analysis
Analysis of shapes includes commands to compute length, area, volumes and inertial properties.
- * Use **lprops**, **sprops**, **vprops **to compute integral properties.
- * Use **bounding **to display the bounding box of a shape.
- * Use **distmini **to calculate the minimum distance between two shapes.
+ * Use **lprops**, **sprops**, **vprops** to compute integral properties.
+ * Use **bounding** to display the bounding box of a shape.
+ * Use **distmini** to calculate the minimum distance between two shapes.
+@subsubsection occt_draw_7_9_1 lprops, sprops, vprops
-
-@subsubsection occt_2142243456_1869436669791 lprops, sprops, vprops
-
-Syntax: lprops shape
+Syntax:
+~~~~~
+lprops shape
sprops shape
vprops shape
+~~~~~
-**lprops **computes the mass properties of all edges in the shape with a linear density of 1, **sprops **of all faces with a surface density of 1 and **vprops **of all solids with a density of 1.
+* **lprops** computes the mass properties of all edges in the shape with a linear density of 1;
+* **sprops** of all faces with a surface density of 1;
+* **vprops** of all solids with a density of 1.
All three commands print the mass, the coordinates of the center of gravity, the matrix of inertia and the moments. Mass is either the length, the area or the volume. The center and the main axis of inertia are displayed.
-**Example:**
+**Example:**
+~~~~~
# volume of a cylinder
pcylinder c 10 20
vprops c
@@ -5862,16 +6643,20 @@ Moments :
IX = 366519.141446336
IY = 366519.141444962
I.Z = 314159.265357595
+~~~~~
+@subsubsection occt_draw_7_9_2 bounding
-@subsubsection occt_2142243456_1869436669792 bounding
-
-Syntax: bounding shape
+Syntax:
+~~~~~
+bounding shape
+~~~~~
Displays the bounding box of a shape. The bounding box is a cuboid created with faces parallel to the x, y, and z planes. The command returns the dimension values of the the box, *xmin ymin zmin xmax ymax zmax.*
-**Example:**
+**Example:**
+~~~~~
# bounding box of a torus
ptorus t 20 5
bounding t
@@ -5879,15 +6664,19 @@ bounding t
5.0000001000000003
==27.059805107309852 27.059805107309852
5.0000001000000003
+~~~~~
+@subsubsection occt_draw_7_9_3 distmini
-@subsubsection occt_2142243456_1869436669793 distmini
+Syntax:
+~~~~~
+distmini name Shape1 Shape2
+~~~~~
-Syntax: distmini name Shape1 Shape2
+Calculates the minimum distance between two shapes. The calculation returns the number of solutions, If more than one solution exists. The options are displayed in the viewer(red) and the results are listed in the shell window. The *distmini* lines are considered as shapes which have a value v.
-**distmini **calculates the minimum distance between two shapes. The calculation returns the number of solutions, If more than one solution exists. The options are displayed in the viewer(red) and the results are listed in the shell window. The distmini lines are considered as shapes which have a value v.
**Example:**
-
+~~~~~
box b 0 0 0 10 20 30
box b2 30 30 0 10 20 30
distmini d1 b b2
@@ -5913,25 +6702,25 @@ are:
==X=30 Y=30 Z=0
==d1_val d1 d12
+~~~~~
-
-
-
-@subsection occt_2142243456_1869436669710 Surface creation
+@subsection occt_draw_7_10 Surface creation
Surface creation commands include surfaces created from boundaries and from spaces between shapes.
+ * **gplate** creates a surface from a boundary definition.
+ * **filling** creates a surface from a group of surfaces.
- * gplate creates a surface from a boundary definition.
- * filling creates a surface from a group of surfaces.
+@subsubsection occt_draw_7_10_1 gplate,
+Syntax:
+~~~~~
+gplate result nbrcurfront nbrpntconst [SurfInit] [edge 0] [edge tang (1:G1;2:G2) surf]...[point] [u v tang (1:G1;2:G2) surf] ...
+~~~~~
-@subsubsection occt_2142243456_18694366697101 gplate,
+Creates a surface from a defined boundary. The boundary can be defined using edges, points, or other surfaces.
-Syntax: gplate result nbrcurfront nbrpntconst [SurfInit] [edge 0] [edge tang (1:G1;2:G2) surf]...[point] [u v tang (1:G1;2:G2) surf] ...
-
-**gplate **creates a surface from a defined boundary. The boundary can be defined using edges, points, or other surfaces.
**Example:**
-
+~~~~~
plane p
trim p p -1 3 -1 3
mkface p p
@@ -5985,13 +6774,17 @@ Loop number: 1
Approximation results
Approximation error : 0.000422195884750181
Criterium error : 3.43709808053967e-05
+~~~~~
-@subsubsection occt_2142243456_18694366697102 filling, fillingparam
+@subsubsection occt_draw_7_10_2 filling, fillingparam
-Syntax: filling result nbB nbC nbP [SurfInit] [edge][face]order...
+Syntax:
+~~~~~
+filling result nbB nbC nbP [SurfInit] [edge][face]order...
edge[face]order... point/u v face order...
+~~~~~
-**filling **creates a surface between borders. It uses the **gplate **algorithm but creates a surface that is tangential to the adjacent surfaces. The result is a smooth continuous surface based on the G1 criterion.
+Creates a surface between borders. This command uses the **gplate** algorithm but creates a surface that is tangential to the adjacent surfaces. The result is a smooth continuous surface based on the G1 criterion.
To define the surface border:
@@ -6000,21 +6793,18 @@ To define the surface border:
The surface can pass through other points. These are defined after the border definition.
-You can use the **fillingparam **command to access the filling parameters.
+You can use the *fillingparam* command to access the filling parameters.
The options are:
--l : to list current values
+ * -l : to list current values
+ * -i : to set default values
+ * -rdeg nbPonC nbIt anis : to set filling options
+ * -c t2d t3d tang tcur : to set tolerances
+ * -a maxdeg maxseg : Approximation option
--i : to set default values
-
--r deg nbPonC nbIt anis : to set filling options
-
--c t2d t3d tang tcur : to set tolerances
-
--a maxdeg maxseg : Approximation option
**Example:**
-
+~~~~~
# to create four curved survaces and a point
plane p
trim p p -1 3 -1 3
@@ -6057,90 +6847,72 @@ TolCurv = 0.1
MaxDeg = 8
MaxSegments = 9
+~~~~~
-
-
-@subsection occt_2142243456_1869436669711 Complex Topology
+@subsection occt_draw_7_11 Complex Topology
Complex topology is the group of commands that modify the topology of shapes. This includes feature modeling.
-@subsubsection occt_2142243456_18694366697111 offsetshape, offsetcompshape
+@subsubsection occt_draw_7_11_1 offsetshape, offsetcompshape
-Syntax: offsetshape r shape offset [tol] [face ...]
+Syntax:
+~~~~~
+offsetshape r shape offset [tol] [face ...]
offsetcompshape r shape offset [face ...]
+~~~~~
-**offsetshape **and **offsetcompshape **assigns a thickness to the edges of a shape. The **offset **value can be negative or positive. This value defines the thickness and direction of the resulting shape. Each face can be removed to create a hollow object.
+**offsetshape** and **offsetcompshape** assign a thickness to the edges of a shape. The *offset* value can be negative or positive. This value defines the thickness and direction of the resulting shape. Each face can be removed to create a hollow object.
-The resulting shape is based on a calculation of intersections. In case of simple shapes such as a box, only the adjacent intersections are required and you can use the **offsetshape **command.
-
-In case of complex shapes, where intersections can occur from non-adjacent edges and faces, use the **offsetcompshape **command. **comp **indicates complete and requires more time to calculate the result.
+The resulting shape is based on a calculation of intersections. In case of simple shapes such as a box, only the adjacent intersections are required and you can use the **offsetshape** command.
+In case of complex shapes, where intersections can occur from non-adjacent edges and faces, use the **offsetcompshape** command. **comp** indicates complete and requires more time to calculate the result.
The opening between the object interior and exterior is defined by the argument face or faces.
-**Example:**
+**Example:**
+~~~~~
box b1 10 20 30
explode b1 f
== b1_1 b1_2 b1_3 b1_4 b1_5 b1_6
offsetcompshape r b1 -1 b1_3
+~~~~~
-Syntax: offsetparameter tolerance intersection(c/p) join(a/i)
-offsetload shape offset [face1 face2 …]
-offsetonface face1 offset1 face2 offset2 …
-offsetperform result
+@subsubsection occt_draw_7_11_2 featprism, featdprism, featrevol, featlf, featrf
-**offsetparameter** sets the values of parameters and options for the following command **offsetload**:
- * *tolerance* defines the coincidence tolerance criterion for generated shapes;
- * *intersection* defines the mode of intersection: *c* means complete intersection, *p* means partial intersection;
- * *join* defines the mode of connecting new adjacent faces: *a* means GeomAbs_Arc, *i* means GeomAbs_Intersection.
-
-**offsetload** loads shape, offset value and, if necessary, a set of faces to remove from the shape. These data are later used by command **offsetperform**.
-**offsetonface** indicates the faces of shape (loaded earlier by command **offsetload**) that should be shifted with special offset value. This command is optional. **Warning:** this command should be called only after **offsetload** and it takes effect only if parameter join = GeomAbs_Intersection.
-
-**offsetperform** performs the result of 3d-offset algorithm using the data loaded by previous commands.
-**Example:**
-
-box b1 10 20 30
-explode b1 f
-== b1_1 b1_2 b1_3 b1_4 b1_5 b1_6
-offsetparameter 1e-7 p i
-offsetload b1 2 b1_1 b1_2
-offsetonface b1_3 5
-offsetperform result
-
-
-
-@subsubsection occt_2142243456_18694366697112 featprism, featdprism, featrevol, featlf, featrf
-
-Syntax: featprism shape element skface Dirx Diry Dirz Fuse(0/1/2) Modify(0/1)
+Syntax:
+~~~~~
+featprism shape element skface Dirx Diry Dirz Fuse(0/1/2) Modify(0/1)
featdprism shape face skface angle Fuse(0/1/2) Modify(0/1)
featrevol shape element skface Ox Oy Oz Dx Dy Dz Fuse(0/1/2) Modify(0/1)
featlf shape wire plane DirX DirY DirZ DirX DirY DirZ Fuse(0/1/2) Modify(0/1)
featrf shape wire plane X Y Z DirX DirY DirZ Size Size Fuse(0/1/2) Modify(0/1)
featperform prism/revol/pipe/dprism/lf result [[Ffrom] Funtil]
featperformval prism/revol/dprism/lf result value
+~~~~~
-**featprism **loads the arguments for a prism with contiguous sides normal to the face.
+**featprism** loads the arguments for a prism with contiguous sides normal to the face.
-**featdprism **loads the arguments for a prism which is created in a direction normal to the face and includes a draft angle.
+**featdprism** loads the arguments for a prism which is created in a direction normal to the face and includes a draft angle.
-**featrevol **loads the arguments for a prism with a circular evolution.
+**featrevol** loads the arguments for a prism with a circular evolution.
-**featlf **loads the arguments for a linear rib or slot. This feature uses planar faces and a wire as a guideline.
+**featlf** loads the arguments for a linear rib or slot. This feature uses planar faces and a wire as a guideline.
-**featrf **loads the arguments for a rib or slot with a curved surface. This feature uses a circular face and a wire as a guideline.
+**featrf** loads the arguments for a rib or slot with a curved surface. This feature uses a circular face and a wire as a guideline.
-**featperform **loads the arguments to create the feature.
+**featperform** loads the arguments to create the feature.
-**featperformval **uses the defined arguments to create a feature with a limiting value.
+**featperformval** uses the defined arguments to create a feature with a limiting value.
All the features are created from a set of arguments which are defined when you initialize the feature context. Negative values can be used to create depressions.
-**Example:**
-# to create a feature prism with a draft angle and a
-normal direction
+**Examples:**
+
+Let us create a feature prism with a draft angle and a normal direction :
+
+~~~~~
# create a box with a wire contour on the upper face
box b 1 1 1
profil f O 0 0 1 F 0.25 0.25 x 0.5 y 0.5 x -0.5
@@ -6151,11 +6923,14 @@ featdprism b f b_6 5 1 0
featperformval dprism r 1
==BRepFeat_MakeDPrism::Perform(Height)
BRepFeat_Form::GlobalPerform ()
-Gluer
-still Gluer
-Gluer result
+ Gluer
+ still Gluer
+ Gluer result
+~~~~~
-# to create a feature prism with circular direction
+Let us create a feature prism with circular direction :
+
+~~~~~
# create a box with a wire contour on the upper face
box b 1 1 1
profil f O 0 0 1 F 0.25 0.25 x 0.5 y 0.5 x -0.5
@@ -6165,11 +6940,15 @@ featrevol b f b_6 1 0 1 0 1 0 1 0
featperformval revol r 45
==BRepFeat_MakeRevol::Perform(Angle)
BRepFeat_Form::GlobalPerform ()
-Gluer
-still Gluer
-Gluer result
+ Gluer
+ still Gluer
+ Gluer result
+~~~~~
-# to create a slot using the linear feature
+
+Let us create a slot using the linear feature :
+
+~~~~~
#create the base model using the multi viewer
mu4
profile p x 5 y 1 x -3 y -0.5 x -1.5 y 0.5 x 0.5 y 4 x -1 y -5
@@ -6190,8 +6969,11 @@ plane pl 0.2 0.2 0.3 0 0 1
# loads the linear feature arguments
featlf pr w pl 0 0 0.3 0 0 0 0 1
featperform lf result
+~~~~~
-# to create a rib using the revolution feature
+Let us create a rib using the revolution feature :
+
+~~~~~
#create the base model using the multi viewer
mu4
pcylinder c1 3 5
@@ -6204,33 +6986,29 @@ plane pl -3 0 1.5 0 1 0
# loads the revolution feature arguments
featrf c1 w pl 0 0 0 0 0 1 0.3 0.3 1 1
featperform rf result
+~~~~~
+@subsubsection occt_draw_7_11_3 draft
-@subsubsection occt_2142243456_18694366697113 draft
+Syntax:
+~~~~~
+draft result shape dirx diry dirz angle shape/surf/length [-IN/-OUT] [Ri/Ro] [-Internal]
+~~~~~
-Syntax: draft result shape dirx diry dirz angle shape/surf/length [-IN/-OUT] [Ri/Ro] [-Internal]
-
-**draft **computes a draft angle surface from a wire. The surface is determined by the draft direction, the inclination of the draft surface, a draft angle, and a limiting distance.
+Computes a draft angle surface from a wire. The surface is determined by the draft direction, the inclination of the draft surface, a draft angle, and a limiting distance.
* The draft angle is measured in radians.
* The draft direction is determined by the argument -INTERNAL
- * The argument Ri/Ro deftermines wether the corner edges of the
-
-draft surface are angular or rounded.
-
+ * The argument Ri/Ro deftermines wether the corner edges of the draft surfaces are angular or rounded.
* Arguments that can be used to define the surface distance are:
- * length, a defined distance
- * shape, until the surface contacts a shape
- * surface, until the surface contacts a surface.
+ * length, a defined distance
+ * shape, until the surface contacts a shape
+ * surface, until the surface contacts a surface.
-
NOTE
-*The original aim of adding a draft angle to a shape is to*
-*produce a shape which can be removed easily from a mould.*
-*The Examples below use larger angles than are used normally*
-*and the calculation results returned are not indicated.*
+**Note** that the original aim of adding a draft angle to a shape is to produce a shape which can be removed easily from a mould. The Examples below use larger angles than are used normally and the calculation results returned are not indicated.
**Example:**
-
+~~~~~
# to create a simple profile
profile p F 0 0 x 2 y 4 tt 0 4 w
# creates a draft with rounded angles
@@ -6239,132 +7017,188 @@ draft res p 0 0 1 3 1 -Ro
profile p F 0 0 x 2 y 4 tt 1 1.5 tt 0 4 w
# creates a draft with rounded external angles
draft res p 0 0 1 3 1 -Ro
+~~~~~
+@subsubsection occt_draw_7_11_4 deform
-@subsubsection occt_2142243456_18694366697114 deform, nurbsconvert
+Syntax:
+~~~~~
+deform newname name CoeffX CoeffY CoeffZ
+~~~~~
-Syntax: deform newname name CoeffX CoeffY CoeffZ
-
-**deform **modifies the shape using the x, y, and z coefficients. You can reduce or magnify the shape in the x,y, and z directions.
-
-Syntax nurbsconvert result name [result name]
-
-**nurbsconvert **changes the NURBS curve definition of a shape to a Bspline curve definition. This conversion is required for assymetric deformation and prepares the arguments for other commands such as **deform. **The conversion can be necessary when transferring shape data to other applications.
+Modifies the shape using the x, y, and z coefficients. You can reduce or magnify the shape in the x,y, and z directions.
+
**Example:**
-
+~~~~~
pcylinder c 20 20
deform a c 1 3 5
# the conversion to bspline is followed by the
deformation
+~~~~~
+@subsubsection occt_draw_7_11_5 nurbsconvert
-@subsection occt_2142243456_1869436669712 Texture Mapping to a Shape
+Syntax:
+
+~~~~~
+nurbsconvert result name [result name]
+~~~~~
+
+Changes the NURBS curve definition of a shape to a Bspline curve definition. This conversion is required for assymetric deformation and prepares the arguments for other commands such as **deform**. The conversion can be necessary when transferring shape data to other applications.
+
+
+@subsection occt_draw_7_12 Texture Mapping to a Shape
Texture mapping allows you to map textures on a shape. Textures are texture image files and several are predefined. You can control the number of occurrences of the texture on a face, the position of a texture and the scale factor of the texture.
-@subsubsection occt_2142243456_18694366697121 vtexture
+@subsubsection occt_draw_7_12_1 vtexture
-Syntax vtexture NameOfShape TextureFile
+Syntax:
+~~~~~
+vtexture NameOfShape TextureFile
vtexture NameOfShape
vtexture NameOfShape ?
vtexture NameOfShape IdOfTexture
+~~~~~
-**TextureFile **identifies the file containing the texture you want. The same syntax without **TextureFile **disables texture mapping. The question-mark ***?* **lists available textures. **IdOfTexture **allows you to apply predefined textures.
+**TextureFile** identifies the file containing the texture you want. The same syntax without **TextureFile** disables texture mapping. The question-mark ? lists available textures. **IdOfTexture** allows applying predefined textures.
-@subsubsection occt_2142243456_18694366697122 vtexscale
+@subsubsection occt_draw_7_12_2 vtexscale
-Syntax: vtexscale NameOfShape ScaleU ScaleV
+Syntax:
+~~~~~
+vtexscale NameOfShape ScaleU ScaleV
vtexscale NameOfShape ScaleUV
vtexscale NameOfShape
+~~~~~
-**ScaleU **and **Scale V **allow you to scale the texture according to the U and V parameters individually, while **ScaleUV **applies the same scale to both parameters. The same syntax without **ScaleU**, **ScaleV **or **ScaleUV **disables texture scaling.
+*ScaleU* and *Scale V* allow scaling the texture according to the U and V parameters individually, while *ScaleUV* applies the same scale to both parameters.
-@subsubsection occt_2142243456_18694366697123 vtexorigin
+The syntax without *ScaleU*, *ScaleV* or *ScaleUV* disables texture scaling.
-Syntax vtexorigin NameOfShape UOrigin VOrigin
+@subsubsection occt_draw_7_12_3 vtexorigin
+
+Syntax:
+~~~~~
+vtexorigin NameOfShape UOrigin VOrigin
vtexorigin NameOfShape UVOrigin
vtexorigin NameOfShape
+~~~~~
-**UOrigin **and **VOrigin **allow you to place the texture according to the U and V parameters individually while **UVOrigin **applies the same position value to both parameters. The same syntax without **UOrigin**, **VOrigin **or **UVOrigin **disables origin positioning.
+*UOrigin* and *VOrigin* allow placing the texture according to the U and V parameters individually, while *UVOrigin* applies the same position value to both parameters.
-@subsubsection occt_2142243456_18694366697124 vtexrepeat
+The syntax without *UOrigin*, *VOrigin* or *UVOrigin* disables origin positioning.
-Syntax vtexrepeat NameOfShape URepeat VRepeat
+@subsubsection occt_draw_7_12_4 vtexrepeat
+
+Syntax:
+~~~~~
+vtexrepeat NameOfShape URepeat VRepeat
vtexrepeat NameOfShape UVRepeat
vtexrepeat NameOfShape
+~~~~~
-**URepeat **and **VRepeat **allow you to repeat the texture along the U and V parameters individually while **UVRepeat **applies the same number of repetitions for both parameters. The same syntax without **URepeat**, **VRepeat **or **UVRepeat **disables texture repetition.
+*URepeat* and *VRepeat* allow repeating the texture along the U and V parameters individually, while *UVRepeat* applies the same number of repetitions for both parameters.
-@subsubsection occt_2142243456_18694366697125 vtexdefault
+The same syntax without *URepeat*, *VRepeat* or *UVRepeat* disables texture repetition.
-Syntax vtexdefault NameOfShape
+@subsubsection occt_draw_7_12_5 vtexdefault
-**Vtexdefault **sets or resets the texture mapping default parameters.
+Syntax:
+~~~~~
+vtexdefault NameOfShape
+~~~~~
+
+*Vtexdefault* sets or resets the texture mapping default parameters.
The defaults are:
-URepeat = VRepeat = 1 = no repetition
-UOrigin = VOrigin = 1 = origin set at (0,0)
-UScale = VScale = 1 = texture covers 100% of the face
-@section occt_2142243456_1866931135 Data Exchange commands
+ * *URepeat = VRepeat = 1* no repetition
+ * *UOrigin = VOrigin = 1* origin set at (0,0)
+ * *UScale = VScale = 1* texture covers 100% of the face
-
-@subsection occt_2142243456_186693113581 General
+@section occt_draw_8 Data Exchange commands
This paragraph presents some general information about Data Exchange (DE) operations.
DE commands are intended for translation files of various formats (IGES,STEP) into OCCT shapes with their attributes (colors, layers etc.)
-This files include a number of entities. Each entity has its own number in the file which we call label and denote as # for a STEP file and D for an IGES file. Each file has entities called roots (one or more). A full description of such entities is contained in the Users’s Guide for a corresponding format.
+This files include a number of entities. Each entity has its own number in the file which we call label and denote as # for a STEP file and D for an IGES file. Each file has entities called roots (one or more). A full description of such entities is contained in the Users' Guides
+* for STEP format and
+* for IGES format.
-Each Draw session has an interface model – some structure for keeping various information.
-First step of translation – loading information from a file into a model.
-Second step – creation of an OpenCASCADE shape from this model.
-Each entity from file has its own number in the model (num).
-During the translation a map of correspondences between labels(from file) and numbers (from model) is created.
-The model and the mentioned map are used for working with most of DE commands.
+Each Draw session has an interface model, which is a structure for keeping various information.
-@subsection occt_2142243456_186693113582 IGES commands
+The first step of translation is loading information from a file into a model.
+The second step is creation of an OpenCASCADE shape from this model.
-These commands are used during the translation of IGES models.
+Each entity from a file has its own number in the model (num). During the translation a map of correspondences between labels(from file) and numbers (from model) is created.
+
+The model and the map are used for working with most of DE commands.
+
+@subsection occt_draw_8_1 IGES commands
+
+@subsubsection occt_draw_8_1_1 igesread
+
+Syntax:
+~~~~~
+igesread []
+~~~~~
+
+Reads an IGES file to an OCCT shape. This command will interactively ask the user to select a set of entities to be converted.
-@subsubsection occt_2142243456_1866931135821 igesread
-
-Syntax: igesread file_name result_shape_name [selection]
-
-Read an IGES file to an OCCT shape.
-This command will interactively ask the user to select a set of entities to be converted:
+| N | Mode | Description |
+| :-- | :-- | :---------- |
+| 0 | End | finish conversion and exit igesbrep |
+| 1 | Visible roots | convert only visible roots |
+| 2 | All roots | convert all roots |
+| 3 | One entity | convert entity with number provided by the user |
+| 4 | Selection | convert only entities contained in selection |
After the selected set of entities is loaded the user will be asked how loaded entities should be converted into OCCT shapes (e.g., one shape per root or one shape for all the entities). It is also possible to save loaded shapes in files, and to cancel loading.
-The second parameter of this command defines the name of the loaded shape. If several shapes are created, they will get indexed names. For instance, if the last parameter was ‘s’, they will be s_1, ... s_N.
-selection specifies the scope of selected entities in the model, it is xst-transferrable-roots by default. More about selection see in the *IGES FORMAT User’s Guide*.
-If we use symbol * as selection all roots will be translated.
-**Example:**
+The second parameter of this command defines the name of the loaded shape. If several shapes are created, they will get indexed names. For instance, if the last parameter was *s*, they will be *s_1, ... s_N*.
+
+ specifies the scope of selected entities in the model, by default it is *xst-transferrable-roots*. If we use symbol * as all roots will be translated.
+
+See also the detailed description of Selecting IGES entities.
+
+**Example:**
+~~~~~
# translation all roots from file
igesread /disk01/files/model.igs a *
+~~~~~
-@subsubsection occt_2142243456_1866931135822 tplosttrim
+@subsubsection occt_draw_8_1_2 tplosttrim
-Syntax: tplosttrim [IGES_type]
+Syntax:
+~~~~~
+tplosttrim []
+~~~~~
Sometimes the trimming contours of IGES faces (i.e., entity 141 for 143, 142 for 144) can be lost during translation due to fails. This command gives us a number of lost trims and the number of corresponding IGES entities.
It outputs the rank and numbers of faces that lost their trims and their numbers for each type (143, 144, 510) and their total number. If a face lost several of its trims it is output only once.
-Optional parameter IGES_type can be TrimmedSurface, BoundedSurface or Face to specify the only type of IGES faces.
+Optional parameter can be *0TrimmedSurface, BoundedSurface* or *Face* to specify the only type of IGES faces.
+
**Example:**
-
+~~~~~
tplosttrim TrimmedSurface
+~~~~~
-@subsubsection occt_2142243456_1866931135823 brepiges
+@subsubsection occt_draw_8_1_3 brepiges
-Syntax: brepiges shape_name filename.igs
+Syntax:
+~~~~~
+brepiges
+~~~~~
Writes an OCCT shape to an IGES file.
+
**Example:**
-
+~~~~~
# write shape with name aa to IGES file
brepiges aa /disk1/tmp/aaa.igs
== unit (write) : MM
@@ -6374,799 +7208,1190 @@ brepiges aa /disk1/tmp/aaa.igs
== Now, to write a file, command : writeall filename
== Output on file : /disk1/tmp/aaa.igs
== Write OK
+~~~~~
-
-
-@subsection occt_2142243456_186693113583 STEP commands
+@subsection occt_draw_8_2 STEP commands
These commands are used during the translation of STEP models.
-@subsubsection occt_2142243456_1866931135831 stepread
+@subsubsection occt_draw_8_2_1 stepread
-Syntax: stepread file_name result_shape_name [selection]
+Syntax:
+~~~~~
+stepread file_name result_shape_name [selection]
+~~~~~
Read a STEP file to an OCCT shape.
This command will interactively ask the user to select a set of entities to be converted:
+| N | Mode | Description |
+| :---- | :---- | :---- |
+| 0 | End | Finish transfer and exit stepread |
+| 1 | root with rank 1 | Transfer first root |
+| 2 | root by its rank | Transfer root specified by its rank |
+| 3 | One entity | Transfer entity with a number provided by the user |
+| 4 | Selection | Transfer only entities contained in selection |
After the selected set of entities is loaded the user will be asked how loaded entities should be converted into OCCT shapes.
-The second parameter of this command defines the name of the loaded shape. If several shapes are created, they will get indexed names. For instance, if the last parameter was ‘s’, they will be s_1, ... s_N.
-selection specifies the scope of selected entities in the model. More about selection see in the *STEP FORMAT User’s Guide*.
-If as selection we use symbol * all roots will be translated.
-**Example:**
+The second parameter of this command defines the name of the loaded shape. If several shapes are created, they will get indexed names. For instance, if the last parameter was *s*, they will be *s_1, ... s_N*.
+ specifies the scope of selected entities in the model. If we use symbol * as all roots will be translated.
+See also the detailed description of Selecting STEP entities.
+
+**Example:**
+~~~~~
# translation all roots from file
stepread /disk01/files/model.stp a *
+~~~~~
-@subsubsection occt_2142243456_1866931135832 stepwrite
+@subsubsection occt_draw_8_2_2 stepwrite
-Syntax: stepwrite mode shape_name file_name
+Syntax:
+~~~~~
+stepwrite mode shape_name file_name
+~~~~~
Writes an OCCT shape to a STEP file.
-The available modes are the following:
- 0 or ‘a’ - ;as is; mode – mode is selected automatically depending on type & geometry of the shape
- 1 or ‘m’ - manifold_solid_brep or brep_with_voids
- 2 or ‘f’ - faceted_brep
- 3 or ‘w’ - geometric_curve_set
- 4 or ‘s’ - shell_based_surface_model
-For further information see ;STEP FORMAT User’s Guide ;.
+
+The following modes are available :
+ * *a* - as is – mode is selected automatically depending on the type & geometry of the shape;
+ * *m* - *manifold_solid_brep* or *brep_with_voids*
+ * *f* - *faceted_brep*
+ * *w* - *geometric_curve_set*
+ * *s* - *shell_based_surface_model*
+
+For further information see Writing a STEP file.
+
**Example:**
-# write shape with name a to STEP file with mode 0
+Let us write shape *a* to a STEP file in mode *0*.
+
+~~~~~
stepwrite 0 a /disk1/tmp/aaa.igs
+~~~~~
+@subsection occt_draw_8_3 General commands
-@subsection occt_2142243456_186693113584 General commands
+These are auxilary commands used for the analysis of result of translation of IGES and STEP files.
-These commands are auxilary commands. Most of them are used for the analysis of result of translation of IGES and STEP files.
+@subsubsection occt_draw_8_3_1 count
-@subsubsection occt_2142243456_1866931135841 count
+Syntax:
+~~~~~
+count []
+~~~~~
-Syntax: count counter [selection]
+Calculates statistics on the entities in the model and outputs a count of entities.
-Is used to calculate statistics on the entities in the model.
-Gives us a count of entities.
-The optional selection argument, if specified, defines a subset of entities, which are to be taken into account. The first argument should be one of the currently defined counters (for example):
+The optional selection argument, if specified, defines a subset of entities, which are to be taken into account. The first argument should be one of the currently defined counters.
+
+| Counter | Operation |
+| :-------- | :-------- |
+| xst-types | Calculates how many entities of each OCCT type exist |
+| step214-types | Calculates how many entities of each STEP type exist |
**Example:**
-
+~~~~~
count xst-types
+~~~~~
-@subsubsection occt_2142243456_1866931135842 data
+@subsubsection occt_draw_8_3_2 data
-Syntax: data symbol
+Syntax:
+~~~~~
+data
+~~~~~
+
+Obtains general statistics on the loaded data.
+The information printed by this command depends on the symbol specified.
-Is used to obtain general statistics on the loaded data.
-Information printed by this command depends on the symbol specified:
**Example:**
-
+~~~~~
# print full information about warnings and fails
data c
+~~~~~
-@subsubsection occt_2142243456_1866931135843 elabel
+| Symbol | Output |
+| :------ | :------ |
+| g | Prints the information contained in the header of the file |
+| c or f | Prints messages generated during the loading of the STEP file (when the procedure of the integrity of the loaded data check is performed) and the resulting statistics (f works only with fail messages while c with both fail and warning messages) |
+| t | The same as c or f, with a list of failed or warned entities |
+| m or l | The same as t but also prints a status for each entity |
+| e | Lists all entities of the model with their numbers, types, validity status etc. |
+| R | The same as e but lists only root entities |
-Syntax: elabel num
+
+
+@subsubsection occt_draw_8_3_3 elabel
+
+Syntax:
+~~~~~
+elabel
+~~~~~
Entities in the IGES and STEP files are numbered in the succeeding order. An entity can be identified either by its number or by its label. Label is the letter ‘#'(for STEP, for IGES use ‘D’) followed by the rank. This command gives us a label for an entity with a known number.
+
**Example:**
-
+~~~~~
elabel 84
+~~~~~
-@subsubsection occt_2142243456_1866931135844 entity
+@subsubsection occt_draw_8_3_4 entity
-Syntax: entity #(D)_or_num level_of_information
+Syntax:
+~~~~~
+entity <#(D)>_or_
+~~~~~
The content of an IGES or STEP entity can be obtained by using this command.
Entity can be determined by its number or label.
-level_of_information has range [0-6]. You can get more information about this level using this command without parameters.
-**Example:**
+ has range [0-6]. You can get more information about this level using this command without parameters.
+**Example:**
+~~~~~
# full information for STEP entity with label 84
entity #84 6
+~~~~~
-@subsubsection occt_2142243456_1866931135845 enum
+@subsubsection occt_draw_8_3_5 enum
-Syntax: enum #(D)
+Syntax:
+~~~~~
+enum <#(D)>
+~~~~~
Prints a number for the entity with a given label.
-**Example:**
+**Example:**
+~~~~~
# give a number for IGES entity with label 21
enum D21
+~~~~~
-@subsubsection occt_2142243456_1866931135846 estatus
+@subsubsection occt_draw_8_3_6 estatus
-Syntax: estatus #(D)_or_num
+Syntax:
+~~~~~
+estatus <#(D)>_or_
+~~~~~
The list of entities referenced by a given entity and the list of entities referencing to it can be obtained by this command.
-**Example:**
+**Example:**
+~~~~~
estatus #315
+~~~~~
-@subsubsection occt_2142243456_1866931135847 fromshape
+@subsubsection occt_draw_8_3_7 fromshape
-Syntax: fromshape shape_name
+Syntax:
+~~~~~
+fromshape
+~~~~~
+
+Gives the number of an IGES or STEP entity corresponding to an OCCT shape. If no corresponding entity can be found and if OCCT shape is a compound the command explodes it to subshapes and try to find corresponding entities for them.
-Gives us the number of an IGES or STEP entity corresponding to an OCCT shape. If no corresponding entity can be found and if OCCT shape is a compound the command explodes it to subshapes and try to find corresponding entities for them.
**Example:**
-
+~~~~~
fromshape a_1_23
+~~~~~
-@subsubsection occt_2142243456_1866931135848 givecount
+@subsubsection occt_draw_8_3_8 givecount
-Syntax: givecount selection_name [selection_name]
+Syntax:
+~~~~~
+givecount []
+~~~~~
+
+
+Prints a number of loaded entities defined by the selection argument.
+Possible values of you can find in the “IGES FORMAT Users’s Guide”.
**Example:**
-
+~~~~~
givecount xst-model-roots
+~~~~~
-@subsubsection occt_2142243456_1866931135849 givelist
+@subsubsection occt_draw_8_3_9 givelist
-Syntax: givelist selection_name
+Syntax:
+~~~~~
+givelist
+~~~~~
Prints a list of a subset of loaded entities defined by the selection argument:
+| Selection | Description |
+| :------- | :----------- |
+| xst-model-all | all entities of the model |
+| xst-model-roots | all roots |
+| xst-pointed | (Interactively) pointed entities (not used in DRAW) |
+| xst-transferrable-all | all transferable (recognized) entities |
+| xst-transferrable-roots | Transferable roots |
+
**Example:**
-
+~~~~~
# give a list of all entities of the model
givelist xst-model-all
+~~~~~
-@subsubsection occt_2142243456_18669311358410 listcount
+@subsubsection occt_draw_8_3_10 listcount
-Syntax: listcount counter [selection ...]
+Syntax: listcount [ ...]
Prints a list of entities per each type matching the criteria defined by arguments.
-Optional selection argument, if specified, defines a subset of entities, which are to be taken into account. Argument counter should be one of the currently defined counters:
+Optional argument, if specified, defines a subset of entities, which are to be taken into account. Argument should be one of the currently defined counters:
+
+| Counter | Operation |
+| :----- | :------ |
+| xst-types | Calculates how many entities of each OCCT type exist |
+| iges-types | Calculates how many entities of each IGES type and form exist |
+| iges-levels | Calculates how many entities lie in different IGES levels |
**Example:**
-
+~~~~~
listcount xst-types
+~~~~~
-@subsubsection occt_2142243456_18669311358411 listitems
+@subsubsection occt_draw_8_3_11 listitems
-Syntax: listitems
+Syntax:
+~~~~~
+listitems
+~~~~~
This command prints a list of objects (counters, selections etc.) defined in the current session.
-**Example:**
-listitems
-@subsubsection occt_2142243456_18669311358412 listtypes
+@subsubsection occt_draw_8_3_12 listtypes
-Syntax: listtypes [selection_name ...]
+Syntax:
+~~~~~
+listtypes [ ...]
+~~~~~
Gives a list of entity types which were encountered in the last loaded file (with a number of entities of each type). The list can be shown not for all entities but for a subset of them. This subset is defined by an optional selection argument.
-**Example:**
-# full list of all entities with thier counts
-listtypes
-@subsubsection occt_2142243456_18669311358413 newmodel
+@subsubsection occt_draw_8_3_13 newmodel
-Syntax: newmodel
+Syntax:
+~~~~~
+newmodel
+~~~~~
Clears the current model.
-**Example:**
-newmodel
-@subsubsection occt_2142243456_18669311358414 param
+@subsubsection occt_draw_8_3_14 param
-Syntax: param [parameter] [value]
+Syntax:
+~~~~~
+param [] []
+~~~~~
This command is used to manage translation parameters.
-Command without arguments gives us a full list of parameters with current values.
-Command with parameter (without value) gives us the current value of this parameter and all possible values for it. Command with value sets this new value to parameter.
-For more information about translation parameters see the corresponding User’s Guide.
+Command without arguments gives a full list of parameters with current values.
+Command with (without ) gives us the current value of this parameter and all possible values for it. Command with sets this new value to .
+
**Example:**
-# info about possible schemes for writing STEP file
+Let us get the information about possible schemes for writing STEP file :
+
+~~~~~
param write.step.schema
+~~~~~
-@subsubsection occt_2142243456_18669311358415 sumcount
+@subsubsection occt_draw_8_3_15 sumcount
-Syntax: sumcount counter [selection ...]
+Syntax:
+~~~~~
+sumcount [ ...]
+~~~~~
Prints only a number of entities per each type matching the criteria defined by arguments.
+
**Example:**
-
+~~~~~
sumcount xst-types
+~~~~~
-@subsubsection occt_2142243456_18669311358416 tpclear
+@subsubsection occt_draw_8_3_16 tpclear
-Syntax: tpclear
+Syntax:
+~~~~~
+tpclear
+~~~~~
Clears the map of correspondences between IGES or STEP entities and OCCT shapes.
-**Example:**
-tpclear
-@subsubsection occt_2142243456_18669311358417 tpdraw
-Syntax: tpdraw #(D)_or_num
+@subsubsection occt_draw_8_3_17 tpdraw
+
+Syntax:
+~~~~~
+tpdraw <#(D)>_or_
+~~~~~
**Example:**
-
+~~~~~
tpdraw 57
+~~~~~
-@subsubsection occt_2142243456_18669311358418 tpent
+@subsubsection occt_draw_8_3_18 tpent
-Syntax: tpent #(D)_or_num
+Syntax:
+~~~~~
+tpent <#(D)>_or_
+~~~~~
+
+Get information about the result of translation of the given IGES or STEP entity.
**Example:**
+~~~~~
+tpent \#23
+~~~~~
-tpent #23
+@subsubsection occt_draw_8_3_19 tpstat
-@subsubsection occt_2142243456_18669311358419 tpstat
-
-Syntax: tpstat [*|?]symbol [selection]
-
-Gives all statistics on the last transfer, including the list of transferred entities with mapping from IGES or STEP to OCCT types, as well as fail and warning messages. The parameter *symbol *defines what information will be printed:
+Syntax:
+~~~~~
+tpstat [*|?] []
+~~~~~
-The sign ‘*’ before the parameters **n**, **s**, **b**, **t**, **r** makes it work on all entities (not only on roots). The sign ‘?’ before **n**, **s**, **b**, **t** limits the scope of information to invalid entities.
-Optional argument selection can limit the action of the command with a selected subset of entities.
+Provides all statistics on the last transfer, including a list of transferred entities with mapping from IGES or STEP to OCCT types, as well as fail and warning messages. The parameter defines what information will be printed:
+
+* *g* - General statistics (a list of results and messages)
+* *c* - Count of all warning and fail messages
+* *C* - List of all warning and fail messages
+* *f* - Count of all fail messages
+* *F* - List of all fail messages
+* *n* - List of all transferred roots
+* *s* - The same, with types of source entity and the type of result
+* *b* - The same, with messages
+* *t* - Count of roots for geometrical types
+* *r* - Count of roots for topological types
+* *l* - The same, with the type of the source entity
+
+The sign \* before parameters *n, s, b, t, r* makes it work on all entities (not only on roots).
+
+The sign ? before *n, s, b, t* limits the scope of information to invalid entities.
+
+Optional argument \ can limit the action of the command to the selection, not to all entities.
+
+To get help, run this command without arguments.
+
**Example:**
-
+~~~~~
# translation ratio on IGES faces
tpstat *l iges-faces
+~~~~~
-@subsubsection occt_2142243456_18669311358420 xload
+@subsubsection occt_draw_8_3_20 xload
-Syntax: xload file_name
+Syntax:
+~~~~~
+xload
+~~~~~
This command loads an IGES or STEP file into memory (i.e. to fill the model with data from the file) without creation of an OCCT shape.
+
**Example:**
-
+~~~~~
xload /disk1/tmp/aaa.stp
+~~~~~
-
-@subsection occt_2142243456_186693113585 Overview of XDE commands
+@subsection occt_draw_8_4 Overview of XDE commands
These commands are used for translation of IGES and STEP files into an XCAF document (special document is inherited from CAF document and is intended for Extended Data Exchange (XDE) ) and working with it. XDE translation allows reading and writing of shapes with additional attributes – colors, layers etc. All commands can be divided into the following groups:
- * **XDE translation commands**
- * **XDE general commands**
- * **XDE shape’s commands**
- * **XDE color’s commands**
- * **XDE layer’s commands**
- * **XDE property’s commands**
+ * XDE translation commands
+ * XDE general commands
+ * XDE shape’s commands
+ * XDE color’s commands
+ * XDE layer’s commands
+ * XDE property’s commands
+Reminding: All operations of translation are performed with parameters managed by command the command *param*.
+@subsubsection occt_draw_8_4_1 ReadIges
-@subsection occt_2142243456_186693113586 XDE translation commands
-
-Reminding: All operations of translation are performed with parameters managed by command param (see above)
-
-@subsubsection occt_2142243456_1866931135861 ReadIges
-
-Syntax: ReadIges document file_name
+Syntax:
+~~~~~
+ReadIges document file_name
+~~~~~
Reads information from an IGES file to an XCAF document.
+
**Example:**
-
+~~~~~
ReadIges D /disk1/tmp/aaa.igs
-== Document saved with name D
+==> Document saved with name D
+~~~~~
-@subsubsection occt_2142243456_1866931135862 ReadStep
+@subsubsection occt_draw_8_4_2 ReadStep
-Syntax: ReadStep document file_name
+Syntax:
+~~~~~
+ReadStep
+~~~~~
Reads information from a STEP file to an XCAF document.
-**Example:**
+**Example:**
+~~~~~
ReadStep D /disk1/tmp/aaa.stp
== Document saved with name D
+~~~~~
-@subsubsection occt_2142243456_1866931135863 WriteIges
+@subsubsection occt_draw_8_4_3 WriteIges
-Syntax: WriteIges document file_name
+Syntax:
+~~~~~
+WriteIges
+~~~~~
**Example:**
-
+~~~~~
WriteIges D /disk1/tmp/aaa.igs
+~~~~~
-@subsubsection occt_2142243456_1866931135864 WriteStep
+@subsubsection occt_draw_8_4_4 WriteStep
-Syntax: WriteStep document file_name
+Syntax:
+~~~~~
+WriteStep
+~~~~~
Writes information from an XCAF document to a STEP file.
+
**Example:**
-
+~~~~~
WriteStep D /disk1/tmp/aaa.stp
+~~~~~
-@subsubsection occt_2142243456_1866931135865 XFileCur
+@subsubsection occt_draw_8_4_5 XFileCur
-Syntax: XFileCur
+Syntax:
+~~~~~
+XFileCur
+~~~~~
Returns the name of file which is set as the current one in the Draw session.
-**Example:**
+**Example:**
+~~~~~
XFileCur
== *as1-ct-203.stp*
+~~~~~
-@subsubsection occt_2142243456_1866931135866 XFileList
+@subsubsection occt_draw_8_4_6 XFileList
-Syntax: XFileList
+Syntax:
+~~~~~
+XFileList
+~~~~~
Returns a list all files that were transferred by the last transfer. This command is meant (assigned) for the assemble step file.
+
**Example:**
-
+~~~~~
XFileList
-== *as1-ct-Bolt.stp*
-== *as1-ct-L-Bracktet.stp*
-== *as1-ct-LBA.stp*
-== *as1-ct-NBA.stp*
-== …
+==> *as1-ct-Bolt.stp*
+==> *as1-ct-L-Bracktet.stp*
+==> *as1-ct-LBA.stp*
+==> *as1-ct-NBA.stp*
+==> …
+~~~~~
-@subsubsection occt_2142243456_1866931135867 XFileSet
+@subsubsection occt_draw_8_4_7 XFileSet
-Syntax: XFileSet filename
+Syntax:
+~~~~~
+XFileSet
+~~~~~
Sets the current file taking it from the components list of the assemble file.
-**Example:**
+**Example:**
+~~~~~
XFileSet as1-ct-NBA.stp
+~~~~~
-@subsubsection occt_2142243456_1866931135868 XFromShape
+@subsubsection occt_draw_8_4_8 XFromShape
-Syntax: XFromShape shape
+Syntax:
+~~~~~
+XFromShape
+~~~~~
+
+This command is similar to the command *fromshape*, but gives additional information about the file name. It is useful if a shape was translated from several files.
-This command is similar to command *fromshape* (see above) but gives additional information about the name of file. It is useful in the case when a shape was translated from several files.
**Example:**
-
+~~~~~
XFromShape a
-== Shape a: imported from entity 217:#26 in file as1-ct-Nut.stp
+==> Shape a: imported from entity 217:#26 in file as1-ct-Nut.stp
+~~~~~
+@subsection occt_draw_8_5 XDE general commands
-@subsection occt_2142243456_186693113587 XDE general commands
+@subsubsection occt_draw_8_5_1 XNewDoc
-@subsubsection occt_2142243456_1866931135871 XNewDoc
-
-Syntax: XNewDoc document
+Syntax:
+~~~~~
+XNewDoc
+~~~~~
Creates a new XCAF document.
+
**Example:**
-
+~~~~~
XNewDoc D
+~~~~~
-@subsubsection occt_2142243456_1866931135872 XShow
+@subsubsection occt_draw_8_5_2 XShow
-Syntax: XShow document [ label1 … ]
+Syntax:
+~~~~~
+XShow [ … ]
+~~~~~
Shows a shape from a given label in the 3D viewer. If the label is not given – shows all shapes from the document.
-**Example:**
+**Example:**
+~~~~~
# show shape from label 0:1:1:4 from document D
XShow D 0:1:1:4
+~~~~~
-@subsubsection occt_2142243456_1866931135873 XStat
+@subsubsection occt_draw_8_5_3 XStat
-Syntax: XStat document
+Syntax:
+~~~~~
+XStat
+~~~~~
Prints common information from an XCAF document.
+
**Example:**
-
+~~~~~
XStat D
-==Statistis of shapes in the document:
-==level N 0 : 9
-==level N 1 : 18
-==level N 2 : 5
-==Total number of labels for shapes in the document = 32
-==Number of labels with name = 27
-==Number of labels with color link = 3
+==>Statistis of shapes in the document:
+==>level N 0 : 9
+==>level N 1 : 18
+==>level N 2 : 5
+==>Total number of labels for shapes in the document = 32
+==>Number of labels with name = 27
+==>Number of labels with color link = 3
==Number of labels with layer link = 0
-==Statistis of Props in the document:
-==Number of Centroid Props = 5
-==Number of Volume Props = 5
-==Number of Area Props = 5
-==Number of colors = 4
-==BLUE1 RED YELLOW BLUE2
-==Number of layers = 0
+==>Statistis of Props in the document:
+==>Number of Centroid Props = 5
+==>Number of Volume Props = 5
+==>Number of Area Props = 5
+==>Number of colors = 4
+==>BLUE1 RED YELLOW BLUE2
+==>Number of layers = 0
+~~~~~
-@subsubsection occt_2142243456_1866931135874 XWdump
+@subsubsection occt_draw_8_5_4 XWdump
-Syntax: XWdump document filename
+Syntax:
+~~~~~
+XWdump
+~~~~~
Saves the contents of the viewer window as an image (XWD, png or BMP file).
-filename must have a corresponding extention.
+ must have a corresponding extention.
+
**Example:**
-
+~~~~~
XWdump D /disk1/tmp/image.png
+~~~~~
-@subsubsection occt_2142243456_1866931135875 Xdump
+@subsubsection occt_draw_8_5_5 Xdump
-Syntax: Xdump document [int deep {0|1}]
+Syntax:
+~~~~~
+Xdump [int deep {0|1}]
+~~~~~
Prints information about the tree structure of the document. If parameter 1 is given, then the tree is printed with a link to shapes.
+
**Example:**
-
+~~~~~
Xdump D 1
-== ASSEMBLY 0:1:1:1 L-BRACKET(0xe8180448)
-== ASSEMBLY 0:1:1:2 NUT(0xe82151e8)
-== ASSEMBLY 0:1:1:3 BOLT(0xe829b000)
-== ASSEMBLY 0:1:1:4 PLATE(0xe8387780)
-== ASSEMBLY 0:1:1:5 ROD(0xe8475418)
-== ASSEMBLY 0:1:1:6 AS1(0xe8476968)
-== ASSEMBLY 0:1:1:7 L-BRACKET-ASSEMBLY(0xe8476230)
-== ASSEMBLY 0:1:1:1 L-BRACKET(0xe8180448)
-== ASSEMBLY 0:1:1:8 NUT-BOLT-ASSEMBLY(0xe8475ec0)
-== ASSEMBLY 0:1:1:2 NUT(0xe82151e8)
-== ASSEMBLY 0:1:1:3 BOLT(0xe829b000)
+==> ASSEMBLY 0:1:1:1 L-BRACKET(0xe8180448)
+==> ASSEMBLY 0:1:1:2 NUT(0xe82151e8)
+==> ASSEMBLY 0:1:1:3 BOLT(0xe829b000)
+==> ASSEMBLY 0:1:1:4 PLATE(0xe8387780)
+==> ASSEMBLY 0:1:1:5 ROD(0xe8475418)
+==> ASSEMBLY 0:1:1:6 AS1(0xe8476968)
+==> ASSEMBLY 0:1:1:7 L-BRACKET-ASSEMBLY(0xe8476230)
+==> ASSEMBLY 0:1:1:1 L-BRACKET(0xe8180448)
+==> ASSEMBLY 0:1:1:8 NUT-BOLT-ASSEMBLY(0xe8475ec0)
+==> ASSEMBLY 0:1:1:2 NUT(0xe82151e8)
+==> ASSEMBLY 0:1:1:3 BOLT(0xe829b000)
etc.
+~~~~~
+@subsection occt_draw_8_6 XDE shape commands
-@subsection occt_2142243456_186693113588 XDE shape’s commands
+@subsubsection occt_draw_8_6_1 XAddComponent
-@subsubsection occt_2142243456_1866931135881 XAddComponent
-
-Syntax: XAddComponent document label shape
+Syntax:
+~~~~~
+XAddComponent