ViewObject API/fr: Difference between revisions

Latest revision as of 21:04, 16 January 2024

Other languages:

(octobre 2019) Ne pas éditer cette page. L'information est incomplète et obsolète. Pour la dernière API, voir la documentation de l'API générée automatiquement, ou générez la documentation vous-même, voir Documentation du code source.

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:

myViewObj = FreeCAD.ActiveDocument.myObjectName.ViewObject
myViewObj = FreeCADGui.ActiveDocument.myObjectName
print myViewObj.IV

Annotation

Returns: le nœud d'annotation d'une vue Object

Boîte englobante

Returns: la boîte englobante

Contenu

Returns: une représentation XML des propriétés d'un ViewObject

DisplayMode

Returns: le mode d'affichage actuel

IV

Returns: une représentation Inventeur du ViewObject

objet

Returns: L'objet de ce ViewObject FreeCAD Document associé

PropertiesList

Returns: une liste de propriétés de ce ViewObject

RootNode

Returns: le nœud Inventeur de cette ViewObject (objet pivy.coin)

sélectionnable

Returns: True si l'objet est sélectionnable

Type

Returns: le type de cette ViewObject

Visibilité

Returns: Vrai si le ViewObject est visible

getAllDerivedFrom ( )

Description:

Returns: toutes descentences de cet objet

getDocumentationOfProperty ( )

Description:

Returns: la chaîne de documentation de la propriété de cette classe

getGroupOfProperty ( )

Description:

Returns: 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é.

getPropertyByName ( )

Description:

Returns: . La valeur d'une propriété nommée

getTypeOfProperty ( )

Description:

Returns: le type d'une propriété nommée. Cela peut être (Hidden, ReadOnly, Output) ou toute combinaison.

hide ( )

Description: Masque l'objet

Returns: .

isDerivedFrom ( chaîne )

Description: Vérifie si cet objet est dérivé du type d'objet donné

Returns: vrai si le type donné est un père

isVisible ( )

Description: Vérifie si l'objet est visible

Returns: un booléen

listDisplayModes ( )

Description: Affiche une liste de tous les modes d'affichage

Returns: liste

setTransformation ( coin.SoTransform )

Description: Définit une transformation sur le nœud Inventor

Returns: rien

spectacle ( )

Description: Indique si l'objet est caché

Returns: rien

toString ( )

Description:

Returns: une représentation de chaîne du nœud Inventor

Mise à jour ( )

Description: Mise à jour de la vue de représentation de l'objet

Returns:

Hub utilisateurs

Démarrer avec FreeCAD
Installation : Téléchargements, Windows, Linux, Mac, Logiciels supplémentaires, Docker, AppImage, Ubuntu Snap
Bases : À propos de FreeCAD, Interface, Navigation par la souris, Méthodes de sélection, Objet name, Préférences, Ateliers, Structure du document, Propriétés, Contribuer à FreeCAD, Faire un don

Aide : Tutoriels, Tutoriels vidéo
Ateliers : Std Base, Arch, Assembly, CAM, Draft, FEM, Inspection, Mesh, OpenSCAD, Part, PartDesign, Points, Reverse Engineering, Robot, Sketcher, Spreadsheet, Start, Surface, TechDraw, Test, Web

Addons : Gestionnaire d'Addons, Ateliers externes, Scripts et macros

Hubs : Hub utilisateurs, Hub utilisateurs expérimentés, Hub Développeurs

@@ Line 1: / Line 1: @@
+<languages/>
+{{VeryImportantMessage|(octobre 2019) Ne pas éditer cette page. L'information est incomplète et obsolète. Pour la dernière API, voir la [https://www.freecadweb.org/api documentation de l'API générée automatiquement], ou générez la documentation vous-même, voir [[Source documentation/fr|Documentation du code source]].}}
 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:
 {{Code|code=
@@ Line 6: / Line 9: @@
 }}
+{{APIProperty | Annotation | le nœud d'annotation d'une vue Object}}
+{{APIProperty | Boîte englobante | la boîte englobante}}
+{{APIProperty | Contenu | une représentation XML des propriétés d'un ViewObject}}
+{{APIProperty | DisplayMode | le mode d'affichage actuel}}
+{{APIProperty | IV | une représentation Inventeur du ViewObject}}
+{{APIProperty | objet | L'objet de ce ViewObject FreeCAD Document associé}}
+{{APIProperty | PropertiesList | une liste de propriétés de ce ViewObject}}
+{{APIProperty | RootNode | le nœud Inventeur de cette ViewObject (objet pivy.coin)}}
+{{APIProperty | sélectionnable | True si l'objet est sélectionnable}}
+{{APIProperty | Type | le type de cette ViewObject}}
+{{APIProperty | Visibilité | Vrai si le ViewObject est visible}}
+{{APIFunction | getAllDerivedFrom | | | toutes descentences de cet objet}}
+{{APIFunction | getDocumentationOfProperty | | | la chaîne de documentation de la propriété de cette classe}}
+{{APIFunction | getGroupOfProperty | | | 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é.}}
+{{APIFunction | getPropertyByName | | |. La valeur d'une propriété nommée}}
+{{APIFunction | getTypeOfProperty | | | le type d'une propriété nommée. Cela peut être (Hidden, ReadOnly, Output) ou toute combinaison.}}
+{{APIFunction | hide | | Masque l'objet |.}}
+{{APIFunction | isDerivedFrom | chaîne | Vérifie si cet objet est dérivé du type d'objet donné | vrai si le type donné est un père}}
+{{APIFunction | isVisible | | Vérifie si l'objet est visible | un booléen}}
+{{APIFunction | listDisplayModes | | Affiche une liste de tous les modes d'affichage | liste}}
+{{APIFunction | setTransformation | coin.SoTransform | Définit une transformation sur le nœud Inventor | rien}}
+{{APIFunction | spectacle | | Indique si l'objet est caché | rien}}
+{{APIFunction | toString | | | une représentation de chaîne du nœud Inventor}}
+{{APIFunction | Mise à jour | | Mise à jour de la  vue de représentation  de l'objet |}}
+{{Userdocnavi{{#translation:}}}}
-{{APIProperty|Annotation|the annotation node of a ViewObject}}
+[[Category:API{{#translation:}}]]
-{{APIProperty|BoundingBox|the bounding box}}
+[[Category:Poweruser Documentation{{#translation:}}]]
-{{APIProperty|Content|an XML representation of a ViewObject's properties}}
-{{APIProperty|DisplayMode|the current display mode}}
-{{APIProperty|IV|an Inventor representation of the ViewObject}}
-{{APIProperty|Object|the associated FreeCAD Document Object of this ViewObject}}
-{{APIProperty|PropertiesList|a list of properties of this ViewObject}}
-{{APIProperty|RootNode|the Inventor node of this ViewObject (pivy.coin object)}}
-{{APIProperty|Selectable|True if the object is selectable}}
-{{APIProperty|Type|the type of this ViewObject}}
-{{APIProperty|Visibility|True if the viewObject is visible}}
-{{APIFunction|getAllDerivedFrom| | |all descentences of this object}}
-{{APIFunction|getDocumentationOfProperty| | |the documentation string of the property of this class.}}
-{{APIFunction|getGroupOfProperty| | |the name of the group which the property belongs to in this class. The properties sorted in differnt named groups for convenience.}}
-{{APIFunction|getPropertyByName| | |the value of a named property.}}
-{{APIFunction|getTypeOfProperty| | |the type of a named property. This can be (Hidden,ReadOnly,Output) or any combination.}}
-{{APIFunction|hide| |Hides the object.| }}
-{{APIFunction|isDerivedFrom|string|Checks if this object is derived from the given object type|True if given type is a father}}
-{{APIFunction|isVisible| |Checks if the object is visible|a boolean}}
-{{APIFunction|listDisplayModes| |Shows a list of all display modes|a list}}
-{{APIFunction|setTransformation|coin.SoTransform|Sets a transformation on the Inventor node|nothing}}
-{{APIFunction|show| |Shows the object if hidden|nothing}}
-{{APIFunction|toString| | |a string representation of the Inventor node}}
-{{APIFunction|update| |Updates the view representation of the object| }}
-[[Category:API/fr]]
 {{clear}}
-<languages/>