ebec72db31c6fa6ea7d8d6d264680fd5c7d2a594
[occt.git] / dox / technical_overview / technical_overview.md
1 Technical Overview {#technical_overview}
2 ========================================
3
4 @tableofcontents
5
6 @section OCCT_TOVW_SECTION_1 Product Overview
7
8 Open CASCADE Technology is an object-oriented C++ class library designed for rapid production of sophisticated domain-specific design applications. A typical application developed using OCCT deals with two or three-dimensional (2D or 3D) geometric modeling
9 in general-purpose or specialized Computer Aided Design (CAD) systems, manufacturing
10 or analysis applications, simulation applications, or illustration tools. OCCT Object
11 Libraries help you to develop your applications significantly faster.
12
13 @image html /technical_overview/images/technical_overview_over.png
14 @image latex /technical_overview/images/technical_overview_over.png
15
16 The OCCT Library provides the following services:
17
18
19   * 2D and 3D geometric modeling toolkits which allow you to model any type of object:
20     * Creating primitives such as prism, cylinder, cone and torus 
21     * Performing Boolean operations (addition, subtraction and intersection) 
22     * Tweaking constructions using fillets, chamfers and drafts 
23     * Modeling constructions using offsets, shelling, hollowing and sweeps 
24     * Computing properties such as surface, volume, center of gravity, curvature 
25     * Computing geometry using projection, interpolation, approximation 
26   * Visualization services that allow you to manage object display and manipulate views, for example:
27     * 3D rotation 
28     * Zoom 
29     * Shading 
30   * The application framework features: 
31     * Association between non-geometric application data and geometry 
32     * Parameterization of models 
33     * Java Application Desktop (JAD), a framework for creating your Graphical User Interfaces (GUI) 
34   * Data exchange providing import and export functions of OCCT models to and from standard formats such as IGES and STEP 
35
36 OCCT Library is developed and marketed by OPEN CASCADE Company. The library is designed
37 to be truly modular and extensible. As such, they separate C++ classes for:
38
39   * Defining data structures (geometric modeling, display and graphic selection) 
40   * Implementing complex algorithms 
41   * Providing Application Programming Interfaces (APIs) 
42
43
44 Related classes are grouped into packages to prevent any class-name conflicts; 
45 C++ class-names are prefixed by a package name. For example, all classes defining 
46 3D geometric objects belong to the Geompackage. 
47 In Geom, the class implementing Bezier surfaces is called BezierSurface, and its full name is <i> Geom_BezierSurface</i>.
48
49 Packages are then archived into libraries, to which you can link your application.
50
51 Finally, libraries are grouped into six modules: Foundation Classes, 
52 Modeling Data, Modeling Algorithms, Visualization, Data Exchange and Application Framework. 
53
54 In addition Draw Test Harness (Draw) provides testing tools for the Visualization, 
55 Modeling Algorithms, Application Framework and Data Exchange modules. 
56 These tools include a wide range of interpreted commands which allow experimenting with OCCT.
57
58 Refer to the Technical Overview and OCCT documentation for details about the services provided in each module. 
59
60 @section OCCT_TOVW_SECTION_2 Foundation Classes
61
62
63 Foundation Classes provide a variety of general-purpose services such as:
64
65   * Primitive types, strings and various types of quantities 
66   * Automated management of heap memory 
67   * Exception handling 
68   * Classes for manipulating data collections
69   * Math tools such as vectors, matrices and primitive geometric types 
70   * Basic services for saving data in ASCII files 
71
72 These services are organized into the following libraries:
73
74   * Kernel Classes 
75   * Math Utilities 
76   * Basic Persistence
77
78 The technical overview provides only a basic description of the libraries. Please, refer for more details to  <a href="user_guides__foundation_classes.html">Foundation Classes User's guide</a>
79
80 See also: our web site at <a href="http://www.opencascade.org/support/training/">E-learning and Training</a>.
81
82 @subsection OCCT_TOVW_SECTION_2_1 Kernel Classes
83
84
85 ### Root Classes
86
87
88 Root Classes, primarily implemented in the Standard package, are the predefined classes on which
89 all other Open CASCADE Technology classes are built. They provide:
90
91   * Primitive types such as Boolean, Character, Integer or Real 
92   * Memory manager based on reference counting for optimizing the allocation and deallocation of large numbers of small C++ objects 
93   * <i>Standard_Transient</i> class automating memory management through smart pointers
94   * OCCT <i>Handle</i>; most of OCCT classes inherit from this base class.
95   * Management of exceptions,
96   * Encapsulation of C++ streams.
97
98 ### Quantities
99
100 Quantity classes provide the following services:
101
102   * Definition of primitive types representing most of mathematical and physical quantities
103   * Unit conversion tools.    
104   * Resources to manage time information such as dates and time periods 
105   * Resources to manage color definition 
106
107 A mathematical quantity is characterized by the name and the value (real).
108 A physical quantity is characterized by the name, the value (real) and the unit. 
109 The unit may be either an international unit complying with the International Unit System (SI) 
110 or a user defined unit. The unit is managed by the physical quantity user.
111
112 The fact that both physical and mathematical quantities are manipulated as real
113 values means that :
114
115   * They are defined as aliases of real values, so all functions provided by the <i>Standard_Real</i> class are available on each quantity.
116   * It is possible to mix several physical quantities in a mathematical or physical formula involving real values.
117
118 <i>Quantity</i> package includes all commonly used basic physical quantities. 
119
120 ### Exceptions
121
122 Exception classes list all the exceptions, which can be raised by any OCCT function.
123
124 Each exception inherits from Standard_Failure either directly or by inheriting from
125 another exception.
126
127 Exceptions describe anomalies which can occur during the execution of a method. With
128 the raising of an exception, the normal course of program execution is abandoned.
129 The execution of actions in response to this situation is called the treatment of
130 the exception.
131
132
133 The methods try & catch are redefined in OCCT to work properly on any platform. Nevertheless
134 they call native mechanisms each time it is possible. The only reason not to use
135 native exceptions is that they may not work properly on some compilers. In this case,
136 a specific OCCT code is used instead. 
137
138
139 ### Strings
140
141 Strings are classes that handle dynamically sized sequences of characters based on
142 ASCII/Unicode UTF-8 (normal 8-bit character type)
143 and UTF-16/UCS-2 (16-bit character type). They provide editing operations with built-in
144 memory management which make the relative objects easier to use than ordinary character
145 arrays.
146
147 String classes provide the following services to manipulate character strings:
148  * Editing operations on string objects, using a built-in string manager 
149  * Handling of dynamically-sized sequences of characters 
150  * Conversion from/to ASCII and UTF-8 strings. 
151
152 Strings may also be manipulated by handles and therefore, can be shared.
153
154 These classes are implemented in <i>TCollection</i> and <i>NCollection</i> packages.
155
156
157 ### Collections
158
159 Apart from strings, the <i> TCollection</i> package contains classes of dynamically sized
160 aggregates of data. They include a wide range of collections.
161
162   * Arrays (unidimensional and bidimensional) are generally used for quick access to an item.
163   Note that an array is a fixed-sized aggregate. 
164   * Sequences are ordered collections of non-unique objects. 
165   A sequence item is longer to access than an array item: only an exploration in sequence 
166   is efficient (but sequences are not adapted for numerous explorations). 
167   Arrays and sequences are commonly used as data structures for more complex objects.
168   * Maps are dynamic structures where the size is constantly adapted to the number of inserted
169   items and access to an item is the fastest. Maps structures are commonly used in
170   cases of numerous explorations: they are typically internal data structures for complex
171   algorithms. Sets generate the same results as maps but computation time is considerable.
172   * Lists, queues and stacks, which are minor structures similar to sequences but with different
173   algorithms to explore them 
174   * Specific iterators for sequences, maps, and stacks.
175
176 Most collections follow value semantics: their instances are the actual collections,
177 not handles to a collection. Only arrays, sequences and sets may also be manipulated
178 by handle, and therefore shared.
179
180
181 Collection classes are generic (C++ template-like), so they can contain 
182 a variety of objects which do not necessarily inherit from
183 a unique root class. When you need to use a collection of a given object type, you
184 must instantiate the collection for this specific type. Once the code for this declaration
185 is compiled, all functions available on the generic collection are available on your
186 instantiated class.
187
188 Each collection directly used as an argument in Open CASCADE Technology public syntax
189 is instantiated in an OCCT component using the corresponding generic class in package
190 <i> TCollection</i>, by means of compiling the CDL declaration of the instance. 
191 Thus OCCT generic classes require compilation of definitions in the CDL language and therefore
192 can only be instantiated in WOK.
193
194 If you are not using CDL in your project (CDL compilation under WOK is necessary
195 to instantiate any generic Collection from package <i>TCollection</i>), then you should
196 use the Collections defined in <i> NCollection</i> package. It contains definitions of the
197 same generic collection classes described above, but in a form of C++ templates.
198 Therefore, to instantiate any collection type no additional support is required beyond
199 the ANSI C++ compiler.
200
201 @subsection OCCT_TOVW_SECTION_2_2 Math Utilities
202
203
204 ### Vectors and Matrices
205
206
207 The <i> Vector</i> and <i> Matrix </i> classes provide commonly used mathematical algorithms which
208 include:
209
210   * Basic calculations involving vectors and matrices; 
211   * Computation of eigenvalues and eigenvectors of a square matrix; 
212   * Solvers for a set of linear algebraic equations; 
213   * Algorithms to find the roots of a set of non-linear equations; 
214   * Algorithms to find the minimum function of one or more independent variables. 
215
216 These classes also provide a data structure to represent any expression,
217 relation, or function used in mathematics, including the assignment of variables.
218
219 Vectors and matrices have arbitrary ranges which must be defined at declaration time
220 and cannot be changed after declaration. 
221
222 ~~~
223     math_Vector v(1, 3);
224     // a vector of dimension 3 with range (1..3)
225
226     math_Matrix m(0, 2, 0, 2);
227     // a matrix of dimension 3x3 with range (0..2, 0..2)
228
229     math_Vector v(N1, N2);
230     // a vector of dimension N2-N1+1 with range (N1..N2)
231 ~~~
232
233 Vector and Matrix objects follow "value semantics", that is, they cannot be shared
234 and are copied though assignment.
235
236 ~~~
237     math_Vector v1(1, 3), v2(0, 2);
238
239     v2 = v1; // v1 is copied into v2
240                 // a modification of v1 does not affect v2
241 ~~~
242
243 Vector and Matrix elements can be retrieved using indexes, which must be in the range
244 defined upon Vector/Matrix creation. The elements can be initialized with some numerical
245 value upon creation as well.
246
247 ~~~
248     math_Vector v(1, 3);
249     math_Matrix m(1, 3, 1, 3);
250     Standard_Real value;
251
252     v(2) = 1.0;
253     value = v(1);
254     m(1, 3) = 1.0;
255     value = m(2, 2);
256 ~~~
257
258 Some operations on Vector and Matrix objects may not be legal. In this case an exception
259 is raised. Two standard exceptions are used:
260  *<i>Standard_DimensionError</i> exception is raised when two matrices or vectors involved
261 in an operation are of incompatible dimensions.
262  *<i>Standard_RangeError</i>exception is raised if an attempt to access outside the range
263 defined upon creation of a vector or a matrix is made.
264
265 ~~~
266     math_Vector v1(1, 3), v2(1, 2), v3(0, 2);
267
268     v1 = v2;            // error: Standard_DimensionError is raised
269     v1 = v3;            // OK: ranges are not equal, but dimensions are compatible
270     v1(0) = 2.0;        // error: Standard_RangeError is raised
271 ~~~
272
273
274 ### Fundamental Geometry Types
275
276 The Fundamental Geometry Types component groups the following packages:
277 * geometric processor package <i> gp</i>;
278 * <i>GeomAbs</i> package, which provides enumerations generally used in geometry;
279
280 <i>gp</i> package is a STEP-compliant implementation of basic geometric and algebraic
281 entities, used to define and manipulate elementary data structures.
282
283 In particular, <i>gp</i> provides:
284
285   * descriptions of primitive geometric shapes, such as:
286           * Points; 
287           * Vectors; 
288           * Lines; 
289           * Circles and conics; 
290           * Planes and elementary surfaces;
291   * positioning of these shapes in space or in a plane by means of an axis or a coordinate system;
292   * definition and application of geometric transformations to these shapes:
293           * Translations; 
294           * Rotations; 
295           * Symmetries; 
296           * Scaling transformations; 
297           * Composed transformations;
298   * Tools (coordinates and matrices) for algebraic computation.
299
300 These functions are defined in 3D space and in the plane.
301
302 <i> gp</i> curves and surfaces are analytic: there is no parameterization and no orientation 
303 on <i>gp</i> entities, i.e. these entities do not provide functions which work with these properties. 
304 If you need, you may use more evolved data structures provided by <i> Geom</i> 
305 (in 3D space) and <i> Geom2d</i> (in the plane). However, the definition of <i> gp</i> entities 
306 is identical to the one of equivalent <i> Geom</i> and <i> Geom2d</i> entities, and they are located
307 in the plane or in space with the same kind of positioning systems. 
308 They implicitly contain the orientation, which they express 
309 on the <i> Geom </i> and <i> Geom2d </i> entities, and they induce the definition of their parameterization.
310
311
312 Therefore, it is easy to give an implicit parameterization to <i> gp</i> curves and surfaces,
313 which is the parametarization of the equivalent <i> Geom</i> or <i> Geom2d</i> entity. This property
314 is particularly useful when computing projections or intersections, or for operations
315 involving complex algorithms where it is particularly important to manipulate the
316 simplest data structures, i.e. those of <i> gp</i>. Thus, the <i> ElCLib</i> and <i> ElSLib</i> packages
317 provide functions to compute:
318
319   * the point of parameter u on a 2D or 3D gp curve,
320   * the point of parameter (u,v) on a gp elementary surface, and
321   * any derivative vector at this point.
322
323 Note: the <i> gp</i> entities cannot be shared when they are inside more complex data structures.
324
325
326 ### Common Mathematical Algorithms
327
328 Common mathematical algorithms provided in OCCT include:
329
330   * Algorithms to solve a set of linear algebraic equations, 
331   * Algorithms to find the minimum of a function of one or more independent variables,
332   * Algorithms to find roots of one or of a set of non-linear equations, 
333   * An algorithm to find the eigenvalues and eigenvectors of a square matrix.
334
335 @section OCCT_TOVW_SECTION_3 Modeling Data
336
337 Modeling Data supplies data structures to represent 2D and 3D geometric models.
338
339 @image html /technical_overview/images/technical_overview_md.png
340 @image latex /technical_overview/images/technical_overview_md.png
341
342 These services are organized into the following libraries:
343
344   * 2D Geometry 
345   * 3D Geometry 
346   * Geometry Utilities 
347   * Topology 
348
349 The technical overview provides only a basic description of the libraries. Please, refer for more details to  <a href="user_guides__modeling_data.html">Modeling Data User's guide</a>
350
351 3D geometric models are stored in OCCT native BREP format. It is possible to learn
352 more about it in <a href="occt_brep_format.html">BREP Format Description White Paper</a> 
353
354 See also: our web site at <a href="http://www.opencascade.org/support/training/">E-learning and Training</a>.
355
356 @subsection OCCT_TOVW_SECTION_3_1 2D Geometry Types
357
358 <i> Geom2d</i> package provides an implementation of 2D geometric objects complying with
359 STEP, part 42. In particular, it provides functions for:
360 * description of points, vectors and curves,
361 * their positioning in the plane using coordinate systems,
362 * their geometric transformation, by applying translations, rotations, symmetries, scaling transformations and combinations thereof.
363
364 The key characteristic of <i> Geom2d </i> curves is that they are parameterized. 
365 Each class provides functions to work with the parametric equation of the curve, 
366 and, in particular, to compute the point of parameter u on a curve and the derivative vectors of order 1, 2.., N at this point.
367
368 As a consequence of the parameterization, a <i> Geom2d </i> curve is naturally oriented.
369
370 Parameterization and orientation differentiate elementary <i>Geom2d </i>curves from their
371 equivalent as provided by <i> gp</i> package. <i>  Geom2d</i> package provides conversion
372 functions to transform a <i> Geom2d</i> object into a <i> gp</i> object, and vice-versa, when this is possible.
373
374 Moreover, <i> Geom2d</i> package provides more complex curves, including Bezier curves,
375 BSpline curves, trimmed curves and offset curves.
376
377 <i> Geom2d </i> objects are organized according to an inheritance structure over several levels.
378 Thus, an ellipse (specific class <i> Geom2d_Ellipse</i>) is also a conical curve and inherits
379 from the abstract class <i> Geom2d_Conic</i>, while a Bezier curve (concrete class <i> Geom2d_BezierCurve</i>)
380 is also a bounded curve and inherits from the abstract class <i> Geom2d_BoundedCurve</i>;
381 both these examples are also curves (abstract class <i>Geom2d_Curve</i>). Curves, points
382 and vectors inherit from the abstract class <i> Geom2d_Geometry,</i> which describes the properties
383 common to any geometric object from the <i>Geom2d</i> package.
384
385 This inheritance structure is open and it is possible to describe new objects which
386 inherit from those provided in the <i>Geom2d</i> package, provided that they respect the
387 behavior of the classes from which they are to inherit.
388
389 Finally, <i> Geom2d</i> objects can be shared within more complex data structures. 
390 This is why they are used within topological data structures, for example.
391
392 <i> Geom2d </i>package uses the services of the <i> gp</i> package to:
393
394   * implement elementary algebraic calculus and basic analytic geometry,
395   * describe geometric transformations which can be applied to <i> Geom2d</i> objects,
396   * describe the elementary data structures of <i>Geom2d</i> objects.
397
398 However, the <i> Geom2d</i> package essentially provides data structures and not algorithms.
399 You can refer to the <i> GCE2d </i> package to find more evolved construction algorithms for <i> Geom2d </i> objects.
400
401 @subsection OCCT_TOVW_SECTION_3_2 3D Geometry Types
402
403 The <i> Geom</i> package provides an implementation of 3D geometric objects complying with
404 STEP, part 42. In particular, it provides functions for:
405
406   * description of points, vectors, curves and surfaces,
407     * their positioning in 3D space using axis or coordinate systems, and
408     * their geometric transformation, by applying translations, rotations, symmetries, scaling transformations and combinations thereof.
409
410 The key characteristic of Geom curves and surfaces is that they are parameterized.
411 Each class provides functions to work with the parametric equation of the curve or
412 surface, and, in particular, to compute:
413
414    * the point of parameter u on a curve, or
415    * the point of parameters (u, v) on a surface.
416
417 together with the derivative vectors of order 1, 2, ... N at this point.
418
419 As a consequence of this parameterization, a Geom curve or surface is naturally oriented.
420
421 Parameterization and orientation differentiate elementary Geom curves and surfaces from the classes of the same (or similar) names found in the <i> gp</i> package. 
422 The <i>Geom</i> package also provides conversion functions to transform a Geom object into a <i> gp</i> object, and vice-versa, when such transformation is possible.
423
424 Moreover, the <i> Geom </i>package provides more complex curves and surfaces, including:
425   * Bezier and BSpline curves and surfaces,
426   * swept surfaces, for example surfaces of revolution and surfaces of linear extrusion,
427   * trimmed curves and surfaces, and
428   * offset curves and surfaces.
429
430 Geom objects are organized according to an inheritance structure over several levels.
431 Thus, a sphere (concrete class <i> Geom_SphericalSurface</i>) is also an elementary surface and inherits from the abstract class <i> Geom_ElementarySurface</i>, while a Bezier surface (concrete class <i> Geom_BezierSurface</i>) is also a bounded surface and inherits from the abstract class <i> Geom_BoundedSurface</i>; both these examples are also surfaces (abstract class <i> Geom_Surface</i>). Curves, points and vectors inherit from the abstract class <i> Geom_Geometry,</i> which describes the properties common to any geometric object from the <i>Geom</i> package.
432
433 This inheritance structure is open and it is possible to describe new objects, which inherit from those provided in the Geom package, on the condition that they respect the behavior of the classes from which they are to inherit.
434
435 Finally, Geom objects can be shared within more complex data structures. This is why they are used within topological data structures, for example.
436
437 The <i> Geom</i> package uses the services of the <i> gp</i> package to:
438   * implement elementary algebraic calculus and basic analytic geometry,
439   * describe geometric transformations which can be applied to Geom objects,
440   * describe the elementary data structures of Geom objects.
441
442 However, the Geom package essentially provides data structures and not algorithms.
443 You can refer to the <i> GC</i> package to find more evolved construction algorithms for
444 Geom objects.
445
446
447 ### Adaptors for Curves and Surfaces
448
449 Some Open CASCADE Technology general algorithms may work theoretically on numerous types of curves or surfaces. 
450 To do this, they simply get the services required of the analysed  curve or surface through an interface so as to a single API,  whatever the type of curve or surface. These interfaces are called adaptors.
451 For example, <i> Adaptor3d_Curve </i> is the abstract class which provides  the required services by an algorithm which uses any 3d curve.
452
453 <i> GeomAdaptor </i>package provides interfaces:
454
455   * On a Geom curve;
456   * On a curve lying on a Geom surface;
457   * On a Geom surface;
458
459 <i> Geom2dAdaptor</i> package provides interfaces :
460
461   * On a <i>Geom2d</i> curve.
462
463 <i> BRepAdaptor </i> package provides interfaces:
464
465   * On a Face
466   * On an Edge
467
468 When you write an algorithm which operates on geometric objects, use <i> Adaptor3d</i> (or <i> Adaptor2d</i>) objects. 
469 As a result, you can use the algorithm with any kind of object, 
470 if you provide for this object, an interface derived from *Adaptor3d* or *Adaptor2d*.
471 These interfaces are easy to use: simply create an adapted curve or surface from a *Geom2d* curve, 
472 and then use this adapted curve as an argument for the algorithm which requires it.
473
474
475 @subsection OCCT_TOVW_SECTION_3_3 Geometry Utilities
476
477 This library provides standard high-level functions in 2D and 3D geometry such as:
478
479   * Direct construction of algorithms; 
480   * Approximation of curves and surfaces from points; 
481   * Conversion of more elementary geometry to BSpline curves and surfaces; 
482   * Calculation of points on a 2D or 3D curve; 
483   * Calculation of extrema between two geometries. 
484
485 ### Direct Construction
486
487 The <i> gp</i>, <i> Geom2d</i> and <i> Geom</i> packages describe elementary data structures of simple geometric
488 objects. The constructors of these objects are elementary: the construction arguments
489 are fields by which the objects are represented in their data structure.
490
491
492 On the other hand, the <i> gce</i>, <i> GCE2d</i> and <i> GC</i> packages provided 
493 by the Direct Construction component construct the same types of objects 
494 as <i> gp</i>, <i> Geom2d </i>and <i> Geom</i> respectively.
495 However, the former implement geometric construction algorithms that translate the
496 constructor's arguments into the data structure specific to each object.
497
498
499 Algorithms implemented by these packages are simple: there is no creation of objects
500 defined by advanced positional constraints (for more information on this subject,
501 see <i> Geom2dGcc</i> and <i> GccAna</i> which describe geometry by constraints).
502
503
504 <i> gce</i>, <i> GCE2d</i> and <i> GC </i>each offer a series of classes of construction algorithms.
505
506
507 For example, the class <i>gce_MakeCirc</i> provides a framework 
508 for defining eight problems encountered in the geometric construction of circles, 
509 and implementing the eight related construction algorithms.
510
511 The object created (or implemented) is an algorithm which can be consulted to find out, in particular:
512
513   * its result, which is a <i>gp_Circ</i>, and
514   * its status. Here, the status indicates whether or not the construction was successful.
515
516 If it was unsuccessful, the status gives the reason for the failure.
517
518 ~~~~
519     gp_Pnt P1 (0.,0.,0.);
520     gp_Pnt P2 (0.,10.,0.);
521     gp_Pnt P3 (10.,0.,0.);
522     gce_MakeCirc MC (P1,P2,P3);
523     if (MC.IsDone()) {
524                 const gp_Circ& C = MC.Value();
525     }
526 ~~~~
527
528 In addition, <i> gce</i>, <i> GCE2d</i> and <i> GC</i> each have a <i>Root</i> class. This class is the root of
529 all the classes in the package which return a status. The returned status (successful
530 construction or construction error) is described by the enumeration <i> gce_ErrorType</i>.
531
532 Note: classes which construct geometric transformations do not return a status, and
533 therefore do not inherit from Root.
534
535 ### Approximations
536
537 Approximation of Curves and Surfaces groups together a variety of functions used in 2D and 3D geometry for:
538
539   * the interpolation of a set of 2D points using a 2D BSpline or Bezier curve;
540   * the approximation of a set of 2D points using a 2D BSpline or Bezier curve;
541   * the interpolation of a set of 3D points using a 3D BSpline or Bezier curve, or a BSpline surface;
542   * the approximation of a set of 3D points using a 3D BSpline or Bezier curve, or a BSpline surface.
543
544 You can program approximations in two ways:
545
546   * Using high-level functions, designed to provide a simple method for obtaining approximations with minimal programming,
547   * Using low-level functions, designed for users requiring more control over the approximations.
548
549 The low-level functions provide a second API with functions to:
550
551   * Define compulsory tangents for an approximation. These tangents have origins and extremities.
552   * Approximate a set of curves in parallel to respect identical parameterization.
553   * Smooth approximations. This is to produce a faired curve.
554
555 The classes <i> AppDef_MultiPointConstraints</i> and <i> AppDef_MultiLines </i> allow organizing the data.
556 The classes <i> AppDef_Compute</i>, <i> AppDef_BSplineCompute</i> and <i> AppDef_TheVariational </i> 
557 classes perform the approximation itself using Bezier curves, BSpline curves, and smooth BSpline curves, respectively.
558
559 You can also find functions to compute:
560
561   * The minimal box which includes a set of points
562   * The mean plane, line or point of a set of coplanar, collinear or coincident points.
563
564 ### Conversion to and from BSplines
565  
566 The Conversion to and from BSplines component has the following two distinct purposes:
567   * Firstly, it provides a homogenous formulation which can be used to describe any curve or surface. 
568   This is useful for writing algorithms for a single data structure model. 
569   The BSpline formulation can be used to represent most basic geometric objects provided 
570   by the components which describe geometric data structures ("Fundamental Geometry Types", "2D Geometry Types" and "3D Geometry Types" components).
571   * Secondly, it can be used to divide a BSpline curve or surface into a series of curves or surfaces, 
572   thereby providing a higher degree of continuity. This is useful for writing algorithms 
573   which require a specific degree of continuity in the objects to which they are applied. 
574   Discontinuities are situated on the boundaries of objects only.
575
576 The "Conversion to and from BSplines" component is composed of three packages.
577
578 The <i> Convert </i> package provides algorithms to convert the following into a BSpline curve or surface:
579
580   * a bounded curve based on an elementary 2D curve (line, circle or conic) from the <i> gp </i> package,
581   * a bounded surface based on an elementary surface (cylinder, cone, sphere or torus) from the <i> gp</i> package,
582   * a series of adjacent 2D or 3D Bezier curves defined by their poles.
583
584 These algorithms compute the data needed to define the resulting BSpline curve or surface. 
585 This elementary data (degrees, periodic characteristics, poles and weights, knots and multiplicities) 
586 may then be used directly in an algorithm, or can be used to construct the curve or the surface 
587 by calling the appropriate constructor provided by the classes <i>Geom2d_BSplineCurve, Geom_BSplineCurve </i> or <i>Geom_BSplineSurface</i>.
588
589 The <i>Geom2dConvert</i> package provides the following:
590
591   * a global function which is used to construct a BSpline curve from a bounded curve based on a 2D curve from the Geom2d package,
592   * a splitting algorithm which computes the points at which a 2D BSpline curve should be cut in order to obtain arcs with the same degree of continuity,
593   * global functions used to construct the BSpline curves created by this splitting algorithm, or by other types of segmentation of the BSpline curve,
594   * an algorithm which converts a 2D BSpline curve into a series of adjacent Bezier curves.
595
596 The <i> GeomConvert</i> package also provides the following:
597
598   * a global function used to construct a BSpline curve from a bounded curve based on a curve from the Geom package,
599   * a splitting algorithm, which computes the points at which a BSpline curve should be cut in order to obtain arcs with the same degree of continuity,
600   * global functions to construct BSpline curves created by this splitting algorithm, or by other types of BSpline curve segmentation,
601   * an algorithm, which converts a BSpline curve into a series of adjacent Bezier curves,
602   * a global function to construct a BSpline surface from a bounded surface based on a surface from the Geom package,
603   * a splitting algorithm, which determines the curves along which a BSpline surface should be cut in order to obtain patches with the same degree of continuity,
604   * global functions to construct BSpline surfaces created by this splitting algorithm, or by other types of BSpline surface segmentation,
605   * an algorithm, which converts a BSpline surface into a series of adjacent Bezier surfaces,
606   * an algorithm, which converts a grid of adjacent Bezier surfaces into a BSpline surface.
607
608 ### Points on Curves
609
610 The Making Points on Curves component comprises high level functions providing an Application Programming Interface for complex algorithms that compute points on a 2D or 3D curve. The functions use various methods.
611
612 The algorithms result in the following:
613
614   * a point on a curve, situated at a given curvilinear distance from another point on the curve
615   * a distribution of points situated at constant curvilinear intervals along a curve
616   * a distribution of points at a constant rise (i.e. respecting a criterion of maximum rise between the curve and the polygon that results from the computed points) along a curve
617   * the length of a curve.
618
619 @subsection OCCT_TOVW_SECTION_3_4 Topology
620
621 Topological library allows you to build pure topological data structures..
622
623 Topology defines relationships between simple geometric entities. In this way, 
624 you can model complex shapes as assemblies of simpler entities. 
625 Due to a built-in non-manifold (or mixed-dimensional) feature, you can build models mixing:
626
627   * 0D entities such as points; 
628   * 1D entities such as curves; 
629   * 2D entities such as surfaces; 
630   * 3D entities such as volumes. 
631
632 You can, for example, represent a single object made of several distinct bodies 
633 containing embedded curves and surfaces connected or non-connected to an outer boundary.
634
635 Abstract topological data structure describes a basic entity - a shape, 
636 which can be divided into the following component topologies:
637
638   * Vertex - a zero-dimensional shape corresponding to a point in geometry; 
639   * Edge - a shape corresponding to a curve, and bound by a vertex at each extremity;
640   * Wire - a sequence of edges connected by their vertices; 
641   * Face - part of a plane (in 2D geometry) or a surface (in 3D geometry) bounded by a closed wire;
642   * Shell - a collection of faces connected by some edges of their wire boundaries; 
643   * Solid - a part of 3D space bound by a shell; 
644   * Compound solid - a collection of solids. 
645
646 The wire and the solid can be either infinite or closed.
647
648 A face with 3D underlying geometry may also refer to a collection of connected triangles 
649 that approximate the underlying surface. The surfaces can be undefined 
650 leaving the faces represented by triangles only. If so, the model is purely polyhedral.
651
652 Topology defines the relationship between simple geometric entities, 
653 which can thus be linked together to represent complex shapes.
654
655 Abstract Topology is provided by six packages. 
656 The first three packages describe the topological data structure used in Open CASCADE Technology:
657
658   * <i> TopAbs</i> package provides general resources for topology-driven applications. It contains enumerations that are used to describe basic topological notions: topological shape, orientation and state. It also provides methods to manage these enumerations.
659   * <i> TopLoc </i>package provides resources to handle 3D local coordinate systems: <i> Datum3D</i>and <i> Location</i>. <i> Datum3D</i> describes an elementary coordinate system, while <i> Location</i> comprises a series of elementary coordinate systems.
660   * <i> TopoDS</i> package describes classes to model and build data structures that are purely topological.
661
662 Three additional packages provide tools to access and manipulate this abstract topology:
663
664   * <i> TopTools</i> package provides basic tools to use on topological data structures.
665   * <i> TopExp</i> package provides classes to explore and manipulate the topological data structures described in the TopoDS package.
666   * <i> BRepTools </i> package provides classes to explore, manipulate, read and write BRep data structures. These more complex data structures combine topological descriptions with additional geometric information, and include rules for evaluating equivalence of different possible representations of the same object, for example, a point.
667
668 @subsection OCCT_TOVW_SECTION_3_5 Properties of Shapes
669
670 ### Local Properties of Shapes
671
672 <i>BRepLProp</i> package provides the Local Properties of Shapes component, 
673 which contains algorithms computing various local properties on edges and faces in a BRep model.
674
675 The local properties which may be queried are:
676
677   * for a point of parameter u on a curve which supports an edge :
678     * the point,
679     * the derivative vectors, up to the third degree,
680     * the tangent vector,
681     * the normal,
682     * the curvature, and the center of curvature;
683   * for a point of parameter (u, v) on a surface which supports a face :
684     * the point,
685     * the derivative vectors, up to the second degree,
686     * the tangent vectors to the u and v isoparametric curves,
687     * the normal vector,
688     * the minimum or maximum curvature, and the corresponding directions of curvature;
689   * the degree of continuity of a curve which supports an edge, built by the concatenation of two other edges, at their junction point.
690
691 Analyzed edges and faces are described as <i> BRepAdaptor</i> curves and surfaces, 
692 which provide shapes with an interface for the description of their geometric support. 
693 The base point for local properties is defined by its u parameter value on a curve, or its (u, v) parameter values on a surface.
694
695 ### Local Properties of Curves and Surfaces
696
697
698 The "Local Properties of Curves and Surfaces" component provides algorithms for computing various local 
699 properties on a Geom curve (in 2D or 3D space) or a surface. It is composed of:
700
701   * <i> Geom2dLProp</i> package, which provides local properties on 2D curves
702   * <i> GeomLProp </i> package, which provides local properties on 3D curves and surfaces
703   * <i> LProp </i> package, which provides an enumeration used to characterize a particular point on a 2D curve.
704
705 Curves are either <i> Geom_Curve </i> curves (in 3D space) or <i> Geom2d_Curve </i> curves (in the plane). 
706 Surfaces are <i> Geom_Surface </i> surfaces. The point on which local properties are calculated 
707 is defined by its u parameter value on a curve, and its (u,v) parameter values on a surface.
708
709 It is possible to query the same local properties for points as mentioned above, and additionally for 2D curves:
710
711   * the points corresponding to a minimum or a maximum of curvature;
712   * the inflection points.
713
714 ### Global Properties of Shapes
715
716 The Global Properties of Shapes component provides algorithms for computing the global 
717 properties of a composite geometric system in 3D space, and frameworks to query the computed results.
718
719 The global properties computed for a system are :
720
721   * mass,
722   * mass center,
723   * matrix of inertia,
724   * moment about an axis,
725   * radius of gyration about an axis,
726   * principal properties of inertia such as principal axis, principal moments, and principal radius of gyration.
727
728 Geometric systems are generally defined as shapes. Depending on the way they are analyzed, these shapes will give properties of:
729
730   * lines induced from the edges of the shape,
731   * surfaces induced from the faces of the shape, or
732   * volumes induced from the solid bounded by the shape.
733
734 The global properties of several systems may be brought together to give the global properties of the system composed of the sum of all individual systems.
735
736 The Global Properties of Shapes component is composed of:
737 * seven functions for computing global properties of a shape: one function for lines, two functions for surfaces and four functions for volumes. The choice of functions depends on input parameters and algorithms used for computation (<i>BRepGProp</i> global functions),
738 * a framework for computing global properties for a set of points (<i>GProp_PGProps</i>),
739 * and a general framework to bring together the global properties retained by several more elementary frameworks, and provide a general programming interface to consult computed global properties.
740     
741 @subsection OCCT_TOVW_SECTION_3_6 Examples
742
743 ### How to compute the curve length
744
745 To compute curve length, use the method <i>AbscissaPoint::Length</i> from <i> GCPnts</i>.
746
747 This function is used only for initializing a framework to compute the length of a curve (or a series of curves).
748
749 The adapted curves are:
750
751   * Adaptor_Curve2d for 2D curves
752   * Adaptor_Curve for 3D curves.
753
754 The adapted curve is created in the following way:
755
756 In 2D:
757
758 ~~~~~~~~~~~
759     Handle(Geom2d_Curve) mycurve = ... ;
760     Geom2dAdaptor_Curve C (mycurve) ;
761 ~~~~~~~~~~~
762
763 In 3D:
764
765 ~~~~~~~~~
766     Handle(Geom_Curve) mycurve = ... ;
767     GeomAdaptor_Curve C (mycurve) ;
768 ~~~~~~~~~
769
770
771 The length of the curve is then computed using this curve object:
772
773 ~~~~~~~~
774     GCPnts_AbscissaPoint myAlgo () ;
775     Standard_Real L = myAlgo.Length( C ) ;
776 ~~~~~~~~
777
778 ### How to check the surface concavity
779
780 To check the concavity of a surface, proceed as follows:
781
782   1. Sample the surface and compute at each point the Gaussian curvature.
783   2. If the value of the curvature changes of sign, the surface is concave or convex depending on the point of view.
784   3. To compute a Gaussian curvature, use the class <i> SLprops</i> from <i> GeomLProp</i>, which instantiates the generic class <i> SLProps </i>from <i> LProp</i> and use the method <i> GaussianCurvature</i>.
785
786 ### How to approximate a curve with respect to tangencies
787
788
789 To approximate a curve with respect to tangencies, follow these steps:
790
791   1. Create an object of type <i> AppDef_MultiPointConstraints</i> from the set of points to approximate and use the method <i> SetTang </i>to set the tangency vectors.
792   2. Create an object of type <i> AppDef_MultiLine </i>from the <i> AppDef_MultiPointConstraint</i>.
793   3. Use <i> AppDef_BSplineCompute</i>, which instantiates <i>Approx_BSplineComputeLine</i> to perform the approximation.
794
795 ### How to extract the underlying geometry from shapes
796
797
798 To extract the underlying geometry from a Shape, use the following methods:
799
800   * <i> BRep_Tool::Surface</i> to get the geometric surface from a face.
801   * <i> BRep_Tool::Curve</i> to get the 3d geometric curve from an edge.
802   * <i> BRep_Tool::CurveOnSurface</i> to get the 2d geometric curve of an edge, defined in the parametric space of a face.
803   * <i> BRep_Tool::Pnt </i> to get the 3D point from a vertex.
804
805 Some of these methods have a location as argument.
806
807 For example, when you use <i> S1 = BRep_Tool::Surface(F,L), </i> you then get the surface stored in <i> TShape</i>.
808
809 To use this surface in the same position as the face, you have to apply 
810 a transformation to it corresponding to the location of the face as follows:
811
812 ~~~~~~~~~~~~
813     gp_Trsf T(L) ;
814     S2 = S1->Moved(T) ;
815 ~~~~~~~~~~~~
816
817 The same method used without location as argument is <i>S3 = BRep_Tool : : Surface(F)</i> 
818 returns a Surface in position, according to the location. S3 and S2 are geometrically equivalent surfaces.
819
820 Warning: with the first method, you get a pointer on the surface stored in the shape. 
821 Do not modify the surface because you will modify the shape and may produce an inconsistent model.
822 With the second method, you get a copy of the surface on which the location has been applied.
823 Note: you can use also a topological object directly just as if it 
824 were a geometric one by using the services of <i> BRepAdaptor </i>classes.
825
826 ### How to get the coordinates of a vertex
827
828
829 To recover the UV coordinates of vertices, 
830 use <i> BRep_Tool::Parameters const TopoDS_Vertex& V,const TopoDS_Face& F), </i> 
831 which returns the U and V parameters of the vertex V on the face F as a <i> gp_Pnt2d</i>. 
832
833 ### How to explore a Wire
834
835
836 To explore the edges of a wire in a contiguous order, use <i> BrepTools_WireExplorer</i> class.
837
838 ~~~~
839     TopoDS_Wire myWire =&ldots;.
840     BRepTools_WireExplorer Ex;
841     for (Ex.Init(myWire); Ex.More(); Ex.Next()) {
842     TopoDS_Edge currentedge = Ex.Current();
843     // Process current edge
844     }
845 ~~~~
846
847 ### How to merge bspline curves
848
849
850 To merge joined bspline curves use the following methods:
851
852 ~~~~
853     void GeomConvert::ConcatG1
854     TColGeom_Array1OfBSplineCurve& ArrayOfCurves,
855       const TColStd_Array1OfReal& ArrayOfToler,
856     Handle(TColGeom_HArray1OfBSplineCurve) & ArrayOfConcatenated,
857     const Standard_Boolean ClosedG1Flag,
858       const Standard_Real ClosedTolerance)
859 ~~~~
860
861 This method concatenates according to G1 (tangency continuity along the curve) the 
862 <i>ArrayOfCurves</i> as far as possible. The following arguments are used:
863
864   * <i> ArrayOfCurves</i> must have dimension bounds [0, N-1], N   * number of curves to be merged.
865   * <i> ArrayOfToler</i> contains the biggest tolerance of the two points shared by two consecutive curves. Its dimension is: [0, N-2].
866   * <i> ArrayOfConcatenated</i> contains results of operation: one or more, when impossible to merge all curves from <i> ArrayOfCurves </i> into one, new bspline curves are created.
867   * <i> ClosedG1Flag </i> indicates if the <i> ArrayOfCurves </i> is closed or not.
868   * If <i> ClosedG1Flag = Standard_True, ClosedTolerance </i> contains the biggest tolerance of the two points which are at the closure, otherwise its value is 0.0.
869
870 ~~~~
871     void GeomConvert::ConcatC1
872     TColGeom_Array1OfBSplineCurve& ArrayOfCurves,
873       const TColStd_Array1OfReal& ArrayOfToler,
874     Handle(TColStd_HArray1OfInteger)& ArrayOfIndices,
875     Handle(TColGeom_HArray1OfBSplineCurve)& ArrayOfConcatenated,
876     const Standard_Boolean ClosedG1Flag,
877       const Standard_Real ClosedTolerance,
878       const Standard_Real AngularTolerance)
879 ~~~~
880
881 This method concatenates according to C1 (first derivative continuity along the curve) the <i> 
882 ArrayOfCurves</i> as far possible. The following arguments are used (additionally to the mentioned above):
883
884 * <i> ArrayOfIndices</i> contains indices that define curves from <i> ArrayOfCurves</i> which are beginning curves for each group of curves merged into a new curve.
885 * <i> AngularTolerance</i> is used to check the continuity of tangencies.
886
887 ~~~~
888     void GeomConvert::ConcatC1
889     TColGeom_Array1OfBSplineCurve& ArrayOfCurves,
890       const TColStd_Array1OfReal& ArrayOfToler,
891     Handle(TColStd_HArray1OfInteger)& ArrayOfIndices,
892     Handle(TColGeom_HArray1OfBSplineCurve)& ArrayOfConcatenated,
893       const Standard_Boolean ClosedG1Flag,
894       const Standard_Real ClosedTolerance)
895 ~~~~
896 This method is the same as the previous one, except for that <i> AngularTolerance = Precision::Angular() </i>
897
898 It is also possible to use class <i> GeomConvert_CompCurveToBSplineCurve</i>. 
899 This class provides methods to concatenate several restricted curves to a bspline curve. 
900 Non-bspline curves are converted to bspline before concatenation.
901
902 Constructor:
903 ~~~~~~~~~~
904     GeomConvert_CompCurveToBSplineCurve::
905     GeomConvert_CompCurveToBSplineCurve(const Handle(Geom_BoundedCurve)& BasisCurve, const Convert_ParameterisationType Parameterization)
906     BasisCurve   * beginning curve;
907 ~~~~~~~~~~
908
909 Parameterization defines the ways of conversion in bspline (by default <i> Convert_TgtThetaOver2</i>).
910
911 The method to add a new curve is:
912 ~~~~
913     Standard_Boolean GeomConvert_CompCurveToBSplineCurve::
914     Add(const Handle(Geom_BoundedCurve)& NewCurve,
915     const Standard_Real Tolerance,
916     const Standard_Boolean After,
917     const Standard_Boolean WithRatio,
918     const Standard_Integer MinM)
919 ~~~~
920
921 It returns False if the curve is not C0 with the <i> BSplineCurve</i>.
922
923 Tolerance is used to check the continuity and decrease the Multiplicity 
924 at the common Knot until <i> MinM </i>. If <i> MinM = 0 </i>, the common Knot can be removed.
925
926 The parameter after defines the place for a new curve when it is possible to put 
927 the new curve before or after the <i> BasisCurve</i> (in fact, it is case when concatenated curve can be closed). 
928 It does not change the shape of the curve, but defines its first and last points.
929
930 If <i> WithRatio = Standard_True </i> the algorithm tries to reach C1 continuity.
931
932 The method to get a result is <i> Handle(Geom_BSplineCurve) GeomConvert_CompCurveToBSplineCurve::BSplineCurve() const </i>
933
934 @section OCCT_TOVW_SECTION_4 Modeling Algorithms
935
936 Modeling Algorithms module groups a wide range of 
937 topological algorithms used in modeling and geometric algorithms, called by them.
938
939 These services are organized into the following libraries:
940
941   * Geometric Tools 
942   * Topological Tools 
943   * Construction of Primitives 
944   * Boolean Operations 
945   * Fillets and Chamfers 
946   * Offsets and Drafts 
947   * Features 
948   * Hidden Line Removal
949   * Shape Healing 
950
951 @image html /technical_overview/images/technical_overview_ma.png
952 @image latex /technical_overview/images/technical_overview_ma.png
953
954 The technical overview provides only a basic description of the libraries. Please, refer for more details to  <a href="user_guides__modeling_algos.html">Modeling Algorithms User's guide</a>
955
956 See also: our web site at <a href="http://www.opencascade.org/support/training/">E-learning and Training</a>.
957
958 @subsection OCCT_TOVW_SECTION_4_1 Geometric Tools
959
960 This library provides algorithms to:
961
962   * Calculate the intersection of two 2D curves, surfaces, or a 3D curve and a surface;
963   * Project points onto 2D and 3D curves, points onto surfaces, and 3D curves onto surfaces;
964   * Construct lines and circles from constraints; 
965   * Construct curves and surfaces from constraints; 
966   * Construct curves and surfaces by interpolation 
967
968 OPEN CASCADE company also provides a product known as Surfaces from Scattered Points
969 (SSP), which allows constructing surfaces from scattered points. This algorithm accepts
970 or constructs an initial B-Spline surface and looks for its deformation (finite elements
971 method) which would satisfy the constraints. Using optimized computation methods,
972 this algorithm is able to construct a surface from more than 500 000 points.
973
974 SSP product is not supplied with Open CASCADE Technology, but can be purchased separately.
975
976 @subsubsection OCCT_TOVW_SECTION_4_1_1 Intersections
977
978 The Intersections component is used to compute intersections between 2D or 3D geometrical
979 objects: 
980
981   * the intersections between two 2D curves
982   * the self-intersections of a 2D curve
983   * the intersection between a 3D curve and a surface
984   * the intersection between two surfaces.
985
986 @subsubsection OCCT_TOVW_SECTION_4_1_2 Projections
987
988 The Projections component provides functionality for 2D and 3D geometry objects for computing the following:
989
990   * the projections of a 2D point onto a 2D curve
991   * the projections of a 3D point onto a 3D curve or surface
992   * the projection of a 3D curve onto a surface.
993   * the planar curve transposition from the 3D to the 2D parametric space of an underlying plane and v. s.
994   * the positioning of a 2D gp object in the 3D geometric space.
995
996 @subsubsection OCCT_TOVW_SECTION_4_1_3 Lines and Circles from Constraints
997
998 The Lines and Circles from Constraints component provides numerous 
999 construction algorithms for 2D circles or lines described with numeric or 
1000 geometric constraints in relation to other curves. These constraints enable the following to be imposed:
1001
1002   * the radius of a circle,
1003   * the angle that a straight line makes with another straight line,
1004   * the tangency of a straight line or circle in relation to a curve,
1005   * the passage of a straight line or circle through a point,
1006   * the circle with center in a point or curve.
1007
1008 For example, these algorithms enable to easily construct a circle of a given radius,
1009 centered on a straight line and tangential to another circle.
1010
1011 The implemented algorithms are more complex than those provided 
1012 by the Direct Constructions component for building 2D circles or lines.
1013
1014 The expression of a tangency problem generally leads to several results, according
1015 to the relative positions of the solution and the circles or straight lines in relation
1016 to which the tangency constraints are expressed. For example, consider the following
1017 case of a circle of a given radius (a small one) which is tangential to two secant
1018 circles C1 and C2:
1019
1020 @image html /technical_overview/images/technical_overview_occ_0005.png "Example of a Tangency Constraint"
1021 @image latex /technical_overview/images/technical_overview_occ_0005.png "Example of a Tangency Constraint"
1022
1023 This diagram clearly shows that there are 8 possible solutions.
1024
1025 In order to limit the number of solutions, we can try to express the relative position
1026 of the required solution in relation to the circles to which it is tangential. For
1027 example, if we specify that the solution is inside the circle C1 and outside the
1028 circle C2, only two solutions referenced 3 and 4 on the diagram respond to the problem
1029 posed.
1030
1031 This technique of qualification of a solution, in relation to the curves to which
1032 it is tangential, can be used in all algorithms for constructing a circle or a straight
1033 line by geometric constraints. Four qualifiers are used, which specify the following:
1034
1035   * the solution(s) must enclose the argument, or
1036   * the solution(s) must be enclosed by the argument, or
1037   * the solution(s) and the argument must be external to one another, or
1038   * the relative position is not qualified, i.e. all solutions apply.
1039
1040 These definitions are very easy to interpret on a circle, where it is easy to identify
1041 the interior and exterior sides. In fact, for any kind of curve the interior is defined
1042 as the left-hand side of the curve in relation to its orientation.
1043
1044 OCCT implements several categories of algorithms:
1045
1046   * analytic algorithms, where solutions are obtained by the resolution of an equation, such algorithms are used when the geometries which are worked on (tangency arguments,   position of the center, etc.) are points, lines or circles;
1047   * geometric algorithms, where the solution is generally obtained by calculating the intersection of parallel or bisecting curves built from geometric arguments;
1048   * iterative algorithms, where the solution is obtained by a process of iteration.
1049
1050 For each kind of geometric construction of a constrained line or circle, OCCT provides
1051 two types of access to the user:
1052
1053   * algorithms from the package <i> Geom2dGcc </i> automatically select the algorithm best suited to the problem to be treated, both in the general case and in all types of specific cases; the arguments used are Geom2d objects; the solutions computed are <i> gp </i> objects;
1054   * algorithms from the package <i> GccAna</i> resolve the problem analytically, and can only be used when the geometries to be worked on are lines or circles; the arguments used and solutions computed are <i> gp </i> objects.
1055
1056 The provided algorithms compute all solutions, which correspond to the stated geometric
1057 problem, unless the solution is found by an iterative algorithm.
1058
1059 Iterative algorithms compute only one solution, closest to an initial
1060 position. They can be used in the following cases:
1061
1062   * to build a circle, when an argument is more complex than a line or a circle, and where 
1063   the radius is not known or difficult to determine: this is the case for a circle tangential 
1064   to three geometric elements, or tangential to two geometric elements and centered on a curve;
1065   * to build a line, when a tangency argument is more complex than a line or a circle.
1066
1067 Qualified curves (for tangency arguments) are provided either by:
1068
1069   * the <i> GccEnt</i> package, for direct use by <i> GccAna</i> algorithms, or
1070   * the <i> Geom2dGcc </i> package, for general use by <i> Geom2dGcc </i> algorithms.
1071
1072 The <i> GccEnt</i> and <i> Geom2dGcc</i> packages also provide simple functions for building qualified curves in a very efficient way.
1073
1074 The <i> GccAna </i>package also provides algorithms for constructing bisecting loci between
1075 circles, lines or points. Bisecting loci between two geometric objects are such that
1076 each of their points is at the same distance from the two geometric objects. They
1077 are typically curves, such as circles, lines or conics for <i> GccAna</i> algorithms. 
1078 Each elementary solution is given as an elementary bisecting locus object (line, circle,
1079 ellipse, hyperbola, parabola), described by the <i>GccInt</i> package.
1080
1081 Note: Curves used by <i> GccAna </i> algorithms to define the geometric problem to be solved,
1082 are 2D lines or circles from the <i> gp</i> package: they are not explicitly parameterized.
1083 However, these lines or circles retain an implicit parameterization, corresponding
1084 to that which they induce on equivalent Geom2d objects. This induced parameterization
1085 is the one used when returning parameter values on such curves, for instance with
1086 the functions <i> Tangency1, Tangency2, Tangency3, Intersection2</i> and <i> CenterOn3</i> provided
1087 by construction algorithms from the <i> GccAna </i> or <i> Geom2dGcc</i> packages.
1088
1089 @subsubsection OCCT_TOVW_SECTION_4_1_4 Curves and Surfaces from Constraints
1090
1091 The Curves and Surfaces from Constraints component groups together high level functions
1092 used in 2D and 3D geometry for:
1093
1094   * creation of faired and minimal variation 2D curves
1095   * construction of ruled surfaces
1096   * construction of pipe surfaces
1097   * filling of surfaces
1098   * construction of plate surfaces
1099   * extension of a 3D curve or surface beyond its original bounds.
1100
1101 #### 2D Curves from constraints
1102
1103
1104 Elastic beam curves have their origin in traditional methods of modeling applied 
1105 in boat-building, where a long thin piece of wood, a lathe, was forced to pass
1106 between two sets of nails and in this way, take the form of a curve based on the
1107 two points, the directions of the forces applied at those points, and the properties
1108 of the wooden lathe itself.
1109
1110 Maintaining these constraints requires both longitudinal and transversal forces to
1111 be applied to the beam in order to compensate for its internal elasticity. The longitudinal
1112 forces can be a push or a pull and the beam may or may not be allowed to slide over
1113 these fixed points.
1114
1115 The class <i> Batten</i> produces curves defined on the basis of one or more constraints
1116 on each of the two reference points. These include point and angle of tangency settings.
1117 The class <i> MinimalVariation</i> produces curves with minimal variation in curvature. 
1118 The exact degree of variation is provided by curvature settings.
1119
1120 #### Ruled Surfaces
1121
1122 A ruled surface is built by ruling a line along the length of two curves.
1123
1124 #### Pipe Surfaces
1125
1126
1127 A pipe is built by sweeping a curve (the section) along another curve (the path).
1128
1129 The following types of construction are available:
1130   * pipes with a circular section of constant radius,
1131   * pipes with a constant section,
1132   * pipes with a section evolving between two given curves.
1133
1134
1135 #### Surface filling
1136
1137 It is often convenient to create a surface from two or more curves which will form
1138 the boundaries that define the new surface.
1139
1140 A case in point is the intersection of two fillets at a corner. If the radius of
1141 the fillet on one edge is different from that of the fillet on another, it becomes
1142 impossible to sew together all the edges of the resulting surfaces. This leaves a
1143 gap in the overall surface of the object which you are constructing.
1144
1145 @image html /technical_overview/images/technical_overview_occ_0006.png "Intersecting filleted edges with differing radiuses"
1146 @image latex /technical_overview/images/technical_overview_occ_0006.png "Intersecting filleted edges with differing radiuses"
1147
1148 These algorithms allow you to fill this gap from two, three or four curves. This
1149 can be done with or without constraints, and the resulting surface will be either
1150 a Bezier or a BSpline surface in one of a range of filling styles.
1151
1152
1153 This package was designed with a view to handling gaps produced during fillet construction.
1154 Satisfactory results cannot be guaranteed for other uses.
1155
1156 #### Plate surfaces
1157
1158
1159 In CAD, it is often necessary to generate a surface which has no exact mathematical
1160 definition, but which is defined by respective constraints. These can be of a mathematical,
1161 a technical or an aesthetic order.
1162
1163
1164 Essentially, a plate surface is constructed by deforming a surface so that it conforms
1165 to a given number of curve or point constraints. In the figure below, you can see
1166 four segments of the outline of the plane, and a point which have been used as the
1167 curve constraints and the point constraint respectively. The resulting surface can
1168 be converted into a BSpline surface by using the function <i> MakeApprox </i>.
1169
1170
1171 The surface is built using a variational spline algorithm. It uses the principle
1172 of deformation of a thin plate by localised mechanical forces. If not already given
1173 in the input, an initial surface is calculated. This corresponds to the plate prior
1174 to deformation. Then, the algorithm is called to calculate the final surface. It
1175 looks for a solution satisfying constraints and minimizing energy input.
1176
1177 @image html /technical_overview/images/technical_overview_occ_0007.png "Surface generated from four curves and a point"
1178 @image latex /technical_overview/images/technical_overview_occ_0007.png  "Surface generated from four curves and a point" 
1179
1180 @image html /technical_overview/images/technical_overview_occ_0008.png "Surface generated from two curves and a point"
1181 @image latex /technical_overview/images/technical_overview_occ_0008.png "Surface generated from two curves and a point" 
1182
1183 #### Extension of a 3D curve or surface beyond its original bounds
1184
1185 The extension is performed according to a geometric requirement and a continuity
1186 constraint. It should be a small extension with respect to the size of the original
1187 curve or surface.
1188
1189 @subsubsection OCCT_TOVW_SECTION_4_1_5 Interpolation
1190
1191 The Interpolation Laws component provides definitions of functions: <i> y=f(x) </i>.
1192
1193 In particular, it provides definitions of:
1194
1195   * a linear function,
1196   * an <i> S </i> function, and
1197   * an interpolation function for a range of values.
1198
1199 Such functions can be used to define, for example, the evolution law of a fillet along the edge of a shape.
1200
1201 The validity of the function built is never checked: the Law package does not know for what 
1202 application or to what end the function will be used. In particular, if the function is used 
1203 as the evolution law of a fillet, it is important that the function is always positive. The user must check this.
1204
1205 @subsection OCCT_TOVW_SECTION_4_2 Topological Tools
1206
1207 This library provides algorithms to:
1208
1209   * Tessellate shapes 
1210   * Validate shapes 
1211   * Determine the local properties of shapes 
1212   * Determine the global properties of shapes 
1213   * Perform geometric transformations
1214   * Find planes in which edges are located
1215   * Convert shapes to NURBS geometry.
1216
1217 It also furnishes a complete brep data structure for topological data structures defined 
1218 in the Topology library of the Modeling Data module. 
1219 This linAllows you to create standard topological objects such as:
1220
1221   * Vertices
1222   * Edges
1223   * Faces
1224   * Wires
1225   * Polygonal wires
1226   * Shells
1227   * Solids.
1228
1229 The API provides classes to build objects:
1230
1231   * The constructors of classes provide different construction methods;
1232   * The class retains different tools used to build objects as fields;
1233   * The class provides a casting method to obtain the result automatically with a function-like call. 
1234
1235 For example, to build a vertex V on a point P, you can use:
1236
1237 ~~~
1238     V = BRepBuilderAPI_MakeVertex(P);
1239 ~~~
1240 or
1241
1242 ~~~
1243     BRepBuilderAPI_MakeVertex MV(P);
1244     V = MV.Vertex();
1245 ~~~ 
1246
1247 For error handling, the <i> BRepBuilderAPI</i> commands raise only the 
1248 <i> 0StdFail_NotDone</i> exception. When <i> IsDone</i> is false for a command, 
1249 the error description can be requested from the command.
1250
1251 @subsection OCCT_TOVW_SECTION_4_3 Construction of Primitives
1252
1253 This library contained in <i> BRepPrimAPI</i> package provides an API (Application Programming Interface) for:
1254
1255   * Construction of primitives such as:
1256     * Boxes;
1257     * Cones;
1258     * Cylinders;
1259     * Prisms.
1260   * Construction by sweeping along a profile:
1261     * Linear;
1262     * Rotational (through an angle of rotation).
1263
1264 Sweeps are objects obtained by sweeping a profile along a path. 
1265 The profile can be any topology and the path is usually a curve or a wire. 
1266 The profile generates objects according to the following rules:
1267
1268   * Vertices generate Edges
1269   * Edges generate Faces.
1270   * Wires generate Shells.
1271   * Faces generate Solids.
1272   * Shells generate Composite Solids.
1273
1274 It is not allowed to sweep Solids and Composite Solids.
1275
1276 Swept constructions along complex profiles such as 
1277 BSpline curves are also available in the <i> BRepOffsetAPI </i> package.
1278
1279 This API provides simple, high level calls for the most common operations.
1280
1281 @subsection OCCT_TOVW_SECTION_4_4 Boolean Operations 
1282
1283 Boolean operations to create new shapes from old ones by using:
1284
1285   * Common 
1286   * Cut 
1287   * Fuse 
1288   * Section 
1289
1290 There are two libraries for Boolean Operations: 
1291
1292   * Old Boolean Operations (BOA) provided by <i>BRepAlgo</i> package designed and developed in Open CASCADE 6x in 2000; its architecture and content are out of date.
1293   * New Boolean Operations (NBOA) provided by <i>BRepAlgoAPI</i> package designed and developed in 2009 and completely revised in 2013.
1294
1295 New Boolean Operations provide the following major benefits:
1296
1297   * The NBOA have an expandable architecture of inner sub-algorithms, which  allows to create specific algorithms for the Customers using existing inner sub-algorithms as root algorithms and to reduce the time for the development. 
1298   * The architecture of inner sub-algorithms of NBOA provides their reusability with maximal independence from the environment of NBOA. The fact allows to create specific algorithms for the Customers using these sub-algorithms as they are or as root classes and thus to reduce the time for the development. 
1299   * The architecture of NBOA is history-based. The implementation of NBOA internally sets up a correspondence between any sub-shape of the argument and its image in the result. The history is not imposed and thus it is not error-prone as it was in BOA. The fact allows direct and safely usage of the algorithm in parametric modeling.   
1300   * NBOA provide a general algorithm. It correctly processes without using the workarounds even the cases that cannot be properly processed by BOA.
1301   * The implementation of NBOA is based on NCollection classes. The usage of opportunities given by local memory allocators ( <i> NCollection_IncAllocator</i>) allows improving memory management and saving memory resources. 
1302   * NBOA use modern algorithms of OCC as auxiliary tools. For e.g. the algorithm of unbalanced binary tree of overlapped bounding boxes <i> NCollection_UBTree</i>. The usage of the algorithm allows to improve the performance of NBOA if there is a big number of sub-shapes in the arguments.
1303
1304 Boolean Operations have the following types of the arguments and produce the following results:
1305 * For arguments having the same shape type (e.g. SOLID / SOLID) the type of the resulting shape will be a COMPOUND, containing shapes of this type;
1306 * For arguments having different shape types (e.g. SHELL / SOLID) the type of the resulting shape will be a COMPOUND, containing shapes of the type that is the same as that of the low type of the argument. Example: For SHELL/SOLID the result is a COMPOUND of SHELLs. 
1307 * For arguments with different shape types some of Boolean Operations can not be done using the default implementation, because of a non-manifold type of the result. Example: the FUSE operation for SHELL and SOLID can not be done, but the CUT operation can be done, where SHELL is the object and SOLID is the tool.
1308 * It is possible to perform Boolean Operations on arguments of the COMPOUND shape type. In this case each compound must not be heterogeneous, i.e. it must contain equidimensional shapes (EDGEs or/and WIREs, FACEs or/and SHELLs, SOLIDs). SOLIDs inside the COMPOUND must not contact (intersect or touch) each other. The same condition should be respected for SHELLs or FACEs, WIREs or EDGEs.
1309 * Boolean Operations for COMPSOLID type of shape are not supported.
1310
1311 @subsection OCCT_TOVW_SECTION_4_5 Features
1312
1313 This library contained in BRepFeat package is necessary for the creation 
1314 and manipulation of both form and mechanical features in a Boundary Representation framework.
1315
1316 The form features are depressions or protrusions including the following types:
1317
1318   * Cylinder;
1319   * Draft Prism;
1320   * Prism;
1321   * Revolved feature;
1322   * Pipe.
1323
1324 Depending on whether you wish to make a depression or a protrusion, 
1325 you can choose either to remove matter (Boolean cut: Fuse equal to 0) or to add it (Boolean fusion: Fuse equal to 1).
1326
1327 The semantics of form feature creation is based on the construction of shapes:
1328
1329   * for a certain length in a certain direction;
1330   * up to the limiting face;
1331   * from the limiting face at a height;
1332   * above and/or below a plane.
1333
1334 The shape defining the construction of a feature can be 
1335 either a supporting edge or a concerned area of a face.
1336
1337 In case of supporting edge, this contour can be attached to a face 
1338 of the basis shape by binding. When the contour is bound to this face, 
1339 the information that the contour will slide on the face becomes available 
1340 to the relevant class methods. In case of the concerned area of a face, you could, 
1341 for example, cut it out and move it at a different height, 
1342 which will define the limiting face of a protrusion or depression.
1343
1344 Topological definition with local operations of this sort makes calculations simpler 
1345 and faster than a global operation. The latter would entail a second phase 
1346 of removing unwanted matter to get the same result.
1347
1348 Mechanical features include ribs, protrusions and grooves (or slots), 
1349 depressions along planar (linear) surfaces or revolution surfaces.
1350
1351 The semantics of mechanical features is based on giving thickness to a contour. 
1352 This thickness can either be
1353
1354   * unilateral 
1355   * on one side of the contour 
1356   * or bilateral 
1357   * on both sides. 
1358
1359 As in the semantics of form features, the thickness is defined 
1360 by construction of shapes in specific contexts.
1361
1362 However, in case of mechanical features, development contexts differ. 
1363 Here they include extrusion:
1364
1365   * to a limiting face of the basis shape;
1366   * to or from a limiting plane;
1367   * to a height.
1368
1369 @subsection OCCT_TOVW_SECTION_4_6 Hidden Line Removal
1370
1371 This library provides two algorithms: <i> HLRBRep_Algo</i> and <i> HLRBRep_PolyAlgo</i>  to define the lines of a shape hidden in a given projection.  These lines can be shown or hidden to have the precision required in industrial design. To do this, the Hidden Line Removal component provides 
1372
1373 These algorithms remove or indicate lines hidden by surfaces. 
1374 For a given projection, they calculate a set of lines characteristic of the object  being represented. They are also used in conjunction with extraction utilities,   which reconstruct a new, simplified shape from a selection of calculation results. 
1375 This new shape is made up of edges, which represent the lines of the visualized shape in a plane.   This plane is the projection plane.
1376
1377 The algorithm <i> HLRBRep_Algo</i> allows working with the shape itself,  while <i> HLRBRep_PolyAlgo </i>works with its polyhedral simplification. When you use <i> HLRBRep_Algo</i>, you obtain an exact result, whereas, when you use <i> HLRBRep_PolyAlgo</i>, you reduce computation time but obtain polygonal segments.
1378
1379 @subsection OCCT_TOVW_SECTION_4_7 Shape Healing
1380
1381 Shape Healing library provides algorithms to modify the geometry and topology of OCCT shapes.
1382 Shape Healing adapts shapes to make them maximally appropriate for use by OCCT, for example:
1383
1384  * analyze shape characteristics and, in particular, identify the shapes that do not comply with OCCT validity rules; 
1385   * fix incorrect or problem shapes;
1386   * upgrade and change shape characteristics if needed, for example a C0 supporting surface can become C1 continuous.
1387
1388 It has several sub-domains, each with its own scope of functionality:
1389
1390   * analysis        - exploring shape properties, computing shape features, detecting violation of OCCT requirements (the shape itself is not modified);
1391   * fixing          - fixing shape to meet the OCCT requirements (the shape may change its original form: modifying, removing, constructing sub-shapes, etc.);
1392   * upgrade         - shape improvement for better usability in OCCT or other algorithms (the shape is replaced with a new one, but geometrically they are the same);
1393   * customization   - modifying shape representation to fit specific needs (the shape is not modified, only the form of its representation is modified);
1394   * processing      - mechanism of shape modification via a user-editable resource file.
1395
1396 The technical overview provides only a basic description of the libraries. Please, refer for more details to  <a href="user_guides__shape_healing.html">Shape Healing User's guide</a>
1397
1398 See also: our web site at <a href="http://www.opencascade.org/support/training/">E-learning and Training</a>.
1399
1400
1401 @subsection OCCT_TOVW_SECTION_4_8 Miscellaneous modelling algorithms. 
1402
1403 ### Fillets and Chamfers
1404
1405 This library provides algorithms to make fillets and chamfers on shape edges.
1406 The following cases are addressed:
1407
1408   * Corners and apexes with different radii; 
1409   * Corners and apexes with different concavity. 
1410
1411 If there is a concavity, both surfaces that need to be extended and those, which do not, are processed.
1412
1413 ### Offsets, Drafts, Sewing and Sweeps
1414
1415 These classes provide the following services:
1416
1417   * Creation of offset shapes and their variants such as: 
1418     * Hollowing; 
1419     * Shelling; 
1420     * Lofting; 
1421   * Creation of tapered shapes using draft angles 
1422   * Sewing 
1423   * Creation of sweeps 
1424
1425
1426 @subsection OCCT_TOVW_SECTION_4_9 Examples
1427
1428 ### How to compute the state of a point on a face:
1429
1430
1431 Use <i> BRepTools::Pnt </i> to get the point from your vertex.
1432 Your shape must be of the <i> TopoDS_Shape </i>type.
1433 If it is, you can use <i> BRepTopAdaptor_FClass2d </i>class. For example:
1434
1435 ~~~~~
1436     BRepTopAdaptor_FClass2d::Load (to load the solid )
1437     BRepTopAdaptor_FClass2d::Perform (to compute the state of the point )
1438     BRepTopAdaptor_FClass2d::State (to get the TopAbs_State). 
1439 ~~~~~
1440
1441
1442 ### How to compute the state of a point in a solid:
1443
1444
1445 Use <i>BRepTools::Pnt </i> to get the point from your vertex.
1446 Your shape must be of the <i> TopoDS_Solid</i> type.
1447
1448 If it is, you can use the <i> BRepClass3d_SolidClassifier </i> class, for example:
1449
1450 ~~~~~
1451     BRepClass3d_SolidClassifier::Load (to load the solid)
1452     BRepClass3d_SolidClassifier::Perform (to compute the state of the point)
1453     BRepClass3d_SolidClassifier::State (to get a TopAbs_State object)
1454     BRepClass3d_SolidClassifier inherits BRepclass3d_SClassifier
1455 ~~~~~
1456
1457 ### How to connect a set of contiguous but independent faces
1458
1459
1460 A unique topological object can be obtained in this way using the class 
1461 <i> Sewing</i> from the <i> BRepOffsetAPI </i>package which produces a shell as a result.
1462
1463 ~~~~~
1464     BRepOffsetAPI_Sewing Sew;
1465     Sew.Add(Face1); 
1466     Sew.Add(Face2); 
1467     ...
1468     Sew.Add(Facen); 
1469     Sew.Perform();
1470     TopoDS_Shape result= Sew.SewedShape();
1471 ~~~~~
1472
1473 @note The sewing algorithm uses a tolerance to assemble the faces by sewing them along common edges. You must therefore check the gap between faces before sewing or adjust the value of the tolerance according to the real gap of the geometry.
1474
1475 If all faces have been sewed correctly, the result is a shell. Otherwise, it is a compound. After a successful sewing operation all faces have a coherent orientation.
1476
1477 For more information, refer to the entry for this class in reference documentation.
1478
1479 ### How to check the orientation of a solid
1480
1481 If you want to create a solid from a closed shell, you must first check the orientation to determine if you have to reverse the shell or not (for example after creating a closed shell from a sewing operation). To do this, use the <i> PerformInfinitePoint</i> method from the <i> BrepClass3D_SolidClassifier</i> class.
1482
1483 ~~~~~
1484     BRepClass3d_SolidClassifier clas3d(aShell);
1485     clas3d.PerformInfinitePoint(Precision::Confusion());
1486     if (clas3d.State() == TopAbs_IN)
1487     newShell.Reverse();
1488     BRepBuilderAPI_MakeSolid aSolid(aShell);
1489 ~~~~~
1490
1491 @section OCCT_TOVW_SECTION_5 Visualization
1492
1493 Visualization in Open CASCADE Technology is based on the separation of modeling data you want to display and select, and on the graphical presentation of its structure.
1494
1495 For visualizing data structures, OCCT provides ready-to-use algorithms, which create graphic presentations from geometric models. These data structures may be used with the viewers supplied, and can be customized to take the specificity of your application into account.
1496
1497 Display is managed through presentation services, and selection in its turn is managed through selection services. With these services, data structures and algorithms are provided to display objects of an application and to support graphical selection of these objects.
1498
1499 Application Interactive Services (AIS) are provided to manage displaying, detection and selection of graphical presentations. These services associate data structures and interactive objects.
1500
1501 The technical overview provides only a basic description of the libraries. Please, refer for more details to  <a href="user_guides__visualization.html">Visualization User's guide</a>
1502
1503 See also: our web site at <a href="http://www.opencascade.org/support/training/">E-learning and Training</a>.
1504
1505 @image html /technical_overview/images/technical_overview_viz.png
1506 @image latex /technical_overview/images/technical_overview_viz.png
1507
1508 @subsection OCCT_TOVW_SECTION_5_1 3D Graphics
1509
1510 3D Graphics provided by  <i>Graphic3d</i> package supports three-dimensional manipulation  of 3d graphic objects called structures. Structures, are made up of groups that unite primitives, such as polylines, planar polygons with or without holes, text and markers, and attributes,  such as color, transparency, reflection, line type, line width, and text font.
1511 A group is the smallest editable element of a structure.
1512
1513 A structure can be displayed, erased, highlighted and transformed.
1514 Structures can be connected to form a hierarchy of structures, composed by transformations.
1515 The viewer can perform global manipulation of structures.
1516
1517 <i> Visual3d </i> package contains the group of classes required to implement commands for 3D viewer. The viewer manages views and light sources.
1518
1519 Most types of primitives supported by <i> Graphic3d</i> can be dumped to a vector file format such as PDF and PostScript. Export to vector formats is implemented with help of <i> GL2PS</i> library.
1520
1521 @subsection OCCT_TOVW_SECTION_5_2 3D Visualization
1522
1523 This library provides services for:
1524
1525   * Selection of 3D data structures 
1526   * Presentation of 3D data structures 
1527
1528 Access to 3D presentation and selection is provided through AIS (Application Interactive Services). 
1529 This package is a high-level interface that offers access to the lower-level presentation and selection services. 
1530 AIS expand this underlying functionality with standard 3D selection attributes, presentation management,  and standard 3D presentation attributes, and manages it in the definition of GUI viewers. To implement these services, AIS package includes the following:
1531
1532   * Interactive context 
1533   * Interactive objects 
1534   * A graphic attributes manager 
1535   * Selection filters 
1536
1537 ### Interactive Context
1538
1539 Interactive context pilots 3D visualizations and selections. 
1540 The interactive context allows you to manage, in a transparent way, graphic and "selectable" behavior of interactive objects which is not yet defined in the predefined types of these objects.
1541
1542 AIS have two operating context types. The default neutral point type allows easily visualizing and selecting entire interactive objects, which have been loaded into the context. 
1543 Opening a local context allows preparing and using a temporary selection environment to select a part of an interactive object.
1544
1545 ### Interactive Objects
1546
1547 Entities which are visualized and selected in the AIS viewer are objects.  They connect the underlying reference geometry of a model to its graphic representation in AIS. You can use predefined OCCT classes of standard interactive objects for which all necessary functions have already been programmed, or, in case you are an advanced user, you can implement your own classes of interactive objects.
1548
1549 ### Graphic Attributes Manager
1550
1551 Graphic attributes manager, or AIS Drawer, stores graphic attributes  for specific interactive objects and for interactive objects controlled by interactive context.
1552
1553 Initially, all drawer attributes are filled out with the predefined  values which will define the default 3D object appearance.
1554
1555 When an interactive object is visualized, the required graphic attributes are first taken from its own drawer if one exists, or from the context drawer if no specific drawer for that type of object exists.
1556
1557 ### Selection Filters
1558
1559 An important aspect in selection is the filtering of entities you to select. 
1560 Selection filters allow you to refine the dynamic detection context, which you want to put into effect. Some of these filters can be used at the Neutral Point, others in an open local context only. You can also program your own filters and load them into the context.
1561
1562
1563 @subsection OCCT_TOVW_SECTION_5_3 Application Interactive Services (AIS)
1564
1565 Application Interactive Services provide the means to create links between an application GUI viewer and the packages which are used to manage selection and presentation. The tools AIS defined for this include different sorts of entities: the selectable viewable objects themselves and the context and attribute managers to define their selection and display.
1566
1567 To orient the user as he works in a modeling environment, views and selections must be comprehensible. 
1568 There must be several different sorts of selectable and viewable object defined. 
1569 These must also be interactive, that is, connecting graphic representation and the underlying reference geometry. These entities are called Interactive Objects, and are divided into four types:
1570   * the Datum
1571   * the Relation
1572   * the Object
1573   * None.
1574
1575 The Datum groups together the construction elements such as lines, circles, points, trihedrons, plane trihedrons, planes and axes.
1576 The Relation is made up of constraints on one or more interactive shapes and the corresponding reference geometry. For example, you might want to constrain two edges in a parallel relation. This constraint is considered as an object in its own right, and is shown as a sensitive primitive. This takes the graphic form of a perpendicular arrow marked with the || symbol and lying between the two edges.
1577
1578 The Object type includes topological shapes, and connections between shapes.
1579
1580 None, in order not to eliminate the object, tells the application to look further until it finds an object definition in its generation which is accepted.
1581
1582 Inside these categories, you have the possibility of an additional characterization by means of a signature. The signature provides an index to the further characterization. By default, the Interactive Object has a None type and a signature of 0 (equivalent to None.) 
1583 If you want to give a particular type and signature to your interactive object, you must redefine the two virtual methods: <i> Type</i> and <i> Signature</i>.
1584
1585 In the C++ inheritance structure of the package, each class representing a specific Interactive Object inherits <i> AIS_InteractiveObject</i>. Among these inheriting classes, <i> AIS_Relation</i> functions as the abstract mother class for inheriting classes defining display of specific relational constraints and types of dimension. Some of these include:
1586
1587   * display of constraints based on relations of symmetry, tangency, parallelism and concentricity
1588   * display of dimensions for angles, offsets, diameters, radii and chamfers.
1589
1590 No viewer can show everything at once with any coherence or clarity. 
1591 Views must be managed carefully both sequentially and at any given instant. 
1592 Another function of the view is that of a context to carry out design in. 
1593 The design changes are applied to the objects in the view and then extended 
1594 to the underlying reference geometry by a solver. 
1595 To make sense of this complicated visual data, several display and selection tools are required. 
1596 To facilitate management, each object and each construction element has a selection priority. 
1597 There are also means to modify the default priority.
1598
1599 To define an environment of dynamic detection, you can use standard filter classes or create your own. 
1600 A filter questions the owner of the sensitive primitive in local context to determine 
1601 if it has the desired qualities. If it answers positively, it is kept. If not, it is rejected.
1602
1603 The standard filters supplied in AIS include:
1604
1605   * <i> AIS_AttributeFilter</i>
1606   * <i> AIS_SignatureFilter</i>
1607   * <i> AIS_TypeFilter</i>.
1608
1609 Only the type filter can be used in the default operating mode, the neutral point. 
1610 The others can only be used in open local contexts.
1611
1612 Neutral point and local context constitute the two operating modes of the 
1613 central entity which pilots visualizations and selections, the Interactive Context. 
1614 It is linked to a main viewer and if you like, a trash bin viewer as well.
1615
1616 The neutral point, which is the default mode, allows you to easily visualize and select interactive objects which have been loaded into the context. Opening local contexts allows you to prepare and use a temporary selection environment without disturbing the neutral point. 
1617 A set of functions allows you to choose the interactive objects which you want to act on, the selection modes which you want to activate, and the temporary visualizations which you will execute. When the operation is finished, you close the current local context and return to the state in which you were before opening it (neutral point or previous local context).
1618
1619 An interactive object can have a certain number of graphic attributes, which are specific to it, such as visualization mode, color, and material. By the same token, the interactive context has a set of graphic attributes, the Drawer which is valid by default for the objects it controls. 
1620 When an interactive object is visualized, the required graphic attributes are first taken from the object's own <i> Drawer</i> if one exists, or from the context drawer for the others.
1621
1622
1623 @subsection OCCT_TOVW_SECTION_5_4 Presentation
1624
1625 ### Presentation Management
1626    
1627 <i> PrsMgr</i> package provides low level services and is only to be used when you do not want to use the services provided by AIS. It manages the display through the following services:
1628   * supplying a graphic structure for the object to be presented
1629   * recalculating presentations when required, e.g. by moving the object or changing its color
1630   * defining the display mode of the object to be presented; in the case of <i> AIS_Shape</i>, for example, this determines whether the object is to be displayed in wireframe (0) or shading (1) mode.
1631
1632 Note that each new Interactive Object must have all its display modes defined.
1633
1634 ### Presentations of Geometry
1635
1636 The Presentations of Geometry component provides services for advanced programmers to extend the Application Interactive Services component, AIS. 
1637 This would prove necessary in situations where new Interactive Objects were required.
1638
1639 The <i> StdPrs </i>package provides standard display tools for specific geometries and topologies whereas <i> Prs3d</i> provides those for generic objects. 
1640 Among these classes are definitions of the display of the specific geometry or topology in various display modes such as wireframe, shading or hidden line removal mode.
1641
1642 ### Presentation of Dimensions
1643
1644  <i> DsgPrs </i> package provides tools for display of dimensions, relations and XYZ trihedrons.
1645
1646 @subsection OCCT_TOVW_SECTION_5_5 Selection
1647
1648 Selection of 3D data structures is provided using various algorithms. 
1649   
1650 ### Basic Selection
1651
1652
1653 The <i> SelectBasics </i>package provides the following services:
1654
1655   * the root definition of the sensitive primitive, a selectable entity in a view
1656   * the definition of the owner of a sensitive primitive; this entity relates the primitive to the application entity which is to be selected in the view.
1657
1658 ### Standard Selections
1659
1660  
1661 The <i> StdSelect</i> package provides the following services:
1662
1663   * definition of selection modes for topological shapes
1664   * definition of several filter standard <i> Selection2d.ap </i> classes
1665   * 3D viewer selectors.
1666
1667 Note that each new Interactive Object must have all its selection modes defined.
1668 The <i>Select3D</i> package provides the following services:
1669
1670   * definition of standard   3D sensitive primitives such as points, curves and faces;
1671   * recovery of the bounding boxes in the 2D graphic selection space, if required;
1672   * a 3D-2D projector.
1673
1674 ### Selection Management
1675
1676  
1677 The <i> SelectMgr</i> package provides low level services and the classes 
1678 <i> SelectMgr_SelectionManager</i> and <i> SelectMgr_ViewerSelector </i>
1679 in particular are only to be used when you do not want to use the services provided by <i> AIS</i>.
1680
1681 <i> SelectMgr </i> manages the process of dynamic selection through the following services:
1682
1683   * activating and deactivating selection modes for Interactive Objects
1684   * adding and removing viewer selectors
1685   * definitions of abstract filter classes
1686
1687 The principle of graphic selection consists in representing the objects which you want 
1688 to select by a bounding box in the selection view. 
1689 The object is selected when you use the mouse to designate the zone produced by the object.
1690
1691 To realize this, the application creates a selection structure 
1692 which is independent of the point of view. This structure is made up 
1693 of sensitive primitives which have one owner object associated to each of them. 
1694 The role of the sensitive primitive is to reply to the requests of the selection algorithm 
1695 whereas the owner's purpose is to make the link between 
1696 the sensitive primitive and the object to be selected. 
1697 Each selection structure corresponds to a selection mode which defines the elements that can be selected.
1698
1699 For example, to select a complete geometric model, 
1700 the application can create a sensitive primitive for each face 
1701 of the interactive object representing the geometric model. 
1702 In this case, all the primitives share the same owner. 
1703 On the other hand, to select an edge in a model, 
1704 the application must create one sensitive primitive per edge.
1705
1706 ~~~~
1707
1708 void InteractiveBox::ComputeSelection
1709       (const Handle(SelectMgr_Selection)& Sel,
1710        const Standard_Integer Mode){
1711   
1712 switch(Mode){
1713 case 0:
1714 // locating the whole box by making its faces sensitive ...
1715          {
1716        Handle(SelectMgr_EntityOwner) Ownr = new
1717        SelectMgr_EntityOwner(this,5);
1718        for(Standard_Integer I=1;I<=Nbfaces;I++){
1719        Sel->Add(new Select3D_SensitiveFace
1720                (Ownr,[array of the vertices] face I);
1721        break;
1722        }
1723
1724 case 1:         // locates the   edges
1725          {
1726   
1727        for(Standard_Integer i=1;i<=12;i++){
1728                         // 1 owner per edge...
1729          Handle(mypk_EdgeOwner) Ownr =
1730                   new mypk_EdgeOwner(this,i,6);
1731                         // 6->priority
1732          Sel->Add(new
1733          Select3D_SensitiveSegment
1734                   (Ownr,firstpt(i),lastpt(i));
1735        }
1736        }
1737 }
1738
1739 ~~~~
1740
1741 The algorithms for creating selection structures store the sensitive primitives in a 
1742 <i> SelectMgr_Selection </i> object. To do this, a set of ready-made sensitive primitives is supplied 
1743 in the <i> Select2D </i>and <i> Select3D </i>packages. New sensitive primitives can be defined through inheritance 
1744 from <i> SensitiveEntity</i>. For the application to make its own objects selectable,
1745  it must define owner classes inheriting <i> SelectMgr_EntityOwner</i>.
1746
1747 For any object inheriting from <i> AIS_InteractiveObject</i>, you redefine 
1748 its <i> ComputeSelection</i> functions. In the example below there are different modes 
1749 of selection on the topological shape contained within the interactive object, 
1750 selection of the shape itself, the vertices, the edges, the wires, the faces.
1751
1752 ~~~~
1753     void MyPack_MyClass::ComputeSelection(
1754                 const Handle(SelectMgr_Selection)& aSelection,
1755                 const Standard_Integer aMode)
1756     {
1757        switch(aMode){
1758        case 0:
1759        StdSelect_BRepSelectionTool::Load(
1760           aSelection,this,myShape,TopAbs_SHAPE);
1761        break;
1762        }
1763        case 1:
1764        StdSelect_BRepSelectionTool::Load(
1765           aSelection,this,myShape,TopAbs_VERTEX);
1766        break;
1767        }
1768        case 2:
1769        StdSelect_BRepSelectionTool::Load(
1770           aSelection,this,myShape,TopAbs_EDGE);
1771        break;
1772        }
1773        case 3:
1774        StdSelect_BRepSelectionTool::Load(
1775           aSelection,this,myShape,TopAbs_WIRE);
1776        break;
1777        }
1778        case 4:
1779        StdSelect_BRepSelectionTool::Load(
1780           aSelection,this,myShape,TopAbs_FACE);
1781        break;
1782        }
1783     }
1784 ~~~~
1785
1786 The <i> StdSelect_BRepSelectionTool </i> object provides a high level service 
1787 which will make the shape <i> myShape</i> selectable when the <i> AIS_InteractiveContext</i> is asked to display your object.
1788
1789 Note:
1790
1791 The traditional way of highlighting selected entity owners 
1792 adopted by Open CASCADE Technology assumes that each entity owner 
1793 highlights itself on its own. This approach has two drawbacks: 
1794
1795   * each entity owner has to maintain its own <i>Prs3d_Presentation object</i>, that results in large memory overhead for thousands of owners;
1796   * drawing selected owners one by one is not efficient from the OpenGL usage viewpoint.
1797
1798 That is why a different method has been introduced. 
1799 On the basis of <i> SelectMgr_EntityOwner::IsAutoHilight() </i> return value 
1800 <i> AIS_LocalContext </i> object either uses the traditional way of highlighting 
1801 ( <i> IsAutoHilight() </i> returned true) or groups such owners according to their 
1802 Selectable Objects and finally calls <i> SelectMgr_SelectableObject::HilightSelected()</i> or 
1803 <i> ClearSelected()</i>, passing a group of owners as an argument. 
1804
1805 Hence, an application can derive its own interactive object and redefine <i> HilightSelected()</i>,
1806  <i> ClearSelected()</i> and <i> HilightOwnerWithColor()</i> virtual methods 
1807  to take advantage of such OpenGL technique as arrays of primitives. 
1808  In any case, these methods should at least have empty implementation.
1809
1810  The <i> AIS_LocalContext::UpdateSelected(const Handle(AIS_InteratciveObject)&, Standard_Boolean) 
1811  </i> method can be used for efficient redrawing a selection presentation for a given interactive object from an application code.
1812
1813 Additionally, the <i> SelectMgr_SelectableObject::ClearSelections() </i> 
1814 method now accepts an optional Boolean argument. 
1815 This parameter defines whether all object selections should be flagged for further update or not. 
1816 This improved method can be used to re-compute an object selection (without redisplaying the object completely) 
1817 when some selection mode is activated not for the first time.
1818
1819
1820 @subsection OCCT_TOVW_SECTION_5_6 Attribute Management
1821
1822 The Attribute Management tool-kit provides services for advanced programmers to extend 
1823 the Application Interactive Services component, AIS. This would prove necessary 
1824 in situations where new Interactive Objects were required.
1825
1826 The <i> Prs3d </i> package provides the following services:
1827
1828   * a presentation object (the context for all modifications to the display, its presentation will be displayed in every view of an active viewer)
1829   * an attribute manager governing how objects such as color, width, and type of line are displayed; these are generic objects, whereas those in <i>StdPrs </i> are specific geometries and topologies.
1830   * generic algorithms providing default settings for objects such as points, curves, surfaces and shapes
1831   * a root object which provides the abstract framework for the DsgPrs definitions at work in display of dimensions, relations and trihedrons.
1832
1833
1834 @subsection OCCT_TOVW_SECTION_5_7 Mesh Visualization Services
1835
1836 <i> MeshVS</i> (Mesh Visualization Service) component extends 3D visualization capabilities 
1837 of Open CASCADE Technology. It provides flexible means of displaying meshes along with associated pre- and post-processor data. 
1838
1839 From a developer's point of view, it is easy to integrate the MeshVS component i
1840 nto any mesh-related application with the help of the following guidelines:
1841
1842 Derive a data source class from the MeshVS_DataSource class. 
1843 Re-implement its virtual methods, so as to give the <i> MeshVS</i> component access 
1844 to the application data model. This is the most important part of the job, 
1845 since visualization performance is affected by performance of data retrieval methods of your data source class.
1846
1847 Create an instance of the <i> MeshVS_Mesh</i> class. 
1848
1849 Create an instance of your data source class and pass it to a <i> MeshVS_Mesh </i> object through the <i> SetDataSource()</i> method.
1850
1851 Create one or several objects of <i> MeshVS_PrsBuilder</i>-derived classes 
1852 (either standard, included in the <i> MeshVS</i> package, or your custom ones). 
1853 Each <i> PrsBuilder</i> is responsible for drawing a <i> MeshVS_Mesh</i> presentation 
1854 in certain display mode(s) specified as a <i> PrsBuilder</i> constructor's argument. 
1855 Display mode is treated by <i> MeshVS</i> classes as a combination of bit flags
1856 (two least significant bits are used to encode standard display modes: wireframe, shading and shrink). 
1857 Pass these objects to the <i> MeshVS_Mesh::AddBuilder()</i> method. <i> MeshVS_Mesh</i> 
1858 takes advantage of improved selection highlighting mechanism: it highlights its selected entities itself, 
1859 with the help of so called "highlighter" object. You can set one of <i> PrsBuilder</i> 
1860 objects to act as a highlighter with the help of a corresponding argument of the <i> AddBuilder()</i> method.
1861
1862 Visual attributes of the <i> MeshVS_Mesh </i> object (such as shading color, shrink coefficient and so on) 
1863 are controlled through <i> MeshVS_Drawer</i> object. It maintains a map "Attribute ID --> attribute value" 
1864 and can be easily extended with any number of custom attributes.
1865
1866 In all other respects, <i> MeshVS_Mesh</i> is very similar to any other class derived 
1867 from <i> AIS_InteractiveObject</i> and it should be used accordingly 
1868 (refer to the description of <i> AIS package</i> in the documentation).
1869
1870 @subsection OCCT_TOVW_SECTION_5_8 Images and Drivers
1871
1872 ### Images
1873
1874 The <i> Image</i> package provides <i> PseudoColorImage</i> 
1875 and <i> ColorImage</i> definitions, and a set of key functions from the image fields. 
1876
1877 The <i> AlienImage</i> package allows importing images from other formats into OCCT format.
1878
1879 ### Drivers
1880
1881 The <i> Xw </i>package contains the common X graphic interface. It uses <i> XWindow </i> bitmap fonts that cannot be modified.
1882
1883 The <i> WNT</i> package contains the common Windows NT graphic interface.
1884
1885 The <i> Cocoa</i> package provides interaction with Cocoa API on Mac OS X.
1886
1887 @subsection OCCT_TOVW_SECTION_5_9 New Interactive Services (NIS)
1888
1889 New Interactive Services package provides the API similar to the traditional AIS but with some important differences/improvements:
1890
1891   * Each type of <i> InteractiveObject</i> should have a corresponding Drawer class that defines the presentation of the Object type using direct OpenGl calls. This is a much faster way to display 3D objects, providing for more than 1 million separate selectable entities in one view.
1892   * The abstract type <i> NIS_InteractiveObject</i> does not support any properties (color, material, other aspects). The relevant properties should be defined in the specializations of the Drawer class, and the API to set/modify should be implemented in the specializations of InteractiveObject class. 
1893   * Interactive selection is managed by <i> InteractiveObject</i> methods instead of special selector classes and data types. This is possible since in NIS the selection is based on 3D representation (by a ray or a box corresponding to the view direction) without intermediate 2D projection.
1894   * Many <i> InteractiveContext</i> instances can be attached to a <i> V3d_View</i>, these instances being independent containers of interactive objects; removal (detaching) of <i> InteractiveContext</i> instance destroys the contained objects.
1895   * All data types and algorithms are designed to provide the best performance for both OpenGl (server side) and application. On the other hand, the API is open to any feature supported by any version of OpenGl. This allows building custom presentations quickly and efficiently.
1896   * Standard <i> NIS_View</i> subclasses <i> V3d_View</i> thus providing all its public API, such as scene definition (view orientation, lights, background, etc.) and the standard view transformations (pan/zoom/rotate,fitAll,...). The traditional AIS-based presentations (e.g., <i> AIS_Shape</i>) are also supported, they can be rendered together with NIS presentations in the same view window.
1897
1898 The DRAW test plugin, <i> TKViewerTest</i>, has been modified 
1899 to manage <i> AIS_InteractiveContext</i> and <i> NIS_InteractiveContext</i> together in one view window.
1900
1901 @subsection OCCT_TOVW_SECTION_5_10 Voxels
1902
1903 A voxel is a sub-volume box with constant scalar/vector value. 
1904 The object in voxel representation is split into many small sub-volumes (voxels) and its properties are distributed through voxels.
1905
1906 Voxels are used for analysis and visualization of 3D-dimensional distribution of data. 
1907 Medicine (mainly, tomography), computational physics (hydrodynamics, aerodynamics, nuclear physics) 
1908 and many other industries use voxels for 3D data visualization and analysis of physical processes.
1909
1910 Open CASCADE Technology provides several basic data containers for voxels 
1911 with fast access to the data and optimal allocation of data in memory. 
1912 Also, a special visualization toolkit allows visualizing voxels 
1913 as colored or black/white points and cubes, displaying only the voxels visible from the user's point of view.
1914
1915 Please, see for more information <a href="occt_voxels_wp.html">Voxels User's Guide</a>.
1916
1917
1918 @subsection OCCT_TOVW_SECTION_5_11 Examples
1919
1920 ### How to change graphic attributes of an interactive object
1921
1922 The set of graphic attributes of an interactive object is defined in AIS_Drawer. 
1923 Each interactive object can have its own visualization attributes.
1924
1925 By default, the interactive object takes the graphic attributes of 
1926 the interactive context in which it is visualized 
1927 (visualization mode, deflection, values for the calculation of presentations, 
1928 number of isoparametric lines, color, type of line, material, etc.)
1929
1930 In the <i> AIS_InteractiveObject</i> abstract class, several standard attributes 
1931 have been privileged. These include: color, thickness of line, material, and transparency. 
1932 Consequently, a certain number virtual functions which allow us to act on these attributes have been proposed. 
1933 Each new class of interactive object can use them as they are or 
1934 can redefine these functions to bring about the changes it should produce in the behavior of the class.
1935
1936 Other attributes can be changed by acting directly on the drawer of the object. 
1937 An interactive object has a specific drawer as soon as you change an attribute on it. 
1938 If you do not modify any graphic attribute on it, the default drawer of the interactive context is referenced and used.
1939
1940 To get the <i> AIS_Drawer</i> of an object, call method <i> AIS_InteractiveObject::Attributes </i>.
1941
1942 To set the <i> AIS_Drawer</i> of an object, call method <i> AIS_InteractiveObject::SetLocalAttributes </i>. 
1943
1944 ### How to dump a scene from the viewer
1945
1946 You can dump the contents of a <i> V3D_View</i> in a file with the same scale or 
1947 with a different scale according to the required paper size (format) 
1948 and the aspect ratio of the view. This is provided by method <i>V3d_View::Dump</i>. For example:
1949
1950 ~~~~
1951 CString filename ("myView3D.bmp");
1952 myView->Dump (filename, Aspect_FOSP_A4);
1953 ~~~~
1954
1955 <i> myView</i> is a <i> V3d_View</i>, where OCCT objects are displayed using, for example, AIS services.
1956
1957 Please, note:
1958
1959   * The file name extension can be any among ".xwd", ".png", or ".bmp" formats both on UNIX or NT.
1960   * Be careful about dump time requirements of the resulting file, especially for the A formats.
1961   * The GIF format generates very small files, BMP and XWD generates much larger files (4 to 6 times the size of a GIF).
1962   * The time to generate these files is very short with the XWD format but 2 to 4 times longer for the other formats.
1963   * After getting an image file of your view, you can use any standard application for editing or sending the image file to a printer (i.e.: Microsoft Photo Editor on Windows or Image Viewer on SUN system)
1964
1965 ### How to add and remove objects from Selections
1966
1967
1968 You can add or remove an object from a selection in one of two ways. You can use:
1969
1970   * <i> AIS_InteractiveContext::AddOrRemoveCurrentObject</i> method at neutral points;
1971   * <i> AddOrRemoveCurrent </i> method if a local context is opened.
1972
1973  
1974 ### How to detect overlapped objects
1975
1976
1977 When objects overlap each other and cause difficulties in selection, 
1978 you can use the mechanism provided with the <i> AIS_InteractiveContext</i> 
1979 to successively highlight all the objects found under the selection. 
1980 This allows you to choose and validate the required object.
1981
1982 ~~~~
1983     If ( myAISContext->HasNextDetected()) {
1984
1985     // if up key is pressed
1986     myAISContext ->HilightNextDetected(myView);
1987
1988     // if down key is pressed
1989     myAISContext ->HilightPreviousDetected(myView);
1990
1991     }
1992 ~~~~
1993
1994
1995
1996 ### Get mouse coordinates in 3D view
1997
1998
1999 To switch from pixel mouse position on the screen to 3D coordinates 
2000 in <i> V3d_View</i>, use <i>V3d_View::Convert</i> method.
2001
2002 ~~~~
2003     Handle(V3d_View) aview
2004     aView->Convert(Xp,Yp,X,Y,Z)
2005 ~~~~
2006
2007 Where <i> Xp</i>, <i> Yp</i> are the mouse coordinates in pixels and X,Y,Z the real coordinates in 3D space.
2008
2009 ### 3D Viewer Objects
2010
2011 The <i> V3d </i>  package contains the set of commands and services of the 3D Viewer. 
2012 It provides a set of high level commands to control views and viewing modes. 
2013 This package is complementary to the <i> Visual3D</i> graphic package.
2014
2015 <i> CSF_WALKTHROUGH</i> variable enables you to manage the perspective of the view 
2016 in the viewer by defining <i> setenv CSF_WALKTHROUGH </i> "Yes".
2017
2018 If you use the syntax <i> unsetenv CSF_WALKTHROUGH </i>, you make sure that the variable 
2019 is deactivated. In this case, the eye is located outside the 3D bounding box of the view. 
2020 This is the default behavior for managing the view perspective.
2021
2022 @section OCCT_TOVW_SECTION_6 Data Exchange
2023
2024 Data Exchange is a key factor in using Open CASCADE Technology (as well as applications based thereon) 
2025 concurrently with other software such as CAD systems. It provides the openness of OCCT in a multi-software environment, 
2026 by allowing it to process external data and providing a good level of integration.
2027
2028 This means obtaining results of good quality, and covering the needs of exchanges 
2029 from OCCT-based applications regardless of external data quality or requirements, 
2030 in particular in respect of allowed data types and arrangements between them, accepted gaps between geometries.
2031
2032 This matter is addressed by Data Exchange Module, which is organized in a modular way.
2033
2034 @image html /technical_overview/images/technical_overview_de.png
2035 @image latex /technical_overview/images/technical_overview_de.png
2036
2037 Data Exchange interfaces in OCCT allow software based on OCCT 
2038 to exchange data with various CAD software, thus ensuring a good level of interoperability.
2039
2040 Data Exchange interfaces function either in accordance with the standards (IGES, STEP), 
2041 which can be used by various software packages for CAD, PDM etc., or as direct connectors to proprietary formats.
2042
2043 ### Standardized Data Exchange
2044
2045
2046 * STEP (AP203 : Mechanical Design, this covers General 3D CAD; AP214: Automotive Design) 
2047 * IGES (up to 5.3) 
2048 * STL 
2049 * VRML
2050
2051 Data Exchange interfaces (STEP, IGES) allow to query and examine a file, 
2052 results of conversion and its validity. They are designed to support extensions (like new standards) in a common modular architecture.
2053
2054 ### Extended data exchange
2055
2056
2057 Extended data exchange (XDE) allows you to extend the scope of exchange by translating
2058  additional data attached to geometric ("BREP") data, thereby improving the interoperability with external software.
2059 Data types such as colors, assembly descriptions and validation properties 
2060 (i.e. center of gravity, etc.) are supported. These data are stored together with shapes in an OCAF (XCAF) document.
2061
2062
2063 ### Proprietary Data Exchange
2064
2065 In addition to standard Data Exchange interfaces, separate components are available 
2066 to provide direct mapping and data adaptation (using Shape Healing) with CAD software supporting the following formats:
2067
2068 * ACIS SAT
2069 * Parasolid X_T
2070 * DXF
2071
2072 These components are based on the same architecture as interfaces with STEP and IGES.
2073
2074 ### Translating a shape to STL Format
2075
2076
2077 OCCT includes a module for translating OCCT shapes to STL (Stereolithography) format. 
2078 STL is a format designed for rapid prototyping. 
2079 It is intended to send geometric data (volumic) to stereolithography machines, 
2080 which can read and interpret such data. These machines can transform a volumic model 
2081 to a physical prototype made of plastic, by using laser to coagulate material, 
2082 which corresponds to the volume, and set free the material around. 
2083 STL defines these surfaces by triangles. 
2084 Thus, no machining is required to switch from a virtual model to a physical one.
2085
2086 Since STL files can only include solids described by their mesh structures, 
2087 OCCT shapes, which are intended to be written, must be solids, 
2088 components of solids or closed shells with a correct orientation.
2089
2090 When translating shapes to STL format, remember that all references 
2091 to shapes mean references to OCCT shapes unless otherwise explicitly defined. 
2092 In addition, sets of faces or unclosed shells may also be translated but visualization in foreign viewers may be incorrect.
2093
2094 ### Translating a shape to VRML Format
2095
2096 The Virtual Reality Modeling Language (VRML) is a language for describing multi-participant interactive simulations, virtual worlds networked via the Internet and hyperlinked with the World Wide Web. VRML is a format designed for animated visualization of solids.
2097 OCCT includes a module for translating OCCT shapes to VRML (Virtual Reality Modeling Language). 
2098 OCCT shapes may be translated in two representations (states): shaded or wireframe. 
2099 Since shaded VRML format files include only solids described by their mesh structures, the OCCT shapes intended to be written must be solids, components of solids or closed shells with a correct orientation.
2100
2101 @subsection OCCT_TOVW_SECTION_6_1 General Definitions
2102
2103 OCCT general definitions for Data Exchange include several enumerations and classes used by IGES and STEP data exchange interfaces.
2104
2105 To define translation parameters and file headers, you can use:
2106
2107   * <i> Interface_InterfaceModel</i>
2108   * <i> Interface_Static</i>
2109
2110 To manage Message display, use class <i> Mesage_Messenger</i>.
2111
2112 To define the type of analysis of the source file, and to ensure the success 
2113 of the loading operation, you use the following enumerations from the <i> IFSelect</i> package:
2114
2115   * <i> PrintCount</i>
2116   * <i> ReturnStatus</i>
2117
2118 To read and write attributes such as names, colors, layers for IGES and STEP 
2119 and validation properties and structure of assemblies for STEP, you can use an XDE document.
2120
2121 It is possible to learn more about XDE documents from <a href="user_guides__xde.html">XDE User's guide</a>.
2122
2123 See also: our web site at <a href="http://www.opencascade.org/support/training/">E-learning and Training</a>.
2124
2125
2126  
2127 @subsection OCCT_TOVW_SECTION_6_2 IGES
2128
2129 The IGES interface reads IGES files and translates them to Open CASCADE Technology models. 
2130 IGES files produced in accordance with IGES standard versions up to and including version 5.3 can be read.
2131 The interface is able to translate one entity, a group of entities or a whole file.
2132 Before beginning a translation, you can set a range of parameters to manage the translation process.
2133 If you like, you can also check file consistency before translation.
2134
2135 The IGES interface also translates OCCT models to IGES files. 
2136 IGES files produced by this component conform to IGES standard version 5.3.
2137
2138 Other kinds of data such as colors and names can be read or written 
2139 with the help of XDE tools <i> IGESCAFControl_Reader</i> and <i> IGESCAFControl_Writer</i>. 
2140
2141 Please, note:
2142
2143   * an IGES model is an IGES file that has been loaded into memory.
2144   * an IGES entity is an entity in the IGES normal sense.
2145   * a root entity is the highest level entity of any given type, e.g. type 144 for surfaces and type 186 for solids. Roots are not referenced by other entities.
2146
2147 It is possible to learn more about the IGES interface from <a href="user_guides__iges.html">IGES User's guide</a>.
2148
2149 See also: our web site at <a href="http://www.opencascade.org/support/training/">E-learning and Training</a>.
2150
2151 @subsection OCCT_TOVW_SECTION_6_3 STEP
2152
2153 The STEP interface reads STEP files produced in accordance with STEP Application Protocol 214 (Conformance Class 2 both CD and DIS versions of schema) and translates them to Open CASCADE Technology models. STEP Application Protocol 203 is also supported.
2154
2155 The STEP interface also translates OCCT models to STEP files. STEP files that are produced by this interface conform to STEP AP 203 or AP 214 (Conformance Class 2, either CD or DIS version of the schema) depending on the user's option.
2156
2157 Basic interface reads and writes geometrical, topological STEP data and assembly structures. 
2158
2159 The interface is able to translate one entity, a group of entities or a whole file.
2160
2161 Other kinds of data such as colors, validation properties, layers, names and the structure of assemblies can be read or written with the help of XDE tools - <i> STEPCAFControl_Reader</i> and <i> STEPCAFControl_Writer</i>. 
2162
2163 To choose a translation mode when exporting to a STEP format, use <i> STEPControl_STEPModelType</i>.
2164
2165 There is a set of parameters that concern the translation and can be set before the beginning of the translation.
2166
2167 Please, note:
2168 * a STEP model is a STEP file that has been loaded into memory;
2169 * all references to shapes indicate OCCT shapes unless otherwise explicitly stated;
2170 * a root entity is the highest level entity of any given type, i.e. an entity that is not referenced by any other one.
2171
2172 It is possible to learn more about the STEP interface from <a href="user_guides__step.html">STEP User's guide</a>.
2173
2174 See also: our web site at <a href="http://www.opencascade.org/support/training/">E-learning and Training</a>.
2175
2176 @subsection OCCT_TOVW_SECTION_6_4 STL
2177
2178 The STL component translates Open CASCADE Technology shapes to STL files. STL (Stereolithography) format is widely used for rapid prototyping.
2179
2180 As STL files can only include solids described by their mesh structure, 
2181 the OCCT shapes to be written must be solids, components of solids or closed shells with a correct orientation.
2182
2183 Note All references to shapes indicate OCCT shapes unless otherwise explicitly stated.
2184
2185 Sets of faces or unclosed shells may also be translated to STL format but visualization with foreign viewers may be incorrect.
2186
2187 @subsection OCCT_TOVW_SECTION_6_5 VRML
2188  
2189 The VRML component translates Open CASCADE Technology shapes to VRML 1.0 files 
2190 (Virtual Reality Modeling Language). OCCT shapes may be translated in two representations: 
2191 shaded or wireframe. A shaded representation present shapes as sets of triangles 
2192 computed by a mesh algorithm while a wireframe representation present shapes as sets of curves.
2193
2194 As shaded VRML format files only include solids described by their mesh structures, 
2195 the OCCT shapes to be written must be solids, components of solids or closed shells with a correct orientation.
2196
2197 Please, note:
2198
2199   * all references to shapes indicate OCCT shapes unless otherwise explicitly stated;
2200   * sets of faces or unclosed shells may also be translated to shaded VRML format but visualization with foreign viewers may be incorrect.
2201
2202 @section OCCT_TOVW_SECTION_7 Application Framework
2203
2204 The Application Framework uses an associativity engine to simplify the development of a CAD application. 
2205 Based on application/document architecture, it does this due to the following features:
2206
2207   * Application data is handled by the mechanism of attributes 
2208   * Attributes may be organized according to your development needs 
2209   * Multiple documents can be managed by an application 
2210   * Ready-to-use modeling data attributes common to CAD/CAM applications 
2211   * Document modification and recomputation
2212   * Data storage services 
2213   * A ready-to-use Undo-Redo and Copy-Paste functions 
2214
2215 Since OCAF handles your application structure, your only major development task is the creation 
2216 of application-specific data and GUIs. It is the organization of application data 
2217 due to which OCAF differs from any other CAD framework. In OCAF, data structures are not shape-driven, 
2218 but reference-key driven. In this respect, attributes such as shape data, color, material, 
2219 are attached to a deeper invariant structure of a model than the shapes themselves. 
2220 Then OCAF organizes and embeds these attributes in a document. 
2221 For example, a geometry becomes the value of the Shape attribute, 
2222 in the same way as a number is the value of the Integer attribute and a string is the value of the Name attribute.
2223
2224 OCAF documents are in their turn managed by an OCAF application.
2225
2226 Please, refer for more details to <a href="user_guides__ocaf.html">OCAF User's guide</a> and the OCAF white papers:
2227 * <a href="ocaf_wp.html">Application Framework</a>  
2228 * <a href="occt_ocaf_tree_wp.html">Distribution of Data through OCAF Tree</a>  
2229 * <a href="occt_ocaf_functionmechanism_wp.html">Application Framework Function Mechanism</a>  
2230
2231 See also: our web site at <a href="http://www.opencascade.org/support/training/">E-learning and Training</a>.
2232
2233 @subsection OCCT_TOVW_SECTION_7_1 How to start working with OCAF
2234
2235 To create a useful OCAF-based application, it is necessary to redefine the following
2236 two deferred methods: <i> Formats</i> and <i> ResourcesName</i>
2237
2238 In the <i> Formats </i> method, it is necessary to add the format 
2239 of the documents to be read by the application and which may have been built in other applications.
2240
2241 For example:
2242
2243 ~~~~
2244     void myApplication::Formats(TColStd_SequenceOfExtendedString& Formats)
2245     {
2246       Formats.Append(TCollection_ExtendedString ("OCAF-myApplication"));
2247     }
2248 ~~~~
2249
2250 In the <i> ResourcesName</i> method, you only define the name of the resource file. This
2251 file contains several definitions for the saving and opening mechanisms associated
2252 with each format and calling of the plug-in file.
2253
2254 ~~~~
2255     Standard_CString myApplication::ResourcesName()
2256     {
2257       return Standard_CString ("Resources");
2258     }
2259 ~~~~
2260
2261 To obtain the saving and opening mechanisms, it is necessary to set two environment
2262 variables: <i> CSF_PluginDefaults</i>, which defines the path of the plug-in file and <i> CSF_ResourcesDefault</i>, which defines the resource file:
2263
2264 ~~~~
2265     SetEnvironmentVariable ( "CSF_ResourcesDefaults",myDirectory);
2266     SetEnvironmentVariable ( "CSF_PluginDefaults",myDirectory);
2267 ~~~~
2268
2269 The plugin and the resource files of the application will be located in <i> myDirector</i>.
2270 The name of the plugin file must be <i>Plugin</i>.
2271
2272 ### Resource File
2273
2274 The resource file describes the documents (type and extension) and 
2275 the type of data that the application can manipulate 
2276 by identifying the storage and retrieval drivers appropriate for this data.
2277
2278 Each driver is unique and identified by a GUID generated, for example, with the <i> uuidgen </i> tool in Windows.
2279
2280 Five drivers are required to use all standard attributes provided within OCAF:
2281
2282   * the schema driver (ad696002-5b34-11d1-b5ba-00a0c9064368)
2283   * the document storage driver (ad696000-5b34-11d1-b5ba-00a0c9064368)
2284   * the document retrieval driver (ad696001-5b34-11d1-b5ba-00a0c9064368)
2285   * the attribute storage driver (47b0b826-d931-11d1-b5da-00a0c9064368)
2286   * the attribute retrieval driver (47b0b827-d931-11d1-b5da-00a0c9064368)
2287
2288 These drivers are provided as plug-ins and are located in the <i> PappStdPlugin</i> library.
2289
2290
2291 For example, this is a resource file, which declares a new model document OCAF-MyApplication:
2292
2293 ~~~~
2294 formatlist:OCAF-MyApplication
2295 OCAF-MyApplication.Description: MyApplication Document Version 1.0
2296 OCAF-MyApplication.FileExtension: sta
2297 OCAF-MyApplication.StoragePlugin: ad696000-5b34-11d1-b5ba-00a0c9064368
2298 OCAF-MyApplication.RetrievalPlugin: ad696001-5b34-11d1-b5ba-00a0c9064368
2299 OCAF-MyApplicationSchema: ad696002-5b34-11d1-b5ba-00a0c9064368
2300 OCAF-MyApplication.AttributeStoragePlugin: 47b0b826-d931-11d1-b5da-00a0c9064368
2301 OCAF-MyApplication.AttributeRetrievalPlugin: 47b0b827-d931-11d1-b5da-00a0c9064368
2302 ~~~~
2303  
2304   
2305 ### Plugin File
2306
2307 The plugin file describes the list of required plug-ins to run the application and the
2308 libraries in which plug-ins are located.
2309
2310 You need at least the <i> FWOSPlugin</i> and the plug-in drivers to run an OCAF application.
2311
2312 The syntax of each item is <i> Identification.Location Library_Name, </i> where:
2313 * Identification is GUID.
2314 * Location defines the location of the Identification (where its definition is found).
2315 * Library_Name is the name (and path to) the library, where the plug-in is located.
2316
2317 For example, this is a Plugin file:
2318
2319 ~~~~
2320 a148e300-5740-11d1-a904-080036aaa103.Location: FWOSPlugin
2321 ! base document drivers plugin
2322 ad696000-5b34-11d1-b5ba-00a0c9064368.Location: PAppStdPlugin
2323 ad696001-5b34-11d1-b5ba-00a0c9064368.Location: PAppStdPlugin
2324 ad696002-5b34-11d1-b5ba-00a0c9064368.Location: PAppStdPlugin
2325 47b0b826-d931-11d1-b5da-00a0c9064368.Location: PAppStdPlugin
2326 47b0b827-d931-11d1-b5da-00a0c9064368.Location: PAppStdPlugin
2327 ~~~~
2328  
2329 @subsection OCCT_TOVW_SECTION_7_2 Data Attributes
2330
2331 The following ready-to-use attributes are provided:
2332   * Shape attributes, which contain shapes and their evolution 
2333   * Standard attributes, a collection of common CAD/CAM attributes including: 
2334     * Real 
2335     * Integer 
2336     * Name 
2337     * Constrain 
2338   * Visualization attributes implement the Application Interactive Services in the context of Open CASCADE Application Framework.
2339   * Function attributes which regenerate any data affected by modifications made in a
2340 document 
2341
2342 ### Shape Attributes
2343
2344 A topological attribute can be seen as a hook into the topological structure. To
2345 this hook, data can be attached and references defined.
2346
2347
2348 It is used for keeping and access to topological objects and their evolution. All
2349 topological objects are stored in the one user-protected <i> TNaming_UsedShapes attribute</i>
2350 at the root label of the data framework. This attribute contains map with all topological
2351 shapes, used in this document.
2352
2353 TNaming_NamedShape attribute can be added to any other attribute. This attribute contains
2354 references (hooks) to shapes from the <i> TNaming_UsedShapes</i> attribute and evolution
2355 of these shapes. <i> TNaming_NamedShape </i> attribute contains a set of pairs of hooks: old
2356 shape and new shape (see the figure below). It allows not only get the topological
2357 shapes by the labels, but also trace evolution of the shapes and correctly resolve
2358 dependent shapes by the changed one. 
2359
2360 If a shape is newly created, the old shape for the corresponding named shape is an empty
2361 shape. If a shape is deleted, then the new shape in this named shape is empty.
2362
2363 @image html /technical_overview/images/technical_overview_shapeattrib.png
2364 @image latex /technical_overview/images/technical_overview_shapeattrib.png
2365
2366
2367 ### Shape attributes in data framework. 
2368
2369 Algorithms can dispose sub-shapes of the result shape at the individual
2370 label depending on necessity: 
2371
2372   * If a sub-shape must have some extra attributes (material of each face or color of each edge). In this case a specific sub-shape is placed to the separate label (usually, sub-label of the result shape label) with all attributes of this sub-shape. 
2373   * If topological naming is needed, a necessary and sufficient (for selected sub-shapes identification) set of sub-shapes is placed to the child labels of the result shape label. As usual, as far as basic solids and closed shells are concerned, all faces of the shape are disposed. Edges and vertices sub-shapes can be identified as intersection of contiguous faces. Modified/generated shapes may be placed to one named shape and identified as this named shape and source named shape that also can be identified with used algorithms. 
2374
2375 <i> TNaming_NamedShape </i> may contain a few pairs of hooks with the same evolution. In this
2376 case topology shape, which belongs to the named shape, is a compound of new shapes.
2377
2378 The data model contains both the topology and the hooks, and functions handle both topological entities and hooks. Consider the case of a box function, which creates a solid with six faces and six hooks. Each hook is attached to a face. If you want, you can also have this function create hooks for edges and vertices as well as for faces. 
2379
2380 Not all functions can define explicit hooks for all topological entities they create, but all topological entities can be turned into hooks when necessary. This is where topological naming is necessary. 
2381
2382 Consider the following example. A box defines six hooks for the six faces, but a protrusion created on a face of the box can only define two hooks, one for the top face, and one for all the lateral faces. As the basic wire defining the protrusion may change in the future the protrusion function cannot designate the lateral faces without ambiguity, their number may change. Figure 6 illustrates this example, faces F1 to F6 of the box each have a hook. Faces F7 to F10, the lateral faces of the protrusion, share a single hook, and face F11, the top face, has one hook.
2383
2384 @image html /technical_overview/images/technical_overview_occ_0068.png
2385 @image latex /technical_overview/images/technical_overview_occ_0068.png
2386
2387 This structure raises two problems: 
2388
2389   * the value of the face F6 attribute-hook has changed; 
2390   * no data can be attached to F7. 
2391
2392 When a hook designates multiple faces like F7-F10 (or the hook on F6 if F6 was split)
2393 it is impossible to attach data to an individual face like F7. 
2394
2395 In fact, the protrusion has a trimmed face F6. As a result, the value of this face
2396 has changed and the current value of the hook attached to it needs to be found. Note
2397 that this face could have been split in two faces (for example if the function had
2398 been a slot) and both new faces would have been attached to the same hook.
2399
2400
2401 ### Standard Attributes
2402
2403
2404 Standard attributes are already existing ready-to-use attributes, which allow you
2405 to create and modify labels and attributes for many basic data types.
2406
2407 To find an attribute attached to a specific label, you use the GUID of the type of
2408 attribute you are looking for. For this, find this information using the method 
2409 <i> GetID</i> and the method <i> Find</i> for the label as follows:
2410
2411 ~~~~
2412     Standard_GUID anID = MyAttributeClass::GetID();
2413     Standard_Boolean HasAttribute = aLabel.Find(anID,anAttribute);
2414 ~~~~
2415
2416
2417 ### Function Attributes
2418
2419
2420 A model consists of data and algorithms manipulating with data. OCAF attributes store data. A Function attribute stores data corresponding to a Function (see the white paper <a href="occt_ocaf_functionmechanism_wp.html"> Application Framework Function Mechanism </a>). This mechanism manipulates with algorithms computing the model in the optimal way following the modifications. 
2421
2422
2423 @subsection OCCT_TOVW_SECTION_7_3 Persistent Data Storage
2424
2425 There are three schemas of persistence, which you can use to store and retrieve OCAF data (documents):
2426
2427   * <i> Standard</i> persistence schema, compatible with previous OCAF applications
2428   * <i> XmlOcaf</i> persistence, allowing the storage of all OCAF data in XML form
2429   * <i> BinOcaf</i> persistence, allowing the storage of all OCAF data in binary format form
2430
2431
2432 All schemes are independent of each other, but they guarantee that the standard OCAF
2433 attributes stored and retrieved by one schema will be storable and retrievable by
2434 the other. Therefore in any OCAF application you can use any persistence schema or
2435 even all three of them. The choice is made by the Format string of stored OCAF documents
2436 or automatically by the file header data -  * on retrieval.
2437
2438 Persistent data storage in OCAF using the <i> Standard</i> package is presented in: 
2439
2440   * Basic Data Storage 
2441   * Persistent Collections 
2442
2443 Persistent storage of shapes is presented in the following chapters:
2444
2445   * Persistent Geometry 
2446   * Persistent Topology 
2447
2448 Finally, information about opening and saving persistent data is presented in Standard
2449 Documents. 
2450
2451
2452 @subsubsection OCCT_TOVW_SECTION_7_3_1 Basic Data Storage
2453
2454 Normally, all data structures provided by Open CASCADE Technology are run-time structures,
2455 in other words, transient data. As transient data, they exist only while an application
2456 is running and are not stored permanently. However, the Data Storage module provides
2457 resources, which enable an application to store data on disk as persistent data.
2458
2459 Data storage services also provide libraries of persistent classes and translation
2460 functions needed to translate data from transient to persistent state and vice-versa.
2461
2462 #### Libraries of persistent classes
2463
2464 Libraries of persistent classes are extensible libraries of elementary classes you
2465 use to define the database schema of your application. They include:
2466 * Unicode (8-bit or 16-bit character type) strings 
2467 * Collections of any kind of persistent data such as arrays, stacks, queues, and graphs.
2468
2469 All persistent classes are derived from the \b Persistent base class, which defines
2470 a unique way of creating and handling persistent objects. You create new persistent
2471 classes by inheriting from this base class.
2472
2473 #### Translation Functions
2474
2475 Translation functions allow you to convert persistent objects to transient ones and
2476 vice-versa. These translation functions are used to build Storage and Retrieval drivers
2477 of an application.
2478
2479 For each class of 2D and 3D geometric types, and for the general shape class in the
2480 topological data structure library, there are corresponding persistent class libraries,
2481 which allow you to translate your data with ease.
2482
2483 #### Creation of Persistent Classes
2484
2485 If you are using Unix platforms as well as WOK and CDL, you can create your own persistent
2486 classes. In this case, data storage is achieved by implementing Storage and Retrieval
2487 drivers.
2488
2489 The <i> Storage </i> package is used to write and read persistent objects. 
2490 These objects are read and written by a retrieval or storage algorithm 
2491 (<i> Storage_Schema </i>object) in a container (disk, memory, network ...). 
2492 Drivers (<i> FSD_File</i> objects) assign a physical container for data to be stored or retrieved.
2493
2494 The standard procedure for an application in reading a container is as follows:
2495
2496   *open the driver in reading mode,
2497   *call the Read function from the schema, setting the driver as a parameter. This function returns an instance of the <i> Storage_Data </i> class which contains the data being read,
2498   *close the driver.
2499
2500 The standard procedure for an application in writing a container is as follows:
2501
2502   *open the driver in writing mode,
2503   *create an instance of the <i> Storage_Data </i> class, then add the persistent data to write with the function <i> AddRoot</i> ,
2504   *call the function <i> Write </i> from the schema, setting the driver and the <i> Storage_Data </i> instance as parameters,
2505   *close the driver.
2506
2507 @subsubsection OCCT_TOVW_SECTION_7_3_2 Persistent Collections
2508
2509 Persistent collections are classes which handle dynamically sized collections of data that can be stored in the database. These collections provide three categories of service:
2510
2511   * persistent strings,
2512   * generic arrays of data, 
2513   * commonly used instantiations of arrays.
2514
2515 Persistent strings are concrete classes that handle sequences of characters based
2516 on both ASCII (normal 8-bit) and Unicode (16-bit) character sets.
2517
2518 Arrays are generic classes, that is, they can hold a variety of objects not necessarily inheriting from a unique root class. These arrays can be instantiated with any kind of storable or persistent object, and then inserted into the persistent data model of a user application.
2519
2520 The purpose of these data collections is simply to convert transient data into its persistent equivalent so that it can be stored in the database. To this end, the collections are used to create the persistent data model and assure the link with the database. They do not provide editing or query capabilities because it is more efficient, within the operative data model of the application, to work with transient data structures (from the <i> TCollection</i> package).
2521
2522 For this reason:
2523
2524   * the persistent strings only provide constructors and functions to convert between transient and persistent strings, and
2525   * the persistent data collections are limited to arrays. In other words, <i> PCollection</i> does not include sequences, lists, queues, sets, stacks and so on (unlike <i> TCollection</i>).
2526
2527 Persistent string and array classes are found in the <i> PCollection</i> package. In addition, <i> PColStd</i> package provides standard, and frequently used, instantiations of persistent arrays, for very simple objects.
2528
2529 @subsubsection OCCT_TOVW_SECTION_7_3_3 Persistent Geometry
2530
2531 The Persistent Geometry component describes geometric data structures which can be stored in the database. These packages provide a way to convert data from the transient "world" to the persistent "world".
2532
2533 Persistent Geometry consists of a set of atomic data models parallel to the geometric data structures described in the geometry packages. Geometric data models, independent of each other, can appear within the data model of any application. The system provides the means to convert each atomic transient data model into a persistent one, but it does not provide a way for these data models to share data.
2534
2535 Consequently, you can create a data model using these components, store data in, and retrieve it from a file or a database, using the geometric components provided in the transient and persistent "worlds". In other words, you customize the system by declaring your own objects, and the conversion of the geometric components from persistent to transient and vice versa is automatically managed for you by the system.
2536
2537 However, these simple objects cannot be shared within a more complex data model. To allow data to be shared, you must provide additional tools.
2538
2539 Persistent Geometry is provided by several packages.
2540
2541 The <i> PGeom</i> package describes geometric persistent objects in 3D space, such as points,
2542 vectors, positioning systems, curves and surfaces.
2543
2544 These objects are persistent versions of those provided by the <i> Geom</i> package: for
2545 each type of transient object provided by Geom there is a corresponding type of persistent
2546 object in the <i>PGeom</i> package. In particular the inheritance structure is parallel.
2547
2548 However the <i> PGeom </i>package does not provide any functions to construct, edit or access
2549 the persistent objects. Instead the objects are manipulated as follows:
2550
2551   * Persistent objects are constructed by converting the equivalent transient <i> Geom </i> objects. To do this you use the <i>MgtGeom::Translate</i> function.
2552   * Persistent objects created in this way are used to build persistent data structures that are then stored in a file or database.
2553   * When these objects are retrieved from the file or database, they are converted back into the corresponding transient objects from the Geom package. To do this, you use <i>MgtGeom::Translate</i> function.
2554
2555 In other words, you always edit or query transient data structures within the transient
2556 data model supplied by the session.
2557 Consequently, the documentation for the <i> PGeom </i> package consists simply of a list of available objects.
2558
2559 The <i> PGeom2d </i> package describes persistent geometric objects in 2D space, such as points,
2560 vectors, positioning systems and curves. This package provides the same type of services
2561 as the <i> PGeom</i> package, but for the 2D geometric objects provided by the <i> Geom2d</i> package.
2562 Conversions are provided by the <i>MgtGeom::Translate</i> function.
2563
2564 ~~~~
2565 //Create a coordinate system
2566 Handle(Geom_Axis2Placement) aSys;
2567
2568
2569 //Create a persistent coordinate PTopoDS_HShape.cdlsystem
2570 Handle(PGeom_Axis2placement)
2571         aPSys = MgtGeom::Translate(aSys);
2572
2573 //Restore a transient coordinate system
2574 Handle(PGeom_Axis2Placement) aPSys;
2575
2576 Handle(Geom_Axis2Placement)
2577         aSys = MgtGeom::Translate(aPSys);
2578 ~~~~
2579
2580
2581 @subsubsection OCCT_TOVW_SECTION_7_3_4 Persistent Topology
2582
2583 The Persistent Topology component describes topological data structures which can be stored in the database. These packages provide a way to convert data from the transient "world" to the persistent "world".
2584
2585 Persistent Topology is based on the BRep concrete data model provided by the topology packages. Unlike the components of the Persistent Geometry package, topological components can be fully shared within a single model, as well as between several models.
2586
2587 Each topological component is considered to be a shape: a <i> TopoDS_Shape</i> object. The system's capacity to convert a transient shape into a persistent shape and vice-versa applies to all objects, irrespective of their complexity: vertex, edge, wire, face, shell, solid, and so on.
2588
2589 When a user creates a data model using BRep shapes, he uses the conversion functions that the system provides to store the data in, and retrieve it from the database. The data can also be shared.
2590
2591 Persistent Topology is provided by several packages.
2592
2593 The <i> PTopoDS</i> package describes the persistent data model associated with any BRep shape; it is the persistent version of any shape of type <i> TopoDS_Shape</i>. As is the case for persistent geometric models, this data structure is never edited or queried, it is simply stored in or retrieved from the database. It is created or converted by the <i>MgtBRep::Translate</i> function.
2594
2595 The <i> MgtBRepAbs</i> and <i> PTColStd </i> packages provide tools used by the conversion functions of topological objects.
2596
2597 ~~~~
2598 //Create a shape
2599 TopoDS_Shape aShape;
2600
2601 //Create a persistent shape
2602 PtColStd_DoubleTransientPersistentMap aMap;
2603
2604 Handle(PTopoDS_HShape) aPShape =
2605         aMap.Bind2(MgtBRep::Translate
2606                 aShape,aMap,MgtBRepAbs_WithTriangle));
2607
2608 aPShape.Nullify();
2609
2610 //Restore a transient shape
2611 Handle(PTopoDS_HShape) aPShape;
2612
2613 Handle(TopoDS_HShape) aShape =
2614         aMap.Bind1(MgtBRep::Translate
2615                 (aPShape,aMap,MgtBRepAbs_WithTriangle));
2616
2617 aShape.Nullify();
2618 ~~~~
2619
2620 @subsubsection OCCT_TOVW_SECTION_7_3_5 Standard Documents
2621
2622 Standard documents offer you a ready-to-use document containing a TDF-based data
2623 structure. The documents themselves are contained in a class inheriting from <i> TDocStd_Application</i>
2624 which manages creation, storage and retrieval of documents.
2625
2626 You can implement undo and redo in your document, and refer from the data framework
2627 of one document to that of another one. This is done by means of external link attributes,
2628 which store the path and the entry of external links. To sum up, standard documents
2629 alone provide access to the data framework. They also allow you to:
2630 *Update external links;
2631 *Manage the saving and opening of data;
2632 *Manage undo/redo functionality.
2633
2634 @section OCCT_TOVW_SECTION_8 FAQ
2635
2636 @subsection OCCT_TOVW_SECTION_8_1 Memory Management
2637
2638 In a work-session, geometry modeling applications create and delete a certain number
2639 of C++ objects. In this context, memory allocation and de-allocation standard functions
2640 are not suited to the system's requirements and for this reason a specialized Memory
2641 Manager is implemented into Open CASCADE Technology. The Memory Manager is based
2642 on the following principles:
2643
2644   * small memory arrays are grouped into clusters and then recycled (clusters are never released to the system),
2645   * large arrays are allocated and de-allocated through the standard functions of the system (the arrays are released to system when they are no longer used).
2646
2647 ### The Reference Counter
2648
2649 To lighten usual programming difficulties linked to the management of object life duration, before deleting an object, the user must ensure the object is no longer referenced and the delete function is secured by a reference counter. 
2650 A smart-pointer called *Handle* automates reference counter management and automatically deletes an object when it is no longer referenced. The application never calls the delete operator explicitly. To benefit from the memory manager in OCCT, transient classes must inherit from <i>TShared</i>. The principle of allocation is as follows:
2651
2652 ~~~~
2653     Handle (TColStd_HSequenceOfInteger) H1 = new TColStd_HSequenceOfInteger;
2654     // H1 has one reference and corresponds to 48 bytes of memory
2655     {
2656       Handle (TColStd_HSequenceOfInteger) H2;
2657       H2 = H1; // H1 has two references
2658       if (argc == 3) 
2659       {
2660         Handle (TColStd_HSequenceOfInteger) H3;
2661         H3 = H1;
2662         // Here, H1 has three references
2663       }
2664          // Here, H1 has two references
2665       }
2666       // Here, H1 has 1 reference
2667     }
2668     // Here, H1 has no reference but the 48 bytes of memory are kept.
2669     Handle (TColStd_HSequenceOfInteger) H1 = new TColStd_HSequenceOfInteger;
2670     // Here, H1 has one reference and corresponds to the preceding 48 bytes of 
2671     // memory. In this case, there is no allocation of memory.
2672 ~~~~
2673
2674 ### Cycles
2675
2676 As cycles are objects which reference one another, memory management is impossible if the data structure contains any cycles, particularly if there are back references.
2677
2678 For example, objects in a graph include primitives and each one of these primitives has to know the graphic object to which it belongs (i.e. a reference to this graphic object). With normal references, the classical handle is used. With back references, a pointer is used. 
2679
2680 ### Memory Consumption
2681
2682
2683 As a general rule, it is advisable to allocate memory through significant blocks. 
2684 In this way, the user can work with blocks of contiguous data and it facilitates memory page manager processing.
2685
2686 @subsection OCCT_TOVW_SECTION_8_2 How to define a handled object without CDL
2687
2688 You can create a class manipulated by handle even if you do not use CDL (Open CASCADE Definition Language). 
2689 To do that you have to use the <i>Define_Standard_Handle</i> macro which is defined in the include file <i> Standard_DefineHandle.hxx</i>.
2690
2691 Here is an example which shows how to define a class <i> SamplePoint </i> manipulated by handle.
2692
2693 Sample_Point.hxx:
2694 ---------------
2695
2696 ~~~~
2697
2698     #ifndef _Sample_Point_HeaderFile
2699     #define _Sample_Point_HeaderFile
2700     #ifndef _Standard_Macro_HeaderFile
2701     #include <Standard_Macro.hxx>
2702     #endif
2703     #include <MMgt_TShared.hxx>
2704     #include <Standard_DefineHandle.hxx>
2705     // Handle definition
2706     //
2707
2708     DEFINE_STANDARD_HANDLE(Sample_Point,MMgt_TShared)
2709     class Sample_Point: public MMgt_TShared {
2710     public:
2711     Sample_Point();
2712     Sample_Point(const Standard_Real, const
2713     Standard_Real);
2714     void SetX(const Standard_Real x) {
2715     myX = x;
2716     }
2717     void SetY(const Standard_Real y) {
2718     myY = y;
2719     }
2720     Standard_Real X() const {
2721     return myX;
2722     }
2723     Standard_Real Y() const {
2724     return myY;
2725     }
2726     // some methods like DynamicType() or
2727     IsKind()
2728     //
2729     DEFINE_STANDARD_RTTI(Sample_Point)
2730     private:
2731     Standard_Real myX;
2732     Standard_Real myY;
2733     };
2734     #endif
2735
2736 ~~~~
2737
2738 Sample_Point.cxx:
2739 ----------------
2740
2741 ~~~~
2742
2743     #include <Sample_Point.hxx>
2744
2745     // Implementation of Handle and type mgt
2746
2747     IMPLEMENT_STANDARD_HANDLE(Sample_Point,MMgt_TShared)
2748     IMPLEMENT_STANDARD_RTTI(Sample_Point,MMgt_TShared)
2749
2750     // For ancestors, we add a IMPLEMENT_STANDARD_SUPERTYPE and
2751     // a IMPLEMENT_STANDARD_SUPERTYPE_ARRAY_ENTRY  macro.
2752     // We must respect the order: from the direct ancestor class to the base class.
2753
2754     IMPLEMENT_STANDARD_TYPE(Sample_Point)
2755     IMPLEMENT_STANDARD_SUPERTYPE(MMgt_TShared)
2756     IMPLEMENT_STANDARD_SUPERTYPE(Standard_Transient)
2757     IMPLEMENT_STANDARD_SUPERTYPE_ARRAY()
2758     IMPLEMENT_STANDARD_SUPERTYPE_ARRAY_ENTRY(MMgt_TShared)
2759     IMPLEMENT_STANDARD_SUPERTYPE_ARRAY_ENTRY(Standard_Transient)
2760     IMPLEMENT_STANDARD_SUPERTYPE_ARRAY_END()
2761     IMPLEMENT_STANDARD_TYPE_END(Sample_Point)
2762
2763    // Constructors implementation
2764
2765     Sample_Point::Sample_Point(const
2766     Standard_Real x, const Standard_Real y)
2767     {
2768     myX = x;
2769     myY = y;
2770     }
2771     Sample_Point::Sample_Point()
2772     {
2773     myX = 0.0;
2774     myY = 0.0;
2775     }
2776 ~~~~
2777
2778 @subsection OCCT_TOVW_SECTION_8_3 When is it necessary to use a handle?
2779
2780 When designing an object, the user is faced with the choice of manipulating that
2781 object by value, or by handle.
2782
2783   * If your object may have a long lifetime within the application and you want to make multiple references to it, it would be preferable to manipulate this object with a handle. The memory for the object will be allocated on the heap. The handle which points to that memory is a light object which can be rapidly passed in argument. This avoids the penalty of copying a large object. 
2784   * If your object will have a limited lifetime, for example, used within a single algorithm, it would be preferable to manipulate this object by value, non-regarding its size, because this object is allocated on the stack and the allocation and de-allocation of memory is extremely rapid, which avoids the implicit calls to 'new' and 'delete' occasioned by allocation on the heap.
2785   * Finally, if an object will be created only once during, but will exist throughout the lifetime of the application, the best choice may be a class manipulated by handle or a value declared as a global variable. 
2786
2787
2788 @subsection OCCT_TOVW_SECTION_8_4  How to cast shape handle to void
2789
2790 You can easily cast a reference to the handle object to <i> void* </i> by defining the following:
2791
2792 ~~~~
2793     void *pointer;
2794     Handle(Some_class) aHandle;
2795     // Here only a pointer will be copied
2796     Pointer = &aHandle;
2797     // Here the Handle object will be copied
2798     aHandle = * (Handle(Some_Class) *)pointer;
2799 ~~~~
2800
2801 @subsection OCCT_TOVW_SECTION_8_5 How to test correct ending of OCCT algorithms
2802
2803 Generally OCCT algorithms implement <i> IsDone</i> method, which  returns <i> true</i> 
2804 if computation has been performed successfully from beginning to end or <i> false</i> if computation has failed.
2805
2806 When <i> IsDone</i> returns <i> true</i>, the computation is successful regarding
2807 to the input data, but it does not necessary mean that you get a result. For example, if
2808 you perform a cut algorithm between two shapes without any common part, the <i> IsDone</i>
2809 method will return <i> true</i>, but the result will be empty.
2810
2811 So, in some cases, it can be necessary to analyse the structure of a result before
2812 using it again in following computations. These tests are not done systematically
2813 into algorithms to get faster computations. The application performs necessary tests
2814 depending on the context.
2815
2816 @subsection OCCT_TOVW_SECTION_8_6 How to cut, copy and paste inside a document
2817
2818 To cut, copy and paste inside a document, you must use the <i> CopyLabel</i> class from the <i> TDF</i> package.
2819 In fact, you must define a Label which contains the temporary value a cut or 
2820 copy operation (say, in <i> Lab_Clipboard</i>). You must also define two other labels:
2821
2822 * One containing the data (e.g. <i> Lab_source</i>)
2823 * One for the destination of the copy (e.g. <i> Lab_ Target</i> )
2824
2825 ~~~~
2826     Copy = copy (Lab_Source => Lab_Clipboard)
2827     Cut = copy + Lab_Source.ForgetAll() // command clear the contents of LabelSource.
2828     Paste = copy (Lab_Clipboard => Lab_target)
2829 ~~~~
2830
2831 So we need a tool to copy all (or a part) of the content of a label and its sub-label,
2832 to another place defined by a label.
2833
2834 ~~~~
2835     TDF_CopyLabel aCopy;
2836     TDF_IDFilter aFilter (Standard_False);
2837
2838     //Don't copy TDataStd_TreeNode attribute
2839
2840      aFilter.Ignore(TDataStd_TreeNode::GetDefaultTreeID());
2841      aCopy.Load(aSource, aTarget); aCopy.UseFilter(aFilter); aCopy.Perform();
2842
2843     // copy the data structure to clipboard 
2844
2845     return aCopy.IsDone(); }
2846 ~~~~
2847
2848 The filter is used to forbid copying a specified type of attribute. 
2849 You can also have a look at *TDF_Closure**, 
2850 which can be useful to determine the dependencies of the part you want to cut from the document.
2851
2852 @subsection OCCT_TOVW_SECTION_8_7 Platform-related problems 
2853
2854 ### Dynamic library loading 
2855
2856 Open CASCADE Technology uses a dynamic library loading mode. Sometimes, the error message such as the following appears:
2857
2858 ~~~~
2859  "cannot map libname.so .. under any of the filenames .."
2860 ~~~~
2861
2862 When this happens, check your *PATH* under Windows, *LD_LIBRARY_PATH* under UNIX ,
2863 *SHLIB_PATH* under HP-UX or *LIBPATH* under IBM AIX . 
2864 It should contain the path where the required dynamic library is located.
2865
2866 ### Running Draw under Windows
2867
2868
2869 When running <i> DRAWEXE</i> and using axo in the Command window you may see the "Invalid command name "axo" " message :
2870
2871 Make sure that the OCCT directory name does not contain any blank spaces.
2872 It causes some problems when reading the OCCT description TCL Commands files.
2873 If you have set <i> DRAWHOME</i> and <i> DRAWDEFAULT</i>, replace \\ by / in the variable. 
2874
2875 ### Error on application start on Windows
2876
2877 If Windows shows an error message with the text *Application failed to initialize properly* 
2878 upon launching the application, check access rights for all libraries used in the application, in particular, third-party libraries. 
2879
2880 Make sure that you have all rights  necessary to access these libraries. 
2881 It is recommended to use option *Inherit access rights from parent*.
2882
2883 ### Problems with 3D viewer
2884
2885 If the 3D viewer fails to display the scene properly, or works very slowly, or exhibits
2886 another problem, make sure to have the latest version of the graphics card driver
2887 installed. If this is not possible or does not help, try to decrease 
2888 hardware acceleration level (usually found in Troubleshooting section of the graphics card properties).