Всички обекти в програмата имат име на обект, което уникално ги идентифицира в даден документ.
Тази информация се прилага за всички обекти, получени от App DocumentObject (клас App::DocumentObject), който по същество включва всички обекти, които е възможно да се създадат в документ.
Има различни свойства на името:
Name може да включва само прости буквено-цифрови знаци и долна черта, [_0-9a-zA-zA-Z].Name не може да започне с число; трябва да започне с буква или долната черта, [_a-zA-Z].Name се присвоява по време на създаването на обекта; след това то вече не може да се редактира. Обектът никога не може да бъде преименуван.Name трябва да бъде уникално в целия документ. Няма значение дали два обекта са от съвсем различни типове, например, единият е PartDesign Pocket, а другият е Arch Wall. Трябва да имат различни имена.Box, Box001, Box0012 и т.н. Това предотвратява конфликти с имената.Name става достъпно за използване от новосъздаден обект. Това означава, че ако Box, Box001, и Box002 съществуват, и изтрием първия елемент, следващото поле, създадено с Part Box, няма да бъде Box003, а ще бъде отново Box, защото този низ е наличен, за да се използва отново. Забележете, че не е възможно да преименувате Box001 или Box002 на Box, тъй като имената са фиксирани.В обобщение, Name по същество действа като уникален идентификатор (UID) за обект. Тъй като уникалното име Name е много ограничително, всички обекти също имат свойство Label, което позволява "преименуване" на обекта на нещо по-описателно. Вътрешното име Name всъщност остава фиксирано, но потребителят може да редактира Label, и може да се го използва в повечето ситуации, в които ще се използва и Name. В обща употреба в програмата и документацията, "преименуване" означава промяна на Label, а не действителното име Name на обекта.
Има различни свойства на етикетите:
Label може да приеме всеки UTF8 низ, включително с ударения и интервали.Label на обекта, а не Name. Следователно, когато се създава нов обект, е добра практика да се промени неговия етикет Label на по-описателен низ. За да преименувате (преетикетирате) обекта, изберете го в дървовидния изглед и натиснете F2 (или само Return на macOS), или отворете контекстното меню (щракване с десния бутон) и изберете Rename.Name все още ще бъде показвано на много места, например в Status Bar или в Selection View, когато обектът е избран.Name, много диалози ще покажат първо Name, последвани от етиката в скоби Label, който може да се редактира, например Box (екструдирана част).Label е уникален, точно като Name. Това поведение обаче може да бъде променено в preferences editor, Edit → Preferences → General → Document → Allow duplicate object labels in one document. Това означава, че като цяло Label не е уникален в документа и всъщност може да се повтори. Препоръката обаче е да се запази уникалният Label, тъй като това е може би това, което е най-полезно за идентифициране на различни обекти. Когато пишете персонализирани функции, които манипулират обекти, методите трябва да използват Name на обекта, а не неговия Label, за да гарантират, че се използва правилният обект.<<Custom Label With Spaces>>.Height
<<Label may use UTF8 characters>>.Width
Това е прост низ, който може да съдържа произволен текст и следователно може да се използва за документиране (описване с повече подробности) на създадения обект.
Label2 от Python console.See also: FreeCAD Scripting Basics, and scripted objects.
Any object in the software is internally created with the addObject() method of the document. The majority of 2D and 3D objects that the user will see in the 3D View are derived from a Part Feature. In the following example, the object created is a Part Box.
import FreeCAD as App
doc = App.newDocument()
obj = doc.addObject("Part::Box", "Name")
obj.Label = "Custom label"
The addObject function has two basic string arguments.
"Part::Box".Name attribute. If it is not provided, it defaults to the same name as the class of the object, that is, "Part__Box", where the two invalid symbols, the colons ::, are replaced by two underscores __.
Name can only include simple alphanumeric characters, and the underscore, [_0-9a-zA-Z]. If other symbols are given, these will be converted to underscores; for example, "A+B:C*" is converted to "A_B_C_".Name cannot start with a number; it must start with a letter or the underscore, [_a-zA-Z]. For example, "123ABC" is converted to "_23ABC".Name is fixed at creation time; it cannot be modified afterwards.Name must be unique in the entire document. If the same "Name" is used, a sequential number will be appended automatically so that the resulting names are unique; for example, if "Name" already exists, then new objects will be called "Name001", "Name002", "Name003", etc.The Label is a property of the created object and can be changed to a more meaningful text.
Label is the same as the Name.Name, the Label can accept any UTF8 string, including accents and spaces.Label can be changed at any point in time just by assigning the desired string, obj.Label = "New label"All objects in a document are data attributes of the corresponding Document object. The attribute's name correspond to the internal Name of the object.
import FreeCAD as App
obj1 = App.ActiveDocument.Box
obj2 = App.ActiveDocument.Box001
obj3 = App.ActiveDocument.Box002
This is equivalent to using the getObject method of the Document.
import FreeCAD as App
obj1 = App.ActiveDocument.getObject('Box')
obj2 = App.ActiveDocument.getObject('Box001')
obj3 = App.ActiveDocument.getObject('Box002')
However, it is also possible to get the object by the more descriptive Label.
import FreeCAD as App
obj1 = App.ActiveDocument.getObjectsByLabel("Concrete wall")[0]
obj2 = App.ActiveDocument.getObjectsByLabel("Custom parallelepiped")[0]
obj3 = App.ActiveDocument.getObjectsByLabel("Some special name for this cube__002")[0]
Given that the Label is in general not unique, the getObjectsByLabel method returns a list with all objects found with that Label. However, if the Label is unique in the document then the first element in that list should be the desired object.