Third Party Libraries

Overveiew
These are libraries which are not changed in the FreeCAD project. They are basically used unchanged as a dynamic link library (*.so or *.dll). If there is a change necessary or a wrapper class is needed, then the code of the wrapper or the changed library code have to be moved to the FreeCAD base package. The used libraries are:

Consider using LibPack instead downloading and installing all the stuff on your own.

Python
Version: 2.3 or higher

You can use the source or binary from http://www.python.org/ or use alternetivly !ActiveState Python from http://www.activestate.com/ though it is a little bit hard to get the debug libs from !ActiveState.

Description
Python is the primary scripting language and is used in the whole application. For example:


 * Implement test scripts for testing on:
 * memory leaks
 * ensure presents of functionality after changes
 * post build checks
 * test coverage tests
 * Macros and macro recording
 * Implement application logic for standard packages
 * Implementation of whole workbenches
 * Dynamic loading of packages
 * Implementing rules for design (Knowledge engineering)
 * Doing some fancy Internet stuff like work groups and PDM
 * And so on ...

Especially the dynamic package loading of python is used to load at run time additional functionality and workbenches needed for the actual tasks. For a closer look to python see: www.python.org Why Python you may ask. There are some reasons: So far I used different scripting languages in my professional life: Python is more OO then Perl and Tcl, the code is not a mess like in Perl and VB. Java isn?t a script language in the first place and hard (or impossible) to embed. Python is well documented and easy to embed and extend. It is also well tested and has a strong back hold in the open source community.
 * Perl
 * Tcl/Tk
 * VB
 * Java

Credits
goes to Guido van Rossum and a lot of people made Python such a success!

OpenCasCade
Version: 5.2 or higher

OCC is a full featured CAD Kernel. Its originally developed by Matra Datavision in France for the Strim (Styler) and Euclid Quantum applications and later on made Open Source. It's a really huge library and makes a free CAD application possible in the first place, by providing some packages which would be hard or impossible to implement in an Open Source project:
 * A complete STEP compliant geometry kernel
 * A topological data model and all needed functions to work on (cut, fuse, extrude, and so on. . . )
 * Standard Import- / Export processors like STEP, IGES, VRML
 * 3D and 2D Viewer with selection support
 * A Document and Project data structure with support for save and restore, external linking of documents, recalculation of design history (parametric modeling) and a facility to load new data types as a extension package dynamically

To learn more about OpenCasCade take a look at the OpenCasCade page or http://www.opencascade.org.

Qt
Version: 3.2.1 or higher (non commercial edition on M$) 4.x not suported so far

I don't think I need to tell a lot about Qt. It's one of the most often used GUI toolkits in Open Source projects. For me the most important point to use Qt is the Qt Designer and the possibility to load whole dialog boxes as a (XML) resource and incorporate specialized widgets. In a CAX application the user interaction and dialog boxes a by far the biggest part of the code and a good dialog designer is very important to easily extend FreeCAD with new functionality. Further information and a very good on line documentation you'll find on http://www.troll.no.

Coin3D
Version: 2.0 or higer

Coin is a high-level 3D graphics library with a C++ Application Programming Interface. Coin uses scene graph data structures to render real-time graphics suitable for mostly all kinds of scientific and engineering visualization applications.

Coin is portable over a wide range of platforms: any UNIX / Linux / *BSD platform, all Microsoft Windows operating system, and Mac OS X.

Coin is built on the industry-standard OpenGL immediate mode rendering library, and adds abstractions for higher-level primitives, provides 3D interactivity, immensely increases programmer convenience and productivity, and contains many complex optimization features for fast rendering that are transparent for the application programmer.

Coin is based on the SGI Open Inventor API. Open Inventor, for those who are not familiar with it, has long since become the de facto standard graphics library for 3D visualization and visual simulation software in the scientific and engineering community. It has proved it's worth over a period of more than 10 years, it's maturity contributing to it's success as a major building block in thousands of large-scale engineering applications around the world.

We will use OpenInventor as 3D viewer in FreeCAD because the OpenCasCade viewer (AIS and Graphics3D) has serios limitations and performace bottlenecks, especially when it goes in large-scale engineering rendering. Other things like textures or volumetric rendering are not really supported, and so on ....

Since Version 2.0 Coin use a different licence model. Its not longer LGPL. They use GPL for open source and a commercial licence for closed source. That means if you want to sell your work based on FreeCAD (extension modules) you need to purchase a Coin licence!

SoQt
Version: 1.2.0 or higher

SoQt is the Inventor binding to the Qt Gui Toolkit. Unfortunately its not longer LGPL so we have to remove it from the code base of FreeCAD and link it as a library. It has the same licence model like Coin. And you have to compile it with your Version of Qt.

Xerces-C++
Version: 2.3.0 or higher

Xerces-C++ is a validating XML parser written in a portable subset of C++. Xerces-C++ makes it easy to give your application the ability to read and write XML data. A shared library is provided for parsing, generating, manipulating, and validating XML documents.

Xerces-C++ is faithful to the XML 1.0 recommendation and many associated standards (see Features below).

The parser provides high performance, modularity, and scalability. Source code, samples and API documentation are provided with the parser. For portability, care has been taken to make minimal use of templates, no RTTI, and minimal use of #ifdefs.

The parser is used for save and store parameter in FreeCAD.

STLport
Version: 4.5.3

Note: You have to use STLport for Windows OS and Visual Studio 6.0 only. On all other Platforms the compiler STL works fine!

STLport is a multiplatform ANSI C++ Standard Library implementation. It is free, open-source product, featuring the following:
 * Advanced techniques and optimizations for maximum efficiency
 * Exception safety and thread safety
 * Important extensions - hash tables, singly-linked list, rope

With STLport, you rely on uniform solid code base for all compilers used in the project. Started as a one-person effort in 1997, it has now become, with the help of numerous contributors.

GTS
Version: 0.7.x

GTS stands for the GNU Triangulated Surface Library. It is an Open Source Free Software Library intended to provide a set of useful functions to deal with 3D surfaces meshed with interconnected triangles. The source code is available free of charge under the Free Software LGPL license.

This library is used by the Mesh module and will be soon replaced by an other implementation.

Zlib
Version: 1.x.x

zlib is designed to be a free, general-purpose, legally unencumbered -- that is, not covered by any patents -- lossless data-compression library for use on virtually any computer hardware and operating system. The zlib data format is itself portable across platforms. Unlike the LZW compression method used in Unix compress(1) and in the GIF image format, the compression method currently used in zlib essentially never expands the data. (LZW can double or triple the file size in extreme cases.) zlib's memory footprint is also independent of the input data and can be reduced, if necessary, at some cost in compression.

Wild Magic
Version: 3.x

See: http://www.geometrictools.com/ for a description.

LibPack
LibPack is a convinant pack with all the the above libraries packed together. It is currently available for the Windows platform on the Download page!

Jürgen Riegel 2006