ViewObject API

From FreeCAD Documentation
Jump to navigation Jump to search
This page is a translated version of the page ViewObject API and the translation is 100% complete.
Other languages:
Deutsch • ‎English • ‎español • ‎français • ‎italiano • ‎română
(Octobre 2019) Ne modifiez pas cette page. L'information est incomplète et obsolète. Pour la dernière API, consultez la documentation de l'API générée automatiquement, ou générez la documentation vous-même, voirSource documentation.


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
Property.png Annotation

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

Property.png Boîte englobante

Returns: la boîte englobante

Property.png Contenu

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

Property.png DisplayMode

Returns: le mode d'affichage actuel

Property.png IV

Returns: une représentation Inventeur du ViewObject

Property.png objet

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

Property.png PropertiesList

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

Property.png RootNode

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

Property.png sélectionnable

Returns: True si l'objet est sélectionnable

Property.png Type

Returns: le type de cette ViewObject

Property.png Visibilité

Returns: Vrai si le ViewObject est visible

Method.png getAllDerivedFrom ( )

Description:

Returns: toutes descentences de cet objet

Method.png getDocumentationOfProperty ( )

Description:

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

Method.png 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é.

Method.png getPropertyByName ( )

Description:

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

Method.png getTypeOfProperty ( )

Description:

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

Method.png hide ( )

Description: Masque l'objet

Returns: .

Method.png 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

Method.png isVisible ( )

Description: Vérifie si l'objet est visible

Returns: un booléen

Method.png listDisplayModes ( )

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

Returns: liste

Method.png setTransformation ( coin.SoTransform )

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

Returns: rien

Method.png spectacle ( )

Description: Indique si l'objet est caché

Returns: rien

Method.png toString ( )

Description:

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

Method.png Mise à jour ( )

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

Returns: