https://wiki.freecad.org/api.php?action=feedcontributions&user=Momentumv5&feedformat=atomFreeCAD Documentation - User contributions [en]2024-03-29T07:58:26ZUser contributionsMediaWiki 1.40.1https://wiki.freecad.org/index.php?title=Std_ViewScreenShot&diff=10349Std ViewScreenShot2012-04-17T14:01:13Z<p>Momentumv5: Grammar & spelling</p>
<hr />
<div>{{GuiCommand|Name=Std_ViewScreenShot|MenuLocation=Tools -> Save picture...|Workbenches=All|SeeAlso=...}}<br />
<br />
<br />
==== Synopsis ====<br />
<br />
This command opens a dialog to save the current content of the 3D view to <br />
a file. It can save to various image formats. Additionally, you can change the <br />
aspect ratio and the resolution of the screen shot using the "Options"<br />
button to get access to more parameters. <br />
<br />
This command can also use the image comment field of some image formats, like PNG or JPEG<br />
to save [[MIBA]] information along with the picture.<br />
<br />
<br />
==== Image formats ====<br />
FreeCAD uses the QT built-in image types and some QT plugins in the bin/imageformats directory<br />
to save pictures. So how many and what formats you can choose depends on your platform.<br />
<br />
==== Dialog ====<br />
<br />
[[Image:Save_picture.png|550px]]<br />
<br />
<br />
===== Image Size =====<br />
The image size parameters are set to the screen size of the active 3D view. But you can change it to any value you like. Some OpenGL drivers don't allow renderings greater then 8000 pixels. It depends on your system.<br />
<br />
With the four buttons you can change the aspect to a certain value.<br />
<br />
===== Image background =====<br />
<br />
With this combo box you can choose the background of the picture you make.<br />
* '''Current''' use the current view background (as chosen in the preferences)<br />
* '''White''' creates a plain white background (for e.g. printings)<br />
* '''Black''' plain black background<br />
* '''Transparent''' creates a transparent background on image formats which support transparency<br />
<br />
===== Comment =====<br />
Some image formats can transport a comment along the picture. In case you choose one of this formats you can insert a comment or use the comment field for the [[MIBA]] information.<br />
<br />
==== Scripting ====<br />
<br />
It's also possible to save the screen by python:<br />
<br />
Gui.ActiveDocument.ActiveView.saveImage('C:/temp/test.png',1656,783,'Current')<br />
<br />
This script makes a series of pictures of different sizes and from different<br />
points of view. The type of the camera, i.e. orthographic or perspective can also be changed. <br />
<br />
import Part,PartGui<br />
# loading test part<br />
Part.open("C:/Documents and Settings/jriegel/My Documents/Projects/FreeCAD/data/Blade.stp")<br />
OutDir = 'c:/temp/'<br />
<br />
# creating images with different Views, Cameras and sizes<br />
for p in ["PerspectiveCamera","OrthographicCamera"]:<br />
Gui.SendMsgToActiveView(p)<br />
for f in ["ViewAxo","ViewFront","ViewTop"]:<br />
Gui.SendMsgToActiveView(f)<br />
for x,y in [[500,500],[1000,3000],[3000,1000],[3000,3000],[8000,8000]]:<br />
Gui.ActiveDocument.ActiveView.saveImage(OutDir + "Blade_" + p +"_" + f + "_" + `x` + "_" + `y` + ".jpg",x,y,"White")<br />
Gui.ActiveDocument.ActiveView.saveImage(OutDir + "Blade_" + p +"_" + f + "_" + `x` + "_" + `y` + ".png",x,y,"Transparent")<br />
<br />
# close active document<br />
App.closeDocument(App.ActiveDocument.Name)<br />
<br />
{{languages | {{es|Std_ViewScreenShot/es}} {{it|Std_ViewScreenShot/it}} }}</div>Momentumv5https://wiki.freecad.org/index.php?title=Source_code_management&diff=9146Source code management2011-12-25T00:22:31Z<p>Momentumv5: /* Developing */ include tanderson's tip from the forum</p>
<hr />
<div>In future our main source code management tool will be git. This article explain how to use it and the general rules apply in case of FreeCAD. <br />
<br />
{{VeryImportantMessage|For a while we keep up the SVN repository on sf.net. It is possible to commit changes <br />
in SVN and Git. I will do from time to time a merge from one to the other via a gatekeeper <br />
repository. <br />
<br />
This is only feasible as a transition. '''I strongly recommend the developers to switch to <br />
git, as soon a possible! '''}}<br />
<br />
<br />
== Access ==<br />
<br />
To access a Git repository, configure your Git client as follows :<br />
<br />
git://free-cad.git.sourceforge.net/gitroot/free-cad/free-cad (read-only)<br />
ssh://USERNAME@free-cad.git.sourceforge.net/gitroot/free-cad/free-cad (read/write) <br />
<br />
=== Access rules ===<br />
We will give everyone interested in participating write access to the git repository <br />
as long as you stay away from ''master'' branch (tip).<br />
<br />
=== Authentication ===<br />
<br />
The read-only access does not prompt for a password.<br />
<br />
The read/write access uses your ssh password or ssh key to authorize your access. To perform write operations, your project administrator must have granted you write access to the repository.<br />
Getting Started<br />
<br />
Note: - For all examples below, "USERNAME" represents your SourceForge.net user account.<br />
<br />
<br />
=== How to clone the repository ===<br />
<br />
You can simply clone your remote repository and get working:<br />
<br />
git clone ssh://USERNAME@free-cad.git.sourceforge.net/gitroot/free-cad/free-cad<br />
cd REPONAME<br />
<br />
The first time you try connecting to the free-cad.git.sourceforge.net host, you should see a message similar to the following:<br />
<br />
The authenticity of host 'free-cad.git.sourceforge.net (216.34.181.91)' can't be established.<br />
RSA key fingerprint is 86:7b:1b:12:85:35:8a:b7:98:b6:d2:97:5e:96:58:1d.<br />
Are you sure you want to continue connecting (yes/no)? <br />
<br />
Before typing 'yes' to accept the host fingerprint, ensure the fingerprint is correct for the host. You can find a listing of SSH host keys in the SSH Host Key Fingerprints list. If you receive a host key warning, please contact the SourceForge.net team.<br />
<br />
=== Setting your git username ===<br />
<br />
Users should commit to their project repository using their SourceForge.net username. If that is not already set globally, you can set it locally for the current Git repository like this:<br />
<br />
git config user.name "YOUR NAME"<br />
git config user.email "USERNAME@users.sourceforge.net"<br />
<br />
You can now use some combination of "git add" and "git commit" commands to create one or more commits in your local repository.<br />
<br />
<br />
== Developing == <br />
First of all '''never develop on the ''master'' branch!''' Create a local branch for development. <br />
You can learn how to do this [http://book.git-scm.com/3_basic_branching_and_merging.html here].<br />
<br />
=== Publishing your work ===<br />
<br />
After done some changes on your local branch and commit it (this means commit ''locally'') you can <br />
push your repository to the server. This opens your branch to the public and allows the <br />
main developers to review and integrate your branch into ''master''. <br />
<br />
git push my-branch<br />
<br />
=== Guidelines for publishing your work ===<br />
<br />
You should try to work in small chunks. If you cannot summarize your changes in one sentence, then it has probably been too long since you have made a commit. It is also important that you have helpful and useful descriptions of your work. For commit messages, FreeCAD has adopted a format mentioned in book Pro Git (see [[#Further Reading]]).<br />
<br />
Short (50 chars or less) summary of changes<br />
<br />
More detailed explanatory text, if necessary. Wrap it to about 72<br />
characters or so. In some contexts, the first line is treated as the<br />
subject of an email and the rest of the text as the body. The blank<br />
line separating the summary from the body is critical (unless you omit<br />
the body entirely); tools like rebase can get confused if you run the<br />
two together.<br />
<br />
Further paragraphs come after blank lines. <br />
<br />
- Bullet points are okay, too<br />
<br />
- Typically a hyphen or asterisk is used for the bullet, preceded by a<br />
single space, with blank lines in between, but conventions vary here<br />
<br />
If you are doing a lot of related work, it has been suggested [https://sourceforge.net/apps/phpbb/free-cad/viewtopic.php?f=10&t=2062&p=14887#p14886 here] that one should make as many commits large or small as makes sense for what you are working on using the short one sentence commit messages. When you want to merge, do a git log master..BRANCH and use the output as a basis for your quality commit message. Then when you merge to master use the --squash option and commit with your quality commit message. This will allow you to be very liberal with your commits and help to provide a good level of detail in commit messages without so many distinct descriptions.<br />
<br />
== Further Reading ==<br />
<br />
* [http://spheredev.org/wiki/Git_for_the_lazy Git for the lazy]<br />
* [http://progit.org/book/ Git pro on-line book]<br />
<br />
{{languages | {{es|Source_code_management/es}} }}</div>Momentumv5https://wiki.freecad.org/index.php?title=Source_code_management&diff=9145Source code management2011-12-25T00:15:21Z<p>Momentumv5: added commit message format, some typos</p>
<hr />
<div>In future our main source code management tool will be git. This article explain how to use it and the general rules apply in case of FreeCAD. <br />
<br />
{{VeryImportantMessage|For a while we keep up the SVN repository on sf.net. It is possible to commit changes <br />
in SVN and Git. I will do from time to time a merge from one to the other via a gatekeeper <br />
repository. <br />
<br />
This is only feasible as a transition. '''I strongly recommend the developers to switch to <br />
git, as soon a possible! '''}}<br />
<br />
<br />
== Access ==<br />
<br />
To access a Git repository, configure your Git client as follows :<br />
<br />
git://free-cad.git.sourceforge.net/gitroot/free-cad/free-cad (read-only)<br />
ssh://USERNAME@free-cad.git.sourceforge.net/gitroot/free-cad/free-cad (read/write) <br />
<br />
=== Access rules ===<br />
We will give everyone interested in participating write access to the git repository <br />
as long as you stay away from ''master'' branch (tip).<br />
<br />
=== Authentication ===<br />
<br />
The read-only access does not prompt for a password.<br />
<br />
The read/write access uses your ssh password or ssh key to authorize your access. To perform write operations, your project administrator must have granted you write access to the repository.<br />
Getting Started<br />
<br />
Note: - For all examples below, "USERNAME" represents your SourceForge.net user account.<br />
<br />
<br />
=== How to clone the repository ===<br />
<br />
You can simply clone your remote repository and get working:<br />
<br />
git clone ssh://USERNAME@free-cad.git.sourceforge.net/gitroot/free-cad/free-cad<br />
cd REPONAME<br />
<br />
The first time you try connecting to the free-cad.git.sourceforge.net host, you should see a message similar to the following:<br />
<br />
The authenticity of host 'free-cad.git.sourceforge.net (216.34.181.91)' can't be established.<br />
RSA key fingerprint is 86:7b:1b:12:85:35:8a:b7:98:b6:d2:97:5e:96:58:1d.<br />
Are you sure you want to continue connecting (yes/no)? <br />
<br />
Before typing 'yes' to accept the host fingerprint, ensure the fingerprint is correct for the host. You can find a listing of SSH host keys in the SSH Host Key Fingerprints list. If you receive a host key warning, please contact the SourceForge.net team.<br />
<br />
=== Setting your git username ===<br />
<br />
Users should commit to their project repository using their SourceForge.net username. If that is not already set globally, you can set it locally for the current Git repository like this:<br />
<br />
git config user.name "YOUR NAME"<br />
git config user.email "USERNAME@users.sourceforge.net"<br />
<br />
You can now use some combination of "git add" and "git commit" commands to create one or more commits in your local repository.<br />
<br />
<br />
== Developing == <br />
First of all '''never develop on the ''master'' branch!''' Create a local branch for development. <br />
You can learn how to do this [http://book.git-scm.com/3_basic_branching_and_merging.html here].<br />
<br />
=== Publishing your work ===<br />
<br />
After done some changes on your local branch and commit it (this means commit ''locally'') you can <br />
push your repository to the server. This opens your branch to the public and allows the <br />
main developers to review and integrate your branch into ''master''. <br />
<br />
git push my-branch<br />
<br />
=== Guidelines for publishing your work ===<br />
<br />
You should try to work in small chunks. If you cannot summarize your changes in one sentence, then it has probably been too long since you have made a commit. It is also important that you have helpful and useful descriptions of your work. For commit messages, FreeCAD has adopted a format mentioned in book Pro Git (see [[#Further Reading]]).<br />
<br />
Short (50 chars or less) summary of changes<br />
<br />
More detailed explanatory text, if necessary. Wrap it to about 72<br />
characters or so. In some contexts, the first line is treated as the<br />
subject of an email and the rest of the text as the body. The blank<br />
line separating the summary from the body is critical (unless you omit<br />
the body entirely); tools like rebase can get confused if you run the<br />
two together.<br />
<br />
Further paragraphs come after blank lines. <br />
<br />
- Bullet points are okay, too<br />
<br />
- Typically a hyphen or asterisk is used for the bullet, preceded by a<br />
single space, with blank lines in between, but conventions vary here<br />
<br />
== Further Reading ==<br />
<br />
* [http://spheredev.org/wiki/Git_for_the_lazy Git for the lazy]<br />
* [http://progit.org/book/ Git pro on-line book]<br />
<br />
{{languages | {{es|Source_code_management/es}} }}</div>Momentumv5https://wiki.freecad.org/index.php?title=Getting_started&diff=8821Getting started2011-12-08T04:14:32Z<p>Momentumv5: /* Navigating in the 3D space */</p>
<hr />
<div>==What's new==<br />
<br />
* [[Release notes 012|Version 0.12 Release notes]] : Check what's new in the 0.12 release of FreeCAD<br />
<br />
==Foreword==<br />
<br />
FreeCAD is a CAD/CAE parametric modeling application. It is still in early stage of development, so don't expect to be able to use it to produce work already. But, if you are curious about what FreeCAD looks like and what features are being developed, you are welcome to download it and give it a try. At the moment, much functionality is already present, but not much user interface has been created for it. This means that if you know a bit of python, you will already be able to produce and modify complex geometry relatively easily. If not, you will probably find that FreeCAD still has little to offer to you. But, be patient, this is expected to change soon.<br />
<br />
And if after testing you have feedback, ideas or opinions, please share it with us on the [http://apps.sourceforge.net/phpbb/free-cad/index.php FreeCAD discussion forum]!<br />
<br />
==Installing== <br />
<br />
First of all (if not done already) download and install FreeCAD. See the [[Download]] page for information about current versions and updates. There are install packages ready for Windows (.msi), Ubuntu & Debian (.deb) openSUSE (.rpm) and Mac OSX.<br />
<br />
==Exploring FreeCAD==<br />
<br />
[[Image:Freecad09-empty.jpg|frame|none|The FreeCAD interface when you start it for the first time. See more [[screenshots]] here.]]<br />
<br />
FreeCAD is a general all-purpose 3D modeling application, focused on mechanical engineering and related areas, such as other engineering specialties or architecture. It is conceived as a platform for developing any kind of 3D application, but also for doing very specific tasks. For that purpose, its interface is divided into a serie of [[Workbenches]]. Workbenches allow to change the interface contents to display all and only the tools necessary for a specific task, or group of tasks.<br />
<br />
The FreeCAD interface can therefore be described as a very simple container, with a menu bar, a 3D view area, and a couple of side panels for displaying the scene contents or object properties. All the contents of these panels can be changes depending on the workbench.<br />
<br />
When you start FreeCAD for the first time, you will be presented a "general" workbench, that we call "complete workbench". This workbench simply gathers the most mature tools from other workbenches. Since FreeCAD is pretty young and not yet used for very specialized work, this workbench is very handy for discovering FreeCAD more easily. Basically, all the tools that are good enough for producing geometry are here.<br />
<br />
=== Navigating in the 3D space ===<br />
<br />
FreeCAD has three different [[Mouse Model|navigation modes]] available, that can be set in the preferences settings dialog or changed by right-clicking in the 3D view. For full details about the modes, see the [[Mouse Model]] page. For the default mode ("CAD Navigation"), the commands are as follows, {{CAD Navigation}}<br />
<br />
You also have several view presets (top view, front view, etc) available in the View menu and on the View toolbar, and by numeric shortcuts ({{KEY|1}}, {{KEY|2}}, etc...)<br />
<br />
==[[Image:Workbench_Draft.png]] [[Draft Module|2D Drafting]]==<br />
<br />
{{Draft Tools}}<br />
<br />
<br />
==[[Image:Workbench_Part.png]] [[Part Module|Creating 3D Parts]]==<br />
<br />
{{Part Tools}}<br />
<br />
<br />
==[[Drawing Module|Exporting to 2D Drawings]]==<br />
<br />
{{Drawing Tools}}<br />
<br />
<br />
==[[Raytracing Module|Exporting to external renderers]]==<br />
<br />
{{Raytracing Tools}}<br />
<br />
<br />
==[[Scripting]]==<br />
<br />
And finally, one of the most powerful features of FreeCAD is the [[scripting]] environment. From the integrated python console (or from any other external python script), you can gain access to almost any part of FreeCAD, create or modify geometry, modify the representation of those objects in the 3D scene or access and modify the FreeCAD interface. Python scripting can also be used in [[macros]], which provide an easy method to create custom commands.<br />
<br />
<br />
{{docnav|Install on Mac|Mouse Model}}<br />
<br />
{{languages | {{cn|Getting started/cn}} {{de|Getting started/de}} {{es|Getting started/es}} {{fr|Getting started/fr}} {{it|Getting started/it}} {{jp|Getting started/jp}} {{pl|Getting started/pl}} {{ru|Getting started/ru}} {{se|Getting started/se}} }}<br />
<br />
[[Category:User Documentation]]</div>Momentumv5https://wiki.freecad.org/index.php?title=Template:CAD_Navigation&diff=8787Template:CAD Navigation2011-12-07T00:19:20Z<p>Momentumv5: </p>
<hr />
<div>{|border=1<br />
!align=center width="25%"|Select<br />
!align=center width="25%"|Pan<br />
!align=center width="25%"|Zoom<br />
!align=center width="25%"|Rotate View<br />
|- align=center<br />
|[[Image:Hand_cursor.png]]<br />
|[[Image:Pan_cursor.png]]<br />
|[[Image:Zoom_cursor.png]]<br />
|[[Image:Rotate_cursor.png]]<br />
|- align=center<br />
|[[Image:Select-mouse.svg|Alt=Mouse with left button clicked | to Select ]]<br />
|[[Image:Pan-mouse.svg |Alt=Mouse with middle button (scroll wheel) clicked | to Pan]]<br />
|[[Image:Zoom-mouse.svg |Alt=Mouse with scroll wheel rolling up or down | to Zoom in or out]]<br />
|[[Image:Rotate-mouse.svg|Alt=Mouse with middle button (scroll wheel) clicked first and held, and the left button clicked second. | to Rotate view]]<br />
|- valign=top<br />
|Press the left mouse button over an object you want to select. Holding down ctrl allows the selection of multiple objects.<br />
|Click the middle mouse button and move the object around to pan<br />
|Use the mouse wheel to zoom in and out.<br />
|Click first with the middle mouse button, hold it and the click the left mouse button on any visible part of an object and drag it in the desired direction. This works like spinning a ball that rotates around its center. If you release the buttons before you stop your motion, the object continues [[spinning]], if this is enabled. A double click with the middle mouse button on any part of an object sets the new center of rotation and zooms in on this point.<br />
|}</div>Momentumv5https://wiki.freecad.org/index.php?title=Template:Blender_Navigation&diff=8786Template:Blender Navigation2011-12-07T00:17:40Z<p>Momentumv5: Add screen cursors</p>
<hr />
<div>{|border=1<br />
!align=center width="25%"|Select<br />
!align=center width="25%"|Pan<br />
!align=center width="25%"|Zoom<br />
!align=center width="25%"|Rotate View<br />
|- align=center<br />
|[[Image:Hand_cursor.png]]<br />
|[[Image:Pan_cursor.png]]<br />
|[[Image:Zoom_cursor.png]]<br />
|[[Image:Rotate_cursor.png]]<br />
|- align= center<br />
|[[Image:Select-mouse.svg|Alt=Mouse with left button clicked | to Select ]]<br />
|{{KEY|shift}}+[[Image:Pan-mouse.svg |Alt=Mouse with middle button (scroll wheel) clicked | to Pan]]<br />
|[[Image:Zoom-mouse.svg |Alt=Mouse with scroll wheel rolling up or down | to Zoom in or out]]<br />
|[[Image:Pan-mouse.svg|Alt=Mouse with middle button (scroll wheel) clicked | to Rotate ]]<br />
|-valign=top<br />
|Press the left mouse button over an object you want to select.<br />
|Hold shift and click the middle mouse button and move the object around.<br />
|Use the mouse wheel to zoom in and out.<br />
|Click and drag with the middle mouse button.<br />
|}</div>Momentumv5https://wiki.freecad.org/index.php?title=File:Hand_cursor.png&diff=8785File:Hand cursor.png2011-12-07T00:13:59Z<p>Momentumv5: FreeCAD select hand cursor</p>
<hr />
<div>FreeCAD select hand cursor</div>Momentumv5https://wiki.freecad.org/index.php?title=File:Rotate_cursor.png&diff=8784File:Rotate cursor.png2011-12-07T00:13:19Z<p>Momentumv5: SoQt Rotate cursor</p>
<hr />
<div>SoQt Rotate cursor</div>Momentumv5https://wiki.freecad.org/index.php?title=File:Pan_cursor.png&diff=8783File:Pan cursor.png2011-12-07T00:10:44Z<p>Momentumv5: SoQt Pan cursor</p>
<hr />
<div>SoQt Pan cursor</div>Momentumv5https://wiki.freecad.org/index.php?title=File:Zoom_cursor.png&diff=8782File:Zoom cursor.png2011-12-07T00:10:07Z<p>Momentumv5: SoQt zoom cursor</p>
<hr />
<div>SoQt zoom cursor</div>Momentumv5https://wiki.freecad.org/index.php?title=Template:Blender_Navigation&diff=8757Template:Blender Navigation2011-12-06T00:24:34Z<p>Momentumv5: Created page with '{|border=1 !align=center width="25%"|Select !align=center width="25%"|Pan !align=center width="25%"|Zoom !align=center width="25%"|Rotate View |- align= center |[[Image:Select-mo…'</p>
<hr />
<div>{|border=1<br />
!align=center width="25%"|Select<br />
!align=center width="25%"|Pan<br />
!align=center width="25%"|Zoom<br />
!align=center width="25%"|Rotate View<br />
|- align= center<br />
|[[Image:Select-mouse.svg|Alt=Mouse with left button clicked | to Select ]]<br />
|shift+[[Image:Pan-mouse.svg |Alt=Mouse with middle button (scroll wheel) clicked | to Pan]]<br />
|[[Image:Zoom-mouse.svg |Alt=Mouse with scroll wheel rolling up or down | to Zoom in or out]]<br />
|[[Image:Pan-mouse.svg|Alt=Mouse with middle button (scroll wheel) clicked | to Rotate ]]<br />
|-valign=top<br />
|Press the left mouse button over an object you want to select.<br />
|Hold shift and click the middle mouse button and move the object around.<br />
|Use the mouse wheel to zoom in and out.<br />
|Click and drag with the middle mouse button.<br />
|}</div>Momentumv5https://wiki.freecad.org/index.php?title=Mouse_navigation&diff=8756Mouse navigation2011-12-06T00:24:13Z<p>Momentumv5: </p>
<hr />
<div>The FreeCAD '''mouse model''' consists of the commands used to visually navigate the 3D space and interact with the objects displayed. There are currently 3 different mouse navigation schemes in FreeCAD. The default navigation style is referred to as "CAD Navigation," and is very simple and practical, but FreeCAD also has two alternative navigation styles modeled after Inventor and Blender navigation. <br />
== Navigation ==<br />
The object handling is common to all workbenches. The following mouse gestures can be used to control the object position and view according to which Navigation style is selected. To change navigation styles, right click in an empty area of the 3D view window.<br />
=== CAD Navigation (default) ===<br />
This is the default navigation style and allows the user a simple control of the view, and does not require the use of keyboard keys except to make multi-selections.<br />
{{CAD Navigation}}<br />
<br />
=== Inventor Navigation ===<br />
In Inventor Navigation, there is no mouse-only selection. In order to select objects, you must hold down the ctrl key.<br />
{{Inventor Navigation}}<br />
<br />
=== Blender Navigation ===<br />
<br />
In Blender Navigation, there is no mouse-only panning. In order to pan the view, you must hold down the shift key.<br />
{{Blender Navigation}}<br />
<br />
<br />
== Selecting objects ==<br />
Objects can be selected by a click with the left mouse button either by clicking on the object in the 3D-view or by selecting it in the tree view. There is also a [[Preselection]] mechanism that highlights objects and displays information about them before selection just by hovering the mouse over it. If you don't like that behaviour or you have a slow machine, you can switch preselection off in the preferences.<br />
<br />
<br />
== Manipulating Objects ==<br />
FreeCAD offers [[manipulator]]s that can be used to modify an object or its visual appearance. A simple example is the [[clipping plane]] wich can be activated with the ''View→Clipping Plane'' menu. After activation the clipping plane object appears and shows seven obvious manipulators as little boxes: One on each end of its three coordinate axes and one on the center of the plane normal axis. There are four more that are not as obvious: The plane itself and the thin part of the three axis objects.<br />
<br />
;Scaling: To scale the object click with the left mouse button on the box manipulators at the end of the axes and pull them back and forth. Depending on the object the manipulators work independently or synchronously.<br />
;Out of plane shifting: To shift the object along its normal vector, pull the long box on the center of an axis with the left mouse button. For the clipping plane there is only one manipulator along the normal vector.<br />
;In plane shifting: To move the center of the clipping plane, click on the plane object and pull it to the desired location.<br />
;Rotation: Clicking on the thin part of the axes puts the manipulator in rotation mode.<br />
<br />
== Hardware support ==<br />
<br />
FreeCAD also supports a couple of [[3D input devices]].<br />
<br />
{{docnav|Getting started|Document structure}}<br />
<br />
{{languages | {{cn|Mouse Model/cn}} {{de|Mouse Model/de}} {{es|Mouse Model/es}} {{fr|Mouse Model/fr}} {{pl|Mouse Model/pl}} {{ru|Mouse Model/ru}} {{se|Mouse Model/se}} }}<br />
<br />
[[Category:User Documentation]]</div>Momentumv5https://wiki.freecad.org/index.php?title=File:Draft_Offset.svg&diff=8754File:Draft Offset.svg2011-12-06T00:18:49Z<p>Momentumv5: uploaded a new version of "File:Draft Offset.svg"</p>
<hr />
<div></div>Momentumv5https://wiki.freecad.org/index.php?title=File:Draft_Offset.svg&diff=8753File:Draft Offset.svg2011-12-06T00:17:27Z<p>Momentumv5: uploaded a new version of "File:Draft Offset.svg"</p>
<hr />
<div></div>Momentumv5https://wiki.freecad.org/index.php?title=File:Draft_Offset.png&diff=8752File:Draft Offset.png2011-12-06T00:15:08Z<p>Momentumv5: uploaded a new version of "File:Draft Offset.png"</p>
<hr />
<div></div>Momentumv5https://wiki.freecad.org/index.php?title=Getting_started&diff=8751Getting started2011-12-06T00:05:25Z<p>Momentumv5: /* Navigating in the 3D space */</p>
<hr />
<div>==What's new==<br />
<br />
* [[Release notes 012|Version 0.12 Release notes]] : Check what's new in the 0.12 release of FreeCAD<br />
<br />
==Foreword==<br />
<br />
FreeCAD is a CAD/CAE parametric modeling application. It is still in early stage of development, so don't expect to be able to use it to produce work already. But, if you are curious about what FreeCAD looks like and what features are being developed, you are welcome to download it and give it a try. At the moment, much functionality is already present, but not much user interface has been created for it. This means that if you know a bit of python, you will already be able to produce and modify complex geometry relatively easily. If not, you will probably find that FreeCAD still has little to offer to you. But, be patient, this is expected to change soon.<br />
<br />
And if after testing you have feedback, ideas or opinions, please share it with us on the [http://apps.sourceforge.net/phpbb/free-cad/index.php FreeCAD discussion forum]!<br />
<br />
==Installing== <br />
<br />
First of all (if not done already) download and install FreeCAD. See the [[Download]] page for information about current versions and updates. There are install packages ready for Windows (.msi), Ubuntu & Debian (.deb) openSUSE (.rpm) and Mac OSX.<br />
<br />
==Exploring FreeCAD==<br />
<br />
[[Image:Freecad09-empty.jpg|frame|none|The FreeCAD interface when you start it for the first time. See more [[screenshots]] here.]]<br />
<br />
FreeCAD is a general all-purpose 3D modeling application, focused on mechanical engineering and related areas, such as other engineering specialties or architecture. It is conceived as a platform for developing any kind of 3D application, but also for doing very specific tasks. For that purpose, its interface is divided into a serie of [[Workbenches]]. Workbenches allow to change the interface contents to display all and only the tools necessary for a specific task, or group of tasks.<br />
<br />
The FreeCAD interface can therefore be described as a very simple container, with a menu bar, a 3D view area, and a couple of side panels for displaying the scene contents or object properties. All the contents of these panels can be changes depending on the workbench.<br />
<br />
When you start FreeCAD for the first time, you will be presented a "general" workbench, that we call "complete workbench". This workbench simply gathers the most mature tools from other workbenches. Since FreeCAD is pretty young and not yet used for very specialized work, this workbench is very handy for discovering FreeCAD more easily. Basically, all the tools that are good enough for producing geometry are here.<br />
<br />
=== Navigating in the 3D space ===<br />
<br />
FreeCAD has three different [[Mouse Model|navigation modes]] available, that can be set in the preferences settings dialog or changed by right-clicking in the 3D view. In the default mode ("CAD Navigation"), the commands are as follows:{{CAD Navigation}}<br />
<br />
You also have several view presets (top view, front view, etc) available in the View menu and on the View toolbar, and by numeric shortcuts ({{KEY|1}}, {{KEY|2}}, etc...)<br />
<br />
==[[Image:Workbench_Draft.png]] [[Draft Module|2D Drafting]]==<br />
<br />
{{Draft Tools}}<br />
<br />
<br />
==[[Image:Workbench_Part.png]] [[Part Module|Creating 3D Parts]]==<br />
<br />
{{Part Tools}}<br />
<br />
<br />
==[[Drawing Module|Exporting to 2D Drawings]]==<br />
<br />
{{Drawing Tools}}<br />
<br />
<br />
==[[Raytracing Module|Exporting to external renderers]]==<br />
<br />
{{Raytracing Tools}}<br />
<br />
<br />
==[[Scripting]]==<br />
<br />
And finally, one of the most powerful features of FreeCAD is the [[scripting]] environment. From the integrated python console (or from any other external python script), you can gain access to almost any part of FreeCAD, create or modify geometry, modify the representation of those objects in the 3D scene or access and modify the FreeCAD interface. Python scripting can also be used in [[macros]], which provide an easy method to create custom commands.<br />
<br />
<br />
{{docnav|Install on Mac|Mouse Model}}<br />
<br />
{{languages | {{cn|Getting started/cn}} {{de|Getting started/de}} {{es|Getting started/es}} {{fr|Getting started/fr}} {{it|Getting started/it}} {{jp|Getting started/jp}} {{pl|Getting started/pl}} {{ru|Getting started/ru}} {{se|Getting started/se}} }}<br />
<br />
[[Category:User Documentation]]</div>Momentumv5https://wiki.freecad.org/index.php?title=Mouse_navigation&diff=8750Mouse navigation2011-12-06T00:01:44Z<p>Momentumv5: /* CAD Navigation (default) */</p>
<hr />
<div>The FreeCAD '''mouse model''' consists of the commands used to visually navigate the 3D space and interact with the objects displayed. There are currently 3 different mouse navigation schemes in FreeCAD. The default navigation style is referred to as "CAD Navigation," and is very simple and practical, but FreeCAD also has two alternative navigation styles modeled after Inventor and Blender navigation. <br />
== Navigation ==<br />
The object handling is common to all workbenches. The following mouse gestures can be used to control the object position and view according to which Navigation style is selected. To change navigation styles, right click in an empty area of the 3D view window.<br />
=== CAD Navigation (default) ===<br />
This is the default navigation style and allows the user a simple control of the view, and does not require the use of keyboard keys except to make multi-selections.<br />
{{CAD Navigation}}<br />
<br />
=== Inventor Navigation ===<br />
In Inventor Navigation, there is no mouse-only selection. In order to select objects, you must hold down the ctrl key.<br />
<br />
{|border=1<br />
!align=center width="25%"|Select<br />
!align=center width="25%"|Pan<br />
!align=center width="25%"|Zoom<br />
!align=center width="25%"|Rotate View<br />
|- align=center<br />
|ctrl+[[Image:Select-mouse.svg|Alt=Mouse with left button clicked | to Select ]]<br />
|[[Image:Pan-mouse.svg |Alt=Mouse with middle button (scroll wheel) clicked | to Pan]]<br />
|[[Image:Zoom-mouse.svg |Alt=Mouse with scroll wheel rolling up or down | to Zoom in or out]] or [[Image:Rotate-mouse.svg|Alt=Mouse with middle button (scroll wheel) clicked first and held, and the left button clicked second. | to Zoom in or out]]<br />
|[[Image:Select-mouse.svg|Alt=Mouse with left button clicked | to Rotate ]]<br />
|-valign=top<br />
|Hold ctrl and press the left mouse button over an object you want to select.<br />
|Click the left mouse button and move the object around.<br />
|Use the mouse wheel to zoom in and out, or click and hold the middle mouse button and click the left mouse button.<br />
|Click and drag with the left mouse button to rotate<br />
|}<br />
<br />
=== Blender Navigation ===<br />
<br />
In Blender Navigation, there is no mouse-only panning. In order to pan the view, you must hold down the shift key.<br />
<br />
{|border=1<br />
!align=center width="25%"|Select<br />
!align=center width="25%"|Pan<br />
!align=center width="25%"|Zoom<br />
!align=center width="25%"|Rotate View<br />
|- align= center<br />
|[[Image:Select-mouse.svg|Alt=Mouse with left button clicked | to Select ]]<br />
|shift+[[Image:Pan-mouse.svg |Alt=Mouse with middle button (scroll wheel) clicked | to Pan]]<br />
|[[Image:Zoom-mouse.svg |Alt=Mouse with scroll wheel rolling up or down | to Zoom in or out]]<br />
|[[Image:Pan-mouse.svg|Alt=Mouse with middle button (scroll wheel) clicked | to Rotate ]]<br />
|-valign=top<br />
|Press the left mouse button over an object you want to select.<br />
|Hold shift and click the middle mouse button and move the object around.<br />
|Use the mouse wheel to zoom in and out.<br />
|Click and drag with the middle mouse button.<br />
|}<br />
<br />
== Selecting objects ==<br />
Objects can be selected by a click with the left mouse button either by clicking on the object in the 3D-view or by selecting it in the tree view. There is also a [[Preselection]] mechanism that highlights objects and displays information about them before selection just by hovering the mouse over it. If you don't like that behaviour or you have a slow machine, you can switch preselection off in the preferences.<br />
<br />
<br />
== Manipulating Objects ==<br />
FreeCAD offers [[manipulator]]s that can be used to modify an object or its visual appearance. A simple example is the [[clipping plane]] wich can be activated with the ''View→Clipping Plane'' menu. After activation the clipping plane object appears and shows seven obvious manipulators as little boxes: One on each end of its three coordinate axes and one on the center of the plane normal axis. There are four more that are not as obvious: The plane itself and the thin part of the three axis objects.<br />
<br />
;Scaling: To scale the object click with the left mouse button on the box manipulators at the end of the axes and pull them back and forth. Depending on the object the manipulators work independently or synchronously.<br />
;Out of plane shifting: To shift the object along its normal vector, pull the long box on the center of an axis with the left mouse button. For the clipping plane there is only one manipulator along the normal vector.<br />
;In plane shifting: To move the center of the clipping plane, click on the plane object and pull it to the desired location.<br />
;Rotation: Clicking on the thin part of the axes puts the manipulator in rotation mode.<br />
<br />
== Hardware support ==<br />
<br />
FreeCAD also supports a couple of [[3D input devices]].<br />
<br />
{{docnav|Getting started|Document structure}}<br />
<br />
{{languages | {{cn|Mouse Model/cn}} {{de|Mouse Model/de}} {{es|Mouse Model/es}} {{fr|Mouse Model/fr}} {{pl|Mouse Model/pl}} {{ru|Mouse Model/ru}} {{se|Mouse Model/se}} }}<br />
<br />
[[Category:User Documentation]]</div>Momentumv5https://wiki.freecad.org/index.php?title=Template:CAD_Navigation&diff=8749Template:CAD Navigation2011-12-06T00:01:08Z<p>Momentumv5: Created page with '{|border=1 !align=center width="25%"|Select !align=center width="25%"|Pan !align=center width="25%"|Zoom !align=center width="25%"|Rotate View |- align=center |[[Image:Select-mou…'</p>
<hr />
<div>{|border=1<br />
!align=center width="25%"|Select<br />
!align=center width="25%"|Pan<br />
!align=center width="25%"|Zoom<br />
!align=center width="25%"|Rotate View<br />
|- align=center<br />
|[[Image:Select-mouse.svg|Alt=Mouse with left button clicked | to Select ]]<br />
|[[Image:Pan-mouse.svg |Alt=Mouse with middle button (scroll wheel) clicked | to Pan]]<br />
|[[Image:Zoom-mouse.svg |Alt=Mouse with scroll wheel rolling up or down | to Zoom in or out]]<br />
|[[Image:Rotate-mouse.svg|Alt=Mouse with middle button (scroll wheel) clicked first and held, and the left button clicked second. | to Rotate view]]<br />
|- valign=top<br />
|Press the left mouse button over an object you want to select. Holding down ctrl allows the selection of multiple objects.<br />
|Click the middle mouse button and move the object around to pan<br />
|Use the mouse wheel to zoom in and out.<br />
|Click first with the middle mouse button, hold it and the click the left mouse button on any visible part of an object and drag it in the desired direction. This works like spinning a ball that rotates around its center. If you release the buttons before you stop your motion, the object continues [[spinning]], if this is enabled. A double click with the middle mouse button on any part of an object sets the new center of rotation and zooms in on this point.<br />
|}</div>Momentumv5https://wiki.freecad.org/index.php?title=Download&diff=8748Download2011-12-05T23:57:28Z<p>Momentumv5: </p>
<hr />
<div>There are several '''downloads''' for various operating systems available. Before downloading keep in mind: <br />
{{VeryImportantMessage|'''FreeCAD is under heavy development and might not be ready for production use'''}}<br />
==Official Installers==<br />
=== Stable FreeCAD installers ===<br />
<br />
The FreeCAD team provides ready-to-install packages for [[Image:windows.png|16px]] '''Windows''' (XP, Vista and 7, 32 and 64bits), [[Image:mac.png|16px]] '''Mac OS X''' (Snow Leopard 10.6), and [[Image:linux.png|16px]] '''Debian-based Linux systems''' (Debian, Ubuntu, 32 and 64bits). Below are links to the Stable installation files for the various systems. Also available on the [http://sourceforge.net/projects/free-cad/files/ FreeCAD Files page] are '''unstable''' packages, that provide the bleeding-edge new features being worked on, but might crash more often or contain features that are incompatible with earlier versions.<br />
{|<br />
|{{DownloadWindowsStable}} || || {{DownloadUnixStable}} || || {{DownloadMacStable}}<br />
|}<br />
<br />
=== Development Versions ===<br />
If you want to install FreeCAD with more in-development features, and are willing to accept that these versions have a higher chance of bugs and crashes, then you can check the official [http://sourceforge.net/projects/free-cad/files/ FreeCAD Files page] to download 64 bit, older, or unstable releases. Of course, if you want to stay even more on the bleeding edge of development, you can [[compiling| compile]] FreeCAD, or use the [[#Ubuntu PPA packages|Ubuntu daily build updates]].<br />
<br />
===Notes for Windows users===<br />
<br />
The windows installer should also work on older Windows platforms, but has not always been tested. You need ''Windows Installer V1'' on your system (msiexec.exe). See [[Install on Windows|Installing on Windows]] for details about different installation options. Download the latest .msi file for windows systems, or the appropriate .deb file for your version of Ubuntu or Debian.<br />
<br />
===Notes for Linux users===<br />
<br />
On most recent distributions such as Debian, Ubuntu or Arch, FreeCAD is included in the official distribution's packages repository, and you are advised to preferably get FreeCAD from there, to make sure you have a version that is 100% compatible with your system. The pivy python module (usually named python-pivy) is needed by FreeCAD from version 0.9 or above. If it is not available on your system, you must download it from here too.<br />
<br />
===Notes for Mac users===<br />
<br />
We rely on very few people to help building Mac OSX packages, so it doesn't get updated as often as the other platforms. The version available on this site might be slightly outdated.<br />
(To compile the most up-to-date version from source see [[CompileOnMac]])<br />
<br />
== Ubuntu PPA packages ==<br />
<br />
The [https://launchpad.net/~freecad-maintainers FreeCAD Launchpad team] has set up two PPA (Personal Package Archive) repositories that allow easy install of Ubuntu packages based on the development branch. Updates to the software are pushed to the Ubuntu Update Manager, which makes it the easiest way to get the latest FreeCAD build.<br />
<br />
* [https://launchpad.net/~freecad-maintainers/+archive/freecad-daily FreeCAD Daily Builds]: an automatic daily build system, which can provide you with a fresh, daily-up-to-date version of FreeCAD. Please be advised that the packages from this bleeding edge PPA may be broken from time to time.<br />
* [https://launchpad.net/~freecad-maintainers/+archive/freecad-dev FreeCAD Devel]: packages available through this PPA are actually copied from the Daily Builds PPA but are summarily tested beforehand. Update schedule is slower, and varies from 1-3 weeks.<br />
<br />
Current supported architectures and versions are:<br />
<br />
* Ubuntu 10.04 LTS (Lucid Lynx) 32 & 64-Bit<br />
* Ubuntu 10.10 (Maverick Meerkat) 32 & 64-Bit<br />
* Ubuntu 11.04 (Natty Narwhal) 32 & 64-Bit<br />
<br />
==== Adding the PPA and installing FreeCAD from the console ====<br />
<br />
Type (or copy-paste) these commands in a console to add the PPA and install FreeCAD along with the documentation:<br />
<br />
For FreeCAD Daily Builds:<br />
sudo add-apt-repository ppa:freecad-maintainers/freecad-daily<br />
For FreeCAD Devel:<br />
sudo add-apt-repository ppa:freecad-maintainers/freecad-dev<br />
Then:<br />
sudo apt-get update<br />
sudo apt-get upgrade<br />
sudo apt-get install freecad freecad-doc<br />
<br />
==== Adding the PPA and installing FreeCAD from the GUI ====<br />
<br />
Add to your system's Software Sources one of the following PPA (read [http://askubuntu.com/questions/4983/what-are-ppas-and-how-do-i-use-them/5102#5102%29 What are PPAs and how do I use them?] if you don't know how):<br />
<br />
* For FreeCAD Daily Builds: '''ppa:freecad-maintainers/freecad-daily'''<br />
* For FreeCAD Devel: '''ppa:freecad-maintainers/freecad-dev'''<br />
<br />
When a dialog window asks you to refresh your software sources, click OK.<br />
<br />
Now you can install FreeCAD and FreeCAD documentation through the Ubuntu Software Center, or your package manager of choice.<br />
<br />
== Alternative FreeCAD builds ==<br />
<br />
These are versions of FreeCAD built by other persons and not officially maintained by the FreeCAD team. They may include customized parts or be optimized for certain types of processors, or other modifications that the package maintainers judged necessary. But they are also sometimes better suited for certain operating systems. Note that on most common linux distributions, official packages are typically installed by the system's package management tool, so you don't need to download and install FreeCAD manually.<br />
<br />
*[http://packages.debian.org/freecad Official Debian package]<br />
*[http://packages.ubuntu.com/freecad Official Ubuntu package]<br />
*[http://software.opensuse.org/search?q=freecad&baseproject=openSUSE%3A11.4&lang=en&exclude_debug=true Official OpenSuse package]<br />
*[http://www.softpedia.com/get/Multimedia/Graphic/Graphic-Editors/FreeCAD.shtml Softpedia Windows build]<br />
*[http://packman.links2linux.de/package/FreeCAD Packman RPM package (for opensuse, fedora)]<br />
*[http://slackbuilds.org/repository/13.37/graphics/FreeCAD/ Slackbuilds package (for Slackware)]<br />
*[http://aur.archlinux.org/packages.php?K=freecad ArchLinux AUR package]<br />
*[http://packages.gentoo.org/package/media-gfx/freecad Gentoo ebuild package]<br />
*[https://svn.pardus.org.tr/pardus/playground/kaan.aksit/2011/freecad/actions.py Pardus linux build script]<br />
<br />
== FreeCAD documentation ==<br />
<br />
The user documentation of FreeCAD is being written together by the developers and the users community, on this wiki site. The best way is to read it online, so you are sure to get the latest version:<br />
<br />
* [[Online Help Toc|The FreeCAD Manual]]<br />
<br />
The manual can also be displayed as one big text, so you can print it or save it as a pdf file:<br />
<br />
* [[Manual|All-in-one printable version]]<br />
<br />
The manual is also be compiled as a qt help file, so it can be browsed offline with the Qt help viewer. This is usually made at each release and is available together with FreeCAD package on most linux software repositories (on debian/ubuntu-based systems, look for '''freecad-doc''' package) and is also bundled in the windows installer. To access it, simply open the "help" menu inside FreeCAD, or use the "What's this?" button.<br />
<br />
For convenience, we also provide a pdf version of this manual:<br />
<br />
* [http://yorik.uncreated.net/archive/freecad010.pdf 0.10 Manual (Pdf file)]<br />
* [http://yorik.uncreated.net/scripts/freecad011.pdf 0.11 Manual (Pdf file)]<br />
* [http://sourceforge.net/projects/free-cad/files/FreeCAD%20Documentation/FreeCAD-0.12.pdf/download 0.12 Manual (Pdf file)]<br />
<br />
Here you can also find a copy of the OpenCasCade 5.2 docs, in a .chm file. After 5.2, the openCasCade documentation is not available as a single file anymore, but as a heavy 180Mb package. So, since there is little change, we keep this one around for convenience:<br />
<br />
*[http://www.4shared.com/file/128871432/96b15e62/occ52.html OpenCasCADE 5.2 documentation]<br />
<br />
== FreeCAD Source package ==<br />
<br />
For all other platforms you need to compile FreeCAD on your own from the Source package. You might also want to compile FreeCAD yourself if you want to optimize certain things, or customize certain parts of FreeCAD. Instructions for compiling can be found on the [[CompileOnWindows]], [[CompileOnMac]] and [[CompileOnUnix]] pages. You can grab a zip or tar.gz file containing the latest official version here (look for the latest version for your system):<br />
<br />
*[http://sourceforge.net/projects/free-cad/files/ official FreeCAD Files repository]<br />
<br />
Alternatively, you can also download latest source code from the SVN repository. You'll get a more recent version, but it might contain bugs or even fail to compile. Instructions for accessing the SVN repository can be found here:<br />
<br />
*[http://sourceforge.net/svn/?group_id=49159 FreeCAD SVN repository]<br />
<br />
You can also download automatically a GNU tarball from the latest source code tree or any part of it by using the code browser and clicking the "Download GNU tarball" at any time. The trunk folder contains the current development version, while the branches folder contains a snapshot of all stable releases to date.<br />
<br />
*[http://free-cad.svn.sourceforge.net/viewvc/free-cad/ FreeCAD SVN browser]<br />
<br />
== FreeCAD LibPack ==<br />
<br />
To collect all the needed libraries to compile FreeCAD can be a time consuming task. So we deliver a convenient package for development on Windows (VS8) with all needed libraries. You can download the latest version of the libpack from<br />
<br />
*[http://sourceforge.net/project/showfiles.php?group_id=49159&package_id=157551 FreeCAD LibPack]<br />
<br />
For linux, you will normally find all necessary libraries in your software management system, so you should just read the [[CompileOnUnix]] page.<br />
<br />
== Additional modules ==<br />
<br />
There are additional modules, addons of plugins for FreeCAD developed outside of the main FreeCAD development team. They are listed here but are not officially supported by the FreeCAD team.<br />
<br />
*[http://ja.orgfree.com/freecad.htm Fold module]: a module in development for working with metal sheets.<br />
*[http://gitorious.org/freecad-ship Ship module]: a module in development for ship design.<br />
<br />
{{Languages| {{de|Download/de}} {{es|Download/es}} {{fr|Download/fr}} {{ru|Download/ru}} {{se|Download/se}} }}<br />
<br />
[[Category:User Documentation]]</div>Momentumv5https://wiki.freecad.org/index.php?title=Mouse_navigation&diff=8747Mouse navigation2011-12-05T23:51:56Z<p>Momentumv5: </p>
<hr />
<div>The FreeCAD '''mouse model''' consists of the commands used to visually navigate the 3D space and interact with the objects displayed. There are currently 3 different mouse navigation schemes in FreeCAD. The default navigation style is referred to as "CAD Navigation," and is very simple and practical, but FreeCAD also has two alternative navigation styles modeled after Inventor and Blender navigation. <br />
== Navigation ==<br />
The object handling is common to all workbenches. The following mouse gestures can be used to control the object position and view according to which Navigation style is selected. To change navigation styles, right click in an empty area of the 3D view window.<br />
=== CAD Navigation (default) ===<br />
This is the default navigation style and allows the user a simple control of the view, and does not require the use of keyboard keys except to make multi-selections.<br />
{|border=1<br />
!align=center width="25%"|Select<br />
!align=center width="25%"|Pan<br />
!align=center width="25%"|Zoom<br />
!align=center width="25%"|Rotate View<br />
|- align=center<br />
|[[Image:Select-mouse.svg|Alt=Mouse with left button clicked | to Select ]]<br />
|[[Image:Pan-mouse.svg |Alt=Mouse with middle button (scroll wheel) clicked | to Pan]]<br />
|[[Image:Zoom-mouse.svg |Alt=Mouse with scroll wheel rolling up or down | to Zoom in or out]]<br />
|[[Image:Rotate-mouse.svg|Alt=Mouse with middle button (scroll wheel) clicked first and held, and the left button clicked second. | to Rotate view]]<br />
|- valign=top<br />
|Press the left mouse button over an object you want to select. Holding down ctrl allows the selection of multiple objects.<br />
|Click the middle mouse button and move the object around to pan<br />
|Use the mouse wheel to zoom in and out.<br />
|Click first with the middle mouse button, hold it and the click the left mouse button on any visible part of an object and drag it in the desired direction. This works like spinning a ball that rotates around its center. If you release the buttons before you stop your motion, the object continues [[spinning]], if this is enabled. A double click with the middle mouse button on any part of an object sets the new center of rotation and zooms in on this point.<br />
|}<br />
<br />
=== Inventor Navigation ===<br />
In Inventor Navigation, there is no mouse-only selection. In order to select objects, you must hold down the ctrl key.<br />
<br />
{|border=1<br />
!align=center width="25%"|Select<br />
!align=center width="25%"|Pan<br />
!align=center width="25%"|Zoom<br />
!align=center width="25%"|Rotate View<br />
|- align=center<br />
|ctrl+[[Image:Select-mouse.svg|Alt=Mouse with left button clicked | to Select ]]<br />
|[[Image:Pan-mouse.svg |Alt=Mouse with middle button (scroll wheel) clicked | to Pan]]<br />
|[[Image:Zoom-mouse.svg |Alt=Mouse with scroll wheel rolling up or down | to Zoom in or out]] or [[Image:Rotate-mouse.svg|Alt=Mouse with middle button (scroll wheel) clicked first and held, and the left button clicked second. | to Zoom in or out]]<br />
|[[Image:Select-mouse.svg|Alt=Mouse with left button clicked | to Rotate ]]<br />
|-valign=top<br />
|Hold ctrl and press the left mouse button over an object you want to select.<br />
|Click the left mouse button and move the object around.<br />
|Use the mouse wheel to zoom in and out, or click and hold the middle mouse button and click the left mouse button.<br />
|Click and drag with the left mouse button to rotate<br />
|}<br />
<br />
=== Blender Navigation ===<br />
<br />
In Blender Navigation, there is no mouse-only panning. In order to pan the view, you must hold down the shift key.<br />
<br />
{|border=1<br />
!align=center width="25%"|Select<br />
!align=center width="25%"|Pan<br />
!align=center width="25%"|Zoom<br />
!align=center width="25%"|Rotate View<br />
|- align= center<br />
|[[Image:Select-mouse.svg|Alt=Mouse with left button clicked | to Select ]]<br />
|shift+[[Image:Pan-mouse.svg |Alt=Mouse with middle button (scroll wheel) clicked | to Pan]]<br />
|[[Image:Zoom-mouse.svg |Alt=Mouse with scroll wheel rolling up or down | to Zoom in or out]]<br />
|[[Image:Pan-mouse.svg|Alt=Mouse with middle button (scroll wheel) clicked | to Rotate ]]<br />
|-valign=top<br />
|Press the left mouse button over an object you want to select.<br />
|Hold shift and click the middle mouse button and move the object around.<br />
|Use the mouse wheel to zoom in and out.<br />
|Click and drag with the middle mouse button.<br />
|}<br />
<br />
== Selecting objects ==<br />
Objects can be selected by a click with the left mouse button either by clicking on the object in the 3D-view or by selecting it in the tree view. There is also a [[Preselection]] mechanism that highlights objects and displays information about them before selection just by hovering the mouse over it. If you don't like that behaviour or you have a slow machine, you can switch preselection off in the preferences.<br />
<br />
<br />
== Manipulating Objects ==<br />
FreeCAD offers [[manipulator]]s that can be used to modify an object or its visual appearance. A simple example is the [[clipping plane]] wich can be activated with the ''View→Clipping Plane'' menu. After activation the clipping plane object appears and shows seven obvious manipulators as little boxes: One on each end of its three coordinate axes and one on the center of the plane normal axis. There are four more that are not as obvious: The plane itself and the thin part of the three axis objects.<br />
<br />
;Scaling: To scale the object click with the left mouse button on the box manipulators at the end of the axes and pull them back and forth. Depending on the object the manipulators work independently or synchronously.<br />
;Out of plane shifting: To shift the object along its normal vector, pull the long box on the center of an axis with the left mouse button. For the clipping plane there is only one manipulator along the normal vector.<br />
;In plane shifting: To move the center of the clipping plane, click on the plane object and pull it to the desired location.<br />
;Rotation: Clicking on the thin part of the axes puts the manipulator in rotation mode.<br />
<br />
== Hardware support ==<br />
<br />
FreeCAD also supports a couple of [[3D input devices]].<br />
<br />
{{docnav|Getting started|Document structure}}<br />
<br />
{{languages | {{cn|Mouse Model/cn}} {{de|Mouse Model/de}} {{es|Mouse Model/es}} {{fr|Mouse Model/fr}} {{pl|Mouse Model/pl}} {{ru|Mouse Model/ru}} {{se|Mouse Model/se}} }}<br />
<br />
[[Category:User Documentation]]</div>Momentumv5https://wiki.freecad.org/index.php?title=Mouse_navigation&diff=8746Mouse navigation2011-12-05T23:43:24Z<p>Momentumv5: add full descriptions for all three navigation styles</p>
<hr />
<div>The FreeCAD '''mouse model''' consists of the commands used to visually navigate the 3D space and interact with the objects displayed. There are currently 3 different mouse navigation schemes in FreeCAD. The default navigation style is referred to as "CAD Navigation," and is a very flexible and intuitive '''mouse model''', but FreeCAD has two alternative navigation styles modeled after Inventor and Blender navigation. <br />
== Navigation ==<br />
The object handling is common to all workbenches. The following mouse gestures can be used to control the object position and view according to which Navigation style is selected. To change navigation styles, right click in an empty area of the 3D view window.<br />
=== CAD Navigation (default) ===<br />
This is the default navigation style and allows the user a simple control of the view, and does not require the use of keyboard keys except to make multi-selections.<br />
{|border=1<br />
!align=center width="25%"|Select<br />
!align=center width="25%"|Pan<br />
!align=center width="25%"|Zoom<br />
!align=center width="25%"|Rotate View<br />
|- align=center<br />
|[[Image:Select-mouse.svg|Alt=Mouse with left button clicked | to Select ]]<br />
|[[Image:Pan-mouse.svg |Alt=Mouse with middle button (scroll wheel) clicked | to Pan]]<br />
|[[Image:Zoom-mouse.svg |Alt=Mouse with scroll wheel rolling up or down | to Zoom in or out]]<br />
|[[Image:Rotate-mouse.svg|Alt=Mouse with middle button (scroll wheel) clicked first and held, and the left button clicked second. | to Rotate view]]<br />
|- valign=top<br />
|Press the left mouse button over an object you want to select. Holding down ctrl allows the selection of multiple objects.<br />
|Click the middle mouse button and move the object around to pan<br />
|Use the mouse wheel to zoom in and out.<br />
|Click first with the middle mouse button, hold it and the click the left mouse button on any visible part of an object and drag it in the desired direction. This works like spinning a ball that rotates around its center. If you release the buttons before you stop your motion, the object continues [[spinning]], if this is enabled. A double click with the middle mouse button on any part of an object sets the new center of rotation and zooms in on this point.<br />
|}<br />
<br />
=== Inventor Navigation ===<br />
In Inventor Navigation, there is no mouse-only selection. In order to select objects, you must hold down the ctrl key.<br />
<br />
{|border=1<br />
!align=center width="25%"|Select<br />
!align=center width="25%"|Pan<br />
!align=center width="25%"|Zoom<br />
!align=center width="25%"|Rotate View<br />
|- align=center<br />
|ctrl+[[Image:Select-mouse.svg|Alt=Mouse with left button clicked | to Select ]]<br />
|[[Image:Pan-mouse.svg |Alt=Mouse with middle button (scroll wheel) clicked | to Pan]]<br />
|[[Image:Zoom-mouse.svg |Alt=Mouse with scroll wheel rolling up or down | to Zoom in or out]] or [[Image:Rotate-mouse.svg|Alt=Mouse with middle button (scroll wheel) clicked first and held, and the left button clicked second. | to Zoom in or out]]<br />
|[[Image:Select-mouse.svg|Alt=Mouse with left button clicked | to Rotate ]]<br />
|-valign=top<br />
|Hold ctrl and press the left mouse button over an object you want to select.<br />
|Click the left mouse button and move the object around.<br />
|Use the mouse wheel to zoom in and out, or click and hold the middle mouse button and click the left mouse button.<br />
|Click and drag with the left mouse button to rotate<br />
|}<br />
<br />
=== Blender Navigation ===<br />
<br />
In Blender Navigation, there is no mouse-only panning. In order to pan the view, you must hold down the shift key.<br />
<br />
{|border=1<br />
!align=center width="25%"|Select<br />
!align=center width="25%"|Pan<br />
!align=center width="25%"|Zoom<br />
!align=center width="25%"|Rotate View<br />
|- align= center<br />
|[[Image:Select-mouse.svg|Alt=Mouse with left button clicked | to Select ]]<br />
|shift+[[Image:Pan-mouse.svg |Alt=Mouse with middle button (scroll wheel) clicked | to Pan]]<br />
|[[Image:Zoom-mouse.svg |Alt=Mouse with scroll wheel rolling up or down | to Zoom in or out]]<br />
|[[Image:Pan-mouse.svg|Alt=Mouse with middle button (scroll wheel) clicked | to Rotate ]]<br />
|-valign=top<br />
|Press the left mouse button over an object you want to select.<br />
|Hold shift and click the middle mouse button and move the object around.<br />
|Use the mouse wheel to zoom in and out.<br />
|Click and drag with the middle mouse button.<br />
|}<br />
<br />
== Selecting objects ==<br />
Objects can be selected by a click with the left mouse button either by clicking on the object in the 3D-view or by selecting it in the tree view. There is also a [[Preselection]] mechanism that highlights objects and displays information about them before selection just by hovering the mouse over it. If you don't like that behaviour or you have a slow machine, you can switch preselection off in the preferences.<br />
<br />
== Handling Objects ==<br />
The object handling is common to all workbenches. The following mouse gestures can be used to control the object position and view.<br />
<br />
;Select: Press the left mouse button over an object you want to select.<br />
<br />
;Zoom: Use the ''+'' or ''-'' keys or the mouse wheel to zoom in and out.<br />
<br />
;Pan: Click the middle mouse button and move the object around.<br />
<br />
;Rotate: Click first with the middle mouse button, hold it and the click the left mouse button on any visible part of an object and drag it in the desired direction. This works like spinning a ball that rotates around its center. If you release the buttons before you stop your motion, the object continues [[spinning]], if this is enabled.<br />
<br />
;Setting Center of Rotation: A double click with the middle mouse button on any part of an object sets the new center of rotation and zooms in on this point.<br />
<br />
== Manipulating Objects ==<br />
FreeCAD offers [[manipulator]]s that can be used to modify an object or its visual appearance. A simple example is the [[clipping plane]] wich can be activated with the ''View→Clipping Plane'' menu. After activation the clipping plane object appears and shows seven obvious manipulators as little boxes: One on each end of its three coordinate axes and one on the center of the plane normal axis. There are four more that are not as obvious: The plane itself and the thin part of the three axis objects.<br />
<br />
;Scaling: To scale the object click with the left mouse button on the box manipulators at the end of the axes and pull them back and forth. Depending on the object the manipulators work independently or synchronously.<br />
;Out of plane shifting: To shift the object along its normal vector, pull the long box on the center of an axis with the left mouse button. For the clipping plane there is only one manipulator along the normal vector.<br />
;In plane shifting: To move the center of the clipping plane, click on the plane object and pull it to the desired location.<br />
;Rotation: Clicking on the thin part of the axes puts the manipulator in rotation mode.<br />
<br />
== Hardware support ==<br />
<br />
Version 0.12 of FreeCAD also supports a couple of [[3D input devices]].<br />
<br />
{{docnav|Getting started|Document structure}}<br />
<br />
{{languages | {{cn|Mouse Model/cn}} {{de|Mouse Model/de}} {{es|Mouse Model/es}} {{fr|Mouse Model/fr}} {{pl|Mouse Model/pl}} {{ru|Mouse Model/ru}} {{se|Mouse Model/se}} }}<br />
<br />
[[Category:User Documentation]]</div>Momentumv5https://wiki.freecad.org/index.php?title=Download&diff=8697Download2011-12-05T01:50:02Z<p>Momentumv5: try to emphasize development options</p>
<hr />
<div>There are several '''downloads''' for various operating systems available. Before downloading keep in mind: <br />
{{VeryImportantMessage|'''FreeCAD is still in ALPHA state and not ready for production use'''}}<br />
<br />
== Stable FreeCAD installers ==<br />
<br />
The FreeCAD team provides ready-to-install packages for [[Image:windows.png|16px]] '''Windows''' (XP, Vista and 7, 32 and 64bits), [[Image:mac.png|16px]] '''Mac OS X''' (Snow Leopard 10.6), and [[Image:linux.png|16px]] '''Debian-based Linux systems''' (Debian, Ubuntu, 32 and 64bits). Below are links to the Stable installation files for the various systems. Also available on the [http://sourceforge.net/projects/free-cad/files/ FreeCAD Files page] are '''unstable''' packages, that provide the bleeding-edge new features being worked on, but might crash more often or contain features that are incompatible with earlier versions.<br />
{|<br />
|{{DownloadWindowsStable}} || || {{DownloadUnixStable}} || || {{DownloadMacStable}}<br />
|}<br />
<br />
=== Development Versions ===<br />
If you want to install FreeCAD with more in-development features, and are willing to accept that these versions have a higher chance of bugs and crashes, then you can check the official [http://sourceforge.net/projects/free-cad/files/ FreeCAD Files page] to download 64 bit, older, or unstable releases. Of course, if you want to stay even more on the bleeding edge of development, you can [[compiling| compile]] FreeCAD, or use the [[#Ubuntu PPA packages|Ubuntu daily build updates]].<br />
<br />
===Notes for Windows users===<br />
<br />
The windows installer should also work on older Windows platforms, but has not always been tested. You need ''Windows Installer V1'' on your system (msiexec.exe). See [[Install on Windows|Installing on Windows]] for details about different installation options. Download the latest .msi file for windows systems, or the appropriate .deb file for your version of Ubuntu or Debian.<br />
<br />
===Notes for Linux users===<br />
<br />
On most recent distributions such as Debian, Ubuntu or Arch, FreeCAD is included in the official distribution's packages repository, and you are advised to preferably get FreeCAD from there, to make sure you have a version that is 100% compatible with your system. The pivy python module (usually named python-pivy) is needed by FreeCAD from version 0.9 or above. If it is not available on your system, you must download it from here too.<br />
<br />
===Notes for Mac users===<br />
<br />
We rely on very few people to help building Mac OSX packages, so it doesn't get updated as often as the other platforms. The version available on this site might be slightly outdated.<br />
(To compile the most up-to-date version from source see [[CompileOnMac]])<br />
<br />
== Ubuntu PPA packages ==<br />
<br />
The [https://launchpad.net/~freecad-maintainers FreeCAD Launchpad team] has set up two PPA (Personal Package Archive) repositories that allow easy install of Ubuntu packages based on the development branch. Updates to the software are pushed to the Ubuntu Update Manager, which makes it the easiest way to get the latest FreeCAD build.<br />
<br />
* [https://launchpad.net/~freecad-maintainers/+archive/freecad-daily FreeCAD Daily Builds]: an automatic daily build system, which can provide you with a fresh, daily-up-to-date version of FreeCAD. Please be advised that the packages from this bleeding edge PPA may be broken from time to time.<br />
* [https://launchpad.net/~freecad-maintainers/+archive/freecad-dev FreeCAD Devel]: packages available through this PPA are actually copied from the Daily Builds PPA but are summarily tested beforehand. Update schedule is slower, and varies from 1-3 weeks.<br />
<br />
Current supported architectures and versions are:<br />
<br />
* Ubuntu 10.04 LTS (Lucid Lynx) 32 & 64-Bit<br />
* Ubuntu 10.10 (Maverick Meerkat) 32 & 64-Bit<br />
* Ubuntu 11.04 (Natty Narwhal) 32 & 64-Bit<br />
<br />
==== Adding the PPA and installing FreeCAD from the console ====<br />
<br />
Type (or copy-paste) these commands in a console to add the PPA and install FreeCAD along with the documentation:<br />
<br />
For FreeCAD Daily Builds:<br />
sudo add-apt-repository ppa:freecad-maintainers/freecad-daily<br />
For FreeCAD Devel:<br />
sudo add-apt-repository ppa:freecad-maintainers/freecad-dev<br />
Then:<br />
sudo apt-get update<br />
sudo apt-get upgrade<br />
sudo apt-get install freecad freecad-doc<br />
<br />
==== Adding the PPA and installing FreeCAD from the GUI ====<br />
<br />
Add to your system's Software Sources one of the following PPA (read [http://askubuntu.com/questions/4983/what-are-ppas-and-how-do-i-use-them/5102#5102%29 What are PPAs and how do I use them?] if you don't know how):<br />
<br />
* For FreeCAD Daily Builds: '''ppa:freecad-maintainers/freecad-daily'''<br />
* For FreeCAD Devel: '''ppa:freecad-maintainers/freecad-dev'''<br />
<br />
When a dialog window asks you to refresh your software sources, click OK.<br />
<br />
Now you can install FreeCAD and FreeCAD documentation through the Ubuntu Software Center, or your package manager of choice.<br />
<br />
== Alternative FreeCAD builds ==<br />
<br />
These are versions of FreeCAD built by other persons and not officially maintained by the FreeCAD team. They may include customized parts or be optimized for certain types of processors, or other modifications that the package maintainers judged necessary. But they are also sometimes better suited for certain operating systems. Note that on most common linux distributions, official packages are typically installed by the system's package management tool, so you don't need to download and install FreeCAD manually.<br />
<br />
*[http://packages.debian.org/freecad Official Debian package]<br />
*[http://packages.ubuntu.com/freecad Official Ubuntu package]<br />
*[http://software.opensuse.org/search?q=freecad&baseproject=openSUSE%3A11.4&lang=en&exclude_debug=true Official OpenSuse package]<br />
*[http://www.softpedia.com/get/Multimedia/Graphic/Graphic-Editors/FreeCAD.shtml Softpedia Windows build]<br />
*[http://packman.links2linux.de/package/FreeCAD Packman RPM package (for opensuse, fedora)]<br />
*[http://slackbuilds.org/repository/13.37/graphics/FreeCAD/ Slackbuilds package (for Slackware)]<br />
*[http://aur.archlinux.org/packages.php?K=freecad ArchLinux AUR package]<br />
*[http://packages.gentoo.org/package/media-gfx/freecad Gentoo ebuild package]<br />
*[https://svn.pardus.org.tr/pardus/playground/kaan.aksit/2011/freecad/actions.py Pardus linux build script]<br />
<br />
== FreeCAD documentation ==<br />
<br />
The user documentation of FreeCAD is being written together by the developers and the users community, on this wiki site. The best way is to read it online, so you are sure to get the latest version:<br />
<br />
* [[Online Help Toc|The FreeCAD Manual]]<br />
<br />
The manual can also be displayed as one big text, so you can print it or save it as a pdf file:<br />
<br />
* [[Manual|All-in-one printable version]]<br />
<br />
The manual is also be compiled as a qt help file, so it can be browsed offline with the Qt help viewer. This is usually made at each release and is available together with FreeCAD package on most linux software repositories (on debian/ubuntu-based systems, look for '''freecad-doc''' package) and is also bundled in the windows installer. To access it, simply open the "help" menu inside FreeCAD, or use the "What's this?" button.<br />
<br />
For convenience, we also provide a pdf version of this manual:<br />
<br />
* [http://yorik.uncreated.net/archive/freecad010.pdf 0.10 Manual (Pdf file)]<br />
* [http://yorik.uncreated.net/scripts/freecad011.pdf 0.11 Manual (Pdf file)]<br />
<br />
Here you can also find a copy of the OpenCasCade 5.2 docs, in a .chm file. After 5.2, the openCasCade documentation is not available as a single file anymore, but as a heavy 180Mb package. So, since there is little change, we keep this one around for convenience:<br />
<br />
*[http://www.4shared.com/file/128871432/96b15e62/occ52.html OpenCasCADE 5.2 documentation]<br />
<br />
== FreeCAD Source package ==<br />
<br />
For all other platforms you need to compile FreeCAD on your own from the Source package. You might also want to compile FreeCAD yourself if you want to optimize certain things, or customize certain parts of FreeCAD. Instructions for compiling can be found on the [[CompileOnWindows]], [[CompileOnMac]] and [[CompileOnUnix]] pages. You can grab a zip or tar.gz file containing the latest official version here (look for the latest version for your system):<br />
<br />
*[http://sourceforge.net/projects/free-cad/files/ official FreeCAD Files repository]<br />
<br />
Alternatively, you can also download latest source code from the SVN repository. You'll get a more recent version, but it might contain bugs or even fail to compile. Instructions for accessing the SVN repository can be found here:<br />
<br />
*[http://sourceforge.net/svn/?group_id=49159 FreeCAD SVN repository]<br />
<br />
You can also download automatically a GNU tarball from the latest source code tree or any part of it by using the code browser and clicking the "Download GNU tarball" at any time. The trunk folder contains the current development version, while the branches folder contains a snapshot of all stable releases to date.<br />
<br />
*[http://free-cad.svn.sourceforge.net/viewvc/free-cad/ FreeCAD SVN browser]<br />
<br />
== FreeCAD LibPack ==<br />
<br />
To collect all the needed libraries to compile FreeCAD can be a time consuming task. So we deliver a convenient package for development on Windows (VS8) with all needed libraries. You can download the latest version of the libpack from<br />
<br />
*[http://sourceforge.net/project/showfiles.php?group_id=49159&package_id=157551 FreeCAD LibPack]<br />
<br />
For linux, you will normally find all necessary libraries in your software management system, so you should just read the [[CompileOnUnix]] page.<br />
<br />
== Additional modules ==<br />
<br />
There are additional modules, addons of plugins for FreeCAD developed outside of the main FreeCAD development team. They are listed here but are not officially supported by the FreeCAD team.<br />
<br />
*[http://ja.orgfree.com/freecad.htm Fold module]: a module in development for working with metal sheets.<br />
*[http://gitorious.org/freecad-ship Ship module]: a module in development for ship design.<br />
<br />
{{Languages| {{de|Download/de}} {{es|Download/es}} {{fr|Download/fr}} {{ru|Download/ru}} {{se|Download/se}} }}<br />
<br />
[[Category:User Documentation]]</div>Momentumv5https://wiki.freecad.org/index.php?title=Mouse_navigation&diff=8607Mouse navigation2011-12-03T23:31:11Z<p>Momentumv5: </p>
<hr />
<div>The '''mouse model''' of FreeCAD is very flexible and intuitive and with a few hints you can use it after only a minute of practice.<br />
<br />
{|<br />
!align=center|Select||Pan||Zoom||Rotate View<br />
|-<br />
|[[Image:Select-mouse.svg|Alt=Mouse with left button clicked | to Select ]]<br />
|[[Image:Pan-mouse.svg |Alt=Mouse with middle button (scroll wheel) clicked | to Pan]]<br />
|[[Image:Zoom-mouse.svg |Alt=Mouse with scroll wheel rolling up or down | to Zoom in or out]]<br />
|[[Image:Rotate-mouse.svg|Alt=Mouse with middle button (scroll wheel) clicked first and held, and the left button clicked second. | to Rotate view]]<br />
|}<br />
== Selecting objects ==<br />
Objects can be selected by a click with the left mouse button either by clicking on the object in the 3D-view or by selecting it in the tree view. There is also a [[Preselection]] mechanism that highlights objects and displays information about them before selection just by hovering the mouse over it. If you don't like that behaviour or you have a slow machine, you can switch preselection off in the preferences.<br />
<br />
== Handling Objects ==<br />
The object handling is common to all workbenches. The following mouse gestures can be used to control the object position and view.<br />
<br />
;Select: Press the left mouse button over an object you want to select.<br />
<br />
;Zoom: Use the ''+'' or ''-'' keys or the mouse wheel to zoom in and out.<br />
<br />
;Pan: Click the middle mouse button and move the object around.<br />
<br />
;Rotate: Click first with the middle mouse button, hold it and the click the left mouse button on any visible part of an object and drag it in the desired direction. This works like spinning a ball that rotates around its center. If you release the buttons before you stop your motion, the object continues [[spinning]], if this is enabled.<br />
<br />
;Setting Center of Rotation: A double click with the middle mouse button on any part of an object sets the new center of rotation and zooms in on this point.<br />
<br />
== Manipulating Objects ==<br />
FreeCAD offers [[manipulator]]s that can be used to modify an object or its visual appearance. A simple example is the [[clipping plane]] wich can be activated with the ''View→Clipping Plane'' menu. After activation the clipping plane object appears and shows seven obvious manipulators as little boxes: One on each end of its three coordinate axes and one on the center of the plane normal axis. There are four more that are not as obvious: The plane itself and the thin part of the three axis objects.<br />
<br />
;Scaling: To scale the object click with the left mouse button on the box manipulators at the end of the axes and pull them back and forth. Depending on the object the manipulators work independently or synchronously.<br />
;Out of plane shifting: To shift the object along its normal vector, pull the long box on the center of an axis with the left mouse button. For the clipping plane there is only one manipulator along the normal vector.<br />
;In plane shifting: To move the center of the clipping plane, click on the plane object and pull it to the desired location.<br />
;Rotation: Clicking on the thin part of the axes puts the manipulator in rotation mode.<br />
<br />
== Hardware support ==<br />
<br />
The SVN version of FreeCAD also supports a couple of [[3D input devices]].<br />
<br />
{{docnav|Getting started|Document structure}}<br />
<br />
{{languages | {{cn|Mouse Model/cn}} {{de|Mouse Model/de}} {{es|Mouse Model/es}} {{fr|Mouse Model/fr}} {{pl|Mouse Model/pl}} {{ru|Mouse Model/ru}} {{se|Mouse Model/se}} }}<br />
<br />
[[Category:User Documentation]]</div>Momentumv5https://wiki.freecad.org/index.php?title=File:Zoom-mouse.svg&diff=8606File:Zoom-mouse.svg2011-12-03T22:41:55Z<p>Momentumv5: uploaded a new version of "File:Zoom-mouse.svg":&#32;move the arrow indicators</p>
<hr />
<div>shows the mouse control for zooming the view in the FreeCAD standard view interface</div>Momentumv5https://wiki.freecad.org/index.php?title=File:Select-mouse.svg&diff=8604File:Select-mouse.svg2011-12-03T22:19:21Z<p>Momentumv5: uploaded a new version of "File:Select-mouse.svg":&#32;shows the mouse control for rotating the view in the FreeCAD standard view interface</p>
<hr />
<div></div>Momentumv5https://wiki.freecad.org/index.php?title=File:Rotate-mouse.svg&diff=8603File:Rotate-mouse.svg2011-12-03T22:16:15Z<p>Momentumv5: shows the mouse control for rotating the view in the FreeCAD standard view interface</p>
<hr />
<div>shows the mouse control for rotating the view in the FreeCAD standard view interface</div>Momentumv5https://wiki.freecad.org/index.php?title=File:Pan-mouse.svg&diff=8602File:Pan-mouse.svg2011-12-03T22:15:36Z<p>Momentumv5: uploaded a new version of "File:Pan-mouse.svg":&#32;shows the mouse control for panning the view in the FreeCAD standard view interface</p>
<hr />
<div></div>Momentumv5https://wiki.freecad.org/index.php?title=File:Zoom-mouse.svg&diff=8601File:Zoom-mouse.svg2011-12-03T22:14:48Z<p>Momentumv5: shows the mouse control for zooming the view in the FreeCAD standard view interface</p>
<hr />
<div>shows the mouse control for zooming the view in the FreeCAD standard view interface</div>Momentumv5https://wiki.freecad.org/index.php?title=User:Momentumv5/test&diff=8561User:Momentumv5/test2011-12-01T23:58:32Z<p>Momentumv5: Created page with 'File:Select_Mouse.svg'</p>
<hr />
<div>[[File:Select_Mouse.svg]]</div>Momentumv5https://wiki.freecad.org/index.php?title=File:Select_Mouse.svg&diff=8560File:Select Mouse.svg2011-12-01T23:54:39Z<p>Momentumv5: uploaded a new version of "File:Select Mouse.svg":&#32;Reverted to version as of 22:27, 1 December 2011</p>
<hr />
<div>standard control</div>Momentumv5https://wiki.freecad.org/index.php?title=File:Pan-mouse.svg&diff=8559File:Pan-mouse.svg2011-12-01T23:37:06Z<p>Momentumv5: uploaded a new version of "File:Pan-mouse.svg"</p>
<hr />
<div></div>Momentumv5https://wiki.freecad.org/index.php?title=File:Pan-mouse.svg&diff=8558File:Pan-mouse.svg2011-12-01T23:36:37Z<p>Momentumv5: uploaded a new version of "File:Pan-mouse.svg"</p>
<hr />
<div></div>Momentumv5https://wiki.freecad.org/index.php?title=File:Pan-mouse.svg&diff=8557File:Pan-mouse.svg2011-12-01T23:34:33Z<p>Momentumv5: </p>
<hr />
<div></div>Momentumv5https://wiki.freecad.org/index.php?title=File:Select-mouse.svg&diff=8556File:Select-mouse.svg2011-12-01T23:33:45Z<p>Momentumv5: </p>
<hr />
<div></div>Momentumv5https://wiki.freecad.org/index.php?title=File:Select_Mouse.svg&diff=8555File:Select Mouse.svg2011-12-01T23:23:33Z<p>Momentumv5: uploaded a new version of "File:Select Mouse.svg"</p>
<hr />
<div>standard control</div>Momentumv5https://wiki.freecad.org/index.php?title=File:Select_Mouse.svg&diff=8554File:Select Mouse.svg2011-12-01T22:40:38Z<p>Momentumv5: uploaded a new version of "File:Select Mouse.svg"</p>
<hr />
<div>standard control</div>Momentumv5https://wiki.freecad.org/index.php?title=File:Select_Mouse.svg&diff=8553File:Select Mouse.svg2011-12-01T22:27:36Z<p>Momentumv5: uploaded a new version of "File:Select Mouse.svg":&#32;trying to fix weird svg clipping things</p>
<hr />
<div>standard control</div>Momentumv5https://wiki.freecad.org/index.php?title=File:Select_Mouse.svg&diff=8552File:Select Mouse.svg2011-12-01T21:21:26Z<p>Momentumv5: standard control</p>
<hr />
<div>standard control</div>Momentumv5https://wiki.freecad.org/index.php?title=Units&diff=8505Units2011-11-27T03:18:44Z<p>Momentumv5: /* Supported units */</p>
<hr />
<div>Here some reading about units:<br />
*[http://en.wikipedia.org/wiki/International_System_of_Units SI system]<br />
*[http://en.wikipedia.org/wiki/Imperial_units Imperial units]<br />
*[http://en.wikipedia.org/wiki/SI_derived_unit SI derived units]<br />
*[http://en.wikipedia.org/wiki/Degree_%28angle%29 angle units]<br />
<br />
== Examples ==<br />
<br />
# -- some examples of the FreeCAD unit translation system --<br />
# make a shortcut for the examples<br />
tu = App.Units.translateUnit<br />
<br />
# 10 meters in internal numbers<br />
tu('10 m')<br />
# doing math<br />
tu('3/8 in')<br />
# combined stuff<br />
tu('100 km/h')<br />
# transfer to other units<br />
tu('100 km/h')/tu('m/s')<br />
# derived units (Ohm)<br />
tu('m^2*kg*s^-3*A^-2')<br />
# or<br />
tu('(m^2*kg)/(A^2*s^3)')<br />
# angles <br />
tu('2*pi rad') # full circle<br />
# as gon<br />
tu('2*pi rad') / tu('gon')<br />
# more imperial<br />
tu('1fo+(3+7/16)in')<br />
# or <br />
tu('1\'+(3+7/16)"') # the ' we have to escape because of python<br />
# trigonometry<br />
tu('sin(pi)')<br />
# Using translated units as parameters, this command will create a 50.8mm x 20mm x 10mm box<br />
b = Part.makeBox(tu('2in'),tu('2m')/100,10)<br />
<br />
== Supported units ==<br />
Here the defined units in FreeCAD so far. It's easy to add a new user defined unit. The definition is here[http://free-cad.svn.sourceforge.net/viewvc/free-cad/trunk/src/Base/UnitsApi.l?view=markup]. <br />
<br />
Metric length<br />
"mm" 1.0; // millimeter (internal standard length)<br />
"m" 1000.0; // meter<br />
"cm" 10.0; // centimeter<br />
"dm" 100.0; // decimeter<br />
"km" 1000000.0; // kilometer<br />
Imperial lenth<br />
"in" "\"" 25.4; // inch<br />
"fo" "'" 304.8; // foot<br />
"th" 0.0254; // thou<br />
"yr" 914.4; // yard<br />
Metric mass<br />
"kg" 1.0; // kilogram (internal standard mass)<br />
"g" 0.001; // gram<br />
"mg" 0.000001; // milligram<br />
"t" 1000.0; // ton <br />
Imperial mass<br />
"lb" 0.45359237; // pound<br />
"oz" 0.45359237; // ounce<br />
"st" 6.35029318; // Stone<br />
"cwt" 50.80234544;// hundredweights<br />
Angle<br />
"deg" 1.0; // degree (internal standard angle)<br />
"rad" 180/M_PI; // radian <br />
"gon" 360.0/400.0;// gon <br />
Time<br />
"s" 1.0; // second (internal standard time)<br />
"min" 60.0; // minute<br />
"h" 3600.0; // hour <br />
Rest of SI<br />
"A" 1.0; // Ampere (internal standard electric current)<br />
"K" 1.0; // Kelvin (internal standard thermodynamic temperature)<br />
"cd" 1.0; // Candela (internal standard luminous intensity) <br />
"mol" 1.0; // Mole (internal standard amount of substance) <br />
Metric Volume<br />
"yl" 1.0; // microliter mm^3(derived standard volume)<br />
"ml" 1000.0; // milliliter cm^3 <br />
"l" 1000000.0; // Liter dm^3<br />
<br />
== Purpose and principles: proposal of an extension of the unit management system ==<br />
<br />
An extension unit management system is proposed in the following sections, developping the concept of ''unit system'', activated during a running FreeCAD instance.<br />
The interest in defining such a new concept is to work more easily with as many type of '''physical''' units as one wants (even user-created ones), without increasing the complexity of unit management for the user, nor for FreeCAD developpers.<br />
<br />
In short, event of unit scaling are localized precisely, and carried out in a generic fashion.<br />
<br />
Achieving such a flexibility is most notably required when one starts to deal with material properties that can have very different units, difficult to manage one by one manually.<br />
<br />
The reasoning proposed allows handling the units such as described in the [http://physics.nist.gov/cuu/pdf/sp811.pdf Guide for the Use of the International System of Units (SI)] and [http://physics.nist.gov/Pubs/SP330/sp330.pdf The International System of Units (SI)] both from NIST.<br />
<br />
In this proposal, one first recall in [[Units#Brainstorming|Brainstorming]] section what are the possible contexts for which unit management is required.<br />
<br />
In [[Units#Organizing|Organizing]] section, we present the data model retained to achieve unit management, based on 3 objects, the ''unit'', the ''unit dictionary'', and the ''unit system''.<br />
Finally, a short API of a 4th object called the ''unit manager'' is presented as well.<br />
<br />
== Outcome ==<br />
<br />
Thanks to this extension, one aims to ease unit scaling that can occurs between different business tasks. For instance, technical drawings can be done in standard unit system, while FE modelling can be managed in an unit system more suited for it.<br />
<br />
The exchange of data between these two kind of activities become easier with this extension.<br />
<br />
== Brainstorming ==<br />
<br />
In this section are highlighted the contexts of use of such an unit management system.<br />
From these contexts, we are then able to defined its technical specifications.<br />
<br />
Essentially 2 contexts are given as example.<br />
<br />
=== Context 1: opening a data file ===<br />
<br />
This case is probably the most frequent case.<br />
You receive a file containing for instance a geometrical model, or describing a material with quite a lot of properties. The geometrical model is expressed in meters, or the material properties according the international unit system.<br />
<br />
Too bad...<br />
<br />
You are an expert FE modelling, and you usually work with millimeter for length, MegaPascal for stress, tonne for mass...<br />
<br />
In this context, unit management is required to scale data from an initial unit system defined in the input file to a user-defined target unit system.<br />
<br />
=== Context 2: switching the unit system at runtime ===<br />
<br />
In this case, you can be at the same time the guy that carries out a drawing, and the guy that will manage the FE modelling. Similarly to the previous case, the unit systems for these 2 tasks are not the same, and you need to switch the initial unit system at runtime to your favorite one.<br />
<br />
== Organizing ==<br />
<br />
=== Logic of unit scaling ===<br />
<br />
In the [[Units#Brainstorming|Brainstorming]] section have been presented 2 contexts when using unit scaling.<br />
Some items should be highlighted from these two contexts.<br />
<br />
==== Unit coherence throughout the FreeCAD running instance ====<br />
<br />
The system proposed is based on a primary assumption: the user is working in a coherent unit system.<br />
For instance, this means that if the user expresses length in millimeters, necessarily areras will be expressed in terms of squared millimeters, not squared meters.<br />
This is '''hypothesis one'''.<br />
<br />
==== Unit system ====<br />
<br />
Because of ''hypothesis one'', it is possible and relevant to define an unit system.<br />
An unit system applies to:<br />
* a running FreeCAD instance into which you are working<br />
* or it may also apply globally to the content of an input file<br />
According [http://physics.nist.gov/cuu/pdf/sp811.pdf Guide for the Use of the International System of Units (SI)] from NIST, they are 7 physical base units.<br />
We chose to express a unit system in terms of these 7 base units.<br />
<br />
When working within an instance of FreeCAD, the user has thus to define first the unit system according to which she/he is working before she/he decides to switch to another unit system, or before importing data from an input file.<br />
<br />
This unit system will apply till the user decides to change it. If she/he does, all data with dimensions will be scaled.<br />
<br />
Considering ''hypothesis one'', all data that the user will input manually in FreeCAD are assumed to be coherent with the chosen unit system.<br />
<br />
The benefit to work with a ''unit system'' defined at a FreeCAD running instance level, or at data file level (instead of ''unit'' which are defined at the data level) is then that unit management is considerably simplified.<br />
<br />
Here are some examples of unit systems.<br />
* meter, kilogram, second, ampere, Kelvin, mole, candela<br />
* millimeter, tonne, millisecond, ampere, Kelvin, mole, candela<br />
* millimeter, kilogramme, millisecond, ampere, Kelvin, mole, candela<br />
*...<br />
<br />
==== Base and derived units ====<br />
<br />
Derived units are created by combination of base units. For instance, an acceleration (m/s) combines at the same time length and time. An interesting picture presenting the relationships between base and derived units can be seen [http://physics.nist.gov/cuu/pdf/SIDiagramColorAnnot.pdf here] also from NIST.<br />
<br />
Thanks to the definition of ''unit system'', it is possible for the user to work with any kind of derived units, without the need for FreeCAD developpers to foresee them in advance.<br />
<br />
==== Base and derived unit symbols ====<br />
<br />
According to [http://physics.nist.gov/Pubs/SP330/sp330.pdf The International System of Units (SI)], the symbols to specify a units are officially approved. Two consequences can be highlighted from this.<br />
* it is not easy for a computer program to work with unit symbols because some are greek letters for instance. Hence they can be a bit difficult to process by a program<br />
* while some units and their symbols can be used widely, they may be not approved officially, like for instance ''tonne'' unit (see p32 of [http://physics.nist.gov/Pubs/SP330/sp330.pdf The International System of Units (SI)])<br />
<br />
To overcome these limitations and remain flexible, the proposed system favors the use of unit magnitudes instead of unit symbols, which remain nonetheless available for an ergonomy reason.<br />
<br />
=== Data model ===<br />
<br />
The three core objects of the unit management system are presented, namely the ''unit'', the ''unit dictionary'' and the ''unit system''.<br />
<br />
==== Unit ====<br />
<br />
As a foreword, it is important to highlight that a ''unit'' object in itself only indicates a '''dimension''' like length, mass, time... It doesn't specify a '''magnitude''' like meter, millimeter, kilometer... This last information is specified through the unit system.<br />
<br />
===== Dimension =====<br />
<br />
Compulsory string indicating the ''dimension'' of the unit. The ''dimension'' of the 7 base units are indicated below (from [http://physics.nist.gov/cuu/pdf/sp811.pdf Guide for the Use of the International System of Units (SI)]).<br />
* LENGTH<br />
* MASS<br />
* TIME<br />
* ELECTRIC CURRENT<br />
* THERMODYNAMIC TEMPERATURE<br />
* AMOUNT OF SUBSTANCE<br />
* LUMINOUS INTENSITY<br />
<br />
''Dimension'' attribute allows identifying the unit.<br />
Two units cannot share the same ''dimension''.<br />
<br />
===== Signature =====<br />
<br />
Compulsory integer array of size 7 (number of base units) that defines what the unit is.<br />
The signature of the 7 base units are:<br />
* LENGTH: [1,0,0,0,0,0,0]<br />
* MASS: [0,1,0,0,0,0,0]<br />
* TIME: [0,0,1,0,0,0,0]<br />
* ELECTRIC CURRENT: [0,0,0,1,0,0,0]<br />
* THERMODYNAMIC TEMPERATURE: [0,0,0,0,1,0,0]<br />
* AMOUNT OF SUBSTANCE: [0,0,0,0,0,1,0]<br />
* LUMINOUS INTENSITY: [0,0,0,0,0,0,1]<br />
<br />
From these 7 units, we are then able to express all derived units defined in [http://physics.nist.gov/cuu/pdf/sp811.pdf Guide for the Use of the International System of Units (SI)] and create new ones as needed such as for instance:<br />
* MASS DENSITY: [-3,1,0,0,0,0,0]<br />
* AREA: [0,2,0,0,0,0,0]<br />
<br />
''Signature'' is the attribute thanks to which unit scaling can be achieved in a generic way.<br />
<br />
===== Symbols =====<br />
<br />
Array of [real, string] (meaning [''magnitude'', ''symbol'']) that lists all ''symbols'' known by FreeCAD.<br />
Thanks to this array, the unit scaling API becomes more ergonomic because ''symbols'' and related ''magnitudes'' are linked.<br />
<br />
This array can be extended as required.<br />
<br />
For instance, the list of ''symbols'' of the LENGTH unit, and their related ''magnitudes'' is:<br />
<br />
[1e+12,"Tm"],[1e+09,"Gm"],[1e+06,"Mm"],<br />
[1e+03,"km"],[1e+02,"hm"],[1e+01,"dam"],<br />
[1e+00,"m"],[1e-01,"dm"],[1e-02,"cm"],<br />
[1e-03,"mm"],[1e-06,"ym"],[1e-09,"nm"],<br />
[1e-12,"pm"],[1e-15,"fm"]<br />
<br />
Standard ''symbols'' can be found on [http://physics.nist.gov/cuu/Units/units.html NIST website] and p23 to 26 and p32 (''metric ton'' or ''tonne'') of [http://physics.nist.gov/Pubs/SP330/sp330.pdf The International System of Units (SI)].<br />
<br />
==== Unit dictionary ====<br />
<br />
All the units available in FreeCAD, and new ones created by the user, should be stored in ''unit dictionary'', which is an XML file (FreeCAD configuration file), so as to be retrieved when needed, i.e. when achieving unit scaling.<br />
<br />
===== Units =====<br />
<br />
Array of units, contained in the ''unit dictionary''.<br />
<br />
==== Unit system ====<br />
<br />
A ''unit system'' is the object that allows the user defining the current unit ''magnitude'' of each base units with which she/he is working.<br />
For instance, knowing that the user is working with millimeter, tonne, and second, thanks to the use of a unit system, FreeCAD can know that energy is expressed in terms of milliJoule, force in terms of Newton, and stress in terms of MegaPascal.<br />
Hence a unit system is only defined by a ''name'' (for instance ''Standard unit system'') and a ''magnitude table'' specifying for each of the 7 base units, what is its corresponding ''magnitude''.<br />
<br />
===== Name =====<br />
<br />
String allowing to the user identifying what is the unit system.<br />
<br />
===== Magnitudes =====<br />
<br />
By specifying the magnitude of the 7 base units, a unit system is defined.<br />
<br />
For instance [1e-03, 1e+03, 1, 1, 1, 1, 1], meaning millimeter, tonne, second, ampere, Kelvin, mole, candela<br />
<br />
==== Unit management API ====<br />
<br />
Only the logic of some methods is presented, in order to highlight some features.<br />
These methods could belong to an object called ''Unit manager''.<br />
<br />
===== Checking the unit dictionary =====<br />
<br />
====== isValid ======<br />
<br />
The unit dictionary can be an XML file (FreeCAD configuration file). It contains a list of defined units.<br />
Such a dictionary is required for the proposed unit management system to work.<br />
<br />
It must fulfills some conditions that should be checked before activating the unit management system.<br />
These conditions are:<br />
* check that all base units are defined<br />
* check that a ''dimension'' is not defined twice through the units<br />
* check that a ''symbol'' is not defined twice in all the existing symbols<br />
* check that the ''signatures'' of all units have all the same size<br />
* chacke that a ''standard symbol'' (for which ''magnitude'' is 1) is defined for all units<br />
<br />
====== isCompatibleWithThisSignature ======<br />
<br />
A unit dictionary defines a set of units and their known magnitudes.<br />
When managing a unit, it is relevant to check that its signature is compatible with the set of units registered in the unit dictionary, so as to process it.<br />
This check includes:<br />
* check that the input ''signature'' length is of the same size than the unit dictionary unit ''signatures''<br />
<br />
===== Scaling units =====<br />
<br />
====== scaleUnitFromSymbolToSymbol ======<br />
<br />
Knowing a value, an initial unit by its symbol, the target unit by its symbol, scale the value.<br />
<br />
====== scaleUnitFromSymbolToUnitSystem ======<br />
<br />
Knowing a value, an initial unit by its symbol, the target unit system, scale the value.<br />
<br />
====== scaleUnitFromUnitSystemToSymbol ======<br />
<br />
Knowing a value, an initial unit system, the target unit by its symbol, scale the value.<br />
<br />
==== Motivations for such a management: example of application ====<br />
<br />
Let's assume that we are going to setup a finite element model.<br />
To build our model, we need the mesh, material properties, and to define numerical parameters.<br />
Considering that they can be tens of material properties to manage, expressed with different units, sometimes not always very common, it is interesting for the user to only have to specify a global unit system, without caring much.<br />
<br />
FreeCAD would then just do the job.<br />
<br />
As FreeCAD developpers and FreeCAD users do not necessarily know all units that can be defined in the material property files, it is interesting to rely on a generic system.<br />
<br />
Let's assume that in such a file we have a fair number of exotic material properties expressed with exotic units, and that we want to work in a specific unit system.<br />
<br />
It is easy with the proposed extension to scale any of these properties by knowing their signatures, magnitudes, and the target unit system.<br />
<br />
<br />
For each of the properties, the scaling is obtained by multiplying the initial property value with the factor <math>\frac{initialMagnitude}{targetMagnitude}</math>.<br />
<br />
The ''targetMagnitude'' is then simply obtained with the operation <math>\prod_{bu} targetMagnitude_{bu}^{signature_{bu}}</math>, ''bu'' standing for ''base unit''.<br />
<br />
It becomes thus very easy to manage any number of properties with any kind of units with very few lines of Python.<br />
<br />
== Next actions ==<br />
<br />
* Review by other people<br />
* Check if the current unit management system can be extended with these new concepts (magnitude, signature, symbol table, unit system, unit dictionary...)<br />
* See with other people if the limitations of this system are acceptable:<br />
** offseting of values is not supported by this system. The only case I see where this need may arise is when switching from Kelvin to degree Celsius. I support to let the user doing it manually. The thing is that this conversion can be tricky: it is not compatible with the concept of global conversion as presented here (context 1 and context 2) because when switching from Kelvin to degree Celsius, data that express a difference should not be converted (see section 8.5, p24 of [http://physics.nist.gov/cuu/pdf/sp811.pdf Guide for the Use of the International System of Units (SI)] for more explanations). Another thing is that I don't know if such a conversion is needed. I don't need it<br />
** currency could have been added as a 8th base unit. However, I don't see the interest to be able to convert it: we would not be able to store magnitudes in a unit dictionary: those are fluctuating everyday! In addition, this unit is useless in FE modelling. Hence I propose to stick on the idea to manage ''physical units''. '''Caution''', it is not because this unit doesn't appear in the ''unit system'' object that it is not possible to convert it. It '''can''' be defined in the unit dictionary, along with symbols and magnitudes, and in the API, there will be methods to work with this information. It is just that when switching globally of unit system, the values with a currency unit will not be scaled, and the user will have to write a Python line herself/himself to scale this data if she/he wants to<br />
** it is the same limitation with dimensionless data like angles (combining length as <math>\frac{m}{m}</math>) or solid angles (combining length as <math>\frac{m^2}{m^2}</math>), that is to say which have no units. It is possible to handle them, but when switching of unit system, they won't be scaled, simply because there is no need to: their values are not affected by a change of base units<br />
* If ok, implement unit or unit system description in FreeCAD data files (those containing data with units, like files to store geometries and material properties)<br />
* Write FreeCAD XML unit dictionary<br />
* Implement unit system concept that has to be activated when running a FreeCAD instance, before carrying out unit scaling, or when importing data from a geometry file or material property file<br />
* Implement unit scaling when importing a file (geometry or material properties) (corresponding to context 1)<br />
* Implement "on demand" unit scaling when the user choses to switch from an initial unit system to a new target one (corresponding to context 2)<br />
<br />
<br />
{{languages | {{es|Units/es}} }}</div>Momentumv5https://wiki.freecad.org/index.php?title=Organization_chart&diff=8460Organization chart2011-11-24T12:56:36Z<p>Momentumv5: </p>
<hr />
<div>The following table shows who does what in the FreeCAD universe...<br />
<br />
{| class="orgchart"<br />
|+ '''FreeCAD software'''<br />
<br />
|- style="background: lightgrey"<br />
! Modules<br />
| FreeCAD base || Part || Mesh || Sketcher + PartDesign || Draft || Drawing || Arch<br />
|-<br />
|<br />
| jriegel, wmayer || wmayer || wmayer || jriegel, logari81, mrlukeparry, wmayer || yorikvanhavre || jriegel || yorikvanhavre<br />
<br />
|- style="background: lightgrey"<br />
! File formats <br />
| FcStd || Obj || Step + Iges || Dxf || IFC<br />
|-<br />
|<br />
| jriegel, wmayer || wmayer || jriegel, wmayer || yorikvanhavre, danielfalck || yorikvanhavre<br />
|}</div>Momentumv5https://wiki.freecad.org/index.php?title=Help_FreeCAD&diff=8459Help FreeCAD2011-11-24T12:34:42Z<p>Momentumv5: /* Program! */</p>
<hr />
<div>If you like FreeCAD and would like to help in its development, there are many things you can do, even if you are not a programmer. Actually, there are things to do for everyone: users, power users and developers:<br />
<br />
=== Work on the documentation ===<br />
<br />
Help us to build, correct and extend this documentation. Correct mistakes, extend or correct pages that are unclear, create new pages if a topic is missing, etc. To edit the wiki, you will need a [http://sourceforge.net SourceForge account], then, you can use the same login and password on this wiki. Then, ask on the forum or on the irc channel for write permission (the wiki is write-protected to avoid spamming). A couple of areas that would welcome your work:<br />
<br />
* The [[List of Commands]] page list and documents all of the FreeCAD commands. Most of them have few or no information at all. The [[Std_ViewScreenShot]] page is a good example of what every other command should like.<br />
* The [[Tutorials]] section is still very poor. If you developed something cool with FreeCAD, why not write there how you did it?<br />
<br />
=== Share your FreeCAD knowledge ===<br />
<br />
The users community around FreeCAD is still small, but already includes several advanced users who do a very important job in showing to newcomers how to use the software. If you begin to feel comfortable with FreeCAD, your knowledge could be very valuable to others, and you might<br />
contribute with important assets, like:<br />
* Showing the work you do with FreeCAD on this [http://sourceforge.net/apps/phpbb/free-cad/viewtopic.php?f=8&t=1222 forum thread]. You can post screenshots, and, even better, attach the FreeCAD files so other people can examine it and understand how you did it.<br />
* Recording [http://www.youtube.com/user/FreeCADNews videos] showing how you did something interesting in FreeCAD. These videos usually do a great job in showing new features.<br />
* Write [http://freecad-tutorial.blogspot.com/ tutorials] describing or teaching something interesting. You can write tutorials on your own blog, directly on our wiki, or even on the forum.<br />
<br />
=== Translate the documentation and FreeCAD itself ===<br />
<br />
* [[Localisation|Translate]] FreeCAD in your own language. All text of the FreeCAD interface can be easily translated in other languages. All we need is someone who know that other language and is willing to help! We currently have translation in english, german and french.<br />
* Translate the documentation: Translating this wiki is easy, you just need to add a /languagecode page to create a translation. For example, to translate the [[Part_Module]] page (its url ends with index.php?title=Part_Module) to french, you would just add /fr to the url, which will create a [[Part_Module/fr]] page. <br />
<br />
=== Help others to know FreeCAD ===<br />
<br />
* Talk about FreeCAD to other people who might be interested<br />
* Find interesting uses for FreeCAD, and document it, for example with screenshots. FreeCAD is very young, and not many people see what they can do with it. If you are a FreeCAD fan already, you surely know some cool thing FreeCAD can do. Help us to show that to others!<br />
* Hang on the forum, and help newcomers to solve basic questions<br />
* Write tutorials, record videos, etc... showing what you do with FreeCAD<br />
* Contribute with files, drawings, etc... We still lack good example files of what can be done with FreeCAD<br />
<br />
=== Report bugs and ask for interesting features ===<br />
<br />
<br />
The place to report bugs and suggest new features is the '''[http://sourceforge.net/apps/mantisbt/free-cad FreeCAD Tracker]'''. In order to save developers time (triaging and handling hard to understand bugs can be very time consuming), and avoid frustrations because your issue was not handled the way you would like, please read the following:<br />
<br />
* Bugs and features requests are handled in the same tracker. Just mark your issue as "bug" (something that doesn't work as it should) or "feature" (something that is not there but you think it would be good to have)<br />
* Although you can submit issues anonymously, please use your sourceforge account (create one if needed), so you can be notified when someone adds notes to the issue. In many cases, the person who will handle the bug will need more information from you.<br />
* When reporting a bug, the most important point is to allow developers to reproduce it. Be sure to include the exact steps needed to make the bug happen, so another person can do the same and see the bug happen on his machine too. If the developer cannot see the bug, he cannot solve it either.<br />
* Also include information that can help developers to situate the problem, like the operating system you are running FreeCAD on, the version of FreeCAD (for example 0.11) and the revision number (for example 4955). Both those numbers are available on the Help -> about FreeCAD dialog.<br />
* If you are not sure whether what you found is a bug or not, the best way is to head to the [http://apps.sourceforge.net/phpbb/free-cad/index.php forum] and discuss it there first.<br />
* Before submitting a feature request, it might also be a good idea to discuss it with other users on the [http://apps.sourceforge.net/phpbb/free-cad/index.php forum], so you might end up with a more solid proposal, with more chances to interest a developer to implement it.<br />
* Remember that FreeCAD is developed by volunteers who use their free time to work on it. Although everyone tries his best to make the best possible application, your bug report might be treated with low priority, or canceled if you cannot give sufficient information, and your feature request might be postponed or even refused if no developer has interest in implement it or if that would request unrealistic amount of work.<br />
<br />
=== Program! ===<br />
<br />
* If you know a bit of python language, program some useful [[Scripting|scripts]]. Maybe you want a small function that is missing? Or you feel bold enough to start to program some new tool? Look in the scripting section, or head to the forum and discuss your ideas, you will surely find plenty of help.<br />
* If you don't know python but would like to try, know that python is extremely easy and user-friendly, in fact it is a perfect language for someone who has never programmed before. With a bit of interest and dedication, you could be on tracks pretty quickly. Have a look at our [[Introduction to python]]!<br />
* If you know how to program in C++, then you are ready for bigger stuff. Head to the [[Developer hub]]!<br />
<br />
{{languages | {{es|Help_FreeCAD/es}} {{it|Help_FreeCAD/it}} {{se|Help_FreeCAD/se}} }}</div>Momentumv5https://wiki.freecad.org/index.php?title=Compiling&diff=8458Compiling2011-11-24T12:33:19Z<p>Momentumv5: </p>
<hr />
<div>Each operating system has its own page for compiling FreeCAD in the [[Online_Help_Toc|Online Help Documentation]]. <br />
{| align='center' width=50%<br />
|align=center|[[Image:Windows.png | alt='Windows' | link= CompileOnWindows]]<br />
|align=center|[[Image:Linux.png | alt='Linux' | link = CompileOnUnix]]<br />
|align=center|[[Image:Mac.png | alt='Mac' | link= CompileOnMac]] <br />
|-<br />
|align=center|[[CompileOnWindows|Compile on Windows]]<br />
|align=center|[[CompileOnUnix | Compile on Linux/Unix]]<br />
|align=center|[[CompileOnMac | Compile on Mac]]<br />
|}</div>Momentumv5https://wiki.freecad.org/index.php?title=Compiling&diff=8457Compiling2011-11-24T12:29:47Z<p>Momentumv5: </p>
<hr />
<div>Each operating system has its own discussion of compiling FreeCAD. <br />
{| align='center' width=50%<br />
|align=center|[[Image:Windows.png | alt='Windows' | link= CompileOnWindows]]<br />
|align=center|[[Image:Linux.png | alt='Linux' | link = CompileOnUnix]]<br />
|align=center|[[Image:Mac.png | alt='Mac' | link= CompileOnMac]] <br />
|-<br />
|align=center|[[CompileOnWindows|Compile on Windows]]<br />
|align=center|[[CompileOnUnix | Compile on Linux/Unix]]<br />
|align=center|[[CompileOnMac | Compile on Mac]]<br />
|}</div>Momentumv5https://wiki.freecad.org/index.php?title=Installing_additional_components&diff=8456Installing additional components2011-11-24T12:22:04Z<p>Momentumv5: fix qt wikipedia link</p>
<hr />
<div>==Choose Your Operating System==<br />
FreeCAD is a truly multi-platform application, developed with the world-renowned [http://en.wikipedia.org/wiki/Qt_(framework) Qt] framework. What that means is that FreeCAD looks and acts the same on Windows, Linux and Mac. However, the installation procedure is a little different for each Operating system. Choose your Operating system below for more details about how to install FreeCAD.<br />
{| align='center' width=50%<br />
|align=center|[[Image:Windows.png | alt='Windows' | link= Install on Windows]]<br />
|align=center|[[Image:Linux.png | alt='Linux' | link = Install on Unix]]<br />
|align=center|[[Image:Mac.png | alt='Mac' | link= Install on Mac]] <br />
|-<br />
|align=center|[[Install on Windows]]<br />
|align=center|[[Install on Unix | Install on Linux/Unix]]<br />
|align=center|[[Install on Mac]]<br />
|}<br />
<br />
{{Docnav|About FreeCAD|Getting started}}</div>Momentumv5https://wiki.freecad.org/index.php?title=Online_Help_Startpage&diff=8455Online Help Startpage2011-11-24T12:16:32Z<p>Momentumv5: /* Contribute */</p>
<hr />
<div>[[Image:Crystal_Clear_app_tutorials.png|right|150]]<br />
== Welcome to the FreeCAD on-line help ==<br />
<br />
This document has been automatically created from the contents of the official FreeCAD wiki documentation, which can be read online at http://apps.sourceforge.net/mediawiki/free-cad/index.php?title=Main_Page . Since the wiki is actively maintained and continuously developed by the FreeCAD community of developers and users, you may find that the online version contains more or newer information than this document. There you will also find in-progress translations of this documentation in several languages. But neverthless, we hope you will find here all information you need. In case you have questions you can't find answers for in this document, have a look on the [https://apps.sourceforge.net/phpbb/free-cad/index.php FreeCAD forum], where you can maybe find your question answered, or someone able to help you.<br />
<br />
=== How to use ===<br />
<br />
This document is divided into several sections: introduction, usage, scripting and development, the last three address specifically the three broad categories of users of FreeCAD: end-users, who simply want to use the program, power-users, who are interested by the scripting capabilities of FreeCAD and would like to customize some of its aspects, and developers, who consider FreeCAD as a base for developing their own applications. If you are comletely new to FreeCAD, we suggest you to start simply from the introduction.<br />
<br />
=== Contribute ===<br />
<br />
As you may have experienced sometimes, programmers are really bad help writers! For them it is all completely clear because they made it that way. Therefore it's vital that experienced users help us to write and revise the documentation. Yes, we mean you! How, you might ask? Just go to the Wiki at http://apps.sourceforge.net/mediawiki/free-cad/index.php in the User section. You will need a [http://sourceforge.net/ sourceforge account] to log in, and then ask on the forum or on the irc channel for write permission (the wiki is write-protected to avoid spamming). Then you can start editing! Also, check out the page at https://sourceforge.net/apps/mediawiki/free-cad/index.php?title=Help_FreeCAD for more ways you can help FreeCAD.<br />
<br />
{{docnav|Online Help Toc|About FreeCAD}}<br />
<br />
{{languages | {{cn|Online_Help_Startpage/cn}} {{de|Online_Help_Startpage/de}} {{es|Online_Help_Startpage/es}} {{fr|Online Help Toc/fr}} {{it|Online_Help_Startpage/it}} {{pl|Online_Help_Startpage/pl}} {{ru|Online_Help_Startpage/ru}} {{se|Online_Help_Startpage/se}} {{tr|Online_Help_Startpage/tr}} }}<br />
<br />
[[Category:User_Documentation]]</div>Momentumv5https://wiki.freecad.org/index.php?title=Installing_on_Mac&diff=8454Installing on Mac2011-11-24T03:09:13Z<p>Momentumv5: </p>
<hr />
<div>FreeCAD can be installed on Mac OS X in one step using the Installer. <br><br />
{{DownloadMacStable}}<br><br />
This page describes the usage and features of the FreeCAD installer. It also includes uninstallation instructions.<br />
Once installed, you can [[Getting started |get started]]!<br />
<br />
=== Simple Installation ===<br />
The FreeCAD installer is provided as a Installer package (.mpkg) enclosed in a disk image file.<br />
<br />
You can download the latest installer from the [[Download]] page. After downloading the file, just mount the disk image, then run the '''Install FreeCAD''' package.<br />
<br />
[[File:mac_installer_1.png]]<br />
<br />
The installer will present you with a '''Customize Installation''' screen that lists the packages that will be installed. If you know that you already have any of these packages, you can deselect them using the checkboxes. If you're not sure, just leave all items checked.<br />
<br />
[[File:mac_installer_2.png]]<br />
<br />
=== Uninstallation ===<br />
<br />
There currently isn't an uninstaller for FreeCAD. To completely remove FreeCAD and all installed components, drag the following files and folders to the Trash:<br />
<br />
*In /Applications:<br />
**FreeCAD<br />
<br />
*in /Library/Frameworks/<br />
**SoQt.framework<br />
**Inventor.framework<br />
<br />
Then, from the terminal, run:<br />
<br />
sudo /Developer/Tools/uninstall-qt.py<br />
sudo rm -R /usr/local/lib/OCC<br />
sudo rm -R /usr/local/include/OCC<br />
<br />
That's it. Eventually, FreeCAD will be available as a self-contained application bundle so all this hassle will go away.<br />
<br />
{{docnav|Install on Unix|Getting started}}<br />
<br />
{{Languages | {{cn|Install on Mac/cn}} {{de|Install on Mac/de}} {{es|Install on Mac/es}} {{fr|Install on Mac/fr}} {{pl|Install on Mac/pl}} {{ru|Install on Mac/ru}} {{se|Install on Mac/se}} }}<br />
<br />
[[Category:User Documentation]]</div>Momentumv5https://wiki.freecad.org/index.php?title=Installing_on_Windows&diff=8452Installing on Windows2011-11-24T03:02:28Z<p>Momentumv5: </p>
<hr />
<div>The easiest way to install FreeCAD on Windows is to download the installer below. <br><br />
{{DownloadWindowsStable}}<br />
<br />
After downloading the .msi (Microsoft Installer) file, just double-click on it to start the installation process.<br />
<br />
Below is more information about technical options. If it looks daunting, don't worry! Most Windows users will not need anything more than the .msi to install FreeCAD and '''[[Getting started | Get started]]'''!<br />
<br />
<br />
=== Simple Microsoft Installer Installation ===<br />
The easiest way to '''install FreeCAD on Windows''' is by using the installer above. This page describes the usage and the features of the ''Microsoft Installer'' for more installation options.<br />
<br />
If you would like to download either a 64 bit or unstable development version, see the [[Download]] page.<br />
<br />
<br />
=== Command Line Installation ===<br />
With the ''msiexec.exe'' command line utility, additional features are available, like non-interactive installation and administrative installation.<br />
<br />
==== Non-interactive Installation ====<br />
With the command line<br />
<br />
msiexec /i FreeCAD<version>.msi<br />
<br />
installation can be initiated programmatically. Additional parameters can be passed at the end of this command line, like<br />
<br />
msiexec /i FreeCAD-2.5.msi TARGETDIR=r:\FreeCAD25<br />
<br />
==== Limited user interface ====<br />
The amount of user interface that installer displays can be controlled with /q options, in particular:<br />
<br />
* /qn - No interface<br />
* /qb - Basic interface - just a small progress dialog<br />
* /qb! - Like /qb, but hide the Cancel button<br />
* /qr - Reduced interface - display all dialogs that don't require user interaction (skip all modal dialogs)<br />
* /qn+ - Like /qn, but display "Completed" dialog at the end<br />
* /qb+ - Like /qb, but display "Completed" dialog at the end <br />
<br />
==== Target directory ====<br />
The property TARGETDIR determines the root directory of the FreeCAD installation. For example, a different installation drive can be specified with<br />
<br />
TARGETDIR=R:\FreeCAD25<br />
<br />
The default TARGETDIR is [WindowsVolume\Programm Files\]FreeCAD<version>.<br />
<br />
==== Installation for All Users ====<br />
Adding<br />
<br />
ALLUSERS=1<br />
<br />
causes an installation for all users. By default, the non-interactive installation install the package just for the current user, and the interactive installation offers a dialog which defaults to "all users" if the user is sufficiently privileged.<br />
<br />
==== Feature Selection ====<br />
A number of properties allow selection of features to be installed, reinstalled, or removed. The set of features for the FreeCAD installer is<br />
<br />
* DefaultFeature - install the software proper, plus the core libraries<br />
* Documentation - install documentation<br />
* Source code - install the sources <br />
* ... ToDo<br />
<br />
In addition, ALL specifies all features. All features depend on DefaultFeature, so installing any feature automatically installs the default feature as well. The following properties control features to be installed or removed<br />
<br />
* ADDLOCAL - list of feature to be installed on the local machine<br />
* REMOVE - list of features to be removed<br />
* ADDDEFAULT - list of features added in their default configuration (which is local for all FreeCAD features)<br />
* REINSTALL - list of features to be reinstalled/repaired<br />
* ADVERTISE - list of feature for which to perform an advertise installation <br />
<br />
There are a few additional properties available; see the MSDN documentation for details.<br />
<br />
With these options, adding<br />
<br />
ADDLOCAL=Extensions<br />
<br />
installs the interpreter itself and registers the extensions, but does not install anything else.<br />
<br />
=== Uninstallation ===<br />
With<br />
<br />
msiexec /x FreeCAD<version>.msi<br />
<br />
FreeCAD can be uninstalled. It is not necessary to have the MSI file available for uninstallation; alternatively, the package or product code can also be specified. You can find the product code by looking at the properties of the Uninstall shortcut that FreeCAD installs in the start menu.<br />
<br />
=== Administrative installation ===<br />
With<br />
<br />
msiexec /a FreeCAD<version>.msi<br />
<br />
an "administrative" (network) installation can be initiated. The files get unpacked into the target directory (which should be a network directory), but no other modification is made to the local system. In addition, another (smaller) msi file is generated in the target directory, which clients can then use to perform a local installation (future versions may also offer to keep some features on the network drive altogether).<br />
<br />
Currently, there is no user interface for administrative installations, so the target directory must be passed on the command line.<br />
<br />
There is no specific uninstall procedure for an administrative install - just delete the target directory if no client uses it anymore.<br />
<br />
=== Advertisement ===<br />
With<br />
<br />
msiexec /jm FreeCAD<version>.msi<br />
<br />
it would be possible, in principle, to "advertise" FreeCAD to a machine (with /ju to a user). This would cause the icons to appear in the start menu, and the extensions to become registered, without the software actually being installed. The first usage of a feature would cause that feature to be installed.<br />
<br />
The FreeCAD installer currently supports just advertisement of start menu entries, but no advertisement of shortcuts.<br />
<br />
=== Automatic Installation on a Group of Machines ===<br />
With Windows Group Policy, it is possible to automatically install FreeCAD an a group of machines. To do so, perform the following steps:<br />
#Log on to the domain controller<br />
#Copy the MSI file into a folder that is shared with access granted to all target machines.<br />
#Open the MMC snapin "Active Directory users and computers"<br />
#Navigate to the group of computers that need FreeCAD<br />
#Open Properties<br />
#Open Group Policies<br />
#Add a new policy, and edit it<br />
#In Computer Configuration/Software Installation, choose New/Package<br />
#Select the MSI file through the network path<br />
#Optionally, select that you want the FreeCAD to be deinstalled if the computer leaves the scope of the policy. <br />
<br />
Group policy propagation typically takes some time - to reliably deploy the package, all machines should be rebooted.<br />
<br />
=== Installation on Linux using Crossover Office ===<br />
<br />
You can install the windows version of FreeCAD on a Linux system using ''CXOffice 5.0.1''. Run ''msiexec'' from the CXOffice command line, assuming that the install package is placed in the "software" directory which is mapped to the drive letter "Y:":<br />
msiexec /i Y:\\software\\FreeCAD<version>.msi<br />
FreeCAD is running, but it has been reported that the OpenGL display does not work, like with other programs running under [[wikipedia:Wine (software)|Wine]] i.e. Google [[wikipedia:SketchUp|SketchUp]].<br />
<br />
{{docnav|Feature list|Install on Unix}}<br />
<br />
{{Languages | {{cn|Install_on_Windows/cn}} {{de|Install_on_Windows/de}} {{es|Install_on_Windows/es}} {{fr|Install_on_Windows/fr}} {{pl|Install_on_Windows/pl}} {{ru|Install_on_Windows/ru}} {{se|Install_on_Windows/se}} }}<br />
<br />
[[Category:User Documentation]]</div>Momentumv5https://wiki.freecad.org/index.php?title=Installing_on_Windows&diff=8448Installing on Windows2011-11-24T02:44:32Z<p>Momentumv5: The navigation is a little screwy b/c there's the path given through the help TOC, and also a semi-parallel path inspired by the home page sidebar links</p>
<hr />
<div>The easiest way to '''install FreeCAD on Windows''' is by using the installer. This page describes the usage and the features of the ''Microsoft Installer'' for more installation options.<br />
<br />
=== Simple Installation ===<br />
{{DownloadWindowsStable}}<br />
<br />
If you would like to download a 64 bit or unstable development version, see the [[Download]] page.<br />
<br />
After downloading the .msi (Microsoft Installer) file, just double-click on it to start the installation process.<br />
<br />
Below is more information about technical options. If it looks daunting, don't worry! Most Windows users will not need anything more than the .msi to install FreeCAD and '''[[Getting started | Get started]]'''!<br />
<br />
=== Command Line Installation ===<br />
With the ''msiexec.exe'' command line utility, additional features are available, like non-interactive installation and administrative installation.<br />
<br />
==== Non-interactive Installation ====<br />
With the command line<br />
<br />
msiexec /i FreeCAD<version>.msi<br />
<br />
installation can be initiated programmatically. Additional parameters can be passed at the end of this command line, like<br />
<br />
msiexec /i FreeCAD-2.5.msi TARGETDIR=r:\FreeCAD25<br />
<br />
==== Limited user interface ====<br />
The amount of user interface that installer displays can be controlled with /q options, in particular:<br />
<br />
* /qn - No interface<br />
* /qb - Basic interface - just a small progress dialog<br />
* /qb! - Like /qb, but hide the Cancel button<br />
* /qr - Reduced interface - display all dialogs that don't require user interaction (skip all modal dialogs)<br />
* /qn+ - Like /qn, but display "Completed" dialog at the end<br />
* /qb+ - Like /qb, but display "Completed" dialog at the end <br />
<br />
==== Target directory ====<br />
The property TARGETDIR determines the root directory of the FreeCAD installation. For example, a different installation drive can be specified with<br />
<br />
TARGETDIR=R:\FreeCAD25<br />
<br />
The default TARGETDIR is [WindowsVolume\Programm Files\]FreeCAD<version>.<br />
<br />
==== Installation for All Users ====<br />
Adding<br />
<br />
ALLUSERS=1<br />
<br />
causes an installation for all users. By default, the non-interactive installation install the package just for the current user, and the interactive installation offers a dialog which defaults to "all users" if the user is sufficiently privileged.<br />
<br />
==== Feature Selection ====<br />
A number of properties allow selection of features to be installed, reinstalled, or removed. The set of features for the FreeCAD installer is<br />
<br />
* DefaultFeature - install the software proper, plus the core libraries<br />
* Documentation - install documentation<br />
* Source code - install the sources <br />
* ... ToDo<br />
<br />
In addition, ALL specifies all features. All features depend on DefaultFeature, so installing any feature automatically installs the default feature as well. The following properties control features to be installed or removed<br />
<br />
* ADDLOCAL - list of feature to be installed on the local machine<br />
* REMOVE - list of features to be removed<br />
* ADDDEFAULT - list of features added in their default configuration (which is local for all FreeCAD features)<br />
* REINSTALL - list of features to be reinstalled/repaired<br />
* ADVERTISE - list of feature for which to perform an advertise installation <br />
<br />
There are a few additional properties available; see the MSDN documentation for details.<br />
<br />
With these options, adding<br />
<br />
ADDLOCAL=Extensions<br />
<br />
installs the interpreter itself and registers the extensions, but does not install anything else.<br />
<br />
=== Uninstallation ===<br />
With<br />
<br />
msiexec /x FreeCAD<version>.msi<br />
<br />
FreeCAD can be uninstalled. It is not necessary to have the MSI file available for uninstallation; alternatively, the package or product code can also be specified. You can find the product code by looking at the properties of the Uninstall shortcut that FreeCAD installs in the start menu.<br />
<br />
=== Administrative installation ===<br />
With<br />
<br />
msiexec /a FreeCAD<version>.msi<br />
<br />
an "administrative" (network) installation can be initiated. The files get unpacked into the target directory (which should be a network directory), but no other modification is made to the local system. In addition, another (smaller) msi file is generated in the target directory, which clients can then use to perform a local installation (future versions may also offer to keep some features on the network drive altogether).<br />
<br />
Currently, there is no user interface for administrative installations, so the target directory must be passed on the command line.<br />
<br />
There is no specific uninstall procedure for an administrative install - just delete the target directory if no client uses it anymore.<br />
<br />
=== Advertisement ===<br />
With<br />
<br />
msiexec /jm FreeCAD<version>.msi<br />
<br />
it would be possible, in principle, to "advertise" FreeCAD to a machine (with /ju to a user). This would cause the icons to appear in the start menu, and the extensions to become registered, without the software actually being installed. The first usage of a feature would cause that feature to be installed.<br />
<br />
The FreeCAD installer currently supports just advertisement of start menu entries, but no advertisement of shortcuts.<br />
<br />
=== Automatic Installation on a Group of Machines ===<br />
With Windows Group Policy, it is possible to automatically install FreeCAD an a group of machines. To do so, perform the following steps:<br />
#Log on to the domain controller<br />
#Copy the MSI file into a folder that is shared with access granted to all target machines.<br />
#Open the MMC snapin "Active Directory users and computers"<br />
#Navigate to the group of computers that need FreeCAD<br />
#Open Properties<br />
#Open Group Policies<br />
#Add a new policy, and edit it<br />
#In Computer Configuration/Software Installation, choose New/Package<br />
#Select the MSI file through the network path<br />
#Optionally, select that you want the FreeCAD to be deinstalled if the computer leaves the scope of the policy. <br />
<br />
Group policy propagation typically takes some time - to reliably deploy the package, all machines should be rebooted.<br />
<br />
=== Installation on Linux using Crossover Office ===<br />
<br />
You can install the windows version of FreeCAD on a Linux system using ''CXOffice 5.0.1''. Run ''msiexec'' from the CXOffice command line, assuming that the install package is placed in the "software" directory which is mapped to the drive letter "Y:":<br />
msiexec /i Y:\\software\\FreeCAD<version>.msi<br />
FreeCAD is running, but it has been reported that the OpenGL display does not work, like with other programs running under [[wikipedia:Wine (software)|Wine]] i.e. Google [[wikipedia:SketchUp|SketchUp]].<br />
<br />
{{docnav|Feature list|Install on Unix}}<br />
<br />
{{Languages | {{cn|Install_on_Windows/cn}} {{de|Install_on_Windows/de}} {{es|Install_on_Windows/es}} {{fr|Install_on_Windows/fr}} {{pl|Install_on_Windows/pl}} {{ru|Install_on_Windows/ru}} {{se|Install_on_Windows/se}} }}<br />
<br />
[[Category:User Documentation]]</div>Momentumv5https://wiki.freecad.org/index.php?title=Download&diff=8447Download2011-11-24T02:23:05Z<p>Momentumv5: minor reworking of download section</p>
<hr />
<div>There are several '''downloads''' for various operating systems available. Before downloading keep in mind: <br />
{{VeryImportantMessage|'''FreeCAD is still in ALPHA state and not ready for production use'''}}<br />
<br />
== official FreeCAD installers ==<br />
<br />
The FreeCAD team provides ready-to-install packages for [[Image:windows.png|16px]] '''Windows''' (XP, Vista and 7, 32 and 64bits), [[Image:mac.png|16px]] '''Mac OS X''' (Snow Leopard 10.6), and [[Image:linux.png|16px]] '''Debian-based Linux systems''' (Debian, Ubuntu, 32 and 64bits). Usually we provide '''stable''' packages, based on the latest stable release, and '''unstable''' packages, that provide the bleeding-edge new features being worked on, but might crash more often or contain features that are incompatible with earlier versions.<br />
{|<br />
|{{DownloadWindowsStable}} || || {{DownloadUnixStable}} || || {{DownloadMacStable}}<br />
|}<br />
Check the official [http://sourceforge.net/projects/free-cad/files/ FreeCAD Files page] to download 64 bit, older, or unstable releases.<br />
<br />
====Notes for Windows users====<br />
<br />
The windows installer should also work on older Windows platforms, but has not always been tested. You need ''Windows Installer V1'' on your system (msiexec.exe). See [[Install on Windows|Installing on Windows]] for details about different installation options. Download the latest .msi file for windows systems, or the appropriate .deb file for your version of Ubuntu or Debian.<br />
<br />
====Notes for Linux users====<br />
<br />
On most recent distributions such as Debian, Ubuntu or Arch, FreeCAD is included in the official distribution's packages repository, and you are advised to preferably get FreeCAD from there, to make sure you have a version that is 100% compatible with your system. The pivy python module (usually named python-pivy) is needed by FreeCAD from version 0.9 or above. If it is not available on your system, you must download it from here too.<br />
<br />
====Notes for Mac users====<br />
<br />
We rely on very few people to help building Mac OSX packages, so it doesn't get updated as often as the other platforms. The version available on this site might be slightly outdated.<br />
(To compile the most up-to-date version from source see [[CompileOnMac]])<br />
<br />
== Ubuntu PPA packages ==<br />
<br />
The [https://launchpad.net/~freecad-maintainers FreeCAD Launchpad team] has set up two PPA (Personal Package Archive) repositories that allow easy install of Ubuntu packages based on the development branch. Updates to the software are pushed to the Ubuntu Update Manager, which makes it the easiest way to get the latest FreeCAD build.<br />
<br />
* [https://launchpad.net/~freecad-maintainers/+archive/freecad-daily FreeCAD Daily Builds]: an automatic daily build system, which can provide you with a fresh, daily-up-to-date version of FreeCAD. Please be advised that the packages from this bleeding edge PPA may be broken from time to time.<br />
* [https://launchpad.net/~freecad-maintainers/+archive/freecad-dev FreeCAD Devel]: packages available through this PPA are actually copied from the Daily Builds PPA but are summarily tested beforehand. Update schedule is slower, and varies from 1-3 weeks.<br />
<br />
Current supported architectures and versions are:<br />
<br />
* Ubuntu 10.04 LTS (Lucid Lynx) 32 & 64-Bit<br />
* Ubuntu 10.10 (Maverick Meerkat) 32 & 64-Bit<br />
* Ubuntu 11.04 (Natty Narwhal) 32 & 64-Bit<br />
<br />
==== Adding the PPA and installing FreeCAD from the console ====<br />
<br />
Type (or copy-paste) these commands in a console to add the PPA and install FreeCAD along with the documentation:<br />
<br />
For FreeCAD Daily Builds:<br />
sudo add-apt-repository ppa:freecad-maintainers/freecad-daily<br />
For FreeCAD Devel:<br />
sudo add-apt-repository ppa:freecad-maintainers/freecad-dev<br />
Then:<br />
sudo apt-get update<br />
sudo apt-get upgrade<br />
sudo apt-get install freecad freecad-doc<br />
<br />
==== Adding the PPA and installing FreeCAD from the GUI ====<br />
<br />
Add to your system's Software Sources one of the following PPA (read [http://askubuntu.com/questions/4983/what-are-ppas-and-how-do-i-use-them/5102#5102%29 What are PPAs and how do I use them?] if you don't know how):<br />
<br />
* For FreeCAD Daily Builds: '''ppa:freecad-maintainers/freecad-daily'''<br />
* For FreeCAD Devel: '''ppa:freecad-maintainers/freecad-dev'''<br />
<br />
When a dialog window asks you to refresh your software sources, click OK.<br />
<br />
Now you can install FreeCAD and FreeCAD documentation through the Ubuntu Software Center, or your package manager of choice.<br />
<br />
== Alternative FreeCAD builds ==<br />
<br />
These are versions of FreeCAD built by other persons and not officially maintained by the FreeCAD team. They may include customized parts or be optimized for certain types of processors, or other modifications that the package maintainers judged necessary. But they are also sometimes better suited for certain operating systems. Note that on most common linux distributions, official packages are typically installed by the system's package management tool, so you don't need to download and install FreeCAD manually.<br />
<br />
*[http://packages.debian.org/freecad Official Debian package]<br />
*[http://packages.ubuntu.com/freecad Official Ubuntu package]<br />
*[http://software.opensuse.org/search?q=freecad&baseproject=openSUSE%3A11.4&lang=en&exclude_debug=true Official OpenSuse package]<br />
*[http://www.softpedia.com/get/Multimedia/Graphic/Graphic-Editors/FreeCAD.shtml Softpedia Windows build]<br />
*[http://packman.links2linux.de/package/FreeCAD Packman RPM package (for opensuse, fedora)]<br />
*[http://slackbuilds.org/repository/13.37/graphics/FreeCAD/ Slackbuilds package (for Slackware)]<br />
*[http://aur.archlinux.org/packages.php?K=freecad ArchLinux AUR package]<br />
*[http://packages.gentoo.org/package/media-gfx/freecad Gentoo ebuild package]<br />
*[https://svn.pardus.org.tr/pardus/playground/kaan.aksit/2011/freecad/actions.py Pardus linux build script]<br />
<br />
== FreeCAD documentation ==<br />
<br />
The user documentation of FreeCAD is being written together by the developers and the users community, on this wiki site. The best way is to read it online, so you are sure to get the latest version:<br />
<br />
* [[Online Help Toc|The FreeCAD Manual]]<br />
<br />
The manual can also be displayed as one big text, so you can print it or save it as a pdf file:<br />
<br />
* [[Manual|All-in-one printable version]]<br />
<br />
The manual is also be compiled as a qt help file, so it can be browsed offline with the Qt help viewer. This is usually made at each release and is available together with FreeCAD package on most linux software repositories (on debian/ubuntu-based systems, look for '''freecad-doc''' package) and is also bundled in the windows installer. To access it, simply open the "help" menu inside FreeCAD, or use the "What's this?" button.<br />
<br />
For convenience, we also provide a pdf version of this manual:<br />
<br />
* [http://yorik.uncreated.net/archive/freecad010.pdf 0.10 Manual (Pdf file)]<br />
* [http://yorik.uncreated.net/scripts/freecad011.pdf 0.11 Manual (Pdf file)]<br />
<br />
Here you can also find a copy of the OpenCasCade 5.2 docs, in a .chm file. After 5.2, the openCasCade documentation is not available as a single file anymore, but as a heavy 180Mb package. So, since there is little change, we keep this one around for convenience:<br />
<br />
*[http://www.4shared.com/file/128871432/96b15e62/occ52.html OpenCasCADE 5.2 documentation]<br />
<br />
== FreeCAD Source package ==<br />
<br />
For all other platforms you need to compile FreeCAD on your own from the Source package. You might also want to compile FreeCAD yourself if you want to optimize certain things, or customize certain parts of FreeCAD. Instructions for compiling can be found on the [[CompileOnWindows]], [[CompileOnMac]] and [[CompileOnUnix]] pages. You can grab a zip or tar.gz file containing the latest official version here (look for the latest version for your system):<br />
<br />
*[http://sourceforge.net/projects/free-cad/files/ official FreeCAD Files repository]<br />
<br />
Alternatively, you can also download latest source code from the SVN repository. You'll get a more recent version, but it might contain bugs or even fail to compile. Instructions for accessing the SVN repository can be found here:<br />
<br />
*[http://sourceforge.net/svn/?group_id=49159 FreeCAD SVN repository]<br />
<br />
You can also download automatically a GNU tarball from the latest source code tree or any part of it by using the code browser and clicking the "Download GNU tarball" at any time. The trunk folder contains the current development version, while the branches folder contains a snapshot of all stable releases to date.<br />
<br />
*[http://free-cad.svn.sourceforge.net/viewvc/free-cad/ FreeCAD SVN browser]<br />
<br />
== FreeCAD LibPack ==<br />
<br />
To collect all the needed libraries to compile FreeCAD can be a time consuming task. So we deliver a convenient package for development on Windows (VS8) with all needed libraries. You can download the latest version of the libpack from<br />
<br />
*[http://sourceforge.net/project/showfiles.php?group_id=49159&package_id=157551 FreeCAD LibPack]<br />
<br />
For linux, you will normally find all necessary libraries in your software management system, so you should just read the [[CompileOnUnix]] page.<br />
<br />
== Additional modules ==<br />
<br />
There are additional modules, addons of plugins for FreeCAD developed outside of the main FreeCAD development team. They are listed here but are not officially supported by the FreeCAD team.<br />
<br />
*[http://ja.orgfree.com/freecad.htm Fold module]: a module in development for working with metal sheets.<br />
*[http://gitorious.org/freecad-ship Ship module]: a module in development for ship design.<br />
<br />
{{Languages| {{de|Download/de}} {{es|Download/es}} {{fr|Download/fr}} {{ru|Download/ru}} {{se|Download/se}} }}<br />
<br />
[[Category:User Documentation]]</div>Momentumv5https://wiki.freecad.org/index.php?title=Installing_additional_components&diff=8440Installing additional components2011-11-24T01:56:11Z<p>Momentumv5: The original page was just a mashing together of three different installation pages. This reorganizes it as more of a helping the user along.</p>
<hr />
<div>==Choose Your Operating System==<br />
FreeCAD is a truly multi-platform application, developed with the world-renowned [http://en.wikipedia.org/wiki/Qt Qt] framework. What that means is that FreeCAD looks and acts the same on Windows, Linux and Mac. However, the installation procedure is a little different for each Operating system. Choose your Operating system below for more details about how to install FreeCAD.<br />
{| align='center' width=50%<br />
|align=center|[[Image:Windows.png | alt='Windows' | link= Install on Windows]]<br />
|align=center|[[Image:Linux.png | alt='Linux' | link = Install on Unix]]<br />
|align=center|[[Image:Mac.png | alt='Mac' | link= Install on Mac]] <br />
|-<br />
|align=center|[[Install on Windows]]<br />
|align=center|[[Install on Unix | Install on Linux/Unix]]<br />
|align=center|[[Install on Mac]]<br />
|}<br />
<br />
{{Docnav|About FreeCAD|Getting started}}</div>Momentumv5