FreeCAD-Doc/localwiki/ViewObject_API-fr.html
2018-07-19 18:47:02 -05:00

252 lines
11 KiB
HTML

<html><head><title>ViewObject API/fr</title><meta http-equiv="Content-Type" content="text/html; charset=utf-8"><link type='text/css' href='wiki.css' rel='stylesheet'></head><body><h1>ViewObject API/fr</h1></div>
<div id="mw-content-text" lang="fr" dir="ltr" class="mw-content-ltr"><hr/><div class="mw-parser-output"><p>Lorsque l'interface graphique est en place, chaque objet dans le document FreeCAD a une ViewObject associé, qui réside dans le document homologue FreeCAD Gui. Un ViewObject peut être récupéré par deux moyens. Exemple:
</p>
<pre>myViewObj = FreeCAD.ActiveDocument.myObjectName.ViewObject
myViewObj = FreeCADGui.ActiveDocument.myObjectName
print myViewObj.IV </pre>
<p><br />
</p>
<div class="api">
<div class="function"><a href="https://www.freecadweb.org/wiki/index.php?title=File:Property.png" class="image"><img alt="Property.png" src="Property.png" width="16" height="16" /></a> <big><b> Annotation </b></big></div>
<div class="description">
<p><small><b>Returns</b>:</small> le nœud d'annotation d'une vue Object
</p>
</div>
</div>
<p><br />
</p>
<div class="api">
<div class="function"><a href="https://www.freecadweb.org/wiki/index.php?title=File:Property.png" class="image"><img alt="Property.png" src="Property.png" width="16" height="16" /></a> <big><b> Boîte englobante </b></big></div>
<div class="description">
<p><small><b>Returns</b>:</small> la boîte englobante
</p>
</div>
</div>
<p><br />
</p>
<div class="api">
<div class="function"><a href="https://www.freecadweb.org/wiki/index.php?title=File:Property.png" class="image"><img alt="Property.png" src="Property.png" width="16" height="16" /></a> <big><b> Contenu </b></big></div>
<div class="description">
<p><small><b>Returns</b>:</small> une représentation XML des propriétés d'un ViewObject
</p>
</div>
</div>
<p><br />
</p>
<div class="api">
<div class="function"><a href="https://www.freecadweb.org/wiki/index.php?title=File:Property.png" class="image"><img alt="Property.png" src="Property.png" width="16" height="16" /></a> <big><b> DisplayMode </b></big></div>
<div class="description">
<p><small><b>Returns</b>:</small> le mode d'affichage actuel
</p>
</div>
</div>
<p><br />
</p>
<div class="api">
<div class="function"><a href="https://www.freecadweb.org/wiki/index.php?title=File:Property.png" class="image"><img alt="Property.png" src="Property.png" width="16" height="16" /></a> <big><b> IV </b></big></div>
<div class="description">
<p><small><b>Returns</b>:</small> une représentation Inventeur du ViewObject
</p>
</div>
</div>
<p><br />
</p>
<div class="api">
<div class="function"><a href="https://www.freecadweb.org/wiki/index.php?title=File:Property.png" class="image"><img alt="Property.png" src="Property.png" width="16" height="16" /></a> <big><b> objet </b></big></div>
<div class="description">
<p><small><b>Returns</b>:</small> L'objet de ce ViewObject FreeCAD Document associé
</p>
</div>
</div>
<p><br />
</p>
<div class="api">
<div class="function"><a href="https://www.freecadweb.org/wiki/index.php?title=File:Property.png" class="image"><img alt="Property.png" src="Property.png" width="16" height="16" /></a> <big><b> PropertiesList </b></big></div>
<div class="description">
<p><small><b>Returns</b>:</small> une liste de propriétés de ce ViewObject
</p>
</div>
</div>
<p><br />
</p>
<div class="api">
<div class="function"><a href="https://www.freecadweb.org/wiki/index.php?title=File:Property.png" class="image"><img alt="Property.png" src="Property.png" width="16" height="16" /></a> <big><b> RootNode </b></big></div>
<div class="description">
<p><small><b>Returns</b>:</small> le nœud Inventeur de cette ViewObject (objet pivy.coin)
</p>
</div>
</div>
<p><br />
</p>
<div class="api">
<div class="function"><a href="https://www.freecadweb.org/wiki/index.php?title=File:Property.png" class="image"><img alt="Property.png" src="Property.png" width="16" height="16" /></a> <big><b> sélectionnable </b></big></div>
<div class="description">
<p><small><b>Returns</b>:</small> True si l'objet est sélectionnable
</p>
</div>
</div>
<p><br />
</p>
<div class="api">
<div class="function"><a href="https://www.freecadweb.org/wiki/index.php?title=File:Property.png" class="image"><img alt="Property.png" src="Property.png" width="16" height="16" /></a> <big><b> Type </b></big></div>
<div class="description">
<p><small><b>Returns</b>:</small> le type de cette ViewObject
</p>
</div>
</div>
<p><br />
</p>
<div class="api">
<div class="function"><a href="https://www.freecadweb.org/wiki/index.php?title=File:Property.png" class="image"><img alt="Property.png" src="Property.png" width="16" height="16" /></a> <big><b> Visibilité </b></big></div>
<div class="description">
<p><small><b>Returns</b>:</small> Vrai si le ViewObject est visible
</p>
</div>
</div>
<p><br />
</p>
<div class="api">
<div class="function"><a href="https://www.freecadweb.org/wiki/index.php?title=File:Method.png" class="image"><img alt="Method.png" src="Method.png" width="16" height="16" /></a> <big><b> getAllDerivedFrom </b></big> ( <i> </i> )</div>
<div class="description">
<p><small><b>Description</b>:</small>
</p><p><small><b>Returns</b>:</small> toutes descentences de cet objet
</p>
</div>
</div>
<p><br />
</p>
<div class="api">
<div class="function"><a href="https://www.freecadweb.org/wiki/index.php?title=File:Method.png" class="image"><img alt="Method.png" src="Method.png" width="16" height="16" /></a> <big><b> getDocumentationOfProperty </b></big> ( <i> </i> )</div>
<div class="description">
<p><small><b>Description</b>:</small>
</p><p><small><b>Returns</b>:</small> la chaîne de documentation de la propriété de cette classe
</p>
</div>
</div>
<p><br />
</p>
<div class="api">
<div class="function"><a href="https://www.freecadweb.org/wiki/index.php?title=File:Method.png" class="image"><img alt="Method.png" src="Method.png" width="16" height="16" /></a> <big><b> getGroupOfProperty </b></big> ( <i> </i> )</div>
<div class="description">
<p><small><b>Description</b>:</small>
</p><p><small><b>Returns</b>:</small> le nom du groupe qui la propriété appartient à cette classe. Les biens immobiliers triés en groupes nommés differnt pour plus de commodité.
</p>
</div>
</div>
<p><br />
</p>
<div class="api">
<div class="function"><a href="https://www.freecadweb.org/wiki/index.php?title=File:Method.png" class="image"><img alt="Method.png" src="Method.png" width="16" height="16" /></a> <big><b> getPropertyByName </b></big> ( <i> </i> )</div>
<div class="description">
<p><small><b>Description</b>:</small>
</p><p><small><b>Returns</b>:</small> . La valeur d'une propriété nommée
</p>
</div>
</div>
<p><br />
</p>
<div class="api">
<div class="function"><a href="https://www.freecadweb.org/wiki/index.php?title=File:Method.png" class="image"><img alt="Method.png" src="Method.png" width="16" height="16" /></a> <big><b> getTypeOfProperty </b></big> ( <i> </i> )</div>
<div class="description">
<p><small><b>Description</b>:</small>
</p><p><small><b>Returns</b>:</small> le type d'une propriété nommée. Cela peut être (Hidden, ReadOnly, Output) ou toute combinaison.
</p>
</div>
</div>
<p><br />
</p>
<div class="api">
<div class="function"><a href="https://www.freecadweb.org/wiki/index.php?title=File:Method.png" class="image"><img alt="Method.png" src="Method.png" width="16" height="16" /></a> <big><b> hide </b></big> ( <i> </i> )</div>
<div class="description">
<p><small><b>Description</b>:</small> Masque l'objet
</p><p><small><b>Returns</b>:</small> .
</p>
</div>
</div>
<p><br />
</p>
<div class="api">
<div class="function"><a href="https://www.freecadweb.org/wiki/index.php?title=File:Method.png" class="image"><img alt="Method.png" src="Method.png" width="16" height="16" /></a> <big><b> isDerivedFrom </b></big> ( <i> chaîne </i> )</div>
<div class="description">
<p><small><b>Description</b>:</small> Vérifie si cet objet est dérivé du type d'objet donné
</p><p><small><b>Returns</b>:</small> vrai si le type donné est un père
</p>
</div>
</div>
<p><br />
</p>
<div class="api">
<div class="function"><a href="https://www.freecadweb.org/wiki/index.php?title=File:Method.png" class="image"><img alt="Method.png" src="Method.png" width="16" height="16" /></a> <big><b> isVisible </b></big> ( <i> </i> )</div>
<div class="description">
<p><small><b>Description</b>:</small> Vérifie si l'objet est visible
</p><p><small><b>Returns</b>:</small> un booléen
</p>
</div>
</div>
<p><br />
</p>
<div class="api">
<div class="function"><a href="https://www.freecadweb.org/wiki/index.php?title=File:Method.png" class="image"><img alt="Method.png" src="Method.png" width="16" height="16" /></a> <big><b> listDisplayModes </b></big> ( <i> </i> )</div>
<div class="description">
<p><small><b>Description</b>:</small> Affiche une liste de tous les modes d'affichage
</p><p><small><b>Returns</b>:</small> liste
</p>
</div>
</div>
<p><br />
</p>
<div class="api">
<div class="function"><a href="https://www.freecadweb.org/wiki/index.php?title=File:Method.png" class="image"><img alt="Method.png" src="Method.png" width="16" height="16" /></a> <big><b> setTransformation </b></big> ( <i> coin.SoTransform </i> )</div>
<div class="description">
<p><small><b>Description</b>:</small> Définit une transformation sur le nœud Inventor
</p><p><small><b>Returns</b>:</small> rien
</p>
</div>
</div>
<p><br />
</p>
<div class="api">
<div class="function"><a href="https://www.freecadweb.org/wiki/index.php?title=File:Method.png" class="image"><img alt="Method.png" src="Method.png" width="16" height="16" /></a> <big><b> spectacle </b></big> ( <i> </i> )</div>
<div class="description">
<p><small><b>Description</b>:</small> Indique si l'objet est caché
</p><p><small><b>Returns</b>:</small> rien
</p>
</div>
</div>
<p><br />
</p>
<div class="api">
<div class="function"><a href="https://www.freecadweb.org/wiki/index.php?title=File:Method.png" class="image"><img alt="Method.png" src="Method.png" width="16" height="16" /></a> <big><b> toString </b></big> ( <i> </i> )</div>
<div class="description">
<p><small><b>Description</b>:</small>
</p><p><small><b>Returns</b>:</small> une représentation de chaîne du nœud Inventor
</p>
</div>
</div>
<p><br />
</p>
<div class="api">
<div class="function"><a href="https://www.freecadweb.org/wiki/index.php?title=File:Method.png" class="image"><img alt="Method.png" src="Method.png" width="16" height="16" /></a> <big><b> Mise à jour </b></big> ( <i> </i> )</div>
<div class="description">
<p><small><b>Description</b>:</small> Mise à jour de la vue de représentation de l'objet
</p><p><small><b>Returns</b>:</small>
</p>
</div>
</div>
<div style="clear:both"></div>
</div>
</div>
</div><div class="printfooter">
Online version: "<a dir="ltr" href="https://www.freecadweb.org/wiki/index.php?title=ViewObject_API/fr&amp;oldid=152809">http://www.freecadweb.org/wiki/index.php?title=ViewObject_API/fr&amp;oldid=152809</a>"</div>
<div id="catlinks" class="catlinks" data-mw="interface"></div><div class="visualClear"></div>
</div>
</div>
<div id="mw-navigation">
<h2>Navigation menu</h2>
</body></html>