Difference between revisions of "Property"

From FreeCAD Documentation
Jump to: navigation, search
(Examples of how the properties look in scripted objects.)
(More information)
Line 1: Line 1:
 
<languages/>
 
<languages/>
 
<translate>
 
<translate>
 +
 +
== Introduction ==
 +
 
<!--T:1-->
 
<!--T:1-->
A [[Property|property]] is a piece of information like a number or a text string that is attached to a FreeCAD document or an object in a document. Properties can be viewed and modified with the [[Property editor|Property editor]].
+
A [[Property|property]] is a piece of information like a number or a text string that is attached to a FreeCAD document or an object in a document. Public properties can be viewed and modified in the [[Property editor|Property editor]].
  
 
<!--T:4-->
 
<!--T:4-->
Properties play a very important part in FreeCAD. As objects in FreeCAD are said to be "parametric", this means that their behavior is defined by their properties, and how those properties are modified class methods.
+
Properties play a very important role in FreeCAD. As objects in FreeCAD are "parametric", this means that their behavior is defined by their properties, and how these properties are used as input for their class methods.
 +
 
 +
== All properties ==
  
 
<!--T:5-->
 
<!--T:5-->
Line 53: Line 58:
 
<translate>
 
<translate>
  
In code
+
== Scripting ==
 +
 
 +
{{Emphasis|See also:}} [[FreeCAD Scripting Basics|FreeCAD scripting basics]]
 +
 
 +
A [[scripted objects|scripted object]] is created first, and then properties are assigned.
 
</translate>
 
</translate>
 
{{Code|code=
 
{{Code|code=

Revision as of 03:33, 23 September 2019

Other languages:
čeština • ‎Deutsch • ‎English • ‎español • ‎français • ‎Bahasa Indonesia • ‎italiano • ‎日本語 • ‎polski • ‎português • ‎română • ‎русский • ‎svenska • ‎Türkçe • ‎中文 • ‎中文(中国大陆)‎

Introduction

A property is a piece of information like a number or a text string that is attached to a FreeCAD document or an object in a document. Public properties can be viewed and modified in the Property editor.

Properties play a very important role in FreeCAD. As objects in FreeCAD are "parametric", this means that their behavior is defined by their properties, and how these properties are used as input for their class methods.

All properties

Custom scripted objects can use any of the property types defined in the base system:

Boolean
Float
FloatList
FloatConstraint
Angle
Distance
Integer
IntegerConstraint
Percent
Enumeration
IntegerList
String
StringList
Link
LinkList
Matrix
Vector
VectorList
Placement
PlacementLink
Color
ColorList
Material
Path
File
FileIncluded
PartShape
FilletContour
Circle

Internally, the property name is prefixed with App::Property:

App::PropertyBoolean
App::PropertyFloat
App::PropertyFloatList
...

Scripting

See also: FreeCAD scripting basics

A scripted object is created first, and then properties are assigned.

obj = App.ActiveDocument.addObject("Part::Feature", "CustomObject")

obj.addProperty("App::PropertyFloat", "Velocity", "Parameter", "Body speed")
obj.addProperty("App::PropertyBool", "VelocityEnabled", "Parameter", "Enable body speed")