OpenCascade/occt
1
0
Fork 0
mirror of https://git.dev.opencascade.org/repos/occt.git synced 2025-04-03 17:56:21 +03:00
Code Packages Releases Activity

0032340: OCCT Documentation - highlight C++ code snippets

Browse Source 
Added {.cpp} highlighting markers to the C++ code blocks in documentation;
Excessive tildes "~~~~~~~" in code block borders are reduced to required minimum of "~~~~" (4);
Removed obsolete space bars after code block borders;
TCL code blocks are now highlighted with {.php} markers;
Removed excessive {.cpp} highlighting markers appended to non-code blocks such as lists, reports and file content or structure examples;
Minor fixes for tests.md and draw_test_harness.md (whitespace removal and structural fix for "Where:" in code examples);
Minimum HDD space for OCCT updated in introduction.md.
This commit is contained in:
btokarev 2021-05-18 13:09:50 +03:00 committed by bugmaster
parent 4d67a36952
commit 77d94fd174
25 changed files with 4576 additions and 4571 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

44
dox/build/build_occt/building_occt.md
View File

@ -243,9 +243,9 @@ The environment is defined in the file *custom.sh* (on Linux and OS X) or *custo
* *ShortCut* - short-cut header files will be created, redirecting to same-named header located in *src*; * *ShortCut* - short-cut header files will be created, redirecting to same-named header located in *src*;
* "HardLink* - hard links to headers located in *src* will be created. * "HardLink* - hard links to headers located in *src* will be created.
* For optional third-party libraries, set corresponding environment variable <i>HAVE_<LIBRARY_NAME></i> to either *false*, e.g.: * For optional third-party libraries, set corresponding environment variable <i>HAVE_<LIBRARY_NAME></i> to either *false*, e.g.:
~~~~~ ~~~~
export HAVE_FREEIMAGE=false export HAVE_FREEIMAGE=false
~~~~~ ~~~~
Alternatively, or when *custom.sh* or *custom.bat* does not exist, you can launch **genconf** tool to configure environment interactively: Alternatively, or when *custom.sh* or *custom.bat* does not exist, you can launch **genconf** tool to configure environment interactively:
@ -257,10 +257,10 @@ Click "Save" to store the specified configuration in *custom.sh* or *custom.bat*
Launch **genproj** tool with option *cbp* to update content of *inc* folder and generate project files after changes in OCCT code affecting layout or composition of source files: Launch **genproj** tool with option *cbp* to update content of *inc* folder and generate project files after changes in OCCT code affecting layout or composition of source files:
~~~~~ ~~~~
$ cd /dev/OCCT/opencascade-7.0.0 $ cd /dev/OCCT/opencascade-7.0.0
$ ./genproj cbp $ ./genproj cbp
~~~~~ ~~~~
The generated Code::Blocks project are placed into subfolder *adm/&lt;OS&gt;/cbp*. The generated Code::Blocks project are placed into subfolder *adm/&lt;OS&gt;/cbp*.
@ -273,9 +273,9 @@ To start **Code::Blocks**, launch script *codeblocks.sh*.
To build all toolkits, click **Build->Build workspace** in the menu bar. To build all toolkits, click **Build->Build workspace** in the menu bar.
To start *DRAWEXE*, which has been built with **Code::Blocks** on Mac OS X, run the script To start *DRAWEXE*, which has been built with **Code::Blocks** on Mac OS X, run the script
~~~~~ ~~~~
./draw.sh cbp [d] ./draw.sh cbp [d]
~~~~~ ~~~~
Option *d* is used if OCCT has been built in **Debug** mode. Option *d* is used if OCCT has been built in **Debug** mode.
@subsection build_occt_genproj Building with Genproj tool @subsection build_occt_genproj Building with Genproj tool
@ -344,9 +344,9 @@ Launch **genproj** to update content of *inc* folder and generate project files
@note To use **genproj** and **genconf** tools you need to have Tcl installed and accessible by PATH. @note To use **genproj** and **genconf** tools you need to have Tcl installed and accessible by PATH.
If Tcl is not found, the tool may prompt you to enter the path to directory where Tcl can be found. If Tcl is not found, the tool may prompt you to enter the path to directory where Tcl can be found.
~~~~~ ~~~~
$ genproj.bat $ genproj.bat
~~~~~ ~~~~
Note that if *custom.bat* is not present, **genproj** will start **genconf** to configure environment. Note that if *custom.bat* is not present, **genproj** will start **genconf** to configure environment.
@ -470,9 +470,9 @@ The environment is defined in the file *custom.sh* which can be edited directly:
* *ShortCut* - short-cut header files will be created, redirecting to same-named header located in *src*; * *ShortCut* - short-cut header files will be created, redirecting to same-named header located in *src*;
* "HardLink* - hard links to headers located in *src* will be created. * "HardLink* - hard links to headers located in *src* will be created.
* For optional third-party libraries, set corresponding environment variable <i>HAVE_<LIBRARY_NAME></i> to either *false*, e.g.: * For optional third-party libraries, set corresponding environment variable <i>HAVE_<LIBRARY_NAME></i> to either *false*, e.g.:
~~~~~ ~~~~
export HAVE_FREEIMAGE=false export HAVE_FREEIMAGE=false
~~~~~ ~~~~
Alternatively, or when *custom.sh* does not exist, you can launch *genconf.sh* to configure environment interactively: Alternatively, or when *custom.sh* does not exist, you can launch *genconf.sh* to configure environment interactively:
@ -488,10 +488,10 @@ Launch **genproj** tool to update content of *inc* folder and generate project f
For instance, in Terminal application: For instance, in Terminal application:
~~~~~ ~~~~
$ cd /dev/OCCT/opencascade-7.0.0 $ cd /dev/OCCT/opencascade-7.0.0
$ ./genproj $ ./genproj
~~~~~ ~~~~
<h2>Building</h2> <h2>Building</h2>
@ -513,14 +513,14 @@ To start *DRAWEXE*, which has been built with Xcode on Mac OS X, perform the fol
1.Open Terminal application 1.Open Terminal application
2.Enter <i>\<OCCT_ROOT_DIR\></i>: 2.Enter <i>\<OCCT_ROOT_DIR\></i>:
~~~~~ ~~~~
cd \<OCCT_ROOT_DIR\> cd \<OCCT_ROOT_DIR\>
~~~~~ ~~~~
3.Run the script 3.Run the script
~~~~~ ~~~~
./draw_cbp.sh xcd [d] ./draw_cbp.sh xcd [d]
~~~~~ ~~~~
Option *d* is used if OCCT has been built in **Debug** mode. Option *d* is used if OCCT has been built in **Debug** mode.
@ -543,9 +543,9 @@ directly:
* *ShortCut* - short-cut header files will be created, redirecting to same-named header located in *src*; * *ShortCut* - short-cut header files will be created, redirecting to same-named header located in *src*;
* "HardLink* - hard links to headers located in *src* will be created. * "HardLink* - hard links to headers located in *src* will be created.
* For optional third-party libraries, set corresponding environment variable <i>HAVE_<LIBRARY_NAME></i> to either *false*, e.g.: * For optional third-party libraries, set corresponding environment variable <i>HAVE_<LIBRARY_NAME></i> to either *false*, e.g.:
~~~~~ ~~~~
export HAVE_FREEIMAGE=false export HAVE_FREEIMAGE=false
~~~~~ ~~~~
Alternatively, or when *custom.sh* or *custom.bat* does not exist, you can launch **genconf** tool to configure Alternatively, or when *custom.sh* or *custom.bat* does not exist, you can launch **genconf** tool to configure
environment interactively: environment interactively:
@ -559,10 +559,10 @@ Click "Save" to store the specified configuration in *custom.sh* or *custom.bat*
Launch **genproj** tool with option *cbp* to update content of *inc* folder and generate project files after changes in Launch **genproj** tool with option *cbp* to update content of *inc* folder and generate project files after changes in
OCCT code affecting layout or composition of source files: OCCT code affecting layout or composition of source files:
~~~~~ ~~~~
$ cd /dev/OCCT/opencascade-7.0.0 $ cd /dev/OCCT/opencascade-7.0.0
$ ./genproj cbp $ ./genproj cbp
~~~~~ ~~~~
The generated Code::Blocks project are placed into subfolder *adm/&lt;OS&gt;/cbp*. The generated Code::Blocks project are placed into subfolder *adm/&lt;OS&gt;/cbp*.
@ -575,7 +575,7 @@ To start **Code::Blocks**, launch script *codeblocks.sh*.
To build all toolkits, click **Build->Build workspace** in the menu bar. To build all toolkits, click **Build->Build workspace** in the menu bar.
To start *DRAWEXE*, which has been built with **Code::Blocks** on Mac OS X, run the script To start *DRAWEXE*, which has been built with **Code::Blocks** on Mac OS X, run the script
~~~~~ ~~~~
./draw_cbp.sh cbp [d] ./draw_cbp.sh cbp [d]
~~~~~ ~~~~
Option *d* is used if OCCT has been built in **Debug** mode. Option *d* is used if OCCT has been built in **Debug** mode.

156
dox/contribution/coding_rules.md
View File

@ -48,11 +48,11 @@ For example, method *GetCoord* returns a triple of real values and is defined fo
Camel Case style is preferred for names. Camel Case style is preferred for names.
For example: For example:
~~~~~{.cpp} ~~~~{.cpp}
Standard_Integer awidthofbox; // this is bad Standard_Integer awidthofbox; // this is bad
Standard_Integer width_of_box; // this is bad Standard_Integer width_of_box; // this is bad
Standard_Integer aWidthOfBox; // this is OK Standard_Integer aWidthOfBox; // this is OK
~~~~~ ~~~~
@subsection occt_coding_rules_2_2 Names of development units @subsection occt_coding_rules_2_2 Names of development units
@ -80,9 +80,9 @@ Toolkit names are prefixed by *TK*, followed by a meaningful part of the name ex
Names of public classes and other types (structures, enums, typedefs) should match the common pattern: name of the package followed by underscore and suffix (the own name of the type): Names of public classes and other types (structures, enums, typedefs) should match the common pattern: name of the package followed by underscore and suffix (the own name of the type):
~~~~~ ~~~~{.cpp}
<package-name>_<class-name> <package-name>_<class-name>
~~~~~ ~~~~
Static methods related to the whole package are defined in the class with the same name as package (without suffix). Static methods related to the whole package are defined in the class with the same name as package (without suffix).
@ -95,9 +95,9 @@ This rule also applies to complex types constructed by instantiation of template
Such types should be given own names using *typedef* statement, located in same-named header file. Such types should be given own names using *typedef* statement, located in same-named header file.
For example, see definition in the file *TColStd_IndexedDataMapOfStringString.hxx*: For example, see definition in the file *TColStd_IndexedDataMapOfStringString.hxx*:
~~~~~ ~~~~{.cpp}
typedef NCollection_IndexedDataMap<TCollection_AsciiString,TCollection_AsciiString,TCollection_AsciiString> TColStd_IndexedDataMapOfStringString; typedef NCollection_IndexedDataMap<TCollection_AsciiString,TCollection_AsciiString,TCollection_AsciiString> TColStd_IndexedDataMapOfStringString;
~~~~~ ~~~~
### Names of functions ### Names of functions
@ -109,7 +109,7 @@ The term **function** here is defined as:
It is preferred to start names of public methods from an upper case character and to start names of protected and private methods from a lower case character. It is preferred to start names of public methods from an upper case character and to start names of protected and private methods from a lower case character.
~~~~~{.cpp} ~~~~{.cpp}
class MyPackage_MyClass class MyPackage_MyClass
{ {
@ -123,7 +123,7 @@ private:
void setIntegerValue (const Standard_Integer theValue); void setIntegerValue (const Standard_Integer theValue);
}; };
~~~~~ ~~~~
@subsection occt_coding_rules_2_3 Names of variables @subsection occt_coding_rules_2_3 Names of variables
@ -137,13 +137,13 @@ The name of a variable should not start with an underscore.
See the following examples: See the following examples:
~~~~~{.cpp} ~~~~{.cpp}
Standard_Integer Elapsed_Time = 0; // this is bad - possible class name Standard_Integer Elapsed_Time = 0; // this is bad - possible class name
Standard_Integer gp = 0; // this is bad - existing package name Standard_Integer gp = 0; // this is bad - existing package name
Standard_Integer aGp = 0; // this is OK Standard_Integer aGp = 0; // this is OK
Standard_Integer _KERNEL = 0; // this is bad Standard_Integer _KERNEL = 0; // this is bad
Standard_Integer THE_KERNEL = 0; // this is OK Standard_Integer THE_KERNEL = 0; // this is OK
~~~~~ ~~~~
### Names of function parameters ### Names of function parameters
@ -151,11 +151,11 @@ The name of a function (procedure, class method) parameter should start with pre
See the following examples: See the following examples:
~~~~~{.cpp} ~~~~{.cpp}
void Package_MyClass::MyFunction (const gp_Pnt& p); // this is bad void Package_MyClass::MyFunction (const gp_Pnt& p); // this is bad
void Package_MyClass::MyFunction (const gp_Pnt& theP); // this is OK void Package_MyClass::MyFunction (const gp_Pnt& theP); // this is OK
void Package_MyClass::MyFunction (const gp_Pnt& thePoint); // this is preferred void Package_MyClass::MyFunction (const gp_Pnt& thePoint); // this is preferred
~~~~~ ~~~~
### Names of class member variables ### Names of class member variables
@ -163,11 +163,11 @@ The name of a class member variable should start with prefix *my* followed by th
See the following examples: See the following examples:
~~~~~{.cpp} ~~~~{.cpp}
Standard_Integer counter; // This is bad Standard_Integer counter; // This is bad
Standard_Integer myC; // This is OK Standard_Integer myC; // This is OK
Standard_Integer myCounter; // This is preferred Standard_Integer myCounter; // This is preferred
~~~~~ ~~~~
### Names of global variables ### Names of global variables
@ -176,18 +176,18 @@ However, as soon as a global variable is necessary, its name should be prefixed
See the following examples: See the following examples:
~~~~~{.cpp} ~~~~{.cpp}
Standard_Integer MyPackage_myGlobalVariable = 0; Standard_Integer MyPackage_myGlobalVariable = 0;
Standard_Integer MyPackage_MyClass_myGlobalVariable = 0; Standard_Integer MyPackage_MyClass_myGlobalVariable = 0;
~~~~~ ~~~~
Static constants within the file should be written in upper-case and begin with prefix *THE_*: Static constants within the file should be written in upper-case and begin with prefix *THE_*:
~~~~~{.cpp} ~~~~{.cpp}
namespace namespace
{ {
static const Standard_Real THE_CONSTANT_COEF = 3.14; static const Standard_Real THE_CONSTANT_COEF = 3.14;
}; };
~~~~~ ~~~~
### Names of local variables ### Names of local variables
@ -197,12 +197,12 @@ It is preferred to prefix local variable names with *a* and *an* (or *is*, *to*
See the following example: See the following example:
~~~~~{.cpp} ~~~~{.cpp}
Standard_Integer theI; // this is bad Standard_Integer theI; // this is bad
Standard_Integer i; // this is bad Standard_Integer i; // this is bad
Standard_Integer index; // this is bad Standard_Integer index; // this is bad
Standard_Integer anIndex; // this is OK Standard_Integer anIndex; // this is OK
~~~~~ ~~~~
### Avoid dummy names ### Avoid dummy names
Avoid dummy names, such as <i>i, j, k</i>. Such names are meaningless and easy to mix up. Avoid dummy names, such as <i>i, j, k</i>. Such names are meaningless and easy to mix up.
@ -211,7 +211,7 @@ The code becomes more and more complicated when such dummy names are used there
See the following examples for preferred style: See the following examples for preferred style:
~~~~~{.cpp} ~~~~{.cpp}
void Average (const Standard_Real** theArray, void Average (const Standard_Real** theArray,
Standard_Integer theRowsNb, Standard_Integer theRowsNb,
Standard_Integer theRowLen, Standard_Integer theRowLen,
@ -227,7 +227,7 @@ void Average (const Standard_Real** theArray,
theResult /= Standard_Real(aRowsNb * aRowLen); theResult /= Standard_Real(aRowsNb * aRowLen);
} }
} }
~~~~~ ~~~~
@section occt_coding_rules_3 Formatting rules @section occt_coding_rules_3 Formatting rules
@ -262,7 +262,7 @@ Punctuation rules follow the rules of the English language.
* For better readability it is also recommended to surround conventional operators by a space character. * For better readability it is also recommended to surround conventional operators by a space character.
Examples: Examples:
~~~~~{.cpp} ~~~~{.cpp}
while (true) // NOT: while( true ) ... while (true) // NOT: while( true ) ...
{ {
DoSomething (theA, theB, theC, theD); // NOT: DoSomething(theA,theB,theC,theD); DoSomething (theA, theB, theC, theD); // NOT: DoSomething(theA,theB,theC,theD);
@ -271,7 +271,7 @@ for (anIter = 0; anIter < 10; ++anIter) // NOT: for (anIter=0;anIter<10;++anIter
{ {
theA = (theB + theC) * theD; // NOT: theA=(theB+theC)*theD theA = (theB + theC) * theD; // NOT: theA=(theB+theC)*theD
} }
~~~~~ ~~~~
### Declaration of pointers and references ### Declaration of pointers and references
@ -281,7 +281,7 @@ Since declaration of several variables with mixed pointer types contrudicts this
Examples: Examples:
~~~~~{.cpp} ~~~~{.cpp}
Standard_Integer *theVariable; // not recommended Standard_Integer *theVariable; // not recommended
Standard_Integer * theVariable; // not recommended Standard_Integer * theVariable; // not recommended
Standard_Integer* theVariable; // this is OK Standard_Integer* theVariable; // this is OK
@ -295,7 +295,7 @@ Standard_Integer ** theVariable; // not recommended
Standard_Integer** theVariable; // this is OK Standard_Integer** theVariable; // this is OK
Standard_Integer *theA, theB, **theC; // not recommended (declare each variable independently) Standard_Integer *theA, theB, **theC; // not recommended (declare each variable independently)
~~~~~ ~~~~
### Separate logical blocks ### Separate logical blocks
@ -303,7 +303,7 @@ Separate logical blocks of code with one blank line and comments.
See the following example: See the following example:
~~~~~{.cpp} ~~~~{.cpp}
// check arguments // check arguments
Standard_Integer anArgsNb = argCount(); Standard_Integer anArgsNb = argCount();
if (anArgsNb < 3 || isSmthInvalid) if (anArgsNb < 3 || isSmthInvalid)
@ -318,7 +318,7 @@ if (anArgsNb < 3 || isSmthInvalid)
// do our job // do our job
... ...
... ...
~~~~~ ~~~~
Notice that multiple blank lines should be avoided. Notice that multiple blank lines should be avoided.
@ -329,7 +329,7 @@ Each descriptive block should contain at least a function name and purpose descr
See the following example: See the following example:
~~~~~{.cpp} ~~~~{.cpp}
// ======================================================================= // =======================================================================
// function : TellMeSmthGood // function : TellMeSmthGood
// purpose : Gives me good news // purpose : Gives me good news
@ -347,19 +347,19 @@ void TellMeSmthBad()
{ {
... ...
} }
~~~~~ ~~~~
### Block layout [MANDATORY] ### Block layout [MANDATORY]
Figure brackets <i>{ }</i> and each operator <i>(for, if, else, try, catch)</i> should be written on a dedicated line. Figure brackets <i>{ }</i> and each operator <i>(for, if, else, try, catch)</i> should be written on a dedicated line.
In general, the layout should be as follows: In general, the layout should be as follows:
~~~~~{.cpp} ~~~~{.cpp}
while (expression) while (expression)
{ {
... ...
} }
~~~~~ ~~~~
Entering a block increases and leaving a block decreases the indentation by one tabulation. Entering a block increases and leaving a block decreases the indentation by one tabulation.
@ -367,7 +367,7 @@ Entering a block increases and leaving a block decreases the indentation by one
Single-line conditional operators <i>(if, while, for,</i> etc.) can be written without brackets on the following line. Single-line conditional operators <i>(if, while, for,</i> etc.) can be written without brackets on the following line.
~~~~~{.cpp} ~~~~{.cpp}
if (!myIsInit) return Standard_False; // bad if (!myIsInit) return Standard_False; // bad
if (thePtr == NULL) // OK if (thePtr == NULL) // OK
@ -377,7 +377,7 @@ if (!theAlgo.IsNull()) // preferred
{ {
DoSomething(); DoSomething();
} }
~~~~~ ~~~~
Having all code in the same line is less convenient for debugging. Having all code in the same line is less convenient for debugging.
@ -386,7 +386,7 @@ Having all code in the same line is less convenient for debugging.
In comparisons, put the variable (in the current context) on the left side and constant on the right side of expression. In comparisons, put the variable (in the current context) on the left side and constant on the right side of expression.
That is, the so called "Yoda style" is to be avoided. That is, the so called "Yoda style" is to be avoided.
~~~~~{.cpp} ~~~~{.cpp}
if (NULL != thePointer) // Yoda style, not recommended if (NULL != thePointer) // Yoda style, not recommended
if (thePointer != NULL) // OK if (thePointer != NULL) // OK
@ -398,13 +398,13 @@ if (anIter <= theNbValues) // OK
if (THE_LIMIT == theValue) // bad style (global constant vs. variable) if (THE_LIMIT == theValue) // bad style (global constant vs. variable)
if (theValue == THE_LIMIT) // OK if (theValue == THE_LIMIT) // OK
~~~~~ ~~~~
### Alignment ### Alignment
Use alignment wherever it enhances the readability. See the following example: Use alignment wherever it enhances the readability. See the following example:
~~~~~{.cpp} ~~~~{.cpp}
MyPackage_MyClass anObject; MyPackage_MyClass anObject;
Standard_Real aMinimum = 0.0; Standard_Real aMinimum = 0.0;
Standard_Integer aVal = theVal; Standard_Integer aVal = theVal;
@ -415,7 +415,7 @@ switch (aVal)
case 3: case 3:
default: computeSomethingElseYet(); break; default: computeSomethingElseYet(); break;
} }
~~~~~ ~~~~
### Indentation of comments ### Indentation of comments
@ -425,7 +425,7 @@ The text of the comment should be separated from the slash character by a single
See the following example: See the following example:
~~~~~{.cpp} ~~~~{.cpp}
while (expression) //bad comment while (expression) //bad comment
{ {
// this is a long multi-line comment // this is a long multi-line comment
@ -433,7 +433,7 @@ while (expression) //bad comment
DoSomething(); // maybe, enough DoSomething(); // maybe, enough
DoSomethingMore(); // again DoSomethingMore(); // again
} }
~~~~~ ~~~~
### Early return statement ### Early return statement
@ -441,7 +441,7 @@ Use an early return condition rather than collect indentations.
Write like this: Write like this:
~~~~~{.cpp} ~~~~{.cpp}
Standard_Integer ComputeSumm (const Standard_Integer* theArray, Standard_Integer ComputeSumm (const Standard_Integer* theArray,
const Standard_Size theSize) const Standard_Size theSize)
{ {
@ -454,11 +454,11 @@ Standard_Integer ComputeSumm (const Standard_Integer* theArray,
... computing summ ... ... computing summ ...
return aSumm; return aSumm;
} }
~~~~~ ~~~~
Rather than: Rather than:
~~~~~{.cpp} ~~~~{.cpp}
Standard_Integer ComputeSumm (const Standard_Integer* theArray, Standard_Integer ComputeSumm (const Standard_Integer* theArray,
const Standard_Size theSize) const Standard_Size theSize)
{ {
@ -469,7 +469,7 @@ Standard_Integer ComputeSumm (const Standard_Integer* theArray,
} }
return aSumm; return aSumm;
} }
~~~~~ ~~~~
This helps to improve readability and reduce the unnecessary indentation depth. This helps to improve readability and reduce the unnecessary indentation depth.
@ -490,7 +490,7 @@ An exception to the rule is ordering system headers generating a macros declarat
The source or header file should include only minimal set of headers necessary for compilation, without duplicates (considering nested includes). The source or header file should include only minimal set of headers necessary for compilation, without duplicates (considering nested includes).
~~~~~{.cpp} ~~~~{.cpp}
// the header file of implemented class // the header file of implemented class
#include <PackageName_ClassName.hxx> #include <PackageName_ClassName.hxx>
@ -506,7 +506,7 @@ The source or header file should include only minimal set of headers necessary f
// system headers // system headers
#include <iostream> #include <iostream>
#include <windows.h> #include <windows.h>
~~~~~ ~~~~
@section occt_coding_rules_4 Documentation rules @section occt_coding_rules_4 Documentation rules
@ -623,7 +623,7 @@ A class with virtual function(s) ought to have a virtual destructor.
Declaration of overriding method should contains specifiers "virtual" and "override" Declaration of overriding method should contains specifiers "virtual" and "override"
(using Standard_OVERRIDE alias for compatibility with old compilers). (using Standard_OVERRIDE alias for compatibility with old compilers).
~~~~~{.cpp} ~~~~{.cpp}
class MyPackage_BaseClass class MyPackage_BaseClass
{ {
@ -641,7 +641,7 @@ public:
Standard_EXPORT virtual Standard_Boolean Perform() Standard_OVERRIDE; Standard_EXPORT virtual Standard_Boolean Perform() Standard_OVERRIDE;
}; };
~~~~~ ~~~~
This makes class definition more clear (virtual methods become highlighted). This makes class definition more clear (virtual methods become highlighted).
@ -667,20 +667,20 @@ Avoid *goto* statement unless it is really needed.
Declare a cycle variable in the header of the *for()* statement if not used out of cycle. Declare a cycle variable in the header of the *for()* statement if not used out of cycle.
~~~~~{.cpp} ~~~~{.cpp}
Standard_Real aMinDist = Precision::Infinite(); Standard_Real aMinDist = Precision::Infinite();
for (NCollection_Sequence<gp_Pnt>::Iterator aPntIter (theSequence); for (NCollection_Sequence<gp_Pnt>::Iterator aPntIter (theSequence);
aPntIter.More(); aPntIter.Next()) aPntIter.More(); aPntIter.Next())
{ {
aMinDist = Min (aMinDist, theOrigin.Distance (aPntIter.Value())); aMinDist = Min (aMinDist, theOrigin.Distance (aPntIter.Value()));
} }
~~~~~ ~~~~
### Condition statements within zero ### Condition statements within zero
Avoid usage of C-style comparison for non-boolean variables: Avoid usage of C-style comparison for non-boolean variables:
~~~~~{.cpp} ~~~~{.cpp}
void Function (Standard_Integer theValue, void Function (Standard_Integer theValue,
Standard_Real* thePointer) Standard_Real* thePointer)
{ {
@ -699,7 +699,7 @@ void Function (Standard_Integer theValue,
DoSome2(); DoSome2();
} }
} }
~~~~~ ~~~~
@section occt_coding_rules_7 Portability issues @section occt_coding_rules_7 Portability issues
@ -791,11 +791,11 @@ In C++ use *new* and *delete* operators instead of *malloc()* and *free()*. Try
Use the same form of new and delete. Use the same form of new and delete.
~~~~~{.cpp} ~~~~{.cpp}
aPtr1 = new TypeA[n]; ... ; delete[] aPtr1; aPtr1 = new TypeA[n]; ... ; delete[] aPtr1;
aPtr2 = new TypeB(); ... ; delete aPtr2; aPtr2 = new TypeB(); ... ; delete aPtr2;
aPtr3 = Standard::Allocate (4096); ... ; Standard::Free (aPtr3); aPtr3 = Standard::Allocate (4096); ... ; Standard::Free (aPtr3);
~~~~~ ~~~~
### Methods managing dynamical allocation [MANDATORY] ### Methods managing dynamical allocation [MANDATORY]
@ -805,10 +805,10 @@ Define a destructor, a copy constructor and an assignment operator for classes w
Every variable should be initialized. Every variable should be initialized.
~~~~~{.cpp} ~~~~{.cpp}
Standard_Integer aTmpVar1; // bad Standard_Integer aTmpVar1; // bad
Standard_Integer aTmpVar2 = 0; // OK Standard_Integer aTmpVar2 = 0; // OK
~~~~~ ~~~~
Uninitialized variables might be kept only within performance-sensitive code blocks and only when their initialization is guaranteed by subsequent code. Uninitialized variables might be kept only within performance-sensitive code blocks and only when their initialization is guaranteed by subsequent code.
@ -824,12 +824,12 @@ In *operator=()* assign to all data members and check for assignment to self.
Don't check floats for equality or non-equality; check for GT, GE, LT or LE. Don't check floats for equality or non-equality; check for GT, GE, LT or LE.
~~~~~{.cpp} ~~~~{.cpp}
if (Abs (theFloat1 - theFloat2) < theTolerance) if (Abs (theFloat1 - theFloat2) < theTolerance)
{ {
DoSome(); DoSome();
} }
~~~~~ ~~~~
Package *Precision* provides standard values for SI units and widely adopted by existing modeling algorithms: Package *Precision* provides standard values for SI units and widely adopted by existing modeling algorithms:
@ -872,7 +872,7 @@ Generally, try to reduce misaligned accesses since they impact the performance (
List class data members in the constructor's initialization list in the order they are declared. List class data members in the constructor's initialization list in the order they are declared.
~~~~~{.cpp} ~~~~{.cpp}
class MyPackage_MyClass class MyPackage_MyClass
{ {
@ -892,19 +892,19 @@ private:
Standard_Integer myPropertyB; Standard_Integer myPropertyB;
}; };
~~~~~ ~~~~
### Initialization over assignment ### Initialization over assignment
Prefer initialization over assignment in class constructors. Prefer initialization over assignment in class constructors.
~~~~~{.cpp} ~~~~{.cpp}
MyPackage_MyClass() MyPackage_MyClass()
: myPropertyA (1) // preferred : myPropertyA (1) // preferred
{ {
myPropertyB = 2; // not recommended myPropertyB = 2; // not recommended
} }
~~~~~ ~~~~
### Optimize caching ### Optimize caching
@ -912,23 +912,23 @@ When programming procedures with extensive memory access, try to optimize them i
On x86 this code On x86 this code
~~~~~{.cpp} ~~~~{.cpp}
Standard_Real anArray[4096][2]; Standard_Real anArray[4096][2];
for (Standard_Integer anIter = 0; anIter < 4096; ++anIter) for (Standard_Integer anIter = 0; anIter < 4096; ++anIter)
{ {
anArray[anIter][0] = anArray[anIter][1]; anArray[anIter][0] = anArray[anIter][1];
} }
~~~~~ ~~~~
is more efficient then is more efficient then
~~~~~{.cpp} ~~~~{.cpp}
Standard_Real anArray[2][4096]; Standard_Real anArray[2][4096];
for (Standard_Integer anIter = 0; anIter < 4096; ++anIter) for (Standard_Integer anIter = 0; anIter < 4096; ++anIter)
{ {
anArray[0][anIter] = anArray[1][anIter]; anArray[0][anIter] = anArray[1][anIter];
} }
~~~~~ ~~~~
since linear access does not invalidate cache too often. since linear access does not invalidate cache too often.
@ -952,7 +952,7 @@ Command arguments should be validated before usage. The user should see a human-
Command should warn the user about unknown arguments, including cases when extra parameters have been pushed for the command with a fixed number of arguments. Command should warn the user about unknown arguments, including cases when extra parameters have been pushed for the command with a fixed number of arguments.
~~~~~{.cpp} ~~~~{.cpp}
if (theArgsNb != 3) if (theArgsNb != 3)
{ {
std::cout << "Syntax error - wrong number of arguments!\n"; std::cout << "Syntax error - wrong number of arguments!\n";
@ -971,7 +971,7 @@ Command should warn the user about unknown arguments, including cases when extra
} }
DBRep::Set (aResName, aFaceShape); DBRep::Set (aResName, aFaceShape);
return 0; return 0;
~~~~~ ~~~~
### Message printing ### Message printing
@ -984,9 +984,9 @@ Information printed into Draw Interpreter should be well-structured to allow usa
Any command with a long list of obligatory parameters should be considered as ill-formed by design. Any command with a long list of obligatory parameters should be considered as ill-formed by design.
Optional parameters should start with flag name (with '-' prefix) and followed by its values: Optional parameters should start with flag name (with '-' prefix) and followed by its values:
~~~~~{.tcl} ~~~~{.php}
myCommand -flag1 value1 value2 -flag2 value3 myCommand -flag1 value1 value2 -flag2 value3
~~~~~ ~~~~
### Arguments parser ### Arguments parser
@ -996,7 +996,7 @@ myCommand -flag1 value1 value2 -flag2 value3
Functions *Draw::Atof()* and *Draw::Atoi()* support expressions and read values in C-locale. Functions *Draw::Atof()* and *Draw::Atoi()* support expressions and read values in C-locale.
~~~~~{.cpp} ~~~~{.cpp}
Standard_Real aPosition[3] = {0.0, 0.0, 0.0}; Standard_Real aPosition[3] = {0.0, 0.0, 0.0};
for (Standard_Integer anArgIter = 1; anArgIter < theArgsNb; ++anArgIter) for (Standard_Integer anArgIter = 1; anArgIter < theArgsNb; ++anArgIter)
{ {
@ -1020,7 +1020,7 @@ Functions *Draw::Atof()* and *Draw::Atoi()* support expressions and read values
return 1; return 1;
} }
} }
~~~~~ ~~~~
@section occt_coding_rules_11 Examples @section occt_coding_rules_11 Examples
@ -1051,7 +1051,7 @@ private: //! \@name private fields
@endverbatim @endverbatim
~~~~~ ~~~~{.cpp}
#include <Package_Class.hxx> #include <Package_Class.hxx>
// ========================================================== // ==========================================================
// function : Square // function : Square
@ -1071,11 +1071,11 @@ void Package_Class::increment()
{ {
++myCounter; ++myCounter;
} }
~~~~~ ~~~~
### TCL script for Draw Harness ### TCL script for Draw Harness
~~~~~{.tcl} ~~~~{.tcl}
# show fragments (solids) in shading with different colors # show fragments (solids) in shading with different colors
proc DisplayColored {theShape} { proc DisplayColored {theShape} {
set aSolids [uplevel #0 explode $theShape so] set aSolids [uplevel #0 explode $theShape so]
@ -1106,10 +1106,10 @@ vzbufftrihedron
DisplayColored c DisplayColored c
vfit vfit
vdump $imagedir/${casename}.png 512 512 vdump $imagedir/${casename}.png 512 512
~~~~~ ~~~~
### GLSL program: ### GLSL program:
~~~~~{.fs} ~~~~{.cpp}
vec3 Ambient; //!< Ambient contribution of light sources vec3 Ambient; //!< Ambient contribution of light sources
vec3 Diffuse; //!< Diffuse contribution of light sources vec3 Diffuse; //!< Diffuse contribution of light sources
vec3 Specular; //!< Specular contribution of light sources vec3 Specular; //!< Specular contribution of light sources
@ -1149,4 +1149,4 @@ void main()
normalize (View), normalize (View),
Position); Position);
} }
~~~~~ ~~~~

44
dox/contribution/git_guide/git_guide.md
View File

@ -152,11 +152,11 @@ The official repository contains:
Make sure to configure Git so that the user name is equal to your username 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: on the OCCT development portal, and set SafeCrLf option to true:
~~~~~ ~~~~
> git config --global user.name "Your User Name" > git config --global user.name "Your User Name"
> git config --global user.email your@mail.address > git config --global user.email your@mail.address
> git config --global your@mail.address > git config --global your@mail.address
~~~~~ ~~~~
@section occt_gitguide_3 Getting access to the repository @section occt_gitguide_3 Getting access to the repository
@ -213,9 +213,9 @@ The official repository contains:
On Windows, you might need to start **Git Bash** command prompt window. On Windows, you might need to start **Git Bash** command prompt window.
Use the following command to generate SSH keys: Use the following command to generate SSH keys:
~~~~~ ~~~~
> ssh-keygen -t rsa -C "your@mail.address" > 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 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.
@ -290,9 +290,9 @@ Click **Save** to input the key to the system.
* From command line by command: * From command line by command:
~~~~~ ~~~~
> git clone gitolite@git.dev.opencascade.org:occt <path> > git clone gitolite@git.dev.opencascade.org:occt <path>
~~~~~ ~~~~
where <i>\<path\></i> is the path to the new folder which will be created for the repository. where <i>\<path\></i> is the path to the new folder which will be created for the repository.
@ -314,9 +314,9 @@ Click **Save** to input the key to the system.
In the console: In the console:
~~~~~ ~~~~
> git checkout -b CR12345 origin/master > git checkout -b CR12345 origin/master
~~~~~ ~~~~
In TortoiseGit: In TortoiseGit:
* Go to the local copy of the repository. * Go to the local copy of the repository.
@ -332,9 +332,9 @@ In TortoiseGit:
If you need to switch to another branch, use Git command checkout for that. If you need to switch to another branch, use Git command checkout for that.
In the console: In the console:
~~~~~ ~~~~
> git checkout CR12345 > git checkout CR12345
~~~~~ ~~~~
In TortoiseGit: right-click in the explorer window and select in the context menu **TortoiseGit** -> **Switch/Checkout**. In TortoiseGit: right-click in the explorer window and select in the context menu **TortoiseGit** -> **Switch/Checkout**.
@ -351,11 +351,11 @@ In TortoiseGit:
* In the console: * In the console:
~~~~~ ~~~~
> git diff > git diff
… …
> git commit -a -m "Write meaningful commit message here" > git commit -a -m "Write meaningful commit message here"
~~~~~ ~~~~
Option -a tells the command to automatically include (stage) files 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. that have been modified or deleted, but it will omit the new files that might have been added by you.
@ -363,12 +363,12 @@ In TortoiseGit:
To find new unstaged files and them to commit, use commands: To find new unstaged files and them to commit, use commands:
~~~~~ ~~~~
> git status -s > git status -s
?? file1.hxx ?? file1.hxx
?? file2.cxx ?? file2.cxx
> git add file1.hxx file2.cxx > git add file1.hxx file2.cxx
~~~~~ ~~~~
* In TortoiseGit: right-click in the explorer window and select in the context menu <b>Git Commit -> CR…</b>: * In TortoiseGit: right-click in the explorer window and select in the context menu <b>Git Commit -> CR…</b>:
@ -384,9 +384,9 @@ In TortoiseGit:
* In the console: * In the console:
~~~~~ ~~~~
> git push "origin" CR12345:CR12345 > git push "origin" CR12345:CR12345
~~~~~ ~~~~
* In TortoiseGit: right-click in the explorer window and select in the context menu, TortoiseGit -> **Push** * In TortoiseGit: right-click in the explorer window and select in the context menu, TortoiseGit -> **Push**
@ -410,9 +410,9 @@ Note that Git forbids pushing a branch if the corresponding remote branch alread
Use Git command *fetch* with option *prune* to get the update of all branches from the remote repository and to clean your local repository from the remote branches that have been deleted. Use Git command *fetch* with option *prune* to get the 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: * In the console:
~~~~~ ~~~~
> git fetch --prune > git fetch --prune
~~~~~ ~~~~
* In TortoiseGit: right-click in the explorer window and select in the context menu **TortoiseGit** -> **Fetch**. Check in **Prune** check-box. * In TortoiseGit: right-click in the explorer window and select in the context menu **TortoiseGit** -> **Fetch**. Check in **Prune** check-box.
@ -423,9 +423,9 @@ Note that Git forbids pushing a branch if the corresponding remote branch alread
This operation is required in particular to update your local master branch when the remote master changes. This operation is required in particular to update your local master branch when the remote master changes.
* In console: * In console:
~~~~~ ~~~~
> git pull > git pull
~~~~~ ~~~~
* In TortoiseGit: right-click in the explorer window and select in the context menu **TortoiseGit** -> **Pull**. * In TortoiseGit: right-click in the explorer window and select in the context menu **TortoiseGit** -> **Pull**.
@ -436,9 +436,9 @@ Note that the local branches of your repository are the primary place, where you
Remove the local branches that you do not need any more. Note that you cannot delete the current branch. It means that you need to switch to another one (e.g. master) if the branch you are going to delete is the current one. Remove the local branches that you do not need any more. Note that you cannot delete the current branch. It means that 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: * In the console:
~~~~~ ~~~~
> git branch -d CR12345 > git branch -d CR12345
~~~~~ ~~~~
* In TortoiseGit: right-click in the explorer window and select in the context menu **TortoiseGit** -> **Git Show Log**. * In TortoiseGit: right-click in the explorer window and select in the context menu **TortoiseGit** -> **Git Show Log**.

292
dox/contribution/tests/tests.md
View File

@ -51,9 +51,9 @@ For this it is recommended to add a file *DrawAppliInit* in the directory which
Example (Windows) Example (Windows)
~~~~~{.tcl} ~~~~{.php}
set env(CSF_TestDataPath) $env(CSF_TestDataPath)\;d:/occt/test-data set env(CSF_TestDataPath) $env(CSF_TestDataPath)\;d:/occt/test-data
~~~~~ ~~~~
Note that variable *CSF_TestDataPath* is set to default value at DRAW start, pointing at the folder <i>$CASROOT/data</i>. Note that variable *CSF_TestDataPath* is set to default value at DRAW start, pointing at the folder <i>$CASROOT/data</i>.
In this example, subdirectory <i>d:/occt/test-data</i> is added to this path. Similar code could be used on Linux and Mac OS X except that on non-Windows platforms colon ":" should be used as path separator instead of semicolon ";". In this example, subdirectory <i>d:/occt/test-data</i> is added to this path. Similar code could be used on Linux and Mac OS X except that on non-Windows platforms colon ":" should be used as path separator instead of semicolon ";".
@ -66,18 +66,18 @@ To run all tests, type command *testgrid*
Example: Example:
~~~~~ ~~~~{.php}
Draw[]> testgrid Draw[]> testgrid
~~~~~ ~~~~
To run only a subset of test cases, give masks for group, grid, and test case names to be executed. To run only a subset of test cases, give masks for group, grid, and test case names to be executed.
Each argument is a list of file masks separated with commas or spaces; by default "*" is assumed. Each argument is a list of file masks separated with commas or spaces; by default "*" is assumed.
Example: Example:
~~~~~ ~~~~{.php}
Draw[]> testgrid bugs caf,moddata*,xde Draw[]> testgrid bugs caf,moddata*,xde
~~~~~ ~~~~
As the tests progress, the result of each test case is reported. As the tests progress, the result of each test case is reported.
At the end of the log a summary of test cases is output, At the end of the log a summary of test cases is output,
@ -86,7 +86,7 @@ including the list of detected regressions and improvements, if any.
Example: Example:
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.tcl} ~~~~{.php}
Tests summary Tests summary
CASE 3rdparty export A1: OK CASE 3rdparty export A1: OK
@ -97,7 +97,7 @@ Example:
Total cases: 208 BAD, 31 SKIPPED, 3 IMPROVEMENT, 1791 OK Total cases: 208 BAD, 31 SKIPPED, 3 IMPROVEMENT, 1791 OK
Elapsed time: 1 Hours 14 Minutes 33.7384512019 Seconds Elapsed time: 1 Hours 14 Minutes 33.7384512019 Seconds
Detailed logs are saved in D:/occt/results_2012-06-04T0919 Detailed logs are saved in D:/occt/results_2012-06-04T0919
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~
The tests are considered as non-regressive if only OK, BAD (i.e. known problem), and SKIPPED (i.e. not executed, typically because of lack of a data file) statuses are reported. See @ref testmanual_details_results "Interpretation of test results" for details. The tests are considered as non-regressive if only OK, BAD (i.e. known problem), and SKIPPED (i.e. not executed, typically because of lack of a data file) statuses are reported. See @ref testmanual_details_results "Interpretation of test results" for details.
@ -105,22 +105,22 @@ The results and detailed logs of the tests are saved by default to a new subdire
If necessary, a non-default output directory can be specified using option <i> -outdir</i> followed by a path to the directory. This directory should be new or empty; use option <i>-overwrite</i> to allow writing results in the existing non-empty directory. If necessary, a non-default output directory can be specified using option <i> -outdir</i> followed by a path to the directory. This directory should be new or empty; use option <i>-overwrite</i> to allow writing results in the existing non-empty directory.
Example: Example:
~~~~~ ~~~~{.php}
Draw[]> testgrid -outdir d:/occt/last_results -overwrite Draw[]> testgrid -outdir d:/occt/last_results -overwrite
~~~~~ ~~~~
In the output directory, a cumulative HTML report <i>summary.html</i> provides links to reports on each test case. An additional report in JUnit-style XML format can be output for use in Jenkins or other continuous integration system. In the output directory, a cumulative HTML report <i>summary.html</i> provides links to reports on each test case. An additional report in JUnit-style XML format can be output for use in Jenkins or other continuous integration system.
To re-run the test cases, which were detected as regressions on the previous run, option <i>-regress dirname</i> should be used. To re-run the test cases, which were detected as regressions on the previous run, option <i>-regress dirname</i> should be used.
<i>dirname</i> is a path to the directory containing the results of the previous run. Only the test cases with *FAILED* and *IMPROVEMENT* statuses will be tested. <i>dirname</i> is a path to the directory containing the results of the previous run. Only the test cases with *FAILED* and *IMPROVEMENT* statuses will be tested.
Example: Example:
~~~~~ ~~~~{.php}
Draw[]> testgrid -regress d:/occt/last_results Draw[]> testgrid -regress d:/occt/last_results
~~~~~ ~~~~
Type <i>help testgrid</i> in DRAW prompt to get help on options supported by *testgrid* command: Type <i>help testgrid</i> in DRAW prompt to get help on options supported by *testgrid* command:
~~~~~ ~~~~{.php}
Draw[3]> help testgrid Draw[3]> help testgrid
testgrid: Run all tests, or specified group, or one grid testgrid: Run all tests, or specified group, or one grid
Use: testgrid [groupmask [gridmask [casemask]]] [options...] Use: testgrid [groupmask [gridmask [casemask]]] [options...]
@ -135,7 +135,7 @@ testgrid: Run all tests, or specified group, or one grid
Here "dirname" is a path to the directory containing the results of the previous run. Here "dirname" is a path to the directory containing the results of the previous run.
Groups, grids, and test cases to be executed can be specified by the list of file Groups, grids, and test cases to be executed can be specified by the list of file
masks separated by spaces or commas; default is all (*). masks separated by spaces or commas; default is all (*).
~~~~~ ~~~~
@subsubsection testmanual_1_3_3 Running a Single Test @subsubsection testmanual_1_3_3 Running a Single Test
@ -143,11 +143,11 @@ To run a single test, type command *test* followed by names of group, grid, and
Example: Example:
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.tcl} ~~~~{.php}
Draw[1]> test blend simple A1 Draw[1]> test blend simple A1
CASE blend simple A1: OK CASE blend simple A1: OK
Draw[2]> Draw[2]>
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~
Note that normally an intermediate output of the script is not shown. The detailed log of the test can be obtained after the test execution by running command <i>"dlog get"</i>. Note that normally an intermediate output of the script is not shown. The detailed log of the test can be obtained after the test execution by running command <i>"dlog get"</i>.
@ -156,7 +156,7 @@ To see intermediate commands and their output during the test execution, add one
Type <i>help test</i> in DRAW prompt to get help on options supported by *test* command: Type <i>help test</i> in DRAW prompt to get help on options supported by *test* command:
~~~~~ ~~~~{.php}
Draw[3]> help test Draw[3]> help test
test: Run specified test case test: Run specified test case
Use: test group grid casename [options...] Use: test group grid casename [options...]
@ -174,7 +174,7 @@ test: Run specified test case
-beep: play sound signal at the end of the test -beep: play sound signal at the end of the test
-errors: show all lines from the log report that are recognized as errors -errors: show all lines from the log report that are recognized as errors
This key will be ignored if the "-echo" key is already set. This key will be ignored if the "-echo" key is already set.
~~~~~ ~~~~
@subsubsection testmanual_intro_quick_create Creating a New Test @subsubsection testmanual_intro_quick_create Creating a New Test
@ -203,29 +203,29 @@ Example:
* Added files: * Added files:
~~~~~ ~~~~{.php}
git status -short git status -short
A tests/bugs/heal/data/bug210_a.brep A tests/bugs/heal/data/bug210_a.brep
A tests/bugs/heal/data/bug210_b.brep A tests/bugs/heal/data/bug210_b.brep
A tests/bugs/heal/bug210_1 A tests/bugs/heal/bug210_1
A tests/bugs/heal/bug210_2 A tests/bugs/heal/bug210_2
~~~~~ ~~~~
* Test script * Test script
~~~~~{.tcl} ~~~~{.php}
puts "OCC210 (case 1): Improve FixShape for touching wires" puts "OCC210 (case 1): Improve FixShape for touching wires"
restore [locate_data_file bug210_a.brep] a restore [locate_data_file bug210_a.brep] a
fixshape result a 0.01 0.01 fixshape result a 0.01 0.01
checkshape result checkshape result
~~~~~ ~~~~
DRAW command *testfile* should be used to check the data files used by the test for possible duplication of content or names. DRAW command *testfile* should be used to check the data files used by the test for possible duplication of content or names.
The command accepts the list of paths to files to be checked (as a single argument) and gives a conclusion on each of the files, for instance: The command accepts the list of paths to files to be checked (as a single argument) and gives a conclusion on each of the files, for instance:
~~~~~ ~~~~{.php}
Draw[1]> testfile [glob /my/data/path/bug12345*] Draw[1]> testfile [glob /my/data/path/bug12345*]
Collecting info on test data files repository... Collecting info on test data files repository...
Checking new file(s)... Checking new file(s)...
@ -247,7 +247,7 @@ Checking new file(s)...
* /my/data/path/case_8_wire4.brep: error * /my/data/path/case_8_wire4.brep: error
name is already used by existing file name is already used by existing file
--> //server/occt_tests_data/public/brep/case_8_wire4.brep --> //server/occt_tests_data/public/brep/case_8_wire4.brep
~~~~~ ~~~~
@section testmanual_2 Organization of Test Scripts @section testmanual_2 Organization of Test Scripts
@ -284,11 +284,11 @@ The names of directories of test groups containing systematic test grids corresp
Example: Example:
~~~~~ ~~~~
caf caf
mesh mesh
offset offset
~~~~~ ~~~~
Test group *bugs* is used to collect the tests coming from bug reports. Group *demo* collects tests of the test system, DRAW, samples, etc. Test group *bugs* is used to collect the tests coming from bug reports. Group *demo* collects tests of the test system, DRAW, samples, etc.
@ -296,19 +296,19 @@ Test group *bugs* is used to collect the tests coming from bug reports. Group *d
This test group contains file *grids.list*, which defines an ordered list of grids in this group in the following format: This test group contains file *grids.list*, which defines an ordered list of grids in this group in the following format:
~~~~~~~~~~~~~~~~~ ~~~~
001 gridname1 001 gridname1
002 gridname2 002 gridname2
... ...
NNN gridnameN NNN gridnameN
~~~~~~~~~~~~~~~~~ ~~~~
Example: Example:
~~~~~~~~~~~~~~~~~ ~~~~
001 basic 001 basic
002 advanced 002 advanced
~~~~~~~~~~~~~~~~~ ~~~~
@subsubsection testmanual_2_2_3 File "begin" @subsubsection testmanual_2_2_3 File "begin"
@ -318,10 +318,10 @@ additional Tcl functions used in test scripts.
Example: Example:
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.tcl} ~~~~{.php}
pload TOPTEST ;# load topological command pload TOPTEST ;# load topological command
set cpulimit 300 ;# set maximum time allowed for script execution set cpulimit 300 ;# set maximum time allowed for script execution
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~
@subsubsection testmanual_2_2_4 File "end" @subsubsection testmanual_2_2_4 File "end"
@ -332,14 +332,14 @@ Note: *TEST COMPLETED* string should be present in the output to indicate that t
See @ref testmanual_3 "Creation and modification of tests" chapter for more information. See @ref testmanual_3 "Creation and modification of tests" chapter for more information.
Example: Example:
~~~~~ ~~~~{.php}
if { [isdraw result] } { if { [isdraw result] } {
checkshape result checkshape result
} else { } else {
puts "Error: The result shape can not be built" puts "Error: The result shape can not be built"
} }
puts "TEST COMPLETED" puts "TEST COMPLETED"
~~~~~ ~~~~
@subsubsection testmanual_2_2_5 File "parse.rules" @subsubsection testmanual_2_2_5 File "parse.rules"
@ -353,12 +353,12 @@ The rest of the line can contain a comment message, which will be added to the t
Example: Example:
~~~~~ ~~~~
FAILED /\b[Ee]xception\b/ exception FAILED /\b[Ee]xception\b/ exception
FAILED /\bError\b/ error FAILED /\bError\b/ error
SKIPPED /Cannot open file for reading/ data file is missing SKIPPED /Cannot open file for reading/ data file is missing
SKIPPED /Could not read file .*, abandon/ data file is missing SKIPPED /Could not read file .*, abandon/ data file is missing
~~~~~ ~~~~
Lines starting with a *#* character and blank lines are ignored to allow comments and spacing. Lines starting with a *#* character and blank lines are ignored to allow comments and spacing.
@ -368,11 +368,11 @@ If a line matches several rules, the first one applies. Rules defined in the gri
Example: Example:
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.tcl} ~~~~
FAILED /\\bFaulty\\b/ bad shape FAILED /\\bFaulty\\b/ bad shape
IGNORE /^Error [23]d = [\d.-]+/ debug output of blend command IGNORE /^Error [23]d = [\d.-]+/ debug output of blend command
IGNORE /^Tcl Exception: tolerance ang : [\d.-]+/ blend failure IGNORE /^Tcl Exception: tolerance ang : [\d.-]+/ blend failure
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~
@subsubsection testmanual_2_2_6 Directory "data" @subsubsection testmanual_2_2_6 Directory "data"
The test group may contain subdirectory *data*, where test scripts shared by different test grids can be put. See also @ref testmanual_2_3_5 "Directory data". The test group may contain subdirectory *data*, where test scripts shared by different test grids can be put. See also @ref testmanual_2_3_5 "Directory data".
@ -386,12 +386,12 @@ Each directory contains a set of related test cases. The name of a directory sho
Example: Example:
~~~~~ ~~~~
caf caf
basic basic
bugs bugs
presentation presentation
~~~~~ ~~~~
Here *caf* is the name of the test group and *basic*, *bugs*, *presentation*, etc. are the names of grids. Here *caf* is the name of the test group and *basic*, *bugs*, *presentation*, etc. are the names of grids.
@ -403,9 +403,9 @@ Usually it sets variables specific for the current grid.
Example: Example:
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.tcl} ~~~~{.php}
set command bopfuse ;# command tested in this grid set command bopfuse ;# command tested in this grid
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~
@subsubsection testmanual_2_3_3 File "end" @subsubsection testmanual_2_3_3 File "end"
@ -415,9 +415,9 @@ Usually it executes a specific sequence of commands common for all tests in the
Example: Example:
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.tcl} ~~~~{.php}
vdump $imagedir/${casename}.png ;# makes a snap-shot of AIS viewer vdump $imagedir/${casename}.png ;# makes a snap-shot of AIS viewer
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~
@subsubsection testmanual_2_3_4 File "cases.list" @subsubsection testmanual_2_3_4 File "cases.list"
@ -427,9 +427,9 @@ This file should contain a single line defining the relative path to the collect
Example: Example:
~~~~~ ~~~~
../data/simple ../data/simple
~~~~~ ~~~~
This option is used for creation of several grids of tests with the same data files and operations but performed with differing parameters. The common scripts are usually located place in the common This option is used for creation of several grids of tests with the same data files and operations but performed with differing parameters. The common scripts are usually located place in the common
subdirectory of the test group, <i>data/simple</i> for example. subdirectory of the test group, <i>data/simple</i> for example.
@ -450,25 +450,25 @@ and produces meaningful messages that can be used to check the validity of the r
Example: Example:
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.tcl} ~~~~{.php}
pcylinder c1 10 20 ;# create first cylinder pcylinder c1 10 20 ;# create first cylinder
pcylinder c2 5 20 ;# create second cylinder pcylinder c2 5 20 ;# create second cylinder
ttranslate c2 5 0 10 ;# translate second cylinder to x,y,z ttranslate c2 5 0 10 ;# translate second cylinder to x,y,z
bsection result c1 c2 ;# create a section of two cylinders bsection result c1 c2 ;# create a section of two cylinders
checksection result ;# will output error message if result is bad checksection result ;# will output error message if result is bad
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~
The test case can have any name (except for the reserved names *begin, end, data, cases.list* and *parse.rules*). The test case can have any name (except for the reserved names *begin, end, data, cases.list* and *parse.rules*).
For systematic grids it is usually a capital English letter followed by a number. For systematic grids it is usually a capital English letter followed by a number.
Example: Example:
~~~~~ ~~~~
A1 A1
A2 A2
B1 B1
B2 B2
~~~~~ ~~~~
Such naming facilitates compact representation of tests execution results in tabular format within HTML reports. Such naming facilitates compact representation of tests execution results in tabular format within HTML reports.
@ -488,11 +488,11 @@ The test case name in the bugs group should be prefixed by the ID of the corresp
Example: Example:
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.tcl} ~~~~
bug12345_coaxial bug12345_coaxial
bug12345_orthogonal_1 bug12345_orthogonal_1
bug12345_orthogonal_2 bug12345_orthogonal_2
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~
If the new test corresponds to a functionality already covered by the existing systematic test grid (e.g. group *mesh* for *BRepMesh* issues), this test can be added (or moved later by OCC team) to that grid. If the new test corresponds to a functionality already covered by the existing systematic test grid (e.g. group *mesh* for *BRepMesh* issues), this test can be added (or moved later by OCC team) to that grid.
@ -526,32 +526,32 @@ The test should run commands necessary to perform the tested operations, in gene
Usually the script represents a set of commands that a person would run interactively to perform the operation and see its results, with additional comments to explain what happens. Usually the script represents a set of commands that a person would run interactively to perform the operation and see its results, with additional comments to explain what happens.
Example: Example:
~~~~~ ~~~~{.php}
# Simple test of fusing box and sphere # Simple test of fusing box and sphere
box b 10 10 10 box b 10 10 10
sphere s 5 sphere s 5
bfuse result b s bfuse result b s
checkshape result checkshape result
~~~~~ ~~~~
Make sure that file *parse.rules* in the grid or group directory contains a regular expression to catch possible messages indicating the failure of the test. Make sure that file *parse.rules* in the grid or group directory contains a regular expression to catch possible messages indicating the failure of the test.
For instance, for catching errors reported by *checkshape* command relevant grids define a rule to recognize its report by the word *Faulty*: For instance, for catching errors reported by *checkshape* command relevant grids define a rule to recognize its report by the word *Faulty*:
~~~~~ ~~~~
FAILED /\bFaulty\b/ bad shape FAILED /\bFaulty\b/ bad shape
~~~~~ ~~~~
For the messages generated in the script it is recommended to use the word 'Error' in the error message. For the messages generated in the script it is recommended to use the word 'Error' in the error message.
Example: Example:
~~~~~ ~~~~{.php}
set expected_length 11 set expected_length 11
if { [expr $actual_length - $expected_length] > 0.001 } { if { [expr $actual_length - $expected_length] > 0.001 } {
puts "Error: The length of the edge should be $expected_length" puts "Error: The length of the edge should be $expected_length"
} }
~~~~~ ~~~~
At the end, the test script should output *TEST COMPLETED* string to mark a successful completion of the script. This is often done by the *end* script in the grid. At the end, the test script should output *TEST COMPLETED* string to mark a successful completion of the script. This is often done by the *end* script in the grid.
@ -571,9 +571,9 @@ During execution of the test, location of such data file can be constructed usin
Example: Example:
~~~~~ ~~~~{.php}
checkresult $result $::dirname/$::groupname/$::gridname/data/${::casename}.txt checkresult $result $::dirname/$::groupname/$::gridname/data/${::casename}.txt
~~~~~ ~~~~
CAD models and other data files which are not going to change over time should be stored separately from the source repository. CAD models and other data files which are not going to change over time should be stored separately from the source repository.
Use Tcl procedure *locate_data_file* to get a path to such data files, instead of coding the path explicitly. Use Tcl procedure *locate_data_file* to get a path to such data files, instead of coding the path explicitly.
@ -583,9 +583,9 @@ If the file is not found, *locate_data_file* will raise exception, and the test
Example: Example:
~~~~~ ~~~~{.php}
stepread [locate_data_file CAROSKI_COUPELLE.step] a * stepread [locate_data_file CAROSKI_COUPELLE.step] a *
~~~~~ ~~~~
When the test needs to produce some snapshots or other artefacts, use Tcl variable *imagedir* as the location where such files should be put. When the test needs to produce some snapshots or other artefacts, use Tcl variable *imagedir* as the location where such files should be put.
* Command *testgrid* sets this variable to the subdirectory of the results folder corresponding to the grid. * Command *testgrid* sets this variable to the subdirectory of the results folder corresponding to the grid.
@ -601,20 +601,20 @@ The test system can recognize an image file (snapshot) and include it in HTML lo
The image format (defined by extension) should be *png*. The image format (defined by extension) should be *png*.
Example: Example:
~~~~~ ~~~~{.php}
xwd $::imagedir/${::casename}.png xwd $::imagedir/${::casename}.png
vdisplay result; vfit vdisplay result; vfit
vdump $::imagedir/${::casename}-axo.png vdump $::imagedir/${::casename}-axo.png
vfront; vfit vfront; vfit
vdump $::imagedir/${::casename}-front.png vdump $::imagedir/${::casename}-front.png
~~~~~ ~~~~
would produce: would produce:
~~~~~ ~~~~
A1.png A1.png
A1-axo.png A1-axo.png
A1-front.png A1-front.png
~~~~~ ~~~~
Note that OCCT must be built with FreeImage support to be able to produce usable images. Note that OCCT must be built with FreeImage support to be able to produce usable images.
@ -644,26 +644,26 @@ The new test created for an unsolved problem should return BAD. The new test cre
If the test produces an invalid result at a certain moment then the corresponding bug should be created in the OCCT issue tracker located at https://tracker.dev.opencascade.org, and the problem should be marked as TODO in the test script. If the test produces an invalid result at a certain moment then the corresponding bug should be created in the OCCT issue tracker located at https://tracker.dev.opencascade.org, and the problem should be marked as TODO in the test script.
The following statement should be added to such a test script: The following statement should be added to such a test script:
~~~~~ ~~~~{.php}
puts "TODO BugNumber ListOfPlatforms: RegularExpression" puts "TODO BugNumber ListOfPlatforms: RegularExpression"
~~~~~ ~~~~
Here: Here:
* *BugNumber* is the bug ID in the tracker. For example: #12345. * *BugNumber* is the bug ID in the tracker. For example: #12345.
* *ListOfPlatforms* is a list of platforms, at which the bug is reproduced (Linux, Windows, MacOS, or All). Note that the platform name is custom for the OCCT test system; Use procedure *checkplatform* to get the platform name. * *ListOfPlatforms* is a list of platforms, at which the bug is reproduced (Linux, Windows, MacOS, or All). Note that the platform name is custom for the OCCT test system; Use procedure *checkplatform* to get the platform name.
Example: Example:
~~~~~ ~~~~{.php}
Draw[2]> checkplatform Draw[2]> checkplatform
Windows Windows
~~~~~ ~~~~
* RegularExpression is a regular expression, which should be matched against the line indicating the problem in the script output. * RegularExpression is a regular expression, which should be matched against the line indicating the problem in the script output.
Example: Example:
~~~~~ ~~~~{.php}
puts "TODO #22622 Mandriva2008: Abort .* an exception was raised" puts "TODO #22622 Mandriva2008: Abort .* an exception was raised"
~~~~~ ~~~~
The parser checks the test output and if an output line matches the *RegularExpression* then it will be assigned a BAD status instead of FAILED. The parser checks the test output and if an output line matches the *RegularExpression* then it will be assigned a BAD status instead of FAILED.
@ -673,29 +673,29 @@ To mark the test as BAD for an incomplete case (when the final *TEST COMPLETE* m
Example: Example:
~~~~~ ~~~~{.php}
puts "TODO OCC22817 All: exception.+There are no suitable edges" puts "TODO OCC22817 All: exception.+There are no suitable edges"
puts "TODO OCC22817 All: \\*\\* Exception \\*\\*" puts "TODO OCC22817 All: \\*\\* Exception \\*\\*"
puts "TODO OCC22817 All: TEST INCOMPLETE" puts "TODO OCC22817 All: TEST INCOMPLETE"
~~~~~ ~~~~
@subsection testmanual_3_7 Marking required output @subsection testmanual_3_7 Marking required output
To check the obtained test output matches the expected results considered correct, add REQUIRED statement for each specific message. To check the obtained test output matches the expected results considered correct, add REQUIRED statement for each specific message.
For that, the following statement should be added to the corresponding test script: For that, the following statement should be added to the corresponding test script:
~~~~~ ~~~~{.php}
puts "REQUIRED ListOfPlatforms: RegularExpression" puts "REQUIRED ListOfPlatforms: RegularExpression"
~~~~~ ~~~~
Here *ListOfPlatforms* and *RegularExpression* have the same meaning as in TODO statements described above. Here *ListOfPlatforms* and *RegularExpression* have the same meaning as in TODO statements described above.
The REQUIRED statement can also be used to mask the message that would normally be interpreted as error (according to the rules defined in *parse.rules*) but should not be considered as such within the current test. The REQUIRED statement can also be used to mask the message that would normally be interpreted as error (according to the rules defined in *parse.rules*) but should not be considered as such within the current test.
Example: Example:
~~~~~ ~~~~{.php}
puts "REQUIRED Linux: Faulty shapes in variables faulty_1 to faulty_5" puts "REQUIRED Linux: Faulty shapes in variables faulty_1 to faulty_5"
~~~~~ ~~~~
This statement notifies test system that errors reported by *checkshape* command are expected in that test case, and test should be considered as OK if this message appears, despite of presence of general rule stating that 'Faulty' signals failure. This statement notifies test system that errors reported by *checkshape* command are expected in that test case, and test should be considered as OK if this message appears, despite of presence of general rule stating that 'Faulty' signals failure.
@ -711,13 +711,13 @@ Note: in OCCT 6.5.3, file *DrawAppliInit* already exists in <i>$CASROOT/src/Draw
For example, let us assume that *d:/occt* contains an up-to-date version of OCCT sources with tests, and the test data archive is unpacked to *d:/test-data*): For example, let us assume that *d:/occt* contains an up-to-date version of OCCT sources with tests, and the test data archive is unpacked to *d:/test-data*):
~~~~~ ~~~~{.php}
set env(CASROOT) d:/occt set env(CASROOT) d:/occt
set env(CSF_TestScriptsPath) $env(CASROOT)/tests set env(CSF_TestScriptsPath) $env(CASROOT)/tests
source $env(CASROOT)/src/DrawResources/TestCommands.tcl source $env(CASROOT)/src/DrawResources/TestCommands.tcl
set env(CSF_TestDataPath) $env(CASROOT)/data;d:/test-data set env(CSF_TestDataPath) $env(CASROOT)/data;d:/test-data
return return
~~~~~ ~~~~
Note that on older versions of OCCT the tests are run in compatibility mode and thus not all output of the test command can be captured; this can lead to absence of some error messages (can be reported as either a failure or an improvement). Note that on older versions of OCCT the tests are run in compatibility mode and thus not all output of the test command can be captured; this can lead to absence of some error messages (can be reported as either a failure or an improvement).
@ -728,13 +728,13 @@ You can extend the test system by adding your own tests. For that it is necessar
Use Tcl command <i>_path_separator</i> to insert a platform-dependent separator to the path list. Use Tcl command <i>_path_separator</i> to insert a platform-dependent separator to the path list.
For example: For example:
~~~~~ ~~~~{.php}
set env(CSF_TestScriptsPath) \ set env(CSF_TestScriptsPath) \
$env(TestScriptsPath)[_path_separator]d:/MyOCCTProject/tests $env(TestScriptsPath)[_path_separator]d:/MyOCCTProject/tests
set env(CSF_TestDataPath) \ set env(CSF_TestDataPath) \
d:/occt/test-data[_path_separator]d:/MyOCCTProject/data d:/occt/test-data[_path_separator]d:/MyOCCTProject/data
return ;# this is to avoid an echo of the last command above in cout return ;# this is to avoid an echo of the last command above in cout
~~~~~ ~~~~
@subsection testmanual_4_3 Parallel execution of tests @subsection testmanual_4_3 Parallel execution of tests
@ -749,9 +749,9 @@ Some test results are very dependent on the characteristics of the workstation,
OCCT test system provides a dedicated command *testdiff* for comparing CPU time of execution, memory usage, and images produced by the tests. OCCT test system provides a dedicated command *testdiff* for comparing CPU time of execution, memory usage, and images produced by the tests.
~~~~~ ~~~~{.php}
testdiff dir1 dir2 [groupname [gridname]] [options...] testdiff dir1 dir2 [groupname [gridname]] [options...]
~~~~~ ~~~~
Here *dir1* and *dir2* are directories containing logs of two test runs. Here *dir1* and *dir2* are directories containing logs of two test runs.
Possible options are: Possible options are:
@ -771,18 +771,18 @@ Possible options are:
Example: Example:
~~~~~ ~~~~{.php}
Draw[]> testdiff results/CR12345-2012-10-10T08:00 results/master-2012-10-09T21:20 Draw[]> testdiff results/CR12345-2012-10-10T08:00 results/master-2012-10-09T21:20
~~~~~ ~~~~
Particular tests can generate additional data that need to be compared by *testdiff* command. Particular tests can generate additional data that need to be compared by *testdiff* command.
For that, for each parameter to be controlled, the test should produce the line containing keyword "COUNTER* followed by arbitrary name of the parameter, then colon and numeric value of the parameter. For that, for each parameter to be controlled, the test should produce the line containing keyword "COUNTER* followed by arbitrary name of the parameter, then colon and numeric value of the parameter.
Example of test code: Example of test code:
~~~~~ ~~~~{.php}
puts "COUNTER Memory heap usage at step 5: [meminfo h]" puts "COUNTER Memory heap usage at step 5: [meminfo h]"
~~~~~ ~~~~
@section testmanual_5 APPENDIX @section testmanual_5 APPENDIX
@ -1106,50 +1106,50 @@ This group allows testing extended data exchange packages.
Run command *checkshape* on the result (or intermediate) shape and make sure that *parse.rules* of the test grid or group reports bad shapes (usually recognized by word "Faulty") as error. Run command *checkshape* on the result (or intermediate) shape and make sure that *parse.rules* of the test grid or group reports bad shapes (usually recognized by word "Faulty") as error.
Example Example
~~~~~ ~~~~{.php}
checkshape result checkshape result
~~~~~ ~~~~
To check the number of faults in the shape command *checkfaults* can be used. To check the number of faults in the shape command *checkfaults* can be used.
Use: checkfaults shape source_shape [ref_value=0] Use: checkfaults shape source_shape [ref_value=0]
The default syntax of *checkfaults* command: The default syntax of *checkfaults* command:
~~~~~ ~~~~{.php}
checkfaults results a_1 checkfaults results a_1
~~~~~ ~~~~
The command will check the number of faults in the source shape (*a_1*) and compare it The command will check the number of faults in the source shape (*a_1*) and compare it
with number of faults in the resulting shape (*result*). If shape *result* contains with number of faults in the resulting shape (*result*). If shape *result* contains
more faults, you will get an error: more faults, you will get an error:
~~~~~ ~~~~{.php}
checkfaults results a_1 checkfaults results a_1
Error : Number of faults is 5 Error : Number of faults is 5
~~~~~ ~~~~
It is possible to set the reference value for comparison (reference value is 4): It is possible to set the reference value for comparison (reference value is 4):
~~~~~ ~~~~{.php}
checkfaults results a_1 4 checkfaults results a_1 4
~~~~~ ~~~~
If number of faults in the resulting shape is unstable, reference value should be set to "-1". If number of faults in the resulting shape is unstable, reference value should be set to "-1".
As a result command *checkfaults* will return the following error: As a result command *checkfaults* will return the following error:
~~~~~ ~~~~{.php}
checkfaults results a_1 -1 checkfaults results a_1 -1
Error : Number of faults is UNSTABLE Error : Number of faults is UNSTABLE
~~~~~ ~~~~
@subsubsection testmanual_5_3_2 Shape tolerance @subsubsection testmanual_5_3_2 Shape tolerance
The maximal tolerance of sub-shapes of each kind of the resulting shape can be extracted from output of tolerance command as follows: The maximal tolerance of sub-shapes of each kind of the resulting shape can be extracted from output of tolerance command as follows:
~~~~~ ~~~~{.php}
set tolerance [tolerance result] set tolerance [tolerance result]
regexp { *FACE +: +MAX=([-0-9.+eE]+)} $tolerance dummy max_face regexp { *FACE +: +MAX=([-0-9.+eE]+)} $tolerance dummy max_face
regexp { *EDGE +: +MAX=([-0-9.+eE]+)} $tolerance dummy max_edgee regexp { *EDGE +: +MAX=([-0-9.+eE]+)} $tolerance dummy max_edgee
regexp { *VERTEX +: +MAX=([-0-9.+eE]+)} $tolerance dummy max_vertex regexp { *VERTEX +: +MAX=([-0-9.+eE]+)} $tolerance dummy max_vertex
~~~~~ ~~~~
It is possible to use command *checkmaxtol* to check maximal tolerance of shape and compare it with reference value. It is possible to use command *checkmaxtol* to check maximal tolerance of shape and compare it with reference value.
@ -1162,39 +1162,39 @@ Allowed options are:
* <i>-multi_tol</i> -- tolerance multiplier. * <i>-multi_tol</i> -- tolerance multiplier.
The default syntax of *checkmaxtol* command for comparison with the reference value: The default syntax of *checkmaxtol* command for comparison with the reference value:
~~~~~ ~~~~{.php}
checkmaxtol result -ref 0.00001 checkmaxtol result -ref 0.00001
~~~~~ ~~~~
There is an opportunity to compare max tolerance of resulting shape with max tolerance of source shape. There is an opportunity to compare max tolerance of resulting shape with max tolerance of source shape.
In the following example command *checkmaxtol* gets max tolerance among objects *a_1* and *a_2*. In the following example command *checkmaxtol* gets max tolerance among objects *a_1* and *a_2*.
Then it chooses the maximum value between founded tolerance and value -min_tol (0.000001) Then it chooses the maximum value between founded tolerance and value -min_tol (0.000001)
and multiply it on the coefficient -multi_tol (i.e. 2): and multiply it on the coefficient -multi_tol (i.e. 2):
~~~~~ ~~~~{.php}
checkmaxtol result -source {a_1 a_2} -min_tol 0.000001 -multi_tol 2 checkmaxtol result -source {a_1 a_2} -min_tol 0.000001 -multi_tol 2
~~~~~ ~~~~
If the value of maximum tolerance more than founded tolerance for comparison, the command will return an error. If the value of maximum tolerance more than founded tolerance for comparison, the command will return an error.
Also, command *checkmaxtol* can be used to get max tolerance of the shape: Also, command *checkmaxtol* can be used to get max tolerance of the shape:
~~~~~ ~~~~{.php}
set maxtol [checkmaxtol result] set maxtol [checkmaxtol result]
~~~~~ ~~~~
@subsubsection testmanual_5_3_3 Shape volume, area, or length @subsubsection testmanual_5_3_3 Shape volume, area, or length
Use command *vprops, sprops,* or *lprops* to correspondingly measure volume, area, or length of the shape produced by the test. The value can be extracted from the result of the command by *regexp*. Use command *vprops, sprops,* or *lprops* to correspondingly measure volume, area, or length of the shape produced by the test. The value can be extracted from the result of the command by *regexp*.
Example: Example:
~~~~~ ~~~~{.php}
# check area of shape result with 1% tolerance # check area of shape result with 1% tolerance
regexp {Mass +: +([-0-9.+eE]+)} [sprops result] dummy area regexp {Mass +: +([-0-9.+eE]+)} [sprops result] dummy area
if { abs($area - $expected) > 0.1 + 0.01 * abs ($area) } { if { abs($area - $expected) > 0.1 + 0.01 * abs ($area) } {
puts "Error: The area of result shape is $area, while expected $expected" puts "Error: The area of result shape is $area, while expected $expected"
} }
~~~~~ ~~~~
@subsubsection testmanual_5_3_4 Memory leaks @subsubsection testmanual_5_3_4 Memory leaks
@ -1204,7 +1204,7 @@ To check memory leak on a particular operation, run it in a cycle, measure the m
The command *checktrend* (defined in *tests/bugs/begin*) can be used to analyze a sequence of memory measurements and to get a statistically based evaluation of the leak presence. The command *checktrend* (defined in *tests/bugs/begin*) can be used to analyze a sequence of memory measurements and to get a statistically based evaluation of the leak presence.
Example: Example:
~~~~~ ~~~~{.php}
set listmem {} set listmem {}
for {set i 1} {$i < 100} {incr i} { for {set i 1} {$i < 100} {incr i} {
# run suspect operation # run suspect operation
@ -1216,13 +1216,13 @@ for {set i 1} {$i < 100} {incr i} {
break break
} }
} }
~~~~~ ~~~~
@subsubsection testmanual_5_3_5 Visualization @subsubsection testmanual_5_3_5 Visualization
The following command sequence allows you to take a snapshot of the viewer, give it the name of the test case, and save in the directory indicated by Tcl variable *imagedir*. The following command sequence allows you to take a snapshot of the viewer, give it the name of the test case, and save in the directory indicated by Tcl variable *imagedir*.
~~~~~ ~~~~{.php}
vinit vinit
vclear vclear
vdisplay result vdisplay result
@ -1230,7 +1230,7 @@ vsetdispmode 1
vfit vfit
vzfit vzfit
vdump $imagedir/${casename}_shading.png vdump $imagedir/${casename}_shading.png
~~~~~ ~~~~
This image will be included in the HTML log produced by *testgrid* command and will be checked for non-regression through comparison of images by command *testdiff*. This image will be included in the HTML log produced by *testgrid* command and will be checked for non-regression through comparison of images by command *testdiff*.
@ -1256,21 +1256,21 @@ Allowed options are:
Note that is required to use either option <i> -2d </i> or option <i> -3d</i>. Note that is required to use either option <i> -2d </i> or option <i> -3d</i>.
Examples: Examples:
~~~~~ ~~~~{.php}
checkview -display result -2d -path ${imagedir}/${test_image}.png checkview -display result -2d -path ${imagedir}/${test_image}.png
checkview -display result -3d -path ${imagedir}/${test_image}.png checkview -display result -3d -path ${imagedir}/${test_image}.png
checkview -display result_2d -2d v2d -path ${imagedir}/${test_image}.png checkview -display result_2d -2d v2d -path ${imagedir}/${test_image}.png
~~~~~ ~~~~
~~~~~ ~~~~{.php}
box a 10 10 10 box a 10 10 10
box b 5 5 5 10 10 10 box b 5 5 5 10 10 10
bcut result b a bcut result b a
set result_vertices [explode result v] set result_vertices [explode result v]
checkview -display result -2d -with ${result_vertices} -otherwise { a b } -l -path ${imagedir}/${test_image}.png checkview -display result -2d -with ${result_vertices} -otherwise { a b } -l -path ${imagedir}/${test_image}.png
~~~~~ ~~~~
~~~~~ ~~~~{.php}
box a 10 10 10 box a 10 10 10
box b 5 5 5 10 10 10 box b 5 5 5 10 10 10
bcut result b a bcut result b a
@ -1278,7 +1278,7 @@ vinit
vdisplay a b vdisplay a b
vfit vfit
checkview -screenshot -3d -path ${imagedir}/${test_image}.png checkview -screenshot -3d -path ${imagedir}/${test_image}.png
~~~~~ ~~~~
@subsubsection testmanual_5_3_6 Number of free edges @subsubsection testmanual_5_3_6 Number of free edges
@ -1290,9 +1290,9 @@ Allowed options are:
* <i>-tol N</i> -- used tolerance (default -0.01); * <i>-tol N</i> -- used tolerance (default -0.01);
* <i>-type N</i> -- used type, possible values are "closed" and "opened" (default "closed"). * <i>-type N</i> -- used type, possible values are "closed" and "opened" (default "closed").
~~~~~ ~~~~{.php}
checkfreebounds result 13 checkfreebounds result 13
~~~~~ ~~~~
Option <i>-tol N</i> defines tolerance for command *freebounds*, which is used within command *checkfreebounds*. Option <i>-tol N</i> defines tolerance for command *freebounds*, which is used within command *checkfreebounds*.
@ -1301,10 +1301,10 @@ Option <i>-type N</i> is used to select the type of counted free edges: closed o
If the number of free edges in the resulting shape is unstable, the reference value should be set to "-1". If the number of free edges in the resulting shape is unstable, the reference value should be set to "-1".
As a result command *checkfreebounds* will return the following error: As a result command *checkfreebounds* will return the following error:
~~~~~ ~~~~{.php}
checkfreebounds result -1 checkfreebounds result -1
Error : Number of free edges is UNSTABLE Error : Number of free edges is UNSTABLE
~~~~~ ~~~~
@subsubsection testmanual_5_3_7 Compare numbers @subsubsection testmanual_5_3_7 Compare numbers
@ -1312,9 +1312,9 @@ Procedure *checkreal* checks the equality of two reals with a tolerance (relativ
Use: checkreal name value expected tol_abs tol_rel Use: checkreal name value expected tol_abs tol_rel
~~~~~ ~~~~{.php}
checkreal "Some important value" $value 5 0.0001 0.01 checkreal "Some important value" $value 5 0.0001 0.01
~~~~~ ~~~~
@subsubsection testmanual_5_3_8 Check number of sub-shapes @subsubsection testmanual_5_3_8 Check number of sub-shapes
@ -1336,9 +1336,9 @@ Allowed options are:
the same sub-shapes with different location as different sub-shapes. the same sub-shapes with different location as different sub-shapes.
* <i>-m msg</i> -- prints "msg" in case of error * <i>-m msg</i> -- prints "msg" in case of error
~~~~~ ~~~~{.php}
checknbshapes result -vertex 8 -edge 4 checknbshapes result -vertex 8 -edge 4
~~~~~ ~~~~
@subsubsection testmanual_5_3_9 Check pixel color @subsubsection testmanual_5_3_9 Check pixel color
@ -1354,9 +1354,9 @@ This procedure checks color with tolerance (5x5 area).
Next example will compare color of point with coordinates x=100 y=100 with RGB color R=1 G=0 B=0. Next example will compare color of point with coordinates x=100 y=100 with RGB color R=1 G=0 B=0.
If colors are not equal, procedure will check the nearest ones points (5x5 area) If colors are not equal, procedure will check the nearest ones points (5x5 area)
~~~~~ ~~~~{.php}
checkcolor 100 100 1 0 0 checkcolor 100 100 1 0 0
~~~~~ ~~~~
@subsubsection testmanual_5_3_10 Compute length, area and volume of input shape @subsubsection testmanual_5_3_10 Compute length, area and volume of input shape
@ -1375,10 +1375,10 @@ Allowed options are:
Options <i> -l, -s </i> and <i> -v</i> are independent and can be used in any order. Tolerance *epsilon* is the same for all options. Options <i> -l, -s </i> and <i> -v</i> are independent and can be used in any order. Tolerance *epsilon* is the same for all options.
~~~~~ ~~~~{.php}
checkprops result -s 6265.68 checkprops result -s 6265.68
checkprops result -s -equal FaceBrep checkprops result -s -equal FaceBrep
~~~~~ ~~~~
@subsubsection testmanual_5_3_11 Parse output dump and compare it with reference values @subsubsection testmanual_5_3_11 Parse output dump and compare it with reference values
@ -1391,9 +1391,9 @@ Allowed options are:
* <i>-ref VALUE</i> -- list of reference values for each parameter in *NAME*; * <i>-ref VALUE</i> -- list of reference values for each parameter in *NAME*;
* <i>-eps EPSILON</i> -- the epsilon defines relative precision of computation. * <i>-eps EPSILON</i> -- the epsilon defines relative precision of computation.
~~~~~ ~~~~{.php}
checkdump result -name {Center Axis XAxis YAxis Radii} -ref {{-70 0} {-1 -0} {-1 -0} {0 -1} {20 10}} -eps 0.01 checkdump result -name {Center Axis XAxis YAxis Radii} -ref {{-70 0} {-1 -0} {-1 -0} {0 -1} {20 10}} -eps 0.01
~~~~~ ~~~~
@subsubsection testmanual_5_3_12 Compute length of input curve @subsubsection testmanual_5_3_12 Compute length of input curve
@ -1407,10 +1407,10 @@ Allowed options are:
* <i>-equal CURVE</i> -- compares the length of input curves. Puts error if they are not equal; * <i>-equal CURVE</i> -- compares the length of input curves. Puts error if they are not equal;
* <i>-notequal CURVE</i> -- compares the length of input curves. Puts error if they are equal. * <i>-notequal CURVE</i> -- compares the length of input curves. Puts error if they are equal.
~~~~~ ~~~~{.php}
checklength cp1 -l 7.278 checklength cp1 -l 7.278
checklength res -l -equal ext_1 checklength res -l -equal ext_1
~~~~~ ~~~~
@subsubsection testmanual_5_3_13 Check maximum deflection, number of triangles and nodes in mesh @subsubsection testmanual_5_3_13 Check maximum deflection, number of triangles and nodes in mesh
Command *checktrinfo* can be used to to check the maximum deflection, as well as the number of nodes and triangles in mesh. Command *checktrinfo* can be used to to check the maximum deflection, as well as the number of nodes and triangles in mesh.
@ -1438,33 +1438,33 @@ Note that options <i> -tri, -nod </i> and <i> -defl </i> do not work together wi
Examples: Examples:
Comparison with some reference values: Comparison with some reference values:
~~~~~ ~~~~{.php}
checktrinfo result -tri 129 -nod 131 -defl 0.01 checktrinfo result -tri 129 -nod 131 -defl 0.01
~~~~~ ~~~~
Comparison with another mesh: Comparison with another mesh:
~~~~~ ~~~~{.php}
checktrinfo result -ref [tringo a] checktrinfo result -ref [tringo a]
~~~~~ ~~~~
Comparison of deflection with the max possible value: Comparison of deflection with the max possible value:
~~~~~ ~~~~{.php}
checktrinfo result -max_defl 1 checktrinfo result -max_defl 1
~~~~~ ~~~~
Check that the current values are not equal to zero: Check that the current values are not equal to zero:
~~~~~ ~~~~{.php}
checktrinfo result -tri -nod -defl checktrinfo result -tri -nod -defl
~~~~~ ~~~~
Check that the number of triangles and the number of nodes are not equal to some specific values: Check that the number of triangles and the number of nodes are not equal to some specific values:
~~~~~ ~~~~{.php}
checktrinfo result -tri !10 -nod !8 checktrinfo result -tri !10 -nod !8
~~~~~ ~~~~
It is possible to compare current values with reference values with some tolerances. It is possible to compare current values with reference values with some tolerances.
Use options <i>-tol_\* </i> for that. Use options <i>-tol_\* </i> for that.
~~~~~ ~~~~{.php}
checktrinfo result -defl 1 -tol_abs_defl 0.001 checktrinfo result -defl 1 -tol_abs_defl 0.001
~~~~~ ~~~~

65
dox/debug/debug.md
View File

@ -49,34 +49,34 @@ Open CASCADE Test Harness or @ref occt_user_guides__test_harness "DRAW" provides
In some cases the objects to be inspected are available in DRAW as results of DRAW commands. In other cases, however, it is necessary to inspect intermediate objects created by the debugged algorithm. To support this, DRAW provides a set of commands allowing the developer to store intermediate objects directly from the debugger stopped at some point during the program execution (usually at a breakpoint). In some cases the objects to be inspected are available in DRAW as results of DRAW commands. In other cases, however, it is necessary to inspect intermediate objects created by the debugged algorithm. To support this, DRAW provides a set of commands allowing the developer to store intermediate objects directly from the debugger stopped at some point during the program execution (usually at a breakpoint).
~~~~~ ~~~~{.php}
const char* Draw_Eval (const char *theCommandStr) const char* Draw_Eval (const char *theCommandStr)
~~~~~ ~~~~
Evaluates a DRAW command or script. Evaluates a DRAW command or script.
A command is passed as a string parameter. A command is passed as a string parameter.
~~~~~ ~~~~{.php}
const char* DBRep_Set (const char* theNameStr, void* theShapePtr) const char* DBRep_Set (const char* theNameStr, void* theShapePtr)
~~~~~ ~~~~
Sets the specified shape as a value of DRAW interpreter variable with the given name. Sets the specified shape as a value of DRAW interpreter variable with the given name.
- *theNameStr* -- the DRAW interpreter variable name to set. - *theNameStr* -- the DRAW interpreter variable name to set.
- *theShapePtr* -- a pointer to *TopoDS_Shape* variable. - *theShapePtr* -- a pointer to *TopoDS_Shape* variable.
~~~~~ ~~~~{.php}
const char* DBRep_SetComp (const char* theNameStr, void* theListPtr) const char* DBRep_SetComp (const char* theNameStr, void* theListPtr)
~~~~~ ~~~~
Makes a compound from the specified list of shapes and sets it as a value of DRAW interpreter variable with the given name. Makes a compound from the specified list of shapes and sets it as a value of DRAW interpreter variable with the given name.
- *theNameStr* -- the DRAW interpreter variable name to set. - *theNameStr* -- the DRAW interpreter variable name to set.
- *theListPtr* -- a pointer to *TopTools_ListOfShape* variable. - *theListPtr* -- a pointer to *TopTools_ListOfShape* variable.
~~~~~ ~~~~{.php}
const char* DrawTrSurf_Set (const char* theNameStr, void* theHandlePtr) const char* DrawTrSurf_Set (const char* theNameStr, void* theHandlePtr)
const char* DrawTrSurf_SetPnt (const char* theNameStr, void* thePntPtr) const char* DrawTrSurf_SetPnt (const char* theNameStr, void* thePntPtr)
const char* DrawTrSurf_SetPnt2d (const char* theNameStr, void* thePnt2dPtr) const char* DrawTrSurf_SetPnt2d (const char* theNameStr, void* thePnt2dPtr)
~~~~~ ~~~~
Sets the specified geometric object as a value of DRAW interpreter variable with the given name. Sets the specified geometric object as a value of DRAW interpreter variable with the given name.
- *theNameStr* -- the DRAW interpreter variable name to set. - *theNameStr* -- the DRAW interpreter variable name to set.
@ -90,27 +90,27 @@ All these functions are defined in *TKDraw* toolkit and return a string indicati
The following functions are provided by *TKBRep* toolkit and can be used from debugger prompt: The following functions are provided by *TKBRep* toolkit and can be used from debugger prompt:
~~~~~ ~~~~{.php}
const char* BRepTools_Write (const char* theFileNameStr, void* theShapePtr) const char* BRepTools_Write (const char* theFileNameStr, void* theShapePtr)
~~~~~ ~~~~
Saves the specified shape to a file with the given name. Saves the specified shape to a file with the given name.
- *theFileNameStr* -- the name of the file where the shape is saved. - *theFileNameStr* -- the name of the file where the shape is saved.
- *theShapePtr* -- a pointer to *TopoDS_Shape* variable. - *theShapePtr* -- a pointer to *TopoDS_Shape* variable.
~~~~~ ~~~~{.php}
const char* BRepTools_Dump (void* theShapePtr) const char* BRepTools_Dump (void* theShapePtr)
const char* BRepTools_DumpLoc (void* theShapePtr) const char* BRepTools_DumpLoc (void* theShapePtr)
~~~~~ ~~~~
Dumps shape or its location to cout. Dumps shape or its location to cout.
- *theShapePtr* -- a pointer to *TopoDS_Shape* variable. - *theShapePtr* -- a pointer to *TopoDS_Shape* variable.
The following function is provided by *TKMesh* toolkit: The following function is provided by *TKMesh* toolkit:
~~~~~ ~~~~{.php}
const char* BRepMesh_Dump (void* theMeshHandlePtr, const char* theFileNameStr) const char* BRepMesh_Dump (void* theMeshHandlePtr, const char* theFileNameStr)
~~~~~ ~~~~
Stores mesh produced in parametric space to BREP file. Stores mesh produced in parametric space to BREP file.
- *theMeshHandlePtr* -- a pointer to *Handle(BRepMesh_DataStructureOfDelaun)* variable. - *theMeshHandlePtr* -- a pointer to *Handle(BRepMesh_DataStructureOfDelaun)* variable.
@ -118,10 +118,10 @@ Stores mesh produced in parametric space to BREP file.
The following functions are provided by *TKTopTest* toolkit: The following functions are provided by *TKTopTest* toolkit:
~~~~~ ~~~~{.php}
const char* MeshTest_DrawLinks(const char* theNameStr, void* theFaceAttr) const char* MeshTest_DrawLinks(const char* theNameStr, void* theFaceAttr)
const char* MeshTest_DrawTriangles(const char* theNameStr, void* theFaceAttr) const char* MeshTest_DrawTriangles(const char* theNameStr, void* theFaceAttr)
~~~~~ ~~~~
Sets the edges or triangles from mesh data structure of type *Handle(BRepMesh_FaceAttribute)* as DRAW interpreter variables, assigning a unique name in the form "<theNameStr>_<index>" to each object. Sets the edges or triangles from mesh data structure of type *Handle(BRepMesh_FaceAttribute)* as DRAW interpreter variables, assigning a unique name in the form "<theNameStr>_<index>" to each object.
- *theNameStr* -- the prefix to use in names of objects. - *theNameStr* -- the prefix to use in names of objects.
@ -129,9 +129,9 @@ Sets the edges or triangles from mesh data structure of type *Handle(BRepMesh_Fa
The following additional function is provided by *TKGeomBase* toolkit: The following additional function is provided by *TKGeomBase* toolkit:
~~~~~ ~~~~{.php}
const char* GeomTools_Dump (void* theHandlePtr) const char* GeomTools_Dump (void* theHandlePtr)
~~~~~ ~~~~
Dump geometric object to cout. Dump geometric object to cout.
- *theHandlePtr* -- a pointer to the geometric variable (<i>Handle</i> to *Geom_Geometry* or *Geom2d_Curve* or descendant) to be set. - *theHandlePtr* -- a pointer to the geometric variable (<i>Handle</i> to *Geom_Geometry* or *Geom2d_Curve* or descendant) to be set.
@ -174,7 +174,7 @@ It is implemented in 'vaspect' and 'boundingbox' commands.
Json output for Bnd_OBB (using command 'bounding v -obb -dumpJson'): Json output for Bnd_OBB (using command 'bounding v -obb -dumpJson'):
~~~~~ ~~~~{.java}
"Bnd_OBB": { "Bnd_OBB": {
"Center": { "Center": {
"gp_XYZ": [1, 2, 3] "gp_XYZ": [1, 2, 3]
@ -193,7 +193,7 @@ Json output for Bnd_OBB (using command 'bounding v -obb -dumpJson'):
"HDims[2]": 0, "HDims[2]": 0,
"IsAABox": 1, "IsAABox": 1,
} }
~~~~~ ~~~~
@section occt_debug_vstudio Using Visual Studio debugger @section occt_debug_vstudio Using Visual Studio debugger
@ -206,18 +206,18 @@ When the execution is interrupted by a breakpoint, you can use this window to ca
For example, assume that you are debugging a function, where local variable *TopoDS_Edge* *anEdge1* is of interest. For example, assume that you are debugging a function, where local variable *TopoDS_Edge* *anEdge1* is of interest.
The following set of commands in the Command window will save this edge to file *edge1.brep*, then put it to DRAW variable *e1* and show it maximized in the axonometric DRAW view: The following set of commands in the Command window will save this edge to file *edge1.brep*, then put it to DRAW variable *e1* and show it maximized in the axonometric DRAW view:
~~~~~ ~~~~{.php}
>? ({,,TKBRep.dll}BRepTools_Write)("d:/edge1.brep",(void*)&anEdge1) >? ({,,TKBRep.dll}BRepTools_Write)("d:/edge1.brep",(void*)&anEdge1)
0x04a2f234 "d:/edge1.brep" 0x04a2f234 "d:/edge1.brep"
>? ({,,TKDraw.dll}DBRep_Set)("e1",(void*)&anEdge1) >? ({,,TKDraw.dll}DBRep_Set)("e1",(void*)&anEdge1)
0x0369eba8 "e1" 0x0369eba8 "e1"
>? ({,,TKDraw.dll}Draw_Eval)("donly e1; axo; fit") >? ({,,TKDraw.dll}Draw_Eval)("donly e1; axo; fit")
0x029a48f0 "" 0x029a48f0 ""
~~~~~ ~~~~
For convenience it is possible to define aliases to commands in this window, for instance (here ">" is prompt provided by the command window; in the Immediate window this symbol should be entered manually): For convenience it is possible to define aliases to commands in this window, for instance (here ">" is prompt provided by the command window; in the Immediate window this symbol should be entered manually):
~~~~~ ~~~~{.php}
>alias deval ? ({,,TKDraw}Draw_Eval) >alias deval ? ({,,TKDraw}Draw_Eval)
>alias dsetshape ? ({,,TKDraw}DBRep_Set) >alias dsetshape ? ({,,TKDraw}DBRep_Set)
>alias dsetcomp ? ({,,TKDraw}DBRep_SetComp) >alias dsetcomp ? ({,,TKDraw}DBRep_SetComp)
@ -229,18 +229,18 @@ For convenience it is possible to define aliases to commands in this window, for
>alias dumploc ? ({,,TKBRep}BRepTools_DumpLoc) >alias dumploc ? ({,,TKBRep}BRepTools_DumpLoc)
>alias dumpmesh ? ({,,TKMesh}BRepMesh_Dump) >alias dumpmesh ? ({,,TKMesh}BRepMesh_Dump)
>alias dumpgeom ? ({,,TKGeomBase}GeomTools_Dump) >alias dumpgeom ? ({,,TKGeomBase}GeomTools_Dump)
~~~~~ ~~~~
Note that aliases are stored in the Visual Studio user's preferences and it is sufficient to define them once on a workstation. With these aliases, the above example can be reproduced easier (note the space symbol after alias name!): Note that aliases are stored in the Visual Studio user's preferences and it is sufficient to define them once on a workstation. With these aliases, the above example can be reproduced easier (note the space symbol after alias name!):
~~~~~ ~~~~{.php}
>saveshape ("d:/edge1.brep",(void*)&anEdge1) >saveshape ("d:/edge1.brep",(void*)&anEdge1)
0x04a2f234 "d:/edge1.brep" 0x04a2f234 "d:/edge1.brep"
>dsetshape ("e1",(void*)&anEdge1) >dsetshape ("e1",(void*)&anEdge1)
0x0369eba8 "e1" 0x0369eba8 "e1"
>deval ("donly e1; axo; fit") >deval ("donly e1; axo; fit")
0x029a48f0 "" 0x029a48f0 ""
~~~~~ ~~~~
Note that there is no guarantee that the call will succeed and will not affect the program execution, thus use this feature at your own risk. In particular, the commands interacting with window system (such as *axo*, *vinit*, etc.) are known to cause application crash when the program is built in 64-bit mode. To avoid this, it is recommended to prepare all necessary view windows in advance, and arrange these windows to avoid overlapping with the Visual Studio window, to ensure that they are visible during debug. Note that there is no guarantee that the call will succeed and will not affect the program execution, thus use this feature at your own risk. In particular, the commands interacting with window system (such as *axo*, *vinit*, etc.) are known to cause application crash when the program is built in 64-bit mode. To avoid this, it is recommended to prepare all necessary view windows in advance, and arrange these windows to avoid overlapping with the Visual Studio window, to ensure that they are visible during debug.
@ -252,7 +252,7 @@ In Visual Studio 2005-2010 the rules for this display are defined in file *autoe
### \[AutoExpand\] section ### \[AutoExpand\] section
~~~~~ ~~~~{.cpp}
; Open CASCADE classes ; Open CASCADE classes
Standard_Transient=<,t> count=<count,d> Standard_Transient=<,t> count=<count,d>
Handle_Standard_Transient=<entity,x> count=<entity->count,d> <,t> Handle_Standard_Transient=<entity,x> count=<entity->count,d> <,t>
@ -274,11 +274,11 @@ gp_Dir2d=<coord.x,g>, <coord.y,g>
gp_Vec2d=<coord.x,g>, <coord.y,g> gp_Vec2d=<coord.x,g>, <coord.y,g>
gp_Mat2d={<matrix[0][0],g>,<matrix[0][1],g>}, {<matrix[1][0],g>,<matrix[1][1],g>} gp_Mat2d={<matrix[0][0],g>,<matrix[0][1],g>}, {<matrix[1][0],g>,<matrix[1][1],g>}
gp_Ax1=loc={<loc.coord.x,g>, <loc.coord.y,g>, <loc.coord.z,g>} vdir={<vdir.coord.x,g>, <vdir.coord.y,g>, <vdir.coord.z,g>} gp_Ax1=loc={<loc.coord.x,g>, <loc.coord.y,g>, <loc.coord.z,g>} vdir={<vdir.coord.x,g>, <vdir.coord.y,g>, <vdir.coord.z,g>}
~~~~~ ~~~~
### \[Visualizer\] section ### \[Visualizer\] section
~~~~~ ~~~~{.cpp}
; Open CASCADE classes ; Open CASCADE classes
NCollection_Handle<*> { NCollection_Handle<*> {
@ -342,7 +342,7 @@ Handle_TCollection_HAsciiString {
#array( expr: ((TCollection_HAsciiString*)$e.entity)->myString.mystring[$i], #array( expr: ((TCollection_HAsciiString*)$e.entity)->myString.mystring[$i],
size: ((TCollection_HAsciiString*)$e.entity)->myString.mylength) ) ) size: ((TCollection_HAsciiString*)$e.entity)->myString.mylength) ) )
} }
~~~~~ ~~~~
In Visual Studio 2012 and later, visualizers can be put in a separate file in subdirectory *Visualizers*. See file *occt.natvis* for example. In Visual Studio 2012 and later, visualizers can be put in a separate file in subdirectory *Visualizers*. See file *occt.natvis* for example.
@ -403,7 +403,10 @@ Example of configuration steps for Ubuntu:
7. Run DRAW and perform tests as usual, keeping in mind that running with sanitizer is much heavier than normal build: 7. Run DRAW and perform tests as usual, keeping in mind that running with sanitizer is much heavier than normal build:
> ./draw.sh relwithdeb <br> > ./draw.sh relwithdeb <br>
> Draw[]> testgrid -parallel 0
~~~~{.php}
Draw[]> testgrid -parallel 0
~~~~
Note that when running tests under sanitizers, behavior may be different. Note that when running tests under sanitizers, behavior may be different.
Known problems (as of CLang 6.0) are: Known problems (as of CLang 6.0) are:

2
dox/introduction/introduction.md
View File

@ -380,7 +380,7 @@ https://www.opencascade.com/content/3rd-party-components
| Component | Requirement | | Component | Requirement |
| --------- | ----------- | | --------- | ----------- |
| Minimum memory | 512 MB, 1 GB recommended | | Minimum memory | 512 MB, 1 GB recommended |
| Free disk space (complete installation) | 600 MB approx. | | Free disk space (complete installation) | 1,5 GB approx. |
On desktop, 3D viewer for optimal performance requires graphics processing unit (GPU) supporting OpenGL 3.3 or above. On desktop, 3D viewer for optimal performance requires graphics processing unit (GPU) supporting OpenGL 3.3 or above.
Ray tracing requires OpenGL 4.0+ or OpenGL 3.3+ with *GL_ARB_texture_buffer_object_rgb32* extension. Ray tracing requires OpenGL 4.0+ or OpenGL 3.3+ with *GL_ARB_texture_buffer_object_rgb32* extension.

8
dox/samples/ocaf.md
View File

@ -128,7 +128,7 @@ ad696002-5b34-11d1-b5ba-00a0c9064368.Location: PAppStdPlugin
## Implementation of Attribute Transformation in a HXX file ## Implementation of Attribute Transformation in a HXX file
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.cpp} ~~~~
\#include <TDF_Attribute.hxx> \#include <TDF_Attribute.hxx>
\#include <gp_Ax3.hxx> \#include <gp_Ax3.hxx>
@ -223,11 +223,11 @@ private:
gp_Pnt myFirstPoint; gp_Pnt myFirstPoint;
gp_Pnt mySecondPoint; gp_Pnt mySecondPoint;
}; };
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~
## Implementation of Attribute Transformation in a CPP file ## Implementation of Attribute Transformation in a CPP file
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.cpp} ~~~~{.cpp}
\#include <MyPackage_Transformation.hxx> \#include <MyPackage_Transformation.hxx>
//======================================================================= //=======================================================================
@ -526,7 +526,7 @@ Standard_OStream& MyPackage_Transformation::Dump(Standard_OStream& anOS) const
MyPackage_Transformation::MyPackage_Transformation():myType(gp_Identity){ MyPackage_Transformation::MyPackage_Transformation():myType(gp_Identity){
} }
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~
## Implementation of typical actions with standard OCAF attributes. ## Implementation of typical actions with standard OCAF attributes.

8
dox/samples/ocaf_func.md
View File

@ -160,7 +160,7 @@ drivers for a function driver table with the help of *TFunction_DriverTable* cl
This is an example of the code for iteration and execution of functions. This is an example of the code for iteration and execution of functions.
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.cpp} ~~~~{.cpp}
// The scope of functions is defined. // The scope of functions is defined.
Handle(TFunction_Scope) scope = TFunction_Scope::Set( anyLabel ); Handle(TFunction_Scope) scope = TFunction_Scope::Set( anyLabel );
@ -200,14 +200,14 @@ drivers for a function driver table with the help of *TFunction_DriverTable* cl
} // end of iteration of current functions } // end of iteration of current functions
} // end of iteration of functions. } // end of iteration of functions.
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~
### Example 2: Cylinder function driver ### Example 2: Cylinder function driver
This is an example of the code for a cylinder function driver. To make the things clearer, the methods This is an example of the code for a cylinder function driver. To make the things clearer, the methods
<i>\::Arguments()</i> and <i>\::Results()</i> from the base class are also mentioned. <i>\::Arguments()</i> and <i>\::Results()</i> from the base class are also mentioned.
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.cpp} ~~~~{.cpp}
// A virtual method ::Arguments() returns a list of arguments of the function. // A virtual method ::Arguments() returns a list of arguments of the function.
CylinderDriver::Arguments( TDF_LabelList&amp; args ) CylinderDriver::Arguments( TDF_LabelList&amp; args )
@ -283,4 +283,4 @@ drivers for a function driver table with the help of *TFunction_DriverTable* cl
return 0; return 0;
} }
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~

90
dox/specification/boolean_operations/boolean_operations.md
View File

@ -811,7 +811,7 @@ The following example illustrates how to use the GF algorithm:
#### Usage of the GF algorithm on C++ level #### Usage of the GF algorithm on C++ level
~~~~ ~~~~{.cpp}
BOPAlgo_Builder aBuilder; BOPAlgo_Builder aBuilder;
// Setting arguments // Setting arguments
TopTools_ListOfShape aLSObjects = …; // Objects TopTools_ListOfShape aLSObjects = …; // Objects
@ -865,7 +865,7 @@ const TopoDS_Shape& aResult = aBuilder.Shape();
#### Usage of the GF algorithm on Tcl level #### Usage of the GF algorithm on Tcl level
~~~~ ~~~~{.cpp}
# prepare the arguments # prepare the arguments
box b1 10 10 10 box b1 10 10 10
box b2 3 4 5 10 10 10 box b2 3 4 5 10 10 10
@ -1199,7 +1199,7 @@ It is based on the General Fuse algorithm, thus all options of the General Fuse
@subsubsection specification__boolean_8_3_1 API @subsubsection specification__boolean_8_3_1 API
On the low level the Splitter algorithm is implemented in class *BOPAlgo_Splitter*. The usage of this algorithm looks as follows: On the low level the Splitter algorithm is implemented in class *BOPAlgo_Splitter*. The usage of this algorithm looks as follows:
~~~~~ ~~~~{.cpp}
BOPAlgo_Splitter aSplitter; BOPAlgo_Splitter aSplitter;
// Setting arguments and tools // Setting arguments and tools
TopTools_ListOfShape aLSObjects = …; // Objects TopTools_ListOfShape aLSObjects = …; // Objects
@ -1218,12 +1218,12 @@ if (aSplitter.HasErrors()) { //check error status
} }
// //
const TopoDS_Shape& aResult = aSplitter.Shape(); // result of the operation const TopoDS_Shape& aResult = aSplitter.Shape(); // result of the operation
~~~~~ ~~~~
@subsubsection specification__boolean_8_3_2 DRAW @subsubsection specification__boolean_8_3_2 DRAW
The command *bsplit* implements the Splitter algorithm in DRAW. Similarly to the *bbuild* command for the General Fuse algorithm, the *bsplit* command should be used after the Pave Filler is filled. The command *bsplit* implements the Splitter algorithm in DRAW. Similarly to the *bbuild* command for the General Fuse algorithm, the *bsplit* command should be used after the Pave Filler is filled.
~~~~~ ~~~~{.cpp}
# s1 s2 s3 - objects # s1 s2 s3 - objects
# t1 t2 t3 - tools # t1 t2 t3 - tools
bclearobjects bclearobjects
@ -1232,7 +1232,7 @@ baddobjects s1 s2 s3
baddtools t1 t2 t3 baddtools t1 t2 t3
bfillds bfillds
bsplit result bsplit result
~~~~~ ~~~~
@subsection specification__boolean_8_4 Examples @subsection specification__boolean_8_4 Examples
@ -1240,7 +1240,7 @@ bsplit result
Splitting a face by the set of edges: Splitting a face by the set of edges:
~~~~ ~~~~{.cpp}
# draw script for reproducing # draw script for reproducing
bclearobjects bclearobjects
bcleartools bcleartools
@ -1286,7 +1286,7 @@ bsplit result
Splitting a plate by the set of cylinders: Splitting a plate by the set of cylinders:
~~~~ ~~~~{.cpp}
# draw script for reproducing: # draw script for reproducing:
bclearobjects bclearobjects
bcleartools bcleartools
@ -2182,7 +2182,7 @@ This option is useful e.g. for building a solid from the faces of one shell or f
#### C++ Level #### C++ Level
The usage of the algorithm on the API level: The usage of the algorithm on the API level:
~~~~ ~~~~{.cpp}
BOPAlgo_MakerVolume aMV; BOPAlgo_MakerVolume aMV;
// Set the arguments // Set the arguments
TopTools_ListOfShape aLS = …; // arguments TopTools_ListOfShape aLS = …; // arguments
@ -2206,7 +2206,7 @@ const TopoDS_Shape& aResult = aMV.Shape(); // result of the operation
#### Tcl Level #### Tcl Level
To use the algorithm in Draw the command mkvolume has been implemented. The usage of this command is following: To use the algorithm in Draw the command mkvolume has been implemented. The usage of this command is following:
~~~~ ~~~~{.php}
Usage: mkvolume r b1 b2 ... [-c] [-ni] [-ai] Usage: mkvolume r b1 b2 ... [-c] [-ni] [-ai]
Options: Options:
-c - use this option to have input compounds considered as set of separate arguments (allows passing multiple arguments as one compound); -c - use this option to have input compounds considered as set of separate arguments (allows passing multiple arguments as one compound);
@ -2309,7 +2309,7 @@ aResult = aCBuilder.Shape(); // the result
#### DRAW usage #### DRAW usage
The following set of new commands has been implemented to run the algorithm in DRAW Test Harness: The following set of new commands has been implemented to run the algorithm in DRAW Test Harness:
~~~~ ~~~~{.php}
bcbuild : Initialization of the Cells Builder. Use: *bcbuild r* bcbuild : Initialization of the Cells Builder. Use: *bcbuild r*
bcadd : Add parts to result. Use: *bcadd r s1 (0,1) s2 (0,1) ... [-m material [-u]]* bcadd : Add parts to result. Use: *bcadd r s1 (0,1) s2 (0,1) ... [-m material [-u]]*
bcaddall : Add all parts to result. Use: *bcaddall r [-m material [-u]]* bcaddall : Add all parts to result. Use: *bcaddall r [-m material [-u]]*
@ -2320,7 +2320,7 @@ bcmakecontainers : Make containers from the parts added to result. Use: *bcmakec
~~~~ ~~~~
Here is the example of the algorithm use on the DRAW level: Here is the example of the algorithm use on the DRAW level:
~~~~ ~~~~{.php}
psphere s1 15 psphere s1 15
psphere s2 15 psphere s2 15
psphere s3 15 psphere s3 15
@ -2343,7 +2343,7 @@ bcremoveint res
@subsection specification__boolean_10c_Cells_2 Examples @subsection specification__boolean_10c_Cells_2 Examples
The following simple example illustrates the possibilities of the algorithm working on a cylinder and a sphere intersected by a plane: The following simple example illustrates the possibilities of the algorithm working on a cylinder and a sphere intersected by a plane:
~~~~ ~~~~{.php}
pcylinder c 10 30 pcylinder c 10 30
psphere s 15 psphere s 15
ttranslate s 0 0 30 ttranslate s 0 0 30
@ -2353,7 +2353,7 @@ mkface f p -25 30 -17 17
@figure{/specification/boolean_operations/images/cells_algorithm_001.png,"Arguments",160} @figure{/specification/boolean_operations/images/cells_algorithm_001.png,"Arguments",160}
~~~~ ~~~~{.php}
bclearobjects bclearobjects
bcleartools bcleartools
baddobjects c s f baddobjects c s f
@ -2363,7 +2363,7 @@ bcbuild r
#### 1. Common for all arguments #### 1. Common for all arguments
~~~~ ~~~~{.php}
bcremoveall bcremoveall
bcadd res c 1 s 1 f 1 bcadd res c 1 s 1 f 1
~~~~ ~~~~
@ -2372,7 +2372,7 @@ bcadd res c 1 s 1 f 1
#### 2. Common between cylinder and face #### 2. Common between cylinder and face
~~~~ ~~~~{.php}
bcremoveall bcremoveall
bcadd res f 1 c 1 bcadd res f 1 c 1
~~~~ ~~~~
@ -2381,7 +2381,7 @@ bcadd res f 1 c 1
#### 3. Common between cylinder and sphere #### 3. Common between cylinder and sphere
~~~~ ~~~~{.php}
bcremoveall bcremoveall
bcadd res c 1 s 1 bcadd res c 1 s 1
~~~~ ~~~~
@ -2390,7 +2390,7 @@ bcadd res c 1 s 1
#### 4. Fuse of cylinder and sphere #### 4. Fuse of cylinder and sphere
~~~~ ~~~~{.php}
bcremoveall bcremoveall
bcadd res c 1 -m 1 bcadd res c 1 -m 1
bcadd res s 1 -m 1 bcadd res s 1 -m 1
@ -2401,7 +2401,7 @@ bcremoveint res
#### 5. Parts of the face inside solids - FUSE(COMMON(f, c), COMMON(f, s)) #### 5. Parts of the face inside solids - FUSE(COMMON(f, c), COMMON(f, s))
~~~~ ~~~~{.php}
bcremoveall bcremoveall
bcadd res f 1 s 1 -m 1 bcadd res f 1 s 1 -m 1
bcadd res f 1 c 1 -m 1 bcadd res f 1 c 1 -m 1
@ -2409,7 +2409,7 @@ bcadd res f 1 c 1 -m 1
@figure{/specification/boolean_operations/images/cells_algorithm_006_1.png,"Parts of the face inside solids",160} @figure{/specification/boolean_operations/images/cells_algorithm_006_1.png,"Parts of the face inside solids",160}
~~~~ ~~~~{.php}
bcremoveint res bcremoveint res
~~~~ ~~~~
@ -2417,7 +2417,7 @@ bcremoveint res
#### 6. Part of the face outside solids #### 6. Part of the face outside solids
~~~~ ~~~~{.php}
bcremoveall bcremoveall
bcadd res f 1 c 0 s 0 bcadd res f 1 c 0 s 0
~~~~ ~~~~
@ -2426,7 +2426,7 @@ bcadd res f 1 c 0 s 0
#### 7. Fuse operation (impossible using standard Boolean Fuse operation) #### 7. Fuse operation (impossible using standard Boolean Fuse operation)
~~~~ ~~~~{.php}
bcremoveall bcremoveall
bcadd res c 1 -m 1 bcadd res c 1 -m 1
bcadd res s 1 -m 1 bcadd res s 1 -m 1
@ -2788,7 +2788,7 @@ For setting the Gluing options in DRAW it is necessary to call the <i>bglue</i>
* 1 - for partial coincidence; * 1 - for partial coincidence;
* 2 - for full coincidence * 2 - for full coincidence
~~~~ ~~~~{.php}
bglue 1 bglue 1
~~~~ ~~~~
@ -2836,7 +2836,7 @@ To enable the safe processing mode for the operation in DRAW, it is necessary to
* 0 - default value, the safe mode is switched off; * 0 - default value, the safe mode is switched off;
* 1 - the safe mode will be switched on. * 1 - the safe mode will be switched on.
~~~~ ~~~~{.php}
bnondestructive 1 bnondestructive 1
~~~~ ~~~~
@ -2867,7 +2867,7 @@ To enable/disable the classification of the solids in DRAW, it is necessary to c
* 0 - disabling the classification; * 0 - disabling the classification;
* 1 - default value, enabling the classification. * 1 - default value, enabling the classification.
~~~~ ~~~~{.php}
bcheckinverted 0 bcheckinverted 0
~~~~ ~~~~
@ -2893,7 +2893,7 @@ aGF.SetUseOBB(Standard_True);
To enable/disable the usage of OBB in the operation in DRAW it is necessary to call the *buseobb* command with the appropriate value: To enable/disable the usage of OBB in the operation in DRAW it is necessary to call the *buseobb* command with the appropriate value:
* 0 - disabling the usage of OBB; * 0 - disabling the usage of OBB;
* 1 - enabling the usage of OBB. * 1 - enabling the usage of OBB.
~~~~ ~~~~{.php}
buseobb 1 buseobb 1
~~~~ ~~~~
@ -2919,7 +2919,7 @@ Note that messages corresponding to errors and warnings are defined in resource
These messages can be localized; for that put translated version to separate file and load it in the application by call to *Message_MsgFile::Load()* . These messages can be localized; for that put translated version to separate file and load it in the application by call to *Message_MsgFile::Load()* .
Here is the example of how to use this system: Here is the example of how to use this system:
~~~~~ ~~~~{.php}
BOPAlgo_PaveFiller aPF; BOPAlgo_PaveFiller aPF;
aPF.SetArguments(...); aPF.SetArguments(...);
aPF.Perform(); aPF.Perform();
@ -2934,12 +2934,12 @@ if (aPF.HasErrors()) {
} }
... ...
} }
~~~~~ ~~~~
DRAW commands executing Boolean operations output errors and warnings generated by these operations in textual form. DRAW commands executing Boolean operations output errors and warnings generated by these operations in textual form.
Additional option allows saving shapes for which warnings have been generated, as DRAW variables. Additional option allows saving shapes for which warnings have been generated, as DRAW variables.
To activate this option, run command *bdrawwarnshapes* with argument 1 (or with 0 to deactivate): To activate this option, run command *bdrawwarnshapes* with argument 1 (or with 0 to deactivate):
~~~~ ~~~~{.php}
bdrawwarnshapes 1 bdrawwarnshapes 1
~~~~ ~~~~
@ -2978,7 +2978,7 @@ But if the faces are fully coinciding, the result must be empty, and both faces
Example of the overlapping faces: Example of the overlapping faces:
~~~~ ~~~~{.php}
plane p 0 0 0 0 0 1 plane p 0 0 0 0 0 1
mkface f1 p -10 10 -10 10 mkface f1 p -10 10 -10 10
mkface f2 p 0 20 -10 10 mkface f2 p 0 20 -10 10
@ -3005,7 +3005,7 @@ Thus, each of the input edges will be Modified into its two splits.
But in the CUT operation on the same edges, the tool edge will be Deleted from the result and, thus, will not have any Modified shapes. But in the CUT operation on the same edges, the tool edge will be Deleted from the result and, thus, will not have any Modified shapes.
Example of the intersecting edges: Example of the intersecting edges:
~~~~ ~~~~{.php}
line l1 0 0 0 1 0 0 line l1 0 0 0 1 0 0
mkedge e1 l1 -10 10 mkedge e1 l1 -10 10
@ -3051,7 +3051,7 @@ Two intersecting edges will both have the intersection vertices Generated from t
As for the operation with intersecting faces, consider the following example: As for the operation with intersecting faces, consider the following example:
~~~~ ~~~~{.php}
plane p1 0 0 0 0 0 1 plane p1 0 0 0 0 0 1
mkface f1 p1 -10 10 -10 10 mkface f1 p1 -10 10 -10 10
@ -3115,7 +3115,7 @@ For controlling this possibility in DRAW the command **bsimplify** has been impl
Here is the simple example of simplification of the result of Fuse operation of two boxes: Here is the simple example of simplification of the result of Fuse operation of two boxes:
~~~~ ~~~~{.php}
bsimplify -f 1 bsimplify -f 1
box b1 10 10 15 box b1 10 10 15
@ -3173,7 +3173,7 @@ The following example illustrates how to use General Fuse operator:
#### C++ Level #### C++ Level
~~~~ ~~~~{.cpp}
#include <TopoDS_Shape.hxx> #include <TopoDS_Shape.hxx>
#include <TopTools_ListOfShape.hxx> #include <TopTools_ListOfShape.hxx>
#include <BRepAlgoAPI_BuilderAlgo.hxx> #include <BRepAlgoAPI_BuilderAlgo.hxx>
@ -3205,7 +3205,7 @@ The following example illustrates how to use General Fuse operator:
#### Tcl Level #### Tcl Level
~~~~ ~~~~{.php}
# prepare the arguments # prepare the arguments
box b1 10 10 10 box b1 10 10 10
box b2 3 4 5 10 10 10 box b2 3 4 5 10 10 10
@ -3231,7 +3231,7 @@ The following example illustrates how to use the Splitter operator:
#### C++ Level #### C++ Level
~~~~ ~~~~{.cpp}
#include <TopoDS_Shape.hxx> #include <TopoDS_Shape.hxx>
#include <TopTools_ListOfShape.hxx> #include <TopTools_ListOfShape.hxx>
#include <BRepAlgoAPI_Splitter.hxx> #include <BRepAlgoAPI_Splitter.hxx>
@ -3265,7 +3265,7 @@ const TopoDS_Shape& aResult = aSplitter.Shape();
#### Tcl Level #### Tcl Level
~~~~ ~~~~{.php}
# prepare the arguments # prepare the arguments
# objects # objects
box b1 10 10 10 box b1 10 10 10
@ -3297,7 +3297,7 @@ The following example illustrates how to use Common operation:
#### C++ Level #### C++ Level
~~~~ ~~~~{.cpp}
#include <TopoDS_Shape.hxx> #include <TopoDS_Shape.hxx>
#include <TopTools_ListOfShape.hxx> #include <TopTools_ListOfShape.hxx>
#include < BRepAlgoAPI_Common.hxx> #include < BRepAlgoAPI_Common.hxx>
@ -3336,7 +3336,7 @@ The following example illustrates how to use Common operation:
#### Tcl Level #### Tcl Level
~~~~ ~~~~{.php}
# prepare the arguments # prepare the arguments
box b1 10 10 10 box b1 10 10 10
box b2 7 0 4 10 10 10 box b2 7 0 4 10 10 10
@ -3364,7 +3364,7 @@ The following example illustrates how to use Fuse operation:
#### C++ Level #### C++ Level
~~~~ ~~~~{.cpp}
#include <TopoDS_Shape.hxx> #include <TopoDS_Shape.hxx>
#include <TopTools_ListOfShape.hxx> #include <TopTools_ListOfShape.hxx>
#include < BRepAlgoAPI_Fuse.hxx> #include < BRepAlgoAPI_Fuse.hxx>
@ -3403,7 +3403,7 @@ The following example illustrates how to use Fuse operation:
#### Tcl Level #### Tcl Level
~~~~ ~~~~{.php}
# prepare the arguments # prepare the arguments
box b1 10 10 10 box b1 10 10 10
box b2 7 0 4 10 10 10 box b2 7 0 4 10 10 10
@ -3431,7 +3431,7 @@ The following example illustrates how to use Cut operation:
#### C++ Level #### C++ Level
~~~~ ~~~~{.cpp}
#include <TopoDS_Shape.hxx> #include <TopoDS_Shape.hxx>
#include <TopTools_ListOfShape.hxx> #include <TopTools_ListOfShape.hxx>
#include < BRepAlgoAPI_Cut.hxx> #include < BRepAlgoAPI_Cut.hxx>
@ -3470,7 +3470,7 @@ The following example illustrates how to use Cut operation:
#### Tcl Level #### Tcl Level
~~~~ ~~~~{.php}
# prepare the arguments # prepare the arguments
box b1 10 10 10 box b1 10 10 10
box b2 7 0 4 10 10 10 box b2 7 0 4 10 10 10
@ -3499,7 +3499,7 @@ The following example illustrates how to use Section operation:
#### C++ Level #### C++ Level
~~~~ ~~~~{.cpp}
#include <TopoDS_Shape.hxx> #include <TopoDS_Shape.hxx>
#include <TopTools_ListOfShape.hxx> #include <TopTools_ListOfShape.hxx>
#include < BRepAlgoAPI_Section.hxx> #include < BRepAlgoAPI_Section.hxx>
@ -3538,7 +3538,7 @@ The following example illustrates how to use Section operation:
#### Tcl Level #### Tcl Level
~~~~ ~~~~{.php}
# prepare the arguments # prepare the arguments
box b1 10 10 10 box b1 10 10 10
box b2 3 4 5 10 10 10 box b2 3 4 5 10 10 10

28
dox/specification/brep_format.md
View File

@ -35,12 +35,12 @@ Each of these methods has two arguments:
The following sample code reads a shape from ASCII file and writes it to a binary one: The following sample code reads a shape from ASCII file and writes it to a binary one:
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.cpp} ~~~~{.cpp}
TopoDS_Shape aShape; TopoDS_Shape aShape;
if (BRepTools::Read (aShape, "source_file.txt")) { if (BRepTools::Read (aShape, "source_file.txt")) {
BinTools::Write (aShape, "result_file.bin"); BinTools::Write (aShape, "result_file.bin");
} }
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~
@section specification__brep_format_3 Format Common Structure @section specification__brep_format_3 Format Common Structure
@ -250,7 +250,7 @@ The example record is interpreted as a line which passes through a point *P*=(1
**BNF-like Definition** **BNF-like Definition**
~~~~ ~~~~{.cpp}
<3D curve record 2> = "2" <_> <3D circle center> <_> <3D circle N> <_> <3D circle Dx> <_> <3D circle Dy> <_> <3D circle radius> <_\n>; <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 center> = <3D point>;
@ -283,7 +283,7 @@ The example record is interpreted as a circle which has its center *P*=(1, 2, 3
**BNF-like Definition** **BNF-like Definition**
~~~~ ~~~~{.cpp}
<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 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 center> = <3D point>;
@ -318,7 +318,7 @@ The example record is interpreted as an ellipse which has its center *P*=(1, 2,
**BNF-like Definition** **BNF-like Definition**
~~~~ ~~~~{.cpp}
<3D curve record 4> = "4" <_> <3D parabola origin> <_> <3D parabola N> <_> <3D parabola Dx> <_> <3D parabola Dy> <_> <3D parabola focal length> <_\n>; <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 origin> = <3D point>;
@ -352,7 +352,7 @@ The example record is interpreted as a parabola in plane which passes through a
**BNF-like Definition** **BNF-like Definition**
~~~~ ~~~~{.cpp}
<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 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 origin> = <3D point>;
@ -428,7 +428,7 @@ The example record is interpreted as a Bezier curve with a rational flag *r*=1,
**BNF-like Definition** **BNF-like Definition**
~~~~ ~~~~{.cpp}
<3D curve record 7> = "7" <_> <3D B-spline rational flag> <_> "0" <_> <3D B-spline degree> <_> <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> <3D B-spline pole count> <_> <3D B-spline multiplicity knot count> <3D B-spline weight poles>
<_\n> <3D B-spline multiplicity knots> <_\n>; <_\n> <3D B-spline multiplicity knots> <_\n>;
@ -492,7 +492,7 @@ The example record is interpreted as a B-spline curve with a rational flag *r*=
**BNF-like Definition** **BNF-like Definition**
~~~~ ~~~~{.cpp}
<3D curve record 8> = "8" <_> <3D trimmed curve u min> <_> <3D trimmed curve u max> <_\n> <3D curve record>; <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 min> = <real>;
@ -764,7 +764,7 @@ where @f$ V(v)=(5,2,0)+4 \cdot (cos(v) \cdot (1,0,0)+sin(v) \cdot (0,1,0)), V_{D
**BNF-like Definition** **BNF-like Definition**
~~~~ ~~~~{.cpp}
<surface record 8> = "8" <_> <Bezier surface u rational flag> <_> <Bezier surface v rational flag> <_> <Bezier surface u degree> <_> <Bezier surface v degree> <_> <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 weight poles>;
@ -1076,7 +1076,7 @@ The example record is interpreted as a line which passes through a point *P*=(3
**BNF-like Definition** **BNF-like Definition**
~~~~ ~~~~{.cpp}
<2D curve record 2> = "2" <_> <2D circle center> <_> <2D circle Dx> <_> <2D circle Dy> <_> <2D circle radius> <_\n>; <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 center> = <2D point>;
@ -1247,7 +1247,7 @@ The example record is interpreted as a Bezier curve with a rational flag *r*=1,
**BNF-like Definition** **BNF-like Definition**
~~~~ ~~~~{.cpp}
<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 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 rational flag> = <flag>;
@ -1430,7 +1430,7 @@ The example record describes a polyline from *m*=2 nodes with a parameter prese
**BNF-like Definition** **BNF-like Definition**
~~~~ ~~~~{.cpp}
<triangulations> = <triangulation header> <_\n> <triangulation records>; <triangulations> = <triangulation header> <_\n> <triangulation records>;
<triangulation header> = "Triangulations" <_> <triangulation count>; <triangulation header> = "Triangulations" <_> <triangulation count>;
@ -1785,7 +1785,7 @@ The usage of \<vertex data representation u parameter\> *U* is described belo
**BNF-like Definition** **BNF-like Definition**
~~~~ ~~~~{.cpp}
<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> = <_> <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 tolerance> = <real>;
@ -1855,7 +1855,7 @@ Flags \<edge data same parameter flag\>, \<edge data same range flag\> and \<edg
**BNF-like Definition** **BNF-like Definition**
~~~~ ~~~~{.cpp}
<face data> = <face data natural restriction flag> <_> <face data tolerance> <_> <surface number> <_> <location number> <\n> ["2" <_> <triangulation number>]; <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 natural restriction flag> = <flag>;

180
dox/tutorial/tutorial.md
View File

@ -66,19 +66,19 @@ To choose the best class for this application, consider the following:
Since all the points you will define are only used to create the profile's curves, an object with a limited lifetime will do. Choose the *gp_Pnt* class. Since all the points you will define are only used to create the profile's curves, an object with a limited lifetime will do. Choose the *gp_Pnt* class.
To instantiate a *gp_Pnt* object, just specify the X, Y, and Z coordinates of the points in the global Cartesian coordinate system: To instantiate a *gp_Pnt* object, just specify the X, Y, and Z coordinates of the points in the global Cartesian coordinate system:
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.cpp} ~~~~{.cpp}
gp_Pnt aPnt1(-myWidth / 2., 0, 0); gp_Pnt aPnt1(-myWidth / 2., 0, 0);
gp_Pnt aPnt2(-myWidth / 2., -myThickness / 4., 0); gp_Pnt aPnt2(-myWidth / 2., -myThickness / 4., 0);
gp_Pnt aPnt3(0, -myThickness / 2., 0); gp_Pnt aPnt3(0, -myThickness / 2., 0);
gp_Pnt aPnt4(myWidth / 2., -myThickness / 4., 0); gp_Pnt aPnt4(myWidth / 2., -myThickness / 4., 0);
gp_Pnt aPnt5(myWidth / 2., 0, 0); gp_Pnt aPnt5(myWidth / 2., 0, 0);
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~
Once your objects are instantiated, you can use methods provided by the class to access and modify its data. For example, to get the X coordinate of a point: Once your objects are instantiated, you can use methods provided by the class to access and modify its data. For example, to get the X coordinate of a point:
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.cpp} ~~~~{.cpp}
Standard_Real xValue1 = aPnt1.X(); Standard_Real xValue1 = aPnt1.X();
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~
@subsection OCCT_TUTORIAL_SUB2_2 Profile: Defining the Geometry @subsection OCCT_TUTORIAL_SUB2_2 Profile: Defining the Geometry
With the help of the previously defined points, you can compute a part of the bottle's profile geometry. As shown in the figure below, it will consist of two segments and one arc. With the help of the previously defined points, you can compute a part of the bottle's profile geometry. As shown in the figure below, it will consist of two segments and one arc.
@ -95,15 +95,15 @@ This is because the *GC* provides two algorithm classes which are exactly what i
Both of these classes return a *Geom_TrimmedCurve* manipulated by handle. This entity represents a base curve (line or circle, in our case), limited between two of its parameter values. For example, circle C is parameterized between 0 and 2PI. If you need to create a quarter of a circle, you create a *Geom_TrimmedCurve* on C limited between 0 and M_PI/2. Both of these classes return a *Geom_TrimmedCurve* manipulated by handle. This entity represents a base curve (line or circle, in our case), limited between two of its parameter values. For example, circle C is parameterized between 0 and 2PI. If you need to create a quarter of a circle, you create a *Geom_TrimmedCurve* on C limited between 0 and M_PI/2.
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.cpp} ~~~~{.cpp}
Handle(Geom_TrimmedCurve) aArcOfCircle = GC_MakeArcOfCircle(aPnt2,aPnt3,aPnt4); Handle(Geom_TrimmedCurve) aArcOfCircle = GC_MakeArcOfCircle(aPnt2,aPnt3,aPnt4);
Handle(Geom_TrimmedCurve) aSegment1 = GC_MakeSegment(aPnt1, aPnt2); Handle(Geom_TrimmedCurve) aSegment1 = GC_MakeSegment(aPnt1, aPnt2);
Handle(Geom_TrimmedCurve) aSegment2 = GC_MakeSegment(aPnt4, aPnt5); Handle(Geom_TrimmedCurve) aSegment2 = GC_MakeSegment(aPnt4, aPnt5);
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~
All *GC* classes provide a casting method to obtain a result automatically with a function-like call. Note that this method will raise an exception if construction has failed. To handle possible errors more explicitly, you may use the *IsDone* and *Value* methods. For example: All *GC* classes provide a casting method to obtain a result automatically with a function-like call. Note that this method will raise an exception if construction has failed. To handle possible errors more explicitly, you may use the *IsDone* and *Value* methods. For example:
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.cpp} ~~~~{.cpp}
GC_MakeSegment mkSeg (aPnt1, aPnt2); GC_MakeSegment mkSeg (aPnt1, aPnt2);
Handle(Geom_TrimmedCurve) aSegment1; Handle(Geom_TrimmedCurve) aSegment1;
if(mkSegment.IsDone()){ if(mkSegment.IsDone()){
@ -112,7 +112,7 @@ All *GC* classes provide a casting method to obtain a result automatically with
else { else {
// handle error // handle error
} }
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~
@subsection OCCT_TUTORIAL_SUB2_3 Profile: Defining the Topology @subsection OCCT_TUTORIAL_SUB2_3 Profile: Defining the Topology
@ -144,18 +144,18 @@ Referring to the previous table, to build the profile, you will create:
However, the *TopoDS* package provides only the data structure of the topological entities. Algorithm classes available to compute standard topological objects can be found in the *BRepBuilderAPI* package. However, the *TopoDS* package provides only the data structure of the topological entities. Algorithm classes available to compute standard topological objects can be found in the *BRepBuilderAPI* package.
To create an edge, you use the BRepBuilderAPI_MakeEdge class with the previously computed curves: To create an edge, you use the BRepBuilderAPI_MakeEdge class with the previously computed curves:
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.cpp} ~~~~{.cpp}
TopoDS_Edge aEdge1 = BRepBuilderAPI_MakeEdge(aSegment1); TopoDS_Edge aEdge1 = BRepBuilderAPI_MakeEdge(aSegment1);
TopoDS_Edge aEdge2 = BRepBuilderAPI_MakeEdge(aArcOfCircle); TopoDS_Edge aEdge2 = BRepBuilderAPI_MakeEdge(aArcOfCircle);
TopoDS_Edge aEdge3 = BRepBuilderAPI_MakeEdge(aSegment2); TopoDS_Edge aEdge3 = BRepBuilderAPI_MakeEdge(aSegment2);
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~
In Open CASCADE Technology, you can create edges in several ways. One possibility is to create an edge directly from two points, in which case the underlying geometry of this edge is a line, bounded by two vertices being automatically computed from the two input points. For example, aEdge1 and aEdge3 could have been computed in a simpler way: In Open CASCADE Technology, you can create edges in several ways. One possibility is to create an edge directly from two points, in which case the underlying geometry of this edge is a line, bounded by two vertices being automatically computed from the two input points. For example, aEdge1 and aEdge3 could have been computed in a simpler way:
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.cpp} ~~~~{.cpp}
TopoDS_Edge aEdge1 = BRepBuilderAPI_MakeEdge(aPnt1, aPnt3); TopoDS_Edge aEdge1 = BRepBuilderAPI_MakeEdge(aPnt1, aPnt3);
TopoDS_Edge aEdge2 = BRepBuilderAPI_MakeEdge(aPnt4, aPnt5); TopoDS_Edge aEdge2 = BRepBuilderAPI_MakeEdge(aPnt4, aPnt5);
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~
To connect the edges, you need to create a wire with the *BRepBuilderAPI_MakeWire* class. There are two ways of building a wire with this class: To connect the edges, you need to create a wire with the *BRepBuilderAPI_MakeWire* class. There are two ways of building a wire with this class:
@ -164,9 +164,9 @@ To connect the edges, you need to create a wire with the *BRepBuilderAPI_MakeWir
When building a wire from less than four edges, as in the present case, you can use the constructor directly as follows: When building a wire from less than four edges, as in the present case, you can use the constructor directly as follows:
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.cpp} ~~~~{.cpp}
TopoDS_Wire aWire = BRepBuilderAPI_MakeWire(aEdge1, aEdge2, aEdge3); TopoDS_Wire aWire = BRepBuilderAPI_MakeWire(aEdge1, aEdge2, aEdge3);
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~
@subsection OCCT_TUTORIAL_SUB2_4 Profile: Completing the Profile @subsection OCCT_TUTORIAL_SUB2_4 Profile: Completing the Profile
@ -186,17 +186,17 @@ The first way is to define it from scratch, using its geometric definition:
* X axis is located at (0, 0, 0) - use the *gp_Pnt* class. * X axis is located at (0, 0, 0) - use the *gp_Pnt* class.
* X axis direction is (1, 0, 0) - use the *gp_Dir* class. A *gp_Dir* instance is created out of its X, Y and Z coordinates. * X axis direction is (1, 0, 0) - use the *gp_Dir* class. A *gp_Dir* instance is created out of its X, Y and Z coordinates.
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.cpp} ~~~~{.cpp}
gp_Pnt aOrigin(0, 0, 0); gp_Pnt aOrigin(0, 0, 0);
gp_Dir xDir(1, 0, 0); gp_Dir xDir(1, 0, 0);
gp_Ax1 xAxis(aOrigin, xDir); gp_Ax1 xAxis(aOrigin, xDir);
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~
The second and simplest way is to use the geometric constants defined in the gp package (origin, main directions and axis of the global coordinate system). To get the X axis, just call the *gp::OX* method: The second and simplest way is to use the geometric constants defined in the gp package (origin, main directions and axis of the global coordinate system). To get the X axis, just call the *gp::OX* method:
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.cpp} ~~~~{.cpp}
gp_Ax1 xAxis = gp::OX(); gp_Ax1 xAxis = gp::OX();
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~
As previously explained, the 3D geometric transformation is defined with the *gp_Trsf* class. There are two different ways to use this class: As previously explained, the 3D geometric transformation is defined with the *gp_Trsf* class. There are two different ways to use this class:
@ -205,43 +205,43 @@ As previously explained, the 3D geometric transformation is defined with the *gp
Since the simplest approach is always the best one, you should use the SetMirror method with the axis as the center of symmetry. Since the simplest approach is always the best one, you should use the SetMirror method with the axis as the center of symmetry.
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.cpp} ~~~~{.cpp}
gp_Trsf aTrsf; gp_Trsf aTrsf;
aTrsf.SetMirror(xAxis); aTrsf.SetMirror(xAxis);
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~
You now have all necessary data to apply the transformation with the BRepBuilderAPI_Transform class by specifying: You now have all necessary data to apply the transformation with the BRepBuilderAPI_Transform class by specifying:
* the shape on which the transformation must be applied. * the shape on which the transformation must be applied.
* the geometric transformation * the geometric transformation
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.cpp} ~~~~{.cpp}
BRepBuilderAPI_Transform aBRepTrsf(aWire, aTrsf); BRepBuilderAPI_Transform aBRepTrsf(aWire, aTrsf);
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~
*BRepBuilderAPI_Transform* does not modify the nature of the shape: the result of the reflected wire remains a wire. But the function-like call or the *BRepBuilderAPI_Transform::Shape* method returns a *TopoDS_Shape* object: *BRepBuilderAPI_Transform* does not modify the nature of the shape: the result of the reflected wire remains a wire. But the function-like call or the *BRepBuilderAPI_Transform::Shape* method returns a *TopoDS_Shape* object:
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.cpp} ~~~~{.cpp}
TopoDS_Shape aMirroredShape = aBRepTrsf.Shape(); TopoDS_Shape aMirroredShape = aBRepTrsf.Shape();
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~
What you need is a method to consider the resulting reflected shape as a wire. The *TopoDS* global functions provide this kind of service by casting a shape into its real type. To cast the transformed wire, use the *TopoDS::Wire* method. What you need is a method to consider the resulting reflected shape as a wire. The *TopoDS* global functions provide this kind of service by casting a shape into its real type. To cast the transformed wire, use the *TopoDS::Wire* method.
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.cpp} ~~~~{.cpp}
TopoDS_Wire aMirroredWire = TopoDS::Wire(aMirroredShape); TopoDS_Wire aMirroredWire = TopoDS::Wire(aMirroredShape);
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~
The bottle's profile is almost finished. You have created two wires: *aWire* and *aMirroredWire*. You need to concatenate them to compute a single shape. To do this, you use the *BRepBuilderAPI_MakeWire* class as follows: The bottle's profile is almost finished. You have created two wires: *aWire* and *aMirroredWire*. You need to concatenate them to compute a single shape. To do this, you use the *BRepBuilderAPI_MakeWire* class as follows:
* create an instance of *BRepBuilderAPI_MakeWire*. * create an instance of *BRepBuilderAPI_MakeWire*.
* add all edges of the two wires by using the *Add* method on this object. * add all edges of the two wires by using the *Add* method on this object.
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.cpp} ~~~~{.cpp}
BRepBuilderAPI_MakeWire mkWire; BRepBuilderAPI_MakeWire mkWire;
mkWire.Add(aWire); mkWire.Add(aWire);
mkWire.Add(aMirroredWire); mkWire.Add(aMirroredWire);
TopoDS_Wire myWireProfile = mkWire.Wire(); TopoDS_Wire myWireProfile = mkWire.Wire();
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~
@section sec3 Building the Body @section sec3 Building the Body
@ -266,9 +266,9 @@ Your current profile is a wire. Referring to the Shape/Generates table, you need
To create a face, use the *BRepBuilderAPI_MakeFace* class. As previously explained, a face is a part of a surface bounded by a closed wire. Generally, *BRepBuilderAPI_MakeFace* computes a face out of a surface and one or more wires. To create a face, use the *BRepBuilderAPI_MakeFace* class. As previously explained, a face is a part of a surface bounded by a closed wire. Generally, *BRepBuilderAPI_MakeFace* computes a face out of a surface and one or more wires.
When the wire lies on a plane, the surface is automatically computed. When the wire lies on a plane, the surface is automatically computed.
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.cpp} ~~~~{.cpp}
TopoDS_Face myFaceProfile = BRepBuilderAPI_MakeFace(myWireProfile); TopoDS_Face myFaceProfile = BRepBuilderAPI_MakeFace(myWireProfile);
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~
The *BRepPrimAPI* package provides all the classes to create topological primitive constructions: boxes, cones, cylinders, spheres, etc. Among them is the *BRepPrimAPI_MakePrism* class. As specified above, the prism is defined by: The *BRepPrimAPI* package provides all the classes to create topological primitive constructions: boxes, cones, cylinders, spheres, etc. Among them is the *BRepPrimAPI_MakePrism* class. As specified above, the prism is defined by:
@ -277,15 +277,15 @@ The *BRepPrimAPI* package provides all the classes to create topological primiti
You want the solid to be finite, swept along the Z axis and to be myHeight height. The vector, defined with the *gp_Vec* class on its X, Y and Z coordinates, is: You want the solid to be finite, swept along the Z axis and to be myHeight height. The vector, defined with the *gp_Vec* class on its X, Y and Z coordinates, is:
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.cpp} ~~~~{.cpp}
gp_Vec aPrismVec(0, 0, myHeight); gp_Vec aPrismVec(0, 0, myHeight);
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~
All the necessary data to create the main body of your bottle is now available. Just apply the *BRepPrimAPI_MakePrism* class to compute the solid: All the necessary data to create the main body of your bottle is now available. Just apply the *BRepPrimAPI_MakePrism* class to compute the solid:
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.cpp} ~~~~{.cpp}
TopoDS_Shape myBody = BRepPrimAPI_MakePrism(myFaceProfile, aPrismVec); TopoDS_Shape myBody = BRepPrimAPI_MakePrism(myFaceProfile, aPrismVec);
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~
@subsection OCCT_TUTORIAL_SUB3_2 Applying Fillets @subsection OCCT_TUTORIAL_SUB3_2 Applying Fillets
@ -305,9 +305,9 @@ To apply fillets on the edges of a shape, you use the *BRepFilletAPI_MakeFillet*
* Add the fillet descriptions (an edge and a radius) using the *Add* method (you can add as many edges as you need). * Add the fillet descriptions (an edge and a radius) using the *Add* method (you can add as many edges as you need).
* Ask for the resulting filleted shape with the *Shape* method. * Ask for the resulting filleted shape with the *Shape* method.
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.cpp} ~~~~{.cpp}
BRepFilletAPI_MakeFillet mkFillet(myBody); BRepFilletAPI_MakeFillet mkFillet(myBody);
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~
To add the fillet description, you need to know the edges belonging to your shape. The best solution is to explore your solid to retrieve its edges. This kind of functionality is provided with the *TopExp_Explorer* class, which explores the data structure described in a *TopoDS_Shape* and extracts the sub-shapes you specifically need. To add the fillet description, you need to know the edges belonging to your shape. The best solution is to explore your solid to retrieve its edges. This kind of functionality is provided with the *TopExp_Explorer* class, which explores the data structure described in a *TopoDS_Shape* and extracts the sub-shapes you specifically need.
Generally, this explorer is created by providing the following information: Generally, this explorer is created by providing the following information:
@ -315,9 +315,9 @@ Generally, this explorer is created by providing the following information:
* the shape to explore * the shape to explore
* the type of sub-shapes to be found. This information is given with the *TopAbs_ShapeEnum* enumeration. * the type of sub-shapes to be found. This information is given with the *TopAbs_ShapeEnum* enumeration.
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.cpp} ~~~~{.cpp}
TopExp_Explorer anEdgeExplorer(myBody, TopAbs_EDGE); TopExp_Explorer anEdgeExplorer(myBody, TopAbs_EDGE);
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~
An explorer is usually applied in a loop by using its three main methods: An explorer is usually applied in a loop by using its three main methods:
@ -326,26 +326,26 @@ An explorer is usually applied in a loop by using its three main methods:
* *Next()* to move onto the next sub-shape to explore. * *Next()* to move onto the next sub-shape to explore.
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.cpp} ~~~~{.cpp}
while(anEdgeExplorer.More()){ while(anEdgeExplorer.More()){
TopoDS_Edge anEdge = TopoDS::Edge(anEdgeExplorer.Current()); TopoDS_Edge anEdge = TopoDS::Edge(anEdgeExplorer.Current());
//Add edge to fillet algorithm //Add edge to fillet algorithm
... ...
anEdgeExplorer.Next(); anEdgeExplorer.Next();
} }
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~
In the explorer loop, you have found all the edges of the bottle shape. Each one must then be added in the *BRepFilletAPI_MakeFillet* instance with the *Add()* method. Do not forget to specify the radius of the fillet along with it. In the explorer loop, you have found all the edges of the bottle shape. Each one must then be added in the *BRepFilletAPI_MakeFillet* instance with the *Add()* method. Do not forget to specify the radius of the fillet along with it.
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.cpp} ~~~~{.cpp}
mkFillet.Add(myThickness / 12., anEdge); mkFillet.Add(myThickness / 12., anEdge);
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~
Once this is done, you perform the last step of the procedure by asking for the filleted shape. Once this is done, you perform the last step of the procedure by asking for the filleted shape.
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.cpp} ~~~~{.cpp}
myBody = mkFillet.Shape(); myBody = mkFillet.Shape();
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~
@subsection OCCT_TUTORIAL_SUB3_3 Adding the Neck @subsection OCCT_TUTORIAL_SUB3_3 Adding the Neck
@ -358,31 +358,31 @@ To add a neck to the bottle, you will create a cylinder and fuse it to the body.
To position the cylinder, you need to define a coordinate system with the *gp_Ax2* class defining a right-handed coordinate system from a point and two directions - the main (Z) axis direction and the X direction (the Y direction is computed from these two). To position the cylinder, you need to define a coordinate system with the *gp_Ax2* class defining a right-handed coordinate system from a point and two directions - the main (Z) axis direction and the X direction (the Y direction is computed from these two).
To align the neck with the center of the top face, being in the global coordinate system (0, 0, *myHeight*), with its normal on the global Z axis, your local coordinate system can be defined as follows: To align the neck with the center of the top face, being in the global coordinate system (0, 0, *myHeight*), with its normal on the global Z axis, your local coordinate system can be defined as follows:
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.cpp} ~~~~{.cpp}
gp_Pnt neckLocation(0, 0, myHeight); gp_Pnt neckLocation(0, 0, myHeight);
gp_Dir neckAxis = gp::DZ(); gp_Dir neckAxis = gp::DZ();
gp_Ax2 neckAx2(neckLocation, neckAxis); gp_Ax2 neckAx2(neckLocation, neckAxis);
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~
To create a cylinder, use another class from the primitives construction package: the *BRepPrimAPI_MakeCylinder* class. The information you must provide is: To create a cylinder, use another class from the primitives construction package: the *BRepPrimAPI_MakeCylinder* class. The information you must provide is:
* the coordinate system where the cylinder will be located; * the coordinate system where the cylinder will be located;
* the radius and height. * the radius and height.
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.cpp} ~~~~{.cpp}
Standard_Real myNeckRadius = myThickness / 4.; Standard_Real myNeckRadius = myThickness / 4.;
Standard_Real myNeckHeight = myHeight / 10; Standard_Real myNeckHeight = myHeight / 10;
BRepPrimAPI_MakeCylinder MKCylinder(neckAx2, myNeckRadius, myNeckHeight); BRepPrimAPI_MakeCylinder MKCylinder(neckAx2, myNeckRadius, myNeckHeight);
TopoDS_Shape myNeck = MKCylinder.Shape(); TopoDS_Shape myNeck = MKCylinder.Shape();
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~
You now have two separate parts: a main body and a neck that you need to fuse together. You now have two separate parts: a main body and a neck that you need to fuse together.
The *BRepAlgoAPI* package provides services to perform Boolean operations between shapes, and especially: *common* (Boolean intersection), *cut* (Boolean subtraction) and *fuse* (Boolean union). The *BRepAlgoAPI* package provides services to perform Boolean operations between shapes, and especially: *common* (Boolean intersection), *cut* (Boolean subtraction) and *fuse* (Boolean union).
Use *BRepAlgoAPI_Fuse* to fuse the two shapes: Use *BRepAlgoAPI_Fuse* to fuse the two shapes:
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.cpp} ~~~~{.cpp}
myBody = BRepAlgoAPI_Fuse(myBody, myNeck); myBody = BRepAlgoAPI_Fuse(myBody, myNeck);
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~
@subsection OCCT_TUTORIAL_SUB3_4 Creating a Hollowed Solid @subsection OCCT_TUTORIAL_SUB3_4 Creating a Hollowed Solid
@ -411,11 +411,11 @@ The challenging part in this procedure is to find the face to remove from your s
To find the face with such characteristics, you will once again use an explorer to iterate on all the bottle's faces to find the appropriate one. To find the face with such characteristics, you will once again use an explorer to iterate on all the bottle's faces to find the appropriate one.
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.cpp} ~~~~{.cpp}
for(TopExp_Explorer aFaceExplorer(myBody, TopAbs_FACE) ; aFaceExplorer.More() ; aFaceExplorer.Next()){ for(TopExp_Explorer aFaceExplorer(myBody, TopAbs_FACE) ; aFaceExplorer.More() ; aFaceExplorer.Next()){
TopoDS_Face aFace = TopoDS::Face(aFaceExplorer.Current()); TopoDS_Face aFace = TopoDS::Face(aFaceExplorer.Current());
} }
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~
For each detected face, you need to access the geometric properties of the shape: use the *BRep_Tool* class for that. The most commonly used methods of this class are: For each detected face, you need to access the geometric properties of the shape: use the *BRep_Tool* class for that. The most commonly used methods of this class are:
@ -423,9 +423,9 @@ For each detected face, you need to access the geometric properties of the shape
* *Curve* to access the 3D curve of an edge; * *Curve* to access the 3D curve of an edge;
* *Point* to access the 3D point of a vertex. * *Point* to access the 3D point of a vertex.
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.cpp} ~~~~{.cpp}
Handle(Geom_Surface) aSurface = BRep_Tool::Surface(aFace); Handle(Geom_Surface) aSurface = BRep_Tool::Surface(aFace);
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~
As you can see, the *BRep_Tool::Surface* method returns an instance of the *Geom_Surface* class manipulated by handle. However, the *Geom_Surface* class does not provide information about the real type of the object *aSurface*, which could be an instance of *Geom_Plane*, *Geom_CylindricalSurface*, etc. As you can see, the *BRep_Tool::Surface* method returns an instance of the *Geom_Surface* class manipulated by handle. However, the *Geom_Surface* class does not provide information about the real type of the object *aSurface*, which could be an instance of *Geom_Plane*, *Geom_CylindricalSurface*, etc.
All objects manipulated by handle, like *Geom_Surface*, inherit from the *Standard_Transient* class which provides two very useful methods concerning types: All objects manipulated by handle, like *Geom_Surface*, inherit from the *Standard_Transient* class which provides two very useful methods concerning types:
@ -436,52 +436,52 @@ All objects manipulated by handle, like *Geom_Surface*, inherit from the *Standa
DynamicType returns the real type of the object, but you need to compare it with the existing known types to determine whether *aSurface* is a plane, a cylindrical surface or some other type. DynamicType returns the real type of the object, but you need to compare it with the existing known types to determine whether *aSurface* is a plane, a cylindrical surface or some other type.
To compare a given type with the type you seek, use the *STANDARD_TYPE* macro, which returns the type of a class: To compare a given type with the type you seek, use the *STANDARD_TYPE* macro, which returns the type of a class:
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.cpp} ~~~~{.cpp}
if(aSurface->DynamicType() == STANDARD_TYPE(Geom_Plane)){ if(aSurface->DynamicType() == STANDARD_TYPE(Geom_Plane)){
// //
} }
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~
If this comparison is true, you know that the *aSurface* real type is *Geom_Plane*. You can then convert it from *Geom_Surface* to *Geom_Plane* by using the *DownCast()* method provided by each class inheriting *Standard_Transient*. As its name implies, this static method is used to downcast objects to a given type with the following syntax: If this comparison is true, you know that the *aSurface* real type is *Geom_Plane*. You can then convert it from *Geom_Surface* to *Geom_Plane* by using the *DownCast()* method provided by each class inheriting *Standard_Transient*. As its name implies, this static method is used to downcast objects to a given type with the following syntax:
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.cpp} ~~~~{.cpp}
Handle(Geom_Plane) aPlane = Handle(Geom_Plane)::DownCast(aSurface); Handle(Geom_Plane) aPlane = Handle(Geom_Plane)::DownCast(aSurface);
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~
Remember that the goal of all these conversions is to find the highest face of the bottle lying on a plane. Suppose that you have these two global variables: Remember that the goal of all these conversions is to find the highest face of the bottle lying on a plane. Suppose that you have these two global variables:
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.cpp} ~~~~{.cpp}
TopoDS_Face faceToRemove; TopoDS_Face faceToRemove;
Standard_Real zMax = -1; Standard_Real zMax = -1;
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~
You can easily find the plane whose origin is the biggest in Z knowing that the location of the plane is given with the *Geom_Plane::Location* method. For example: You can easily find the plane whose origin is the biggest in Z knowing that the location of the plane is given with the *Geom_Plane::Location* method. For example:
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.cpp} ~~~~{.cpp}
gp_Pnt aPnt = aPlane->Location(); gp_Pnt aPnt = aPlane->Location();
Standard_Real aZ = aPnt.Z(); Standard_Real aZ = aPnt.Z();
if(aZ > zMax){ if(aZ > zMax){
zMax = aZ; zMax = aZ;
faceToRemove = aFace; faceToRemove = aFace;
} }
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~
You have now found the top face of the neck. Your final step before creating the hollowed solid is to put this face in a list. Since more than one face can be removed from the initial solid, the *BRepOffsetAPI_MakeThickSolid* constructor takes a list of faces as arguments. You have now found the top face of the neck. Your final step before creating the hollowed solid is to put this face in a list. Since more than one face can be removed from the initial solid, the *BRepOffsetAPI_MakeThickSolid* constructor takes a list of faces as arguments.
Open CASCADE Technology provides many collections for different kinds of objects: see *TColGeom* package for collections of objects from *Geom* package, *TColgp* package for collections of objects from gp package, etc. Open CASCADE Technology provides many collections for different kinds of objects: see *TColGeom* package for collections of objects from *Geom* package, *TColgp* package for collections of objects from gp package, etc.
The collection for shapes can be found in the *TopTools* package. As *BRepOffsetAPI_MakeThickSolid* requires a list, use the *TopTools_ListOfShape* class. The collection for shapes can be found in the *TopTools* package. As *BRepOffsetAPI_MakeThickSolid* requires a list, use the *TopTools_ListOfShape* class.
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.cpp} ~~~~{.cpp}
TopTools_ListOfShape facesToRemove; TopTools_ListOfShape facesToRemove;
facesToRemove.Append(faceToRemove); facesToRemove.Append(faceToRemove);
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~
All the necessary data are now available so you can create your hollowed solid by calling the *BRepOffsetAPI_MakeThickSolid* MakeThickSolidByJoin method: All the necessary data are now available so you can create your hollowed solid by calling the *BRepOffsetAPI_MakeThickSolid* MakeThickSolidByJoin method:
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.cpp} ~~~~{.cpp}
BRepOffsetAPI_MakeThickSolid BodyMaker; BRepOffsetAPI_MakeThickSolid BodyMaker;
BodyMaker.MakeThickSolidByJoin(myBody, facesToRemove, -myThickness / 50, 1.e-3); BodyMaker.MakeThickSolidByJoin(myBody, facesToRemove, -myThickness / 50, 1.e-3);
myBody = BodyMaker.Shape(); myBody = BodyMaker.Shape();
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~
@section sec4 Building the Threading @section sec4 Building the Threading
@ -504,11 +504,11 @@ Using the same coordinate system *neckAx2* used to position the neck, you create
Notice that one of the cylindrical surfaces is smaller than the neck. There is a good reason for this: after the thread creation, you will fuse it with the neck. So, we must make sure that the two shapes remain in contact. Notice that one of the cylindrical surfaces is smaller than the neck. There is a good reason for this: after the thread creation, you will fuse it with the neck. So, we must make sure that the two shapes remain in contact.
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.cpp} ~~~~{.cpp}
Handle(Geom_CylindricalSurface) aCyl1 = new Geom_CylindricalSurface(neckAx2, myNeckRadius * 0.99); Handle(Geom_CylindricalSurface) aCyl1 = new Geom_CylindricalSurface(neckAx2, myNeckRadius * 0.99);
Handle(Geom_CylindricalSurface) aCyl2 = new Geom_CylindricalSurface(neckAx2, myNeckRadius * 1.05); Handle(Geom_CylindricalSurface) aCyl2 = new Geom_CylindricalSurface(neckAx2, myNeckRadius * 1.05);
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~
@subsection OCCT_TUTORIAL_SUB4_2 Defining 2D Curves @subsection OCCT_TUTORIAL_SUB4_2 Defining 2D Curves
@ -564,11 +564,11 @@ To use 2D primitive geometry types of Open CASCADE Technology for defining a poi
* To define a 2D direction (unit vector) from its X and Y coordinates, use the gp_Dir2d class. The coordinates will automatically be normalized. * To define a 2D direction (unit vector) from its X and Y coordinates, use the gp_Dir2d class. The coordinates will automatically be normalized.
* To define a 2D right-handed coordinate system, use the *gp_Ax2d* class, which is computed from a point (origin of the coordinate system) and a direction - the X direction of the coordinate system. The Y direction will be automatically computed. * To define a 2D right-handed coordinate system, use the *gp_Ax2d* class, which is computed from a point (origin of the coordinate system) and a direction - the X direction of the coordinate system. The Y direction will be automatically computed.
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.cpp} ~~~~{.cpp}
gp_Pnt2d aPnt(2. * M_PI, myNeckHeight / 2.); gp_Pnt2d aPnt(2. * M_PI, myNeckHeight / 2.);
gp_Dir2d aDir(2. * M_PI, myNeckHeight / 4.); gp_Dir2d aDir(2. * M_PI, myNeckHeight / 4.);
gp_Ax2d anAx2d(aPnt, aDir); gp_Ax2d anAx2d(aPnt, aDir);
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~
You will now define the curves. As previously mentioned, these thread profiles are computed on two cylindrical surfaces. In the following figure, curves on the left define the base (on *aCyl1* surface) and the curves on the right define the top of the thread's shape (on *aCyl2* surface). You will now define the curves. As previously mentioned, these thread profiles are computed on two cylindrical surfaces. In the following figure, curves on the left define the base (on *aCyl1* surface) and the curves on the right define the top of the thread's shape (on *aCyl2* surface).
@ -588,36 +588,36 @@ Supposing that:
Your ellipses are defined as follows: Your ellipses are defined as follows:
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.cpp} ~~~~{.cpp}
Standard_Real aMajor = 2. * M_PI; Standard_Real aMajor = 2. * M_PI;
Standard_Real aMinor = myNeckHeight / 10; Standard_Real aMinor = myNeckHeight / 10;
Handle(Geom2d_Ellipse) anEllipse1 = new Geom2d_Ellipse(anAx2d, aMajor, aMinor); Handle(Geom2d_Ellipse) anEllipse1 = new Geom2d_Ellipse(anAx2d, aMajor, aMinor);
Handle(Geom2d_Ellipse) anEllipse2 = new Geom2d_Ellipse(anAx2d, aMajor, aMinor / 4); Handle(Geom2d_Ellipse) anEllipse2 = new Geom2d_Ellipse(anAx2d, aMajor, aMinor / 4);
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~
To describe portions of curves for the arcs drawn above, you define *Geom2d_TrimmedCurve* trimmed curves out of the created ellipses and two parameters to limit them. To describe portions of curves for the arcs drawn above, you define *Geom2d_TrimmedCurve* trimmed curves out of the created ellipses and two parameters to limit them.
As the parametric equation of an ellipse is P(U) = O + (MajorRadius * cos(U) * XDirection) + (MinorRadius * sin(U) * YDirection), the ellipses need to be limited between 0 and M_PI. As the parametric equation of an ellipse is P(U) = O + (MajorRadius * cos(U) * XDirection) + (MinorRadius * sin(U) * YDirection), the ellipses need to be limited between 0 and M_PI.
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.cpp} ~~~~{.cpp}
Handle(Geom2d_TrimmedCurve) anArc1 = new Geom2d_TrimmedCurve(anEllipse1, 0, M_PI); Handle(Geom2d_TrimmedCurve) anArc1 = new Geom2d_TrimmedCurve(anEllipse1, 0, M_PI);
Handle(Geom2d_TrimmedCurve) anArc2 = new Geom2d_TrimmedCurve(anEllipse2, 0, M_PI); Handle(Geom2d_TrimmedCurve) anArc2 = new Geom2d_TrimmedCurve(anEllipse2, 0, M_PI);
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~
The last step consists in defining the segment, which is the same for the two profiles: a line limited by the first and the last point of one of the arcs. The last step consists in defining the segment, which is the same for the two profiles: a line limited by the first and the last point of one of the arcs.
To access the point corresponding to the parameter of a curve or a surface, you use the Value or D0 method (meaning 0th derivative), D1 method is for first derivative, D2 for the second one. To access the point corresponding to the parameter of a curve or a surface, you use the Value or D0 method (meaning 0th derivative), D1 method is for first derivative, D2 for the second one.
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.cpp} ~~~~{.cpp}
gp_Pnt2d anEllipsePnt1 = anEllipse1->Value(0); gp_Pnt2d anEllipsePnt1 = anEllipse1->Value(0);
gp_Pnt2d anEllipsePnt2; gp_Pnt2d anEllipsePnt2;
anEllipse1->D0(M_PI, anEllipsePnt2); anEllipse1->D0(M_PI, anEllipsePnt2);
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~
When creating the bottle's profile, you used classes from the *GC* package, providing algorithms to create elementary geometries. When creating the bottle's profile, you used classes from the *GC* package, providing algorithms to create elementary geometries.
In 2D geometry, this kind of algorithms is found in the *GCE2d* package. Class names and behaviors are similar to those in *GC*. For example, to create a 2D segment out of two points: In 2D geometry, this kind of algorithms is found in the *GCE2d* package. Class names and behaviors are similar to those in *GC*. For example, to create a 2D segment out of two points:
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.cpp} ~~~~{.cpp}
Handle(Geom2d_TrimmedCurve) aSegment = GCE2d_MakeSegment(anEllipsePnt1, anEllipsePnt2); Handle(Geom2d_TrimmedCurve) aSegment = GCE2d_MakeSegment(anEllipsePnt1, anEllipsePnt2);
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~
@subsection OCCT_TUTORIAL_SUB4_3 Building Edges and Wires @subsection OCCT_TUTORIAL_SUB4_3 Building Edges and Wires
@ -637,28 +637,28 @@ Previously, you have built:
To compute the edges out of these curves, once again use the *BRepBuilderAPI_MakeEdge* class. One of its constructors allows you to build an edge out of a curve described in the 2D parametric space of a surface. To compute the edges out of these curves, once again use the *BRepBuilderAPI_MakeEdge* class. One of its constructors allows you to build an edge out of a curve described in the 2D parametric space of a surface.
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.cpp} ~~~~{.cpp}
TopoDS_Edge anEdge1OnSurf1 = BRepBuilderAPI_MakeEdge(anArc1, aCyl1); TopoDS_Edge anEdge1OnSurf1 = BRepBuilderAPI_MakeEdge(anArc1, aCyl1);
TopoDS_Edge anEdge2OnSurf1 = BRepBuilderAPI_MakeEdge(aSegment, aCyl1); TopoDS_Edge anEdge2OnSurf1 = BRepBuilderAPI_MakeEdge(aSegment, aCyl1);
TopoDS_Edge anEdge1OnSurf2 = BRepBuilderAPI_MakeEdge(anArc2, aCyl2); TopoDS_Edge anEdge1OnSurf2 = BRepBuilderAPI_MakeEdge(anArc2, aCyl2);
TopoDS_Edge anEdge2OnSurf2 = BRepBuilderAPI_MakeEdge(aSegment, aCyl2); TopoDS_Edge anEdge2OnSurf2 = BRepBuilderAPI_MakeEdge(aSegment, aCyl2);
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~
Now, you can create the two profiles of the threading, lying on each surface. Now, you can create the two profiles of the threading, lying on each surface.
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.cpp} ~~~~{.cpp}
TopoDS_Wire threadingWire1 = BRepBuilderAPI_MakeWire(anEdge1OnSurf1, anEdge2OnSurf1); TopoDS_Wire threadingWire1 = BRepBuilderAPI_MakeWire(anEdge1OnSurf1, anEdge2OnSurf1);
TopoDS_Wire threadingWire2 = BRepBuilderAPI_MakeWire(anEdge1OnSurf2, anEdge2OnSurf2); TopoDS_Wire threadingWire2 = BRepBuilderAPI_MakeWire(anEdge1OnSurf2, anEdge2OnSurf2);
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~
Remember that these wires were built out of a surface and 2D curves. Remember that these wires were built out of a surface and 2D curves.
One important data item is missing as far as these wires are concerned: there is no information on the 3D curves. Fortunately, you do not need to compute this yourself, which can be a difficult task since the mathematics can be quite complex. One important data item is missing as far as these wires are concerned: there is no information on the 3D curves. Fortunately, you do not need to compute this yourself, which can be a difficult task since the mathematics can be quite complex.
When a shape contains all the necessary information except 3D curves, Open CASCADE Technology provides a tool to build them automatically. In the BRepLib tool package, you can use the *BuildCurves3d* method to compute 3D curves for all the edges of a shape. When a shape contains all the necessary information except 3D curves, Open CASCADE Technology provides a tool to build them automatically. In the BRepLib tool package, you can use the *BuildCurves3d* method to compute 3D curves for all the edges of a shape.
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.cpp} ~~~~{.cpp}
BRepLib::BuildCurves3d(threadingWire1); BRepLib::BuildCurves3d(threadingWire1);
BRepLib::BuildCurves3d(threadingWire2); BRepLib::BuildCurves3d(threadingWire2);
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~
@subsection OCCT_TUTORIAL_SUB4_4 Creating Threading @subsection OCCT_TUTORIAL_SUB4_4 Creating Threading
@ -675,12 +675,12 @@ The loft function is implemented in the *BRepOffsetAPI_ThruSections* class, whic
* Use the *CheckCompatibility* method to activate (or deactivate) the option that checks whether the wires have the same number of edges. In this case, wires have two edges each, so you can deactivate this option. * Use the *CheckCompatibility* method to activate (or deactivate) the option that checks whether the wires have the same number of edges. In this case, wires have two edges each, so you can deactivate this option.
* Ask for the resulting loft shape with the Shape method. * Ask for the resulting loft shape with the Shape method.
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.cpp} ~~~~{.cpp}
BRepOffsetAPI_ThruSections aTool(Standard_True); BRepOffsetAPI_ThruSections aTool(Standard_True);
aTool.AddWire(threadingWire1); aTool.AddWire(threadingWire2); aTool.AddWire(threadingWire1); aTool.AddWire(threadingWire2);
aTool.CheckCompatibility(Standard_False); aTool.CheckCompatibility(Standard_False);
TopoDS_Shape myThreading = aTool.Shape(); TopoDS_Shape myThreading = aTool.Shape();
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~
@section sec5 Building the Resulting Compound @section sec5 Building the Resulting Compound
@ -688,13 +688,13 @@ The loft function is implemented in the *BRepOffsetAPI_ThruSections* class, whic
You are almost done building the bottle. Use the *TopoDS_Compound* and *BRep_Builder* classes to build single shape from *myBody* and *myThreading*: You are almost done building the bottle. Use the *TopoDS_Compound* and *BRep_Builder* classes to build single shape from *myBody* and *myThreading*:
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.cpp} ~~~~{.cpp}
TopoDS_Compound aRes; TopoDS_Compound aRes;
BRep_Builder aBuilder; BRep_Builder aBuilder;
aBuilder.MakeCompound (aRes); aBuilder.MakeCompound (aRes);
aBuilder.Add (aRes, myBody); aBuilder.Add (aRes, myBody);
aBuilder.Add (aRes, myThreading); aBuilder.Add (aRes, myThreading);
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~
Congratulations! Your bottle is complete. Here is the result snapshot of the Tutorial application: Congratulations! Your bottle is complete. Here is the result snapshot of the Tutorial application:
@ -709,7 +709,7 @@ If you want to know more and develop major projects using Open CASCADE Technolog
Complete definition of MakeBottle function (defined in the file src/MakeBottle.cxx of the Tutorial): Complete definition of MakeBottle function (defined in the file src/MakeBottle.cxx of the Tutorial):
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.cpp} ~~~~{.cpp}
TopoDS_Shape MakeBottle(const Standard_Real myWidth, const Standard_Real myHeight, TopoDS_Shape MakeBottle(const Standard_Real myWidth, const Standard_Real myHeight,
const Standard_Real myThickness) const Standard_Real myThickness)
{ {
@ -846,5 +846,5 @@ Complete definition of MakeBottle function (defined in the file src/MakeBottle.c
return aRes; return aRes;
} }
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~

206
dox/upgrade/upgrade.md
View File

@ -39,7 +39,7 @@ Porting of user applications from an earlier OCCT version to version 6.5 require
Porting of user applications from an earlier OCCT version to version 6.5.1 requires taking into account the following major changes: Porting of user applications from an earlier OCCT version to version 6.5.1 requires taking into account the following major changes:
* Method *Graphic3d_Structure::Groups()* now returns *Graphic3d_SequenceOfGroup*. If this method has been used, the application code should be updated to iterate another collection type or, if *Graphic3d_HSetOfGroup* is required, to fill its own collection: * Method *Graphic3d_Structure::Groups()* now returns *Graphic3d_SequenceOfGroup*. If this method has been used, the application code should be updated to iterate another collection type or, if *Graphic3d_HSetOfGroup* is required, to fill its own collection:
~~~~ ~~~~{.cpp}
const Graphic3d_SequenceOfGroup& aGroupsSeq = theStructure.Groups(); const Graphic3d_SequenceOfGroup& aGroupsSeq = theStructure.Groups();
Handle(Graphic3d_HSetOfGroup) aGroupSet = new Graphic3d_HSetOfGroup(); Handle(Graphic3d_HSetOfGroup) aGroupSet = new Graphic3d_HSetOfGroup();
Standard_Integer aLen = aGroupsSeq.Length(); Standard_Integer aLen = aGroupsSeq.Length();
@ -62,7 +62,7 @@ Porting of user applications from an earlier OCCT version to version 6.5.2 requi
* If the callback mechanism in call_togl_redraw function was used in the application code, it is necessary to revise it to take into account the new callback execution and provide a check of reason value of Aspect_GraphicCallbackStruct in callback methods to confirm that the callback code is executed at the right moment. Now the callbacks are executed before redrawing the underlayer, before redrawing the overlayer and at the end of redrawing. The information about the moment when the callback is invoked is provided with the reason value in form of an additional bit flag <i>(OCC_PRE_REDRAW, OCC_PRE_OVERLAY)</i>. The state of OpenGl changed in callback methods will not be restored automatically, which might lead to unwanted behavior in redrawing procedure. * If the callback mechanism in call_togl_redraw function was used in the application code, it is necessary to revise it to take into account the new callback execution and provide a check of reason value of Aspect_GraphicCallbackStruct in callback methods to confirm that the callback code is executed at the right moment. Now the callbacks are executed before redrawing the underlayer, before redrawing the overlayer and at the end of redrawing. The information about the moment when the callback is invoked is provided with the reason value in form of an additional bit flag <i>(OCC_PRE_REDRAW, OCC_PRE_OVERLAY)</i>. The state of OpenGl changed in callback methods will not be restored automatically, which might lead to unwanted behavior in redrawing procedure.
* The print method used in the application code might need to be revised to take into account the ability to choose between print algorithms: tile and stretch. The stretch algorithm will be selected by default during porting. * The print method used in the application code might need to be revised to take into account the ability to choose between print algorithms: tile and stretch. The stretch algorithm will be selected by default during porting.
* It is recommended to *BRepMesh_DiscretFactory* users, to check *BRepMesh_DiscretFactory::SetDefault()* return value to determine plugin availability / validity. *BRepMesh_DiscretFactory::Discret()* method now returns handle instead of pointer. The code should be updated in the following manner: * It is recommended to *BRepMesh_DiscretFactory* users, to check *BRepMesh_DiscretFactory::SetDefault()* return value to determine plugin availability / validity. *BRepMesh_DiscretFactory::Discret()* method now returns handle instead of pointer. The code should be updated in the following manner:
~~~~ ~~~~{.cpp}
Handle(BRepMesh_DiscretRoot) aMeshAlgo = BRepMesh_DiscretFactory::Get().Discret (theShape, theDeflection, theAngularToler); Handle(BRepMesh_DiscretRoot) aMeshAlgo = BRepMesh_DiscretFactory::Get().Discret (theShape, theDeflection, theAngularToler);
if (!aMeshAlgo.IsNull()) {} if (!aMeshAlgo.IsNull()) {}
~~~~ ~~~~
@ -88,7 +88,7 @@ Porting of user applications from an earlier OCCT version to version 6.5.3 requi
Porting of user applications from an earlier OCCT version to version 6.5.4 requires taking into account the following major changes: Porting of user applications from an earlier OCCT version to version 6.5.4 requires taking into account the following major changes:
* The code using obsolete classes *Aspect_PixMap, Xw_PixMap* and *WNT_PixMap* should be rewritten implementing class *Image_PixMap*, which is now retrieved by *ToPixMap* methods as argument. A sample code using *ToPixMap* is given below: * The code using obsolete classes *Aspect_PixMap, Xw_PixMap* and *WNT_PixMap* should be rewritten implementing class *Image_PixMap*, which is now retrieved by *ToPixMap* methods as argument. A sample code using *ToPixMap* is given below:
~~~~ ~~~~{.cpp}
#include <Image_AlienPixMap.hxx> #include <Image_AlienPixMap.hxx>
void dump (Handle(V3d_View)& theView3D) void dump (Handle(V3d_View)& theView3D)
{ {
@ -121,7 +121,7 @@ Correspondingly, the code using methods *SetAnimationModeOn(), SetAnimationModeO
* Interactive selection of 2D presentations should be set up inside *ComputeSelection()* virtual method of a custom interactive object class, using standard sensitive entities from *Select3D* package and standard or custom entity owners derived from *SelectMgr_EntityOwner* base. * Interactive selection of 2D presentations should be set up inside *ComputeSelection()* virtual method of a custom interactive object class, using standard sensitive entities from *Select3D* package and standard or custom entity owners derived from *SelectMgr_EntityOwner* base.
Refer to the Visualization User's Guide for further details concerning OCCT 3D visualization and selection classes. See also *Viewer2D* OCCT sample application, which shows how 2D drawing can be implemented using TKV3d API. Refer to the Visualization User's Guide for further details concerning OCCT 3D visualization and selection classes. See also *Viewer2D* OCCT sample application, which shows how 2D drawing can be implemented using TKV3d API.
* Run-time graphic driver library loading mechanism based on *CSF_GraphicShr* environment variable usage has been replaced by explicit linking against *TKOpenGl* library. The code sample below shows how the graphic driver should be created and initialized in the application code: * Run-time graphic driver library loading mechanism based on *CSF_GraphicShr* environment variable usage has been replaced by explicit linking against *TKOpenGl* library. The code sample below shows how the graphic driver should be created and initialized in the application code:
~~~~ ~~~~{.cpp}
// initialize a new viewer with OpenGl graphic driver // initialize a new viewer with OpenGl graphic driver
Handle(Graphic3d_GraphicDriver) aGraphicDriver = Handle(Graphic3d_GraphicDriver) aGraphicDriver =
new OpenGl_GraphicDriver ("TKOpenGl"); new OpenGl_GraphicDriver ("TKOpenGl");
@ -264,7 +264,7 @@ Custom Interactive Objects should implement new virtual method *SelectMgr_Select
Now the method *SelectMgr_Selection::Sensitive()* does not return *SelectBasics_SensitiveEntity*. It returns an instance of *SelectMgr_SensitiveEntity*, which belongs to a different class hierarchy (thus *DownCast()* will fail). To access base sensitive it is necessary to use method *SelectMgr_SensitiveEntity::BaseSensitive()*. For example: Now the method *SelectMgr_Selection::Sensitive()* does not return *SelectBasics_SensitiveEntity*. It returns an instance of *SelectMgr_SensitiveEntity*, which belongs to a different class hierarchy (thus *DownCast()* will fail). To access base sensitive it is necessary to use method *SelectMgr_SensitiveEntity::BaseSensitive()*. For example:
~~~~ ~~~~{.cpp}
Handle(SelectMgr_Selection) aSelection = anInteractiveObject->Selection (aMode); Handle(SelectMgr_Selection) aSelection = anInteractiveObject->Selection (aMode);
for (aSelection->Init(); aSelection->More(); aSelection->Next()) for (aSelection->Init(); aSelection->More(); aSelection->Next())
{ {
@ -286,7 +286,7 @@ The depth and distance to the center of geometry must be calculated for the 3D p
Here is an example of overlap/inclusion test for a box: Here is an example of overlap/inclusion test for a box:
~~~~ ~~~~{.cpp}
if (!theMgr.IsOverlapAllowed()) // check for inclusion if (!theMgr.IsOverlapAllowed()) // check for inclusion
{ {
Standard_Boolean isInside = Standard_True; Standard_Boolean isInside = Standard_True;
@ -404,26 +404,26 @@ Most of typical changes required for upgrading code for OCCT 7.0 can be done aut
This tool is a Tcl script, thus Tcl should be available on your workstation to run it. This tool is a Tcl script, thus Tcl should be available on your workstation to run it.
Example: Example:
~~~~~ ~~~~{.php}
$ tclsh $ tclsh
% source <path_to_occt>/adm/upgrade.tcl % source <path_to_occt>/adm/upgrade.tcl
% upgrade -recurse -all -src=<path_to_your_sources> % upgrade -recurse -all -src=<path_to_your_sources>
~~~~~ ~~~~
On Windows, the helper batch script *upgrade.bat* can be used, provided that Tcl is either available in *PATH*, or configured via *custom.bat* script (for instance, if you use OCCT installed from Windows installer package). Start it from the command prompt: On Windows, the helper batch script *upgrade.bat* can be used, provided that Tcl is either available in *PATH*, or configured via *custom.bat* script (for instance, if you use OCCT installed from Windows installer package). Start it from the command prompt:
~~~~~ ~~~~
cmd> <path_to_occt>\upgrade.bat -recurse -all -inc=<path_to_occt>\inc -src=<path_to_your_sources> [options] cmd> <path_to_occt>\upgrade.bat -recurse -all -inc=<path_to_occt>\inc -src=<path_to_your_sources> [options]
~~~~~ ~~~~
Run the upgrade tool without arguments to see the list of available options. Run the upgrade tool without arguments to see the list of available options.
The upgrade tool performs the following changes in the code. The upgrade tool performs the following changes in the code.
1. Replaces macro *DEFINE_STANDARD_RTTI* by *DEFINE_STANDARD_RTTIEXT*, with second argument indicating base class for the main argument class (if inheritance is recognized by the script): 1. Replaces macro *DEFINE_STANDARD_RTTI* by *DEFINE_STANDARD_RTTIEXT*, with second argument indicating base class for the main argument class (if inheritance is recognized by the script):
~~~~~ ~~~~{.cpp}
DEFINE_STANDARD_RTTI(Class) -> DEFINE_STANDARD_RTTIEXT(Class, Base) DEFINE_STANDARD_RTTI(Class) -> DEFINE_STANDARD_RTTIEXT(Class, Base)
~~~~~ ~~~~
@note If macro *DEFINE_STANDARD_RTTI* with two arguments (used in intermediate development versions of OCCT 7.0) is found, the script will convert it to either *DEFINE_STANDARD_RTTIEXT* or *DEFINE_STANDARD_RTTI_INLINE*. @note If macro *DEFINE_STANDARD_RTTI* with two arguments (used in intermediate development versions of OCCT 7.0) is found, the script will convert it to either *DEFINE_STANDARD_RTTIEXT* or *DEFINE_STANDARD_RTTI_INLINE*.
The former case is used if current file is header and source file with the same name is found in the same folder. The former case is used if current file is header and source file with the same name is found in the same folder.
@ -431,50 +431,50 @@ DEFINE_STANDARD_RTTI(Class) -> DEFINE_STANDARD_RTTIEXT(Class, Base)
The latter variant defines all methods for RTTI as inline, and does not require *IMPLEMENT_STANDARD_RTTIEXT* macro. The latter variant defines all methods for RTTI as inline, and does not require *IMPLEMENT_STANDARD_RTTIEXT* macro.
2. Replaces forward declarations of collection classes previously generated from CDL generics (defined in *TCollection* package) by inclusion of the corresponding header: 2. Replaces forward declarations of collection classes previously generated from CDL generics (defined in *TCollection* package) by inclusion of the corresponding header:
~~~~~ ~~~~{.cpp}
class TColStd_Array1OfReal; -> #include <TColStd_Array1OfReal.hxx> class TColStd_Array1OfReal; -> #include <TColStd_Array1OfReal.hxx>
~~~~~ ~~~~
3. Replaces underscored names of *Handle* classes by usage of a macro: 3. Replaces underscored names of *Handle* classes by usage of a macro:
~~~~~ ~~~~{.cpp}
Handle_Class -> Handle(Class) Handle_Class -> Handle(Class)
~~~~~ ~~~~
This change is not applied if the source or header file is recognized as containing the definition of Qt class with signals or slots, to avoid possible compilation errors of MOC files caused by inability of MOC to recognize macros (see https://doc.qt.io/qt-4.8/signalsandslots.html). This change is not applied if the source or header file is recognized as containing the definition of Qt class with signals or slots, to avoid possible compilation errors of MOC files caused by inability of MOC to recognize macros (see https://doc.qt.io/qt-4.8/signalsandslots.html).
The file is considered as defining a Qt object if it contains strings *Q_OBJECT* and either *slots:* or *signals:*. The file is considered as defining a Qt object if it contains strings *Q_OBJECT* and either *slots:* or *signals:*.
4. Removes forward declarations of classes with names <i>Handle(C)</i> or *Handle_C*, replacing them either by forward declaration of its argument class, or (for files defining Qt objects) <i>\#include</i> statement for a header with the name of the argument class and extension .hxx: 4. Removes forward declarations of classes with names <i>Handle(C)</i> or *Handle_C*, replacing them either by forward declaration of its argument class, or (for files defining Qt objects) <i>\#include</i> statement for a header with the name of the argument class and extension .hxx:
~~~~~ ~~~~{.cpp}
class Handle(TColStd_HArray1OfReal); -> #include <TColStd_HArray1OfReal.hxx> class Handle(TColStd_HArray1OfReal); -> #include <TColStd_HArray1OfReal.hxx>
~~~~~ ~~~~
5. Removes <i> \#includes </i> of files <i>Handle_...hxx</i> that have disappeared in OCCT 7.0: 5. Removes <i> \#includes </i> of files <i>Handle_...hxx</i> that have disappeared in OCCT 7.0:
~~~~~ ~~~~{.cpp}
#include <Handle_Geom_Curve.hxx> -> #include <Handle_Geom_Curve.hxx> ->
~~~~~ ~~~~
6. Removes *typedef* statements that use *Handle* macro to generate the name: 6. Removes *typedef* statements that use *Handle* macro to generate the name:
~~~~~ ~~~~{.cpp}
typedef NCollection_Handle<Message_Msg> Handle(Message_Msg); -> typedef NCollection_Handle<Message_Msg> Handle(Message_Msg); ->
~~~~~ ~~~~
7. Converts C-style casts applied to Handles into calls to <i>DownCast()</i> method: 7. Converts C-style casts applied to Handles into calls to <i>DownCast()</i> method:
~~~~~ ~~~~{.cpp}
((Handle(A)&)b) -> Handle(A)::DownCast(b) ((Handle(A)&)b) -> Handle(A)::DownCast(b)
(Handle(A)&)b -> Handle(A)::DownCast(b) (Handle(A)&)b -> Handle(A)::DownCast(b)
(*((Handle(A)*)&b)) -> Handle(A)::DownCast(b) (*((Handle(A)*)&b)) -> Handle(A)::DownCast(b)
*((Handle(A)*)&b) -> Handle(A)::DownCast(b) *((Handle(A)*)&b) -> Handle(A)::DownCast(b)
(*(Handle(A)*)&b) -> Handle(A)::DownCast(b) (*(Handle(A)*)&b) -> Handle(A)::DownCast(b)
~~~~~ ~~~~
8. Moves <i>Handle()</i> macro out of namespace scope: 8. Moves <i>Handle()</i> macro out of namespace scope:
~~~~~ ~~~~{.cpp}
Namespace::Handle(Class) -> Handle(Namespace::Class) Namespace::Handle(Class) -> Handle(Namespace::Class)
~~~~~ ~~~~
9. Converts local variables of reference type, which are initialized by a temporary object returned by call to <i>DownCast()</i>, to the variables of non-reference type (to avoid using references to destroyed memory): 9. Converts local variables of reference type, which are initialized by a temporary object returned by call to <i>DownCast()</i>, to the variables of non-reference type (to avoid using references to destroyed memory):
~~~~~ ~~~~{.cpp}
const Handle(A)& a = Handle(B)::DownCast (b); -> Handle(A) a (Handle(B)::DownCast (b)); const Handle(A)& a = Handle(B)::DownCast (b); -> Handle(A) a (Handle(B)::DownCast (b));
~~~~~ ~~~~
10. Adds <i>\#include</i> for all classes used as argument to macro <i>STANDARD_TYPE()</i>, except for already included ones; 10. Adds <i>\#include</i> for all classes used as argument to macro <i>STANDARD_TYPE()</i>, except for already included ones;
@ -487,9 +487,9 @@ Namespace::Handle(Class) -> Handle(Namespace::Class)
As long as the upgrade routine runs, some information messages are sent to the standard output. As long as the upgrade routine runs, some information messages are sent to the standard output.
In some cases the warnings or errors like the following may appear: In some cases the warnings or errors like the following may appear:
~~~~~ ~~~~
Error in {HEADER_FILE}: Macro DEFINE_STANDARD_RTTI used for class {CLASS_NAME} whose declaration is not found in this file, cannot fix Error in {HEADER_FILE}: Macro DEFINE_STANDARD_RTTI used for class {CLASS_NAME} whose declaration is not found in this file, cannot fix
~~~~~ ~~~~
Be sure to check carefully all reported errors and warnings, as the corresponding code will likely require manual corrections. Be sure to check carefully all reported errors and warnings, as the corresponding code will likely require manual corrections.
In some cases these messages may help you to detect errors in your code, for instance, cases where *DEFINE_STANDARD_RTTI* macro is used with incorrect class name as an argument. In some cases these messages may help you to detect errors in your code, for instance, cases where *DEFINE_STANDARD_RTTI* macro is used with incorrect class name as an argument.
@ -506,12 +506,12 @@ The use of handle objects (construction, comparison using operators == or !=, us
For example, the following lines will fail to compile if *Geom_Line.hxx* is not included: For example, the following lines will fail to compile if *Geom_Line.hxx* is not included:
~~~~~ ~~~~{.cpp}
Handle(Geom_Line) aLine = 0; Handle(Geom_Line) aLine = 0;
if (aLine != aCurve) {...} if (aLine != aCurve) {...}
if (aCurve->IsKind(STANDARD_TYPE(Geom_Line)) {...} if (aCurve->IsKind(STANDARD_TYPE(Geom_Line)) {...}
aLine = Handle(Geom_Line)::DownCast (aCurve); aLine = Handle(Geom_Line)::DownCast (aCurve);
~~~~~ ~~~~
Note that it is not necessary to include header of the class to declare Handle to it. Note that it is not necessary to include header of the class to declare Handle to it.
However, if you define a class *B* that uses Handle(*A*) in its fields, or contains a method returning Handle(*A*), it is advisable to have header defining *A* included in the header of *B*. However, if you define a class *B* that uses Handle(*A*) in its fields, or contains a method returning Handle(*A*), it is advisable to have header defining *A* included in the header of *B*.
@ -523,31 +523,31 @@ This issue appears in the compilers that do not support default arguments in tem
The problem is that operator <i> const handle<T2>& </i> is defined for any type *T2*, thus the compiler cannot make the right choice. The problem is that operator <i> const handle<T2>& </i> is defined for any type *T2*, thus the compiler cannot make the right choice.
Example: Example:
~~~~~ ~~~~{.cpp}
void func (const Handle(Geom_Curve)&); void func (const Handle(Geom_Curve)&);
void func (const Handle(Geom_Surface)&); void func (const Handle(Geom_Surface)&);
Handle(Geom_TrimmedCurve) aCurve = new Geom_TrimmedCurve (...); Handle(Geom_TrimmedCurve) aCurve = new Geom_TrimmedCurve (...);
func (aCurve); // ambiguity error in VC++ 10 func (aCurve); // ambiguity error in VC++ 10
~~~~~ ~~~~
Note that this problem can be avoided in many cases if macro *OCCT_HANDLE_NOCAST* is used, see @ref upgrade_occt700_cdl_nocast "below". Note that this problem can be avoided in many cases if macro *OCCT_HANDLE_NOCAST* is used, see @ref upgrade_occt700_cdl_nocast "below".
To resolve this ambiguity, change your code so that argument type should correspond exactly to the function signature. To resolve this ambiguity, change your code so that argument type should correspond exactly to the function signature.
In some cases this can be done by using the relevant type for the corresponding variable, like in the example above: In some cases this can be done by using the relevant type for the corresponding variable, like in the example above:
~~~~~ ~~~~{.cpp}
Handle(Geom_Curve) aCurve = new Geom_TrimmedCurve (...); Handle(Geom_Curve) aCurve = new Geom_TrimmedCurve (...);
~~~~~ ~~~~
Other variants consist in assigning the argument to a local variable of the correct type and using the direct cast or constructor: Other variants consist in assigning the argument to a local variable of the correct type and using the direct cast or constructor:
~~~~~ ~~~~{.cpp}
const Handle(Geom_Curve)& aGCurve (aTrimmedCurve); const Handle(Geom_Curve)& aGCurve (aTrimmedCurve);
func (aGCurve); // OK - argument has exact type func (aGCurve); // OK - argument has exact type
func (static_cast(aCurve)); // OK - direct cast func (static_cast(aCurve)); // OK - direct cast
func (Handle(Geom_Curve)(aCurve)); // OK - temporary handle is constructed func (Handle(Geom_Curve)(aCurve)); // OK - temporary handle is constructed
~~~~~ ~~~~
Another possibility consists in defining additional template variant of the overloaded function causing ambiguity, and using *SFINAE* to resolve the ambiguity. Another possibility consists in defining additional template variant of the overloaded function causing ambiguity, and using *SFINAE* to resolve the ambiguity.
This technique can be illustrated by the definition of the template variant of method <i>IGESData_IGESWriter::Send()</i>. This technique can be illustrated by the definition of the template variant of method <i>IGESData_IGESWriter::Send()</i>.
@ -558,31 +558,31 @@ As the cast of a handle to the reference to another handle to the base type has
For example: For example:
~~~~~ ~~~~{.cpp}
Handle(Geom_Geometry) aC = GC_MakeLine (p, v); // compiler error Handle(Geom_Geometry) aC = GC_MakeLine (p, v); // compiler error
~~~~~ ~~~~
The problem is that the class *GC_MakeLine* has a user-defined conversion to <i>const Handle(Geom_TrimmedCurve)&,</i> which is not the same as the type of the local variable *aC*. The problem is that the class *GC_MakeLine* has a user-defined conversion to <i>const Handle(Geom_TrimmedCurve)&,</i> which is not the same as the type of the local variable *aC*.
To resolve this, use method <i>Value()</i>: To resolve this, use method <i>Value()</i>:
~~~~~ ~~~~{.cpp}
Handle(Geom_Geometry) aC = GC_MakeLine (p, v).Value(); // ok Handle(Geom_Geometry) aC = GC_MakeLine (p, v).Value(); // ok
~~~~~ ~~~~
or use variable of the appropriate type: or use variable of the appropriate type:
~~~~~ ~~~~{.cpp}
Handle(Geom_TrimmedCurve) aC = GC_MakeLine (p, v); // ok Handle(Geom_TrimmedCurve) aC = GC_MakeLine (p, v); // ok
~~~~~ ~~~~
A similar problem appears with GCC compiler, when *const* handle to derived type is used to construct handle to base type via assignment (and in some cases in return statement), for instance: A similar problem appears with GCC compiler, when *const* handle to derived type is used to construct handle to base type via assignment (and in some cases in return statement), for instance:
~~~~~ ~~~~{.cpp}
const Handle(Geom_Line) aLine; const Handle(Geom_Line) aLine;
Handle(Geom_Curve) c1 = aLine; // GCC error Handle(Geom_Curve) c1 = aLine; // GCC error
Handle(Geom_Curve) c2 (aLine); // ok Handle(Geom_Curve) c2 (aLine); // ok
~~~~~ ~~~~
This problem is specific to GCC and it does not appear if macro *OCCT_HANDLE_NOCAST* is used, see @ref upgrade_occt700_cdl_nocast "below". This problem is specific to GCC and it does not appear if macro *OCCT_HANDLE_NOCAST* is used, see @ref upgrade_occt700_cdl_nocast "below".
@ -593,20 +593,20 @@ You might need to clean your code from incorrect use of macros *STANDARD_TYPE*()
1. Explicit definitions of static functions with names generated by macro *STANDARD_TYPE()*, which are artifacts of old implementation of RTTI, should be removed. 1. Explicit definitions of static functions with names generated by macro *STANDARD_TYPE()*, which are artifacts of old implementation of RTTI, should be removed.
Example: Example:
~~~~~ ~~~~{.cpp}
const Handle(Standard_Type)& STANDARD_TYPE(math_GlobOptMin) const Handle(Standard_Type)& STANDARD_TYPE(math_GlobOptMin)
{ {
static Handle(Standard_Type) _atype = new Standard_Type ("math_GlobOptMin", sizeof (math_GlobOptMin)); static Handle(Standard_Type) _atype = new Standard_Type ("math_GlobOptMin", sizeof (math_GlobOptMin));
return _atype; return _atype;
} }
~~~~~ ~~~~
2. Incorrect location of closing parenthesis of *Handle()* macro that was not detectable in OCCT 6.x will cause a compiler error and must be corrected. 2. Incorrect location of closing parenthesis of *Handle()* macro that was not detectable in OCCT 6.x will cause a compiler error and must be corrected.
Example (note misplaced closing parenthesis): Example (note misplaced closing parenthesis):
~~~~~ ~~~~{.cpp}
aBSpline = Handle( Geom2d_BSplineCurve::DownCast(BS->Copy()) ); aBSpline = Handle( Geom2d_BSplineCurve::DownCast(BS->Copy()) );
~~~~~ ~~~~
#### Use of class Standard_AncestorIterator #### Use of class Standard_AncestorIterator
@ -617,20 +617,20 @@ Class *Standard_AncestorIterator* has been removed; use method *Parent()* of *St
Handles in OCCT 7.0 do not have the operator of conversion to <i>Standard_Transient*,</i> which was present in earlier versions. Handles in OCCT 7.0 do not have the operator of conversion to <i>Standard_Transient*,</i> which was present in earlier versions.
This is done to prevent possible unintended errors like this: This is done to prevent possible unintended errors like this:
~~~~~ ~~~~{.cpp}
Handle(Geom_Line) aLine = ...; Handle(Geom_Line) aLine = ...;
Handle(Geom_Surface) aSurf = ...; Handle(Geom_Surface) aSurf = ...;
... ...
if (aLine == aSurf) {...} // will cause a compiler error in OCCT 7.0, but not OCCT 6.x if (aLine == aSurf) {...} // will cause a compiler error in OCCT 7.0, but not OCCT 6.x
~~~~~ ~~~~
The places where this implicit cast has been used should be corrected manually. The places where this implicit cast has been used should be corrected manually.
The typical situation is when Handle is passed to stream: The typical situation is when Handle is passed to stream:
~~~~~ ~~~~{.cpp}
Handle(Geom_Line) aLine = ...; Handle(Geom_Line) aLine = ...;
os << aLine; // in OCCT 6.9.0, resolves to operator << (void*) os << aLine; // in OCCT 6.9.0, resolves to operator << (void*)
~~~~~ ~~~~
Call method <i>get()</i> explicitly to output the address of the Handle. Call method <i>get()</i> explicitly to output the address of the Handle.
@ -639,24 +639,24 @@ Call method <i>get()</i> explicitly to output the address of the Handle.
Method *DownCast()* in OCCT 7.0 is made templated; if its argument is not a base class, "deprecated" compiler warning is generated. Method *DownCast()* in OCCT 7.0 is made templated; if its argument is not a base class, "deprecated" compiler warning is generated.
This is done to prevent possible unintended errors like this: This is done to prevent possible unintended errors like this:
~~~~~ ~~~~{.cpp}
Handle(Geom_Surface) aSurf = ; Handle(Geom_Surface) aSurf = ;
Handle(Geom_Line) aLine = Handle(Geom_Line) aLine =
Handle(Geom_Line)::DownCast (aSurf); // will cause a compiler warning in OCCT 7.0, but not OCCT 6.x Handle(Geom_Line)::DownCast (aSurf); // will cause a compiler warning in OCCT 7.0, but not OCCT 6.x
~~~~~ ~~~~
The places where this cast has been used should be corrected manually. The places where this cast has been used should be corrected manually.
If down casting is used in a template context where the argument can have the same or unrelated type so that *DownCast()* may be not available in all cases, use C++ *dynamic_cast<>* instead, e.g.: If down casting is used in a template context where the argument can have the same or unrelated type so that *DownCast()* may be not available in all cases, use C++ *dynamic_cast<>* instead, e.g.:
~~~~~ ~~~~{.cpp}
template <class T> template <class T>
bool CheckLine (const Handle(T) theArg) bool CheckLine (const Handle(T) theArg)
{ {
Handle(Geom_Line) aLine = dynamic_cast<Geom_Line> (theArg.get()); Handle(Geom_Line) aLine = dynamic_cast<Geom_Line> (theArg.get());
... ...
} }
~~~~~ ~~~~
@subsubsection upgrade_occt700_cdl_runtime Possible runtime problems @subsubsection upgrade_occt700_cdl_runtime Possible runtime problems
@ -671,19 +671,19 @@ This problem does not appear if macro *OCCT_HANDLE_NOCAST* is used during compil
Example: Example:
~~~~~ ~~~~{.cpp}
// note that DownCast() returns new temporary object! // note that DownCast() returns new temporary object!
const Handle(Geom_BoundedCurve)& aBC = const Handle(Geom_BoundedCurve)& aBC =
Handle(Geom_TrimmedCurve)::DownCast(aCurve); Handle(Geom_TrimmedCurve)::DownCast(aCurve);
aBC->Transform (T); // access violation in OCCT 7.0 aBC->Transform (T); // access violation in OCCT 7.0
~~~~~ ~~~~
@subsubsection upgrade_occt700_cdl_nocast Option to avoid cast of handle to reference to base type @subsubsection upgrade_occt700_cdl_nocast Option to avoid cast of handle to reference to base type
In OCCT 6.x and earlier versions the handle classes formed a hierarchy echoing the hierarchy of the corresponding object classes . In OCCT 6.x and earlier versions the handle classes formed a hierarchy echoing the hierarchy of the corresponding object classes .
This automatically enabled the possibility to use the handle to a derived class in all contexts where the handle to a base class was needed, e.g. to pass it in a function by reference without copying: This automatically enabled the possibility to use the handle to a derived class in all contexts where the handle to a base class was needed, e.g. to pass it in a function by reference without copying:
~~~~ ~~~~{.cpp}
Standard_Boolean GetCurve (Handle(Geom_Curve)& theCurve); Standard_Boolean GetCurve (Handle(Geom_Curve)& theCurve);
.... ....
Handle(Geom_Line) aLine; Handle(Geom_Line) aLine;
@ -705,13 +705,13 @@ This implies creation of temporary objects and hence may be more expensive at ru
The code that relies on the possibility of casting to base should be amended to always use the handle of argument type in function call and to use *DownCast()* to safely convert the result to the desired type. The code that relies on the possibility of casting to base should be amended to always use the handle of argument type in function call and to use *DownCast()* to safely convert the result to the desired type.
For instance, the code from the example below can be changed as follows: For instance, the code from the example below can be changed as follows:
~~~~~ ~~~~{.cpp}
Handle(Geom_Line) aLine; Handle(Geom_Line) aLine;
Handle(Geom_Curve) aCurve; Handle(Geom_Curve) aCurve;
if (GetCurve (aCure) && !(aLine = Handle(Geom_Line)::DownCast (aCurve)).IsNull()) { if (GetCurve (aCure) && !(aLine = Handle(Geom_Line)::DownCast (aCurve)).IsNull()) {
// use aLine safely // use aLine safely
} }
~~~~~ ~~~~
@subsubsection upgrade_occt700_cdl_compat Preserving compatibility with OCCT 6.x @subsubsection upgrade_occt700_cdl_compat Preserving compatibility with OCCT 6.x
@ -724,12 +724,12 @@ If you like to preserve the compatibility of your application code with OCCT ver
3. Define macros *DEFINE_STANDARD_RTTIEXT* and *DEFINE_STANDARD_RTTI_INLINE* when building with previous versions of OCCT, resolving to *DEFINE_STANDARD_RTTI* with single argument 3. Define macros *DEFINE_STANDARD_RTTIEXT* and *DEFINE_STANDARD_RTTI_INLINE* when building with previous versions of OCCT, resolving to *DEFINE_STANDARD_RTTI* with single argument
Example: Example:
~~~~~ ~~~~{.cpp}
#if OCC_VERSION_HEX < 0x070000 #if OCC_VERSION_HEX < 0x070000
#define DEFINE_STANDARD_RTTIEXT(C1,C2) DEFINE_STANDARD_RTTI(C1) #define DEFINE_STANDARD_RTTIEXT(C1,C2) DEFINE_STANDARD_RTTI(C1)
#define DEFINE_STANDARD_RTTI_INLINE(C1,C2) DEFINE_STANDARD_RTTI(C1) #define DEFINE_STANDARD_RTTI_INLINE(C1,C2) DEFINE_STANDARD_RTTI(C1)
#endif #endif
~~~~~ ~~~~
@subsubsection upgrade_occt700_cdl_wok Applications based on CDL and WOK @subsubsection upgrade_occt700_cdl_wok Applications based on CDL and WOK
@ -768,7 +768,7 @@ The code that used the tools provided by that package should be corrected manual
The recommended approach is to use sorting algorithms provided by STL. The recommended approach is to use sorting algorithms provided by STL.
For instance: For instance:
~~~~~ ~~~~{.cpp}
#include <SortTools_StraightInsertionSortOfReal.hxx> #include <SortTools_StraightInsertionSortOfReal.hxx>
#include <SortTools_ShellSortOfReal.hxx> #include <SortTools_ShellSortOfReal.hxx>
#include <TCollection_CompareOfReal.hxx> #include <TCollection_CompareOfReal.hxx>
@ -777,15 +777,15 @@ TCollection_Array1OfReal aValues = ...;
... ...
TCollection_CompareOfReal aCompReal; TCollection_CompareOfReal aCompReal;
SortTools_StraightInsertionSortOfReal::Sort(aValues, aCompReal); SortTools_StraightInsertionSortOfReal::Sort(aValues, aCompReal);
~~~~~ ~~~~
can be replaced by: can be replaced by:
~~~~~ ~~~~{.cpp}
#include <algorithm> #include <algorithm>
... ...
TCollection_Array1OfReal aValues = ...; TCollection_Array1OfReal aValues = ...;
... ...
std::stable_sort (aValues.begin(), aValues.end()); std::stable_sort (aValues.begin(), aValues.end());
~~~~~ ~~~~
@subsection upgrade_occt700_2dlayers On-screen objects and ColorScale @subsection upgrade_occt700_2dlayers On-screen objects and ColorScale
@ -802,7 +802,7 @@ Predefined Z-layers *Graphic3d_ZLayerId_TopOSD* and *Graphic3d_ZLayerId_BotOSD*
The property of *V3d_View* storing the global *ColorScale* object has been removed with associated methods *V3d_View::ColorScaleDisplay(), V3d_View::ColorScaleErase(), V3d_View::ColorScaleIsDisplayed()* and *V3d_View::ColorScale()* as well as the classes *V3d_ColorScale, V3d_ColorScaleLayerItem* and *Aspect_ColorScale*. The property of *V3d_View* storing the global *ColorScale* object has been removed with associated methods *V3d_View::ColorScaleDisplay(), V3d_View::ColorScaleErase(), V3d_View::ColorScaleIsDisplayed()* and *V3d_View::ColorScale()* as well as the classes *V3d_ColorScale, V3d_ColorScaleLayerItem* and *Aspect_ColorScale*.
Here is an example of creating *ColorScale* using the updated API: Here is an example of creating *ColorScale* using the updated API:
~~~~~ ~~~~{.cpp}
Handle(AIS_ColorScale) aCS = new AIS_ColorScale(); Handle(AIS_ColorScale) aCS = new AIS_ColorScale();
// configuring // configuring
Standard_Integer aWidth, aHeight; Standard_Integer aWidth, aHeight;
@ -815,13 +815,13 @@ aCS->SetZLayer (Graphic3d_ZLayerId_TopOSD);
aCS->SetTransformPersistence (Graphic3d_TMF_2d, gp_Pnt (-1,-1,0)); aCS->SetTransformPersistence (Graphic3d_TMF_2d, gp_Pnt (-1,-1,0));
aCS->SetToUpdate(); aCS->SetToUpdate();
theContextAIS->Display (aCS); theContextAIS->Display (aCS);
~~~~~ ~~~~
To see how 2d objects are implemented in OCCT you can call Draw commands *vcolorscale, vlayerline* or *vdrawtext* (with <i>-2d</i> option). To see how 2d objects are implemented in OCCT you can call Draw commands *vcolorscale, vlayerline* or *vdrawtext* (with <i>-2d</i> option).
Draw command *vcolorscale* now requires the name of *ColorScale* object as argument. Draw command *vcolorscale* now requires the name of *ColorScale* object as argument.
To display this object use command *vdisplay*. For example: To display this object use command *vdisplay*. For example:
~~~~~ ~~~~{.php}
pload VISUALIZATION pload VISUALIZATION
vinit vinit
vcolorscale cs -demo vcolorscale cs -demo
@ -832,16 +832,16 @@ vsetdispmode 1
vfit vfit
vlayerline 0 300 300 300 10 vlayerline 0 300 300 300 10
vdrawtext t "2D-TEXT" -2d -pos 0 150 0 -color red vdrawtext t "2D-TEXT" -2d -pos 0 150 0 -color red
~~~~~ ~~~~
Here is a small example in C++ illustrating how to display a custom AIS object in 2d: Here is a small example in C++ illustrating how to display a custom AIS object in 2d:
~~~~~ ~~~~{.cpp}
Handle(AIS_InteractiveContext) aContext = ...; Handle(AIS_InteractiveContext) aContext = ...;
Handle(AIS_InteractiveObject) anObj =...; // create an AIS object Handle(AIS_InteractiveObject) anObj =...; // create an AIS object
anObj->SetZLayer(Graphic3d_ZLayerId_TopOSD); // display object in overlay anObj->SetZLayer(Graphic3d_ZLayerId_TopOSD); // display object in overlay
anObj->SetTransformPersistence (Graphic3d_TMF_2d, gp_Pnt (-1,-1,0)); // set 2d flag, coordinate origin is set to down-left corner anObj->SetTransformPersistence (Graphic3d_TMF_2d, gp_Pnt (-1,-1,0)); // set 2d flag, coordinate origin is set to down-left corner
aContext->Display (anObj); // display the object aContext->Display (anObj); // display the object
~~~~~ ~~~~
@subsection upgrade_occt700_userdraw UserDraw and Visual3d @subsection upgrade_occt700_userdraw UserDraw and Visual3d
@ -879,7 +879,7 @@ The functionality previously provided by *Visual3d* package has been redesigned
Old APIs based on global callback functions for creating *UserDraw* objects and for performing custom OpenGL rendering within the view have been dropped. Old APIs based on global callback functions for creating *UserDraw* objects and for performing custom OpenGL rendering within the view have been dropped.
*UserDraw* callbacks are no more required since *OpenGl_Group* now inherits *Graphic3d_Group* and thus can be accessed directly from *AIS_InteractiveObject*: *UserDraw* callbacks are no more required since *OpenGl_Group* now inherits *Graphic3d_Group* and thus can be accessed directly from *AIS_InteractiveObject*:
~~~~~ ~~~~{.cpp}
//! Class implementing custom OpenGL element. //! Class implementing custom OpenGL element.
class UserDrawElement : public OpenGl_Element {}; class UserDrawElement : public OpenGl_Element {};
@ -901,12 +901,12 @@ void UserDrawObject::Compute (const Handle(PrsMgr_PresentationManager)& thePrsMg
// invalidate bounding box of the scene // invalidate bounding box of the scene
thePrsMgr->StructureManager()->Update(); thePrsMgr->StructureManager()->Update();
} }
~~~~~ ~~~~
To perform a custom OpenGL code within the view, it is necessary to inherit from class *OpenGl_View*. To perform a custom OpenGL code within the view, it is necessary to inherit from class *OpenGl_View*.
See the following code sample: See the following code sample:
~~~~~ ~~~~{.cpp}
//! Custom view. //! Custom view.
class UserView : public OpenGl_View class UserView : public OpenGl_View
{ {
@ -953,7 +953,7 @@ public:
} }
}; };
~~~~~ ~~~~
@subsection upgrade_occt700_localcontext Deprecation of Local Context @subsection upgrade_occt700_localcontext Deprecation of Local Context
@ -1172,22 +1172,22 @@ Class *BRepOffsetAPI_MakeOffsetShape*:
* *BRepOffsetAPI_MakeOffsetShape::PerformByJoin()* - method has been added. This method is old algorithm behaviour. * *BRepOffsetAPI_MakeOffsetShape::PerformByJoin()* - method has been added. This method is old algorithm behaviour.
The code below shows new calling procedure: The code below shows new calling procedure:
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.cpp} ~~~~{.cpp}
BRepOffsetAPI_MakeOffsetShape OffsetMaker; BRepOffsetAPI_MakeOffsetShape OffsetMaker;
OffsetMaker.PerformByJoin(Shape, OffsetValue, Tolerance); OffsetMaker.PerformByJoin(Shape, OffsetValue, Tolerance);
NewShape = OffsetMaker.Shape(); NewShape = OffsetMaker.Shape();
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~
Class *BRepOffsetAPI_MakeThickSolid*: Class *BRepOffsetAPI_MakeThickSolid*:
* *BRepOffsetAPI_MakeThickSolid::BRepOffsetAPI_MakeThickSolid()* - constructor with parameters has been deleted. * *BRepOffsetAPI_MakeThickSolid::BRepOffsetAPI_MakeThickSolid()* - constructor with parameters has been deleted.
* *BRepOffsetAPI_MakeThickSolid::MakeThickSolidByJoin()* - method has been added. This method is old algorithm behaviour. * *BRepOffsetAPI_MakeThickSolid::MakeThickSolidByJoin()* - method has been added. This method is old algorithm behaviour.
The code below shows new calling procedure: The code below shows new calling procedure:
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.cpp} ~~~~{.cpp}
BRepOffsetAPI_MakeThickSolid BodyMaker; BRepOffsetAPI_MakeThickSolid BodyMaker;
BodyMaker.MakeThickSolidByJoin(myBody, facesToRemove, -myThickness / 50, 1.e-3); BodyMaker.MakeThickSolidByJoin(myBody, facesToRemove, -myThickness / 50, 1.e-3);
myBody = BodyMaker.Shape(); myBody = BodyMaker.Shape();
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~
@subsection upgrade_720_highlight Highlight style @subsection upgrade_720_highlight Highlight style
@ -1317,7 +1317,7 @@ One can use this functionality in two ways:
The code example below demonstrates how to read shapes from a storage driver using *StdStorage* class. The code example below demonstrates how to read shapes from a storage driver using *StdStorage* class.
~~~~ ~~~~{.cpp}
// aDriver should be created and opened for reading // aDriver should be created and opened for reading
Handle(StdStorage_Data) aData; Handle(StdStorage_Data) aData;
@ -1355,7 +1355,7 @@ if (!aRoots.IsNull())
The following code demonstrates how to write shapes in OCCT 7.2.0 using *StdStorage* class. The following code demonstrates how to write shapes in OCCT 7.2.0 using *StdStorage* class.
~~~~ ~~~~{.cpp}
// Create a file driver // Create a file driver
NCollection_Handle<Storage_BaseDriver> aFileDriver(new FSD_File()); NCollection_Handle<Storage_BaseDriver> aFileDriver(new FSD_File());
@ -1640,7 +1640,7 @@ The following changes have been introduced in the API of *BRepMesh_IncrementalMe
Example of usage: Example of usage:
Case 1 (explicit parameters): Case 1 (explicit parameters):
~~~~ ~~~~{.cpp}
#include <IMeshData_Status.hxx> #include <IMeshData_Status.hxx>
#include <IMeshTools_Parameters.hxx> #include <IMeshTools_Parameters.hxx>
#include <BRepMesh_IncrementalMesh.hxx> #include <BRepMesh_IncrementalMesh.hxx>
@ -1688,7 +1688,7 @@ In fact, drawing points or lines with lighting applied is a valid use case, but
As aspects for different primitive types have been merged, Graphic3d_Group does no more provide per-type aspect properties. As aspects for different primitive types have been merged, Graphic3d_Group does no more provide per-type aspect properties.
Existing code relying on old behavior and putting interleaved per-type aspects into single Graphic3d_Group should be updated. Existing code relying on old behavior and putting interleaved per-type aspects into single Graphic3d_Group should be updated.
For example, the following pseudo-code will not work anymore, because all *SetGroupPrimitivesAspect* calls will setup the same property: For example, the following pseudo-code will not work anymore, because all *SetGroupPrimitivesAspect* calls will setup the same property:
~~~~ ~~~~{.cpp}
Handle(Graphic3d_Group) aGroup = thePrs->NewGroup(); Handle(Graphic3d_Group) aGroup = thePrs->NewGroup();
aGroup->SetGroupPrimitivesAspect (myDrawer->ShadingAspect()->Aspect()); aGroup->SetGroupPrimitivesAspect (myDrawer->ShadingAspect()->Aspect());
aGroup->SetGroupPrimitivesAspect (myDrawer->LineAspect()->Aspect()); //!< overrides previous aspect aGroup->SetGroupPrimitivesAspect (myDrawer->LineAspect()->Aspect()); //!< overrides previous aspect
@ -1700,7 +1700,7 @@ aGroup->AddPrimitiveArray (aTris);
~~~~ ~~~~
To solve the problem, the code should be modified to either put primitives into dedicated groups (preferred approach), or using *SetPrimitivesAspect* in proper order: To solve the problem, the code should be modified to either put primitives into dedicated groups (preferred approach), or using *SetPrimitivesAspect* in proper order:
~~~~ ~~~~{.cpp}
Handle(Graphic3d_Group) aGroup = thePrs->NewGroup(); Handle(Graphic3d_Group) aGroup = thePrs->NewGroup();
aGroup->SetGroupPrimitivesAspect (myDrawer->ShadingAspect()->Aspect()); aGroup->SetGroupPrimitivesAspect (myDrawer->ShadingAspect()->Aspect());
@ -1718,7 +1718,7 @@ Decomposition of Ambient, Diffuse, Specular and Emissive properties has been eli
As result, the following methods of *Graphic3d_MaterialAspect* class have been removed: SetReflectionMode(), SetReflectionModeOn(), Ambient(), Diffuse(), Emissive(), Specular(), SetAmbient(), SetDiffuse(), SetSpecular(), SetEmissive(). As result, the following methods of *Graphic3d_MaterialAspect* class have been removed: SetReflectionMode(), SetReflectionModeOn(), Ambient(), Diffuse(), Emissive(), Specular(), SetAmbient(), SetDiffuse(), SetSpecular(), SetEmissive().
Previously, computation of final value required the following code: Previously, computation of final value required the following code:
~~~~ ~~~~{.cpp}
Graphic3d_MaterialAspect theMaterial; Quantity_Color theInteriorColor; Graphic3d_MaterialAspect theMaterial; Quantity_Color theInteriorColor;
Graphic3d_Vec3 anAmbient (0.0f); Graphic3d_Vec3 anAmbient (0.0f);
if (theMaterial.ReflectionMode (Graphic3d_TOR_AMBIENT)) if (theMaterial.ReflectionMode (Graphic3d_TOR_AMBIENT))
@ -1730,7 +1730,7 @@ if (theMaterial.ReflectionMode (Graphic3d_TOR_AMBIENT))
~~~~ ~~~~
New code looks like this: New code looks like this:
~~~~ ~~~~{.cpp}
Graphic3d_MaterialAspect theMaterial; Quantity_Color theInteriorColor; Graphic3d_MaterialAspect theMaterial; Quantity_Color theInteriorColor;
Graphic3d_Vec3 anAmbient = theMaterial.AmbientColor(); Graphic3d_Vec3 anAmbient = theMaterial.AmbientColor();
if (theMaterial.MaterialType (Graphic3d_MATERIAL_ASPECT)) { anAmbient *= (Graphic3d_Vec3 )theInteriorColor; } if (theMaterial.MaterialType (Graphic3d_MATERIAL_ASPECT)) { anAmbient *= (Graphic3d_Vec3 )theInteriorColor; }
@ -1751,7 +1751,7 @@ Existing code should be updated to:
Parameters of *Text* in *Graphic3d_Group* are moved into a new *Graphic3d_Text* class. *AddText* of *Graphic3d_Group* should be used instead of the previous *Text*. Parameters of *Text* in *Graphic3d_Group* are moved into a new *Graphic3d_Text* class. *AddText* of *Graphic3d_Group* should be used instead of the previous *Text*.
The previous code: The previous code:
~~~~ ~~~~{.cpp}
Standard_Real x, y, z; Standard_Real x, y, z;
theAttachmentPoint.Coord(x,y,z); theAttachmentPoint.Coord(x,y,z);
theGroup->Text (theText, theGroup->Text (theText,
@ -1763,7 +1763,7 @@ theGroup->Text (theText,
theAspect->VerticalJustification()); theAspect->VerticalJustification());
~~~~ ~~~~
should be replaced by the new code: should be replaced by the new code:
~~~~ ~~~~{.cpp}
Handle(Graphic3d_Text) aText = new Graphic3d_Text (theAspect->Height()); Handle(Graphic3d_Text) aText = new Graphic3d_Text (theAspect->Height());
aText->SetText (theText.ToExtString()); aText->SetText (theText.ToExtString());
aText->SetPosition (theAttachmentPoint); aText->SetPosition (theAttachmentPoint);
@ -1927,7 +1927,7 @@ The method Select3D_SensitiveEntity::NbSubElements() has been changed to be cons
@subsection upgrade_750_Booleans Changes in Boolean operations algorithm @subsection upgrade_750_Booleans Changes in Boolean operations algorithm
* TreatCompound method has been moved from *BOPAlgo_Tools* to *BOPTools_AlgoTools*. Additionally, the map parameter became optional: * TreatCompound method has been moved from *BOPAlgo_Tools* to *BOPTools_AlgoTools*. Additionally, the map parameter became optional:
~~~~ ~~~~{.cpp}
void BOPTools_AlgoTools::TreatCompound (const TopoDS_Shape& theS, void BOPTools_AlgoTools::TreatCompound (const TopoDS_Shape& theS,
TopTools_ListOfShape& theLS, TopTools_ListOfShape& theLS,
TopTools_MapOfShape* theMap = NULL); TopTools_MapOfShape* theMap = NULL);
@ -2094,25 +2094,25 @@ corresponding type of the message.
The code that used operator << for messenger, should be ported as follows. The code that used operator << for messenger, should be ported as follows.
Before the change: Before the change:
~~~~~ ~~~~{.cpp}
Handle(Message_Messenger) theMessenger = ...; Handle(Message_Messenger) theMessenger = ...;
theMessenger << "Value = " << anInteger << Message_EndLine; theMessenger << "Value = " << anInteger << Message_EndLine;
~~~~~ ~~~~
After the change, single-line variant: After the change, single-line variant:
~~~~~ ~~~~{.cpp}
Handle(Message_Messenger) theMessenger = ...; Handle(Message_Messenger) theMessenger = ...;
theMessenger->SendInfo() << "Value = " << anInteger << std::endl; theMessenger->SendInfo() << "Value = " << anInteger << std::endl;
~~~~~ ~~~~
After the change, extended variant: After the change, extended variant:
~~~~~ ~~~~{.cpp}
Handle(Message_Messenger) theMessenger = ...; Handle(Message_Messenger) theMessenger = ...;
Message_Messenger::StreamBuffer aSender = theMessenger->SendInfo(); Message_Messenger::StreamBuffer aSender = theMessenger->SendInfo();
aSender << "Array: [ "; aSender << "Array: [ ";
for (int i = 0; i < aNb; ++i) { aSender << anArray[i] << " "; } for (int i = 0; i < aNb; ++i) { aSender << anArray[i] << " "; }
aSender << "]" << std::endl; // aSender can be used further for other messages aSender << "]" << std::endl; // aSender can be used further for other messages
~~~~~ ~~~~
@subsection upgrade_750_message_printer Message_Printer interface change @subsection upgrade_750_message_printer Message_Printer interface change
@ -2136,13 +2136,13 @@ provided that each thread deals with its own instance of *TDataStd_Application*
Note that neither *TDataStd_Application* nor *TDocStd_Document* is protected from concurrent access from several threads. Note that neither *TDataStd_Application* nor *TDocStd_Document* is protected from concurrent access from several threads.
Such protection, if necessary, shall be implemented on the application level. Such protection, if necessary, shall be implemented on the application level.
For an example, access to labels and attributes could be protected by mutex if there is a probability that different threads access the same labels / attributes: For an example, access to labels and attributes could be protected by mutex if there is a probability that different threads access the same labels / attributes:
~~~~~ ~~~~{.cpp}
{ {
Standard_Mutex::Sentry aSentry (myMainLabelAccess); Standard_Mutex::Sentry aSentry (myMainLabelAccess);
TDF_Label aChildLab = aDocument->Main().NewChild(); TDF_Label aChildLab = aDocument->Main().NewChild();
TDataStd_Integer::Set(aChildLab, 0); TDataStd_Integer::Set(aChildLab, 0);
} }
~~~~~ ~~~~
@subsection upgrade_750_draw_hotkeys Draw Harness hotkeys @subsection upgrade_750_draw_hotkeys Draw Harness hotkeys
@ -2179,10 +2179,10 @@ Existing code relying on old behavior, if any, shall be rewritten.
Geom_RectangularTrimmedSurface sequentially trimming in U and V directions already no longer loses the first trim. Geom_RectangularTrimmedSurface sequentially trimming in U and V directions already no longer loses the first trim.
For example: For example:
~~~~~ ~~~~{.cpp}
Handle(Geom_RectangularTrimmedSurface) ST = new Geom_RectangularTrimmedSurface (Sbase, u1, u2, Standard_True); // trim along U Handle(Geom_RectangularTrimmedSurface) ST = new Geom_RectangularTrimmedSurface (Sbase, u1, u2, Standard_True); // trim along U
Handle(Geom_RectangularTrimmedSurface) ST1 = new Geom_RectangularTrimmedSurface (ST, v1, v2, Standard_False); // trim along V Handle(Geom_RectangularTrimmedSurface) ST1 = new Geom_RectangularTrimmedSurface (ST, v1, v2, Standard_False); // trim along V
~~~~~ ~~~~
gives different result. gives different result.
In current version ST1 - surface trimmed only along V, U trim is removed; In current version ST1 - surface trimmed only along V, U trim is removed;
After modification ST1 - surface trimmed along U and V, U trim is kept. After modification ST1 - surface trimmed along U and V, U trim is kept.

4040
dox/user_guides/draw_test_harness/draw_test_harness.md
View File

File diff suppressed because one or more lines are too long

204
dox/user_guides/foundation_classes/foundation_classes.md
View File

@ -183,9 +183,9 @@ A variable of a type manipulated by handle which is not attached to an object is
To reference an object, we instantiate the class with one of its constructors. To reference an object, we instantiate the class with one of its constructors.
For example, in C++: For example, in C++:
~~~~~ ~~~~{.cpp}
Handle(MyClass) anObject = new MyClass(); Handle(MyClass) anObject = new MyClass();
~~~~~ ~~~~
In Open CASCADE Technology, the Handles are specific classes that are used to safely manipulate objects allocated in the dynamic memory by reference, In Open CASCADE Technology, the Handles are specific classes that are used to safely manipulate objects allocated in the dynamic memory by reference,
providing reference counting mechanism and automatic destruction of the object when it is not referenced. providing reference counting mechanism and automatic destruction of the object when it is not referenced.
@ -302,15 +302,15 @@ It provides a reference counter field, inherited by all its descendant classes,
Objects of classes derived (directly or indirectly) from *Transient*, are normally allocated in dynamic memory using operator **new**, and manipulated by handle. Objects of classes derived (directly or indirectly) from *Transient*, are normally allocated in dynamic memory using operator **new**, and manipulated by handle.
Handle is defined as template class *opencascade::handle<>*. Handle is defined as template class *opencascade::handle<>*.
Open CASCADE Technology provides preprocessor macro *Handle()* that is historically used throughout OCCT code to name a handle: Open CASCADE Technology provides preprocessor macro *Handle()* that is historically used throughout OCCT code to name a handle:
~~~~~{.cpp} ~~~~{.cpp}
Handle(Geom_Line) aLine; // "Handle(Geom_Line)" is expanded to "opencascade::handle<Geom_Line>" Handle(Geom_Line) aLine; // "Handle(Geom_Line)" is expanded to "opencascade::handle<Geom_Line>"
~~~~~ ~~~~
In addition, for most OCCT classes additional *typedef* is defined for a handle, as the name of a class prefixed by *Handle_*. In addition, for most OCCT classes additional *typedef* is defined for a handle, as the name of a class prefixed by *Handle_*.
For instance, the above example can be also coded as: For instance, the above example can be also coded as:
~~~~~{.cpp} ~~~~{.cpp}
Handle_Geom_Line aLine; // "Handle_Geom_Line" is typedef to "opencascade::handle<Geom_Line>" Handle_Geom_Line aLine; // "Handle_Geom_Line" is typedef to "opencascade::handle<Geom_Line>"
~~~~~ ~~~~
#### Using a Handle #### Using a Handle
@ -318,9 +318,9 @@ A handle is characterized by the object it references.
Before performing any operation on a transient object, you must declare the handle. Before performing any operation on a transient object, you must declare the handle.
For example, if Point and Line are two transient classes from the Geom package, you would write: For example, if Point and Line are two transient classes from the Geom package, you would write:
~~~~~ ~~~~{.cpp}
Handle(Geom_Point) p1, p2; Handle(Geom_Point) p1, p2;
~~~~~ ~~~~
Declaring a handle creates a null handle that does not refer to any object. Declaring a handle creates a null handle that does not refer to any object.
The handle may be checked to be null by its method *IsNull()*. The handle may be checked to be null by its method *IsNull()*.
To nullify a handle, use method *Nullify()*. To nullify a handle, use method *Nullify()*.
@ -338,7 +338,7 @@ To enable this feature, a class declaration should include the declaration of OC
Header *Standard_Type.hxx* provides two variants of preprocessor macros facilitating this: Header *Standard_Type.hxx* provides two variants of preprocessor macros facilitating this:
* Inline variant, which declares and defines RTTI methods by a single line of code: * Inline variant, which declares and defines RTTI methods by a single line of code:
~~~~~{.cpp} ~~~~{.cpp}
#include <Geom_Surface.hxx> #include <Geom_Surface.hxx>
class Appli_ExtSurface : public Geom_Surface class Appli_ExtSurface : public Geom_Surface
{ {
@ -346,12 +346,12 @@ class Appli_ExtSurface : public Geom_Surface
public: public:
DEFINE_STANDARD_RTTIEXT(Appli_ExtSurface,Geom_Surface) DEFINE_STANDARD_RTTIEXT(Appli_ExtSurface,Geom_Surface)
}; };
~~~~~ ~~~~
* Out-of line variant, which uses one macro in the declaration (normally in the header file), and another in the implementation (in C++ source): * Out-of line variant, which uses one macro in the declaration (normally in the header file), and another in the implementation (in C++ source):
In *Appli_ExtSurface.hxx* file: In *Appli_ExtSurface.hxx* file:
~~~~~{.cpp} ~~~~{.cpp}
#include <Geom_Surface.hxx> #include <Geom_Surface.hxx>
class Appli_ExtSurface : public Geom_Surface class Appli_ExtSurface : public Geom_Surface
{ {
@ -359,13 +359,13 @@ class Appli_ExtSurface : public Geom_Surface
public: public:
DEFINE_STANDARD_RTTIEXT(Appli_ExtSurface,Geom_Surface) DEFINE_STANDARD_RTTIEXT(Appli_ExtSurface,Geom_Surface)
}; };
~~~~~ ~~~~
In *Appli_ExtSurface.cxx* file: In *Appli_ExtSurface.cxx* file:
~~~~~{.cpp} ~~~~{.cpp}
#include <Appli_ExtSurface.hxx> #include <Appli_ExtSurface.hxx>
IMPLEMENT_STANDARD_RTTIEXT(Appli_ExtSurface,Geom_Surface) IMPLEMENT_STANDARD_RTTIEXT(Appli_ExtSurface,Geom_Surface)
~~~~~ ~~~~
These macros define method *DynamicType()* that returns a type descriptor - handle to singleton instance of the class *Standard_Type* describing the class. These macros define method *DynamicType()* that returns a type descriptor - handle to singleton instance of the class *Standard_Type* describing the class.
The type descriptor stores the name of the class and the descriptor of its parent class. The type descriptor stores the name of the class and the descriptor of its parent class.
@ -375,12 +375,12 @@ Note that while inline version is easier to use, for widely used classes this me
To get the type descriptor for a given class type, use macro *STANDARD_TYPE()* with the name of the class as argument. To get the type descriptor for a given class type, use macro *STANDARD_TYPE()* with the name of the class as argument.
Example of usage: Example of usage:
~~~~~{.cpp} ~~~~{.cpp}
if (aCurve->IsKind(STANDARD_TYPE(Geom_Line))) // equivalent to "if (dynamic_cast<Geom_Line>(aCurve.get()) != 0)" if (aCurve->IsKind(STANDARD_TYPE(Geom_Line))) // equivalent to "if (dynamic_cast<Geom_Line>(aCurve.get()) != 0)"
{ {
... ...
} }
~~~~~ ~~~~
#### Type Conformity #### Type Conformity
@ -390,12 +390,12 @@ Thus, the dynamic type of an object (also called the actual type of an object) c
Consider the class *Geom_CartesianPoint*, a sub-class of *Geom_Point*; the rule of type conformity can be illustrated as follows: Consider the class *Geom_CartesianPoint*, a sub-class of *Geom_Point*; the rule of type conformity can be illustrated as follows:
~~~~~ ~~~~{.cpp}
Handle(Geom_Point) aPnt1; Handle(Geom_Point) aPnt1;
Handle(Geom_CartesianPoint) aPnt2; Handle(Geom_CartesianPoint) aPnt2;
aPnt2 = new Geom_CartesianPoint(); aPnt2 = new Geom_CartesianPoint();
aPnt1 = aPnt2; // OK, the types are compatible aPnt1 = aPnt2; // OK, the types are compatible
~~~~~ ~~~~
The compiler sees *aPnt1* as a handle to *Geom_Point* though the actual object referenced by *aPnt1* is of the *Geom_CartesianPoint* type. The compiler sees *aPnt1* as a handle to *Geom_Point* though the actual object referenced by *aPnt1* is of the *Geom_CartesianPoint* type.
@ -409,19 +409,19 @@ A handle can be converted explicitly into one of its sub-types if the actual typ
If this is not the case, the handle is nullified (explicit type conversion is sometimes called a "safe cast"). If this is not the case, the handle is nullified (explicit type conversion is sometimes called a "safe cast").
Consider the example below. Consider the example below.
~~~~~~ ~~~~{.cpp}
Handle(Geom_Point) aPnt1; Handle(Geom_Point) aPnt1;
Handle(Geom_CartesianPoint) aPnt2, aPnt3; Handle(Geom_CartesianPoint) aPnt2, aPnt3;
aPnt2 = new Geom_CartesianPoint(); aPnt2 = new Geom_CartesianPoint();
aPnt1 = aPnt2; // OK, standard assignment aPnt1 = aPnt2; // OK, standard assignment
aPnt3 = Handle(Geom_CartesianPoint)::DownCast (aPnt1); aPnt3 = Handle(Geom_CartesianPoint)::DownCast (aPnt1);
// OK, the actual type of aPnt1 is Geom_CartesianPoint, although the static type of the handle is Geom_Point // OK, the actual type of aPnt1 is Geom_CartesianPoint, although the static type of the handle is Geom_Point
~~~~~~ ~~~~
If conversion is not compatible with the actual type of the referenced object, the handle which was "cast" becomes null (and no exception is raised). If conversion is not compatible with the actual type of the referenced object, the handle which was "cast" becomes null (and no exception is raised).
So, if you require reliable services defined in a sub-class of the type seen by the handle (static type), write as follows: So, if you require reliable services defined in a sub-class of the type seen by the handle (static type), write as follows:
~~~~~~ ~~~~{.cpp}
void MyFunction (const Handle(A) & a) void MyFunction (const Handle(A) & a)
{ {
Handle(B) b = Handle(B)::DownCast(a); Handle(B) b = Handle(B)::DownCast(a);
@ -432,12 +432,12 @@ void MyFunction (const Handle(A) & a)
// the types are incompatible // the types are incompatible
} }
} }
~~~~~~ ~~~~
Downcasting is used particularly with collections of objects of different types; however, these objects should inherit from the same root class. Downcasting is used particularly with collections of objects of different types; however, these objects should inherit from the same root class.
For example, with a sequence of transient objects *TColStd_SequenceOfTransient* and two classes A and B that both inherit from *Standard_Transient*, you get the following syntax: For example, with a sequence of transient objects *TColStd_SequenceOfTransient* and two classes A and B that both inherit from *Standard_Transient*, you get the following syntax:
~~~~~ ~~~~{.cpp}
Handle(A) a; Handle(A) a;
Handle(B) b; Handle(B) b;
Handle(Standard_Transient) t; Handle(Standard_Transient) t;
@ -459,17 +459,17 @@ else
{ {
// the types are incompatible // the types are incompatible
} }
~~~~~ ~~~~
@subsubsection occt_fcug_2_2_3 Using Handles to Create Objects @subsubsection occt_fcug_2_2_3 Using Handles to Create Objects
To create an object which is manipulated by handle, declare the handle and initialize it with the standard C++ **new** operator, immediately followed by a call to the constructor. To create an object which is manipulated by handle, declare the handle and initialize it with the standard C++ **new** operator, immediately followed by a call to the constructor.
The constructor can be any of those specified in the source of the class from which the object is instanced. The constructor can be any of those specified in the source of the class from which the object is instanced.
~~~~~ ~~~~{.cpp}
Handle(Geom_CartesianPoint) aPnt; Handle(Geom_CartesianPoint) aPnt;
aPnt = new Geom_CartesianPoint (0, 0, 0); aPnt = new Geom_CartesianPoint (0, 0, 0);
~~~~~ ~~~~
Unlike for a pointer, the **delete** operator does not work on a handle; the referenced object is automatically destroyed when no longer in use. Unlike for a pointer, the **delete** operator does not work on a handle; the referenced object is automatically destroyed when no longer in use.
@ -480,7 +480,7 @@ To invoke a method which acts on the referenced object, you translate this metho
To test or to modify the state of the handle, the method is translated by the *dot* operator. To test or to modify the state of the handle, the method is translated by the *dot* operator.
The example below illustrates how to access the coordinates of an (optionally initialized) point object: The example below illustrates how to access the coordinates of an (optionally initialized) point object:
~~~~~ ~~~~{.cpp}
Handle(Geom_CartesianPoint) aCentre; Handle(Geom_CartesianPoint) aCentre;
Standard_Real x, y, z; Standard_Real x, y, z;
if (aCentre.IsNull()) if (aCentre.IsNull())
@ -488,11 +488,11 @@ if (aCentre.IsNull())
aCentre = new PGeom_CartesianPoint (0, 0, 0); aCentre = new PGeom_CartesianPoint (0, 0, 0);
} }
aCentre->Coord (x, y, z); aCentre->Coord (x, y, z);
~~~~~ ~~~~
The example below illustrates how to access the type object of a Cartesian point: The example below illustrates how to access the type object of a Cartesian point:
~~~~~ ~~~~{.cpp}
Handle(Standard_Transient) aPnt = new Geom_CartesianPoint (0., 0., 0.); Handle(Standard_Transient) aPnt = new Geom_CartesianPoint (0., 0., 0.);
if (aPnt->DynamicType() == STANDARD_TYPE(Geom_CartesianPoint)) if (aPnt->DynamicType() == STANDARD_TYPE(Geom_CartesianPoint))
{ {
@ -502,7 +502,7 @@ else
{ {
std::cout << "Type check FAILED\n"; std::cout << "Type check FAILED\n";
} }
~~~~~ ~~~~
*Standard_NullObject* exception will be raised if a field or a method of an object is accessed via a *Null* handle. *Standard_NullObject* exception will be raised if a field or a method of an object is accessed via a *Null* handle.
@ -512,9 +512,9 @@ A class method is called like a static C++ function, i.e. it is called by the na
For example, we can find the maximum degree of a Bezier curve: For example, we can find the maximum degree of a Bezier curve:
~~~~~ ~~~~{.cpp}
Standard_Integer aDegree = Geom_BezierCurve::MaxDegree(); Standard_Integer aDegree = Geom_BezierCurve::MaxDegree();
~~~~~ ~~~~
@subsubsection occt_fcug_2_2_5 Handle deallocation @subsubsection occt_fcug_2_2_5 Handle deallocation
@ -529,7 +529,7 @@ The object is automatically deleted by the handle when reference counter becomes
The principle of allocation can be seen in the example below. The principle of allocation can be seen in the example below.
~~~~~ ~~~~{.cpp}
... ...
{ {
Handle(TColStd_HSequenceOfInteger) H1 = new TColStd_HSequenceOfInteger(); Handle(TColStd_HSequenceOfInteger) H1 = new TColStd_HSequenceOfInteger();
@ -549,11 +549,11 @@ The principle of allocation can be seen in the example below.
// Here, H1 has 1 reference // Here, H1 has 1 reference
} }
// Here, H1 has no reference and the referred TColStd_HSequenceOfInteger object is deleted. // Here, H1 has no reference and the referred TColStd_HSequenceOfInteger object is deleted.
~~~~~ ~~~~
You can easily cast a reference to the handle object to <i> void* </i> by defining the following: You can easily cast a reference to the handle object to <i> void* </i> by defining the following:
~~~~ ~~~~{.cpp}
void* aPointer; void* aPointer;
Handle(Some_Class) aHandle; Handle(Some_Class) aHandle;
// Here only a pointer will be copied // Here only a pointer will be copied
@ -701,12 +701,12 @@ The following paragraphs describe recommended approaches for using exceptions wh
#### "C++ like" Syntax #### "C++ like" Syntax
The following example: The following example:
~~~~~ ~~~~{.cpp}
throw Standard_DomainError ("Cannot cope with this condition"); throw Standard_DomainError ("Cannot cope with this condition");
~~~~~ ~~~~
raises an exception of *Standard_DomainError* type with the associated message "Cannot cope with this condition", the message being optional. raises an exception of *Standard_DomainError* type with the associated message "Cannot cope with this condition", the message being optional.
This exception may be caught by a handler of a *Standard_DomainError* type as follows: This exception may be caught by a handler of a *Standard_DomainError* type as follows:
~~~~~ ~~~~{.cpp}
try try
{ {
OCC_CATCH_SIGNALS OCC_CATCH_SIGNALS
@ -716,7 +716,7 @@ catch (const Standard_DomainError& )
{ {
// handle Standard_DomainError exceptions here // handle Standard_DomainError exceptions here
} }
~~~~~ ~~~~
#### Regular usage #### Regular usage
@ -734,7 +734,7 @@ For example, if you consider the *TCollection_Array1* class used with:
then, the *Value* function may be implemented as follows: then, the *Value* function may be implemented as follows:
~~~~~ ~~~~{.cpp}
Item TCollection_Array1::Value (Standard_Integer theIndex) const Item TCollection_Array1::Value (Standard_Integer theIndex) const
{ {
// where myR1 and myR2 are the lower and upper bounds of the array // where myR1 and myR2 are the lower and upper bounds of the array
@ -744,7 +744,7 @@ Item TCollection_Array1::Value (Standard_Integer theIndex) const
} }
return myContents[theIndex]; return myContents[theIndex];
} }
~~~~~ ~~~~
Here validity of the index is first verified using the Lower and Upper functions in order to protect the call. Here validity of the index is first verified using the Lower and Upper functions in order to protect the call.
Normally the caller ensures the index being in the valid range before calling <i>Value()</i>. Normally the caller ensures the index being in the valid range before calling <i>Value()</i>.
@ -752,26 +752,26 @@ In this case the above implementation of *Value* is not optimal since the test d
It is a widely used practice to include that kind of protections in a debug build of the program and exclude in release (optimized) build. It is a widely used practice to include that kind of protections in a debug build of the program and exclude in release (optimized) build.
To support this practice, the macros <i>Raise_if()</i> are provided for every OCCT exception class: To support this practice, the macros <i>Raise_if()</i> are provided for every OCCT exception class:
~~~~~ ~~~~{.cpp}
<ErrorTypeName>_Raise_if(condition, "Error message"); <ErrorTypeName>_Raise_if(condition, "Error message");
~~~~~ ~~~~
where *ErrorTypeName* is the exception type, *condition* is the logical expression leading to the raise of the exception, and *Error message* is the associated message. where *ErrorTypeName* is the exception type, *condition* is the logical expression leading to the raise of the exception, and *Error message* is the associated message.
The entire call may be removed by defining one of the preprocessor symbols *No_Exception* or <i>No_<ErrorTypeName></i> at compile-time: The entire call may be removed by defining one of the preprocessor symbols *No_Exception* or <i>No_<ErrorTypeName></i> at compile-time:
~~~~~ ~~~~{.cpp}
#define No_Exception // remove all raises #define No_Exception // remove all raises
~~~~~ ~~~~
Using this syntax, the *Value* function becomes: Using this syntax, the *Value* function becomes:
~~~~~ ~~~~{.cpp}
Item TCollection_Array1::Value (Standard_Integer theIndex) const Item TCollection_Array1::Value (Standard_Integer theIndex) const
{ {
Standard_OutOfRange_Raise_if(theIndex < myR1 || theIndex > myR2, "index out of range in TCollection_Array1::Value"); Standard_OutOfRange_Raise_if(theIndex < myR1 || theIndex > myR2, "index out of range in TCollection_Array1::Value");
return myContents[theIndex]; return myContents[theIndex];
} }
~~~~~ ~~~~
@subsubsection occt_fcug_2_4_3 Handling an Exception @subsubsection occt_fcug_2_4_3 Handling an Exception
@ -788,7 +788,7 @@ The recommended location for it is first statement after opening brace of <i>try
As an example, consider the exceptions of type *Standard_NumericError, Standard_Overflow, Standard_Underflow* and *Standard_DivideByZero*, where *Standard_NumericError* is the parent type of the three others. As an example, consider the exceptions of type *Standard_NumericError, Standard_Overflow, Standard_Underflow* and *Standard_DivideByZero*, where *Standard_NumericError* is the parent type of the three others.
~~~~~ ~~~~{.cpp}
void f(1) void f(1)
{ {
try try
@ -805,7 +805,7 @@ void f(1)
// ... // ...
} }
} }
~~~~~ ~~~~
Here, the first handler will catch exceptions of *Standard_Overflow* type Here, the first handler will catch exceptions of *Standard_Overflow* type
and the second one -- exceptions of *Standard_NumericError* type and all exceptions derived from it, including *Standard_Underflow* and *Standard_DivideByZero*. and the second one -- exceptions of *Standard_NumericError* type and all exceptions derived from it, including *Standard_Underflow* and *Standard_DivideByZero*.
@ -813,7 +813,7 @@ and the second one -- exceptions of *Standard_NumericError* type and all excepti
The handlers are checked in order of appearance, from the nearest to the try block to the most distant from it, until one matches the raise expression. The handlers are checked in order of appearance, from the nearest to the try block to the most distant from it, until one matches the raise expression.
For a try block, it would be a mistake to place a handler for a base exception type ahead of a handler for its derived type since that would ensure that the handler for the derived exception would never be invoked. For a try block, it would be a mistake to place a handler for a base exception type ahead of a handler for its derived type since that would ensure that the handler for the derived exception would never be invoked.
~~~~~ ~~~~{.cpp}
void f(1) void f(1)
{ {
int i = 0; int i = 0;
@ -832,7 +832,7 @@ void f(1)
} }
. . . . . .
} }
~~~~~ ~~~~
The exceptions form a hierarchy tree completely separated from other user defined classes. The exceptions form a hierarchy tree completely separated from other user defined classes.
One exception of type *Standard_Failure* is the root of the entire exception hierarchy. One exception of type *Standard_Failure* is the root of the entire exception hierarchy.
@ -841,7 +841,7 @@ It is recommended to set up such a handler in the main routine.
The main routine of a program would look like this: The main routine of a program would look like this:
~~~~~ ~~~~{.cpp}
#include <Standard_ErrorHandler.hxx> #include <Standard_ErrorHandler.hxx>
#include <Standard_Failure.hxx> #include <Standard_Failure.hxx>
#include <iostream> #include <iostream>
@ -859,7 +859,7 @@ int main (int argc, char* argv[])
} }
return 1; return 1;
} }
~~~~~ ~~~~
Though standard C++ scoping rules and syntax apply to try block and handlers, note that on some platforms Open CASCADE Technology may be compiled in compatibility mode when exceptions are emulated by long jumps (see below). Though standard C++ scoping rules and syntax apply to try block and handlers, note that on some platforms Open CASCADE Technology may be compiled in compatibility mode when exceptions are emulated by long jumps (see below).
In this mode it is required that no statement precedes or follows any handler. In this mode it is required that no statement precedes or follows any handler.
@ -921,17 +921,17 @@ Foundation classes provide in the package *Plugin* a method named *Load()*, whic
That method reads the information regarding available plug-ins and their locations from the resource file *Plugin* found by environment variable *CSF_PluginDefaults*: That method reads the information regarding available plug-ins and their locations from the resource file *Plugin* found by environment variable *CSF_PluginDefaults*:
~~~~~ ~~~~
$CSF_PluginDefaults/Plugin $CSF_PluginDefaults/Plugin
~~~~~ ~~~~
The *Load* method looks for the library name in the resource file or registry through its GUID, for example, on UNIX: The *Load* method looks for the library name in the resource file or registry through its GUID, for example, on UNIX:
~~~~~ ~~~~
! METADATADRIVER whose value must be OS or DM. ! METADATADRIVER whose value must be OS or DM.
! FW ! FW
a148e300-5740-11d1-a904-080036aaa103.Location: libFWOSPlugin.so a148e300-5740-11d1-a904-080036aaa103.Location: libFWOSPlugin.so
~~~~~ ~~~~
Then the *Load* method loads the library according to the rules of the operating system of the host machine (for example, by using environment variables such as *LD_LIBRARY_PATH* with Unix and *PATH* with Windows). Then the *Load* method loads the library according to the rules of the operating system of the host machine (for example, by using environment variables such as *LD_LIBRARY_PATH* with Unix and *PATH* with Windows).
After that it invokes the *PLUGINFACTORY* method to return the object, which supports the required service. After that it invokes the *PLUGINFACTORY* method to return the object, which supports the required service.
@ -941,13 +941,13 @@ The client may then call the functions supported by this object.
To invoke one of the services provided by the plug-in, you may call the *Plugin::Load()* global function with the *Standard_GUID* of the requested service as follows: To invoke one of the services provided by the plug-in, you may call the *Plugin::Load()* global function with the *Standard_GUID* of the requested service as follows:
~~~~~{.cpp} ~~~~{.cpp}
Handle(FADriver_PartStorer)::DownCast(PlugIn::Load (yourStandardGUID)); Handle(FADriver_PartStorer)::DownCast(PlugIn::Load (yourStandardGUID));
~~~~~ ~~~~
Let us take *FAFactory.hxx* and *FAFactory.cxx* as an example: Let us take *FAFactory.hxx* and *FAFactory.cxx* as an example:
~~~~~{.cpp} ~~~~{.cpp}
#include <Standard_Macro.hxx> #include <Standard_Macro.hxx>
#include <Standard_GUID.hxx> #include <Standard_GUID.hxx>
#include <Standard_Transient.hxx> #include <Standard_Transient.hxx>
@ -957,9 +957,9 @@ class FAFactory
public: public:
Standard_EXPORT static Handle(Standard_Transient) Factory (const Standard_GUID& theGUID); Standard_EXPORT static Handle(Standard_Transient) Factory (const Standard_GUID& theGUID);
}; };
~~~~~ ~~~~
~~~~~{.cpp} ~~~~{.cpp}
#include <FAFactory.hxx> #include <FAFactory.hxx>
#include <FADriver_PartRetriever.hxx> #include <FADriver_PartRetriever.hxx>
@ -1004,7 +1004,7 @@ Handle(Standard_Transient) FAFactory::Factory (const Standard_GUID& theGUID)
// export plugin function "PLUGINFACTORY" // export plugin function "PLUGINFACTORY"
PLUGIN(FAFactory) PLUGIN(FAFactory)
~~~~~ ~~~~
Application might also instantiate a factory by linking to the library and calling *FAFactory::Factory()* directly. Application might also instantiate a factory by linking to the library and calling *FAFactory::Factory()* directly.
@ -1042,14 +1042,14 @@ These definitions are now obsolete though still can be used, particularly for co
Let see an example of NCollection template class instantiation for a sequence of points in the header file *MyPackage_SequenceOfPnt.hxx* (analogue of *TColgp_SequenceOfPnt*): Let see an example of NCollection template class instantiation for a sequence of points in the header file *MyPackage_SequenceOfPnt.hxx* (analogue of *TColgp_SequenceOfPnt*):
~~~~~{.cpp} ~~~~{.cpp}
#include <NCollection_Sequence.hxx> #include <NCollection_Sequence.hxx>
#include <gp_Pnt.hxx> #include <gp_Pnt.hxx>
typedef NCollection_Sequence<gp_Pnt> MyPackage_SequenceOfPnt; typedef NCollection_Sequence<gp_Pnt> MyPackage_SequenceOfPnt;
~~~~~ ~~~~
For the case, when sequence itself should be managed by handle, auxiliary macros *DEFINE_HSEQUENCE* can be used: For the case, when sequence itself should be managed by handle, auxiliary macros *DEFINE_HSEQUENCE* can be used:
~~~~~{.cpp} ~~~~{.cpp}
#include <NCollection_Sequence.hxx> #include <NCollection_Sequence.hxx>
#include <NCollection_DefineHSequence.hxx> #include <NCollection_DefineHSequence.hxx>
#include <gp_Pnt.hxx> #include <gp_Pnt.hxx>
@ -1057,7 +1057,7 @@ typedef NCollection_Sequence<gp_Pnt> MyPackage_SequenceOfPnt;
DEFINE_HSEQUENCE(MyPackage_HSequenceOfPnt, MyPackage_SequenceOfPnt) DEFINE_HSEQUENCE(MyPackage_HSequenceOfPnt, MyPackage_SequenceOfPnt)
... ...
Handle(MyPackage_HSequenceOfPnt) aSeq = new MyPackage_HSequenceOfPnt(); Handle(MyPackage_HSequenceOfPnt) aSeq = new MyPackage_HSequenceOfPnt();
~~~~~ ~~~~
See more details about available collections in following sections. See more details about available collections in following sections.
@ -1302,7 +1302,7 @@ The common methods of Iterator are:
Usage sample: Usage sample:
~~~~~{.cpp} ~~~~{.cpp}
typedef Ncollection_Sequence<gp_Pnt> MyPackage_SequenceOfPnt; typedef Ncollection_Sequence<gp_Pnt> MyPackage_SequenceOfPnt;
void Perform (const MyPackage_SequenceOfPnt& theSequence) void Perform (const MyPackage_SequenceOfPnt& theSequence)
{ {
@ -1312,17 +1312,17 @@ void Perform (const MyPackage_SequenceOfPnt& theSequence)
... ...
} }
} }
~~~~~ ~~~~
@subsubsection occt_fcug_3_1_5 Allocators @subsubsection occt_fcug_3_1_5 Allocators
All constructors of *NCollection* classes receive the *Allocator* object as the last parameter. All constructors of *NCollection* classes receive the *Allocator* object as the last parameter.
This is an object of a type managed by Handle, inheriting *NCollection_BaseAllocator*, with the following (mandatory) methods redefined: This is an object of a type managed by Handle, inheriting *NCollection_BaseAllocator*, with the following (mandatory) methods redefined:
~~~~~{.cpp} ~~~~{.cpp}
virtual void* Allocate (const size_t theSize) override; virtual void* Allocate (const size_t theSize) override;
virtual void Free (void* theAddress) override; virtual void Free (void* theAddress) override;
~~~~~ ~~~~
It is used internally every time when the collection allocates memory for its item(s) and releases this memory. It is used internally every time when the collection allocates memory for its item(s) and releases this memory.
The default value of this parameter (empty *Handle*) designates the use of *NCollection_BaseAllocator*, where the functions *Standard::Allocate* and *Standard::Free* are called. The default value of this parameter (empty *Handle*) designates the use of *NCollection_BaseAllocator*, where the functions *Standard::Allocate* and *Standard::Free* are called.
@ -1360,7 +1360,7 @@ Among the best suitable solutions there can be a pointer to an object, handled o
The bounding object may have any dimension and geometry. The bounding object may have any dimension and geometry.
The minimal interface of *TheBndType* (besides public empty and copy constructor and operator=) used in NCollection_UBTree algorithm as follows: The minimal interface of *TheBndType* (besides public empty and copy constructor and operator=) used in NCollection_UBTree algorithm as follows:
~~~~~{.cpp} ~~~~{.cpp}
class MyBndType class MyBndType
{ {
public: public:
@ -1373,7 +1373,7 @@ public:
//! Computes the squared maximal linear extent of me (for a box it is the squared diagonal of the box). //! Computes the squared maximal linear extent of me (for a box it is the squared diagonal of the box).
Standard_Real SquareExtent() const; Standard_Real SquareExtent() const;
}; };
~~~~~ ~~~~
This interface is implemented in types of Bnd package: *Bnd_Box, Bnd_Box2d, Bnd_B2x, Bnd_B3x*. This interface is implemented in types of Bnd package: *Bnd_Box, Bnd_Box2d, Bnd_B2x, Bnd_B3x*.
@ -1384,7 +1384,7 @@ The quality of a tree is better (considering the speed of searches) if objects a
Instantiation of *NCollection_UBTreeFiller* collects objects to be added, and then adds them at once to the given NCollection_UBTree instance in a random order using the Fisher-Yates algorithm. Instantiation of *NCollection_UBTreeFiller* collects objects to be added, and then adds them at once to the given NCollection_UBTree instance in a random order using the Fisher-Yates algorithm.
Below is the sample code that creates an instance of *NCollection_UBTree* indexed by 2D boxes (Bnd_B2f), then a selection is performed returning the objects whose bounding boxes contain the given 2D point. Below is the sample code that creates an instance of *NCollection_UBTree* indexed by 2D boxes (Bnd_B2f), then a selection is performed returning the objects whose bounding boxes contain the given 2D point.
~~~~~{.cpp} ~~~~{.cpp}
typedef NCollection_UBTree<MyData, Bnd_B2f> UBTree; typedef NCollection_UBTree<MyData, Bnd_B2f> UBTree;
typedef NCollection_List<MyData> ListOfSelected; typedef NCollection_List<MyData> ListOfSelected;
//! Tree Selector type //! Tree Selector type
@ -1426,7 +1426,7 @@ aTreeFiller.Fill();
MyTreeSelector aSel (aPoint2d); MyTreeSelector aSel (aPoint2d);
aTree.Select (aSel); aTree.Select (aSel);
const ListOfSelected& aSelected = aSel.ListAccepted(); const ListOfSelected& aSelected = aSel.ListAccepted();
~~~~~ ~~~~
##### NCollection_CellFilter ##### NCollection_CellFilter
@ -1438,10 +1438,10 @@ while search with NCollection_UBTree provides logarithmic law access time.
Packages *TShort*, *TColGeom*, *TColGeom2d*, *TColStd*, *TColgp* provide template instantiations (typedefs) of *NCollection* templates to standard OCCT types. Packages *TShort*, *TColGeom*, *TColGeom2d*, *TColStd*, *TColgp* provide template instantiations (typedefs) of *NCollection* templates to standard OCCT types.
Classes with *H* prefix in name are handle-based variants and inherit Standard_Transient. Classes with *H* prefix in name are handle-based variants and inherit Standard_Transient.
~~~~~{.cpp} ~~~~{.cpp}
typedef NCollection_Array1<gp_Vec> TColgp_Array1OfVec; typedef NCollection_Array1<gp_Vec> TColgp_Array1OfVec;
typedef NCollection_Array1<TCollection_AsciiString> TColStd_Array1OfAsciiString; typedef NCollection_Array1<TCollection_AsciiString> TColStd_Array1OfAsciiString;
~~~~~ ~~~~
Packages like *TopTools* also include definitions of collections and hash functions for complex types like shapes -- *TopTools_ShapeMapHasher*, *TopTools_MapOfShape*. Packages like *TopTools* also include definitions of collections and hash functions for complex types like shapes -- *TopTools_ShapeMapHasher*, *TopTools_MapOfShape*.
@ -1525,27 +1525,27 @@ These classes also provide a data structure to represent any expression, relatio
Vectors and matrices have arbitrary ranges which must be defined at declaration time and cannot be changed after declaration. Vectors and matrices have arbitrary ranges which must be defined at declaration time and cannot be changed after declaration.
~~~~~{.cpp} ~~~~{.cpp}
math_Vector aVec (1, 3); math_Vector aVec (1, 3);
// a vector of dimension 3 with range (1..3) // a vector of dimension 3 with range (1..3)
math_Matrix aMat (0, 2, 0, 2); math_Matrix aMat (0, 2, 0, 2);
// a matrix of dimension 3x3 with range (0..2, 0..2) // a matrix of dimension 3x3 with range (0..2, 0..2)
math_Vector aVec (N1, N2); math_Vector aVec (N1, N2);
// a vector of dimension N2-N1+1 with range (N1..N2) // a vector of dimension N2-N1+1 with range (N1..N2)
~~~~~ ~~~~
Vector and Matrix objects use value semantics. Vector and Matrix objects use value semantics.
In other words, they cannot be shared and are copied through assignment. In other words, they cannot be shared and are copied through assignment.
~~~~~{.cpp} ~~~~{.cpp}
math_Vector aVec1 (1, 3), aVec2 (0, 2); math_Vector aVec1 (1, 3), aVec2 (0, 2);
aVec2 = aVec1; aVec2 = aVec1;
// aVec1 is copied into aVec2; a modification of aVec1 does not affect aVec2 // aVec1 is copied into aVec2; a modification of aVec1 does not affect aVec2
~~~~~ ~~~~
Vector and Matrix values may be initialized and obtained using indexes which must lie within the range definition of the vector or the matrix. Vector and Matrix values may be initialized and obtained using indexes which must lie within the range definition of the vector or the matrix.
~~~~~{.cpp} ~~~~{.cpp}
math_Vector aVec (1, 3); math_Vector aVec (1, 3);
math_Matrix aMat (1, 3, 1, 3); math_Matrix aMat (1, 3, 1, 3);
Standard_Real aValue; Standard_Real aValue;
@ -1554,7 +1554,7 @@ aVec (2) = 1.0;
aValue = aVec(1); aValue = aVec(1);
aMat (1, 3) = 1.0; aMat (1, 3) = 1.0;
aValue = aMat (2, 2); aValue = aMat (2, 2);
~~~~~ ~~~~
Some operations on Vector and Matrix objects may not be legal. Some operations on Vector and Matrix objects may not be legal.
In this case an exception is raised. In this case an exception is raised.
@ -1562,12 +1562,12 @@ Two standard exceptions are used:
* *Standard_DimensionError* exception is raised when two matrices or vectors involved in an operation are of incompatible dimensions. * *Standard_DimensionError* exception is raised when two matrices or vectors involved in an operation are of incompatible dimensions.
* *Standard_RangeError* exception is raised if an access outside the range definition of a vector or of a matrix is attempted. * *Standard_RangeError* exception is raised if an access outside the range definition of a vector or of a matrix is attempted.
~~~~~~{.cpp} ~~~~{.cpp}
math_Vector aVec1 (1, 3), aVec2 (1, 2), aVec3 (0, 2); math_Vector aVec1 (1, 3), aVec2 (1, 2), aVec3 (0, 2);
aVec1 = aVec2; // error: Standard_DimensionError is raised aVec1 = aVec2; // error: Standard_DimensionError is raised
aVec1 = aVec3; // OK: ranges are not equal but dimensions are compatible aVec1 = aVec3; // OK: ranges are not equal but dimensions are compatible
aVec1 (0) = 2.0; // error: Standard_RangeError is raised aVec1 (0) = 2.0; // error: Standard_RangeError is raised
~~~~~~ ~~~~
@subsection occt_occt_fcug_4_3 Primitive Geometric Types @subsection occt_occt_fcug_4_3 Primitive Geometric Types
@ -1649,7 +1649,7 @@ They contain:
The example below demonstrates the use of the math_Gauss class, which implements the Gauss solution for a set of linear equations. The example below demonstrates the use of the math_Gauss class, which implements the Gauss solution for a set of linear equations.
The following definition is an extract from the header file of the class *math_Gauss*: The following definition is an extract from the header file of the class *math_Gauss*:
~~~~~~{.cpp} ~~~~{.cpp}
class math_Gauss class math_Gauss
{ {
public: public:
@ -1657,11 +1657,11 @@ public:
Standard_Boolean IsDone() const; Standard_Boolean IsDone() const;
void Solve (const math_Vector& B, math_Vector& X) const; void Solve (const math_Vector& B, math_Vector& X) const;
}; };
~~~~~~ ~~~~
Now the main program uses the math_Gauss class to solve the equations _a*x1=b1_ and _a*x2=b2_: Now the main program uses the math_Gauss class to solve the equations _a*x1=b1_ and _a*x2=b2_:
~~~~~{.cpp} ~~~~{.cpp}
#include <math_Vector.hxx> #include <math_Vector.hxx>
#include <math_Matrix.hxx> #include <math_Matrix.hxx>
main() main()
@ -1686,12 +1686,12 @@ main()
// StdFail_NotDone is raised // StdFail_NotDone is raised
} }
} }
~~~~~ ~~~~
The next example demonstrates the use of the *math_BissecNewton* class, which implements a combination of the Newton and Bissection algorithms to find the root of a function known to lie between two bounds. The next example demonstrates the use of the *math_BissecNewton* class, which implements a combination of the Newton and Bissection algorithms to find the root of a function known to lie between two bounds.
The definition is an extract from the header file of the class *math_BissecNewton*: The definition is an extract from the header file of the class *math_BissecNewton*:
~~~~~{.cpp} ~~~~{.cpp}
class math_BissecNewton class math_BissecNewton
{ {
public: public:
@ -1702,12 +1702,12 @@ public:
Standard_Boolean IsDone() const; Standard_Boolean IsDone() const;
Standard_Real Root(); Standard_Real Root();
}; };
~~~~~ ~~~~
The abstract class *math_FunctionWithDerivative* describes the services which have to be implemented for the function _f_ which is to be used by a *math_BissecNewton* algorithm. The abstract class *math_FunctionWithDerivative* describes the services which have to be implemented for the function _f_ which is to be used by a *math_BissecNewton* algorithm.
The following definition corresponds to the header file of the abstract class *math_FunctionWithDerivative*: The following definition corresponds to the header file of the abstract class *math_FunctionWithDerivative*:
~~~~~{.cpp} ~~~~{.cpp}
class math_FunctionWithDerivative class math_FunctionWithDerivative
{ {
public: public:
@ -1715,12 +1715,12 @@ public:
virtual Standard_Boolean Derivative (const Standard_Real x, Standard_Real& d) = 0; virtual Standard_Boolean Derivative (const Standard_Real x, Standard_Real& d) = 0;
virtual Standard_Boolean Values (const Standard_Real x, Standard_Real& f, Standard_Real& d) = 0; virtual Standard_Boolean Values (const Standard_Real x, Standard_Real& f, Standard_Real& d) = 0;
}; };
~~~~~ ~~~~
Now the test sample uses the *math_BissecNewton* class to find the root of the equation _f(x)=x**2-4_ in the interval [1.5, 2.5]. Now the test sample uses the *math_BissecNewton* class to find the root of the equation _f(x)=x**2-4_ in the interval [1.5, 2.5].
The function to solve is implemented in the class *myFunction* which inherits from the class *math_FunctionWithDerivative*, then the main program finds the required root. The function to solve is implemented in the class *myFunction* which inherits from the class *math_FunctionWithDerivative*, then the main program finds the required root.
~~~~~{.cpp} ~~~~{.cpp}
#include <math_BissecNewton.hxx> #include <math_BissecNewton.hxx>
#include <math_FunctionWithDerivative.hxx> #include <math_FunctionWithDerivative.hxx>
class myFunction : public math_FunctionWithDerivative class myFunction : public math_FunctionWithDerivative
@ -1759,7 +1759,7 @@ main()
else // no else // no
{ {
} }
~~~~~ ~~~~
@subsection occt_occt_fcug_4_7 Precision @subsection occt_occt_fcug_4_7 Precision
@ -1796,10 +1796,10 @@ The choice of precision value for parametric space depends not only on the accur
This is because it is desirable to link parametric precision and real precision. This is because it is desirable to link parametric precision and real precision.
If you are on a curve defined by the equation *P(t)*, you would want to have equivalence between the following: If you are on a curve defined by the equation *P(t)*, you would want to have equivalence between the following:
~~~~~ ~~~~{.cpp}
Abs (t1 - t2) < ParametricPrecision Abs (t1 - t2) < ParametricPrecision
Distance (P(t1), P(t2)) < RealPrecision Distance (P(t1), P(t2)) < RealPrecision
~~~~~ ~~~~
@subsubsection occt_occt_fcug_4_7_1 The Precision package @subsubsection occt_occt_fcug_4_7_1 The Precision package
@ -1832,7 +1832,7 @@ This method is used to compare two angles.
Its current value is *Epsilon(2 * PI)* i.e. the smallest number *x* such that *2*PI + x* is different of *2\*PI*. Its current value is *Epsilon(2 * PI)* i.e. the smallest number *x* such that *2*PI + x* is different of *2\*PI*.
It can be used to check confusion of two angles as follows: It can be used to check confusion of two angles as follows:
~~~{.cpp} ~~~~{.cpp}
bool areEqualAngles (double theAngle1, double theAngle2) bool areEqualAngles (double theAngle1, double theAngle2)
{ {
return Abs(theAngle1 - theAngle2) < Precision::Angular(); return Abs(theAngle1 - theAngle2) < Precision::Angular();
@ -1840,7 +1840,7 @@ bool areEqualAngles (double theAngle1, double theAngle2)
~~~ ~~~
It is also possible to check parallelism of two vectors as follows: It is also possible to check parallelism of two vectors as follows:
~~~{.cpp} ~~~~{.cpp}
bool areParallelVectors (const gp_Vec& theVec1, const gp_Vec& theVec2) bool areParallelVectors (const gp_Vec& theVec1, const gp_Vec& theVec2)
{ {
return theVec1.IsParallel (theVec2, Precision::Angular()); return theVec1.IsParallel (theVec2, Precision::Angular());
@ -1849,7 +1849,7 @@ bool areParallelVectors (const gp_Vec& theVec1, const gp_Vec& theVec2)
Note that *Precision::Angular()* can be used on both dot and cross products because for small angles the *Sine* and the *Angle* are equivalent. Note that *Precision::Angular()* can be used on both dot and cross products because for small angles the *Sine* and the *Angle* are equivalent.
So to test if two directions of type *gp_Dir* are perpendicular, it is legal to use the following code: So to test if two directions of type *gp_Dir* are perpendicular, it is legal to use the following code:
~~~{.cpp} ~~~~{.cpp}
bool arePerpendicular (const gp_Dir& theDir1, const gp_Dir& theDir2) bool arePerpendicular (const gp_Dir& theDir1, const gp_Dir& theDir2)
{ {
return Abs(theDir1 * theDir2) < Precision::Angular(); return Abs(theDir1 * theDir2) < Precision::Angular();
@ -1862,7 +1862,7 @@ This method is used to test 3D distances.
The current value is *1.e-7*, in other words, 1/10 micron if the unit used is the millimeter. The current value is *1.e-7*, in other words, 1/10 micron if the unit used is the millimeter.
It can be used to check confusion of two points as follows: It can be used to check confusion of two points as follows:
~~~{.cpp} ~~~~{.cpp}
bool areEqualPoints (const gp_Pnt& thePnt1, const gp_Pnt& thePnt2) bool areEqualPoints (const gp_Pnt& thePnt1, const gp_Pnt& thePnt2)
{ {
return thePnt1.IsEqual (thePnt2, Precision::Confusion()); return thePnt1.IsEqual (thePnt2, Precision::Confusion());
@ -1870,7 +1870,7 @@ bool areEqualPoints (const gp_Pnt& thePnt1, const gp_Pnt& thePnt2)
~~~ ~~~
It is also possible to find a vector of null length: It is also possible to find a vector of null length:
~~~{.cpp} ~~~~{.cpp}
bool isNullVector (const gp_Vec& theVec) bool isNullVector (const gp_Vec& theVec)
{ {
return theVec.Magnitude() < Precision::Confusion(); return theVec.Magnitude() < Precision::Confusion();

348
dox/user_guides/iges/iges.md
View File

@ -60,25 +60,25 @@ Administrative data, in the Global Section of the IGES file (such as the file n
@subsection occt_iges_2_3 Description of the process @subsection occt_iges_2_3 Description of the process
@subsubsection occt_iges_2_3_1 Loading the IGES file @subsubsection occt_iges_2_3_1 Loading the IGES file
Before performing any other operation, you have to load the file using the syntax below. Before performing any other operation, you have to load the file using the syntax below.
~~~~~ ~~~~{.cpp}
IGESControl_Reader reader; IGESControl_Reader reader;
IFSelect_ReturnStatus stat = reader.ReadFile(“filename.igs”); IFSelect_ReturnStatus stat = reader.ReadFile(“filename.igs”);
~~~~~ ~~~~
The loading operation only loads the IGES file into computer memory; it does not translate it. The loading operation only loads the IGES file into computer memory; it does not translate it.
@subsubsection occt_iges_2_3_2 Checking the IGES file @subsubsection occt_iges_2_3_2 Checking the IGES file
This step is not obligatory. Check the loaded file with: This step is not obligatory. Check the loaded file with:
~~~~~ ~~~~{.cpp}
Standard_Boolean ok = reader.Check(Standard_True); Standard_Boolean ok = reader.Check(Standard_True);
~~~~~ ~~~~
The variable “ok is True” is returned if no fail message was found; “ok is False” is returned if there was at least one fail message. The variable “ok is True” is returned if no fail message was found; “ok is False” is returned if there was at least one fail message.
~~~~~ ~~~~{.cpp}
reader.PrintCheckLoad (failsonly, mode); reader.PrintCheckLoad (failsonly, mode);
~~~~~ ~~~~
Error messages are displayed if there are invalid or incomplete IGES entities, giving you information on the cause of the error. Error messages are displayed if there are invalid or incomplete IGES entities, giving you information on the cause of the error.
~~~~~ ~~~~{.cpp}
Standard_Boolean failsonly = Standard_True or Standard_False; Standard_Boolean failsonly = Standard_True or Standard_False;
~~~~~ ~~~~
If you give True, you will see fail messages only. If you give False, you will see both fail and warning messages. If you give True, you will see fail messages only. If you give False, you will see both fail and warning messages.
Your analysis of the file can be either message-oriented or entity-oriented. Choose your preference with *IFSelect_PrintCount mode = IFSelect_xxx*, where *xxx* can be any of the following: Your analysis of the file can be either message-oriented or entity-oriented. Choose your preference with *IFSelect_PrintCount mode = IFSelect_xxx*, where *xxx* can be any of the following:
@ -98,14 +98,14 @@ manages the continuity of BSpline curves (IGES entities 106, 112 and 126) after
* 2: This option concerns IGES Spline curves only. IGES Spline curves are broken down into pieces of C2 continuity. If C2 cannot be ensured, the Spline curves will be broken down into pieces of C1 continuity. * 2: This option concerns IGES Spline curves only. IGES Spline curves are broken down into pieces of C2 continuity. If C2 cannot be ensured, the Spline curves will be broken down into pieces of C1 continuity.
Read this parameter with: Read this parameter with:
~~~~~ ~~~~{.cpp}
Standard_Integer ic = Interface_Static::IVal("read.iges.bspline.continuity"); Standard_Integer ic = Interface_Static::IVal("read.iges.bspline.continuity");
~~~~~ ~~~~
Modify this value with: Modify this value with:
~~~~~ ~~~~{.cpp}
if (!Interface_Static::SetIVal ("read.iges.bspline.continuity",2)) if (!Interface_Static::SetIVal ("read.iges.bspline.continuity",2))
.. error ..; .. error ..;
~~~~~ ~~~~
Default value is 1. Default value is 1.
This parameter does not change the continuity of curves that are used in the construction of IGES BRep entities. In this case, the parameter does not influence the continuity of the resulting OCCT curves (it is ignored). This parameter does not change the continuity of curves that are used in the construction of IGES BRep entities. In this case, the parameter does not influence the continuity of the resulting OCCT curves (it is ignored).
@ -117,14 +117,14 @@ reads the precision value.
* User (1) the precision value is that of the read.precision.val parameter. * User (1) the precision value is that of the read.precision.val parameter.
Read this parameter with: Read this parameter with:
~~~~~ ~~~~{.cpp}
Standard_Integer ic = Interface_Static::IVal("read.precision.mode"); Standard_Integer ic = Interface_Static::IVal("read.precision.mode");
~~~~~ ~~~~
Modify this value with: Modify this value with:
~~~~~ ~~~~{.cpp}
if (!Interface_Static::SetIVal ("read.precision.mode",1)) if (!Interface_Static::SetIVal ("read.precision.mode",1))
.. error ..; .. error ..;
~~~~~ ~~~~
Default value is *File* (0). Default value is *File* (0).
<h4>read.precision.val</h4> <h4>read.precision.val</h4>
@ -133,14 +133,14 @@ User defined precision value. This parameter gives the precision for shape const
This value is in the measurement unit defined in the IGES file header. This value is in the measurement unit defined in the IGES file header.
Read this parameter with: Read this parameter with:
~~~~~ ~~~~{.cpp}
Standard_Real rp = Interface_Static::RVal("read.precision.val"); Standard_Real rp = Interface_Static::RVal("read.precision.val");
~~~~~ ~~~~
Modify this parameter with: Modify this parameter with:
~~~~~ ~~~~{.cpp}
if (!Interface_Static::SetRVal ("read.precision.val",0.001)) if (!Interface_Static::SetRVal ("read.precision.val",0.001))
.. error ..; .. error ..;
~~~~~ ~~~~
Default value is 0.0001. Default value is 0.0001.
The value given to this parameter is a target value that is applied to *TopoDS_Vertex, TopoDS_Edge* and *TopoDS_Face* entities. The processor does its best to reach it. Under certain circumstances, the value you give may not be attached to all of the entities concerned at the end of processing. IGES-to-OCCT translation does not improve the quality of the geometry in the original IGES file. This means that the value you enter may be impossible to attain the given quality of geometry in the IGES file. The value given to this parameter is a target value that is applied to *TopoDS_Vertex, TopoDS_Edge* and *TopoDS_Face* entities. The processor does its best to reach it. Under certain circumstances, the value you give may not be attached to all of the entities concerned at the end of processing. IGES-to-OCCT translation does not improve the quality of the geometry in the original IGES file. This means that the value you enter may be impossible to attain the given quality of geometry in the IGES file.
@ -154,27 +154,27 @@ defines the mode of applying the maximum allowed tolerance. Its possible values
* *Forced(1)* maximum tolerance is used as a rigid limit, i.e. it can not be exceeded and, if this happens, tolerance is trimmed to suit the maximum-allowable value. * *Forced(1)* maximum tolerance is used as a rigid limit, i.e. it can not be exceeded and, if this happens, tolerance is trimmed to suit the maximum-allowable value.
Read this parameter with: Read this parameter with:
~~~~~ ~~~~{.cpp}
Standard_Integer mv = Interface_Static::IVal("read.maxprecision.mode"); Standard_Integer mv = Interface_Static::IVal("read.maxprecision.mode");
~~~~~ ~~~~
Modify this parameter with: Modify this parameter with:
~~~~~ ~~~~{.cpp}
if (!Interface_Static::SetIVal ("read.maxprecision.mode",1)) if (!Interface_Static::SetIVal ("read.maxprecision.mode",1))
.. error ..; .. error ..;
~~~~~ ~~~~
Default value is *Preferred (0)*. Default value is *Preferred (0)*.
<h4>read.maxprecision.val</h4> <h4>read.maxprecision.val</h4>
defines the maximum allowable tolerance (in mm) of the shape. It should be not less than the basis value of tolerance set in processor (either Resolution from the file or *read.precision.val*). Actually, the maximum between *read.maxprecision.val* and basis tolerance is used to define maximum allowed tolerance. defines the maximum allowable tolerance (in mm) of the shape. It should be not less than the basis value of tolerance set in processor (either Resolution from the file or *read.precision.val*). Actually, the maximum between *read.maxprecision.val* and basis tolerance is used to define maximum allowed tolerance.
Read this parameter with: Read this parameter with:
~~~~~ ~~~~{.cpp}
Standard_Real rp = Interface_Static::RVal("read.maxprecision.val"); Standard_Real rp = Interface_Static::RVal("read.maxprecision.val");
~~~~~ ~~~~
Modify this parameter with: Modify this parameter with:
~~~~~ ~~~~{.cpp}
if (!Interface_Static::SetRVal ("read.maxprecision.val",0.1)) if (!Interface_Static::SetRVal ("read.maxprecision.val",0.1))
.. error ..; .. error ..;
~~~~~ ~~~~
Default value is 1. Default value is 1.
<h4>read.stdsameparameter.mode</h4> <h4>read.stdsameparameter.mode</h4>
@ -183,14 +183,14 @@ defines the using of *BRepLib\::SameParameter*. Its possible values are:
* 1 (On) -- *BRepLib\::SameParameter* is called. * 1 (On) -- *BRepLib\::SameParameter* is called.
*BRepLib\::SameParameter* is used through *ShapeFix_Edge\::SameParameter*. It ensures that the resulting edge will have the lowest tolerance taking pcurves either unmodified from the IGES file or modified by *BRepLib\::SameParameter*. *BRepLib\::SameParameter* is used through *ShapeFix_Edge\::SameParameter*. It ensures that the resulting edge will have the lowest tolerance taking pcurves either unmodified from the IGES file or modified by *BRepLib\::SameParameter*.
Read this parameter with: Read this parameter with:
~~~~~ ~~~~{.cpp}
Standard_Integer mv = Interface_Static::IVal("read.stdsameparameter.mode"); Standard_Integer mv = Interface_Static::IVal("read.stdsameparameter.mode");
~~~~~ ~~~~
Modify this parameter with: Modify this parameter with:
~~~~~ ~~~~{.cpp}
if (!Interface_Static::SetIVal ("read.stdsameparameter.mode",1)) if (!Interface_Static::SetIVal ("read.stdsameparameter.mode",1))
.. error ..; .. error ..;
~~~~~ ~~~~
Deafault value is 0 (Off). Deafault value is 0 (Off).
<h4>read.surfacecurve.mode</h4> <h4>read.surfacecurve.mode</h4>
@ -224,42 +224,42 @@ In any other case, the 2D representation is preferred to the 3D.
If either a 3D or a 2D contour is absent in the file or cannot be translated, then it is re-computed from another contour. If the translation of both 2D and 3D contours fails, the whole curve (type 141 or 142) is not translated. If this curve is used for trimming a face, the face will be translated without this trimming and will have natural restrictions. If either a 3D or a 2D contour is absent in the file or cannot be translated, then it is re-computed from another contour. If the translation of both 2D and 3D contours fails, the whole curve (type 141 or 142) is not translated. If this curve is used for trimming a face, the face will be translated without this trimming and will have natural restrictions.
Read this parameter with: Read this parameter with:
~~~~~ ~~~~{.cpp}
Standard_Integer ic = Interface_Static::IVal("read.surfacecurve.mode"); Standard_Integer ic = Interface_Static::IVal("read.surfacecurve.mode");
~~~~~ ~~~~
Modify this value with: Modify this value with:
~~~~~ ~~~~{.cpp}
if (!Interface_Static::SetIVal ("read.surfacecurve.mode",3)) if (!Interface_Static::SetIVal ("read.surfacecurve.mode",3))
.. error ..; .. error ..;
~~~~~ ~~~~
Default value is Default (0). Default value is Default (0).
<h4>read.encoderegularity.angle</h4> <h4>read.encoderegularity.angle</h4>
This parameter is used within the *BRepLib::EncodeRegularity()* function which is called for a shape read from an IGES or a STEP file at the end of translation process. This function sets the regularity flag of an edge in a shell when this edge is shared by two faces. This flag shows the continuity, which these two faces are connected with at that edge. This parameter is used within the *BRepLib::EncodeRegularity()* function which is called for a shape read from an IGES or a STEP file at the end of translation process. This function sets the regularity flag of an edge in a shell when this edge is shared by two faces. This flag shows the continuity, which these two faces are connected with at that edge.
Read this parameter with: Read this parameter with:
~~~~~ ~~~~{.cpp}
Standard_Real era = Interface_Static::RVal("read.encoderegularity.angle"); Standard_Real era = Interface_Static::RVal("read.encoderegularity.angle");
~~~~~ ~~~~
Modify this parameter with: Modify this parameter with:
~~~~~ ~~~~{.cpp}
if (!Interface_Static::SetRVal ("read.encoderegularity.angle",0.1)) if (!Interface_Static::SetRVal ("read.encoderegularity.angle",0.1))
.. error ..; .. error ..;
~~~~~ ~~~~
Default value is 0.01. Default value is 0.01.
<h4>read.iges.bspline.approxd1.mode</h4> <h4>read.iges.bspline.approxd1.mode</h4>
This parameter is obsolete (it is rarely used in real practice). If set to True, it affects the translation of bspline curves of degree 1 from IGES: these curves (which geometrically are polylines) are split by duplicated points, and the translator attempts to convert each of the obtained parts to a bspline of a higher continuity. This parameter is obsolete (it is rarely used in real practice). If set to True, it affects the translation of bspline curves of degree 1 from IGES: these curves (which geometrically are polylines) are split by duplicated points, and the translator attempts to convert each of the obtained parts to a bspline of a higher continuity.
Read this parameter with: Read this parameter with:
~~~~~ ~~~~{.cpp}
Standard_Real bam = Interface_Static::CVal("read.iges.bspline.approxd1.mode"); Standard_Real bam = Interface_Static::CVal("read.iges.bspline.approxd1.mode");
~~~~~ ~~~~
Modify this parameter with: Modify this parameter with:
~~~~~ ~~~~{.cpp}
if (!Interface_Static::SetRVal ("read.encoderegularity.angle","On")) if (!Interface_Static::SetRVal ("read.encoderegularity.angle","On"))
.. error ..; .. error ..;
~~~~~ ~~~~
Default value is Off. Default value is Off.
@ -282,41 +282,41 @@ Default value is MM.
@subsubsection occt_iges_2_3_4 Selecting entities @subsubsection occt_iges_2_3_4 Selecting entities
A list of entities can be formed by invoking the method *IGESControl_Reader::GiveList*. A list of entities can be formed by invoking the method *IGESControl_Reader::GiveList*.
~~~~~ ~~~~{.cpp}
Handle(TColStd_HSequenceOfTransient) list = reader.GiveList(); Handle(TColStd_HSequenceOfTransient) list = reader.GiveList();
~~~~~ ~~~~
Several predefined operators can be used to select a list of entities of a specific type. Several predefined operators can be used to select a list of entities of a specific type.
To make a selection, use the method *IGESControl_Reader::GiveList* with the selection type in quotation marks as an argument. You can also make cumulative selections. For example, you would use the following syntax: To make a selection, use the method *IGESControl_Reader::GiveList* with the selection type in quotation marks as an argument. You can also make cumulative selections. For example, you would use the following Syntax:
1. Requesting the faces in the file: 1. Requesting the faces in the file:
~~~~~ ~~~~{.cpp}
faces = Reader.GiveList("iges-faces"); faces = Reader.GiveList("iges-faces");
~~~~~ ~~~~
2. Requesting the visible roots in the file: 2. Requesting the visible roots in the file:
~~~~~ ~~~~{.cpp}
visibles = Reader.GiveList(iges-visible-roots); visibles = Reader.GiveList(iges-visible-roots);
~~~~~ ~~~~
3. Requesting the visible faces: 3. Requesting the visible faces:
~~~~~ ~~~~{.cpp}
visfac = Reader.GiveList(iges-visible-roots,faces); visfac = Reader.GiveList(iges-visible-roots,faces);
~~~~~ ~~~~
Using a signature, you can define a selection dynamically, filtering the string by means of a criterion. When you request a selection using the method GiveList, you can give either a predefined selection or a selection by signature. You make your selection by signature using the predefined signature followed by your criterion in parentheses as shown in the example below. The syntaxes given are equivalent to each other. Using a signature, you can define a selection dynamically, filtering the string by means of a criterion. When you request a selection using the method GiveList, you can give either a predefined selection or a selection by signature. You make your selection by signature using the predefined signature followed by your criterion in parentheses as shown in the example below. The syntaxes given are equivalent to each other.
~~~~~ ~~~~{.cpp}
faces = Reader.GiveList(“xst-type(SurfaceOfRevolution)”); faces = Reader.GiveList(“xst-type(SurfaceOfRevolution)”);
faces = Reader.GiveList(“iges-type(120)”); faces = Reader.GiveList(“iges-type(120)”);
~~~~~ ~~~~
You can also look for: You can also look for:
* values returned by your signature which match your criterion exactly * values returned by your signature which match your criterion exactly
~~~~~ ~~~~{.cpp}
faces = Reader.GiveList(“xst-type(=SurfaceOfRevolution)”); faces = Reader.GiveList(“xst-type(=SurfaceOfRevolution)”);
~~~~~ ~~~~
* values returned by your signature which do not contain your criterion * values returned by your signature which do not contain your criterion
~~~~~ ~~~~{.cpp}
faces = Reader.GiveList(“xst-type(!SurfaceOfRevolution)”); faces = Reader.GiveList(“xst-type(!SurfaceOfRevolution)”);
~~~~~ ~~~~
* values returned by your signature which do not exactly match your criterion. * values returned by your signature which do not exactly match your criterion.
~~~~~ ~~~~{.cpp}
faces = Reader.GiveList(“xst-type(!=SurfaceOfRevolution)”); faces = Reader.GiveList(“xst-type(!=SurfaceOfRevolution)”);
~~~~~ ~~~~
<h4>List of predefined operators that can be used:</h4> <h4>List of predefined operators that can be used:</h4>
* *xst-model-all* -- selects all entities. * *xst-model-all* -- selects all entities.
@ -342,62 +342,62 @@ faces = Reader.GiveList(“xst-type(!=SurfaceOfRevolution)”);
@subsubsection occt_iges_2_3_5 Performing the IGES file translation @subsubsection occt_iges_2_3_5 Performing the IGES file translation
Perform translation according to what you want to translate: Perform translation according to what you want to translate:
1. Translate an entity identified by its rank with: 1. Translate an entity identified by its rank with:
~~~~~ ~~~~{.cpp}
Standard_Boolean ok = reader.Transfer (rank); Standard_Boolean ok = reader.Transfer (rank);
~~~~~ ~~~~
2. Translate an entity identified by its handle with: 2. Translate an entity identified by its handle with:
~~~~~ ~~~~{.cpp}
Standard_Boolean ok = reader.TransferEntity (ent); Standard_Boolean ok = reader.TransferEntity (ent);
~~~~~ ~~~~
3. Translate a list of entities in one operation with: 3. Translate a list of entities in one operation with:
~~~~~ ~~~~{.cpp}
Standard_Integer nbtrans = reader.TransferList (list); Standard_Integer nbtrans = reader.TransferList (list);
reader.IsDone(); reader.IsDone();
~~~~~ ~~~~
where *nbtrans* returns the number of items in the list that produced a shape and *reader.IsDone()* indicates whether at least one entity was translated. where *nbtrans* returns the number of items in the list that produced a shape and *reader.IsDone()* indicates whether at least one entity was translated.
4. Translate a list of entities, entity by entity: 4. Translate a list of entities, entity by entity:
~~~~~ ~~~~{.cpp}
Standard_Integer i,nb = list-Length(); Standard_Integer i,nb = list-Length();
for (i = 1; i <= nb; i ++) { for (i = 1; i <= nb; i ++) {
Handle(Standard_Transient) ent = list-Value(i); Handle(Standard_Transient) ent = list-Value(i);
Standard_Boolean OK = reader.TransferEntity (ent); Standard_Boolean OK = reader.TransferEntity (ent);
} }
~~~~~ ~~~~
5. Translate the whole file (all entities or only visible entities) with: 5. Translate the whole file (all entities or only visible entities) with:
~~~~~ ~~~~{.cpp}
Standard_Boolean onlyvisible = Standard_True or Standard_False; Standard_Boolean onlyvisible = Standard_True or Standard_False;
reader.TransferRoots(onlyvisible) reader.TransferRoots(onlyvisible)
~~~~~ ~~~~
@subsubsection occt_iges_2_3_6 Getting the translation results @subsubsection occt_iges_2_3_6 Getting the translation results
Each successful translation operation outputs one shape. A series of translations gives a series of shapes. Each successful translation operation outputs one shape. A series of translations gives a series of shapes.
Each time you invoke *TransferEntity, Transfer* or *Transferlist*, their results are accumulated and NbShapes increases. You can clear the results (Clear function) between two translation operations, if you do not do this, the results from the next translation will be added to the accumulation. *TransferRoots* operations automatically clear all existing results before they start. Each time you invoke *TransferEntity, Transfer* or *Transferlist*, their results are accumulated and NbShapes increases. You can clear the results (Clear function) between two translation operations, if you do not do this, the results from the next translation will be added to the accumulation. *TransferRoots* operations automatically clear all existing results before they start.
~~~~~ ~~~~{.cpp}
Standard_Integer nbs = reader.NbShapes(); Standard_Integer nbs = reader.NbShapes();
~~~~~ ~~~~
returns the number of shapes recorded in the result. returns the number of shapes recorded in the result.
~~~~~ ~~~~{.cpp}
TopoDS_Shape shape = reader.Shape(num);, TopoDS_Shape shape = reader.Shape(num);,
~~~~~ ~~~~
returns the result *num*, where *num* is an integer between 1 and *NbShapes*. returns the result *num*, where *num* is an integer between 1 and *NbShapes*.
~~~~~ ~~~~{.cpp}
TopoDS_Shape shape = reader.Shape(); TopoDS_Shape shape = reader.Shape();
~~~~~ ~~~~
returns the first result in a translation operation. returns the first result in a translation operation.
~~~~~ ~~~~{.cpp}
TopoDS_Shape shape = reader.OneShape(); TopoDS_Shape shape = reader.OneShape();
~~~~~ ~~~~
returns all results in a single shape which is: returns all results in a single shape which is:
* a null shape if there are no results, * a null shape if there are no results,
* in case of a single result, a shape that is specific to that result, * in case of a single result, a shape that is specific to that result,
* a compound that lists the results if there are several results. * a compound that lists the results if there are several results.
~~~~~ ~~~~{.cpp}
reader.Clear(); reader.Clear();
~~~~~ ~~~~
erases the existing results. erases the existing results.
~~~~~ ~~~~{.cpp}
reader.PrintTransferInfo (failsonly, mode); reader.PrintTransferInfo (failsonly, mode);
~~~~~ ~~~~
displays the messages that appeared during the last invocation of *Transfer* or *TransferRoots*. displays the messages that appeared during the last invocation of *Transfer* or *TransferRoots*.
If *failsonly* is *IFSelect_FailOnly*, only fail messages will be output, if it is *IFSelect_FailAndWarn*, all messages will be output. Parameter “mode” can have *IFSelect_xxx* values where *xxx* can be: If *failsonly* is *IFSelect_FailOnly*, only fail messages will be output, if it is *IFSelect_FailAndWarn*, all messages will be output. Parameter “mode” can have *IFSelect_xxx* values where *xxx* can be:
@ -490,25 +490,25 @@ If a *TopoDS_Face* is output, its geometrical support is a *Geom_Surface* and i
@subsection occt_iges_2_5 Messages @subsection occt_iges_2_5 Messages
Messages are displayed concerning the normal functioning of the processor (transfer, loading, etc.). Messages are displayed concerning the normal functioning of the processor (transfer, loading, etc.).
You must declare an include file: You must declare an include file:
~~~~~ ~~~~{.cpp}
#include \<Interface_DT.hxx\> #include \<Interface_DT.hxx\>
~~~~~ ~~~~
You have the choice of the following options for messages: You have the choice of the following options for messages:
~~~~~ ~~~~{.cpp}
IDT_SetLevel (level); IDT_SetLevel (level);
~~~~~ ~~~~
level modifies the level of messages: level modifies the level of messages:
* 0: no messages * 0: no messages
* 1: raise and fail messages are displayed, as are messages concerning file access, * 1: raise and fail messages are displayed, as are messages concerning file access,
* 2: warnings are also displayed. * 2: warnings are also displayed.
~~~~~ ~~~~{.cpp}
IDT_SetFile (“tracefile.log”); IDT_SetFile (“tracefile.log”);
~~~~~ ~~~~
prints the messages in a file, prints the messages in a file,
~~~~~ ~~~~{.cpp}
IDT_SetStandard(); IDT_SetStandard();
~~~~~ ~~~~
restores screen output. restores screen output.
@subsection occt_iges_2_6 Tolerance management @subsection occt_iges_2_6 Tolerance management
@ -605,7 +605,7 @@ The highlighted classes produce OCCT geometry.
@subsection occt_iges_2_8 Example @subsection occt_iges_2_8 Example
~~~~~ ~~~~{.cpp}
#include “IGESControl_Reader.hxx” #include “IGESControl_Reader.hxx”
#include “TColStd_HSequenceOfTransient.hxx” #include “TColStd_HSequenceOfTransient.hxx”
#include “TopoDS_Shape.hxx” #include “TopoDS_Shape.hxx”
@ -627,7 +627,7 @@ cout<<"IGES Faces: "<<nIgesFaces<<" Transferred:"<<nTransFaces<<endl;
TopoDS_Shape sh = myIgesReader.OneShape(); TopoDS_Shape sh = myIgesReader.OneShape();
//and obtains the results in an OCCT shape. //and obtains the results in an OCCT shape.
} }
~~~~~ ~~~~
@section occt_iges_3 Writing IGES @section occt_iges_3 Writing IGES
@subsection occt_iges_3_1 Procedure @subsection occt_iges_3_1 Procedure
@ -665,13 +665,13 @@ The following parameters are used for the OCCT-to-IGES translation.
* "Faces" (0): OCCT *TopoDS_Faces* will be translated into IGES 144 (Trimmed Surface) entities, no BRep entities will be written to the IGES file, * "Faces" (0): OCCT *TopoDS_Faces* will be translated into IGES 144 (Trimmed Surface) entities, no BRep entities will be written to the IGES file,
* "BRep" (1): OCCT *TopoDS_Faces* will be translated into IGES 510 (Face) entities, the IGES file will contain BRep entities. * "BRep" (1): OCCT *TopoDS_Faces* will be translated into IGES 510 (Face) entities, the IGES file will contain BRep entities.
Read this parameter with: Read this parameter with:
~~~~~ ~~~~{.cpp}
Standard_Integer byvalue = Interface_Static::IVal("write.iges.brep.mode"); Standard_Integer byvalue = Interface_Static::IVal("write.iges.brep.mode");
~~~~~ ~~~~
Modify this parameter with: Modify this parameter with:
~~~~~ ~~~~{.cpp}
Interface_Static::SetIVal ("write.iges.brep.mode", 1); Interface_Static::SetIVal ("write.iges.brep.mode", 1);
~~~~~ ~~~~
Default value is "Faces" (0). Default value is "Faces" (0).
* *write.convertsurface.mode* when writing to IGES in the BRep mode, this parameter indicates whether elementary surfaces (cylindrical, conical, spherical, and toroidal) are converted into corresponding IGES 5.3 entities (if the value of a parameter value is On), or written as surfaces of revolution (by default). * *write.convertsurface.mode* when writing to IGES in the BRep mode, this parameter indicates whether elementary surfaces (cylindrical, conical, spherical, and toroidal) are converted into corresponding IGES 5.3 entities (if the value of a parameter value is On), or written as surfaces of revolution (by default).
* *write.iges.unit:* allows choosing the unit. The default unit for Open CASCADE Technology is "MM" (millimeter). You can choose to write a file into any unit accepted by IGES. * *write.iges.unit:* allows choosing the unit. The default unit for Open CASCADE Technology is "MM" (millimeter). You can choose to write a file into any unit accepted by IGES.
@ -700,46 +700,46 @@ Default value is "Faces" (0).
* *write.precision.val:* is the user precision value. This parameter gives the resolution value for an IGES file when the *write.precision.mode* parameter value is 1. It is equal to 0.0001 by default, but can take any real positive (non null) value. * *write.precision.val:* is the user precision value. This parameter gives the resolution value for an IGES file when the *write.precision.mode* parameter value is 1. It is equal to 0.0001 by default, but can take any real positive (non null) value.
Read this parameter with: Read this parameter with:
~~~~~ ~~~~{.cpp}
Standard_Real rp = Interface_Static::RVal(;write.precision.val;); Standard_Real rp = Interface_Static::RVal(;write.precision.val;);
~~~~~ ~~~~
Modify this parameter with: Modify this parameter with:
~~~~~ ~~~~{.cpp}
if (!Interface_Static::SetRVal(;write.precision.val;,0.01)) if (!Interface_Static::SetRVal(;write.precision.val;,0.01))
.. error .. .. error ..
~~~~~ ~~~~
Default value is 0.0001. Default value is 0.0001.
<h4>write.iges.resource.name</h4> and <h4>write.iges.sequence</h4> are the same as the corresponding read.iges.\* parameters. Note that the default sequence for writing contains *DirectFaces* operator, which converts elementary surfaces based on left-hand axes (valid in CASCADE) to right-hand axes (which are valid only in IGES). <h4>write.iges.resource.name</h4> and <h4>write.iges.sequence</h4> are the same as the corresponding read.iges.\* parameters. Note that the default sequence for writing contains *DirectFaces* operator, which converts elementary surfaces based on left-hand axes (valid in CASCADE) to right-hand axes (which are valid only in IGES).
Default values : Default values :
~~~~~ ~~~~{.cpp}
write.iges.resource.name - IGES, write.iges.resource.name - IGES,
write.iges.sequence - ToIGES. write.iges.sequence - ToIGES.
~~~~~ ~~~~
@subsubsection occt_iges_3_3_3 Performing the Open CASCADE Technology shape translation @subsubsection occt_iges_3_3_3 Performing the Open CASCADE Technology shape translation
You can perform the translation in one or several operations. Here is how you translate topological and geometrical objects: You can perform the translation in one or several operations. Here is how you translate topological and geometrical objects:
~~~~~ ~~~~{.cpp}
Standard_Boolean ok = writer.AddShape (TopoDS_Shape); Standard_Boolean ok = writer.AddShape (TopoDS_Shape);
~~~~~ ~~~~
*ok* is True if translation was correctly performed and False if there was at least one entity that was not translated. *ok* is True if translation was correctly performed and False if there was at least one entity that was not translated.
~~~~~ ~~~~{.cpp}
Standard_Boolean ok = writer.AddGeom (geom); Standard_Boolean ok = writer.AddGeom (geom);
~~~~~ ~~~~
where *geom* is *Handle(Geom_Curve)* or *Handle(Geom_Surface)*; where *geom* is *Handle(Geom_Curve)* or *Handle(Geom_Surface)*;
*ok* is True if the translation was correctly performed and False if there was at least one entity whose geometry was not among the allowed types. *ok* is True if the translation was correctly performed and False if there was at least one entity whose geometry was not among the allowed types.
@subsubsection occt_iges_3_3_4 Writing the IGES file @subsubsection occt_iges_3_3_4 Writing the IGES file
Write the IGES file with: Write the IGES file with:
~~~~~ ~~~~{.cpp}
Standard_Boolean ok = writer.Write ("filename.igs"); Standard_Boolean ok = writer.Write ("filename.igs");
~~~~~ ~~~~
to give the file name. to give the file name.
~~~~~ ~~~~{.cpp}
Standard_Boolean ok = writer.Write (S); Standard_Boolean ok = writer.Write (S);
~~~~~ ~~~~
where *S* is *Standard_OStream* where *S* is *Standard_OStream*
*ok* is True if the operation was correctly performed and False if an error occurred (for instance, if the processor could not create the file). *ok* is True if the operation was correctly performed and False if an error occurred (for instance, if the processor could not create the file).
@ -823,7 +823,7 @@ The highlighted classes are intended to translate geometry.
@subsection occt_iges_3_7 Example @subsection occt_iges_3_7 Example
~~~~~{c++} ~~~~{.cpp}
#include <IGESControl_Controller.hxx> #include <IGESControl_Controller.hxx>
#include <IGESControl_Writer.hxx> #include <IGESControl_Writer.hxx>
#include <TopoDS_Shape.hxx> #include <TopoDS_Shape.hxx>
@ -839,7 +839,7 @@ Standard_Integer main()
Standard_Boolean OK = ICW.Write (;MyFile.igs;); Standard_Boolean OK = ICW.Write (;MyFile.igs;);
//writes a model to the file MyFile.igs //writes a model to the file MyFile.igs
} }
~~~~~ ~~~~
@section occt_iges_4 Using XSTEPDRAW @section occt_iges_4 Using XSTEPDRAW
@ -852,7 +852,7 @@ In the description of commands, square brackets ([]) are used to indicate optio
A set of parameters for importing and exporting IGES files is defined in the XSTEP resource file. In XSTEPDRAW, these parameters can be viewed or changed using command A set of parameters for importing and exporting IGES files is defined in the XSTEP resource file. In XSTEPDRAW, these parameters can be viewed or changed using command
~~~~ ~~~~{.php}
Draw> param [<parameter_name> [<value>]] Draw> param [<parameter_name> [<value>]]
~~~~ ~~~~
@ -883,15 +883,15 @@ These parameters are set by command *param* :
It is possible either only to load an IGES file into memory (i.e. to fill the model with data from the file), or to read it (i.e. to load and convert all entities to OCCT shapes). It is possible either only to load an IGES file into memory (i.e. to fill the model with data from the file), or to read it (i.e. to load and convert all entities to OCCT shapes).
Loading is done by the command Loading is done by the command
~~~~~ ~~~~{.php}
Draw> xload <file_name> Draw> xload <file_name>
~~~~~ ~~~~
Once the file is loaded, it is possible to investigate the structure of the loaded data. To learn how to do it see @ref occt_iges_4_4 "Analyzing the transferred". Once the file is loaded, it is possible to investigate the structure of the loaded data. To learn how to do it see @ref occt_iges_4_4 "Analyzing the transferred".
Reading of an IGES file is done by the command Reading of an IGES file is done by the command
~~~~~ ~~~~{.php}
Draw> igesbrep <file_name> <result_shape_name> [<selection>] Draw> igesbrep <file_name> <result_shape_name> [<selection>]
~~~~~ ~~~~
Here a dot can be used instead of a filename if the file is already loaded by *xload* or *igesbrep* command. In that case, only conversion of IGES entities to OCCT shapes will be done. Here a dot can be used instead of a filename if the file is already loaded by *xload* or *igesbrep* command. In that case, only conversion of IGES entities to OCCT shapes will be done.
Command *igesbrep* will interactively ask the user to select a set of entities to be converted: Command *igesbrep* will interactively ask the user to select a set of entities to be converted:
@ -912,13 +912,13 @@ The second parameter of the *igesbrep* command defines the name of the loaded s
Instead of *igesbrep* it is possible to use commands: Instead of *igesbrep* it is possible to use commands:
~~~~~ ~~~~{.php}
Draw> trimport <file_name> <result_shape_name> <selection> Draw> trimport <file_name> <result_shape_name> <selection>
~~~~~ ~~~~
which outputs the result of translation of each selected entity into one shape, or which outputs the result of translation of each selected entity into one shape, or
~~~~~ ~~~~{.php}
Draw> trimpcomp <file_name> <result_shape_name> <selection> Draw> trimpcomp <file_name> <result_shape_name> <selection>
~~~~~ ~~~~
which outputs the result of translation of all selected entities into one shape (*TopoDS_Compound* for several entities). which outputs the result of translation of all selected entities into one shape (*TopoDS_Compound* for several entities).
An asterisk “*” can be specified instead of *selection*, it means *xst-transferrable-roots*. An asterisk “*” can be specified instead of *selection*, it means *xst-transferrable-roots*.
@ -940,9 +940,9 @@ The procedure of analysis of the data import can be divided into two stages:
@subsubsection occt_iges_4_4_1 Checking file contents @subsubsection occt_iges_4_4_1 Checking file contents
General statistics on the loaded data can be obtained by using command General statistics on the loaded data can be obtained by using command
~~~~~ ~~~~{.php}
Draw> data <symbol> Draw> data <symbol>
~~~~~ ~~~~
The information printed by this command depends on the symbol specified: The information printed by this command depends on the symbol specified:
| Symbol | Output | | Symbol | Output |
@ -963,18 +963,18 @@ There is a set of special objects, which can be used to operate with the loaded
A list of these objects defined in the current session can be printed in DRAW by command A list of these objects defined in the current session can be printed in DRAW by command
~~~~~ ~~~~{.php}
Draw> listitems Draw> listitems
~~~~~ ~~~~
In the following commands if several <i>\<selection\></i> arguments are specified the results of each following selection are applied to the results of the previous one. In the following commands if several <i>\<selection\></i> arguments are specified the results of each following selection are applied to the results of the previous one.
~~~~~ ~~~~{.php}
Draw> givelist <selection_name> [<selection_name>] Draw> givelist <selection_name> [<selection_name>]
~~~~~ ~~~~
prints a list of loaded entities defined by selection argument. prints a list of loaded entities defined by selection argument.
~~~~~ ~~~~{.php}
Draw> givecount <selection_name> [<selection_name>] Draw> givecount <selection_name> [<selection_name>]
~~~~~ ~~~~
prints a number of loaded entities defined by <i>selection</i> argument. prints a number of loaded entities defined by <i>selection</i> argument.
Three commands are used to calculate statistics on the entities in the model: Three commands are used to calculate statistics on the entities in the model:
@ -991,9 +991,9 @@ Optional <i>\<selection\></i> argument, if specified, defines a subset of entiti
| iges-levels | Calculates how much entities lie in different IGES levels | | iges-levels | Calculates how much entities lie in different IGES levels |
The command: The command:
~~~~~ ~~~~{.php}
Draw> listtypes <selection_name> ... Draw> listtypes <selection_name> ...
~~~~~ ~~~~
gives a list of entity types which were encountered in the last loaded file (with a number of IGES 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. gives a list of entity types which were encountered in the last loaded file (with a number of IGES 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.
Entities in the IGES file are numbered in the succeeding order. An entity can be identified either by its number (#) or by its label. Label is the letter ‘D’ followed by the index of the first line with the data for this entity in the Directory Entry section of the IGES file. The label can be calculated on the basis of the number as ‘D(2*# -1)’. For example, entity # 6 has label D11. Entities in the IGES file are numbered in the succeeding order. An entity can be identified either by its number (#) or by its label. Label is the letter ‘D’ followed by the index of the first line with the data for this entity in the Directory Entry section of the IGES file. The label can be calculated on the basis of the number as ‘D(2*# -1)’. For example, entity # 6 has label D11.
@ -1006,9 +1006,9 @@ Entities in the IGES file are numbered in the succeeding order. An entity can b
@subsubsection occt_iges_4_4_2 Estimating the results of reading IGES @subsubsection occt_iges_4_4_2 Estimating the results of reading IGES
All of the following commands are available only after the data are converted into OCCT shapes (i.e. after command **igesbrep**). All of the following commands are available only after the data are converted into OCCT shapes (i.e. after command **igesbrep**).
~~~~~ ~~~~{.php}
Draw> tpstat [*|?]<symbol> [<selection>] Draw> tpstat [*|?]<symbol> [<selection>]
~~~~~ ~~~~
provides all statistics on the last transfer, including the list of transferred entities with mapping from IGES to OCCT types, as well as fail and warning messages. The parameter <i>\<symbol\></i> defines what information will be printed: provides all statistics on the last transfer, including the list of transferred entities with mapping from IGES to OCCT types, as well as fail and warning messages. The parameter <i>\<symbol\></i> defines what information will be printed:
* G -- General statistics (list of results and messages) * G -- General statistics (list of results and messages)
* C -- Count of all warning and fail messages * C -- Count of all warning and fail messages
@ -1028,13 +1028,13 @@ Optional argument <i>\<selection\></i> can limit the action of the command with
To get help, run this command without arguments. To get help, run this command without arguments.
For example, to get translation ratio on IGES faces, you can use. For example, to get translation ratio on IGES faces, you can use.
~~~~~ ~~~~{.php}
Draw:> tpstat *l iges-faces Draw:> tpstat *l iges-faces
~~~~~ ~~~~
The second version of the same command is TPSTAT (not capital spelling). The second version of the same command is TPSTAT (not capital spelling).
~~~~~ ~~~~{.php}
Draw:> TPSTAT <symbol> Draw:> TPSTAT <symbol>
~~~~~ ~~~~
Symbol can be of the following values: Symbol can be of the following values:
* g -- General statistics (list of results and messages) * g -- General statistics (list of results and messages)
* c -- Count of all warning and fail messages * c -- Count of all warning and fail messages
@ -1045,37 +1045,37 @@ Symbol can be of the following values:
Sometimes the trimming contours of IGES faces (i.e., entity 141 for 143, 142 for 144) can be lost during translation due to fails. Sometimes the trimming contours of IGES faces (i.e., entity 141 for 143, 142 for 144) can be lost during translation due to fails.
The number of lost trims and the corresponding IGES entities can be obtained by the command: The number of lost trims and the corresponding IGES entities can be obtained by the command:
~~~~~ ~~~~{.php}
Draw> tplosttrim [<IGES_type>] Draw> tplosttrim [<IGES_type>]
~~~~~ ~~~~
It outputs the rank and DE 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. It outputs the rank and DE 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 <i>\<IGES_type\></i> can be *TrimmedSurface, BoundedSurface* or *Face* to specify the only type of IGES faces. Optional parameter <i>\<IGES_type\></i> can be *TrimmedSurface, BoundedSurface* or *Face* to specify the only type of IGES faces.
For example, to get untrimmed 144 entities, use command For example, to get untrimmed 144 entities, use command
~~~~~ ~~~~{.php}
Draw> tplosttrim TrimmedSurface Draw> tplosttrim TrimmedSurface
~~~~~ ~~~~
To get the information on OCCT shape contents, use command To get the information on OCCT shape contents, use command
~~~~~ ~~~~{.php}
Draw> statshape <shape_name> Draw> statshape <shape_name>
~~~~~ ~~~~
It outputs the number of each kind of shapes (vertex, edge, wire, etc.) in a shape and some geometrical data (number of C0 surfaces, curves, indirect surfaces, etc.). It outputs the number of each kind of shapes (vertex, edge, wire, etc.) in a shape and some geometrical data (number of C0 surfaces, curves, indirect surfaces, etc.).
Note. The number of faces is returned as a number of references. To obtain the number of single instances the standard command (from TTOPOLOGY executable) **nbshapes** can be used. Note. The number of faces is returned as a number of references. To obtain the number of single instances the standard command (from TTOPOLOGY executable) **nbshapes** can be used.
To analyze the internal validity of a shape, use command To analyze the internal validity of a shape, use command
~~~~~ ~~~~{.php}
Draw> checkbrep <shape_name> <expurged_shape_name> Draw> checkbrep <shape_name> <expurged_shape_name>
~~~~~ ~~~~
It checks the geometry and topology of a shape for different cases of inconsistency, like self-intersecting wires or wrong orientation of trimming contours. If an error is found, it copies bad parts of the shape with the names "expurged_subshape_name _#" and generates an appropriate message. If possible, this command also tries to find IGES entities the OCCT shape was produced from. It checks the geometry and topology of a shape for different cases of inconsistency, like self-intersecting wires or wrong orientation of trimming contours. If an error is found, it copies bad parts of the shape with the names "expurged_subshape_name _#" and generates an appropriate message. If possible, this command also tries to find IGES entities the OCCT shape was produced from.
<i>\<expurged_shape_name\></i> will contain the original shape without invalid subshapes. <i>\<expurged_shape_name\></i> will contain the original shape without invalid subshapes.
To get information on tolerances of subshapes, use command To get information on tolerances of subshapes, use command
~~~~~ ~~~~{.php}
Draw> tolerance <shape_name> [<min> [<max>] [<symbol>]] Draw> tolerance <shape_name> [<min> [<max>] [<symbol>]]
~~~~~ ~~~~
It outputs maximum, average and minimum values of tolerances for each kind of subshapes having tolerances or it can output tolerances of all subshapes of the whole shape. It outputs maximum, average and minimum values of tolerances for each kind of subshapes having tolerances or it can output tolerances of all subshapes of the whole shape.
When specifying *min* and *max* arguments this command outputs shapes with names <i>\<shape_name\>...</i> and their total number with tolerances in the range <i>[min, max]</i>. When specifying *min* and *max* arguments this command outputs shapes with names <i>\<shape_name\>...</i> and their total number with tolerances in the range <i>[min, max]</i>.
@ -1099,19 +1099,19 @@ Refer to @ref occt_iges_3_3_2 "Setting the translation parameters" for a descrip
| Measurement units | XSTEP.iges.unit | 1-11 (or a string value) | | Measurement units | XSTEP.iges.unit | 1-11 (or a string value) |
Several shapes can be written in one file. To start writing a new file, enter command Several shapes can be written in one file. To start writing a new file, enter command
~~~~~ ~~~~{.php}
Draw> newmodel Draw> newmodel
~~~~~ ~~~~
This command clears the *InterfaceModel* to make it empty. This command clears the *InterfaceModel* to make it empty.
~~~~~ ~~~~{.php}
Draw> brepiges <shape_name_1> [<filename.igs>] Draw> brepiges <shape_name_1> [<filename.igs>]
~~~~~ ~~~~
Converts the specified shapes into IGES entities and puts them into the *InterfaceModel*. Converts the specified shapes into IGES entities and puts them into the *InterfaceModel*.
~~~~~ ~~~~{.php}
Draw> writeall <filename.igs> Draw> writeall <filename.igs>
~~~~~ ~~~~
Allows writing the prepared model to a file with name *filename.igs*. Allows writing the prepared model to a file with name *filename.igs*.
@section occt_iges_5 Reading from and writing to IGES @section occt_iges_5 Reading from and writing to IGES
@ -1121,10 +1121,10 @@ Allows writing the prepared model to a file with name *filename.igs*.
### Load an IGES file ### Load an IGES file
Before performing any other operation, you must load an IGES file with: Before performing any other operation, you must load an IGES file with:
~~~~~ ~~~~{.cpp}
IGESCAFControl_Reader reader(XSDRAW::Session(), Standard_False); IGESCAFControl_Reader reader(XSDRAW::Session(), Standard_False);
IFSelect_ReturnStatus stat = reader.ReadFile(“filename.igs”); IFSelect_ReturnStatus stat = reader.ReadFile(“filename.igs”);
~~~~~ ~~~~
Loading the file only memorizes, but does not translate the data. Loading the file only memorizes, but does not translate the data.
### Check the loaded IGES file ### Check the loaded IGES file
@ -1137,64 +1137,64 @@ See the description of @ref occt_iges_2_3_3 "Setting translation parameters" abo
In addition, the following parameters can be set for XDE translation of attributes: In addition, the following parameters can be set for XDE translation of attributes:
* For transferring colors: * For transferring colors:
~~~~~ ~~~~{.cpp}
reader.SetColorMode(mode); reader.SetColorMode(mode);
// mode can be Standard_True or Standard_False // mode can be Standard_True or Standard_False
~~~~~ ~~~~
* For transferring names: * For transferring names:
~~~~~ ~~~~{.cpp}
reader.SetNameMode(mode); reader.SetNameMode(mode);
// mode can be Standard_True or Standard_False // mode can be Standard_True or Standard_False
~~~~~ ~~~~
### Translate an IGES file to XDE ### Translate an IGES file to XDE
The following function performs a translation of the whole document: The following function performs a translation of the whole document:
~~~~~ ~~~~{.cpp}
Standard_Boolean ok = reader.Transfer(doc); Standard_Boolean ok = reader.Transfer(doc);
~~~~~ ~~~~
where *doc* is a variable which contains a handle to the output document and should have a type *Handle(TDocStd_Document)*. where *doc* is a variable which contains a handle to the output document and should have a type *Handle(TDocStd_Document)*.
@subsection occt_iges_5_2 Writing to IGES @subsection occt_iges_5_2 Writing to IGES
The translation from XDE to IGES can be initialized as follows: The translation from XDE to IGES can be initialized as follows:
~~~~~ ~~~~{.cpp}
IGESCAFControl_Writer aWriter(XSDRAW::Session(),Standard_False); IGESCAFControl_Writer aWriter(XSDRAW::Session(),Standard_False);
~~~~~ ~~~~
### Set parameters for translation from XDE to IGES ### Set parameters for translation from XDE to IGES
The following parameters can be set for translation of attributes to IGES: The following parameters can be set for translation of attributes to IGES:
* For transferring colors: * For transferring colors:
~~~~~ ~~~~{.cpp}
aWriter.SetColorMode(mode); aWriter.SetColorMode(mode);
// mode can be Standard_True or Standard_False // mode can be Standard_True or Standard_False
~~~~~ ~~~~
* For transferring names: * For transferring names:
~~~~~ ~~~~{.cpp}
aWriter.SetNameMode(mode); aWriter.SetNameMode(mode);
// mode can be Standard_True or Standard_False // mode can be Standard_True or Standard_False
~~~~~ ~~~~
### Translate an XDE document to IGES ### Translate an XDE document to IGES
You can perform the translation of a document by calling the function: You can perform the translation of a document by calling the function:
~~~~~ ~~~~{.cpp}
IFSelect_ReturnStatus aRetSt = aWriter.Transfer(doc); IFSelect_ReturnStatus aRetSt = aWriter.Transfer(doc);
~~~~~ ~~~~
where "doc" is a variable which contains a handle to the input document for transferring and should have a type *Handle(TDocStd_Document)*. where "doc" is a variable which contains a handle to the input document for transferring and should have a type *Handle(TDocStd_Document)*.
### Write an IGES file ### Write an IGES file
Write an IGES file with: Write an IGES file with:
~~~~~ ~~~~{.cpp}
IFSelect_ReturnStatus statw = aWriter.WriteFile("filename.igs"); IFSelect_ReturnStatus statw = aWriter.WriteFile("filename.igs");
~~~~~ ~~~~
or or
~~~~~ ~~~~{.cpp}
IFSelect_ReturnStatus statw = writer.WriteFile (S); IFSelect_ReturnStatus statw = writer.WriteFile (S);
~~~~~ ~~~~
where S is OStream. where S is OStream.

8
dox/user_guides/inspector/inspector.md
View File

@ -479,10 +479,10 @@ See more detailed description of the @ref occt_draw_13_1 "tinspector" command.
The simple code to start Inspector with all plugins loaded: The simple code to start Inspector with all plugins loaded:
~~~~~ ~~~~
pload INSPECTOR pload INSPECTOR
tinspector tinspector
~~~~~ ~~~~
@figure{drawexe_tinspector.png,"tinspector",360} @figure{drawexe_tinspector.png,"tinspector",360}
@ -509,7 +509,7 @@ In general, the following steps should be taken:
Here is an example of C++ implementation: Here is an example of C++ implementation:
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.cpp} ~~~~{.cpp}
#include <inspector/TInspector_Communicator.hxx> #include <inspector/TInspector_Communicator.hxx>
@ -533,7 +533,7 @@ void CreateInspector()
} }
MyTCommunicator->SetVisible (true); MyTCommunicator->SetVisible (true);
} }
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~
Give one the following objects for a plugin using a container of parameters: Give one the following objects for a plugin using a container of parameters:

12
dox/user_guides/mesh/mesh.md
View File

@ -30,7 +30,7 @@ Learn more about SALOME platform on https://www.salome-platform.org
The algorithm of shape triangulation is provided by the functionality of *BRepMesh_IncrementalMesh* class, which adds a triangulation of the shape to its topological data structure. This triangulation is used to visualize the shape in shaded mode. The algorithm of shape triangulation is provided by the functionality of *BRepMesh_IncrementalMesh* class, which adds a triangulation of the shape to its topological data structure. This triangulation is used to visualize the shape in shaded mode.
~~~~~ ~~~~{.cpp}
#include <IMeshData_Status.hxx> #include <IMeshData_Status.hxx>
#include <IMeshTools_Parameters.hxx> #include <IMeshTools_Parameters.hxx>
#include <BRepMesh_IncrementalMesh.hxx> #include <BRepMesh_IncrementalMesh.hxx>
@ -69,7 +69,7 @@ Standard_Boolean meshing_imeshtools_parameters()
const Standard_Integer aStatus = aMesher.GetStatusFlags(); const Standard_Integer aStatus = aMesher.GetStatusFlags();
return !aStatus; return !aStatus;
} }
~~~~~ ~~~~
The default meshing algorithm *BRepMesh_IncrementalMesh* has two major options to define triangulation -- linear and angular deflections. The default meshing algorithm *BRepMesh_IncrementalMesh* has two major options to define triangulation -- linear and angular deflections.
@ -194,7 +194,7 @@ OCCT comes with two base 2D meshing algorithms: *BRepMesh_MeshAlgoFactory* (used
The following example demonstrates how it could be done from *Draw* environment: The following example demonstrates how it could be done from *Draw* environment:
~~~~~ ~~~~{.php}
psphere s 10 psphere s 10
### Default Algo ### ### Default Algo ###
@ -202,11 +202,11 @@ incmesh s 0.0001 -algo default
### Delabella Algo ### ### Delabella Algo ###
incmesh s 0.0001 -algo delabella incmesh s 0.0001 -algo delabella
~~~~~ ~~~~
The code snippet below shows passing a custom mesh factory to BRepMesh_IncrementalMesh: The code snippet below shows passing a custom mesh factory to BRepMesh_IncrementalMesh:
~~~~~ ~~~~{.cpp}
IMeshTools_Parameters aMeshParams; IMeshTools_Parameters aMeshParams;
Handle(IMeshTools_Context) aContext = new BRepMesh_Context(); Handle(IMeshTools_Context) aContext = new BRepMesh_Context();
aContext->SetFaceDiscret (new BRepMesh_FaceDiscret (new BRepMesh_DelabellaMeshAlgoFactory())); aContext->SetFaceDiscret (new BRepMesh_FaceDiscret (new BRepMesh_DelabellaMeshAlgoFactory()));
@ -216,7 +216,7 @@ aMesher.SetShape (aShape);
aMesher.ChangeParameters() = aMeshParams; aMesher.ChangeParameters() = aMeshParams;
aMesher.Perform (aContext); aMesher.Perform (aContext);
~~~~~ ~~~~
#### Range splitter #### Range splitter
Range splitter tools provide functionality to generate internal surface nodes defined within the range computed using discrete model data. The base functionality is provided by *BRepMesh_DefaultRangeSplitter* which can be used without modifications in case of planar surface. The default splitter does not generate any internal node. Range splitter tools provide functionality to generate internal surface nodes defined within the range computed using discrete model data. The base functionality is provided by *BRepMesh_DefaultRangeSplitter* which can be used without modifications in case of planar surface. The default splitter does not generate any internal node.

588
dox/user_guides/modeling_algos/modeling_algos.md
View File

File diff suppressed because it is too large Load Diff

86
dox/user_guides/modeling_data/modeling_data.md
View File

@ -52,14 +52,14 @@ The class *Interpolate* from *GeomAPI* package allows building a constrained 3D
@figure{/user_guides/modeling_data/images/modeling_data_image003.png,"Approximation of a BSpline from scattered points",420} @figure{/user_guides/modeling_data/images/modeling_data_image003.png,"Approximation of a BSpline from scattered points",420}
This class may be instantiated as follows: This class may be instantiated as follows:
~~~~~ ~~~~{.cpp}
GeomAPI_Interpolate Interp(Points); GeomAPI_Interpolate Interp(Points);
~~~~~ ~~~~
From this object, the BSpline curve may be requested as follows: From this object, the BSpline curve may be requested as follows:
~~~~~ ~~~~{.cpp}
Handle(Geom_BSplineCurve) C = Interp.Curve(); Handle(Geom_BSplineCurve) C = Interp.Curve();
~~~~~ ~~~~
#### 2D Approximation #### 2D Approximation
@ -71,16 +71,16 @@ The class *PointsToBSpline* from GeomAPI package allows building a 3D BSplinecur
The resulting BSpline curve will be C2 or second degree continuous, except where a tangency constraint is defined on a point, through which the curve passes. In this case, it will be only C1 continuous. This class is instantiated as follows: The resulting BSpline curve will be C2 or second degree continuous, except where a tangency constraint is defined on a point, through which the curve passes. In this case, it will be only C1 continuous. This class is instantiated as follows:
~~~~~ ~~~~{.cpp}
GeomAPI_PointsToBSpline GeomAPI_PointsToBSpline
Approx(Points,DegMin,DegMax,Continuity, Tol); Approx(Points,DegMin,DegMax,Continuity, Tol);
~~~~~ ~~~~
From this object, the BSpline curve may be requested as follows: From this object, the BSpline curve may be requested as follows:
~~~~~ ~~~~{.cpp}
Handle(Geom_BSplineCurve) K = Approx.Curve(); Handle(Geom_BSplineCurve) K = Approx.Curve();
~~~~~ ~~~~
#### Surface Approximation #### Surface Approximation
@ -184,7 +184,7 @@ The object created (or implemented) is an algorithm which can be consulted to fi
If it was unsuccessful, the status gives the reason for the failure. If it was unsuccessful, the status gives the reason for the failure.
~~~~ ~~~~{.cpp}
gp_Pnt P1 (0.,0.,0.); gp_Pnt P1 (0.,0.,0.);
gp_Pnt P2 (0.,10.,0.); gp_Pnt P2 (0.,10.,0.);
gp_Pnt P3 (10.,0.,0.); gp_Pnt P3 (10.,0.,0.);
@ -246,7 +246,7 @@ Each class from *gp* package, such as *Circ, Circ2d, Mirror, Mirror2d*, etc., ha
It is possible to create a point using a *gce* package class, then question it to recover the corresponding *gp* object. It is possible to create a point using a *gce* package class, then question it to recover the corresponding *gp* object.
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.cpp} ~~~~{.cpp}
gp_Pnt2d Point1,Point2; gp_Pnt2d Point1,Point2;
... ...
//Initialization of Point1 and Point2 //Initialization of Point1 and Point2
@ -254,13 +254,13 @@ It is possible to create a point using a *gce* package class, then question it t
if (L.Status() == gce_Done() ){ if (L.Status() == gce_Done() ){
gp_Lin2d l = L.Value(); gp_Lin2d l = L.Value();
} }
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~
This is useful if you are uncertain as to whether the arguments can create the *gp* object without raising an exception. In the case above, if *Point1* and *Point2* are closer than the tolerance value required by *MakeLin2d*, the function *Status* will return the enumeration *gce_ConfusedPoint*. This tells you why the *gp* object cannot be created. If you know that the points *Point1* and *Point2* are separated by the value exceeding the tolerance value, then you may create the *gp* object directly, as follows: This is useful if you are uncertain as to whether the arguments can create the *gp* object without raising an exception. In the case above, if *Point1* and *Point2* are closer than the tolerance value required by *MakeLin2d*, the function *Status* will return the enumeration *gce_ConfusedPoint*. This tells you why the *gp* object cannot be created. If you know that the points *Point1* and *Point2* are separated by the value exceeding the tolerance value, then you may create the *gp* object directly, as follows:
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.cpp} ~~~~{.cpp}
gp_Lin2d l = gce_MakeLin2d(Point1,Point2); gp_Lin2d l = gce_MakeLin2d(Point1,Point2);
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~
@subsubsection occt_modat_1_2_2 Geometric entities manipulated by handle @subsubsection occt_modat_1_2_2 Geometric entities manipulated by handle
@ -363,20 +363,20 @@ The following characteristic points exist on parameterized curves in 3d space:
Let us take an adapted curve **C**, i.e. an object which is an interface between the services provided by either a 2D curve from the package Geom2d (in case of an Adaptor_Curve2d curve) or a 3D curve from the package Geom (in case of an Adaptor_Curve curve), and the services required on the curve by the computation algorithm. The adapted curve is created in the following way: Let us take an adapted curve **C**, i.e. an object which is an interface between the services provided by either a 2D curve from the package Geom2d (in case of an Adaptor_Curve2d curve) or a 3D curve from the package Geom (in case of an Adaptor_Curve curve), and the services required on the curve by the computation algorithm. The adapted curve is created in the following way:
**2D case :** **2D case :**
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.cpp} ~~~~{.cpp}
Handle(Geom2d_Curve) mycurve = ... ; Handle(Geom2d_Curve) mycurve = ... ;
Geom2dAdaptor_Curve C (mycurve) ; Geom2dAdaptor_Curve C (mycurve) ;
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~
**3D case :** **3D case :**
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.cpp} ~~~~{.cpp}
Handle(Geom_Curve) mycurve = ... ; Handle(Geom_Curve) mycurve = ... ;
GeomAdaptor_Curve C (mycurve) ; GeomAdaptor_Curve C (mycurve) ;
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~
The algorithm is then constructed with this object: The algorithm is then constructed with this object:
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.cpp} ~~~~{.cpp}
GCPnts_UniformDeflection myAlgo () ; GCPnts_UniformDeflection myAlgo () ;
Standard_Real Deflection = ... ; Standard_Real Deflection = ... ;
myAlgo.Initialize ( C , Deflection ) ; myAlgo.Initialize ( C , Deflection ) ;
@ -390,7 +390,7 @@ The algorithm is then constructed with this object:
... ...
} }
} }
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~
@subsection occt_modat_1_5 Extrema @subsection occt_modat_1_5 Extrema
@ -771,7 +771,7 @@ There are no constructors for the classes inheriting from the *TopoDS_Shape* cla
The following example shows a routine receiving an argument of the *TopoDS_Shape* type, then putting it into a variable V if it is a vertex or calling the method ProcessEdge if it is an edge. The following example shows a routine receiving an argument of the *TopoDS_Shape* type, then putting it into a variable V if it is a vertex or calling the method ProcessEdge if it is an edge.
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.cpp} ~~~~{.cpp}
#include <TopoDS_Vertex.hxx> #include <TopoDS_Vertex.hxx>
#include <TopoDS_Edge.hxx> #include <TopoDS_Edge.hxx>
#include <TopoDS_Shape.hxx> #include <TopoDS_Shape.hxx>
@ -796,7 +796,7 @@ The following example shows a routine receiving an argument of the *TopoDS_Shape
// OK for compiler but an exception will be raised at run-time // OK for compiler but an exception will be raised at run-time
} }
} }
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~
@ -814,7 +814,7 @@ The TopExp package provides the class *TopExp_Explorer* to find all sub-objects
The Explorer visits the whole structure in order to find the shapes of the requested type not contained in the type to avoid. The example below shows how to find all faces in the shape *S*: The Explorer visits the whole structure in order to find the shapes of the requested type not contained in the type to avoid. The example below shows how to find all faces in the shape *S*:
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.cpp} ~~~~{.cpp}
void test() { void test() {
TopoDS_Shape S; TopoDS_Shape S;
TopExp_Explorer Ex; TopExp_Explorer Ex;
@ -822,19 +822,19 @@ The Explorer visits the whole structure in order to find the shapes of the reque
ProcessFace(Ex.Current()); ProcessFace(Ex.Current());
} }
} }
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~
Find all the vertices which are not in an edge Find all the vertices which are not in an edge
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.cpp} ~~~~{.cpp}
for (Ex.Init(S,TopAbs_VERTEX,TopAbs_EDGE); ...) for (Ex.Init(S,TopAbs_VERTEX,TopAbs_EDGE); ...)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~
Find all the faces in a SHELL, then all the faces not in a SHELL: Find all the faces in a SHELL, then all the faces not in a SHELL:
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.cpp} ~~~~{.cpp}
void test() { void test() {
TopExp_Explorer Ex1, Ex2; TopExp_Explorer Ex1, Ex2;
TopoDS_Shape S; TopoDS_Shape S;
@ -852,14 +852,14 @@ Find all the faces in a SHELL, then all the faces not in a SHELL:
ProcessFace(Ex1.Current()); ProcessFace(Ex1.Current());
} }
} }
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~
The Explorer presumes that objects contain only objects of an equal or inferior type. For example, if searching for faces it does not look at wires, edges, or vertices to see if they contain faces. The Explorer presumes that objects contain only objects of an equal or inferior type. For example, if searching for faces it does not look at wires, edges, or vertices to see if they contain faces.
The *MapShapes* method from *TopExp* package allows filling a Map. An exploration using the Explorer class can visit an object more than once if it is referenced more than once. For example, an edge of a solid is generally referenced by two faces. To process objects only once, they have to be placed in a Map. The *MapShapes* method from *TopExp* package allows filling a Map. An exploration using the Explorer class can visit an object more than once if it is referenced more than once. For example, an edge of a solid is generally referenced by two faces. To process objects only once, they have to be placed in a Map.
**Example** **Example**
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.cpp} ~~~~{.cpp}
void TopExp::MapShapes (const TopoDS_Shape& S, void TopExp::MapShapes (const TopoDS_Shape& S,
const TopAbs_ShapeEnum T, const TopAbs_ShapeEnum T,
TopTools_IndexedMapOfShape& M) TopTools_IndexedMapOfShape& M)
@ -870,7 +870,7 @@ The *MapShapes* method from *TopExp* package allows filling a Map. An exploratio
Ex.Next(); Ex.Next();
} }
} }
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~
In the following example all faces and all edges of an object are drawn in accordance with the following rules: In the following example all faces and all edges of an object are drawn in accordance with the following rules:
- The faces are represented by a network of *NbIso* iso-parametric lines with *FaceIsoColor* color. - The faces are represented by a network of *NbIso* iso-parametric lines with *FaceIsoColor* color.
@ -886,7 +886,7 @@ The following steps are performed:
3. Exploring the edges and for each of them increment the counter of faces in the array. 3. Exploring the edges and for each of them increment the counter of faces in the array.
4. From the Map of edges, drawing each edge with the color corresponding to the number of faces. 4. From the Map of edges, drawing each edge with the color corresponding to the number of faces.
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.cpp} ~~~~{.cpp}
void DrawShape ( const TopoDS_Shape& aShape, void DrawShape ( const TopoDS_Shape& aShape,
const Standard_Integer nbIsos, const Standard_Integer nbIsos,
const Color FaceIsocolor, const Color FaceIsocolor,
@ -930,7 +930,7 @@ The following steps are performed:
} }
} }
} }
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~
@subsubsection occt_modat_5_5 Lists and Maps of Shapes @subsubsection occt_modat_5_5 Lists and Maps of Shapes
@ -946,7 +946,7 @@ With a *TopTools_Map*, a set of references to Shapes can be kept without duplica
The following example counts the size of a data structure as a number of *TShapes*. The following example counts the size of a data structure as a number of *TShapes*.
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.cpp} ~~~~{.cpp}
#include <TopoDS_Iterator.hxx> #include <TopoDS_Iterator.hxx>
Standard_Integer Size(const TopoDS_Shape& aShape) Standard_Integer Size(const TopoDS_Shape& aShape)
{ {
@ -959,14 +959,14 @@ The following example counts the size of a data structure as a number of *TShape
} }
return size; return size;
} }
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~
This program is incorrect if there is sharing in the data structure. This program is incorrect if there is sharing in the data structure.
Thus for a contour of four edges it should count 1 wire + 4 edges +4 vertices with the result 9, but as the vertices are each shared by two edges this program will return 13. One solution is to put all the Shapes in a Map so as to avoid counting them twice, as in the following example: Thus for a contour of four edges it should count 1 wire + 4 edges +4 vertices with the result 9, but as the vertices are each shared by two edges this program will return 13. One solution is to put all the Shapes in a Map so as to avoid counting them twice, as in the following example:
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.cpp} ~~~~{.cpp}
#include <TopoDS_Iterator.hxx> #include <TopoDS_Iterator.hxx>
#include <TopTools_MapOfShape.hxx> #include <TopTools_MapOfShape.hxx>
@ -990,7 +990,7 @@ Thus for a contour of four edges it should count 1 wire + 4 edges +4 vertices wi
MapShapes(aShape,M); MapShapes(aShape,M);
return M.Extent(); return M.Extent();
} }
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~
**Note** For more details about Maps, refer to the *TCollection* documentation (Foundation Classes Reference Manual). **Note** For more details about Maps, refer to the *TCollection* documentation (Foundation Classes Reference Manual).
@ -999,7 +999,7 @@ The following example is more ambitious and writes a program which copies a data
- A table of Shapes is created in parallel with the map to receive the copies. - A table of Shapes is created in parallel with the map to receive the copies.
- The structure is copied using the auxiliary recursive function,which copies from the map to the array. - The structure is copied using the auxiliary recursive function,which copies from the map to the array.
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.cpp} ~~~~{.cpp}
#include <TopoDS_Shape.hxx> #include <TopoDS_Shape.hxx>
#include <TopoDS_Iterator.hxx> #include <TopoDS_Iterator.hxx>
#include <TopTools_IndexedMapOfShape.hxx> #include <TopTools_IndexedMapOfShape.hxx>
@ -1029,7 +1029,7 @@ The following example is more ambitious and writes a program which copies a data
} }
} }
} }
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~
In the above example, the index *i* is that of the first object not treated in the Map. When *i* reaches the same size as the Map this means that everything has been treated. The treatment consists in inserting in the Map all the sub-objects, if they are not yet in the Map, they are inserted with an index greater than *i*. In the above example, the index *i* is that of the first object not treated in the Map. When *i* reaches the same size as the Map this means that everything has been treated. The treatment consists in inserting in the Map all the sub-objects, if they are not yet in the Map, they are inserted with an index greater than *i*.
@ -1037,7 +1037,7 @@ In the above example, the index *i* is that of the first object not treated in t
**Note** that the objects are inserted with a local reference set to the identity and a FORWARD orientation. Only the underlying TShape is of great interest. **Note** that the objects are inserted with a local reference set to the identity and a FORWARD orientation. Only the underlying TShape is of great interest.
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.cpp} ~~~~{.cpp}
//Create an array to store the copies. //Create an array to store the copies.
TopTools_Array1OfShapetheCopies(1,theMap.Extent()); TopTools_Array1OfShapetheCopies(1,theMap.Extent());
@ -1054,12 +1054,12 @@ In the above example, the index *i* is that of the first object not treated in t
S.Location(aShape.Location()); S.Location(aShape.Location());
S.Orientation(aShape.Orientation()); S.Orientation(aShape.Orientation());
return S; return S;
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~
Below is the auxiliary function, which copies the element of rank *i* from the map to the table. This method checks if the object has been copied; if not copied, then an empty copy is performed into the table and the copies of all the sub-elements are inserted by finding their rank in the map. Below is the auxiliary function, which copies the element of rank *i* from the map to the table. This method checks if the object has been copied; if not copied, then an empty copy is performed into the table and the copies of all the sub-elements are inserted by finding their rank in the map.
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.cpp} ~~~~{.cpp}
void AuxiliaryCopy(Standard_Integer index, void AuxiliaryCopy(Standard_Integer index,
const TopTools_IndexedMapOfShapes& sources, const TopTools_IndexedMapOfShapes& sources,
TopTools_Array1OfShape& copies, TopTools_Array1OfShape& copies,
@ -1081,7 +1081,7 @@ Below is the auxiliary function, which copies the element of rank *i* from the m
} }
} }
} }
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~
**Wire Explorer** **Wire Explorer**
@ -1093,7 +1093,7 @@ For example, in the wire in the image we want to recuperate the edges in the ord
*TopExp_Explorer*, however, recuperates the lines in any order. *TopExp_Explorer*, however, recuperates the lines in any order.
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.cpp} ~~~~{.cpp}
TopoDS_Wire W = ...; TopoDS_Wire W = ...;
BRepTools_WireExplorer Ex; BRepTools_WireExplorer Ex;
for(Ex.Init(W); Ex.More(); Ex.Next()) { for(Ex.Init(W); Ex.More(); Ex.Next()) {
@ -1101,7 +1101,7 @@ For example, in the wire in the image we want to recuperate the edges in the ord
ProcessTheVertexConnectingTheCurrentEdgeToThePrevious ProcessTheVertexConnectingTheCurrentEdgeToThePrevious
One(Ex.CurrentVertex()); One(Ex.CurrentVertex());
} }
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~
@section occt_modat_4 Properties of Shapes @section occt_modat_4 Properties of Shapes

420
dox/user_guides/ocaf/ocaf.md
View File

File diff suppressed because it is too large Load Diff

256
dox/user_guides/shape_healing/shape_healing.md
View File

@ -65,10 +65,10 @@ The status may contain a set of Boolean flags (internally represented by bits).
It is possible to test the status for the presence of some flag(s), using Status...() method(s) provided by the class: It is possible to test the status for the presence of some flag(s), using Status...() method(s) provided by the class:
~~~~~ ~~~~{.cpp}
if ( object.Status.. ( ShapeExtend_DONE ) ) {// something was done if ( object.Status.. ( ShapeExtend_DONE ) ) {// something was done
} }
~~~~~ ~~~~
8 'DONE' and 8 'FAIL' flags, named ShapeExtend_DONE1 ... ShapeExtend_FAIL8, are defined for a detailed analysis of the encountered situation. Each method assigns its own meaning to each flag, documented in the header for that method. There are also three enumerative values used for testing several flags at a time: 8 'DONE' and 8 'FAIL' flags, named ShapeExtend_DONE1 ... ShapeExtend_FAIL8, are defined for a detailed analysis of the encountered situation. Each method assigns its own meaning to each flag, documented in the header for that method. There are also three enumerative values used for testing several flags at a time:
* *ShapeExtend_OK* -- if no flags have been set; * *ShapeExtend_OK* -- if no flags have been set;
@ -131,32 +131,32 @@ The sequence of actions is as follows :
In some cases using only *ShapeFix_Shape* can be insufficient. It is possible to use tools for merging and removing small edges and fixing gaps between 2D and 3D curves. In some cases using only *ShapeFix_Shape* can be insufficient. It is possible to use tools for merging and removing small edges and fixing gaps between 2D and 3D curves.
5. Create *ShapeFix_Wireframe* tool and initialize it by shape: 5. Create *ShapeFix_Wireframe* tool and initialize it by shape:
~~~~~ ~~~~{.cpp}
Handle(ShapeFix_Wirefarme) SFWF = new ShapeFix_Wirefarme(shape); Handle(ShapeFix_Wirefarme) SFWF = new ShapeFix_Wirefarme(shape);
Or Or
Handle(ShapeFix_Wirefarme) SFWF = new ShapeFix_Wirefarme; Handle(ShapeFix_Wirefarme) SFWF = new ShapeFix_Wirefarme;
SFWF->Load(shape); SFWF->Load(shape);
~~~~~ ~~~~
6. Set the basic precision and the maximum allowed tolerance: 6. Set the basic precision and the maximum allowed tolerance:
~~~~~ ~~~~{.cpp}
sfs->SetPrecision ( Prec ); sfs->SetPrecision ( Prec );
sfs->SetMaxTolerance ( maxTol ); sfs->SetMaxTolerance ( maxTol );
~~~~~ ~~~~
See the description for *Prec* and *maxTol* above. See the description for *Prec* and *maxTol* above.
7. Merge and remove small edges: 7. Merge and remove small edges:
~~~~~ ~~~~{.cpp}
SFWF->DropSmallEdgesMode() = Standard_True; SFWF->DropSmallEdgesMode() = Standard_True;
SFWF->FixSmallEdges(); SFWF->FixSmallEdges();
~~~~~ ~~~~
**Note:** Small edges are not removed with the default mode, but in many cases removing small edges is very useful for fixing a shape. **Note:** Small edges are not removed with the default mode, but in many cases removing small edges is very useful for fixing a shape.
8. Fix gaps for 2D and 3D curves 8. Fix gaps for 2D and 3D curves
~~~~~ ~~~~{.cpp}
SFWF->FixWireGaps(); SFWF->FixWireGaps();
~~~~~ ~~~~
9. Get the result 9. Get the result
~~~~~ ~~~~{.cpp}
TopoDS_Shape Result = SFWF->Shape(); TopoDS_Shape Result = SFWF->Shape();
~~~~~ ~~~~
@subsection occt_shg_2_2 Shape Correction. @subsection occt_shg_2_2 Shape Correction.
@ -175,7 +175,7 @@ If you want to make a fix on one sub-shape of a certain shape it is possible to
For example, in the following way it is possible to fix face *Face1* of shape *Shape1*: For example, in the following way it is possible to fix face *Face1* of shape *Shape1*:
~~~~~ ~~~~{.cpp}
//create tools for fixing a face //create tools for fixing a face
Handle(ShapeFix_Face) SFF= new ShapeFix_Face; Handle(ShapeFix_Face) SFF= new ShapeFix_Face;
@ -195,7 +195,7 @@ SFF->Perform();
//get the result //get the result
TopoDS_Shape NewShape = Context->Apply(Shape1); TopoDS_Shape NewShape = Context->Apply(Shape1);
//Resulting shape contains the fixed face. //Resulting shape contains the fixed face.
~~~~~ ~~~~
A set of required fixes and invalid sub-shapes can be obtained with the help of tools responsible for the analysis of shape validity (section 3.2). A set of required fixes and invalid sub-shapes can be obtained with the help of tools responsible for the analysis of shape validity (section 3.2).
@ -219,14 +219,14 @@ The following sequence of actions should be applied to perform fixes:
6. Get the result in two ways : 6. Get the result in two ways :
- with help of a special method *Shape(),Face(),Wire().Edge()*. - with help of a special method *Shape(),Face(),Wire().Edge()*.
- from the rebuilding tool by method *Apply* (for access to rebuilding tool use method *Context()*): - from the rebuilding tool by method *Apply* (for access to rebuilding tool use method *Context()*):
~~~~~ ~~~~{.cpp}
TopoDS_Shape resultShape = fixtool->Context()->Apply(initialShape); TopoDS_Shape resultShape = fixtool->Context()->Apply(initialShape);
~~~~~ ~~~~
Modification fistory for the shape and its sub-shapes can be obtained from the tool for shape re-building (*ShapeBuild_ReShape*). Modification fistory for the shape and its sub-shapes can be obtained from the tool for shape re-building (*ShapeBuild_ReShape*).
~~~~~ ~~~~{.cpp}
TopoDS_Shape modifsubshape = fixtool->Context() -> Apply(initsubshape); TopoDS_Shape modifsubshape = fixtool->Context() -> Apply(initsubshape);
~~~~~ ~~~~
@subsubsection occt_shg_2_3_2 Flags Management @subsubsection occt_shg_2_3_2 Flags Management
@ -235,12 +235,12 @@ The flags *Fix...Mode()* are used to control the execution of fixing procedures
For example, it is possible to forbid performing fixes to remove small edges - *FixSmall* For example, it is possible to forbid performing fixes to remove small edges - *FixSmall*
~~~~~ ~~~~{.cpp}
Handle(ShapeFix_Shape) Sfs = new ShapeFix_Shape(shape); Handle(ShapeFix_Shape) Sfs = new ShapeFix_Shape(shape);
Sfs-> FixWireTool ()->FixSmallMode () =0; Sfs-> FixWireTool ()->FixSmallMode () =0;
if(Sfs->Perform()) if(Sfs->Perform())
TopoDS_Shape resShape = Sfs->Shape(); TopoDS_Shape resShape = Sfs->Shape();
~~~~~ ~~~~
@subsubsection occt_shg_2_3_3 Repairing tool for shapes @subsubsection occt_shg_2_3_3 Repairing tool for shapes
@ -249,7 +249,7 @@ Class *ShapeFix_Shape* allows using repairing tools for all sub-shapes of a shap
For example, it is possible to force the removal of invalid 2D curves from a face. For example, it is possible to force the removal of invalid 2D curves from a face.
~~~~~ ~~~~{.cpp}
TopoDS_Face face … // face with invalid 2D curves. TopoDS_Face face … // face with invalid 2D curves.
//creation of tool and its initialization by shape. //creation of tool and its initialization by shape.
Handle(ShapeFix_Shape) sfs = new ShapeFix_Shape(face); Handle(ShapeFix_Shape) sfs = new ShapeFix_Shape(face);
@ -271,7 +271,7 @@ cout<< "Shape could not be fixed" << endl;
else if(sfs->Status(ShapeExtent_OK)) { else if(sfs->Status(ShapeExtent_OK)) {
cout<< "Initial face is valid with specified precision ="<< precendl; cout<< "Initial face is valid with specified precision ="<< precendl;
} }
~~~~~ ~~~~
@subsubsection occt_shg_2_3_4 Repairing tool for solids @subsubsection occt_shg_2_3_4 Repairing tool for solids
@ -302,7 +302,7 @@ This tool has the following control flags:
* *FixMissingSeamMode* -- mode to fix a missing seam, True by default. If True, tries to insert a seam. * *FixMissingSeamMode* -- mode to fix a missing seam, True by default. If True, tries to insert a seam.
* *FixSmallAreaWireMode* -- mode to fix a small-area wire, False by default. If True, drops wires bounding small areas. * *FixSmallAreaWireMode* -- mode to fix a small-area wire, False by default. If True, drops wires bounding small areas.
~~~~~ ~~~~{.cpp}
TopoDS_Face face = ...; TopoDS_Face face = ...;
TopoDS_Wire wire = ...; TopoDS_Wire wire = ...;
@ -319,7 +319,7 @@ sff.FixOrientation();
//Get the resulting face //Get the resulting face
TopoDS_Face newface = sff.Face(); TopoDS_Face newface = sff.Face();
~~~~~ ~~~~
@subsubsection occt_shg_2_3_7 Repairing tool for wires @subsubsection occt_shg_2_3_7 Repairing tool for wires
@ -413,7 +413,7 @@ Boolean flag *FixGapsByRanges* is used to activate an additional mode applied be
Let us create a custom set of fixes as an example. Let us create a custom set of fixes as an example.
~~~~~ ~~~~{.cpp}
TopoDS_Face face = ...; TopoDS_Face face = ...;
TopoDS_Wire wire = ...; TopoDS_Wire wire = ...;
Standard_Real precision = 1e-04; Standard_Real precision = 1e-04;
@ -437,7 +437,7 @@ Standard_Boolean LockVertex = Standard_True;
} }
TopoDS_Wire newwire = sfw.Wire(); TopoDS_Wire newwire = sfw.Wire();
//Returns the corrected wire //Returns the corrected wire
~~~~~ ~~~~
#### Example: Correction of a wire #### Example: Correction of a wire
@ -451,7 +451,7 @@ It is necessary to apply the @ref occt_shg_3_1_2 "tools for the analysis of wire
* there are no intersecting adjacent edges; * there are no intersecting adjacent edges;
and then immediately apply fixing tools. and then immediately apply fixing tools.
~~~~~ ~~~~{.cpp}
TopoDS_Face face = ...; TopoDS_Face face = ...;
TopoDS_Wire wire = ...; TopoDS_Wire wire = ...;
Standard_Real precision = 1e-04; Standard_Real precision = 1e-04;
@ -483,7 +483,7 @@ adjacent edges”<<endl;
// The edges are cut at the intersection point so that they no longer intersect. // The edges are cut at the intersection point so that they no longer intersect.
} }
} }
~~~~~ ~~~~
As the result all failures have been fixed. As the result all failures have been fixed.
@ -504,7 +504,7 @@ To see how this tool works, it is possible to take an edge, where the maximum de
First it is necessary to apply the @ref occt_shg_3_1_3 "tool for checking the edge validity" to find that the maximum deviation between pcurve and 3D curve is greater than tolerance. Then we can use the repairing tool to increase the tolerance and make the deviation acceptable. First it is necessary to apply the @ref occt_shg_3_1_3 "tool for checking the edge validity" to find that the maximum deviation between pcurve and 3D curve is greater than tolerance. Then we can use the repairing tool to increase the tolerance and make the deviation acceptable.
~~~~~ ~~~~{.cpp}
ShapeAnalysis_Edge sae; ShapeAnalysis_Edge sae;
TopoDS_Face face = ...; TopoDS_Face face = ...;
TopoDS_Wire wire = ...; TopoDS_Wire wire = ...;
@ -518,7 +518,7 @@ if (sae.CheckSameParameter (edge, maxdev)) {
sfe.FixSameParameter(); sfe.FixSameParameter();
cout<<“New tolerance “<<BRep_Tool::Tolerance(edge)<<endl; cout<<“New tolerance “<<BRep_Tool::Tolerance(edge)<<endl;
} }
~~~~~ ~~~~
@figure{/user_guides/shape_healing/images/shape_healing_image012.png,"Resulting shape",420} @figure{/user_guides/shape_healing/images/shape_healing_image012.png,"Resulting shape",420}
@ -539,7 +539,7 @@ To perform fixes it is necessary to:
* set the working precision problems will be detected with and the maximum allowed tolerance * set the working precision problems will be detected with and the maximum allowed tolerance
* perform fixes * perform fixes
~~~~~ ~~~~{.cpp}
//creation of a tool //creation of a tool
Handle(ShapeFix_Wireframe) sfwf = new ShapeFix_Wireframe(shape); Handle(ShapeFix_Wireframe) sfwf = new ShapeFix_Wireframe(shape);
//sets the working precision problems will be detected with and the maximum allowed tolerance //sets the working precision problems will be detected with and the maximum allowed tolerance
@ -555,7 +555,7 @@ sfwf->SetLimliteAngle(angle);
sfwf->FixSmallEdges(); sfwf->FixSmallEdges();
//getting the result //getting the result
TopoDS_Shape resShape = sfwf->Shape(); TopoDS_Shape resShape = sfwf->Shape();
~~~~~ ~~~~
It is desirable that a shape is topologically correct before applying the methods of this class. It is desirable that a shape is topologically correct before applying the methods of this class.
@ -567,7 +567,7 @@ Class ShapeFix_FixSmallFaceThis tool is intended for dropping small faces from t
The sequence of actions for performing the fix is the same as for the fixes described above: The sequence of actions for performing the fix is the same as for the fixes described above:
~~~~~ ~~~~{.cpp}
//creation of a tool //creation of a tool
Handle(ShapeFix_FixSmallFace) sff = new ShapeFix_FixSmallFace(shape); Handle(ShapeFix_FixSmallFace) sff = new ShapeFix_FixSmallFace(shape);
//setting of tolerances //setting of tolerances
@ -577,7 +577,7 @@ sff->SetMaxTolerance(maxTol);
sff.Perform(); sff.Perform();
//getting the result //getting the result
TopoDS_Shape resShape = sff.FixShape(); TopoDS_Shape resShape = sff.FixShape();
~~~~~ ~~~~
@subsubsection occt_shg_2_3_11 Tool to modify tolerances of shapes (Class ShapeFix_ShapeTolerance). @subsubsection occt_shg_2_3_11 Tool to modify tolerances of shapes (Class ShapeFix_ShapeTolerance).
@ -589,7 +589,7 @@ You set the tolerance functionality as follows:
* set a tolerance for sub-shapes, by method SetTolerance, * set a tolerance for sub-shapes, by method SetTolerance,
* limit tolerances with given ranges, by method LimitTolerance. * limit tolerances with given ranges, by method LimitTolerance.
~~~~~ ~~~~{.cpp}
//creation of a tool //creation of a tool
ShapeFix_ShapeTolerance Sft; ShapeFix_ShapeTolerance Sft;
//setting a specified tolerance on shape and all of its sub-shapes. //setting a specified tolerance on shape and all of its sub-shapes.
@ -598,7 +598,7 @@ Sft.SetTolerance(shape,toler);
Sft.SetTolerance(shape,toler,TopAbs_VERTEX); Sft.SetTolerance(shape,toler,TopAbs_VERTEX);
//limiting the tolerance on the shape and its sub-shapes between minimum and maximum tolerances //limiting the tolerance on the shape and its sub-shapes between minimum and maximum tolerances
Sft.LimitTolerance(shape,tolermin,tolermax); Sft.LimitTolerance(shape,tolermin,tolermax);
~~~~~ ~~~~
@section occt_shg_3 Analysis @section occt_shg_3 Analysis
@ -614,7 +614,7 @@ However, if you want, these tools can be used for detecting some of shape proble
* initialize it by shape and set a tolerance problems will be detected with if it is necessary. * initialize it by shape and set a tolerance problems will be detected with if it is necessary.
* check the problem that interests you. * check the problem that interests you.
~~~~~ ~~~~{.cpp}
TopoDS_Face face = ...; TopoDS_Face face = ...;
ShapeAnalysis_Edge sae; ShapeAnalysis_Edge sae;
//Creates a tool for analyzing an edge //Creates a tool for analyzing an edge
@ -623,18 +623,18 @@ for(TopExp_Explorer Exp(face,TopAbs_EDGE);Exp.More();Exp.Next()) {
if (!sae.HasCurve3d (edge)) { if (!sae.HasCurve3d (edge)) {
cout <<"Edge has no 3D curve"<< endl; } cout <<"Edge has no 3D curve"<< endl; }
} }
~~~~~ ~~~~
@subsubsection occt_shg_3_1_1 Analysis of orientation of wires on a face. @subsubsection occt_shg_3_1_1 Analysis of orientation of wires on a face.
It is possible to check whether a face has an outer boundary with the help of method *ShapeAnalysis::IsOuterBound*. It is possible to check whether a face has an outer boundary with the help of method *ShapeAnalysis::IsOuterBound*.
~~~~~ ~~~~{.cpp}
TopoDS_Face face … //analyzed face TopoDS_Face face … //analyzed face
if(!ShapeAnalysis::IsOuterBound(face)) { if(!ShapeAnalysis::IsOuterBound(face)) {
cout<<"Face has not outer boundary"<<endl; cout<<"Face has not outer boundary"<<endl;
} }
~~~~~ ~~~~
@subsubsection occt_shg_3_1_2 Analysis of wire validity @subsubsection occt_shg_3_1_2 Analysis of wire validity
@ -665,7 +665,7 @@ Some methods in this class are:
This class maintains status management. Each API method stores the status of its last execution which can be queried by the corresponding *Status..()* method. In addition, each API method returns a Boolean value, which is True when a case being analyzed is detected (with the set *ShapeExtend_DONE* status), otherwise it is False. This class maintains status management. Each API method stores the status of its last execution which can be queried by the corresponding *Status..()* method. In addition, each API method returns a Boolean value, which is True when a case being analyzed is detected (with the set *ShapeExtend_DONE* status), otherwise it is False.
~~~~~ ~~~~{.cpp}
TopoDS_Face face = ...; TopoDS_Face face = ...;
TopoDS_Wire wire = ...; TopoDS_Wire wire = ...;
Standard_Real precision = 1e-04; Standard_Real precision = 1e-04;
@ -685,7 +685,7 @@ if (saw.CheckConnected()) {
if (saw.CheckSelfIntersection()) { if (saw.CheckSelfIntersection()) {
cout<<"Wire has self-intersecting or intersecting adjacent edges"<< endl; cout<<"Wire has self-intersecting or intersecting adjacent edges"<< endl;
} }
~~~~~ ~~~~
@subsubsection occt_shg_3_1_3 Analysis of edge validity @subsubsection occt_shg_3_1_3 Analysis of edge validity
@ -699,7 +699,7 @@ Class *ShapeAnalysis_Edge* is intended to analyze edges. It provides the followi
This class supports status management described above. This class supports status management described above.
~~~~~ ~~~~{.cpp}
TopoDS_Face face = ...; TopoDS_Face face = ...;
ShapeAnalysis_Edge sae; ShapeAnalysis_Edge sae;
//Creates a tool for analyzing an edge //Creates a tool for analyzing an edge
@ -727,7 +727,7 @@ if(sae.CheckOverlapping(edge1,edge2,prec,dist)) {
cout<<"Edges are overlapped with tolerance = "<<prec<<endl; cout<<"Edges are overlapped with tolerance = "<<prec<<endl;
cout<<"Domain of overlapping ="<<dist<<endl; cout<<"Domain of overlapping ="<<dist<<endl;
} }
~~~~~ ~~~~
@subsubsection occt_shg_3_1_4 Analysis of presence of small faces @subsubsection occt_shg_3_1_4 Analysis of presence of small faces
@ -735,7 +735,7 @@ Class *ShapeAnalysis_CheckSmallFace* class is intended for analyzing small faces
* *CheckSpotFace()* checks if the size of the face is less than the given precision; * *CheckSpotFace()* checks if the size of the face is less than the given precision;
* *CheckStripFace* checks if the size of the face in one dimension is less than the given precision. * *CheckStripFace* checks if the size of the face in one dimension is less than the given precision.
~~~~~ ~~~~{.cpp}
TopoDS_Shape shape … // checked shape TopoDS_Shape shape … // checked shape
//Creation of a tool //Creation of a tool
ShapeAnalysis_CheckSmallFace saf; ShapeAnalysis_CheckSmallFace saf;
@ -750,13 +750,13 @@ NumSmallfaces++;
} }
if(numSmallfaces) if(numSmallfaces)
cout<<"Number of small faces in the shape ="<< numSmallfaces <<endl; cout<<"Number of small faces in the shape ="<< numSmallfaces <<endl;
~~~~~ ~~~~
@subsubsection occt_shg_3_1_5 Analysis of shell validity and closure @subsubsection occt_shg_3_1_5 Analysis of shell validity and closure
Class *ShapeAnalysis_Shell* allows checking the orientation of edges in a manifold shell. With the help of this tool, free edges (edges entered into one face) and bad edges (edges entered into the shell twice with the same orientation) can be found. By occurrence of bad and free edges a conclusion about the shell validity and the closure of the shell can be made. Class *ShapeAnalysis_Shell* allows checking the orientation of edges in a manifold shell. With the help of this tool, free edges (edges entered into one face) and bad edges (edges entered into the shell twice with the same orientation) can be found. By occurrence of bad and free edges a conclusion about the shell validity and the closure of the shell can be made.
~~~~~ ~~~~{.cpp}
TopoDS_Shell shell // checked shape TopoDS_Shell shell // checked shape
ShapeAnalysis_Shell sas(shell); ShapeAnalysis_Shell sas(shell);
//analysis of the shell , second parameter is set to True for //getting free edges,(default False) //analysis of the shell , second parameter is set to True for //getting free edges,(default False)
@ -770,7 +770,7 @@ if(sas.HasFreeEdges()) {
cout<<"Shell is open"<<endl; cout<<"Shell is open"<<endl;
TopoDS_Compound freeEdges = sas.FreeEdges(); TopoDS_Compound freeEdges = sas.FreeEdges();
} }
~~~~~ ~~~~
@subsection occt_shg_3_2 Analysis of shape properties. @subsection occt_shg_3_2 Analysis of shape properties.
@subsubsection occt_shg_3_2_1 Analysis of tolerance on shape @subsubsection occt_shg_3_2_1 Analysis of tolerance on shape
@ -783,7 +783,7 @@ The analysis of tolerance functionality is the following:
* finding sub-shapes with tolerances exceeding the given value, * finding sub-shapes with tolerances exceeding the given value,
* finding sub-shapes with tolerances in the given range. * finding sub-shapes with tolerances in the given range.
~~~~~ ~~~~{.cpp}
TopoDS_Shape shape = ...; TopoDS_Shape shape = ...;
ShapeAnalysis_ShapeTolerance sast; ShapeAnalysis_ShapeTolerance sast;
Standard_Real AverageOnShape = sast.Tolerance (shape, 0); Standard_Real AverageOnShape = sast.Tolerance (shape, 0);
@ -796,29 +796,29 @@ Standard_Real MaxAllowed = 0.1;
if (MaxOnVertex > MaxAllowed) { if (MaxOnVertex > MaxAllowed) {
cout<<"Maximum tolerance of the vertices exceeds maximum allowed"<<endl; cout<<"Maximum tolerance of the vertices exceeds maximum allowed"<<endl;
} }
~~~~~ ~~~~
@subsubsection occt_shg_3_2_2 Analysis of free boundaries. @subsubsection occt_shg_3_2_2 Analysis of free boundaries.
Class ShapeAnalysis_FreeBounds is intended to analyze and output the free bounds of a shape. Free bounds are wires consisting of edges referenced only once by only one face in the shape. Class ShapeAnalysis_FreeBounds is intended to analyze and output the free bounds of a shape. Free bounds are wires consisting of edges referenced only once by only one face in the shape.
This class works on two distinct types of shapes when analyzing their free bounds: This class works on two distinct types of shapes when analyzing their free bounds:
* Analysis of possible free bounds taking the specified tolerance into account. This analysis can be applied to a compound of faces. The analyzer of the sewing algorithm (*BRepAlgo_Sewing*) is used to forecast what free bounds would be obtained after the sewing of these faces is performed. The following method should be used for this analysis: * Analysis of possible free bounds taking the specified tolerance into account. This analysis can be applied to a compound of faces. The analyzer of the sewing algorithm (*BRepAlgo_Sewing*) is used to forecast what free bounds would be obtained after the sewing of these faces is performed. The following method should be used for this analysis:
~~~~~ ~~~~{.cpp}
ShapeAnalysis_FreeBounds safb(shape,toler); ShapeAnalysis_FreeBounds safb(shape,toler);
~~~~~ ~~~~
* Analysis of already existing free bounds. Actual free bounds (edges shared by the only face in the shell) are output in this case. *ShapeAnalysis_Shell* is used for that. * Analysis of already existing free bounds. Actual free bounds (edges shared by the only face in the shell) are output in this case. *ShapeAnalysis_Shell* is used for that.
~~~~~ ~~~~{.cpp}
ShapeAnalysis_FreeBounds safb(shape); ShapeAnalysis_FreeBounds safb(shape);
~~~~~ ~~~~
When connecting edges into wires this algorithm tries to build wires of maximum length. Two options are provided for the user to extract closed sub-contours out of closed and/or open contours. Free bounds are returned as two compounds, one for closed and one for open wires. To obtain a result it is necessary to use methods: When connecting edges into wires this algorithm tries to build wires of maximum length. Two options are provided for the user to extract closed sub-contours out of closed and/or open contours. Free bounds are returned as two compounds, one for closed and one for open wires. To obtain a result it is necessary to use methods:
~~~~~ ~~~~{.cpp}
TopoDS_Compound ClosedWires = safb.GetClosedWires(); TopoDS_Compound ClosedWires = safb.GetClosedWires();
TopoDS_Compound OpenWires = safb.GetOpenWires(); TopoDS_Compound OpenWires = safb.GetOpenWires();
~~~~~ ~~~~
This class also provides some static methods for advanced use: connecting edges/wires to wires, extracting closed sub-wires from wires, distributing wires into compounds for closed and open wires. This class also provides some static methods for advanced use: connecting edges/wires to wires, extracting closed sub-wires from wires, distributing wires into compounds for closed and open wires.
~~~~~ ~~~~{.cpp}
TopoDS_Shape shape = ...; TopoDS_Shape shape = ...;
Standard_Real SewTolerance = 1.e-03; Standard_Real SewTolerance = 1.e-03;
//Tolerance for sewing //Tolerance for sewing
@ -834,7 +834,7 @@ TopoDS_Compound ClosedWires = safb.GetClosedWires();
//Returns a compound of closed free bounds //Returns a compound of closed free bounds
TopoDS_Compound OpenWires = safb.GetClosedWires(); TopoDS_Compound OpenWires = safb.GetClosedWires();
//Returns a compound of open free bounds //Returns a compound of open free bounds
~~~~~ ~~~~
@subsubsection occt_shg_3_2_3 Analysis of shape contents @subsubsection occt_shg_3_2_3 Analysis of shape contents
@ -866,7 +866,7 @@ The corresponding flags should be set to True for storing a shape by a specified
Let us, for example, select faces based on offset surfaces. Let us, for example, select faces based on offset surfaces.
~~~~~ ~~~~{.cpp}
ShapeAnalysis_ShapeContents safc; ShapeAnalysis_ShapeContents safc;
//set a corresponding flag for storing faces based on the offset surfaces //set a corresponding flag for storing faces based on the offset surfaces
safc.ModifyOffsetSurfaceMode() = Standard_True; safc.ModifyOffsetSurfaceMode() = Standard_True;
@ -875,7 +875,7 @@ safc.Perform(shape);
Standard_Integer NbOffsetSurfaces = safc.NbOffsetSurf(); Standard_Integer NbOffsetSurfaces = safc.NbOffsetSurf();
//getting the sequence of faces based on offset surfaces. //getting the sequence of faces based on offset surfaces.
Handle(TopTools_HSequenceOfShape) seqFaces = safc.OffsetSurfaceSec(); Handle(TopTools_HSequenceOfShape) seqFaces = safc.OffsetSurfaceSec();
~~~~~ ~~~~
@section occt_shg_4 Upgrading @section occt_shg_4 Upgrading
@ -918,7 +918,7 @@ The usual way to use these tools exception for the tool of converting a C0 BSpli
Let us, for example, split all surfaces and all 3D and 2D curves having a continuity of less the C2. Let us, for example, split all surfaces and all 3D and 2D curves having a continuity of less the C2.
~~~~~ ~~~~{.cpp}
//create a tool and initializes it by shape. //create a tool and initializes it by shape.
ShapeUpgrade_ShapeDivideContinuity ShapeDivedeCont(initShape); ShapeUpgrade_ShapeDivideContinuity ShapeDivedeCont(initShape);
@ -942,7 +942,7 @@ if(ShapeDivideCont.Status(ShapeExtend_DONE)
for(TopExp_Explorer aExp(initShape,TopAbs_FACE); aExp.More(0; aExp.Next()) { for(TopExp_Explorer aExp(initShape,TopAbs_FACE); aExp.More(0; aExp.Next()) {
TopoDS_Shape modifShape = ShapeDivideCont.GetContext()-> Apply(aExp.Current()); TopoDS_Shape modifShape = ShapeDivideCont.GetContext()-> Apply(aExp.Current());
} }
~~~~~ ~~~~
@subsubsection occt_shg_4_1_3 Creation of a new tool for splitting a shape. @subsubsection occt_shg_4_1_3 Creation of a new tool for splitting a shape.
To create a new splitting tool it is necessary to create tools for geometry splitting according to a desirable criterion. The new tools should be inherited from basic tools for geometry splitting. Then the new tools should be set into corresponding tools for shape splitting. To create a new splitting tool it is necessary to create tools for geometry splitting according to a desirable criterion. The new tools should be inherited from basic tools for geometry splitting. Then the new tools should be set into corresponding tools for shape splitting.
@ -953,7 +953,7 @@ To change the value of criterion of shape splitting it is necessary to create a
Let us split a shape according to a specified criterion. Let us split a shape according to a specified criterion.
~~~~~ ~~~~{.cpp}
//creation of new tools for geometry splitting by a specified criterion. //creation of new tools for geometry splitting by a specified criterion.
Handle(MyTools_SplitSurfaceTool) MySplitSurfaceTool = new MyTools_SplitSurfaceTool; Handle(MyTools_SplitSurfaceTool) MySplitSurfaceTool = new MyTools_SplitSurfaceTool;
Handle(MyTools_SplitCurve3DTool) MySplitCurve3Dtool = new MyTools_SplitCurve3DTool; Handle(MyTools_SplitCurve3DTool) MySplitCurve3Dtool = new MyTools_SplitCurve3DTool;
@ -987,7 +987,7 @@ TopoDS_Shape splitShape = ShapeDivide.GetResult();
for(TopExp_Explorer aExp(initShape,TopAbs_FACE); aExp.More(0; aExp.Next()) { for(TopExp_Explorer aExp(initShape,TopAbs_FACE); aExp.More(0; aExp.Next()) {
TopoDS_Shape modifShape = ShapeDivide.GetContext()-> Apply(aExp.Current()); TopoDS_Shape modifShape = ShapeDivide.GetContext()-> Apply(aExp.Current());
} }
~~~~~ ~~~~
@subsection occt_shg_4_2 General splitting tools. @subsection occt_shg_4_2 General splitting tools.
@ -1059,7 +1059,7 @@ To create new tools for geometry splitting it is enough to inherit a new tool fr
Header file for the tool for surface splitting by continuity: Header file for the tool for surface splitting by continuity:
~~~~~ ~~~~{.cpp}
class ShapeUpgrade_SplitSurfaceContinuity : public ShapeUpgrade_SplitSurface { class ShapeUpgrade_SplitSurfaceContinuity : public ShapeUpgrade_SplitSurface {
Standard_EXPORT ShapeUpgrade_SplitSurfaceContinuity(); Standard_EXPORT ShapeUpgrade_SplitSurfaceContinuity();
@ -1075,14 +1075,14 @@ GeomAbs_Shape myCriterion;
Standard_Real myTolerance; Standard_Real myTolerance;
Standard_Integer myCont; Standard_Integer myCont;
}; };
~~~~~ ~~~~
@subsection occt_shg_4_3 Specific splitting tools. @subsection occt_shg_4_3 Specific splitting tools.
@subsubsection occt_shg_4_3_1 Conversion of shape geometry to the target continuity @subsubsection occt_shg_4_3_1 Conversion of shape geometry to the target continuity
Class *ShapeUpgrade_ShapeDivideContinuity* allows converting geometry with continuity less than the specified continuity to geometry with target continuity. If converting is not possible than geometrical object is split into several ones, which satisfy the given criteria. A topological object based on this geometry is replaced by several objects based on the new geometry. Class *ShapeUpgrade_ShapeDivideContinuity* allows converting geometry with continuity less than the specified continuity to geometry with target continuity. If converting is not possible than geometrical object is split into several ones, which satisfy the given criteria. A topological object based on this geometry is replaced by several objects based on the new geometry.
~~~~~ ~~~~{.cpp}
ShapeUpgrade_ShapeDivideContinuity sdc (shape); ShapeUpgrade_ShapeDivideContinuity sdc (shape);
sdc.SetTolerance (tol3d); sdc.SetTolerance (tol3d);
sdc.SetTolerance3d (tol2d); // if known, else 1.e-09 is taken sdc.SetTolerance3d (tol2d); // if known, else 1.e-09 is taken
@ -1099,7 +1099,7 @@ if (ctx.IsRecorded (sh)) {
// if there are several results, they are recorded inside a Compound. // if there are several results, they are recorded inside a Compound.
// .. process as needed // .. process as needed
} }
~~~~~ ~~~~
@subsubsection occt_shg_4_3_2 Splitting by angle @subsubsection occt_shg_4_3_2 Splitting by angle
Class *ShapeUpgrade_ShapeDivideAngle* allows splitting all surfaces of revolution, cylindrical, toroidal, conical, spherical surfaces in the given shape so that each resulting segment covers not more than the defined angle (in radians). Class *ShapeUpgrade_ShapeDivideAngle* allows splitting all surfaces of revolution, cylindrical, toroidal, conical, spherical surfaces in the given shape so that each resulting segment covers not more than the defined angle (in radians).
@ -1133,7 +1133,7 @@ This tool provides access to various flags for conversion of different types of
* *GetBSplineMode,* * *GetBSplineMode,*
Let us attempt to produce a conversion of planes to Bezier surfaces. Let us attempt to produce a conversion of planes to Bezier surfaces.
~~~~~ ~~~~{.cpp}
//Creation and initialization of a tool. //Creation and initialization of a tool.
ShapeUpgrade_ShapeConvertToBezier SCB (Shape); ShapeUpgrade_ShapeConvertToBezier SCB (Shape);
//setting tolerances //setting tolerances
@ -1144,13 +1144,13 @@ SCB.SetPlaneMode(Standard_True);
SCB.Perform(); SCB.Perform();
If(SCB.Status(ShapeExtend_DONE) If(SCB.Status(ShapeExtend_DONE)
TopoDS_Shape result = SCB.GetResult(); TopoDS_Shape result = SCB.GetResult();
~~~~~ ~~~~
@subsubsection occt_shg_4_3_4 Tool for splitting closed faces @subsubsection occt_shg_4_3_4 Tool for splitting closed faces
Class *ShapeUpgrade_ShapeDivideClosed* provides splitting of closed faces in the shape to a defined number of components by the U and V parameters. It topologically and (partially) geometrically processes closed faces and performs splitting with the help of class *ShapeUpgrade_ClosedFaceDivide*. Class *ShapeUpgrade_ShapeDivideClosed* provides splitting of closed faces in the shape to a defined number of components by the U and V parameters. It topologically and (partially) geometrically processes closed faces and performs splitting with the help of class *ShapeUpgrade_ClosedFaceDivide*.
~~~~~ ~~~~{.cpp}
TopoDS_Shape aShape = …; TopoDS_Shape aShape = …;
ShapeUpgrade_ShapeDivideClosed tool (aShape ); ShapeUpgrade_ShapeDivideClosed tool (aShape );
Standard_Real closeTol = …; Standard_Real closeTol = …;
@ -1164,7 +1164,7 @@ if ( ! tool.Perform() && tool.Status (ShapeExtend_FAIL) ) {
. . . . . .
} }
TopoDS_Shape aResult = tool.Result(); TopoDS_Shape aResult = tool.Result();
~~~~~ ~~~~
@subsubsection occt_shg_4_3_5 Tool for splitting a C0 BSpline 2D or 3D curve to a sequence C1 BSpline curves @subsubsection occt_shg_4_3_5 Tool for splitting a C0 BSpline 2D or 3D curve to a sequence C1 BSpline curves
@ -1190,7 +1190,7 @@ An example of using this tool is presented in the figures below:
* To produce a splitting use method Perform from the base class. * To produce a splitting use method Perform from the base class.
* The result shape can be obtained with the help the method *Result()*. * The result shape can be obtained with the help the method *Result()*.
~~~~~ ~~~~{.cpp}
ShapeUpgrade_ShapeDivideArea tool (inputShape); ShapeUpgrade_ShapeDivideArea tool (inputShape);
tool.MaxArea() = aMaxArea; tool.MaxArea() = aMaxArea;
tool.Perform(); tool.Perform();
@ -1198,7 +1198,7 @@ if(tool.Status(ShapeExtend_DONE)) {
TopoDS_Shape ResultShape = tool.Result(); TopoDS_Shape ResultShape = tool.Result();
ShapeFix::SameParameter ( ResultShape, Standard_False ); ShapeFix::SameParameter ( ResultShape, Standard_False );
} }
~~~~~ ~~~~
**Note** that the use of method *ShapeFix::SameParameter* is necessary, otherwise the parameter edges obtained as a result of splitting can be different. **Note** that the use of method *ShapeFix::SameParameter* is necessary, otherwise the parameter edges obtained as a result of splitting can be different.
@ -1214,27 +1214,27 @@ Customization tools are intended for adaptation of shape geometry in compliance
To implement the necessary shape modification it is enough to initialize the appropriate tool by the shape and desirable parameters and to get the resulting shape. For example for conversion of indirect surfaces in the shape do the following: To implement the necessary shape modification it is enough to initialize the appropriate tool by the shape and desirable parameters and to get the resulting shape. For example for conversion of indirect surfaces in the shape do the following:
~~~~~ ~~~~{.cpp}
TopoDS_Shape initialShape .. TopoDS_Shape initialShape ..
TopoDS_Shape resultShape = ShapeCustom::DirectFaces(initialShape); TopoDS_Shape resultShape = ShapeCustom::DirectFaces(initialShape);
~~~~~ ~~~~
@subsubsection occt_shg_4_4_1 Conversion of indirect surfaces. @subsubsection occt_shg_4_4_1 Conversion of indirect surfaces.
~~~~~ ~~~~{.cpp}
ShapeCustom::DirectFaces ShapeCustom::DirectFaces
static TopoDS_Shape DirectFaces(const TopoDS_Shape& S); static TopoDS_Shape DirectFaces(const TopoDS_Shape& S);
~~~~~ ~~~~
This method provides conversion of indirect elementary surfaces (elementary surfaces with left-handed coordinate systems) in the shape into direct ones. New 2d curves (recomputed for converted surfaces) are added to the same edges being shared by both the resulting shape and the original shape *S*. This method provides conversion of indirect elementary surfaces (elementary surfaces with left-handed coordinate systems) in the shape into direct ones. New 2d curves (recomputed for converted surfaces) are added to the same edges being shared by both the resulting shape and the original shape *S*.
@subsubsection occt_shg_4_4_2 Shape Scaling @subsubsection occt_shg_4_4_2 Shape Scaling
~~~~~ ~~~~{.cpp}
ShapeCustom::ScaleShape ShapeCustom::ScaleShape
TopoDS_Shape ShapeCustom::ScaleShape(const TopoDS_Shape& S, TopoDS_Shape ShapeCustom::ScaleShape(const TopoDS_Shape& S,
const Standard_Real scale); const Standard_Real scale);
~~~~~ ~~~~
This method returns a new shape, which is a scaled original shape with a coefficient equal to the specified value of scale. It uses the tool *ShapeCustom_TrsfModification*. This method returns a new shape, which is a scaled original shape with a coefficient equal to the specified value of scale. It uses the tool *ShapeCustom_TrsfModification*.
@ -1243,7 +1243,7 @@ This method returns a new shape, which is a scaled original shape with a coeffic
*ShapeCustom_BSplineRestriction* allows approximation of surfaces, curves and 2D curves with a specified degree, maximum number of segments, 2d tolerance and 3d tolerance. If the approximation result cannot be achieved with the specified continuity, the latter can be reduced. *ShapeCustom_BSplineRestriction* allows approximation of surfaces, curves and 2D curves with a specified degree, maximum number of segments, 2d tolerance and 3d tolerance. If the approximation result cannot be achieved with the specified continuity, the latter can be reduced.
The method with all parameters looks as follows: The method with all parameters looks as follows:
~~~~~ ~~~~{.cpp}
ShapeCustom::BsplineRestriction ShapeCustom::BsplineRestriction
TopoDS_Shape ShapeCustom::BSplineRestriction (const TopoDS_Shape& S, TopoDS_Shape ShapeCustom::BSplineRestriction (const TopoDS_Shape& S,
const Standard_Real Tol3d, const Standard_Real Tol2d, const Standard_Real Tol3d, const Standard_Real Tol2d,
@ -1254,7 +1254,7 @@ ShapeCustom::BsplineRestriction
const Standard_Boolean Degree, const Standard_Boolean Degree,
const Standard_Boolean Rational, const Standard_Boolean Rational,
const Handle(ShapeCustom_RestrictionParameters)& aParameters) const Handle(ShapeCustom_RestrictionParameters)& aParameters)
~~~~~ ~~~~
It returns a new shape with all surfaces, curves and 2D curves of BSpline/Bezier type or based on them, converted with a degree less than *MaxDegree* or with a number of spans less then *NbMaxSegment* depending on the priority parameter *Degree*. If this parameter is equal to True then *Degree* will be increased to the value *GmaxDegree*, otherwise *NbMaxSegments* will be increased to the value *GmaxSegments*. *GmaxDegree* and *GMaxSegments* are the maximum possible degree and the number of spans correspondingly. These values will be used in cases when an approximation with specified parameters is impossible and either *GmaxDegree* or *GMaxSegments* is selected depending on the priority. It returns a new shape with all surfaces, curves and 2D curves of BSpline/Bezier type or based on them, converted with a degree less than *MaxDegree* or with a number of spans less then *NbMaxSegment* depending on the priority parameter *Degree*. If this parameter is equal to True then *Degree* will be increased to the value *GmaxDegree*, otherwise *NbMaxSegments* will be increased to the value *GmaxSegments*. *GmaxDegree* and *GMaxSegments* are the maximum possible degree and the number of spans correspondingly. These values will be used in cases when an approximation with specified parameters is impossible and either *GmaxDegree* or *GMaxSegments* is selected depending on the priority.
@ -1281,22 +1281,22 @@ The following flags define whether a specified-type geometry has been converted
@subsubsection occt_shg_4_4_4 Conversion of elementary surfaces into surfaces of revolution @subsubsection occt_shg_4_4_4 Conversion of elementary surfaces into surfaces of revolution
~~~~~ ~~~~{.cpp}
ShapeCustom::ConvertToRevolution() ShapeCustom::ConvertToRevolution()
TopoDS_Shape ShapeCustom::ConvertToRevolution(const TopoDS_Shape& S) ; TopoDS_Shape ShapeCustom::ConvertToRevolution(const TopoDS_Shape& S) ;
~~~~~ ~~~~
This method returns a new shape with all elementary periodic surfaces converted to *Geom_SurfaceOfRevolution*. It uses the tool *ShapeCustom_ConvertToRevolution*. This method returns a new shape with all elementary periodic surfaces converted to *Geom_SurfaceOfRevolution*. It uses the tool *ShapeCustom_ConvertToRevolution*.
@subsubsection occt_shg_4_4_5 Conversion of elementary surfaces into Bspline surfaces @subsubsection occt_shg_4_4_5 Conversion of elementary surfaces into Bspline surfaces
~~~~~ ~~~~{.cpp}
ShapeCustom::ConvertToBSpline() ShapeCustom::ConvertToBSpline()
TopoDS_Shape ShapeCustom::ConvertToBSpline( const TopoDS_Shape& S, TopoDS_Shape ShapeCustom::ConvertToBSpline( const TopoDS_Shape& S,
const Standard_Boolean extrMode, const Standard_Boolean extrMode,
const Standard_Boolean revolMode, const Standard_Boolean revolMode,
const Standard_Boolean offsetMode); const Standard_Boolean offsetMode);
~~~~~ ~~~~
This method returns a new shape with all surfaces of linear extrusion, revolution and offset surfaces converted according to flags to *Geom_BSplineSurface* (with the same parameterization). It uses the tool *ShapeCustom_ConvertToBSpline*. This method returns a new shape with all surfaces of linear extrusion, revolution and offset surfaces converted according to flags to *Geom_BSplineSurface* (with the same parameterization). It uses the tool *ShapeCustom_ConvertToBSpline*.
@ -1308,13 +1308,13 @@ If, in addition to the resulting shape, you want to get the history of modificat
The general calling syntax for scaling is The general calling syntax for scaling is
~~~~~ ~~~~{.cpp}
TopoDS_Shape scaled_shape = ShapeCustom::ScaleShape(shape, scale); TopoDS_Shape scaled_shape = ShapeCustom::ScaleShape(shape, scale);
~~~~~ ~~~~
Note that scale is a real value. You can refine your mapping process by using additional calls to follow shape mapping sub-shape by sub-shape. The following code along with pertinent includes can be used: Note that scale is a real value. You can refine your mapping process by using additional calls to follow shape mapping sub-shape by sub-shape. The following code along with pertinent includes can be used:
~~~~~ ~~~~{.cpp}
p_Trsf T; p_Trsf T;
Standard_Real scale = 100; // for example! Standard_Real scale = 100; // for example!
T.SetScale (gp_Pnt (0, 0, 0), scale); T.SetScale (gp_Pnt (0, 0, 0), scale);
@ -1324,13 +1324,13 @@ TopTools_DataMapOfShapeShape context;
BRepTools_Modifier MD; BRepTools_Modifier MD;
TopoDS_Shape res = ShapeCustom::ApplyModifier ( TopoDS_Shape res = ShapeCustom::ApplyModifier (
Shape, TM, context,MD ); Shape, TM, context,MD );
~~~~~ ~~~~
The map, called context in our example, contains the history. The map, called context in our example, contains the history.
Substitutions are made one by one and all shapes are transformed. Substitutions are made one by one and all shapes are transformed.
To determine what happens to a particular sub-shape, it is possible to use: To determine what happens to a particular sub-shape, it is possible to use:
~~~~~ ~~~~{.cpp}
TopoDS_Shape oneres = context.Find (oneshape); TopoDS_Shape oneres = context.Find (oneshape);
//In case there is a doubt, you can also add: //In case there is a doubt, you can also add:
if (context.IsBound(oneshape)) oneres = context.Find(oneshape); if (context.IsBound(oneshape)) oneres = context.Find(oneshape);
@ -1342,7 +1342,7 @@ iter(context);iter(more ();iter.next ()) {
TopoDs_Shape oneshape = iter.key (); TopoDs_Shape oneshape = iter.key ();
TopoDs_Shape oneres = iter.value (); TopoDs_Shape oneres = iter.value ();
} }
~~~~~ ~~~~
@subsubsection occt_shg_4_4_7 Remove internal wires @subsubsection occt_shg_4_4_7 Remove internal wires
@ -1379,7 +1379,7 @@ After the processing six internal wires with contour area less than the specifie
The example of method application is also given below: The example of method application is also given below:
~~~~~ ~~~~{.cpp}
//Initialization of the class by shape. //Initialization of the class by shape.
Handle(ShapeUpgrade_RemoveInternalWires) aTool = new ShapeUpgrade_RemoveInternalWires(inputShape); Handle(ShapeUpgrade_RemoveInternalWires) aTool = new ShapeUpgrade_RemoveInternalWires(inputShape);
//setting parameters //setting parameters
@ -1410,7 +1410,7 @@ if(aTool->Status(ShapeExtend_DONE1)) {
} }
//getting result shape //getting result shape
TopoDS_Shape res = aTool->GetResult(); TopoDS_Shape res = aTool->GetResult();
~~~~~ ~~~~
@subsubsection occt_shg_4_4_8 Conversion of surfaces @subsubsection occt_shg_4_4_8 Conversion of surfaces
@ -1427,7 +1427,7 @@ To convert surfaces to analytical form this class analyzes the form and the clos
The conversion is done only if the new (analytical) surface does not deviate from the source one more than by the given precision. The conversion is done only if the new (analytical) surface does not deviate from the source one more than by the given precision.
~~~~~ ~~~~{.cpp}
Handle(Geom_Surface) initSurf; Handle(Geom_Surface) initSurf;
ShapeCustom_Surface ConvSurf(initSurf); ShapeCustom_Surface ConvSurf(initSurf);
//conversion to analytical form //conversion to analytical form
@ -1436,7 +1436,7 @@ Handle(Geom_Surface) newSurf = ConvSurf.ConvertToAnalytical(allowedtol,Standard
Handle(Geom_Surface) newSurf = ConvSurf.ConvertToPeriodic(Standard_False); Handle(Geom_Surface) newSurf = ConvSurf.ConvertToPeriodic(Standard_False);
//getting the maximum deviation of the new surface from the initial surface //getting the maximum deviation of the new surface from the initial surface
Standard_Real maxdist = ConvSurf.Gap(); Standard_Real maxdist = ConvSurf.Gap();
~~~~~ ~~~~
@subsubsection occt_shg_4_4_9 Unify Same Domain @subsubsection occt_shg_4_4_9 Unify Same Domain
@ -1458,7 +1458,7 @@ The common methods of this tool are as follows:
* Method *Generated()* is used to get a new common shape from the old shape. If a group of edges has been unified into one common edge then method *Generated()* called on any edge from this group will return the common edge. The same goes for the faces. * Method *Generated()* is used to get a new common shape from the old shape. If a group of edges has been unified into one common edge then method *Generated()* called on any edge from this group will return the common edge. The same goes for the faces.
The example of the usage is given below: The example of the usage is given below:
~~~~~ ~~~~{.cpp}
// 'Sh' is the initial shape // 'Sh' is the initial shape
ShapeUpgrade_UnifySameDomain USD(Sh, true, true, true); // UnifyFaces mode on, UnifyEdges mode on, ConcatBSplines mode on. ShapeUpgrade_UnifySameDomain USD(Sh, true, true, true); // UnifyFaces mode on, UnifyEdges mode on, ConcatBSplines mode on.
USD.Build(); USD.Build();
@ -1467,7 +1467,7 @@ The example of the usage is given below:
//Let Sh1 as a part of Sh //Let Sh1 as a part of Sh
//get the new (probably unified) shape form the Sh1 //get the new (probably unified) shape form the Sh1
TopoDS_Shape ResSh1 = USD.Generated(Sh1); TopoDS_Shape ResSh1 = USD.Generated(Sh1);
~~~~~ ~~~~
@section occt_shg_5_ Auxiliary tools for repairing, analysis and upgrading @section occt_shg_5_ Auxiliary tools for repairing, analysis and upgrading
@ -1490,7 +1490,7 @@ Additional method *IsNewShape* can be used to check if the shape has been record
Let us use the tool to get the result shape after modification of sub-shapes of the initial shape: Let us use the tool to get the result shape after modification of sub-shapes of the initial shape:
~~~~~ ~~~~{.cpp}
TopoDS_Shape initialShape… TopoDS_Shape initialShape…
//creation of a rebuilding tool //creation of a rebuilding tool
Handle(ShapeBuild_ReShape) Context = new ShapeBuild_ReShape. Handle(ShapeBuild_ReShape) Context = new ShapeBuild_ReShape.
@ -1516,7 +1516,7 @@ TopoDS_Shape resultShape = Context->Apply(initialShape);
//getting the resulting sub-shape from the subshape1 of the initial shape. //getting the resulting sub-shape from the subshape1 of the initial shape.
TopoDS_Shape result_subshape1 = Context->Apply(subshape1); TopoDS_Shape result_subshape1 = Context->Apply(subshape1);
~~~~~ ~~~~
@subsection occt_shg_5_2 Status definition @subsection occt_shg_5_2 Status definition
@ -1546,7 +1546,7 @@ This class also provides a method to check if the edge in the wire is a seam (if
Let us remove edges from the wire and define whether it is seam edge Let us remove edges from the wire and define whether it is seam edge
~~~~~ ~~~~{.cpp}
TopoDS_Wire ini = .. TopoDS_Wire ini = ..
Handle(ShapeExtend_Wire) asewd = new ShapeExtend_Wire(initwire); Handle(ShapeExtend_Wire) asewd = new ShapeExtend_Wire(initwire);
//Removing edge Edge1 from the wire. //Removing edge Edge1 from the wire.
@ -1556,7 +1556,7 @@ asewd.Remove(index_edge1);
//Definition of whether Edge2 is a seam edge //Definition of whether Edge2 is a seam edge
Standard_Integer index_edge2 = asewd->Index(Edge2); Standard_Integer index_edge2 = asewd->Index(Edge2);
asewd->IsSeam(index_edge2); asewd->IsSeam(index_edge2);
~~~~~ ~~~~
@subsection occt_shg_5_4 Tool for exploring shapes @subsection occt_shg_5_4 Tool for exploring shapes
@ -1570,7 +1570,7 @@ Class *ShapeExtend_MsgRegistrator* attaches messages to objects (generic Transie
Let us send and get a message attached to object: Let us send and get a message attached to object:
~~~~~ ~~~~{.cpp}
Handle(ShapeExtend_MsgRegistrator) MessageReg = new ShapeExtend_MsgRegistrator; Handle(ShapeExtend_MsgRegistrator) MessageReg = new ShapeExtend_MsgRegistrator;
//attaches messages to an object (shape or entity) //attaches messages to an object (shape or entity)
Message_Msg msg.. Message_Msg msg..
@ -1587,7 +1587,7 @@ iter.More(); iter.Next()) {
Message_Msg msg = iter.Value(); Message_Msg msg = iter.Value();
} }
} }
~~~~~ ~~~~
@subsection occt_shg_5_6 Tools for performance measurement @subsection occt_shg_5_6 Tools for performance measurement
@ -1595,7 +1595,7 @@ Classes *MoniTool_Timer* and *MoniTool_TimerSentry* are used for measuring the p
Let us try to use timers in *XSDRAWIGES.cxx* and *IGESBRep_Reader.cxx* to analyse the performance of command *igesbrep*: Let us try to use timers in *XSDRAWIGES.cxx* and *IGESBRep_Reader.cxx* to analyse the performance of command *igesbrep*:
~~~~~ ~~~~{.cpp}
XSDRAWIGES.cxx XSDRAWIGES.cxx
... ...
#include <MoniTool_Timer.hxx> #include <MoniTool_Timer.hxx>
@ -1626,7 +1626,7 @@ IGESBRep_Reader.cxx
} }
... ...
} }
~~~~~ ~~~~
The result of *DumpTimer()* after file translation is as follows: The result of *DumpTimer()* after file translation is as follows:
@ -1646,35 +1646,35 @@ The Shape Processing functionality is implemented with the help of the *XSAlgo*
This function is used in the following way: This function is used in the following way:
~~~~~ ~~~~{.cpp}
TopoDS_Shape aShape = …; TopoDS_Shape aShape = …;
Standard_Real Prec = …, Standard_Real Prec = …,
Standard_Real MaxTol = …; Standard_Real MaxTol = …;
TopoDS_Shape aResult; TopoDS_Shape aResult;
Handle(Standard_Transient) info; Handle(Standard_Transient) info;
TopoDS_Shape aResult = XSAlgo::AlgoContainer()->ProcessShape(aShape, Prec, MaxTol., "Name of ResourceFile", "NameSequence", info ); TopoDS_Shape aResult = XSAlgo::AlgoContainer()->ProcessShape(aShape, Prec, MaxTol., "Name of ResourceFile", "NameSequence", info );
~~~~~ ~~~~
Let us create a custom sequence of operations: Let us create a custom sequence of operations:
1. Create a resource file with the name *ResourceFile*, which includes the following string: 1. Create a resource file with the name *ResourceFile*, which includes the following string:
~~~~~ ~~~~{.cpp}
NameSequence.exec.op: MyOper NameSequence.exec.op: MyOper
~~~~~ ~~~~
where *MyOper* is the name of operation. where *MyOper* is the name of operation.
2. Input a custom parameter for this operation in the resource file, for example: 2. Input a custom parameter for this operation in the resource file, for example:
~~~~~ ~~~~{.cpp}
NameSequence.MyOper.Tolerance: 0.01 NameSequence.MyOper.Tolerance: 0.01
~~~~~ ~~~~
where *Tolerance* is the name of the parameter and 0.01 is its value. where *Tolerance* is the name of the parameter and 0.01 is its value.
3. Add the following string into *void ShapeProcess_OperLibrary::Init()*: 3. Add the following string into *void ShapeProcess_OperLibrary::Init()*:
~~~~~ ~~~~{.cpp}
ShapeProcess::RegisterOperator(;MyOper;, ShapeProcess::RegisterOperator(;MyOper;,
new ShapeProcess_UOperator(myfunction)); new ShapeProcess_UOperator(myfunction));
~~~~~ ~~~~
where *myfunction* is a function which implements the operation. where *myfunction* is a function which implements the operation.
4. Create this function in *ShapeProcess_OperLibrary* as follows: 4. Create this function in *ShapeProcess_OperLibrary* as follows:
~~~~~ ~~~~{.cpp}
static Standard_Boolean myfunction (const static Standard_Boolean myfunction (const
Handle(ShapeProcess_Context)& context) Handle(ShapeProcess_Context)& context)
{ {
@ -1684,19 +1684,19 @@ static Standard_Boolean myfunction (const
//receive our parameter: //receive our parameter:
Standard_Real toler; Standard_Real toler;
ctx->GetReal(;Tolerance;, toler); ctx->GetReal(;Tolerance;, toler);
~~~~~ ~~~~
5. Make the necessary operations with *aShape* using the received value of parameter *Tolerance* from the resource file. 5. Make the necessary operations with *aShape* using the received value of parameter *Tolerance* from the resource file.
~~~~~ ~~~~{.cpp}
return Standard_True; return Standard_True;
} }
~~~~~ ~~~~
6. Define some operations (with their parameters) *MyOper1, MyOper2, MyOper3*, etc. and describe the corresponding functions in *ShapeProcess_OperLibrary*. 6. Define some operations (with their parameters) *MyOper1, MyOper2, MyOper3*, etc. and describe the corresponding functions in *ShapeProcess_OperLibrary*.
7. Perform the required sequence using the specified name of operations and values of parameters in the resource file. 7. Perform the required sequence using the specified name of operations and values of parameters in the resource file.
For example: input of the following string: For example: input of the following string:
~~~~~ ~~~~{.cpp}
NameSequence.exec.op: MyOper1,MyOper3 NameSequence.exec.op: MyOper1,MyOper3
~~~~~ ~~~~
means that the corresponding functions from *ShapeProcess_OperLibrary* will be performed with the original shape *aShape* using parameters defined for *MyOper1* and *MyOper3* in the resource file. means that the corresponding functions from *ShapeProcess_OperLibrary* will be performed with the original shape *aShape* using parameters defined for *MyOper1* and *MyOper3* in the resource file.
It is necessary to note that these operations will be performed step by step and the result obtained after performing the first operation will be used as the initial shape for the second operation. It is necessary to note that these operations will be performed step by step and the result obtained after performing the first operation will be used as the initial shape for the second operation.
@ -1906,7 +1906,7 @@ All lines in the file after the key and before the next keyword (and which are n
The following example illustrates the structure of a message file: The following example illustrates the structure of a message file:
~~~~~ ~~~~{.cpp}
!This is a sample message file !This is a sample message file
!------------------------------ !------------------------------
!Messages for ShapeAnalysis package !Messages for ShapeAnalysis package
@ -1917,15 +1917,15 @@ Your message string goes here
!... !...
! !
!End of the message file !End of the message file
~~~~~ ~~~~
### Loading the message file ### Loading the message file
A custom file can be loaded into memory using the method *Message_MsgFile::LoadFile*, taking as an argument the path to your file as in the example below: A custom file can be loaded into memory using the method *Message_MsgFile::LoadFile*, taking as an argument the path to your file as in the example below:
~~~~~ ~~~~{.cpp}
Standard_CString MsgFilePath = ;(path)/sample.file;; Standard_CString MsgFilePath = ;(path)/sample.file;;
Message_MsgFile::LoadFile (MsgFilePath); Message_MsgFile::LoadFile (MsgFilePath);
~~~~~ ~~~~
@subsection occt_shg_7_3 Tool for managing filling messages @subsection occt_shg_7_3 Tool for managing filling messages
@ -1936,13 +1936,13 @@ The text of the message can contain places for parameters, which are to be fille
* integer -- coded in the text as \%d, * integer -- coded in the text as \%d,
* real -- coded in the text as \%f. * real -- coded in the text as \%f.
The parameter fields are filled by the message text by calling the corresponding methods *AddInteger, AddReal* and *AddString*. Both the original text of the message and the input text with substituted parameters are stored in the object. The prepared and filled message can be output to the default trace file. The text of the message (either original or filled) can be also obtained. The parameter fields are filled by the message text by calling the corresponding methods *AddInteger, AddReal* and *AddString*. Both the original text of the message and the input text with substituted parameters are stored in the object. The prepared and filled message can be output to the default trace file. The text of the message (either original or filled) can be also obtained.
~~~~~ ~~~~{.cpp}
Message_Msg msg01 (;SampleKeyword;); Message_Msg msg01 (;SampleKeyword;);
//Creates the message msg01, identified in the file by the keyword SampleKeyword //Creates the message msg01, identified in the file by the keyword SampleKeyword
msg1.AddInteger (73); msg1.AddInteger (73);
msg1.AddString (;SampleFile;); msg1.AddString (;SampleFile;);
//fills out the code areas //fills out the code areas
~~~~~ ~~~~
@subsection occt_shg_7_4 Tool for managing trace files @subsection occt_shg_7_4 Tool for managing trace files
@ -1951,10 +1951,10 @@ There are two ways of using trace files:
* define an object of *Message_TraceFile*, with its own definition (file name or cout, trace level), and use it where it is defined, * define an object of *Message_TraceFile*, with its own definition (file name or cout, trace level), and use it where it is defined,
* use the default trace file (file name or cout, trace level), usable from anywhere. * use the default trace file (file name or cout, trace level), usable from anywhere.
Use the constructor method to define the target file and the level of the messages as in the example below: Use the constructor method to define the target file and the level of the messages as in the example below:
~~~~~ ~~~~{.cpp}
Message_TraceFile myTF Message_TraceFile myTF
(tracelevel, "tracefile.log", Standard_False); (tracelevel, "tracefile.log", Standard_False);
~~~~~ ~~~~
The parameters are as follows: The parameters are as follows:
* *tracelevel* is a Standard_Integer and modifies the level of messages. It has the following values and semantics: * *tracelevel* is a Standard_Integer and modifies the level of messages. It has the following values and semantics:
+ 0: gives general information such as the start and end of process; + 0: gives general information such as the start and end of process;

298
dox/user_guides/step/step.md
View File

@ -119,23 +119,23 @@ For further information see 2.4 Mapping STEP entities to Open CASCADE Technology
@subsubsection occt_step_2_3_1 Loading the STEP file @subsubsection occt_step_2_3_1 Loading the STEP file
Before performing any other operation you have to load the file with: Before performing any other operation you have to load the file with:
~~~~~ ~~~~{.cpp}
STEPControl_Reader reader; STEPControl_Reader reader;
IFSelect_ReturnStatus stat = reader.ReadFile("filename.stp"); IFSelect_ReturnStatus stat = reader.ReadFile("filename.stp");
~~~~~ ~~~~
Loading the file only memorizes the data, it does not translate it. Loading the file only memorizes the data, it does not translate it.
@subsubsection occt_step_2_3_2 Checking the STEP file @subsubsection occt_step_2_3_2 Checking the STEP file
This step is not obligatory. Check the loaded file with: This step is not obligatory. Check the loaded file with:
~~~~~ ~~~~{.cpp}
reader.PrintCheckLoad(failsonly,mode); reader.PrintCheckLoad(failsonly,mode);
~~~~~ ~~~~
Error messages are displayed if there are invalid or incomplete STEP entities, giving you the information on the cause of error. Error messages are displayed if there are invalid or incomplete STEP entities, giving you the information on the cause of error.
If *failsonly* is true only fail messages are displayed. All messages are displayed if *failsonly* is false. Your analysis of the file can be either message-oriented or entity-oriented. Choose your preference with: If *failsonly* is true only fail messages are displayed. All messages are displayed if *failsonly* is false. Your analysis of the file can be either message-oriented or entity-oriented. Choose your preference with:
~~~~~ ~~~~{.cpp}
IFSelect_PrintCount mode = IFSelect_xxx IFSelect_PrintCount mode = IFSelect_xxx
~~~~~ ~~~~
Where xxx can be one of the following: Where xxx can be one of the following:
* *ItemsByEntity* -- gives a sequential list of all messages per STEP entity, * *ItemsByEntity* -- gives a sequential list of all messages per STEP entity,
* *CountByItem* -- gives the number of STEP entities with their types per message * *CountByItem* -- gives the number of STEP entities with their types per message
@ -153,14 +153,14 @@ Defines which precision value will be used during translation (see section 2.5 b
Read this parameter with: Read this parameter with:
~~~~~ ~~~~{.cpp}
Standard_Integer ic = Interface_Static::IVal("read.precision.mode"); Standard_Integer ic = Interface_Static::IVal("read.precision.mode");
~~~~~ ~~~~
Modify this parameter with: Modify this parameter with:
~~~~~ ~~~~{.cpp}
if(!Interface_Static::SetIVal("read.precision.mode",1)) if(!Interface_Static::SetIVal("read.precision.mode",1))
.. error .. .. error ..
~~~~~ ~~~~
Default value is File (0). Default value is File (0).
<h4>read.precision.val:</h4> <h4>read.precision.val:</h4>
@ -169,14 +169,14 @@ User defined precision value. This parameter gives the precision for shape const
This value is a basic value of tolerance in the processor. The value is in millimeters, independently of the length unit defined in the STEP file. This value is a basic value of tolerance in the processor. The value is in millimeters, independently of the length unit defined in the STEP file.
Read this parameter with: Read this parameter with:
~~~~~ ~~~~{.cpp}
Standard_Real rp = Interface_Static::RVal("read.precision.val"); Standard_Real rp = Interface_Static::RVal("read.precision.val");
~~~~~ ~~~~
Modify this parameter with: Modify this parameter with:
~~~~~ ~~~~{.cpp}
if(!Interface_Static::SetRVal("read.precision.val",0.01)) if(!Interface_Static::SetRVal("read.precision.val",0.01))
.. error .. .. error ..
~~~~~ ~~~~
By default this value is 0.0001. By default this value is 0.0001.
The value given to this parameter is a basic value for ShapeHealing algorithms and the processor. It does its best to reach it. Under certain circumstances, the value you give may not be attached to all of the entities concerned at the end of processing. STEP-to-OpenCASCADE translation does not improve the quality of the geometry in the original STEP file. This means that the value you enter may be impossible to attach to all shapes with the given quality of the geometry in the STEP file. The value given to this parameter is a basic value for ShapeHealing algorithms and the processor. It does its best to reach it. Under certain circumstances, the value you give may not be attached to all of the entities concerned at the end of processing. STEP-to-OpenCASCADE translation does not improve the quality of the geometry in the original STEP file. This means that the value you enter may be impossible to attach to all shapes with the given quality of the geometry in the STEP file.
@ -185,14 +185,14 @@ The value given to this parameter is a basic value for ShapeHealing algorithms a
Defines the maximum allowed tolerance (in mm) of the shape. It should be not less than the basic value of tolerance set in the processor (either the uncertainty from the file or *read.precision.val*). Actually, the maximum between *read.maxprecision.val* and the basis tolerance is used to define the maximum allowed tolerance. Defines the maximum allowed tolerance (in mm) of the shape. It should be not less than the basic value of tolerance set in the processor (either the uncertainty from the file or *read.precision.val*). Actually, the maximum between *read.maxprecision.val* and the basis tolerance is used to define the maximum allowed tolerance.
Read this parameter with: Read this parameter with:
~~~~~ ~~~~{.cpp}
Standard_Real rp = Interface_Static::RVal("read.maxprecision.val"); Standard_Real rp = Interface_Static::RVal("read.maxprecision.val");
~~~~~ ~~~~
Modify this parameter with: Modify this parameter with:
~~~~~ ~~~~{.cpp}
if(!Interface_Static::SetRVal("read.maxprecision.val",0.1)) if(!Interface_Static::SetRVal("read.maxprecision.val",0.1))
.. error .. .. error ..
~~~~~ ~~~~
Default value is 1. Default value is 1.
Note that maximum tolerance even explicitly defined by the user may be insufficient to ensure the validity of the shape (if real geometry is of bad quality). Therefore the user is provided with an additional parameter, which allows him to choose: either he prefers to ensure the shape validity or he rigidly sets the value of maximum tolerance. In the first case there is a possibility that the tolerance will not have any upper limit, in the second case the shape may be invalid. Note that maximum tolerance even explicitly defined by the user may be insufficient to ensure the validity of the shape (if real geometry is of bad quality). Therefore the user is provided with an additional parameter, which allows him to choose: either he prefers to ensure the shape validity or he rigidly sets the value of maximum tolerance. In the first case there is a possibility that the tolerance will not have any upper limit, in the second case the shape may be invalid.
@ -203,14 +203,14 @@ Defines the mode of applying the maximum allowed tolerance. Its possible values
* 1 (Forced) -- maximum tolerance is used as a rigid limit, i.e. no tolerance can exceed it and if it is the case, the tolerance is trimmed by the maximum tolerance. * 1 (Forced) -- maximum tolerance is used as a rigid limit, i.e. no tolerance can exceed it and if it is the case, the tolerance is trimmed by the maximum tolerance.
Read this parameter with: Read this parameter with:
~~~~~ ~~~~{.cpp}
Standard_Integer ic = Interface_Static::IVal("read.maxprecision.mode"); Standard_Integer ic = Interface_Static::IVal("read.maxprecision.mode");
~~~~~ ~~~~
Modify this parameter with: Modify this parameter with:
~~~~~ ~~~~{.cpp}
if(!Interface_Static::SetIVal("read.maxprecision.mode",1)) if(!Interface_Static::SetIVal("read.maxprecision.mode",1))
.. error .. .. error ..
~~~~~ ~~~~
Default value is 0 ("Preferred"). Default value is 0 ("Preferred").
<h4>read.stdsameparameter.mode</h4> <h4>read.stdsameparameter.mode</h4>
@ -221,14 +221,14 @@ defines the use of *BRepLib::SameParameter*. Its possible values are:
The functionality of *BRepLib::SameParameter* is used through *ShapeFix_Edge::SameParameter*. It ensures that the resulting edge will have the lowest tolerance taking pcurves either unmodified from the STEP file or modified by *BRepLib::SameParameter*. The functionality of *BRepLib::SameParameter* is used through *ShapeFix_Edge::SameParameter*. It ensures that the resulting edge will have the lowest tolerance taking pcurves either unmodified from the STEP file or modified by *BRepLib::SameParameter*.
Read this parameter with: Read this parameter with:
~~~~~ ~~~~{.cpp}
Standard_Integer mv = Interface_Static::IVal("read.stdsameparameter.mode"); Standard_Integer mv = Interface_Static::IVal("read.stdsameparameter.mode");
~~~~~ ~~~~
Modify this parameter with: Modify this parameter with:
~~~~~ ~~~~{.cpp}
if (!Interface_Static::SetIVal ("read.stdsameparameter.mode",1)) if (!Interface_Static::SetIVal ("read.stdsameparameter.mode",1))
.. error ..; .. error ..;
~~~~~ ~~~~
Default value is 0 (;Off;). Default value is 0 (;Off;).
<h4>read.surfacecurve.mode:</h4> <h4>read.surfacecurve.mode:</h4>
@ -240,28 +240,28 @@ If both 2D and 3D representation of the entity are present, the computation of t
* *3DUse_Preferred (3)* : 3D curves are used to rebuild 2D ones. * *3DUse_Preferred (3)* : 3D curves are used to rebuild 2D ones.
Read this parameter with: Read this parameter with:
~~~~~ ~~~~{.cpp}
Standard_Integer rp = Interface_Static::IVal("read.surfacecurve.mode"); Standard_Integer rp = Interface_Static::IVal("read.surfacecurve.mode");
~~~~~ ~~~~
Modify this parameter with: Modify this parameter with:
~~~~~ ~~~~{.cpp}
if(!Interface_Static::SetIVal("read.surfacecurve.mode",3)) if(!Interface_Static::SetIVal("read.surfacecurve.mode",3))
.. error .. .. error ..
~~~~~ ~~~~
Default value is (0). Default value is (0).
<h4>read.encoderegularity.angle</h4> <h4>read.encoderegularity.angle</h4>
This parameter is used for call to *BRepLib::EncodeRegularity()* function which is called for the shape read from an IGES or a STEP file at the end of translation process. This function sets the regularity flag of the edge in the shell when this edge is shared by two faces. This flag shows the continuity these two faces are connected with at that edge. This parameter is used for call to *BRepLib::EncodeRegularity()* function which is called for the shape read from an IGES or a STEP file at the end of translation process. This function sets the regularity flag of the edge in the shell when this edge is shared by two faces. This flag shows the continuity these two faces are connected with at that edge.
Read this parameter with: Read this parameter with:
~~~~~ ~~~~{.cpp}
Standard_Real era = Interface_Static::RVal("read.encoderegularity.angle"); Standard_Real era = Interface_Static::RVal("read.encoderegularity.angle");
~~~~~ ~~~~
Modify this parameter with: Modify this parameter with:
~~~~~ ~~~~{.cpp}
if (!Interface_Static::SetRVal ("read.encoderegularity.angle",0.1)) if (!Interface_Static::SetRVal ("read.encoderegularity.angle",0.1))
.. error ..; .. error ..;
~~~~~ ~~~~
Default value is 0.01. Default value is 0.01.
<h4>step.angleunit.mode</h4> <h4>step.angleunit.mode</h4>
@ -292,15 +292,15 @@ Defines the approach used for selection of top-level STEP entities for translati
* 0 (OFF) -- *SHAPE_DEFINITION_REPRESENTATION* entities are taken as top-level ones; assembly is recognized by *CONTEXT_DEPENDENT_SHAPE_REPRESENTATION* entities. This is compatibility mode, which can be used for reading legacy STEP files produced by older versions of STEP translators and having incorrect or incomplete product information. * 0 (OFF) -- *SHAPE_DEFINITION_REPRESENTATION* entities are taken as top-level ones; assembly is recognized by *CONTEXT_DEPENDENT_SHAPE_REPRESENTATION* entities. This is compatibility mode, which can be used for reading legacy STEP files produced by older versions of STEP translators and having incorrect or incomplete product information.
Read this parameter with: Read this parameter with:
~~~~~ ~~~~{.cpp}
Standard_Integer ic = Interface_Static::IVal("read.step.product.mode"); Standard_Integer ic = Interface_Static::IVal("read.step.product.mode");
~~~~~ ~~~~
Modify this parameter with: Modify this parameter with:
~~~~~ ~~~~{.cpp}
if(!Interface_Static::SetIVal("read.step.product.mode",1)) if(!Interface_Static::SetIVal("read.step.product.mode",1))
.. error .. .. error ..
~~~~~ ~~~~
Default value is 1 (ON). Default value is 1 (ON).
Note that the following parameters have effect only if *read.step.product.mode* is ON. Note that the following parameters have effect only if *read.step.product.mode* is ON.
@ -315,15 +315,15 @@ When reading AP 209 STEP files, allows selecting either only `design' or `analys
Note that in AP 203 and AP214 files all products should be marked as `design', so if this mode is set to `analysis', nothing will be read. Note that in AP 203 and AP214 files all products should be marked as `design', so if this mode is set to `analysis', nothing will be read.
Read this parameter with: Read this parameter with:
~~~~~ ~~~~{.cpp}
Standard_Integer ic = Interface_Static::IVal("read.step.product.context"); Standard_Integer ic = Interface_Static::IVal("read.step.product.context");
~~~~~ ~~~~
Modify this parameter with: Modify this parameter with:
~~~~~ ~~~~{.cpp}
if(!Interface_Static::SetIVal(;read.step.product.context;,1)) if(!Interface_Static::SetIVal(;read.step.product.context;,1))
.. error .. .. error ..
~~~~~ ~~~~
Default value is 1 (all). Default value is 1 (all).
<h4>read.step.shape.repr:</h4> <h4>read.step.shape.repr:</h4>
@ -340,14 +340,14 @@ Specifies preferred type of representation of the shape of the product, in case
When this option is not equal to 1, for products with multiple representations the representation having a type closest to the selected one in this list will be translated. When this option is not equal to 1, for products with multiple representations the representation having a type closest to the selected one in this list will be translated.
Read this parameter with: Read this parameter with:
~~~~~ ~~~~{.cpp}
Standard_Integer ic = Interface_Static::IVal("read.step.shape.repr"); Standard_Integer ic = Interface_Static::IVal("read.step.shape.repr");
~~~~~ ~~~~
Modify this parameter with: Modify this parameter with:
~~~~~ ~~~~{.cpp}
if(!Interface_Static::SetIVal("read.step.shape.repr",1)) if(!Interface_Static::SetIVal("read.step.shape.repr",1))
.. error .. .. error ..
~~~~~ ~~~~
Default value is 1 (All). Default value is 1 (All).
<h4>read.step.assembly.level:</h4> <h4>read.step.assembly.level:</h4>
@ -359,14 +359,14 @@ Specifies which data should be read for the products found in the STEP file:
* 4 (shape) -- Translate only shapes associated with the product, ignoring the assembly structure (if any). This can be useful to translate only a shape associated with specific product, as a complement to *assembly* mode. * 4 (shape) -- Translate only shapes associated with the product, ignoring the assembly structure (if any). This can be useful to translate only a shape associated with specific product, as a complement to *assembly* mode.
Read this parameter with: Read this parameter with:
~~~~~ ~~~~{.cpp}
Standard_Integer ic = Interface_Static::IVal("read.step.assembly.level"); Standard_Integer ic = Interface_Static::IVal("read.step.assembly.level");
~~~~~ ~~~~
Modify this parameter with: Modify this parameter with:
~~~~~ ~~~~{.cpp}
if(!Interface_Static::SetIVal("read.step.assembly.level",1)) if(!Interface_Static::SetIVal("read.step.assembly.level",1))
.. error .. .. error ..
~~~~~ ~~~~
Default value is 1 (All). Default value is 1 (All).
@ -376,14 +376,14 @@ Defines whether shapes associated with the main *SHAPE_DEFINITION_REPRESENTATION
* 0 (OFF) -- do not translate * 0 (OFF) -- do not translate
Read this parameter with: Read this parameter with:
~~~~~ ~~~~{.cpp}
Standard_Integer ic = Interface_Static::IVal("read.step.shape.relationship"); Standard_Integer ic = Interface_Static::IVal("read.step.shape.relationship");
~~~~~ ~~~~
Modify this parameter with: Modify this parameter with:
~~~~~ ~~~~{.cpp}
if(!Interface_Static::SetIVal(;read.step.shape.relationship;,1)) if(!Interface_Static::SetIVal(;read.step.shape.relationship;,1))
.. error .. .. error ..
~~~~~ ~~~~
Default value is 1 (ON). Default value is 1 (ON).
<h4>read.step.shape.aspect:</h4> <h4>read.step.shape.aspect:</h4>
@ -393,15 +393,15 @@ Defines whether shapes associated with the *PRODUCT_DEFINITION_SHAPE* entity of
* 0 (OFF) -- do not translate * 0 (OFF) -- do not translate
Read this parameter with: Read this parameter with:
~~~~~ ~~~~{.cpp}
Standard_Integer ic = Interface_Static::IVal("read.step.shape.aspect"); Standard_Integer ic = Interface_Static::IVal("read.step.shape.aspect");
~~~~~ ~~~~
Modify this parameter with: Modify this parameter with:
~~~~~ ~~~~{.cpp}
if(!Interface_Static::SetIVal(;read.step.shape.aspect;,1)) if(!Interface_Static::SetIVal(;read.step.shape.aspect;,1))
.. error .. .. error ..
~~~~~ ~~~~
Default value is 1 (ON). Default value is 1 (ON).
<h4>read.step.constructivegeom.relationship:</h4> <h4>read.step.constructivegeom.relationship:</h4>
@ -413,9 +413,9 @@ main representation of the shape (product).
By default, the flag is set to 0 (OFF) so these entities are not translated. By default, the flag is set to 0 (OFF) so these entities are not translated.
Set this flag to 1 (ON) if you need to translate constructive geometry entities associated with the parts: Set this flag to 1 (ON) if you need to translate constructive geometry entities associated with the parts:
~~~~~ ~~~~{.cpp}
if (!Interface_Static::SetIVal("read.step.constructivegeom.relationship", 1)) { .. error .. } if (!Interface_Static::SetIVal("read.step.constructivegeom.relationship", 1)) { .. error .. }
~~~~~ ~~~~
The "CONSTRUCTIVE_GEOMETRY_REPRESENTATION" entity is translated into compound of two unlimited planar faces, The "CONSTRUCTIVE_GEOMETRY_REPRESENTATION" entity is translated into compound of two unlimited planar faces,
whose location is result of translation of corresponding "AXIS_PLACEMENT" entity. whose location is result of translation of corresponding "AXIS_PLACEMENT" entity.
@ -424,7 +424,7 @@ Note that appropriate interpretation of the translated data should be done after
The result of translation can be obtained either for the "CONSTRUCTIVE_GEOMETRY_REPRESENTATION_RELATIONSHIP" entity, The result of translation can be obtained either for the "CONSTRUCTIVE_GEOMETRY_REPRESENTATION_RELATIONSHIP" entity,
of for each of the two "AXIS2_PLACEMENT_3D" entities referenced by it. as follows: of for each of the two "AXIS2_PLACEMENT_3D" entities referenced by it. as follows:
~~~~~ ~~~~{.cpp}
STEPControl_Reader aReader; STEPControl_Reader aReader;
... // translate file and parse STEP model to find relevant axis entity ... // translate file and parse STEP model to find relevant axis entity
Handle(StepGeom_Axis2Placement3d) aSTEPAxis = ...; Handle(StepGeom_Axis2Placement3d) aSTEPAxis = ...;
@ -443,7 +443,7 @@ of for each of the two "AXIS2_PLACEMENT_3D" entities referenced by it. as follow
} }
} }
} }
~~~~~ ~~~~
@subsubsection occt_step_2_3_4 Performing the STEP file translation @subsubsection occt_step_2_3_4 Performing the STEP file translation
@ -474,9 +474,9 @@ The following methods are used for translation:
Each successful translation operation outputs one shape. A series of translations gives a set of shapes. Each successful translation operation outputs one shape. A series of translations gives a set of shapes.
Each time you invoke *TransferOne(), TransferRoot()* or *TransferList()*, their results are accumulated and the counter of results increases. You can clear the results with: Each time you invoke *TransferOne(), TransferRoot()* or *TransferList()*, their results are accumulated and the counter of results increases. You can clear the results with:
~~~~~ ~~~~{.cpp}
reader.ClearShapes(); reader.ClearShapes();
~~~~~ ~~~~
between two translation operations, if you do not, the results from the next translation will be added to the accumulation. between two translation operations, if you do not, the results from the next translation will be added to the accumulation.
*TransferRoots()* operations automatically clear all existing results before they start. *TransferRoots()* operations automatically clear all existing results before they start.
@ -494,9 +494,9 @@ If several individual translations follow each other, the results give a list th
<h5>Checking that translation was correctly performed</h5> <h5>Checking that translation was correctly performed</h5>
Each time you invoke *Transfer* or *TransferRoots()*, you can display the related messages with the help of: Each time you invoke *Transfer* or *TransferRoots()*, you can display the related messages with the help of:
~~~~~ ~~~~{.cpp}
reader.PrintCheckTransfer(failsonly,mode); reader.PrintCheckTransfer(failsonly,mode);
~~~~~ ~~~~
This check concerns the last invocation of *Transfer* or *TransferRoots()* only. This check concerns the last invocation of *Transfer* or *TransferRoots()* only.
@ -512,35 +512,35 @@ There are three selection possibilities. You can select:
<h5>The whole file</h5> <h5>The whole file</h5>
Transferring the whole file means transferring all root entities. The number of roots can be evaluated when the file is loaded: Transferring the whole file means transferring all root entities. The number of roots can be evaluated when the file is loaded:
~~~~~ ~~~~{.cpp}
Standard_Integer NbRoots = reader.NbRootsForTransfer(); Standard_Integer NbRoots = reader.NbRootsForTransfer();
Standard_Integer num = reader.TransferRoots(); Standard_Integer num = reader.TransferRoots();
~~~~~ ~~~~
<h5>List of entities</h5> <h5>List of entities</h5>
A list of entities can be formed by invoking *STEP214Control_Reader::GiveList* (this is a method of the parent class). A list of entities can be formed by invoking *STEP214Control_Reader::GiveList* (this is a method of the parent class).
Here is a simple example of how a list is translated: Here is a simple example of how a list is translated:
~~~~~ ~~~~{.cpp}
Handle(TColStd_HSequenceOfTransient) list = reader.GiveList(); Handle(TColStd_HSequenceOfTransient) list = reader.GiveList();
~~~~~ ~~~~
The result is a *TColStd_HSequenceOfTransient*. The result is a *TColStd_HSequenceOfTransient*.
You can either translate a list entity by entity or all at once. An entity-by-entity operation lets you check each individual entity translated. You can either translate a list entity by entity or all at once. An entity-by-entity operation lets you check each individual entity translated.
<h5>Translating a whole list in one operation</h5> <h5>Translating a whole list in one operation</h5>
~~~~~ ~~~~{.cpp}
Standard_Integer nbtrans = reader.TransferList (list); Standard_Integer nbtrans = reader.TransferList (list);
~~~~~ ~~~~
*nbtrans* gives the number of items in the list that produced a shape. *nbtrans* gives the number of items in the list that produced a shape.
<h5>Translating a list entity by entity:</h5> <h5>Translating a list entity by entity:</h5>
~~~~~ ~~~~{.cpp}
Standard_Integer i,nb = list->Length(); Standard_Integer i,nb = list->Length();
for (i = 1; i <= nb; i ++) { for (i = 1; i <= nb; i ++) {
Handle(Standard_Transient) ent = list->Value(i); Handle(Standard_Transient) ent = list->Value(i);
Standard_Boolean OK = reader.TransferEntity (ent); Standard_Boolean OK = reader.TransferEntity (ent);
} }
~~~~~ ~~~~
<h4>Selections</h4> <h4>Selections</h4>
There is a number of predefined operators that can be used. They are: There is a number of predefined operators that can be used. They are:
@ -565,21 +565,21 @@ You can select an entity either by its rank or by its handle (an entity's handle
<h5>Selection by rank</h5> <h5>Selection by rank</h5>
Use method *StepData_StepModel::NextNumberForLabel* to find its rank with the following: Use method *StepData_StepModel::NextNumberForLabel* to find its rank with the following:
~~~~~ ~~~~{.cpp}
Standard_CString label = `#...'; Standard_CString label = `#...';
StepData_StepModel model = reader.StepModel(); StepData_StepModel model = reader.StepModel();
rank = model->NextNumberForLabe(label, 0, Standard_False); rank = model->NextNumberForLabe(label, 0, Standard_False);
~~~~~ ~~~~
Translate an entity specified by its rank: Translate an entity specified by its rank:
~~~~~ ~~~~{.cpp}
Standard_Boolean ok = reader.Transfer (rank); Standard_Boolean ok = reader.Transfer (rank);
~~~~~ ~~~~
<h5>Direct selection of an entity</h5> <h5>Direct selection of an entity</h5>
*ent* is the entity. The argument is a *Handle(Standard_Transient)*. *ent* is the entity. The argument is a *Handle(Standard_Transient)*.
~~~~~ ~~~~{.cpp}
Standard_Boolean ok = reader.TransferEntity (ent); Standard_Boolean ok = reader.TransferEntity (ent);
~~~~~ ~~~~
@subsection occt_step_2_4 Mapping STEP entities to Open CASCADE Technology shapes @subsection occt_step_2_4 Mapping STEP entities to Open CASCADE Technology shapes
Tables given in this paragraph show the mapping of STEP entities to OCCT objects. Only topological and geometrical STEP entities and entities defining assembly structures are described in this paragraph. For a full list of STEP entities, refer to Appendix A. Tables given in this paragraph show the mapping of STEP entities to OCCT objects. Only topological and geometrical STEP entities and entities defining assembly structures are described in this paragraph. For a full list of STEP entities, refer to Appendix A.
@ -777,7 +777,7 @@ The following diagram illustrates the structure of calls in reading STEP. The hi
@figure{/user_guides/step/images/step_image003.png,"The structure of calls in reading STEP",420} @figure{/user_guides/step/images/step_image003.png,"The structure of calls in reading STEP",420}
@subsection occt_step_2_7 Example @subsection occt_step_2_7 Example
~~~~~ ~~~~{.cpp}
#include <STEPControl_Reader.hxx> #include <STEPControl_Reader.hxx>
#include <TopoDS_Shape.hxx> #include <TopoDS_Shape.hxx>
#include <BRepTools.hxx> #include <BRepTools.hxx>
@ -804,7 +804,7 @@ Standard_Integer main()
. . . . . .
} }
~~~~~ ~~~~
@section occt_step_3 Writing STEP @section occt_step_3 Writing STEP
@ -836,9 +836,9 @@ See also @ref occt_step_3_4 "Mapping OCCT shapes to STEP entities".
@subsection occt_step_3_3 Description of the process @subsection occt_step_3_3 Description of the process
@subsubsection occt_step_3_3_1 Initializing the process @subsubsection occt_step_3_3_1 Initializing the process
Before performing any other operation you have to create a writer object: Before performing any other operation you have to create a writer object:
~~~~~ ~~~~{.cpp}
STEPControl_Writer writer; STEPControl_Writer writer;
~~~~~ ~~~~
@subsubsection occt_step_3_3_2 Setting the translation parameters @subsubsection occt_step_3_3_2 Setting the translation parameters
The following parameters are used for the OCCT-to-STEP translation. The following parameters are used for the OCCT-to-STEP translation.
@ -855,10 +855,10 @@ Read this parameter with:
Standard_Integer ic = Interface_Static::IVal("write.precision.mode"); Standard_Integer ic = Interface_Static::IVal("write.precision.mode");
Modify this parameter with: Modify this parameter with:
~~~~~ ~~~~{.cpp}
if(!Interface_Static::SetIVal("write.precision.mode",1)) if(!Interface_Static::SetIVal("write.precision.mode",1))
.. error .. .. error ..
~~~~~ ~~~~
Default value is 0. Default value is 0.
<h4>write.precision.val</h4> <h4>write.precision.val</h4>
@ -869,15 +869,15 @@ a user-defined precision value. This parameter gives the uncertainty for STEP en
This value is stored in shape_representation in a STEP file as an uncertainty. This value is stored in shape_representation in a STEP file as an uncertainty.
Read this parameter with: Read this parameter with:
~~~~~ ~~~~{.cpp}
Standard_Real rp = Interface_Static::RVal("write.precision.val"); Standard_Real rp = Interface_Static::RVal("write.precision.val");
~~~~~ ~~~~
Modify this parameter with: Modify this parameter with:
~~~~~ ~~~~{.cpp}
if(!Interface_Static::SetRVal("write.precision.val",0.01)) if(!Interface_Static::SetRVal("write.precision.val",0.01))
.. error .. .. error ..
~~~~~ ~~~~
Default value is 0.0001. Default value is 0.0001.
<h4>write.step.assembly</h4> <h4>write.step.assembly</h4>
@ -887,14 +887,14 @@ writing assembly mode.
* 2 (Auto) : writes shapes having a structure of (possibly nested) *TopoDS_Compounds* in the form of STEP assemblies, single shapes are written without assembly structures. * 2 (Auto) : writes shapes having a structure of (possibly nested) *TopoDS_Compounds* in the form of STEP assemblies, single shapes are written without assembly structures.
Read this parameter with: Read this parameter with:
~~~~~ ~~~~{.cpp}
Standard_Integer rp = Interface_Static::IVal("write.step.assembly"); Standard_Integer rp = Interface_Static::IVal("write.step.assembly");
~~~~~ ~~~~
Modify this parameter with: Modify this parameter with:
~~~~~ ~~~~{.cpp}
if(!Interface_Static::SetIVal("write.step.assembly",1)) if(!Interface_Static::SetIVal("write.step.assembly",1))
.. error .. .. error ..
~~~~~ ~~~~
Default value is 0. Default value is 0.
<h4>write.step.schema</h4> <h4>write.step.schema</h4>
@ -906,14 +906,14 @@ defines the version of schema used for the output STEP file:
* 5 or *AP242DIS*: AP242, DIS version. * 5 or *AP242DIS*: AP242, DIS version.
Read this parameter with: Read this parameter with:
~~~~~ ~~~~{.cpp}
TCollection_AsciiString schema = Interface_Static::CVal("write.step.schema"); TCollection_AsciiString schema = Interface_Static::CVal("write.step.schema");
~~~~~ ~~~~
Modify this parameter with: Modify this parameter with:
~~~~~ ~~~~{.cpp}
if(!Interface_Static::SetCVal("write.step.schema","DIS")) if(!Interface_Static::SetCVal("write.step.schema","DIS"))
.. error .. .. error ..
~~~~~ ~~~~
Default value is 1 (;CD;). Default value is 1 (;CD;).
For the parameter *write.step.schema* to take effect, method *STEPControl_Writer::Model(Standard_True)* should be called after changing this parameter (corresponding command in DRAW is *newmodel*). For the parameter *write.step.schema* to take effect, method *STEPControl_Writer::Model(Standard_True)* should be called after changing this parameter (corresponding command in DRAW is *newmodel*).
@ -929,14 +929,14 @@ This parameter indicates whether parametric curves (curves in parametric space o
* On (1) : (default) writes pcurves to STEP file * On (1) : (default) writes pcurves to STEP file
Read this parameter with: Read this parameter with:
~~~~~ ~~~~{.cpp}
Standard_Integer wp = Interface_Static::IVal("write.surfacecurve.mode"); Standard_Integer wp = Interface_Static::IVal("write.surfacecurve.mode");
~~~~~ ~~~~
Modify this parameter with: Modify this parameter with:
~~~~~ ~~~~{.cpp}
if(!Interface_Static::SetIVal("write.surfacecurve.mode",1)) if(!Interface_Static::SetIVal("write.surfacecurve.mode",1))
.. error .. .. error ..
~~~~~ ~~~~
Default value is On. Default value is On.
<h4>write.step.unit</h4> <h4>write.step.unit</h4>
@ -959,14 +959,14 @@ This parameter indicates which of free vertices writing mode is switch on.
* 1 (Single Vertex) : Each vertex exported in its own SHAPE DEFINITION REPRESENTATION (vertex name and style are not lost, but size of STEP file increases). * 1 (Single Vertex) : Each vertex exported in its own SHAPE DEFINITION REPRESENTATION (vertex name and style are not lost, but size of STEP file increases).
Read this parameter with: Read this parameter with:
~~~~~ ~~~~{.cpp}
Standard_Integer ic = Interface_Static::IVal("write.step.vertex.mode"); Standard_Integer ic = Interface_Static::IVal("write.step.vertex.mode");
~~~~~ ~~~~
Modify this parameter with: Modify this parameter with:
~~~~~ ~~~~{.cpp}
if(!Interface_Static::SetIVal("write.step.vertex.mode",1)) if(!Interface_Static::SetIVal("write.step.vertex.mode",1))
.. error .. .. error ..
~~~~~ ~~~~
Default value is 0. Default value is 0.
@subsubsection occt_step_3_3_3 Performing the Open CASCADE Technology shape translation @subsubsection occt_step_3_3_3 Performing the Open CASCADE Technology shape translation
@ -995,16 +995,16 @@ The following list shows which shapes can be translated in which mode:
If *TopoDS_Compound* contains any other types besides the ones mentioned in the table, these sub-shapes will be ignored. If *TopoDS_Compound* contains any other types besides the ones mentioned in the table, these sub-shapes will be ignored.
In case if an OCCT shape cannot be translated according to its mode the result of translation is void. In case if an OCCT shape cannot be translated according to its mode the result of translation is void.
~~~~~ ~~~~{.cpp}
STEP214Control_StepModelTope mode = STEP214Control_ManifoldSolidBrep; STEP214Control_StepModelTope mode = STEP214Control_ManifoldSolidBrep;
IFSelect_ReturnStatus stat = writer.Transfer(shape,mode); IFSelect_ReturnStatus stat = writer.Transfer(shape,mode);
~~~~~ ~~~~
@subsubsection occt_step_3_3_4 Writing the STEP file @subsubsection occt_step_3_3_4 Writing the STEP file
Write the STEP file with: Write the STEP file with:
~~~~~ ~~~~{.cpp}
IFSelect_ReturnStatus stat = writer.Write("filename.stp"); IFSelect_ReturnStatus stat = writer.Write("filename.stp");
~~~~~ ~~~~
to give the file name. to give the file name.
@subsection occt_step_3_4 Mapping Open CASCADE Technology shapes to STEP entities @subsection occt_step_3_4 Mapping Open CASCADE Technology shapes to STEP entities
@ -1116,7 +1116,7 @@ The highlighted classes are intended to translate geometry.
@subsection occt_step_3_7 Example @subsection occt_step_3_7 Example
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.cpp} ~~~~{.cpp}
#include <STEPControl.hxx> #include <STEPControl.hxx>
#include <STEPControl_Writer.hxx> #include <STEPControl_Writer.hxx>
#include <TopoDS_Shape.hxx> #include <TopoDS_Shape.hxx>
@ -1136,7 +1136,7 @@ writer.Write(;Output.stp;);
// writes the resulting entity in the STEP file // writes the resulting entity in the STEP file
} }
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~
@section occt_step_4 Physical STEP file reading and writing @section occt_step_4 Physical STEP file reading and writing
@ -1228,9 +1228,9 @@ In the description of commands, square brackets ([]) are used to indicate option
@subsection occt_step_6_2 Setting the interface parameters @subsection occt_step_6_2 Setting the interface parameters
A set of parameters for importing and exporting STEP data is defined in the XSTEP resource file. In XSDRAW, these parameters can be viewed or changed using the command A set of parameters for importing and exporting STEP data is defined in the XSTEP resource file. In XSDRAW, these parameters can be viewed or changed using the command
~~~~~ ~~~~{.php}
Draw:> param [<parameter_name> [<value>]] Draw:> param [<parameter_name> [<value>]]
~~~~~ ~~~~
Command *param* with no arguments gives a list of all parameters with their values. When the argument *parameter_name* is specified, information about this parameter is printed (current value and short description). Command *param* with no arguments gives a list of all parameters with their values. When the argument *parameter_name* is specified, information about this parameter is printed (current value and short description).
The third argument is used to set a new value of the given parameter. The result of the setting is printed immediately. The third argument is used to set a new value of the given parameter. The result of the setting is printed immediately.
@ -1259,14 +1259,14 @@ For reading a STEP file, the following parameters are defined (see above, @ref o
It is possible either only to load a STEP file into memory (i.e. fill the *InterfaceModel* with data from the file), or to read it (i.e. load and convert all entities to OCCT shapes). It is possible either only to load a STEP file into memory (i.e. fill the *InterfaceModel* with data from the file), or to read it (i.e. load and convert all entities to OCCT shapes).
Loading is done by the command Loading is done by the command
~~~~~ ~~~~{.php}
Draw:> xload <file_name> Draw:> xload <file_name>
~~~~~ ~~~~
Once the file is loaded, it is possible to investigate the structure of the loaded data. To find out how you do it, look in the beginning of the analysis subsection. Once the file is loaded, it is possible to investigate the structure of the loaded data. To find out how you do it, look in the beginning of the analysis subsection.
Reading a STEP file is done by the command Reading a STEP file is done by the command
~~~~~ ~~~~{.php}
Draw:> stepread <file_name> <result_shape_name> [selection] Draw:> stepread <file_name> <result_shape_name> [selection]
~~~~~ ~~~~
Here a dot can be used instead of a filename if the file is already loaded by xload or stepread. Here a dot can be used instead of a filename if the file is already loaded by xload or stepread.
The optional selection (see below for a description of selections) specifies a set of entities to be translated. If an asterisk `*' is given, all transferable roots are translated. If a selection is not given, the user is prompted to define a scope of transfer interactively: The optional selection (see below for a description of selections) specifies a set of entities to be translated. If an asterisk `*' is given, all transferable roots are translated. If a selection is not given, the user is prompted to define a scope of transfer interactively:
@ -1301,7 +1301,7 @@ The procedure of analysis of data import can be divided into two stages:
General statistics on the loaded data can be obtained by using the command General statistics on the loaded data can be obtained by using the command
~~~~ ~~~~{.php}
Draw:> data <symbol> Draw:> data <symbol>
~~~~ ~~~~
@ -1333,10 +1333,10 @@ The command *listtypes* gives a list of entity types, which were encountered in
The list cannot be shown for all entities but for a subset of them. This subset is defined by an optional selection argument (for the list of possible values for STEP, see the table above). The list cannot be shown for all entities but for a subset of them. This subset is defined by an optional selection argument (for the list of possible values for STEP, see the table above).
Two commands are used to calculate statistics on the entities in the model: Two commands are used to calculate statistics on the entities in the model:
~~~~~ ~~~~{.php}
Draw:> count <counter> [<selection>] Draw:> count <counter> [<selection>]
Draw:> listcount <counter> [<selection>] Draw:> listcount <counter> [<selection>]
~~~~~ ~~~~
The former only prints a count of entities while the latter also gives a list of them. The former only prints a count of entities while the latter also gives a list of them.
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: 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:
@ -1407,9 +1407,9 @@ For writing shapes to a STEP file, the following parameters are defined (see abo
Several shapes can be written in one file. To start writing a new file, enter command *Draw:> newmodel*. Several shapes can be written in one file. To start writing a new file, enter command *Draw:> newmodel*.
Actually, command *newmodel* will clear the *InterfaceModel* to empty it, and the next command will convert the specified shape to STEP entities and add them to the *InterfaceModel*: Actually, command *newmodel* will clear the *InterfaceModel* to empty it, and the next command will convert the specified shape to STEP entities and add them to the *InterfaceModel*:
~~~~~ ~~~~{.php}
Draw:> stepwrite <mode> <shape_name> [<file_name>] Draw:> stepwrite <mode> <shape_name> [<file_name>]
~~~~~ ~~~~
The following modes are available : The following modes are available :
* *a* -- "as is" -- the mode is selected automatically depending on the type & geometry of the shape; * *a* -- "as is" -- the mode is selected automatically depending on the type & geometry of the shape;
@ -1419,10 +1419,10 @@ The following modes are available :
* *s* -- *shell_based_surface_model* * *s* -- *shell_based_surface_model*
After a successful translation, if *file_name* parameter is not specified, the procedure asks you whether to write a STEP model in the file or not: After a successful translation, if *file_name* parameter is not specified, the procedure asks you whether to write a STEP model in the file or not:
~~~~~ ~~~~{.php}
execution status : 1 execution status : 1
Mode (0 end, 1 file) : Mode (0 end, 1 file) :
~~~~~ ~~~~
It is necessary to call command *newmodel* to perform a new translation of the next OCCT shape. It is necessary to call command *newmodel* to perform a new translation of the next OCCT shape.
@section occt_step_7 Reading from and writing to STEP @section occt_step_7 Reading from and writing to STEP
@ -1441,10 +1441,10 @@ In addition to the translation of shapes implemented in basic translator, it pro
### Load a STEP file ### Load a STEP file
Before performing any other operation, you must load a STEP file with: Before performing any other operation, you must load a STEP file with:
~~~~~ ~~~~{.cpp}
STEPCAFControl_Reader reader(XSDRAW::Session(), Standard_False); STEPCAFControl_Reader reader(XSDRAW::Session(), Standard_False);
IFSelect_ReturnStatus stat = reader.ReadFile("filename.stp"); IFSelect_ReturnStatus stat = reader.ReadFile("filename.stp");
~~~~~ ~~~~
Loading the file only memorizes the data, it does not translate it. Loading the file only memorizes the data, it does not translate it.
### Check the loaded STEP file ### Check the loaded STEP file
@ -1456,22 +1456,22 @@ See a description of this step in section @ref occt_step_2_3_3 "Setting the tran
In addition, the following parameters can be set for XDE translation of attributes: In addition, the following parameters can be set for XDE translation of attributes:
* Parameter for transferring colors: * Parameter for transferring colors:
~~~~~ ~~~~{.cpp}
reader.SetColorMode(mode); reader.SetColorMode(mode);
// mode can be Standard_True or Standard_False // mode can be Standard_True or Standard_False
~~~~~ ~~~~
* Parameter for transferring names: * Parameter for transferring names:
~~~~~ ~~~~{.cpp}
reader.SetNameMode(mode); reader.SetNameMode(mode);
// mode can be Standard_True or Standard_False // mode can be Standard_True or Standard_False
~~~~~ ~~~~
### Translate a STEP file to XDE ### Translate a STEP file to XDE
The following function performs a translation of the whole document: The following function performs a translation of the whole document:
~~~~~ ~~~~{.cpp}
Standard_Boolean ok = reader.Transfer(doc); Standard_Boolean ok = reader.Transfer(doc);
~~~~~ ~~~~
where *doc* is a variable which contains a handle to the output document and should have a type *Handle(TDocStd_Document)*. where *doc* is a variable which contains a handle to the output document and should have a type *Handle(TDocStd_Document)*.
@ -1585,42 +1585,42 @@ For each Saved View OCCT STEP Reader will retrieve the following attributes:
@subsection occt_step_7_3 Writing to STEP @subsection occt_step_7_3 Writing to STEP
The translation from XDE to STEP can be initialized as follows: The translation from XDE to STEP can be initialized as follows:
~~~~~ ~~~~{.cpp}
STEPCAFControl_Writer aWriter(XSDRAW::Session(),Standard_False); STEPCAFControl_Writer aWriter(XSDRAW::Session(),Standard_False);
~~~~~ ~~~~
### Set parameters for translation from XDE to STEP ### Set parameters for translation from XDE to STEP
The following parameters can be set for a translation of attributes to STEP: The following parameters can be set for a translation of attributes to STEP:
* For transferring colors: * For transferring colors:
~~~~~ ~~~~{.cpp}
aWriter.SetColorMode(mode); aWriter.SetColorMode(mode);
// mode can be Standard_True or Standard_False // mode can be Standard_True or Standard_False
~~~~~ ~~~~
* For transferring names: * For transferring names:
~~~~~ ~~~~{.cpp}
aWriter.SetNameMode(mode); aWriter.SetNameMode(mode);
// mode can be Standard_True or Standard_False // mode can be Standard_True or Standard_False
~~~~~ ~~~~
### Translate an XDE document to STEP ### Translate an XDE document to STEP
You can perform the translation of document by calling the function: You can perform the translation of document by calling the function:
~~~~~ ~~~~{.cpp}
IFSelect_ReturnStatus aRetSt = aWriter.Transfer(doc); IFSelect_ReturnStatus aRetSt = aWriter.Transfer(doc);
~~~~~ ~~~~
where *doc* is a variable, which contains a handle to the input document for transferring and should have a type *Handle(TDocStd_Document)*. where *doc* is a variable, which contains a handle to the input document for transferring and should have a type *Handle(TDocStd_Document)*.
### Write a STEP file ### Write a STEP file
Write a STEP file with: Write a STEP file with:
~~~~~ ~~~~{.cpp}
IFSelect_ReturnStatus statw = aWriter.WriteFile("filename.stp"); IFSelect_ReturnStatus statw = aWriter.WriteFile("filename.stp");
~~~~~ ~~~~
or or
~~~~~ ~~~~{.cpp}
IFSelect_ReturnStatus statw = writer.WriteFile (S); IFSelect_ReturnStatus statw = writer.WriteFile (S);
~~~~~ ~~~~
where *S* is *OStream*. where *S* is *OStream*.
@subsection occt_step_7_4 Attributes written to STEP @subsection occt_step_7_4 Attributes written to STEP
@ -1649,13 +1649,13 @@ All entities, which can be imported from STEP, can be exported too.
See the same item in section @ref occt_step_7_1 "Reading from STEP" to find more information. See the same item in section @ref occt_step_7_1 "Reading from STEP" to find more information.
Note: OCCT use AP214 by default, so for GD&T exporting AP242 should be set manually: Note: OCCT use AP214 by default, so for GD&T exporting AP242 should be set manually:
~~~~~ ~~~~{.cpp}
Interface_Static::SetCVal("write.step.schema", "AP242DIS")); Interface_Static::SetCVal("write.step.schema", "AP242DIS"));
~~~~~ ~~~~
or or
~~~~~ ~~~~{.cpp}
Interface_Static::SetIVal("write.step.schema", 5)); Interface_Static::SetIVal("write.step.schema", 5));
~~~~~ ~~~~
### Saved views ### Saved views
Saved Views are not exported by OCCT. Saved Views are not exported by OCCT.

70
dox/user_guides/vis/vis.md
View File

@ -75,7 +75,7 @@ Additionally, *IVtkTools* package contains auxiliary methods in *IVtkTools* name
To visualize an OCCT topological shape in VTK viewer, it is necessary to perform the following steps: To visualize an OCCT topological shape in VTK viewer, it is necessary to perform the following steps:
1. Create *IVtkOCC_Shape* instance (VIS wrapper for OCCT shape) and initialize it with *TopoDS_Shape* object containing the actual geometry: 1. Create *IVtkOCC_Shape* instance (VIS wrapper for OCCT shape) and initialize it with *TopoDS_Shape* object containing the actual geometry:
~~~~ ~~~~{.cpp}
TopoDS_Shape aShape; TopoDS_Shape aShape;
// Initialize aShape variable: e.g. load it from BREP file // Initialize aShape variable: e.g. load it from BREP file
@ -83,13 +83,13 @@ TopoDS_Shape aShape;
IVtkOCC_Shape::Handle aShapeImpl = new IVtkOCC_Shape(aShape); IVtkOCC_Shape::Handle aShapeImpl = new IVtkOCC_Shape(aShape);
~~~~ ~~~~
2. Create VTK polygonal data source for the target OCCT topological shape and initialize it with created *IVtkOCC_Shape* instance. At this stage the faceter is implicitly plugged: 2. Create VTK polygonal data source for the target OCCT topological shape and initialize it with created *IVtkOCC_Shape* instance. At this stage the faceter is implicitly plugged:
~~~~ ~~~~{.cpp}
vtkSmartPointer<IVtkTools_ShapeDataSource> DS = vtkSmartPointer<IVtkTools_ShapeDataSource>::New(); vtkSmartPointer<IVtkTools_ShapeDataSource> DS = vtkSmartPointer<IVtkTools_ShapeDataSource>::New();
DS->SetShape(aShapeImpl); DS->SetShape(aShapeImpl);
~~~~ ~~~~
3. Visualize the loaded shape in usual VTK way starting a pipeline from the newly created specific source: 3. Visualize the loaded shape in usual VTK way starting a pipeline from the newly created specific source:
~~~~ ~~~~{.cpp}
vtkSmartPointer<vtkPolyDataMapper> Mapper = vtkSmartPointer<vtkPolyDataMapper>::New(); vtkSmartPointer<vtkPolyDataMapper> Mapper = vtkSmartPointer<vtkPolyDataMapper>::New();
Mapper->SetInputConnection(aDS->GetOutputPort()); Mapper->SetInputConnection(aDS->GetOutputPort());
@ -99,14 +99,14 @@ Actor->SetMapper(Mapper);
~~~~ ~~~~
It is always possible to access the shape data source from VTK actor by means of dedicated methods from *IVtkTools_ShapeObject* class: It is always possible to access the shape data source from VTK actor by means of dedicated methods from *IVtkTools_ShapeObject* class:
~~~~ ~~~~{.cpp}
IVtkTools_ShapeDataSource* DS = IVtkTools_ShapeObject::GetShapeSource(Actor); IVtkTools_ShapeDataSource* DS = IVtkTools_ShapeObject::GetShapeSource(Actor);
IVtkOCC_Shape::Handle occShape = IVtkTools_ShapeObject::GetOccShape(Actor); IVtkOCC_Shape::Handle occShape = IVtkTools_ShapeObject::GetOccShape(Actor);
~~~~ ~~~~
It is also possible to get a shape wrapper from the shape data source: It is also possible to get a shape wrapper from the shape data source:
~~~~ ~~~~{.cpp}
IVtkOCC_Shape::Handle occShape = DS->GetShape(); IVtkOCC_Shape::Handle occShape = DS->GetShape();
~~~~ ~~~~
@ -115,26 +115,26 @@ IVtkOCC_Shape::Handle occShape = DS->GetShape();
To colorize different parts of a shape according to the default OCCT color scheme, it is possible to configure the corresponding VTK mapper using a dedicated auxiliary function of *IVtkTools* namespace: To colorize different parts of a shape according to the default OCCT color scheme, it is possible to configure the corresponding VTK mapper using a dedicated auxiliary function of *IVtkTools* namespace:
~~~~ ~~~~{.cpp}
IVtkTools::InitShapeMapper(Mapper); IVtkTools::InitShapeMapper(Mapper);
~~~~ ~~~~
It is possible to get an instance of *vtkLookupTable class* with a default OCCT color scheme by means of the following method: It is possible to get an instance of *vtkLookupTable class* with a default OCCT color scheme by means of the following method:
~~~~ ~~~~{.cpp}
vtkSmartPointer<vtkLookupTable> Table = IVtkTools::InitLookupTable(); vtkSmartPointer<vtkLookupTable> Table = IVtkTools::InitLookupTable();
~~~~ ~~~~
@subsubsection occt_vis_3_2_2 Custom color scheme @subsubsection occt_vis_3_2_2 Custom color scheme
To set up application-specific colors for a shape presentation, use *InitShapeMapper* function with an additional argument passing a custom lookup table: To set up application-specific colors for a shape presentation, use *InitShapeMapper* function with an additional argument passing a custom lookup table:
~~~~ ~~~~{.cpp}
IVtkTools::InitShapeMapper(Mapper, Table); IVtkTools::InitShapeMapper(Mapper, Table);
~~~~ ~~~~
@subsubsection occt_vis_3_2_3 Setting custom colors for sub-shapes @subsubsection occt_vis_3_2_3 Setting custom colors for sub-shapes
It is also possible to bind custom colors to any sub-shape type listed in *IVtk_MeshType* enumeration. For example, to access the color bound to *free edge* entities, the following calls are available in *IVtkTools* namespace: It is also possible to bind custom colors to any sub-shape type listed in *IVtk_MeshType* enumeration. For example, to access the color bound to *free edge* entities, the following calls are available in *IVtkTools* namespace:
~~~~ ~~~~{.cpp}
SetLookupTableColor(aLookupTable, MT_FreeEdge, R, G, B); SetLookupTableColor(aLookupTable, MT_FreeEdge, R, G, B);
SetLookupTableColor(aLookupTable, MT_FreeEdge, R, G, B, A); SetLookupTableColor(aLookupTable, MT_FreeEdge, R, G, B, A);
GetLookupTableColor(aLookupTable, MT_FreeEdge, R, G, B); GetLookupTableColor(aLookupTable, MT_FreeEdge, R, G, B);
@ -146,7 +146,7 @@ Here *R, G, B* are double values of red, green and blue components of a color fr
As VTK color mapping approach is based on associating scalar data arrays to VTK cells, the coloring of shape components can be turned on/off in the following way: As VTK color mapping approach is based on associating scalar data arrays to VTK cells, the coloring of shape components can be turned on/off in the following way:
~~~~ ~~~~{.cpp}
Mapper->ScalarVisibilityOn(); // use colors from lookup table Mapper->ScalarVisibilityOn(); // use colors from lookup table
Mapper->ScalarVisibilityOff(); // use a color of actor’s property Mapper->ScalarVisibilityOff(); // use a color of actor’s property
~~~~ ~~~~
@ -160,7 +160,7 @@ The output of the shape data source can be presented in wireframe or shading dis
For example, the shading representation can be obtained in the following way: For example, the shading representation can be obtained in the following way:
~~~~ ~~~~{.cpp}
vtkSmartPointer<IVtkTools_ShapeDataSource> DS = vtkSmartPointer<IVtkTools_ShapeDataSource>::New(); vtkSmartPointer<IVtkTools_ShapeDataSource> DS = vtkSmartPointer<IVtkTools_ShapeDataSource>::New();
vtkSmartPointer<IVtkTools_DisplayModeFilter> DMFilter = vtkSmartPointer<IVtkTools_DisplayModeFilter>::New(); vtkSmartPointer<IVtkTools_DisplayModeFilter> DMFilter = vtkSmartPointer<IVtkTools_DisplayModeFilter>::New();
@ -181,57 +181,57 @@ TIP: to make the shading representation smooth, use additional *vtkPolyDataNorma
@subsection occt_vis_3_4 Interactive selection @subsection occt_vis_3_4 Interactive selection
*IVtkTools* package provides *IVtkTools_ShapePicker* class to perform selection of OCCT shapes and sub-shapes in VTK viewer and access the picking results. The typical usage of *IVtkTools_ShapePicker* tool consists in the following sequence of actions: *IVtkTools* package provides *IVtkTools_ShapePicker* class to perform selection of OCCT shapes and sub-shapes in VTK viewer and access the picking results. The typical usage of *IVtkTools_ShapePicker* tool consists in the following sequence of actions:
1. Create a picker and set its renderer to your active VTK renderer: 1. Create a picker and set its renderer to your active VTK renderer:
~~~~ ~~~~{.cpp}
vtkSmartPointer<IVtkTools_ShapePicker> aPicker = vtkSmartPointer<IVtkTools_ShapePicker>::New(); vtkSmartPointer<IVtkTools_ShapePicker> aPicker = vtkSmartPointer<IVtkTools_ShapePicker>::New();
aPicker->SetRenderer(aRenderer); aPicker->SetRenderer(aRenderer);
~~~~ ~~~~
2. Activate the desired selection mode by choosing the corresponding sub-shape types from *IVtk_SelectionMode* enumeration. For example, the following call allows selection of edges on all selectable shape actors of the renderer: 2. Activate the desired selection mode by choosing the corresponding sub-shape types from *IVtk_SelectionMode* enumeration. For example, the following call allows selection of edges on all selectable shape actors of the renderer:
~~~~ ~~~~{.cpp}
aPicker->SetSelectionMode(SM_Edge); aPicker->SetSelectionMode(SM_Edge);
~~~~ ~~~~
If it is necessary to limit selection by a particular shape actor, one can use the mentioned *SetSelectionMode* method with *IVtk_IShape* handle or *vtkActor* pointer as the first argument: If it is necessary to limit selection by a particular shape actor, one can use the mentioned *SetSelectionMode* method with *IVtk_IShape* handle or *vtkActor* pointer as the first argument:
~~~~ ~~~~{.cpp}
IVtk_IShape::Handle aShape = new IVtkOCC_Shape(occShape); IVtk_IShape::Handle aShape = new IVtkOCC_Shape(occShape);
aPicker->SetSelectionMode(aShape, SM_Edge); // If shape handle is available aPicker->SetSelectionMode(aShape, SM_Edge); // If shape handle is available
aPicker->SetSelectionMode(anActor, SM_Edge); // If shape actor is available aPicker->SetSelectionMode(anActor, SM_Edge); // If shape actor is available
~~~~ ~~~~
Different selection modes can be turned on/off for a picker at the same time independently from each other. Different selection modes can be turned on/off for a picker at the same time independently from each other.
~~~~ ~~~~{.cpp}
aPicker->SetSelectionMode(SM_Edge); aPicker->SetSelectionMode(SM_Edge);
aPicker->SetSelectionMode(SM_Face); aPicker->SetSelectionMode(SM_Face);
~~~~ ~~~~
To turn off a selection mode, the additional optional Boolean parameter is used with *false* value, for example: To turn off a selection mode, the additional optional Boolean parameter is used with *false* value, for example:
~~~~ ~~~~{.cpp}
aPicker->SetSelectionMode(aShape, SM_Edge, false); aPicker->SetSelectionMode(aShape, SM_Edge, false);
~~~~ ~~~~
3. Call *Pick* method passing the mouse display coordinates: 3. Call *Pick* method passing the mouse display coordinates:
~~~~ ~~~~{.cpp}
aPicker->Pick(x, y, 0); aPicker->Pick(x, y, 0);
~~~~ ~~~~
By default, the renderer passed in the step 1 is used. In order to perform pick operation for another renderer an additional optional parameter can be specified: By default, the renderer passed in the step 1 is used. In order to perform pick operation for another renderer an additional optional parameter can be specified:
~~~~ ~~~~{.cpp}
aPicker->Pick(x, y, 0, aRenderer); aPicker->Pick(x, y, 0, aRenderer);
~~~~ ~~~~
4. Obtain the top-level picking results as a collection of picked VTK actors: 4. Obtain the top-level picking results as a collection of picked VTK actors:
~~~~ ~~~~{.cpp}
vtkActorCollection* anActorCollection = aPicker->GetPickedActors(); vtkActorCollection* anActorCollection = aPicker->GetPickedActors();
~~~~ ~~~~
or as a collection of picked shape IDs: or as a collection of picked shape IDs:
~~~~ ~~~~{.cpp}
IVtk_ShapeIdList ids = aPicker->GetPickedShapesIds(); IVtk_ShapeIdList ids = aPicker->GetPickedShapesIds();
~~~~ ~~~~
These methods return a single top picked actor or a shape by default. To get all the picked actors or shapes it is necessary to send “true” value in the optional Boolean parameter: These methods return a single top picked actor or a shape by default. To get all the picked actors or shapes it is necessary to send “true” value in the optional Boolean parameter:
~~~~ ~~~~{.cpp}
anActorCollection = aPicker->GetPickedActors(true); anActorCollection = aPicker->GetPickedActors(true);
ids = aPicker->GetPickedShapesIds(true); ids = aPicker->GetPickedShapesIds(true);
~~~~ ~~~~
5. Obtain the picked sub-shape IDs: 5. Obtain the picked sub-shape IDs:
~~~~ ~~~~{.cpp}
IVtk_ShapeIdList subShapeIds = aPicker->GetPickedSubShapesIds(shapeId); IVtk_ShapeIdList subShapeIds = aPicker->GetPickedSubShapesIds(shapeId);
~~~~ ~~~~
This method also returns a single ID of a top-level picked sub-shape and has the same optional Boolean parameter to get all the picked sub-shapes of a shape: This method also returns a single ID of a top-level picked sub-shape and has the same optional Boolean parameter to get all the picked sub-shapes of a shape:
~~~~ ~~~~{.cpp}
subShapeIds = aPicker->GetPickedSubShapesIds(shapeId, true); subShapeIds = aPicker->GetPickedSubShapesIds(shapeId, true);
~~~~ ~~~~
@ -249,7 +249,7 @@ WARNING: VIS picker essentially works on the initial topological data structures
For example, sub-shapes can be represented in VTK viewer in the following way: For example, sub-shapes can be represented in VTK viewer in the following way:
~~~~ ~~~~{.cpp}
// Load a shape into data source (see 3.1) // Load a shape into data source (see 3.1)
... ...
vtkSmartPointer<IVtkTools_ShapeDataSource> DS = vtkSmartPointer<IVtkTools_ShapeDataSource>::New(); vtkSmartPointer<IVtkTools_ShapeDataSource> DS = vtkSmartPointer<IVtkTools_ShapeDataSource>::New();
@ -286,7 +286,7 @@ The low-level scenario of VIS usage in VTK pipeline is shown in the figure below
The visualization pipeline for OCCT shape presentation can be initialized as follows: The visualization pipeline for OCCT shape presentation can be initialized as follows:
1. Create an instance of *IShape* class initialized by OCCT topological shape: 1. Create an instance of *IShape* class initialized by OCCT topological shape:
~~~~ ~~~~{.cpp}
TopoDS_Shape aShape; TopoDS_Shape aShape;
// Load or create a TopoDS_Shape in the variable a Shape // Load or create a TopoDS_Shape in the variable a Shape
@ -294,15 +294,15 @@ TopoDS_Shape aShape;
IVtkOCC_Shape::Handle aShapeImpl = new IVtkOCC_Shape(aShape); IVtkOCC_Shape::Handle aShapeImpl = new IVtkOCC_Shape(aShape);
~~~~ ~~~~
2. Create an empty instance of IShapeData implementation for VTK: 2. Create an empty instance of IShapeData implementation for VTK:
~~~~ ~~~~{.cpp}
IVtk_IShapeData::Handle aDataImpl = new IVtkVTK_ShapeData(); IVtk_IShapeData::Handle aDataImpl = new IVtkVTK_ShapeData();
~~~~ ~~~~
3 Create an instance of *IShapeMesher* implementation for OCCT (any faceter can be used at this stage): 3 Create an instance of *IShapeMesher* implementation for OCCT (any faceter can be used at this stage):
~~~~ ~~~~{.cpp}
IVtk_IShapeMesher::Handle aMesher = new IVtkOCC_ShapeMesher(); IVtk_IShapeMesher::Handle aMesher = new IVtkOCC_ShapeMesher();
~~~~ ~~~~
4 Triangulate the OCCT topological shape by means of the Mesher and access the result: 4 Triangulate the OCCT topological shape by means of the Mesher and access the result:
~~~~ ~~~~{.cpp}
aMesher->Build (aShapeImpl, aDataImpl); aMesher->Build (aShapeImpl, aDataImpl);
vtkPolyData* aPolyData = aDataImpl->GetVtkPolyData(); vtkPolyData* aPolyData = aDataImpl->GetVtkPolyData();
@ -323,17 +323,17 @@ Picking algorithm uses an instance of viewer selector (OCCT term), which manage
The typical usage of *IVtk_IShapePickerAlgo* consists in the following sequence of actions: The typical usage of *IVtk_IShapePickerAlgo* consists in the following sequence of actions:
1. Create an instance of the picker class: 1. Create an instance of the picker class:
~~~~ ~~~~{.cpp}
IVtkOCC_ShapePickerAlgo::Handle Picker = new IVtkOCC_ShapePickerAlgo(); IVtkOCC_ShapePickerAlgo::Handle Picker = new IVtkOCC_ShapePickerAlgo();
~~~~ ~~~~
2. Set an instance of *IVtk_IView* class to the algorithm in order to define the viewer parameters: 2. Set an instance of *IVtk_IView* class to the algorithm in order to define the viewer parameters:
~~~~ ~~~~{.cpp}
IVtkVTK_View::Handle View = new IVtkVTK_View(Renderer); IVtkVTK_View::Handle View = new IVtkVTK_View(Renderer);
Picker->SetView(View); Picker->SetView(View);
~~~~ ~~~~
3. Activate the desired selection modes using values from *IVtk_SelectionMode* enumeration. For example, the following call allows selection of edges: 3. Activate the desired selection modes using values from *IVtk_SelectionMode* enumeration. For example, the following call allows selection of edges:
~~~~ ~~~~{.cpp}
TopoDS_Shape aShape; TopoDS_Shape aShape;
// Load or create a TopoDS_Shape in the variable a Shape // Load or create a TopoDS_Shape in the variable a Shape
... ...
@ -343,19 +343,19 @@ myOccPickerAlgo->SetSelectionMode(occShape, SM_Edge);
~~~~ ~~~~
Different selection modes can be turned on/off for a picker at the same time independently from each other. Different selection modes can be turned on/off for a picker at the same time independently from each other.
To turn off a selection mode the additional optional Boolean parameter is used with *false* value, for example: To turn off a selection mode the additional optional Boolean parameter is used with *false* value, for example:
~~~~ ~~~~{.cpp}
myOccPickerAlgo->SetSelectionMode(occShape, SM_Edge, false); myOccPickerAlgo->SetSelectionMode(occShape, SM_Edge, false);
~~~~ ~~~~
4. Call *Pick* method passing the mouse coordinates: 4. Call *Pick* method passing the mouse coordinates:
~~~~ ~~~~{.cpp}
myOccPickerAlgo->Pick(x, y); myOccPickerAlgo->Pick(x, y);
~~~~ ~~~~
5. Obtain top-level picking results as IDs of the picked top-level shapes: 5. Obtain top-level picking results as IDs of the picked top-level shapes:
~~~~ ~~~~{.cpp}
IVtk_ShapeIdList ids = myOccPickerAlgo->ShapesPicked(); IVtk_ShapeIdList ids = myOccPickerAlgo->ShapesPicked();
~~~~ ~~~~
6. Obtain IDs of the picked sub-shapes: 6. Obtain IDs of the picked sub-shapes:
~~~~ ~~~~{.cpp}
IVtk_ShapeIdList subShapeIds IVtk_ShapeIdList subShapeIds
= myOccPickerAlgo->SubShapesPicked(shapeId); = myOccPickerAlgo->SubShapesPicked(shapeId);
~~~~ ~~~~

248
dox/user_guides/visualization/visualization.md
View File

@ -107,7 +107,7 @@ Additional packages, such as *Prs3d* and *Graphic3d* may be used if you need to
@subsubsection occt_visu_2_1_3 A Basic Example: How to display a 3D object @subsubsection occt_visu_2_1_3 A Basic Example: How to display a 3D object
~~~~~{.cpp} ~~~~{.cpp}
Handle(V3d_Viewer) theViewer; Handle(V3d_Viewer) theViewer;
Handle(AIS_InteractiveContext) aContext = new AIS_InteractiveContext (theViewer); Handle(AIS_InteractiveContext) aContext = new AIS_InteractiveContext (theViewer);
@ -115,7 +115,7 @@ BRepPrimAPI_MakeWedge aWedgeMaker (theWedgeDX, theWedgeDY, theWedgeDZ, theWedgeL
TopoDS_Solid aShape = aWedgeMaker.Solid(); TopoDS_Solid aShape = aWedgeMaker.Solid();
Handle(AIS_Shape) aShapePrs = new AIS_Shape (aShape); // creation of the presentable object Handle(AIS_Shape) aShapePrs = new AIS_Shape (aShape); // creation of the presentable object
aContext->Display (aShapePrs, AIS_Shaded, 0, true); // display the presentable object and redraw 3d viewer aContext->Display (aShapePrs, AIS_Shaded, 0, true); // display the presentable object and redraw 3d viewer
~~~~~ ~~~~
The shape is created using the *BRepPrimAPI_MakeWedge* command. The shape is created using the *BRepPrimAPI_MakeWedge* command.
An *AIS_Shape* is then created from the shape. An *AIS_Shape* is then created from the shape.
@ -450,7 +450,7 @@ After these steps, the selection manager of the created interactive context will
The code snippet below illustrates the above steps. The code snippet below illustrates the above steps.
It also contains the code to start the detection procedure and parse the results of selection. It also contains the code to start the detection procedure and parse the results of selection.
~~~~~{.cpp} ~~~~{.cpp}
// Suppose there is an instance of class InteractiveBox from the previous sample. // Suppose there is an instance of class InteractiveBox from the previous sample.
// It contains an implementation of method InteractiveBox::ComputeSelection() for selection // It contains an implementation of method InteractiveBox::ComputeSelection() for selection
// modes 0 (whole box must be selected) and 1 (edge of the box must be selectable) // modes 0 (whole box must be selected) and 1 (edge of the box must be selectable)
@ -478,7 +478,7 @@ for (theContext->InitSelected(); theContext->MoreSelected() && !aHasSelected; th
// deactivate all selection modes for aBox1 // deactivate all selection modes for aBox1
theContext->Deactivate (aBox1); theContext->Deactivate (aBox1);
~~~~~ ~~~~
It is also important to know, that there are 2 types of detection implemented for rectangular selection in OCCT: It is also important to know, that there are 2 types of detection implemented for rectangular selection in OCCT:
- <b>inclusive</b> detection. - <b>inclusive</b> detection.
@ -489,14 +489,14 @@ It is also important to know, that there are 2 types of detection implemented fo
The standard OCCT selection mechanism uses inclusion detection by default. The standard OCCT selection mechanism uses inclusion detection by default.
To change this, use the following code: To change this, use the following code:
~~~~~{.cpp} ~~~~{.cpp}
// Assume there is a created interactive context // Assume there is a created interactive context
const Handle(AIS_InteractiveContext) theContext; const Handle(AIS_InteractiveContext) theContext;
// Retrieve the current viewer selector // Retrieve the current viewer selector
const Handle(StdSelect_ViewerSelector3d)& aMainSelector = theContext->MainSelector(); const Handle(StdSelect_ViewerSelector3d)& aMainSelector = theContext->MainSelector();
// Set the flag to allow overlap detection // Set the flag to allow overlap detection
aMainSelector->AllowOverlapDetection (true); aMainSelector->AllowOverlapDetection (true);
~~~~~ ~~~~
@section occt_visu_3 Application Interactive Services @section occt_visu_3 Application Interactive Services
@subsection occt_visu_3_1 Introduction @subsection occt_visu_3_1 Introduction
@ -550,18 +550,18 @@ If you are creating your own type of interactive object, you must implement the
#### For 3D: #### For 3D:
~~~~~{.cpp} ~~~~{.cpp}
void PackageName_ClassName::Compute (const Handle(PrsMgr_PresentationManager)& thePresentationManager, void PackageName_ClassName::Compute (const Handle(PrsMgr_PresentationManager)& thePresentationManager,
const Handle(Prs3d_Presentation)& thePresentation, const Handle(Prs3d_Presentation)& thePresentation,
const Standard_Integer theMode); const Standard_Integer theMode);
~~~~~ ~~~~
#### For hidden line removal (HLR) mode in 3D: #### For hidden line removal (HLR) mode in 3D:
~~~~~{.cpp} ~~~~{.cpp}
void PackageName_ClassName::Compute (const Handle(Prs3d_Projector)& theProjector, void PackageName_ClassName::Compute (const Handle(Prs3d_Projector)& theProjector,
const Handle(Prs3d_Presentation)& thePresentation); const Handle(Prs3d_Presentation)& thePresentation);
~~~~~ ~~~~
@subsubsection occt_visu_3_2_2 Hidden Line Removal @subsubsection occt_visu_3_2_2 Hidden Line Removal
@ -641,7 +641,7 @@ you can cancel its "infinite" status using *AIS_InteractiveObject::SetInfiniteSt
Let us take for example the class called *IShape* representing an interactive object: Let us take for example the class called *IShape* representing an interactive object:
~~~~~{.cpp} ~~~~{.cpp}
myPk_IShape::myPk_IShape (const TopoDS_Shape& theShape, PrsMgr_TypeOfPresentation theType) myPk_IShape::myPk_IShape (const TopoDS_Shape& theShape, PrsMgr_TypeOfPresentation theType)
: AIS_InteractiveObject (theType), myShape (theShape) { SetHilightMode (0); } : AIS_InteractiveObject (theType), myShape (theShape) { SetHilightMode (0); }
@ -669,7 +669,7 @@ void myPk_IShape::Compute (const Handle(Prs3d_Projector)& theProjector,
// Hidden line mode calculation algorithm // Hidden line mode calculation algorithm
StdPrs_HLRPolyShape::Add (thePrs, myShape, myDrawer, theProjector); StdPrs_HLRPolyShape::Add (thePrs, myShape, myDrawer, theProjector);
} }
~~~~~ ~~~~
@subsubsection occt_visu_3_2_4 Selection @subsubsection occt_visu_3_2_4 Selection
@ -804,14 +804,14 @@ Instances can be controlled by the following DRAW commands:
* *vlistconnected* : Lists objects in the assembly. * *vlistconnected* : Lists objects in the assembly.
Have a look at the examples below: Have a look at the examples below:
~~~~~ ~~~~{.php}
pload MODELING VISUALIZATION pload MODELING VISUALIZATION
vinit vinit
psphere s 1 psphere s 1
vdisplay s vdisplay s
vconnectto s2 3 0 0 s # make instance vconnectto s2 3 0 0 s # make instance
vfit vfit
~~~~~ ~~~~
See how proxy *OpenGl_Structure* is used to represent instance: See how proxy *OpenGl_Structure* is used to represent instance:
@ -820,7 +820,7 @@ See how proxy *OpenGl_Structure* is used to represent instance:
The original object does not have to be displayed in order to make instance. The original object does not have to be displayed in order to make instance.
Also selection handles transformations of instances correctly: Also selection handles transformations of instances correctly:
~~~~~ ~~~~{.php}
pload MODELING VISUALIZATION pload MODELING VISUALIZATION
vinit vinit
psphere s 1 psphere s 1
@ -829,13 +829,13 @@ vdisplay s # p is not displayed
vsetloc s -2 0 0 vsetloc s -2 0 0
vconnect x 3 0 0 s p # make assembly vconnect x 3 0 0 s p # make assembly
vfit vfit
~~~~~ ~~~~
@figure{/user_guides/visualization/images/visualization_image030.png,"",420} @figure{/user_guides/visualization/images/visualization_image030.png,"",420}
Here is the example of a more complex hierarchy involving sub-assemblies: Here is the example of a more complex hierarchy involving sub-assemblies:
~~~~~ ~~~~{.php}
pload MODELING VISUALIZATION pload MODELING VISUALIZATION
vinit vinit
box b 1 1 1 box b 1 1 1
@ -851,7 +851,7 @@ vconnect z 2 0 0 b s
vconnect z2 4 0 0 d d2 vconnect z2 4 0 0 d d2
vconnect z3 6 0 0 z z2 vconnect z3 6 0 0 z z2
vfit vfit
~~~~~ ~~~~
@subsection occt_visu_3_3 Interactive Context @subsection occt_visu_3_3 Interactive Context
@ -863,20 +863,20 @@ Most functions which allow modifying the attributes of interactive objects, and
There is one essential rule to follow: the modification of an interactive object, which is already known by the Context, must be done using Context functions. There is one essential rule to follow: the modification of an interactive object, which is already known by the Context, must be done using Context functions.
You can only directly call the functions available for an interactive object if it has not been loaded into an Interactive Context. You can only directly call the functions available for an interactive object if it has not been loaded into an Interactive Context.
~~~~~{.cpp} ~~~~{.cpp}
Handle(AIS_Shape) aShapePrs = new AIS_Shape (theShape); Handle(AIS_Shape) aShapePrs = new AIS_Shape (theShape);
myIntContext->Display (aShapePrs, AIS_Shaded, 0, false, aShapePrs->AcceptShapeDecomposition()); myIntContext->Display (aShapePrs, AIS_Shaded, 0, false, aShapePrs->AcceptShapeDecomposition());
myIntContext->SetColor(aShapePrs, Quantity_NOC_RED); myIntContext->SetColor(aShapePrs, Quantity_NOC_RED);
~~~~~ ~~~~
You can also write You can also write
~~~~~{.cpp} ~~~~{.cpp}
Handle(AIS_Shape) aShapePrs = new AIS_Shape (theShape); Handle(AIS_Shape) aShapePrs = new AIS_Shape (theShape);
aShapePrs->SetColor (Quantity_NOC_RED); aShapePrs->SetColor (Quantity_NOC_RED);
aShapePrs->SetDisplayMode (AIS_Shaded); aShapePrs->SetDisplayMode (AIS_Shaded);
myIntContext->Display (aShapePrs); myIntContext->Display (aShapePrs);
~~~~~ ~~~~
@subsubsection occt_visu_3_3_2 Groups of functions @subsubsection occt_visu_3_3_2 Groups of functions
@ -903,14 +903,14 @@ When you change a graphic attribute pertaining to the Context (visualization mod
Let us examine the case of two interactive objects: *theObj1* and *theObj2*: Let us examine the case of two interactive objects: *theObj1* and *theObj2*:
~~~~~{.cpp} ~~~~{.cpp}
theCtx->Display (theObj1, false); theCtx->Display (theObj1, false);
theCtx->Display (theObj2, true); // TRUE for viewer update theCtx->Display (theObj2, true); // TRUE for viewer update
theCtx->SetDisplayMode (theObj1, 3, false); theCtx->SetDisplayMode (theObj1, 3, false);
theCtx->SetDisplayMode (2, true); theCtx->SetDisplayMode (2, true);
// theObj2 is visualized in mode 2 (if it accepts this mode) // theObj2 is visualized in mode 2 (if it accepts this mode)
// theObj1 stays visualized in its mode 3 // theObj1 stays visualized in its mode 3
~~~~~ ~~~~
*PrsMgr_PresentationManager* and *SelectMgr_ViewerSelector3d*, which manage the presentation and selection of present interactive objects, are associated to the main Viewer. *PrsMgr_PresentationManager* and *SelectMgr_ViewerSelector3d*, which manage the presentation and selection of present interactive objects, are associated to the main Viewer.
@ -965,7 +965,7 @@ There are several functions to manipulate filters:
#### Example #### Example
~~~~~{.cpp} ~~~~{.cpp}
// shading visualization mode, no specific mode, authorization for decomposition into sub-shapes // shading visualization mode, no specific mode, authorization for decomposition into sub-shapes
const TopoDS_Shape theShape; const TopoDS_Shape theShape;
Handle(AIS_Shape) aShapePrs = new AIS_Shape (theShape); Handle(AIS_Shape) aShapePrs = new AIS_Shape (theShape);
@ -982,7 +982,7 @@ myContext->AddFilter (aFil2);
// only faces of revolution or planar faces will be selected // only faces of revolution or planar faces will be selected
myContext->MoveTo (thePixelX, thePixelY, myView, true); myContext->MoveTo (thePixelX, thePixelY, myView, true);
~~~~~ ~~~~
@subsubsection occt_visu_3_4_6 Selection @subsubsection occt_visu_3_4_6 Selection
@ -996,10 +996,10 @@ There are only a few conventions and functions to be familiar with:
Highlighting of detected and selected entities is automatically managed by the Interactive Context. Highlighting of detected and selected entities is automatically managed by the Interactive Context.
The Highlight colors are those dealt with above. You can nonetheless disconnect this automatic mode if you want to manage this part yourself: The Highlight colors are those dealt with above. You can nonetheless disconnect this automatic mode if you want to manage this part yourself:
~~~~~{.cpp} ~~~~{.cpp}
AIS_InteractiveContext::SetAutomaticHilight AIS_InteractiveContext::SetAutomaticHilight
AIS_InteractiveContext::AutomaticHilight AIS_InteractiveContext::AutomaticHilight
~~~~~ ~~~~
You can question the Interactive context by moving the mouse. You can question the Interactive context by moving the mouse.
The following functions can be used: The following functions can be used:
@ -1019,7 +1019,7 @@ In case of *AIS_Shape*, the (sub)shape is returned by method *StdSelect_BRepOwne
#### Example #### Example
~~~~~{.cpp} ~~~~{.cpp}
for (myAISCtx->InitSelected(); myAISCtx->MoreSelected(); myAISCtx->NextSelected()) for (myAISCtx->InitSelected(); myAISCtx->MoreSelected(); myAISCtx->NextSelected())
{ {
Handle(SelectMgr_EntityOwner) anOwner = myAISCtx->SelectedOwner(); Handle(SelectMgr_EntityOwner) anOwner = myAISCtx->SelectedOwner();
@ -1030,7 +1030,7 @@ for (myAISCtx->InitSelected(); myAISCtx->MoreSelected(); myAISCtx->NextSelected(
TopoDS_Shape aShape = aBRepOwner->Shape(); TopoDS_Shape aShape = aBRepOwner->Shape();
} }
} }
~~~~~ ~~~~
@subsubsection occt_visu_3_4_7 Selection schemes @subsubsection occt_visu_3_4_7 Selection schemes
@ -1101,7 +1101,7 @@ and can be built up from the source data with a custom presentation builder.
The class *AIS_ColoredShape* allows using custom colors and line widths for *TopoDS_Shape* objects and their sub-shapes. The class *AIS_ColoredShape* allows using custom colors and line widths for *TopoDS_Shape* objects and their sub-shapes.
~~~~~{.cpp} ~~~~{.cpp}
AIS_ColoredShape aColoredShape = new AIS_ColoredShape (theShape); AIS_ColoredShape aColoredShape = new AIS_ColoredShape (theShape);
// setup color of entire shape // setup color of entire shape
@ -1118,7 +1118,7 @@ The class *AIS_ColoredShape* allows using custom colors and line widths for *Top
// customize line width of specified sub-shape // customize line width of specified sub-shape
aColoredShape->SetCustomWidth (theSubShape, 0.25); aColoredShape->SetCustomWidth (theSubShape, 0.25);
~~~~~ ~~~~
The presentation class *AIS_PointCloud* can be used for efficient drawing of large arbitrary sets of colored points. The presentation class *AIS_PointCloud* can be used for efficient drawing of large arbitrary sets of colored points.
It uses *Graphic3d_ArrayOfPoints* to pass point data into OpenGl graphic driver to draw a set points as an array of "point sprites". It uses *Graphic3d_ArrayOfPoints* to pass point data into OpenGl graphic driver to draw a set points as an array of "point sprites".
@ -1130,14 +1130,14 @@ The point data is packed into vertex buffer object for performance.
@figure{point_cloud.png,"A random colored cloud of points",240} @figure{point_cloud.png,"A random colored cloud of points",240}
Example: Example:
~~~~~{.cpp} ~~~~{.cpp}
Handle(Graphic3d_ArrayOfPoints) aPoints = new Graphic3d_ArrayOfPoints (2000, Standard_True); Handle(Graphic3d_ArrayOfPoints) aPoints = new Graphic3d_ArrayOfPoints (2000, Standard_True);
aPoints->AddVertex (gp_Pnt(-40.0, -40.0, -40.0), Quantity_Color (Quantity_NOC_BLUE1)); aPoints->AddVertex (gp_Pnt(-40.0, -40.0, -40.0), Quantity_Color (Quantity_NOC_BLUE1));
aPoints->AddVertex (gp_Pnt (40.0, 40.0, 40.0), Quantity_Color (Quantity_NOC_BLUE2)); aPoints->AddVertex (gp_Pnt (40.0, 40.0, 40.0), Quantity_Color (Quantity_NOC_BLUE2));
Handle(AIS_PointCloud) aPntCloud = new AIS_PointCloud(); Handle(AIS_PointCloud) aPntCloud = new AIS_PointCloud();
aPntCloud->SetPoints (aPoints); aPntCloud->SetPoints (aPoints);
~~~~~ ~~~~
The draw command *vpointcloud* builds a cloud of points from shape triangulation. The draw command *vpointcloud* builds a cloud of points from shape triangulation.
This command can also draw a sphere surface or a volume with a large amount of points (more than one million). This command can also draw a sphere surface or a volume with a large amount of points (more than one million).
@ -1183,42 +1183,42 @@ You can choose between the builders to represent the object in a different way.
Moreover, you can redefine the base builder class and provide your own presentation builder. Moreover, you can redefine the base builder class and provide your own presentation builder.
You can add/remove builders using the following methods: You can add/remove builders using the following methods:
~~~~~{.cpp} ~~~~{.cpp}
MeshVS_Mesh::AddBuilder (const Handle(MeshVS_PrsBuilder)& theBuilder, Standard_Boolean theToTreatAsHilighter); MeshVS_Mesh::AddBuilder (const Handle(MeshVS_PrsBuilder)& theBuilder, Standard_Boolean theToTreatAsHilighter);
MeshVS_Mesh::RemoveBuilder (const Standard_Integer theIndex); MeshVS_Mesh::RemoveBuilder (const Standard_Integer theIndex);
MeshVS_Mesh::RemoveBuilderById (const Standard_Integer theId); MeshVS_Mesh::RemoveBuilderById (const Standard_Integer theId);
~~~~~ ~~~~
There is a set of reserved display and highlighting mode flags for *MeshVS_Mesh*. There is a set of reserved display and highlighting mode flags for *MeshVS_Mesh*.
Mode value is a number of bits that allows selecting additional display parameters and combining the following mode flags, Mode value is a number of bits that allows selecting additional display parameters and combining the following mode flags,
which allow displaying mesh in wireframe, shading and shrink modes: which allow displaying mesh in wireframe, shading and shrink modes:
~~~~~{.cpp} ~~~~{.cpp}
MeshVS_DMF_WireFrame MeshVS_DMF_WireFrame
MeshVS_DMF_Shading MeshVS_DMF_Shading
MeshVS_DMF_Shrink MeshVS_DMF_Shrink
~~~~~ ~~~~
It is also possible to display deformed mesh in wireframe, shading or shrink modes using: It is also possible to display deformed mesh in wireframe, shading or shrink modes using:
~~~~~{.cpp} ~~~~{.cpp}
MeshVS_DMF_DeformedPrsWireFrame MeshVS_DMF_DeformedPrsWireFrame
MeshVS_DMF_DeformedPrsShading MeshVS_DMF_DeformedPrsShading
MeshVS_DMF_DeformedPrsShrink MeshVS_DMF_DeformedPrsShrink
~~~~~ ~~~~
The following methods represent different kinds of data: The following methods represent different kinds of data:
~~~~~{.cpp} ~~~~{.cpp}
MeshVS_DMF_VectorDataPrs MeshVS_DMF_VectorDataPrs
MeshVS_DMF_NodalColorDataPrs MeshVS_DMF_NodalColorDataPrs
MeshVS_DMF_ElementalColorDataPrs MeshVS_DMF_ElementalColorDataPrs
MeshVS_DMF_TextDataPrs MeshVS_DMF_TextDataPrs
MeshVS_DMF_EntitiesWithData MeshVS_DMF_EntitiesWithData
~~~~~ ~~~~
The following methods provide selection and highlighting: The following methods provide selection and highlighting:
~~~~~{.cpp} ~~~~{.cpp}
MeshVS_DMF_SelectionPrs MeshVS_DMF_SelectionPrs
MeshVS_DMF_HilightPrs MeshVS_DMF_HilightPrs
~~~~~ ~~~~
*MeshVS_DMF_User* is a user-defined mode. *MeshVS_DMF_User* is a user-defined mode.
@ -1236,7 +1236,7 @@ There is also a set of selection modes flags that can be grouped in a combinatio
Such an object, for example, can be used for displaying the object and stored in the STL file format: Such an object, for example, can be used for displaying the object and stored in the STL file format:
~~~~~{.cpp} ~~~~{.cpp}
// read the data and create a data source // read the data and create a data source
Handle(Poly_Triangulation) aSTLMesh = RWStl::ReadFile (aFileName); Handle(Poly_Triangulation) aSTLMesh = RWStl::ReadFile (aFileName);
Handle(XSDRAWSTLVRML_DataSource) aDataSource = new XSDRAWSTLVRML_DataSource (aSTLMesh); Handle(XSDRAWSTLVRML_DataSource) aDataSource = new XSDRAWSTLVRML_DataSource (aSTLMesh);
@ -1248,13 +1248,13 @@ aMeshPrs->SetDataSource (aDataSource);
// use default presentation builder // use default presentation builder
Handle(MeshVS_MeshPrsBuilder) aBuilder = new MeshVS_MeshPrsBuilder (aMeshPrs); Handle(MeshVS_MeshPrsBuilder) aBuilder = new MeshVS_MeshPrsBuilder (aMeshPrs);
aMeshPrs->AddBuilder (aBuilder, true); aMeshPrs->AddBuilder (aBuilder, true);
~~~~~ ~~~~
*MeshVS_NodalColorPrsBuilder* allows representing a mesh with a color scaled texture mapped on it. *MeshVS_NodalColorPrsBuilder* allows representing a mesh with a color scaled texture mapped on it.
To do this you should define a color map for the color scale, pass this map to the presentation builder, and define an appropriate value in the range of 0.0 - 1.0 for every node. To do this you should define a color map for the color scale, pass this map to the presentation builder, and define an appropriate value in the range of 0.0 - 1.0 for every node.
The following example demonstrates how you can do this (check if the view has been set up to display textures): The following example demonstrates how you can do this (check if the view has been set up to display textures):
~~~~~{.cpp} ~~~~{.cpp}
// assign nodal builder to the mesh // assign nodal builder to the mesh
Handle(MeshVS_NodalColorPrsBuilder) aBuilder = new MeshVS_NodalColorPrsBuilder (theMeshPrs, MeshVS_DMF_NodalColorDataPrs | MeshVS_DMF_OCCMask); Handle(MeshVS_NodalColorPrsBuilder) aBuilder = new MeshVS_NodalColorPrsBuilder (theMeshPrs, MeshVS_DMF_NodalColorDataPrs | MeshVS_DMF_OCCMask);
aBuilder->UseTexture (true); aBuilder->UseTexture (true);
@ -1275,7 +1275,7 @@ aBuilder->SetColorMap (aColorMap);
aBuilder->SetInvalidColor (Quantity_NOC_BLACK); aBuilder->SetInvalidColor (Quantity_NOC_BLACK);
aBuilder->SetTextureCoords (aScaleMap); aBuilder->SetTextureCoords (aScaleMap);
aMesh->AddBuilder (aBuilder, true); aMesh->AddBuilder (aBuilder, true);
~~~~~ ~~~~
@subsection occt_visu_3_6 Dynamic Selection @subsection occt_visu_3_6 Dynamic Selection
@ -1377,7 +1377,7 @@ You can also modify the values assigned to the vertex or query these values by t
The following example shows how to define an array of points: The following example shows how to define an array of points:
~~~~~{.cpp} ~~~~{.cpp}
// create an array // create an array
Handle(Graphic3d_ArrayOfPoints) anArray = new Graphic3d_ArrayOfPoints (theVerticiesMaxCount); Handle(Graphic3d_ArrayOfPoints) anArray = new Graphic3d_ArrayOfPoints (theVerticiesMaxCount);
@ -1389,7 +1389,7 @@ anArray->AddVertex (0.0, 10.0, 10.0);
Handle(Graphic3d_Group) aGroup = thePrs->NewGroup(); Handle(Graphic3d_Group) aGroup = thePrs->NewGroup();
aGroup->AddPrimitiveArray (anArray); aGroup->AddPrimitiveArray (anArray);
aGroup->SetGroupPrimitivesAspect (myDrawer->PointAspect()->Aspect()); aGroup->SetGroupPrimitivesAspect (myDrawer->PointAspect()->Aspect());
~~~~~ ~~~~
If the primitives share the same vertices (polygons, triangles, etc.) then you can define them as indices of the vertices array. If the primitives share the same vertices (polygons, triangles, etc.) then you can define them as indices of the vertices array.
The method *Graphic3d_ArrayOfPrimitives::AddEdge* allows defining the primitives by indices. The method *Graphic3d_ArrayOfPrimitives::AddEdge* allows defining the primitives by indices.
@ -1398,7 +1398,7 @@ It is also possible to query the vertex defined by an edge using method *Graphic
The following example shows how to define an array of triangles: The following example shows how to define an array of triangles:
~~~~~{.cpp} ~~~~{.cpp}
// create an array // create an array
Handle(Graphic3d_ArrayOfTriangles) anArray = new Graphic3d_ArrayOfTriangles (theVerticesMaxCount, theEdgesMaxCount, Graphic3d_ArrayFlags_None); Handle(Graphic3d_ArrayOfTriangles) anArray = new Graphic3d_ArrayOfTriangles (theVerticesMaxCount, theEdgesMaxCount, Graphic3d_ArrayFlags_None);
// add vertices to the array // add vertices to the array
@ -1415,7 +1415,7 @@ anArray->AddEdges (1, 2, 4); // second triangle
Handle(Graphic3d_Group) aGroup = thePrs->NewGroup(); Handle(Graphic3d_Group) aGroup = thePrs->NewGroup();
aGroup->AddPrimitiveArray (anArray); aGroup->AddPrimitiveArray (anArray);
aGroup->SetGroupPrimitivesAspect (myDrawer->ShadingAspect()->Aspect()); aGroup->SetGroupPrimitivesAspect (myDrawer->ShadingAspect()->Aspect());
~~~~~ ~~~~
@subsubsection occt_visu_4_2_5 Text primitive @subsubsection occt_visu_4_2_5 Text primitive
@ -1427,17 +1427,17 @@ aGroup->SetGroupPrimitivesAspect (myDrawer->ShadingAspect()->Aspect());
The text attributes for the group could be defined with the *Graphic3d_AspectText3d* attributes group. The text attributes for the group could be defined with the *Graphic3d_AspectText3d* attributes group.
To add any text to the graphic structure you can use the following methods: To add any text to the graphic structure you can use the following methods:
~~~~~{.cpp} ~~~~{.cpp}
void Graphic3d_Group::AddText (const Handle(Graphic3d_Text)& theTextParams, void Graphic3d_Group::AddText (const Handle(Graphic3d_Text)& theTextParams,
const Standard_Boolean theToEvalMinMax); const Standard_Boolean theToEvalMinMax);
~~~~~ ~~~~
You can pass FALSE as *theToEvalMinMax* if you do not want the Graphic3d structure boundaries to be affected by the text position. You can pass FALSE as *theToEvalMinMax* if you do not want the Graphic3d structure boundaries to be affected by the text position.
**Note** that the text orientation angle can be defined by *Graphic3d_AspectText3d* attributes. **Note** that the text orientation angle can be defined by *Graphic3d_AspectText3d* attributes.
See the example: See the example:
~~~~~{.cpp} ~~~~{.cpp}
// get the group // get the group
Handle(Graphic3d_Group) aGroup = thePrs->NewGroup(); Handle(Graphic3d_Group) aGroup = thePrs->NewGroup();
@ -1452,7 +1452,7 @@ Handle(Graphic3d_Text) aText = new Graphic3d_Text (16.0f);
aText->SetText ("Text"); aText->SetText ("Text");
aText->SetPosition (gp_Pnt (1, 1, 1)); aText->SetPosition (gp_Pnt (1, 1, 1));
aGroup->AddText (aText); aGroup->AddText (aText);
~~~~~ ~~~~
@subsubsection occt_visu_4_2_6 Materials @subsubsection occt_visu_4_2_6 Materials
@ -1490,7 +1490,7 @@ OCCT visualization core supports GLSL shaders.
Custom shaders can be assigned to a generic presentation by its drawer attributes (Graphic3d aspects). Custom shaders can be assigned to a generic presentation by its drawer attributes (Graphic3d aspects).
To enable custom shader for a specific AIS_Shape in your application, the following API functions can be used: To enable custom shader for a specific AIS_Shape in your application, the following API functions can be used:
~~~~~{.cpp} ~~~~{.cpp}
// Create shader program // Create shader program
Handle(Graphic3d_ShaderProgram) aProgram = new Graphic3d_ShaderProgram(); Handle(Graphic3d_ShaderProgram) aProgram = new Graphic3d_ShaderProgram();
@ -1505,7 +1505,7 @@ aProgram->PushVariable ("MyColor", Graphic3d_Vec3 (0.0f, 1.0f, 0.0f));
// Set aspect property for specific AIS_Shape // Set aspect property for specific AIS_Shape
theAISShape->Attributes()->ShadingAspect()->Aspect()->SetShaderProgram (aProgram); theAISShape->Attributes()->ShadingAspect()->Aspect()->SetShaderProgram (aProgram);
~~~~~ ~~~~
@subsection occt_visu_4_3 Graphic attributes @subsection occt_visu_4_3 Graphic attributes
@ -1540,7 +1540,7 @@ This tool set contains methods for creating and editing classes of the viewer su
This sample TEST program for the *V3d* Package uses primary packages *Xw* and *Graphic3d* and secondary packages *Visual3d, Aspect, Quantity* and *math*. This sample TEST program for the *V3d* Package uses primary packages *Xw* and *Graphic3d* and secondary packages *Visual3d, Aspect, Quantity* and *math*.
~~~~~{.cpp} ~~~~{.cpp}
// create a default display connection // create a default display connection
Handle(Aspect_DisplayConnection) aDispConnection = new Aspect_DisplayConnection(); Handle(Aspect_DisplayConnection) aDispConnection = new Aspect_DisplayConnection();
// create a Graphic Driver // create a Graphic Driver
@ -1590,7 +1590,7 @@ aStruct->Display();
aView->Update(); aView->Update();
// Fit view to object size // Fit view to object size
aView->FitAll(); aView->FitAll();
~~~~~ ~~~~
@subsubsection occt_visu_4_4_3 Define viewing parameters @subsubsection occt_visu_4_4_3 Define viewing parameters
@ -1612,12 +1612,12 @@ The camera is defined by the following properties:
Most common view manipulations (panning, zooming, rotation) are implemented as convenience methods of *V3d_View* class or by *AIS_ViewController* tool. Most common view manipulations (panning, zooming, rotation) are implemented as convenience methods of *V3d_View* class or by *AIS_ViewController* tool.
However *Graphic3d_Camera* class can also be used directly by application developers. However *Graphic3d_Camera* class can also be used directly by application developers.
Example: Example:
~~~~~{.cpp} ~~~~{.cpp}
// rotate camera by X axis on 30.0 degrees // rotate camera by X axis on 30.0 degrees
gp_Trsf aTrsf; gp_Trsf aTrsf;
aTrsf.SetRotation (gp_Ax1 (gp_Pnt (0.0, 0.0, 0.0), gp_Dir (1.0, 0.0, 0.0)), M_PI / 4.0); aTrsf.SetRotation (gp_Ax1 (gp_Pnt (0.0, 0.0, 0.0), gp_Dir (1.0, 0.0, 0.0)), M_PI / 4.0);
aView->Camera()->Transform (aTrsf); aView->Camera()->Transform (aTrsf);
~~~~~ ~~~~
@subsubsection occt_visu_4_4_4 Orthographic Projection @subsubsection occt_visu_4_4_4 Orthographic Projection
@ -1625,12 +1625,12 @@ aView->Camera()->Transform (aTrsf);
The following code configures the camera for orthographic rendering: The following code configures the camera for orthographic rendering:
~~~~~{.cpp} ~~~~{.cpp}
// Create an orthographic View in this Viewer // Create an orthographic View in this Viewer
Handle(V3d_View) aView = new V3d_View (theViewer); Handle(V3d_View) aView = new V3d_View (theViewer);
aView->Camera()->SetProjectionType (Graphic3d_Camera::Projection_Orthographic); aView->Camera()->SetProjectionType (Graphic3d_Camera::Projection_Orthographic);
aView->Update(); // update the Visualization in this View aView->Update(); // update the Visualization in this View
~~~~~ ~~~~
@subsubsection occt_visu_4_4_5 Perspective Projection @subsubsection occt_visu_4_4_5 Perspective Projection
@ -1640,12 +1640,12 @@ aView->Update(); // update the Visualization in this View
The following code configures the camera for perspective rendering: The following code configures the camera for perspective rendering:
~~~~~{.cpp} ~~~~{.cpp}
// Create a perspective View in this Viewer // Create a perspective View in this Viewer
Handle(V3d_View) aView = new V3d_View (theViewer); Handle(V3d_View) aView = new V3d_View (theViewer);
aView->Camera()->SetProjectionType (Graphic3d_Camera::Projection_Perspective); aView->Camera()->SetProjectionType (Graphic3d_Camera::Projection_Perspective);
aView->Update(); aView->Update();
~~~~~ ~~~~
@subsubsection occt_visu_4_4_6 Stereographic Projection @subsubsection occt_visu_4_4_6 Stereographic Projection
@ -1673,15 +1673,15 @@ In a non-stereo camera this effect is not visible because only the same projecti
To enable quad buffering support you should provide the following settings to the graphic driver *OpenGl_Caps*: To enable quad buffering support you should provide the following settings to the graphic driver *OpenGl_Caps*:
~~~~~{.cpp} ~~~~{.cpp}
Handle(OpenGl_GraphicDriver) aDriver = new OpenGl_GraphicDriver(); Handle(OpenGl_GraphicDriver) aDriver = new OpenGl_GraphicDriver();
OpenGl_Caps& aCaps = aDriver->ChangeOptions(); OpenGl_Caps& aCaps = aDriver->ChangeOptions();
aCaps.contextStereo = Standard_True; aCaps.contextStereo = Standard_True;
~~~~~ ~~~~
The following code configures the camera for stereographic rendering: The following code configures the camera for stereographic rendering:
~~~~~{.cpp} ~~~~{.cpp}
// Create a Stereographic View in this Viewer // Create a Stereographic View in this Viewer
Handle(V3d_View) aView = new V3d_View (theViewer); Handle(V3d_View) aView = new V3d_View (theViewer);
aView->Camera()->SetProjectionType (Graphic3d_Camera::Projection_Stereo); aView->Camera()->SetProjectionType (Graphic3d_Camera::Projection_Stereo);
@ -1689,15 +1689,15 @@ aView->Camera()->SetProjectionType (Graphic3d_Camera::Projection_Stereo);
aView->Camera()->SetIOD (IODType_Absolute, 5.0); aView->Camera()->SetIOD (IODType_Absolute, 5.0);
// Finally update the Visualization in this View // Finally update the Visualization in this View
aView->Update(); aView->Update();
~~~~~ ~~~~
Other 3D displays are also supported, including row-interlaced with passive glasses and anaglyph glasses - see *Graphic3d_StereoMode* enumeration. Other 3D displays are also supported, including row-interlaced with passive glasses and anaglyph glasses - see *Graphic3d_StereoMode* enumeration.
Example to activate another stereoscopic display: Example to activate another stereoscopic display:
~~~~~{.cpp} ~~~~{.cpp}
Handle(V3d_View) theView; Handle(V3d_View) theView;
theView->Camera()->SetProjectionType (Graphic3d_Camera::Projection_Stereo); theView->Camera()->SetProjectionType (Graphic3d_Camera::Projection_Stereo);
theView->ChangeRenderingParams().StereoParams = Graphic3d_StereoMode_RowInterlaced; theView->ChangeRenderingParams().StereoParams = Graphic3d_StereoMode_RowInterlaced;
~~~~~ ~~~~
Supporting of VR/AR headsets in application is more involving. Supporting of VR/AR headsets in application is more involving.
Class *Aspect_XRSession* defines a basic interface for working with extended reality. Class *Aspect_XRSession* defines a basic interface for working with extended reality.
@ -1716,26 +1716,26 @@ The following features support this method:
There are several types of background styles available for *V3d_View*: solid color, gradient color, image and environment cubemap. There are several types of background styles available for *V3d_View*: solid color, gradient color, image and environment cubemap.
To set solid color for the background you can use the following method: To set solid color for the background you can use the following method:
~~~~~{.cpp} ~~~~{.cpp}
void V3d_View::SetBackgroundColor (const Quantity_Color& theColor); void V3d_View::SetBackgroundColor (const Quantity_Color& theColor);
~~~~~ ~~~~
The gradient background style could be set up with the following method: The gradient background style could be set up with the following method:
~~~~~{.cpp} ~~~~{.cpp}
void V3d_View::SetBgGradientColors (const Quantity_Color& theColor1, void V3d_View::SetBgGradientColors (const Quantity_Color& theColor1,
const Quantity_Color& theColor2, const Quantity_Color& theColor2,
const Aspect_GradientFillMethod theFillStyle, const Aspect_GradientFillMethod theFillStyle,
const Standard_Boolean theToUpdate = false); const Standard_Boolean theToUpdate = false);
~~~~~ ~~~~
The *theColor1* and *theColor2* parameters define the boundary colors of interpolation, the *theFillStyle* parameter defines the direction of interpolation. The *theColor1* and *theColor2* parameters define the boundary colors of interpolation, the *theFillStyle* parameter defines the direction of interpolation.
To set the image as a background and change the background image style you can use the following method: To set the image as a background and change the background image style you can use the following method:
~~~~~{.cpp} ~~~~{.cpp}
void V3d_View::SetBackgroundImage (const Standard_CString theFileName, void V3d_View::SetBackgroundImage (const Standard_CString theFileName,
const Aspect_FillMethod theFillStyle, const Aspect_FillMethod theFillStyle,
const Standard_Boolean theToUpdate = false); const Standard_Boolean theToUpdate = false);
~~~~~ ~~~~
The *theFileName* parameter defines the image file name and the path to it, the *theFillStyle* parameter defines the method of filling the background with the image. The *theFileName* parameter defines the image file name and the path to it, the *theFillStyle* parameter defines the method of filling the background with the image.
The methods are: The methods are:
@ -1793,7 +1793,7 @@ There are several ray-tracing options that user can switch on/off:
* Transparency shadow effects * Transparency shadow effects
Example: Example:
~~~~~{.cpp} ~~~~{.cpp}
Graphic3d_RenderingParams& aParams = aView->ChangeRenderingParams(); Graphic3d_RenderingParams& aParams = aView->ChangeRenderingParams();
// specifies rendering mode // specifies rendering mode
aParams.Method = Graphic3d_RM_RAYTRACING; aParams.Method = Graphic3d_RM_RAYTRACING;
@ -1809,7 +1809,7 @@ aParams.IsAntialiasingEnabled = true;
aParams.IsTransparentShadowEnabled = true; aParams.IsTransparentShadowEnabled = true;
// update the view // update the view
aView->Update(); aView->Update();
~~~~~ ~~~~
@subsubsection occt_visu_4_4_14 Display priorities @subsubsection occt_visu_4_4_14 Display priorities
@ -1828,14 +1828,14 @@ In general, this function can be used for implementing "bring to front" function
Example: Example:
~~~~~{.cpp} ~~~~{.cpp}
// set z-layer to an interactive object // set z-layer to an interactive object
Handle(AIS_InteractiveContext) theContext; Handle(AIS_InteractiveContext) theContext;
Handle(AIS_InteractiveObject) theInterObj; Handle(AIS_InteractiveObject) theInterObj;
Standard_Integer anId = -1; Standard_Integer anId = -1;
aViewer->AddZLayer (anId); aViewer->AddZLayer (anId);
theContext->SetZLayer (theInterObj, anId); theContext->SetZLayer (theInterObj, anId);
~~~~~ ~~~~
For each z-layer, it is allowed to: For each z-layer, it is allowed to:
* Enable / disable depth test for layer. * Enable / disable depth test for layer.
@ -1847,7 +1847,7 @@ You can get the options using getter from *V3d_Viewer*.
It returns *Graphic3d_ZLayerSettings* for a given *LayerId*. It returns *Graphic3d_ZLayerSettings* for a given *LayerId*.
Example: Example:
~~~~~{.cpp} ~~~~{.cpp}
// change z-layer settings // change z-layer settings
Graphic3d_ZLayerSettings aSettings = aViewer->ZLayerSettings (anId); Graphic3d_ZLayerSettings aSettings = aViewer->ZLayerSettings (anId);
aSettings.SetEnableDepthTest (true); aSettings.SetEnableDepthTest (true);
@ -1855,7 +1855,7 @@ aSettings.SetEnableDepthWrite(true);
aSettings.SetClearDepth (true); aSettings.SetClearDepth (true);
aSettings.SetPolygonOffset (Graphic3d_PolygonOffset()); aSettings.SetPolygonOffset (Graphic3d_PolygonOffset());
aViewer->SetZLayerSettings (anId, aSettings); aViewer->SetZLayerSettings (anId, aSettings);
~~~~~ ~~~~
Another application for Z-Layer feature is treating visual precision issues when displaying objects far from the World Center. Another application for Z-Layer feature is treating visual precision issues when displaying objects far from the World Center.
The key problem with such objects is that visualization data is stored and manipulated with single precision floating-point numbers (32-bit). The key problem with such objects is that visualization data is stored and manipulated with single precision floating-point numbers (32-bit).
@ -1887,10 +1887,10 @@ So, to apply this feature in OCCT, the application:
* Defines a Z-Layer for each spatial cell containing any object. * Defines a Z-Layer for each spatial cell containing any object.
* Defines the Local Origin property of the Z-Layer according to the center of the cell. * Defines the Local Origin property of the Z-Layer according to the center of the cell.
~~~~~{.cpp} ~~~~{.cpp}
Graphic3d_ZLayerSettings aSettings = aViewer->ZLayerSettings (anId); Graphic3d_ZLayerSettings aSettings = aViewer->ZLayerSettings (anId);
aSettings.SetLocalOrigin (400.0, 0.0, 0.0); aSettings.SetLocalOrigin (400.0, 0.0, 0.0);
~~~~~ ~~~~
* Assigns a presentable object to the nearest Z-Layer. * Assigns a presentable object to the nearest Z-Layer.
Note that Local Origin of the Layer is used only for rendering - everything outside will be still defined in the World Coordinate System, Note that Local Origin of the Layer is used only for rendering - everything outside will be still defined in the World Coordinate System,
@ -1906,29 +1906,29 @@ The *Graphic3d_ClipPlane* class provides the services for clipping planes:
it holds the plane equation coefficients and provides its graphical representation. it holds the plane equation coefficients and provides its graphical representation.
To set and get plane equation coefficients you can use the following methods: To set and get plane equation coefficients you can use the following methods:
~~~~~{.cpp} ~~~~{.cpp}
Graphic3d_ClipPlane::Graphic3d_ClipPlane (const gp_Pln& thePlane) Graphic3d_ClipPlane::Graphic3d_ClipPlane (const gp_Pln& thePlane)
void Graphic3d_ClipPlane::SetEquation (const gp_Pln& thePlane) void Graphic3d_ClipPlane::SetEquation (const gp_Pln& thePlane)
Graphic3d_ClipPlane::Graphic3d_ClipPlane (const Equation& theEquation) Graphic3d_ClipPlane::Graphic3d_ClipPlane (const Equation& theEquation)
void Graphic3d_ClipPlane::SetEquation (const Equation& theEquation) void Graphic3d_ClipPlane::SetEquation (const Equation& theEquation)
gp_Pln Graphic3d_ClipPlane::ToPlane() const gp_Pln Graphic3d_ClipPlane::ToPlane() const
~~~~~ ~~~~
The clipping planes can be activated with the following method: The clipping planes can be activated with the following method:
~~~~~{.cpp} ~~~~{.cpp}
void Graphic3d_ClipPlane::SetOn (const Standard_Boolean theIsOn) void Graphic3d_ClipPlane::SetOn (const Standard_Boolean theIsOn)
~~~~~ ~~~~
The number of clipping planes is limited. The number of clipping planes is limited.
You can check the limit value via method *Graphic3d_GraphicDriver::InquireLimit()*; You can check the limit value via method *Graphic3d_GraphicDriver::InquireLimit()*;
~~~~~{.cpp} ~~~~{.cpp}
// get the limit of clipping planes for the current view // get the limit of clipping planes for the current view
Standard_Integer aMaxClipPlanes = aView->Viewer()->Driver()->InquireLimit (Graphic3d_TypeOfLimit_MaxNbClipPlanes); Standard_Integer aMaxClipPlanes = aView->Viewer()->Driver()->InquireLimit (Graphic3d_TypeOfLimit_MaxNbClipPlanes);
~~~~~ ~~~~
Let us see for example how to create a new clipping plane with custom parameters and add it to a view or to an object: Let us see for example how to create a new clipping plane with custom parameters and add it to a view or to an object:
~~~~~{.cpp} ~~~~{.cpp}
// create a new clipping plane // create a new clipping plane
Handle(Graphic3d_ClipPlane) aClipPlane = new Graphic3d_ClipPlane(); Handle(Graphic3d_ClipPlane) aClipPlane = new Graphic3d_ClipPlane();
// change equation of the clipping plane // change equation of the clipping plane
@ -1956,7 +1956,7 @@ aView->AddClipPlane (aClipPlane);
aClipPlane->SetOn (Standard_True); aClipPlane->SetOn (Standard_True);
// update the view // update the view
aView->Update(); aView->Update();
~~~~~ ~~~~
@subsubsection occt_visu_4_4_17 Automatic back face culling @subsubsection occt_visu_4_4_17 Automatic back face culling
@ -1989,7 +1989,7 @@ To create 3D graphic objects and display them in the screen, follow the procedur
Create colors. Create colors.
~~~~~{.cpp} ~~~~{.cpp}
Quantity_Color aBlack (Quantity_NOC_BLACK); Quantity_Color aBlack (Quantity_NOC_BLACK);
Quantity_Color aBlue (Quantity_NOC_MATRABLUE); Quantity_Color aBlue (Quantity_NOC_MATRABLUE);
Quantity_Color aBrown (Quantity_NOC_BROWN4); Quantity_Color aBrown (Quantity_NOC_BROWN4);
@ -1999,21 +1999,21 @@ Quantity_Color aGray (Quantity_NOC_GRAY70);
Quantity_Color aMyColor (0.99, 0.65, 0.31, Quantity_TOC_RGB); Quantity_Color aMyColor (0.99, 0.65, 0.31, Quantity_TOC_RGB);
Quantity_Color aBeet (Quantity_NOC_BEET); Quantity_Color aBeet (Quantity_NOC_BEET);
Quantity_Color aWhite (Quantity_NOC_WHITE); Quantity_Color aWhite (Quantity_NOC_WHITE);
~~~~~ ~~~~
Create line attributes. Create line attributes.
~~~~~{.cpp} ~~~~{.cpp}
Handle(Graphic3d_AspectLine3d) anAspectBrown = new Graphic3d_AspectLine3d(); Handle(Graphic3d_AspectLine3d) anAspectBrown = new Graphic3d_AspectLine3d();
Handle(Graphic3d_AspectLine3d) anAspectBlue = new Graphic3d_AspectLine3d(); Handle(Graphic3d_AspectLine3d) anAspectBlue = new Graphic3d_AspectLine3d();
Handle(Graphic3d_AspectLine3d) anAspectWhite = new Graphic3d_AspectLine3d(); Handle(Graphic3d_AspectLine3d) anAspectWhite = new Graphic3d_AspectLine3d();
anAspectBrown->SetColor (aBrown); anAspectBrown->SetColor (aBrown);
anAspectBlue ->SetColor (aBlue); anAspectBlue ->SetColor (aBlue);
anAspectWhite->SetColor (aWhite); anAspectWhite->SetColor (aWhite);
~~~~~ ~~~~
Create marker attributes. Create marker attributes.
~~~~~{.cpp} ~~~~{.cpp}
Handle(Graphic3d_AspectMarker3d aFirebrickMarker = new Graphic3d_AspectMarker3d(); Handle(Graphic3d_AspectMarker3d aFirebrickMarker = new Graphic3d_AspectMarker3d();
// marker attributes // marker attributes
aFirebrickMarker->SetColor (Firebrick); aFirebrickMarker->SetColor (Firebrick);
@ -2021,10 +2021,10 @@ aFirebrickMarker->SetScale (1.0f);
aFirebrickMarker->SetType (Aspect_TOM_BALL); aFirebrickMarker->SetType (Aspect_TOM_BALL);
// or custom image // or custom image
aFirebrickMarker->SetMarkerImage (theImage) aFirebrickMarker->SetMarkerImage (theImage)
~~~~~ ~~~~
Create facet attributes. Create facet attributes.
~~~~~{.cpp} ~~~~{.cpp}
Handle(Graphic3d_AspectFillArea3d) aFaceAspect = new Graphic3d_AspectFillArea3d(); Handle(Graphic3d_AspectFillArea3d) aFaceAspect = new Graphic3d_AspectFillArea3d();
Graphic3d_MaterialAspect aBrassMaterial (Graphic3d_NameOfMaterial_Brass); Graphic3d_MaterialAspect aBrassMaterial (Graphic3d_NameOfMaterial_Brass);
Graphic3d_MaterialAspect aGoldMaterial (Graphic3d_NameOfMaterial_Gold); Graphic3d_MaterialAspect aGoldMaterial (Graphic3d_NameOfMaterial_Gold);
@ -2033,16 +2033,16 @@ aFaceAspect->SetInteriorColor (aMyColor);
aFaceAspect->SetDistinguishOn (); aFaceAspect->SetDistinguishOn ();
aFaceAspect->SetFrontMaterial (aGoldMaterial); aFaceAspect->SetFrontMaterial (aGoldMaterial);
aFaceAspect->SetBackMaterial (aBrassMaterial); aFaceAspect->SetBackMaterial (aBrassMaterial);
~~~~~ ~~~~
Create text attributes. Create text attributes.
~~~~~{.cpp} ~~~~{.cpp}
Handle(Graphic3d_AspectText3d) aTextAspect = new Graphic3d_AspectText3d (aForest, Font_NOF_MONOSPACE, 1.0, 0.0); Handle(Graphic3d_AspectText3d) aTextAspect = new Graphic3d_AspectText3d (aForest, Font_NOF_MONOSPACE, 1.0, 0.0);
~~~~~ ~~~~
@subsubsection occt_visu_4_5_2 Create a 3D Viewer (a Windows example) @subsubsection occt_visu_4_5_2 Create a 3D Viewer (a Windows example)
~~~~~{.cpp} ~~~~{.cpp}
// create a graphic driver // create a graphic driver
Handle(OpenGl_GraphicDriver) aGraphicDriver = new OpenGl_GraphicDriver (Handle(Aspect_DisplayConnection)()); Handle(OpenGl_GraphicDriver) aGraphicDriver = new OpenGl_GraphicDriver (Handle(Aspect_DisplayConnection)());
// create a viewer // create a viewer
@ -2058,30 +2058,30 @@ a3DViewer->SetDefaultLights();
a3DViewer->SetLightOn(); a3DViewer->SetLightOn();
// set background color to black // set background color to black
a3DViewer->SetDefaultBackgroundColor (Quantity_NOC_BLACK); a3DViewer->SetDefaultBackgroundColor (Quantity_NOC_BLACK);
~~~~~ ~~~~
@subsubsection occt_visu_4_5_3 Create a 3D view (a Windows example) @subsubsection occt_visu_4_5_3 Create a 3D view (a Windows example)
It is assumed that a valid Windows window may already be accessed via the method *GetSafeHwnd()* (as in case of MFC sample). It is assumed that a valid Windows window may already be accessed via the method *GetSafeHwnd()* (as in case of MFC sample).
~~~~~{.cpp} ~~~~{.cpp}
Handle(WNT_Window) aWNTWindow = new WNT_Window (GetSafeHwnd()); Handle(WNT_Window) aWNTWindow = new WNT_Window (GetSafeHwnd());
myView = myViewer->CreateView(); myView = myViewer->CreateView();
myView->SetWindow (aWNTWindow); myView->SetWindow (aWNTWindow);
~~~~~ ~~~~
@subsubsection occt_visu_4_5_4 Create an interactive context @subsubsection occt_visu_4_5_4 Create an interactive context
~~~~~{.cpp} ~~~~{.cpp}
myAISContext = new AIS_InteractiveContext (myViewer); myAISContext = new AIS_InteractiveContext (myViewer);
~~~~~ ~~~~
You are now able to display interactive objects such as an *AIS_Shape*. You are now able to display interactive objects such as an *AIS_Shape*.
~~~~~{.cpp} ~~~~{.cpp}
TopoDS_Shape aShape = BRepAPI_MakeBox (10, 20, 30).Solid(); TopoDS_Shape aShape = BRepAPI_MakeBox (10, 20, 30).Solid();
Handle(AIS_Shape) anAISShape = new AIS_Shape (aShape); Handle(AIS_Shape) anAISShape = new AIS_Shape (aShape);
myAISContext->Display (anAISShape, true); myAISContext->Display (anAISShape, true);
~~~~~ ~~~~
@subsubsection occt_visu_4_5_5 Create your own interactive object @subsubsection occt_visu_4_5_5 Create your own interactive object
@ -2095,7 +2095,7 @@ i.e. in hidden line removal and wireframe modes.
Let us look at the example of compute methods Let us look at the example of compute methods
~~~~~{.cpp} ~~~~{.cpp}
void MyPresentableObject::Compute (const Handle(PrsMgr_PresentationManager)& thePrsManager, void MyPresentableObject::Compute (const Handle(PrsMgr_PresentationManager)& thePrsManager,
const Handle(Graphic3d_Structure)& thePrs, const Handle(Graphic3d_Structure)& thePrs,
const Standard_Integer theMode) const Standard_Integer theMode)
@ -2108,25 +2108,25 @@ void MyPresentableObject::Compute (const Handle(Prs3d_Projector)& theProjector,
( (
//... //...
) )
~~~~~ ~~~~
@subsubsection occt_visu_4_5_6 Create primitives in the interactive object @subsubsection occt_visu_4_5_6 Create primitives in the interactive object
Get the group used in *Graphic3d_Structure*. Get the group used in *Graphic3d_Structure*.
~~~~~{.cpp} ~~~~{.cpp}
Handle(Graphic3d_Group) aGroup = thePrs->NewGroup(); Handle(Graphic3d_Group) aGroup = thePrs->NewGroup();
~~~~~ ~~~~
Update the group attributes. Update the group attributes.
~~~~~{.cpp} ~~~~{.cpp}
aGroup->SetGroupPrimitivesAspect (anAspectBlue); aGroup->SetGroupPrimitivesAspect (anAspectBlue);
~~~~~ ~~~~
Create two triangles in *aGroup*. Create two triangles in *aGroup*.
~~~~~{.cpp} ~~~~{.cpp}
Standard_Integer aNbTria = 2; Standard_Integer aNbTria = 2;
Handle(Graphic3d_ArrayOfTriangles) aTriangles = new Graphic3d_ArrayOfTriangles (3 * aNbTria, 0, Graphic3d_ArrayFlags_VertexNormal); Handle(Graphic3d_ArrayOfTriangles) aTriangles = new Graphic3d_ArrayOfTriangles (3 * aNbTria, 0, Graphic3d_ArrayFlags_VertexNormal);
for (Standard_Integer aTriIter = 1; aTriIter <= aNbTria; ++aTriIter) for (Standard_Integer aTriIter = 1; aTriIter <= aNbTria; ++aTriIter)
@ -2137,11 +2137,11 @@ for (Standard_Integer aTriIter = 1; aTriIter <= aNbTria; ++aTriIter)
} }
aGroup->AddPrimitiveArray (aTriangles); aGroup->AddPrimitiveArray (aTriangles);
aGroup->SetGroupPrimitivesAspect (new Graphic3d_AspectFillArea3d()); aGroup->SetGroupPrimitivesAspect (new Graphic3d_AspectFillArea3d());
~~~~~ ~~~~
Use the polyline function to create a boundary box for the *thePrs* structure in group *aGroup*. Use the polyline function to create a boundary box for the *thePrs* structure in group *aGroup*.
~~~~~{.cpp} ~~~~{.cpp}
Standard_Real Xm, Ym, Zm, XM, YM, ZM; Standard_Real Xm, Ym, Zm, XM, YM, ZM;
thePrs->MinMaxValues (Xm, Ym, Zm, XM, YM, ZM); thePrs->MinMaxValues (Xm, Ym, Zm, XM, YM, ZM);
@ -2169,11 +2169,11 @@ aPolylines->AddVertex (Xm, Ym, ZM);
aGroup->AddPrimitiveArray(aPolylines); aGroup->AddPrimitiveArray(aPolylines);
aGroup->SetGroupPrimitivesAspect (new Graphic3d_AspectLine3d()); aGroup->SetGroupPrimitivesAspect (new Graphic3d_AspectLine3d());
~~~~~ ~~~~
Create text and markers in group *aGroup*. Create text and markers in group *aGroup*.
~~~~~{.cpp} ~~~~{.cpp}
static char* THE_TEXT[3] = static char* THE_TEXT[3] =
{ {
"Application title", "Application title",
@ -2194,7 +2194,7 @@ for (int i = 0; i <= 2; i++)
-(Standard_Real )i * 4); -(Standard_Real )i * 4);
aGroup->Text (THE_TEXT[i], Marker, 20.); aGroup->Text (THE_TEXT[i], Marker, 20.);
} }
~~~~~ ~~~~
@section occt_visu_5 Mesh Visualization Services @section occt_visu_5 Mesh Visualization Services

304
dox/user_guides/xde/xde.md
View File

@ -168,38 +168,38 @@ To use XDE you have to set the environment variables properly. Make sure that tw
Before working with shapes, properties, and other types of information, the global organization of an XDE Document can be queried or completed to determine if an existing Document is actually structured for use with XDE. Before working with shapes, properties, and other types of information, the global organization of an XDE Document can be queried or completed to determine if an existing Document is actually structured for use with XDE.
To find out if an existing *TDocStd_Document* is suitable for XDE, use: To find out if an existing *TDocStd_Document* is suitable for XDE, use:
~~~~~ ~~~~{.cpp}
Handle(TDocStd_Document) doc... Handle(TDocStd_Document) doc...
if ( XCAFDoc_DocumentTool::IsXCAFDocument (doc) ) { .. yes .. } if ( XCAFDoc_DocumentTool::IsXCAFDocument (doc) ) { .. yes .. }
~~~~~ ~~~~
If the Document is suitable for XDE, you can perform operations and queries explained in this guide. However, if a Document is not fully structured for XDE, it must be initialized. If the Document is suitable for XDE, you can perform operations and queries explained in this guide. However, if a Document is not fully structured for XDE, it must be initialized.
@subsubsection occt_xde_2_1_3 Get an Application or an Initialized Document @subsubsection occt_xde_2_1_3 Get an Application or an Initialized Document
If you want to retrieve an existing application or an existing document (known to be correctly structured for XDE), use: If you want to retrieve an existing application or an existing document (known to be correctly structured for XDE), use:
~~~~~ ~~~~{.cpp}
Handle(TDocStd_Document) aDoc; Handle(TDocStd_Document) aDoc;
Handle(XCAFApp_Application) anApp = XCAFApp_Application::GetApplication(); Handle(XCAFApp_Application) anApp = XCAFApp_Application::GetApplication();
anApp->NewDocument(;MDTV-XCAF;,aDoc); anApp->NewDocument(;MDTV-XCAF;,aDoc);
~~~~~ ~~~~
@subsection occt_xde_2_2 Shapes and Assemblies @subsection occt_xde_2_2 Shapes and Assemblies
@subsubsection occt_xde_2_2_1 Initialize an XDE Document (Shapes) @subsubsection occt_xde_2_2_1 Initialize an XDE Document (Shapes)
An XDE Document begins with a *TDocStd_Document*. Assuming you have a *TDocStd_Document* already created, you can ensure that it is correctly structured for XDE by initializing the XDE structure as follows: An XDE Document begins with a *TDocStd_Document*. Assuming you have a *TDocStd_Document* already created, you can ensure that it is correctly structured for XDE by initializing the XDE structure as follows:
~~~~~ ~~~~{.cpp}
Handle(TDocStd_Document) doc... Handle(TDocStd_Document) doc...
Handle (XCAFDoc_ShapeTool) myAssembly = Handle (XCAFDoc_ShapeTool) myAssembly =
XCAFDoc_DocumentTool::ShapeTool (Doc->Main()); XCAFDoc_DocumentTool::ShapeTool (Doc->Main());
TDF_Label aLabel = myAssembly->NewShape() TDF_Label aLabel = myAssembly->NewShape()
~~~~~ ~~~~
**Note** that the method *XCAFDoc_DocumentTool::ShapeTool* returns the *XCAFDoc_ShapeTool*. The first time this method is used, it creates the *XCAFDoc_ShapeTool*. In our example, a handle is used for the *TDocStd_Document*. **Note** that the method *XCAFDoc_DocumentTool::ShapeTool* returns the *XCAFDoc_ShapeTool*. The first time this method is used, it creates the *XCAFDoc_ShapeTool*. In our example, a handle is used for the *TDocStd_Document*.
@subsubsection occt_xde_2_2_2 Get a Node considered as an Assembly @subsubsection occt_xde_2_2_2 Get a Node considered as an Assembly
To get a node considered as an Assembly from an XDE structure, you can use the Label of the node. Assuming that you have a properly initialized *TDocStd_Document*, use: To get a node considered as an Assembly from an XDE structure, you can use the Label of the node. Assuming that you have a properly initialized *TDocStd_Document*, use:
~~~~~ ~~~~{.cpp}
Handle(TDocStd_Document) doc... Handle(TDocStd_Document) doc...
Handle(XCAFDoc_ShapeTool) myAssembly = XCAFDoc_DocumentTool::ShapeTool (aLabel); Handle(XCAFDoc_ShapeTool) myAssembly = XCAFDoc_DocumentTool::ShapeTool (aLabel);
~~~~~ ~~~~
In the previous example, you can also get the Main Item of an XDE document, which records the root shape representation (as a Compound if it is an Assembly) by using *ShapeTool(Doc->Main())* instead of *ShapeTool(aLabel)*. In the previous example, you can also get the Main Item of an XDE document, which records the root shape representation (as a Compound if it is an Assembly) by using *ShapeTool(Doc->Main())* instead of *ShapeTool(aLabel)*.
You can then query or edit this Assembly node, the Main Item or another one (*myAssembly* in our examples). You can then query or edit this Assembly node, the Main Item or another one (*myAssembly* in our examples).
@ -210,9 +210,9 @@ You can then query or edit this Assembly node, the Main Item or another one (*my
Some actions in this chapter affect the content of the document, considered as an Assembly. As a result, you will sometimes need to update various representations (including the compounds). Some actions in this chapter affect the content of the document, considered as an Assembly. As a result, you will sometimes need to update various representations (including the compounds).
To update the representations, use: To update the representations, use:
~~~~~ ~~~~{.cpp}
myAssembly->UpdateAssemblies(); myAssembly->UpdateAssemblies();
~~~~~ ~~~~
This call performs a top-down update of the Assembly compounds stored in the document. This call performs a top-down update of the Assembly compounds stored in the document.
**Note** that you have to run this method manually to actualize your Assemblies after any low-level modifications on shapes. **Note** that you have to run this method manually to actualize your Assemblies after any low-level modifications on shapes.
@ -230,29 +230,29 @@ A shape to be added can be defined as a compound (if required), with the followi
* If the Shape is not a compound, it is taken as a whole, without breaking it down. * If the Shape is not a compound, it is taken as a whole, without breaking it down.
To break down a Compound in the assembly structure, use: To break down a Compound in the assembly structure, use:
~~~~~ ~~~~{.cpp}
Standard_Boolean makeAssembly; Standard_Boolean makeAssembly;
// True to interpret a Compound as an Assembly, // True to interpret a Compound as an Assembly,
// False to take it as a whole // False to take it as a whole
aLabel = myAssembly->AddShape(aShape, makeAssembly); aLabel = myAssembly->AddShape(aShape, makeAssembly);
~~~~~ ~~~~
Each node of the assembly therefore refers to its sub-shapes. Each node of the assembly therefore refers to its sub-shapes.
Concerning located instances of sub-shapes, the corresponding shapes, (without location) appear at distinct sub-labels. They are referred to by a shape instance, which associates a location. Concerning located instances of sub-shapes, the corresponding shapes, (without location) appear at distinct sub-labels. They are referred to by a shape instance, which associates a location.
@subsubsection occt_xde_2_2_5 Setting a given Shape at a given Label @subsubsection occt_xde_2_2_5 Setting a given Shape at a given Label
A top-level shape can be changed. In this example, no interpretation of compound is performed: A top-level shape can be changed. In this example, no interpretation of compound is performed:
~~~~~ ~~~~{.cpp}
Standard_CString LabelString ...; Standard_CString LabelString ...;
// identifies the Label (form ;0:i:j...;) // identifies the Label (form ;0:i:j...;)
TDF_Label aLabel...; TDF_Label aLabel...;
// A label must be present // A label must be present
myAssembly->SetShape(aLabel, aShape); myAssembly->SetShape(aLabel, aShape);
~~~~~ ~~~~
@subsubsection occt_xde_2_2_6 Getting a Shape from a Label @subsubsection occt_xde_2_2_6 Getting a Shape from a Label
To get a shape from its Label from the top-level, use: To get a shape from its Label from the top-level, use:
~~~~~ ~~~~{.cpp}
TDF_Label aLabel... TDF_Label aLabel...
// A label must be present // A label must be present
if (aLabel.IsNull()) { if (aLabel.IsNull()) {
@ -263,19 +263,19 @@ aShape = myAssembly->GetShape(aLabel);
if (aShape.IsNull()) { if (aShape.IsNull()) {
// this label is not for a Shape // this label is not for a Shape
} }
~~~~~ ~~~~
**Note** that if the label corresponds to an assembly, the result is a compound. **Note** that if the label corresponds to an assembly, the result is a compound.
@subsubsection occt_xde_2_2_7 Getting a Label from a Shape @subsubsection occt_xde_2_2_7 Getting a Label from a Shape
To get a Label, which is attached to a Shape from the top-level, use: To get a Label, which is attached to a Shape from the top-level, use:
~~~~~ ~~~~{.cpp}
Standard_Boolean findInstance = Standard_False; Standard_Boolean findInstance = Standard_False;
// (this is default value) // (this is default value)
aLabel = myAssembly->FindShape(aShape [,findInstance]); aLabel = myAssembly->FindShape(aShape [,findInstance]);
if (aLabel.IsNull()) { if (aLabel.IsNull()) {
// no label found for this shape // no label found for this shape
} }
~~~~~ ~~~~
If *findInstance* is True, a search is made for the shape with the same location. If it is False (default value), a search is made among original, non-located shapes. If *findInstance* is True, a search is made for the shape with the same location. If it is False (default value), a search is made among original, non-located shapes.
@subsubsection occt_xde_2_2_8 Other Queries on a Label @subsubsection occt_xde_2_2_8 Other Queries on a Label
@ -284,29 +284,29 @@ Various other queries can be made from a Label within the Main Item of XDE:
#### Main Shapes #### Main Shapes
To determine if a Shape is recorded (or not), use: To determine if a Shape is recorded (or not), use:
~~~~~ ~~~~{.cpp}
if ( myAssembly->IsShape(aLabel) ) { .. yes .. } if ( myAssembly->IsShape(aLabel) ) { .. yes .. }
~~~~~ ~~~~
To determine if the shape is top-level, i.e. was added by the *AddShape* method, use: To determine if the shape is top-level, i.e. was added by the *AddShape* method, use:
~~~~~ ~~~~{.cpp}
if ( myAssembly->IsTopLevel(aLabel) ) { .. yes .. } if ( myAssembly->IsTopLevel(aLabel) ) { .. yes .. }
~~~~~ ~~~~
To get a list of top-level shapes added by the *AddShape* method, use: To get a list of top-level shapes added by the *AddShape* method, use:
~~~~~ ~~~~{.cpp}
TDF_LabelSequence frshapes; TDF_LabelSequence frshapes;
myAssembly->GetShapes(frshapes); myAssembly->GetShapes(frshapes);
~~~~~ ~~~~
To get all free shapes at once if the list above has only one item, use: To get all free shapes at once if the list above has only one item, use:
~~~~~ ~~~~{.cpp}
TopoDS_Shape result = myAssembly->GetShape(frshapes.Value(1)); TopoDS_Shape result = myAssembly->GetShape(frshapes.Value(1));
~~~~~ ~~~~
If there is more than one item, you must create and fill a compound, use: If there is more than one item, you must create and fill a compound, use:
~~~~~ ~~~~{.cpp}
TopoDS_Compound C; TopoDS_Compound C;
BRep_Builder B; BRep_Builder B;
B.MakeCompound(C); B.MakeCompound(C);
@ -314,72 +314,72 @@ for(Standard_Integer i=1; i=frshapes.Length(); i++) {
TopoDS_Shape S = myAssembly->GetShape(frshapes.Value(i)); TopoDS_Shape S = myAssembly->GetShape(frshapes.Value(i));
B.Add(C,S); B.Add(C,S);
} }
~~~~~ ~~~~
In our example, the result is the compound C. In our example, the result is the compound C.
To determine if a shape is a free shape (no reference or super-assembly), use: To determine if a shape is a free shape (no reference or super-assembly), use:
~~~~~ ~~~~{.cpp}
if ( myAssembly->IsFree(aLabel) ) { .. yes .. } if ( myAssembly->IsFree(aLabel) ) { .. yes .. }
~~~~~ ~~~~
To get a list of Free Shapes (roots), use: To get a list of Free Shapes (roots), use:
~~~~~ ~~~~{.cpp}
TDF_LabelSequence frshapes; TDF_LabelSequence frshapes;
myAssembly->GetFreeShapes(frshapes); myAssembly->GetFreeShapes(frshapes);
~~~~~ ~~~~
To get the shapes, which use a given shape as a component, use: To get the shapes, which use a given shape as a component, use:
~~~~~ ~~~~{.cpp}
TDF_LabelSequence users; TDF_LabelSequence users;
Standard_Integer nbusers = myAssembly->GetUsers(aLabel,users); Standard_Integer nbusers = myAssembly->GetUsers(aLabel,users);
~~~~~ ~~~~
The count of users is contained with *nbusers*. It contains 0 if there are no users. The count of users is contained with *nbusers*. It contains 0 if there are no users.
#### Assembly and Components #### Assembly and Components
To determine if a label is attached to the main part or to a sub-part (component), use: To determine if a label is attached to the main part or to a sub-part (component), use:
~~~~~ ~~~~{.cpp}
if (myAssembly->IsComponent(aLabel)) { .. yes .. } if (myAssembly->IsComponent(aLabel)) { .. yes .. }
~~~~~ ~~~~
To determine whether a label is a node of a (sub-) assembly or a simple shape, use: To determine whether a label is a node of a (sub-) assembly or a simple shape, use:
~~~~~ ~~~~{.cpp}
if ( myAssembly->IsAssembly(aLabel) ) { .. yes .. } if ( myAssembly->IsAssembly(aLabel) ) { .. yes .. }
~~~~~ ~~~~
If the label is a node of a (sub-) assembly, you can get the count of components, use: If the label is a node of a (sub-) assembly, you can get the count of components, use:
~~~~~ ~~~~{.cpp}
Standard_Boolean subchilds = Standard_False; //default Standard_Boolean subchilds = Standard_False; //default
Standard_Integer nbc = myAssembly->NbComponents (aLabel [,subchilds]); Standard_Integer nbc = myAssembly->NbComponents (aLabel [,subchilds]);
~~~~~ ~~~~
If *subchilds* is True, commands also consider sub-levels. By default, only level one is checked. If *subchilds* is True, commands also consider sub-levels. By default, only level one is checked.
To get component Labels themselves, use: To get component Labels themselves, use:
~~~~~ ~~~~{.cpp}
Standard_Boolean subchilds = Standard_False; //default Standard_Boolean subchilds = Standard_False; //default
TDF_LabelSequence comps; TDF_LabelSequence comps;
Standard_Boolean isassembly = myAssembly->GetComponents Standard_Boolean isassembly = myAssembly->GetComponents
(aLabel,comps[,subchilds]); (aLabel,comps[,subchilds]);
~~~~~ ~~~~
@subsubsection occt_xde_2_2_9 Instances and References for Components @subsubsection occt_xde_2_2_9 Instances and References for Components
To determine if a label is a simple shape, use: To determine if a label is a simple shape, use:
~~~~~ ~~~~{.cpp}
if ( myAssembly->IsSimpleShape(aLabel) ) { .. yes .. } if ( myAssembly->IsSimpleShape(aLabel) ) { .. yes .. }
~~~~~ ~~~~
To determine if a label is a located reference to another one, use: To determine if a label is a located reference to another one, use:
~~~~~ ~~~~{.cpp}
if ( myAssembly->IsReference(aLabel) ) { .. yes .. } if ( myAssembly->IsReference(aLabel) ) { .. yes .. }
~~~~~ ~~~~
If the label is a located reference, you can get the location, use: If the label is a located reference, you can get the location, use:
~~~~~ ~~~~{.cpp}
TopLoc_Location loc = myAssembly->GetLocation (aLabel); TopLoc_Location loc = myAssembly->GetLocation (aLabel);
~~~~~ ~~~~
To get the label of a referenced original shape (also tests if it is a reference), use: To get the label of a referenced original shape (also tests if it is a reference), use:
~~~~~ ~~~~{.cpp}
Standard_Boolean isref = myAssembly->GetReferredShape Standard_Boolean isref = myAssembly->GetReferredShape
(aLabel, refLabel); (aLabel, refLabel);
~~~~~ ~~~~
**Note** *isref* returns False if *aLabel* is not for a reference. **Note** *isref* returns False if *aLabel* is not for a reference.
@ -387,55 +387,55 @@ Standard_Boolean isref = myAssembly->GetReferredShape
In addition to the previously described *AddShape* and *SetShape*, several shape edits are possible. In addition to the previously described *AddShape* and *SetShape*, several shape edits are possible.
To remove a Shape, and all its sub-labels, use: To remove a Shape, and all its sub-labels, use:
~~~~~ ~~~~{.cpp}
Standard_Boolean remsh = myAssembly->RemoveShape(aLabel); Standard_Boolean remsh = myAssembly->RemoveShape(aLabel);
// remsh is returned True if done // remsh is returned True if done
~~~~~ ~~~~
This operation will fail if the shape is neither free nor top level. This operation will fail if the shape is neither free nor top level.
To add a Component to the Assembly, from a new shape, use: To add a Component to the Assembly, from a new shape, use:
~~~~~ ~~~~{.cpp}
Standard_Boolean expand = Standard_False; //default Standard_Boolean expand = Standard_False; //default
TDF_Label aLabel = myAssembly->AddComponent (aShape [,expand]); TDF_Label aLabel = myAssembly->AddComponent (aShape [,expand]);
~~~~~ ~~~~
If *expand* is True and *aShape* is a Compound, *aShape* is broken down to produce sub-components, one for each of its sub-shapes. If *expand* is True and *aShape* is a Compound, *aShape* is broken down to produce sub-components, one for each of its sub-shapes.
To add a component to the assembly, from a previously recorded shape (the new component is defined by the label of the reference shape, and its location), use: To add a component to the assembly, from a previously recorded shape (the new component is defined by the label of the reference shape, and its location), use:
~~~~~ ~~~~{.cpp}
TDF_Label refLabel ...; // the label of reference shape TDF_Label refLabel ...; // the label of reference shape
TopLoc_Location loc ...; // the desired location TopLoc_Location loc ...; // the desired location
TDF_Label aLabel = myAssembly->AddComponent (refLabel, loc); TDF_Label aLabel = myAssembly->AddComponent (refLabel, loc);
~~~~~ ~~~~
To remove a component from the assembly, use: To remove a component from the assembly, use:
~~~~~ ~~~~{.cpp}
myAssembly->RemoveComponent (aLabel); myAssembly->RemoveComponent (aLabel);
~~~~~ ~~~~
@subsection occt_xde_2_4 Management of Sub-Shapes @subsection occt_xde_2_4 Management of Sub-Shapes
In addition to components of a (sub-)assembly, it is possible to have individual identification of some sub-shapes inside any shape. Therefore, you can attach specific attributes such as Colors. Some additional actions can be performed on sub-shapes that are neither top-level, nor components: In addition to components of a (sub-)assembly, it is possible to have individual identification of some sub-shapes inside any shape. Therefore, you can attach specific attributes such as Colors. Some additional actions can be performed on sub-shapes that are neither top-level, nor components:
To add a sub-shape to a given Label, use: To add a sub-shape to a given Label, use:
~~~~~ ~~~~{.cpp}
TDF_Label subLabel = myAssembly->AddSubShape (aLabel, subShape); TDF_Label subLabel = myAssembly->AddSubShape (aLabel, subShape);
~~~~~ ~~~~
To find the Label attached to a given sub-shape, use: To find the Label attached to a given sub-shape, use:
~~~~~ ~~~~{.cpp}
TDF_Label subLabel; // new label to be computed TDF_Label subLabel; // new label to be computed
if ( myAssembly-> FindSubShape (aLabel, subShape, subLabel)) { .. yes .. } if ( myAssembly-> FindSubShape (aLabel, subShape, subLabel)) { .. yes .. }
~~~~~ ~~~~
If the sub-shape is found (yes), *subLabel* is filled by the correct value. If the sub-shape is found (yes), *subLabel* is filled by the correct value.
To find the top-level simple shape (not a compound whether free or not), which contains a given sub-shape, use: To find the top-level simple shape (not a compound whether free or not), which contains a given sub-shape, use:
~~~~~ ~~~~{.cpp}
TDF_Label mainLabel = myAssembly->FindMainShape(subShape); TDF_Label mainLabel = myAssembly->FindMainShape(subShape);
~~~~~ ~~~~
**Note** that there should be only one shape for a valid model. In any case, the search stops on the first one found. **Note** that there should be only one shape for a valid model. In any case, the search stops on the first one found.
To get the sub-shapes of a shape, which are recorded under a label, use: To get the sub-shapes of a shape, which are recorded under a label, use:
~~~~~ ~~~~{.cpp}
TDF_LabelSequence subs; TDF_LabelSequence subs;
Standard_Boolean hassubs = myAssembly->GetSubShapes (aLabel,subs); Standard_Boolean hassubs = myAssembly->GetSubShapes (aLabel,subs);
~~~~~ ~~~~
@subsection occt_xde_2_5 Properties @subsection occt_xde_2_5 Properties
Some properties can be attached directly to shapes. These properties are: Some properties can be attached directly to shapes. These properties are:
* Name (standard definition from OCAF) * Name (standard definition from OCAF)
@ -458,22 +458,22 @@ Name is implemented and used as a *TDataStd_Name*, which can be attached to any
These considerations are not specific to XDE. What is specific to data exchange is the way names are attached to entities. These considerations are not specific to XDE. What is specific to data exchange is the way names are attached to entities.
To get the name attached to a label (as a reminder using OCAF), use: To get the name attached to a label (as a reminder using OCAF), use:
~~~~~ ~~~~{.cpp}
Handle(TDataStd_Name) N; Handle(TDataStd_Name) N;
if ( !aLabel.FindAttribute(TDataStd_Name::GetID(),N)) { if ( !aLabel.FindAttribute(TDataStd_Name::GetID(),N)) {
// no name is attached // no name is attached
} }
TCollection_ExtendedString name = N->Get(); TCollection_ExtendedString name = N->Get();
~~~~~ ~~~~
Don't forget to consider Extended String as ASCII, for the exchange file. Don't forget to consider Extended String as ASCII, for the exchange file.
To set a name to a label (as a reminder using OCAF), use: To set a name to a label (as a reminder using OCAF), use:
~~~~~ ~~~~{.cpp}
TCollection_ExtendedString aName ...; TCollection_ExtendedString aName ...;
// contains the desired name for this Label (ASCII) // contains the desired name for this Label (ASCII)
TDataStd_Name::Set (aLabel, aName); TDataStd_Name::Set (aLabel, aName);
~~~~~ ~~~~
@subsubsection occt_xde_2_5_2 Centroid @subsubsection occt_xde_2_5_2 Centroid
A Centroid is defined by a Point to fix its position. It is handled as a property, item of the class *XCAFDoc_Centroid*, sub-class of *TDF_Attribute*. However, global methods give access to the position itself. A Centroid is defined by a Point to fix its position. It is handled as a property, item of the class *XCAFDoc_Centroid*, sub-class of *TDF_Attribute*. However, global methods give access to the position itself.
@ -483,26 +483,26 @@ This notion has been introduced in STEP, together with that of Volume, and Area,
A centroid can be determined at any level of an assembly, thereby allowing a check of both individual simple shapes and their combinations including locations. A centroid can be determined at any level of an assembly, thereby allowing a check of both individual simple shapes and their combinations including locations.
To get a Centroid attached to a Shape, use: To get a Centroid attached to a Shape, use:
~~~~~ ~~~~{.cpp}
gp_Pnt pos; gp_Pnt pos;
Handle(XCAFDoc_Centroid) C; Handle(XCAFDoc_Centroid) C;
aLabel.FindAttribute ( XCAFDoc_Centroid::GetID(), C ); aLabel.FindAttribute ( XCAFDoc_Centroid::GetID(), C );
if ( !C.IsNull() ) pos = C->Get(); if ( !C.IsNull() ) pos = C->Get();
~~~~~ ~~~~
To set a Centroid to a Shape, use: To set a Centroid to a Shape, use:
~~~~~ ~~~~{.cpp}
gp_Pnt pos (X,Y,Z); gp_Pnt pos (X,Y,Z);
// the position previously computed for the centroid // the position previously computed for the centroid
XCAFDoc_Centroid::Set ( aLabel, pos ); XCAFDoc_Centroid::Set ( aLabel, pos );
~~~~~ ~~~~
@subsubsection occt_xde_2_5_3 Area @subsubsection occt_xde_2_5_3 Area
An Area is defined by a Real, it corresponds to the computed Area of a Shape, provided that it contains surfaces. It is handled as a property, item of the class *XCAFDoc_Area*, sub-class of *TDF_Attribute*. An Area is defined by a Real, it corresponds to the computed Area of a Shape, provided that it contains surfaces. It is handled as a property, item of the class *XCAFDoc_Area*, sub-class of *TDF_Attribute*.
This notion has been introduced in STEP but it is usually disregarded for a Solid, as Volume is used instead. In addition, it is attached to simple shapes, not to assemblies. This notion has been introduced in STEP but it is usually disregarded for a Solid, as Volume is used instead. In addition, it is attached to simple shapes, not to assemblies.
To get an area attached to a Shape, use: To get an area attached to a Shape, use:
~~~~~ ~~~~{.cpp}
Standard_Real area; Standard_Real area;
Handle(XCAFDoc_Area) A; Handle(XCAFDoc_Area) A;
L.FindAttribute ( XCAFDoc_Area::GetID(), A ); L.FindAttribute ( XCAFDoc_Area::GetID(), A );
@ -512,25 +512,25 @@ To set an area value to a Shape, use:
Standard_Real area ...; Standard_Real area ...;
// value previously computed for the area // value previously computed for the area
XCAFDoc_Area::Set ( aLabel, area ); XCAFDoc_Area::Set ( aLabel, area );
~~~~~ ~~~~
@subsubsection occt_xde_2_5_4 Volume @subsubsection occt_xde_2_5_4 Volume
A Volume is defined by a Real and corresponds to the computed volume of a Shape, provided that it contains solids. It is handled as a property, an item of the class *XCAFDoc_Volume*, sub-class of *TDF_Attribute*. A Volume is defined by a Real and corresponds to the computed volume of a Shape, provided that it contains solids. It is handled as a property, an item of the class *XCAFDoc_Volume*, sub-class of *TDF_Attribute*.
This notion has been introduced in STEP. It may be attached to simple shapes or their assemblies for computing cumulated volumes and centers of gravity. This notion has been introduced in STEP. It may be attached to simple shapes or their assemblies for computing cumulated volumes and centers of gravity.
To get a Volume attached to a Shape, use: To get a Volume attached to a Shape, use:
~~~~~ ~~~~{.cpp}
Standard_Real volume; Standard_Real volume;
Handle(XCAFDoc_Volume) V; Handle(XCAFDoc_Volume) V;
L.FindAttribute ( XCAFDoc_Volume::GetID(), V ); L.FindAttribute ( XCAFDoc_Volume::GetID(), V );
if ( !V.IsNull() ) volume = V->Get(); if ( !V.IsNull() ) volume = V->Get();
~~~~~ ~~~~
To set a volume value to a Shape, use: To set a volume value to a Shape, use:
~~~~~ ~~~~{.cpp}
Standard_Real volume ...; Standard_Real volume ...;
// value previously computed for the volume // value previously computed for the volume
XCAFDoc_Volume::Set ( aLabel, volume ); XCAFDoc_Volume::Set ( aLabel, volume );
~~~~~ ~~~~
@subsection occt_xde_2_6 Colors and Layers @subsection occt_xde_2_6 Colors and Layers
XDE can read and write colors and layers assigned to shapes or their subparts (down to level of faces and edges) to and from both IGES and STEP formats. XDE can read and write colors and layers assigned to shapes or their subparts (down to level of faces and edges) to and from both IGES and STEP formats.
@ -553,10 +553,10 @@ These definitions are common to various exchange formats, at least for STEP and
@subsubsection occt_xde_2_6_1 Initialization @subsubsection occt_xde_2_6_1 Initialization
To query, edit, or initialize a Document to handle Colors of XCAF, use: To query, edit, or initialize a Document to handle Colors of XCAF, use:
~~~~~ ~~~~{.cpp}
Handle(XCAFDoc_ColorTool) myColors = Handle(XCAFDoc_ColorTool) myColors =
XCAFDoc_DocumentTool::ColorTool(Doc->Main ()); XCAFDoc_DocumentTool::ColorTool(Doc->Main ());
~~~~~ ~~~~
This call can be used at any time. The first time it is used, a relevant structure is added to the document. This definition is used for all the following color calls and will not be repeated for these. This call can be used at any time. The first time it is used, a relevant structure is added to the document. This definition is used for all the following color calls and will not be repeated for these.
@subsubsection occt_xde_2_6_2 Adding a Color @subsubsection occt_xde_2_6_2 Adding a Color
@ -566,7 +566,7 @@ There are two ways to add a color. You can:
When the Color is added by its value *Quantity_Color*, it is added only if it has not yet been recorded (same RGB values) in the Document. When the Color is added by its value *Quantity_Color*, it is added only if it has not yet been recorded (same RGB values) in the Document.
To set a Color to a Shape using a label, use: To set a Color to a Shape using a label, use:
~~~~~ ~~~~{.cpp}
Quantity_Color Col (red,green,blue); Quantity_Color Col (red,green,blue);
XCAFDoc_ColorType ctype ..; XCAFDoc_ColorType ctype ..;
// can take one of these values : // can take one of these values :
@ -574,60 +574,60 @@ XCAFDoc_ColorType ctype ..;
// XCAFDoc_ColorSurf : surfaces only // XCAFDoc_ColorSurf : surfaces only
// XCAFDoc_ColorCurv : curves only // XCAFDoc_ColorCurv : curves only
myColors->SetColor ( aLabel, Col, ctype ); myColors->SetColor ( aLabel, Col, ctype );
~~~~~ ~~~~
Alternately, the Shape can be designated directly, without using its label, use: Alternately, the Shape can be designated directly, without using its label, use:
~~~~~ ~~~~{.cpp}
myColors->SetColor ( aShape, Col, ctype ); myColors->SetColor ( aShape, Col, ctype );
// Creating and Adding a Color, explicitly // Creating and Adding a Color, explicitly
Quantity_Color Col (red,green,blue); Quantity_Color Col (red,green,blue);
TDF_Label ColLabel = myColors->AddColor ( Col ); TDF_Label ColLabel = myColors->AddColor ( Col );
~~~~~ ~~~~
**Note** that this Color can then be named, allowing later retrieval by its Name instead of its Value. **Note** that this Color can then be named, allowing later retrieval by its Name instead of its Value.
To set a Color, identified by its Label and already recorded, to a Shape, use: To set a Color, identified by its Label and already recorded, to a Shape, use:
~~~~~ ~~~~{.cpp}
XCAFDoc_ColorType ctype ..; // see above XCAFDoc_ColorType ctype ..; // see above
if ( myColors->SetColors ( aLabel, ColLabel, ctype) ) {.. it is done .. } if ( myColors->SetColors ( aLabel, ColLabel, ctype) ) {.. it is done .. }
~~~~~ ~~~~
In this example, *aLabel* can be replaced by *aShape* directly. In this example, *aLabel* can be replaced by *aShape* directly.
@subsubsection occt_xde_2_6_3 Queries on Colors @subsubsection occt_xde_2_6_3 Queries on Colors
Various queries can be performed on colors. However, only specific queries are included in this section, not general queries using names. Various queries can be performed on colors. However, only specific queries are included in this section, not general queries using names.
To determine if a Color is attached to a Shape, for a given color type (ctype), use: To determine if a Color is attached to a Shape, for a given color type (ctype), use:
~~~~~ ~~~~{.cpp}
if ( myColors->IsSet (aLabel , ctype)) { if ( myColors->IsSet (aLabel , ctype)) {
// yes, there is one .. // yes, there is one ..
} }
~~~~~ ~~~~
In this example, *aLabel* can be replaced by *aShape* directly. In this example, *aLabel* can be replaced by *aShape* directly.
To get the Color attached to a Shape (for any color type), use: To get the Color attached to a Shape (for any color type), use:
~~~~~ ~~~~{.cpp}
Quantity_Color col; Quantity_Color col;
// will receive the recorded value (if there is some) // will receive the recorded value (if there is some)
if ( !myColors->GetColor(aLabel, col) ) { if ( !myColors->GetColor(aLabel, col) ) {
// sorry, no color .. // sorry, no color ..
} }
~~~~~ ~~~~
Color name can also be queried from *col.StringName* or *col.Name*. Color name can also be queried from *col.StringName* or *col.Name*.
In this example, *aLabel* can be replaced by *aShape* directly. In this example, *aLabel* can be replaced by *aShape* directly.
To get the Color attached to a Shape, with a specific color type, use: To get the Color attached to a Shape, with a specific color type, use:
~~~~~ ~~~~{.cpp}
XCAFDoc_ColorType ctype ..; XCAFDoc_ColorType ctype ..;
Quantity_Color col; Quantity_Color col;
// will receive the recorded value (if there is some) // will receive the recorded value (if there is some)
if ( !myColors->GetColor(aLabel, ctype, col) ) { if ( !myColors->GetColor(aLabel, ctype, col) ) {
// sorry, no color .. // sorry, no color ..
} }
~~~~~ ~~~~
To get all the Colors recorded in the Document, use: To get all the Colors recorded in the Document, use:
~~~~~ ~~~~{.cpp}
Quantity_Color col; // to receive the values Quantity_Color col; // to receive the values
TDF_LabelSequence ColLabels; TDF_LabelSequence ColLabels;
myColors->GetColors(ColLabels); myColors->GetColors(ColLabels);
@ -637,28 +637,28 @@ for (i = 1; i = nbc; i ++) {
if ( !myColors->GetColor(aLabel, col) ) continue; if ( !myColors->GetColor(aLabel, col) ) continue;
// col receives the color n0 i .. // col receives the color n0 i ..
} }
~~~~~ ~~~~
To find a Color from its Value, use: To find a Color from its Value, use:
~~~~~ ~~~~{.cpp}
Quantity_Color Col (red,green,blue); Quantity_Color Col (red,green,blue);
TDF_Label ColLabel = myColors-FindColor (Col); TDF_Label ColLabel = myColors-FindColor (Col);
if ( !ColLabel.IsNull() ) { .. found .. } if ( !ColLabel.IsNull() ) { .. found .. }
~~~~~ ~~~~
@subsubsection occt_xde_2_6_4 Editing Colors @subsubsection occt_xde_2_6_4 Editing Colors
Besides adding colors, the following attribute edits can be made: Besides adding colors, the following attribute edits can be made:
To unset a Color on a Shape, use: To unset a Color on a Shape, use:
~~~~~ ~~~~{.cpp}
XCAFDoc_ColorType ctype ...; XCAFDoc_ColorType ctype ...;
// desired type (XCAFDoc_ColorGen for all ) // desired type (XCAFDoc_ColorGen for all )
myColors->UnSetColor (aLabel,ctype); myColors->UnSetColor (aLabel,ctype);
~~~~~ ~~~~
To remove a Color and all the references to it (so that the related shapes will become colorless), use: To remove a Color and all the references to it (so that the related shapes will become colorless), use:
~~~~~ ~~~~{.cpp}
myColors->RemoveColor(ColLabel); myColors->RemoveColor(ColLabel);
~~~~~ ~~~~
@subsection occt_xde_2_7 Geometric Dimensions & Tolerances (GD\&T) @subsection occt_xde_2_7 Geometric Dimensions & Tolerances (GD\&T)
@ -683,10 +683,10 @@ These definitions are common to various exchange formats, at least for STEP.
@subsubsection occt_xde_2_7_1 Initialization @subsubsection occt_xde_2_7_1 Initialization
To query, edit, or initialize a Document to handle GD\&Ts of XCAF, use: To query, edit, or initialize a Document to handle GD\&Ts of XCAF, use:
~~~~~ ~~~~{.cpp}
Handle(XCAFDoc_DimTolTool) myDimTolTool = Handle(XCAFDoc_DimTolTool) myDimTolTool =
XCAFDoc_DocumentTool::DimTolTool(Doc->Main()); XCAFDoc_DocumentTool::DimTolTool(Doc->Main());
~~~~~ ~~~~
This call can be used at any time. When it is used for the first time, a relevant structure is added to the document. This definition is used for all later GD\&T calls and is not repeated for them. This call can be used at any time. When it is used for the first time, a relevant structure is added to the document. This definition is used for all later GD\&T calls and is not repeated for them.
@subsubsection occt_xde_2_7_2 Adding a GD\&T @subsubsection occt_xde_2_7_2 Adding a GD\&T
@ -699,19 +699,19 @@ All methods create a sub-label for the corresponding GD\&T entity of the tool ma
created entity. created entity.
Here is an example of adding a new dimension: Here is an example of adding a new dimension:
~~~~~ ~~~~{.cpp}
TDF_Label aDimLabel = myDimTolTool->AddDimension(); TDF_Label aDimLabel = myDimTolTool->AddDimension();
if (!aDimLabel.IsNull()) if (!aDimLabel.IsNull())
{ {
// error processing // error processing
} }
~~~~~ ~~~~
A similar approach can be used for other GD\&T types. A similar approach can be used for other GD\&T types.
@subsubsection occt_xde_2_7_3 Editing a GD\&T @subsubsection occt_xde_2_7_3 Editing a GD\&T
A newly added GD\&T entity is empty. To set its data a corresponding access object should be used as it is demonstrated A newly added GD\&T entity is empty. To set its data a corresponding access object should be used as it is demonstrated
below, where the dimension becomes a linear distance between two points. below, where the dimension becomes a linear distance between two points.
~~~~~ ~~~~{.cpp}
Handle(XCAFDoc_Dimension) aDimAttr; Handle(XCAFDoc_Dimension) aDimAttr;
aDimLabel.FindAttribute(XCAFDoc_Dimension::GetID(), aDimAttr); aDimLabel.FindAttribute(XCAFDoc_Dimension::GetID(), aDimAttr);
if (!aDimAttr.IsNull()) if (!aDimAttr.IsNull())
@ -725,7 +725,7 @@ if (!aDimAttr.IsNull())
//... //...
aDimAttr->SetObject(aDimObject); aDimAttr->SetObject(aDimObject);
} }
~~~~~ ~~~~
A similar approach can be used for other GD\&T types. A similar approach can be used for other GD\&T types.
@subsubsection occt_xde_2_7_4 Linking GD\&Ts @subsubsection occt_xde_2_7_4 Linking GD\&Ts
@ -737,14 +737,14 @@ To link a GD\&T entity with other OCAF labels (e.g. representing shapes) one sho
These methods can take a single label or a sequence of labels. All previous links will be removed. These methods can take a single label or a sequence of labels. All previous links will be removed.
The example below demonstrates linking of a dimension to sequences of shape labels: The example below demonstrates linking of a dimension to sequences of shape labels:
~~~~~ ~~~~{.cpp}
TDF_LabelSequence aShapes1, aShapes2; TDF_LabelSequence aShapes1, aShapes2;
aShapes1.Append(aShape11); aShapes1.Append(aShape11);
//... //...
aShapes2.Append(aShape21); aShapes2.Append(aShape21);
//... //...
aDGTTool->SetDimension(aShapes1, aShapes2, aDimLabel); aDGTTool->SetDimension(aShapes1, aShapes2, aDimLabel);
~~~~~ ~~~~
In addition, a special method *SetDatumToGeomTol* should be used to link a datum with a geometric tolerance. In addition, a special method *SetDatumToGeomTol* should be used to link a datum with a geometric tolerance.
@ -772,14 +772,14 @@ Custom data can be stored in labels with tags beyond the ranges listed above.
In an XDE document, Clipping planes are managed by the class *XCAFDoc_ClippingPlaneTool*. It works basing on the same principles as ShapeTool works with Shapes. This tool can be provided on the Main Label or on any sub-label. Clipping planes are stored in a child of the starting document label 0.1.8, where planes themselves are defined as *TDataXtd_Plane* attribute. *TDataStd_Name* attribute is used for naming. In an XDE document, Clipping planes are managed by the class *XCAFDoc_ClippingPlaneTool*. It works basing on the same principles as ShapeTool works with Shapes. This tool can be provided on the Main Label or on any sub-label. Clipping planes are stored in a child of the starting document label 0.1.8, where planes themselves are defined as *TDataXtd_Plane* attribute. *TDataStd_Name* attribute is used for naming.
To query, edit, or initialize a Document to handle clipping planes of XCAF, use: To query, edit, or initialize a Document to handle clipping planes of XCAF, use:
~~~~~ ~~~~{.cpp}
Handle(XCAFDoc_ClippingPlaneTool) myClipPlaneTool = Handle(XCAFDoc_ClippingPlaneTool) myClipPlaneTool =
XCAFDoc_DocumentTool::ClippingPlaneTool(Doc->Main()); XCAFDoc_DocumentTool::ClippingPlaneTool(Doc->Main());
~~~~~ ~~~~
This call can be used at any time. When it is used for the first time, a relevant structure is added to the document. This call can be used at any time. When it is used for the first time, a relevant structure is added to the document.
To add a clipping plane use one of overloaded methods *AddClippingPlane*, e.g.: To add a clipping plane use one of overloaded methods *AddClippingPlane*, e.g.:
~~~~~ ~~~~{.cpp}
gp_Pln aPln = ... gp_Pln aPln = ...
Standard_Boolean aCapping = ... Standard_Boolean aCapping = ...
TDF_Label aClipPlnLbl = myClipPlaneTool->AddClippingPlane(aPln, "Name of plane", aCapping); TDF_Label aClipPlnLbl = myClipPlaneTool->AddClippingPlane(aPln, "Name of plane", aCapping);
@ -787,31 +787,31 @@ if (aClipPlnLbl.IsNull())
{ {
// error processing // error processing
} }
~~~~~ ~~~~
To remove a plane use *RemoveClippingPlane* method, e.g.: To remove a plane use *RemoveClippingPlane* method, e.g.:
~~~~~ ~~~~{.cpp}
if (!myClipPlaneTool->RemoveClippingPlane(aClipPlnLbl)) if (!myClipPlaneTool->RemoveClippingPlane(aClipPlnLbl))
{ {
// not removed // not removed
} }
~~~~~ ~~~~
The plane will not be removed if it is referenced in at least one view. The plane will not be removed if it is referenced in at least one view.
To change the clipping plane and its name use *UpdateClippingPlane* method, e.g.: To change the clipping plane and its name use *UpdateClippingPlane* method, e.g.:
~~~~~ ~~~~{.cpp}
gp_Pln aPln = ... gp_Pln aPln = ...
myClipPlaneTool->UpdateClippingPlane(aClipPlnLbl, aPln, "New name of plane"); myClipPlaneTool->UpdateClippingPlane(aClipPlnLbl, aPln, "New name of plane");
~~~~~ ~~~~
Capping property can be changed using *SetCapping* method, e.g.: Capping property can be changed using *SetCapping* method, e.g.:
~~~~~ ~~~~{.cpp}
Standard_Boolean aCapping = ... Standard_Boolean aCapping = ...
myClipPlaneTool->SetCapping(aClipPlnLbl, aCapping); myClipPlaneTool->SetCapping(aClipPlnLbl, aCapping);
~~~~~ ~~~~
*XCAFDoc_ClippingPlaneTool* can be used to get all clipping plane labels and to check if a label belongs to the *ClippingPlane table*, e.g.: *XCAFDoc_ClippingPlaneTool* can be used to get all clipping plane labels and to check if a label belongs to the *ClippingPlane table*, e.g.:
~~~~~ ~~~~{.cpp}
TDF_LabelSequence aClipPlaneLbls; TDF_LabelSequence aClipPlaneLbls;
myClipPlaneTool->GetClippingPlanes(aClipPlaneLbls); myClipPlaneTool->GetClippingPlanes(aClipPlaneLbls);
... ...
@ -830,21 +830,21 @@ for (TDF_LabelSequence::Iterator anIt(aClipPlaneLbls); anIt.More(); anIt.Next())
... ...
} }
} }
~~~~~ ~~~~
@subsection occt_xde_2_9 Saved views @subsection occt_xde_2_9 Saved views
In an XDE document, Views are managed by the class *XCAFDoc_ViewTool*. It works basing on the same principles as ShapeTool works with Shapes. This tool can be provided on the Main Label or on any sub-label. Views are stored in a child of the starting document label 0.1.7, where a view itself is defined as *XCAFDoc_View* sub-class of *TDF_Attribute*. Views and selected shapes, clipping planes, GD\&Ts and notes are related by Graph Nodes. In an XDE document, Views are managed by the class *XCAFDoc_ViewTool*. It works basing on the same principles as ShapeTool works with Shapes. This tool can be provided on the Main Label or on any sub-label. Views are stored in a child of the starting document label 0.1.7, where a view itself is defined as *XCAFDoc_View* sub-class of *TDF_Attribute*. Views and selected shapes, clipping planes, GD\&Ts and notes are related by Graph Nodes.
To query, edit, or initialize a Document to handle views of XCAF, use: To query, edit, or initialize a Document to handle views of XCAF, use:
~~~~~ ~~~~{.cpp}
Handle(XCAFDoc_ViewTool) myViewTool = Handle(XCAFDoc_ViewTool) myViewTool =
XCAFDoc_DocumentTool::ViewTool(Doc->Main()); XCAFDoc_DocumentTool::ViewTool(Doc->Main());
~~~~~ ~~~~
This call can be used at any time. When it is used for the first time, a relevant structure is added to the document. This call can be used at any time. When it is used for the first time, a relevant structure is added to the document.
To add a view use *AddView* method and an access *XCAFView_Object* object to set camera parameters, e.g.: To add a view use *AddView* method and an access *XCAFView_Object* object to set camera parameters, e.g.:
~~~~~ ~~~~{.cpp}
TDF_Label aViewLbl = myViewTool->AddView(); TDF_Label aViewLbl = myViewTool->AddView();
if (aViewLbl.IsNull()) if (aViewLbl.IsNull())
{ {
@ -862,22 +862,22 @@ if (!aViewAttr.IsNull())
... ...
aViewAttr->SetObject(aViewObject); aViewAttr->SetObject(aViewObject);
} }
~~~~~ ~~~~
To set shapes, clipping planes, GD\&Ts and notes selected for the view use one of overloaded *SetView* methods of *XCAFDoc_ViewTool*. To set shapes, clipping planes, GD\&Ts and notes selected for the view use one of overloaded *SetView* methods of *XCAFDoc_ViewTool*.
To set only clipping planes one should use *SetClippingPlanes* method. To set only clipping planes one should use *SetClippingPlanes* method.
~~~~~ ~~~~{.cpp}
TDF_LabelSequence aShapes; ... TDF_LabelSequence aShapes; ...
TDF_LabelSequence aGDTs; ... TDF_LabelSequence aGDTs; ...
myViewTool->SetView(aShapes, aGDTs, aViewLbl); myViewTool->SetView(aShapes, aGDTs, aViewLbl);
TDF_LabelSequence aClippingPlanes; ... TDF_LabelSequence aClippingPlanes; ...
myViewTool->SetClippingPlanes(aClippingPlanes, aViewLbl); myViewTool->SetClippingPlanes(aClippingPlanes, aViewLbl);
~~~~~ ~~~~
To remove a view use *RemoveView* method. To remove a view use *RemoveView* method.
To get all view labels and check if a label belongs to the View table use: To get all view labels and check if a label belongs to the View table use:
~~~~~ ~~~~{.cpp}
TDF_LabelSequence aViewLbls; TDF_LabelSequence aViewLbls;
myViewTool->GetViewLabels(aViewLbls); myViewTool->GetViewLabels(aViewLbls);
... ...
@ -889,7 +889,7 @@ for (TDF_LabelSequence::Iterator anIt(aViewLbls); anIt.More(); anIt.Next())
... ...
} }
} }
~~~~~ ~~~~
To get shapes, clipping planes, GD\&Ts or notes associated with a particular view use the following methods: To get shapes, clipping planes, GD\&Ts or notes associated with a particular view use the following methods:
* *GetRefShapeLabel* - returns a sequence of associated shape labels; * *GetRefShapeLabel* - returns a sequence of associated shape labels;
@ -920,10 +920,10 @@ Notes binding is done through *XCAFDoc_GraphNode* attribute.
@subsubsection occt_xde_2_10_1 Initialization @subsubsection occt_xde_2_10_1 Initialization
To query, edit, or initialize a Document to handle custom notes of XCAF, use: To query, edit, or initialize a Document to handle custom notes of XCAF, use:
~~~~~ ~~~~{.cpp}
Handle(XCAFDoc_NotesTool) myNotes = Handle(XCAFDoc_NotesTool) myNotes =
XCAFDoc_DocumentTool::NotesTool(Doc->Main ()); XCAFDoc_DocumentTool::NotesTool(Doc->Main ());
~~~~~ ~~~~
This call can be used at any time. The first time it is used, a relevant structure is added to the document. This definition is used for all later notes calls and will not be repeated for them. This call can be used at any time. The first time it is used, a relevant structure is added to the document. This definition is used for all later notes calls and will not be repeated for them.
@subsubsection occt_xde_2_10_2 Creating Notes @subsubsection occt_xde_2_10_2 Creating Notes
@ -933,25 +933,25 @@ Before annotating a Document item a note must be created using one of the follow
- *CreateBinData* : creates a note with arbitrary binary data, e.g. contents of a file. - *CreateBinData* : creates a note with arbitrary binary data, e.g. contents of a file.
Both methods return an instance of *XCAFDoc_Note* class. Both methods return an instance of *XCAFDoc_Note* class.
~~~~~ ~~~~{.cpp}
Handle(XCAFDoc_NotesTool) myNotes = ... Handle(XCAFDoc_NotesTool) myNotes = ...
Handle(XCAFDoc_Note) myNote = myNotes->CreateComment("User", "Timestamp", "Hello, World!"); Handle(XCAFDoc_Note) myNote = myNotes->CreateComment("User", "Timestamp", "Hello, World!");
~~~~~ ~~~~
This code adds a child label to label 0.1.9.1 with *XCAFDoc_NoteComment* attribute. This code adds a child label to label 0.1.9.1 with *XCAFDoc_NoteComment* attribute.
@subsubsection occt_xde_2_10_3 Editing a Note @subsubsection occt_xde_2_10_3 Editing a Note
An instance of *XCAFDoc_Note* class can be used for note editing. An instance of *XCAFDoc_Note* class can be used for note editing.
One may change common note data. One may change common note data.
~~~~~ ~~~~{.cpp}
myNote->Set("New User", "New Timestamp"); myNote->Set("New User", "New Timestamp");
~~~~~ ~~~~
To change specific data one needs to down cast *myNote* handle to the appropriate sub-class: To change specific data one needs to down cast *myNote* handle to the appropriate sub-class:
~~~~~ ~~~~{.cpp}
Handle(XCAFDoc_NoteComment) myCommentNote = Handle(XCAFDoc_NoteComment)::DownCast(myNote); Handle(XCAFDoc_NoteComment) myCommentNote = Handle(XCAFDoc_NoteComment)::DownCast(myNote);
if (!myCommentNote.IsNull()) { if (!myCommentNote.IsNull()) {
myCommentNote->Set("New comment"); myCommentNote->Set("New comment");
} }
~~~~~ ~~~~
In order to edit auxiliary note data such as text and attachment position, plane for rendering and tessellated presentation, In order to edit auxiliary note data such as text and attachment position, plane for rendering and tessellated presentation,
one should use a transfer object *XCAFNoteObjects_NoteObject* by GetObject and SetObject methods of *XCAFDoc_Note* class. one should use a transfer object *XCAFNoteObjects_NoteObject* by GetObject and SetObject methods of *XCAFDoc_Note* class.
*XCAFNoteObjects_NoteObject* class provides the following functionality: *XCAFNoteObjects_NoteObject* class provides the following functionality:
@ -961,7 +961,7 @@ one should use a transfer object *XCAFNoteObjects_NoteObject* by GetObject and S
- GetPresentation and SetPresentation methods allow to test for and specify tessellated presentation - GetPresentation and SetPresentation methods allow to test for and specify tessellated presentation
After getting, the transfer object can be edited and set back to the note: After getting, the transfer object can be edited and set back to the note:
~~~~~ ~~~~{.cpp}
Handle(XCAFNoteObjects_NoteObject) aNoteObj = myNote->GetObject(); Handle(XCAFNoteObjects_NoteObject) aNoteObj = myNote->GetObject();
if (!aNoteObj.IsNull()) if (!aNoteObj.IsNull())
{ {
@ -971,7 +971,7 @@ if (!aNoteObj.IsNull())
aNoteObj->SetPresentation (aS); aNoteObj->SetPresentation (aS);
myNote->SetObject (aNoteObj); myNote->SetObject (aNoteObj);
} }
~~~~~ ~~~~
@subsubsection occt_xde_2_10_4 Adding Notes @subsubsection occt_xde_2_10_4 Adding Notes
@ -981,7 +981,7 @@ Once a note has been created it can be bound to a Document item using the follow
- *AddNoteToSubshape* : binds a note to a sub-shape. - *AddNoteToSubshape* : binds a note to a sub-shape.
All methods return a pointer to *XCAFDoc_AssemblyItemRef* attribute identifying the annotated item. All methods return a pointer to *XCAFDoc_AssemblyItemRef* attribute identifying the annotated item.
~~~~~ ~~~~{.cpp}
Handle(XCAFDoc_NotesTool) myNotes = ... Handle(XCAFDoc_NotesTool) myNotes = ...
Handle(XCAFDoc_Note) myNote = ... Handle(XCAFDoc_Note) myNote = ...
TDF_Label theLabel; ... TDF_Label theLabel; ...
@ -990,7 +990,7 @@ Standard_GUID theAttrGUID; ...
Handle(XCAFDoc_AssemblyItemRef) myRefAttr = myNotes->AddNoteToAttr(myNote->Label(), theAttrGUID); Handle(XCAFDoc_AssemblyItemRef) myRefAttr = myNotes->AddNoteToAttr(myNote->Label(), theAttrGUID);
Standard_Integer theSubshape = 1; Standard_Integer theSubshape = 1;
Handle(XCAFDoc_AssemblyItemRef) myRefSubshape = myNotes->AddNoteToSubshape(myNote->Label(), theSubshape); Handle(XCAFDoc_AssemblyItemRef) myRefSubshape = myNotes->AddNoteToSubshape(myNote->Label(), theSubshape);
~~~~~ ~~~~
This code adds three child labels with *XCAFDoc_AssemblyItemRef* attribute to label 0.1.9.2. *XCAFDoc_GraphNode* attributes are added to the child labels and note labels. This code adds three child labels with *XCAFDoc_AssemblyItemRef* attribute to label 0.1.9.2. *XCAFDoc_GraphNode* attributes are added to the child labels and note labels.
@subsubsection occt_xde_2_10_5 Finding Notes @subsubsection occt_xde_2_10_5 Finding Notes
@ -1000,7 +1000,7 @@ To find annotation labels under label 0.1.9.2 use the following *XCAFDoc_NotesTo
- *FindAnnotatedItemAttr* : returns an annotation label for a label's attribute; - *FindAnnotatedItemAttr* : returns an annotation label for a label's attribute;
- *FindAnnotatedItemSubshape* : returns an annotation label for a sub-shape. - *FindAnnotatedItemSubshape* : returns an annotation label for a sub-shape.
~~~~~ ~~~~{.cpp}
Handle(XCAFDoc_NotesTool) myNotes = ... Handle(XCAFDoc_NotesTool) myNotes = ...
TDF_Label theLabel; ... TDF_Label theLabel; ...
TDF_Label myLabel = myNotes->FindAnnotatedItem(theLabel); TDF_Label myLabel = myNotes->FindAnnotatedItem(theLabel);
@ -1008,7 +1008,7 @@ Standard_GUID theAttrGUID; ...
TDF_Label myLabelAttr = myNotes->FindAnnotatedItemAttr(theLabel, theAttrGUID); TDF_Label myLabelAttr = myNotes->FindAnnotatedItemAttr(theLabel, theAttrGUID);
Standard_Integer theSubshape = 1; Standard_Integer theSubshape = 1;
TDF_Label myLabelSubshape = myNotes->FindAnnotatedItemSubshape(theLabel, theSubshape); TDF_Label myLabelSubshape = myNotes->FindAnnotatedItemSubshape(theLabel, theSubshape);
~~~~~ ~~~~
Null label will be returned if there is no corresponding annotation. Null label will be returned if there is no corresponding annotation.
To get all notes of the Document item use the following *XCAFDoc_NotesTool* methods: To get all notes of the Document item use the following *XCAFDoc_NotesTool* methods:
@ -1017,7 +1017,7 @@ To get all notes of the Document item use the following *XCAFDoc_NotesTool* meth
- *GetAttrSubshape* : outputs a sequence of note labels bound to a sub-shape. - *GetAttrSubshape* : outputs a sequence of note labels bound to a sub-shape.
All these methods return the number of notes. All these methods return the number of notes.
~~~~~ ~~~~{.cpp}
Handle(XCAFDoc_NotesTool) myNotes = ... Handle(XCAFDoc_NotesTool) myNotes = ...
TDF_Label theLabel; ... TDF_Label theLabel; ...
TDF_LabelSequence theNotes; TDF_LabelSequence theNotes;
@ -1028,7 +1028,7 @@ myNotes->GetAttrNotes(theLabel, theAttrGUID, theNotesAttr);
Standard_Integer theSubshape = 1; Standard_Integer theSubshape = 1;
TDF_LabelSequence theNotesSubshape; TDF_LabelSequence theNotesSubshape;
myNotes->GetAttrSubshape(theLabel, theSubshape, theNotesSubshape); myNotes->GetAttrSubshape(theLabel, theSubshape, theNotesSubshape);
~~~~~ ~~~~
@subsubsection occt_xde_2_10_6 Removing Notes @subsubsection occt_xde_2_10_6 Removing Notes
@ -1037,7 +1037,7 @@ To remove a note use one of the following *XCAFDoc_NotesTool* methods:
- *RemoveAttrNote* : unbinds a note from a label's attribute; - *RemoveAttrNote* : unbinds a note from a label's attribute;
- *RemoveSubshapeNote* : unbinds a note from a sub-shape. - *RemoveSubshapeNote* : unbinds a note from a sub-shape.
~~~~~ ~~~~{.cpp}
Handle(XCAFDoc_Note) myNote = ... Handle(XCAFDoc_Note) myNote = ...
TDF_Label theLabel; ... TDF_Label theLabel; ...
myNotes->RemoveNote(myNote->Label(), theLabel); myNotes->RemoveNote(myNote->Label(), theLabel);
@ -1045,7 +1045,7 @@ Standard_GUID theAttrGUID; ...
myRefAttr = myNotes->RemoveAttrNote(myNote->Label(), theAttrGUID); myRefAttr = myNotes->RemoveAttrNote(myNote->Label(), theAttrGUID);
Standard_Integer theSubshape = 1; Standard_Integer theSubshape = 1;
myNotes->RemoveSubshapeNote(myNote->Label(), theSubshape); myNotes->RemoveSubshapeNote(myNote->Label(), theSubshape);
~~~~~ ~~~~
A note will not be deleted automatically. A note will not be deleted automatically.
Counterpart methods to remove all notes are available, too. Counterpart methods to remove all notes are available, too.
@ -1074,7 +1074,7 @@ The packages to manage this are *IGESCAFControl* for IGES, and *STEPCAFControl*
@subsubsection occt_xde_2_11_1 Reading a STEP file @subsubsection occt_xde_2_11_1 Reading a STEP file
To read a STEP file by itself, use: To read a STEP file by itself, use:
~~~~~ ~~~~{.cpp}
STEPCAFControl_Reader reader; STEPCAFControl_Reader reader;
IFSelect_ReturnStatus readstat = reader.ReadFile(filename); IFSelect_ReturnStatus readstat = reader.ReadFile(filename);
// The various ways of reading a file are available here too : // The various ways of reading a file are available here too :
@ -1089,13 +1089,13 @@ if ( !reader.Transfer ( doc ) ) {
} }
// Here, the Document has been filled from a STEP file, // Here, the Document has been filled from a STEP file,
// it is ready to use // it is ready to use
~~~~~ ~~~~
In addition, the reader provides methods that are applicable to document transfers and for directly querying of the data produced. In addition, the reader provides methods that are applicable to document transfers and for directly querying of the data produced.
@subsubsection occt_xde_2_11_2 Writing a STEP file @subsubsection occt_xde_2_11_2 Writing a STEP file
To write a STEP file by itself, use: To write a STEP file by itself, use:
~~~~~ ~~~~{.cpp}
STEPControl_StepModelType mode = STEPControl_StepModelType mode =
STEPControl_AsIs; STEPControl_AsIs;
// Asis is the recommended value, others are available // Asis is the recommended value, others are available
@ -1111,7 +1111,7 @@ if ( ! writer.Transfer ( Doc, mode ) ) {
} }
// Writing the File // Writing the File
IFSelect_ReturnStatus stat = writer.Write(file-name); IFSelect_ReturnStatus stat = writer.Write(file-name);
~~~~~ ~~~~
@subsubsection occt_xde_2_11_3 Reading an IGES File @subsubsection occt_xde_2_11_3 Reading an IGES File
Use the same procedure as for a STEP file but with IGESCAFControl instead of STEPCAFControl. Use the same procedure as for a STEP file but with IGESCAFControl instead of STEPCAFControl.