File Format FCStd/fr: Difference between revisions

From FreeCAD Documentation
(Created page with "*'''Document.xml''' : contient tous les renseignements relatifs aux objets constituants votre projet. **Exemple avec '''Text004'''")
(Updating to match new version of source page)
 
(128 intermediate revisions by 5 users not shown)
Line 1: Line 1:
<languages/>
Un projet FreeCAD, est en fait une série de fichiers texte normaux, qui contiennent toujours un fichier document '''[http://fr.wikipedia.org/wiki/Extensible_Markup_Language .xml]''', '''GuiDocument.xml Document.xml ''' et, éventuellement plusieurs fichiers de données '''PartShape3.brp Points3 . . .''', plus une vignette au format [http://fr.wikipedia.org/wiki/Portable_Network_Graphics .PNG] le tout étant compressé en un fichier [http://fr.wikipedia.org/wiki/ZIP_(format_de_fichier) .zip] auquel on remplace l'extension en '''.FCStd'''.
{{TOCright}}

<span id="Overview"></span>
== Présentation ==

Le '''format de fichier''' ({{FileName|.FCStd}}) est le format de fichier principal de FreeCAD. Il s’agit d’un format conteneur prenant en charge la compression et l’incorporation de différents types de données.

<span id="Internals_of_.FCStd_files"></span>
==Contenu d'un fichier .FCStd==

FCStd est un [[#Structure_typique|fichier zip standard contenant un ou plusieurs fichiers]] dans une [[#Structure|structure spécifique]]. En tant que tel, il est possible de décompresser un fichier {{FileName|.FCStd}} à l'aide d'un outil de décompression zip, mais des précautions doivent être prises lors de la reconstruction du fichier {{FileName|.FCStd}}. FreeCAD possède un "Utilitaire de projet" pour reconstruire les fichiers {{FileName|.FCStd}}, dont l'utilisation est décrite dans [[#Modifier_le_code_source_du_fichier_.FCStd|Modifier le code source du fichier .FCStd]] ci-dessous.

===Document.xml===

C'est le fichier {{FileName|.xml}} principal, décrivant tous les objets à l'intérieur d'un document FreeCAD, c'est-à-dire la définition géométrique et les paramètres des objets, mais pas leur représentation visuelle. Si FreeCAD est exécuté en mode console (sans l'interface graphique), c'est ce {{FileName|Document.xml}} qui sera utilisé.

<span id="Example_Document.xml"></span>
==== Exemple de Document.xml====


{{Code|lang=xml|code=
==Structure du Document.xml==
<syntaxhighlight>
<?xml version='1.0' encoding='utf-8'?>
<?xml version='1.0' encoding='utf-8'?>
<!--
<!--
Line 94: Line 111:
</ObjectData>
</ObjectData>
</Document>
</Document>
}}
</syntaxhighlight>
==Modifier le source du fichier .FCStd==
{{VeryImportantMessage|'''ATTENTION TRAVAILLEZ TOUJOURS SUR UNE COPIE DE VOTRE PROJET !'''}}


<span id="GuiDocument.xml"></span>
Il est possible de modifier le source d'un fichier .FCStd mais la procédure n'est pas sans risques c'est pour cela qu'il faut travailler sur une '''copie'''.
=== GuiDocument.xml ===


Il s'agit de l'équivalent '''GUI''' (Graphique User Interface) du fichier {{FileName|Document.xml}}. Pour chaque objet décrit dans le {{FileName|Document.xml}}, il y a un objet correspondant dans {{FileName|GuiDocument.xml}}, qui décrit la représentation visuelle de l'objet (couleur, largeur, etc.).
Après avoir fait une '''copie''' de votre projet, procédez comme suit :


<span id="Thumbnails/thumbnail.png"></span>
Créez un nouveau répertoire et placez votre copie dans ce répertoire (il peut y avoir beaucoup de fichiers dans votre FCStd).
=== Thumbnails/thumbnail.png ===


Il s'agit d'une image miniature (thumbnail) du document de 128 x 128 pixels, qui représente une capture d'écran de la vue 3D pour gagner du temps. Les vignettes sont uniquement générées, si l'option correspondante est activée dans les préférences de FreeCAD.
* Allez dans '''Menu > Outils > Utilitaire de projet... Extraire le projet'''
[[File:Project utility fr.png|240px]]
* Source : Donnez le chemin de votre copie à décompresser.
* Destination : Donnez le chemin pour les fichiers décompressés.
* Cliquez sur {{KEY|Extraire}}
* Allez dans votre répertoire et ouvrez les deux fichiers '''GuiDocument.xml''' et '''Document.xml''' à l'aide de [http://notepad-plus-plus.org/ Notepad++] (Windows) (Notepad permet de modifier un mot dans tous les documents ouverts).
*'''GuiDocument.xml''' : contient tous les renseignements de votre projet relatifs à l'interface, affichage dans la Vue combinée, la configuration de FreeCAD . . .
**Exemple avec '''Text004'''
<syntaxhighlight>
<ViewProvider name="Text004">
<Properties Count="9">
<Property name="DisplayMode" type="App::PropertyEnumeration">
<Integer value="1"/>
</Property>
<Property name="FontName" type="App::PropertyString">
<String value="Arial"/>
</Property>
<Property name="FontSize" type="App::PropertyFloat">
<Float value="5.199999809265"/>
</Property>
<Property name="Justification" type="App::PropertyEnumeration">
<Integer value="0"/>
</Property>
<Property name="LineSpacing" type="App::PropertyFloat">
<Float value="0.600000023842"/>
</Property>
<Property name="Rotation" type="App::PropertyAngle">
<Float value="0.000000000000"/>
</Property>
<Property name="RotationAxis" type="App::PropertyEnumeration">
<Integer value="2"/>
</Property>
<Property name="TextColor" type="App::PropertyColor">
<PropertyColor value="4294901760"/>
</Property>
<Property name="Visibility" type="App::PropertyBool">
<Bool value="true"/>
</Property>
</Properties>
</ViewProvider>
</syntaxhighlight>
*'''Document.xml''' : contient tous les renseignements relatifs aux objets constituants votre projet.
**Exemple avec '''Text004'''
<syntaxhighlight>
<Object type="App::Annotation" name="Text004" />
</syntaxhighlight>


<span id="*.brep"></span>
=== *.brep ===


Ce sont les formes [[wikipedia:fr:B-Rep|B-Rep]] de tous les objets, qui ont une forme dans le {{FileName|Document.xml}}. Même s'il est paramétrique, chaque objet a sa forme stockée comme un fichier individuel {{FileName|.brep}}, on y accède donc par des composants sans devoir recalculer la forme.
<syntaxhighlight>
<Object name="Text004">
<Properties Count="3">
<Property name="Label" type="App::PropertyString">
<String value="Text004"/>
</Property>
<Property name="LabelText" type="App::PropertyStringList">
<StringList count="1">
<String value="135"/>
</StringList>
</Property>
<Property name="Position" type="App::PropertyVector">
<PropertyVector valueX="-30.000000000000" valueY="26.000000000000" valueZ="0.000000000000"/>
</Property>
</Properties>
</Object>


===*.svg===
</syntaxhighlight>
* Information such as :
<syntaxhighlight>
<VectorList file="Points1"/>
<ColorList file="DiffuseColor"/>
<Mesh file="MeshKernel.bms"/>
<Part file="PartShape.brp2"/>
. . . .
</syntaxhighlight>
* as well as other definitions containers '''file=''' relate has a file and if you change example "'''DiffuseColor'''" in '''<ColorList file="DiffuseColor"/>''' You must also change the name of the file for correspondence.
* Once the Word change is identified, '''search''' (your Word) and '''Replace by''' (your new word) and click on {{KEY|Replace in all open documents}} and your change will be the same in both files '''GuiDocument.xml''' and '''Document.xml'''.
* When changes are complete, return to the tool '''Menu > Tools > Project utility... Create project'''
* Source : Give the path of the file that you just changed and that is to restore.
* Destination : Give the path of the FCStd file to restore.
* Click {{KEY|...}} In the new window click on {{KEY|Create a new folder}} (to avoid errors by rewriting the file) and you post. Click on {{KEY|Create}} you can check the "Load project file after creation".
* If you have checked "Load project file after creation" your project will load in FreeCAD.
* '''PS :''' It is imperative that it have concordance GuiDocument.xml, Document.xml documents and files without which there will be errors in your .FCStd file. To do this should always work on a copy of your project.


Ce sont les fichiers svg modèles utilisés dans les pages de [[TechDraw_Workbench/fr|TechDraw]].
==Other==
More information on the format [[Fcstd_file_format|Fcstd]].


<span id="Typical_structure"></span>
Here, a file Converter utility [[ImageConv|ImageConv]].
=== Structure typique ===


Structure typique d'un fichier {{FileName|.FCStd}}. L'extension peut être modifiée en {{FileName|.zip}} pour l'explorer comme un répertoire normal. Les {{FileName|Document.xml}} et {{FileName|GuiDocument.xml}} sont à la racine de l'archive, avec un nombre illimité de fichiers {{FileName|.brp}} (B-REP). Un sous-répertoire peut contenir la miniature et un autre les modèles SVG utilisés par [[TechDraw_Workbench/fr|TechDraw]].


<!--DO NOT remove the <pre> </pre> tags. These are used to display the text exactly like this.-->
<pre>
File.FCStd (File.zip)
|
|--thumbnails/
| |
| :--Thumbnail.png
|
:--Document.xml
:--GuiDocument.xml
:--Shape1.brp
:--Shape2.brp
:--MyPage.svg
:--etc.
</pre>

<span id="Embedding_other_files"></span>
== Incorporation d'autres fichiers ==

Pour incorporer d'autres types de fichiers dans un fichier FCStd, vous devez d'abord créer un [[Scripted_objects/fr|objet scripté]] à partir de la [[Python_console/fr|console Python]] et lui donner une propriété {{incode|App::PropertyFileIncluded}}.

Ensuite, dans l'[[Property_editor/fr|éditeur de propriétés]], vous pouvez accéder à la propriété ajoutée et choisir un fichier sur l'ordinateur. Une fois le fichier FCStd enregistré, le fichier affecté à la propriété {{PropertyData/fr|PropertyFileIncluded}} sera mis dans le {{incode|.FCStd}}. Lorsque le document est restauré, le même fichier sera restauré avec la propriété {{PropertyData/fr|PropertyFileIncluded}}.

{{Code|code=
custom_obj = App.ActiveDocument.addObject("App::FeaturePython", "CustomObject")
custom_obj.addProperty("App::PropertyFileIncluded", "AttachedFile")
}}

Voir le fil du forum [https://forum.freecadweb.org/viewtopic.php?t=38201 PDF inside the project].

<span id="Change_the_source_of_the_file_.FCStd"></span>
== Modifier le code source du fichier .FCStd ==

* Voir [[Std_ProjectUtil/fr|Std Utilitaire de projet]].


{{Userdocnavi{{#translation:}}}}
[[Category:Developer{{#translation:}}]]
[[Category:Developer Documentation{{#translation:}}]]
[[Category:File_Formats{{#translation:}}]]
{{clear}}
{{clear}}
<languages/>

Latest revision as of 14:15, 30 April 2024

Présentation

Le format de fichier (.FCStd) est le format de fichier principal de FreeCAD. Il s’agit d’un format conteneur prenant en charge la compression et l’incorporation de différents types de données.

Contenu d'un fichier .FCStd

FCStd est un fichier zip standard contenant un ou plusieurs fichiers dans une structure spécifique. En tant que tel, il est possible de décompresser un fichier .FCStd à l'aide d'un outil de décompression zip, mais des précautions doivent être prises lors de la reconstruction du fichier .FCStd. FreeCAD possède un "Utilitaire de projet" pour reconstruire les fichiers .FCStd, dont l'utilisation est décrite dans Modifier le code source du fichier .FCStd ci-dessous.

Document.xml

C'est le fichier .xml principal, décrivant tous les objets à l'intérieur d'un document FreeCAD, c'est-à-dire la définition géométrique et les paramètres des objets, mais pas leur représentation visuelle. Si FreeCAD est exécuté en mode console (sans l'interface graphique), c'est ce Document.xml qui sera utilisé.

Exemple de Document.xml

<?xml version='1.0' encoding='utf-8'?>
 <Document SchemaVersion="4">
    <Properties Count="9">
       <Property name="Comment" type="App::PropertyString">
          <String value=""/>
       </Property>
       <Property name="Company" type="App::PropertyString">
          <String value=""/>
       </Property>
       <Property name="CreatedBy" type="App::PropertyString">
          <String value=""/>
       </Property>
       <Property name="CreationDate" type="App::PropertyString">
          <String value="Fri Jan 29 15:14:38 2010 "/>
       </Property>
       <Property name="FileName" type="App::PropertyString">
          <String value="/tmp/test.FCStd"/>
       </Property>
       <Property name="Id" type="App::PropertyString">
          <String value="201b746f-a1ed-4297-bf3d-65d5ec11abe0"/>
       </Property>
       <Property name="Label" type="App::PropertyString">
          <String value="names"/>
       </Property>
       <Property name="LastModifiedBy" type="App::PropertyString">
          <String value=""/>
       </Property>
       <Property name="LastModifiedDate" type="App::PropertyString">
          <String value="Fri Jan 29 15:15:21 2010 "/>
       </Property>
    </Properties>
    <Objects Count="2">
       <Object type="Mesh::Cube" name="Cube" />
       <Object type="Part::Box" name="Box" />
    </Objects>
    <ObjectData Count="2">
       <Object name="Cube">
          <Properties Count="7">
             <Property name="Height" type="App::PropertyFloatConstraint">
                <Float value="10"/>
             </Property>
             <Property name="Label" type="App::PropertyString">
                <String value="Cube"/>
             </Property>
             <Property name="Length" type="App::PropertyFloatConstraint">
                <Float value="10"/>
             </Property>
             <Property name="Mesh" type="Mesh::PropertyMeshKernel">
                <Mesh file="MeshKernel.bms"/>
             </Property>
             <Property name="Placement" type="App::PropertyPlacement">
                <PropertyPlacement Px="0" Py="0" Pz="0" Q0="0" Q1="0" Q2="0" Q3="1"/>
             </Property>
             <Property name="Pos" type="App::PropertyPlacementLink">
                <Link value=""/>
             </Property>
             <Property name="Width" type="App::PropertyFloatConstraint">
                <Float value="10"/>
             </Property>
          </Properties>
       </Object>
       <Object name="Box">
          <Properties Count="7">
             <Property name="Height" type="App::PropertyLength">
                <Float value="10"/>
             </Property>
             <Property name="Label" type="App::PropertyString">
                <String value="Box2"/>
             </Property>
             <Property name="Length" type="App::PropertyLength">
                <Float value="10"/>
             </Property>
             <Property name="Placement" type="App::PropertyPlacement">
                <PropertyPlacement Px="0" Py="0" Pz="0" Q0="0" Q1="0" Q2="0" Q3="1"/>
             </Property>
             <Property name="Pos" type="App::PropertyPlacementLink">
                <Link value=""/>
             </Property>
             <Property name="Shape" type="Part::PropertyPartShape">
                <Part file="PartShape.brp2"/>
             </Property>
             <Property name="Width" type="App::PropertyLength">
                <Float value="10"/>
             </Property>
          </Properties>
       </Object>
    </ObjectData>
 </Document>

GuiDocument.xml

Il s'agit de l'équivalent GUI (Graphique User Interface) du fichier Document.xml. Pour chaque objet décrit dans le Document.xml, il y a un objet correspondant dans GuiDocument.xml, qui décrit la représentation visuelle de l'objet (couleur, largeur, etc.).

Thumbnails/thumbnail.png

Il s'agit d'une image miniature (thumbnail) du document de 128 x 128 pixels, qui représente une capture d'écran de la vue 3D pour gagner du temps. Les vignettes sont uniquement générées, si l'option correspondante est activée dans les préférences de FreeCAD.

*.brep

Ce sont les formes B-Rep de tous les objets, qui ont une forme dans le Document.xml. Même s'il est paramétrique, chaque objet a sa forme stockée comme un fichier individuel .brep, on y accède donc par des composants sans devoir recalculer la forme.

*.svg

Ce sont les fichiers svg modèles utilisés dans les pages de TechDraw.

Structure typique

Structure typique d'un fichier .FCStd. L'extension peut être modifiée en .zip pour l'explorer comme un répertoire normal. Les Document.xml et GuiDocument.xml sont à la racine de l'archive, avec un nombre illimité de fichiers .brp (B-REP). Un sous-répertoire peut contenir la miniature et un autre les modèles SVG utilisés par TechDraw.

File.FCStd (File.zip)
  |
  |--thumbnails/
  |  |
  |  :--Thumbnail.png
  |
  :--Document.xml
  :--GuiDocument.xml
  :--Shape1.brp
  :--Shape2.brp
  :--MyPage.svg
  :--etc.

Incorporation d'autres fichiers

Pour incorporer d'autres types de fichiers dans un fichier FCStd, vous devez d'abord créer un objet scripté à partir de la console Python et lui donner une propriété App::PropertyFileIncluded.

Ensuite, dans l'éditeur de propriétés, vous pouvez accéder à la propriété ajoutée et choisir un fichier sur l'ordinateur. Une fois le fichier FCStd enregistré, le fichier affecté à la propriété DonnéesPropertyFileIncluded sera mis dans le .FCStd. Lorsque le document est restauré, le même fichier sera restauré avec la propriété DonnéesPropertyFileIncluded.

custom_obj = App.ActiveDocument.addObject("App::FeaturePython", "CustomObject")
custom_obj.addProperty("App::PropertyFileIncluded", "AttachedFile")

Voir le fil du forum PDF inside the project.

Modifier le code source du fichier .FCStd