Property: Difference between revisions

From FreeCAD Documentation
mNo edit summary
(start to document the properties)
Line 16: Line 16:


</translate>
</translate>
{| class="sortable"
{{Code|code=
|+ Caption text
Acceleration
|-
Angle
! Name !! Unit (if any) !! Annotation
Area
|-
Bool
| Acceleration ||
BoolList
|-
Color
| Angle || °
ColorList
|-
Direction
| Area || mm^2
Distance
|-
ElectricPotential
| Bool ||
Enumeration
|-
ExpressionContainer
| BoolList ||
ExpressionEngine
|-
File
| Color ||
FileIncluded
|-
Float
| ColorList ||
FloatConstraint
|-
FloatList
| Direction ||
Font
|-
Force
| Distance || mm
Frequency
|-
Geometry
| ElectricPotential || V
Integer
|-
IntegerConstraint
| Enumeration ||
IntegerList
|-
IntegerSet
| ExpressionContainer ||
Length
|-
Link
| ExpressionEngine ||
LinkList
|-
LinkSubList
| File ||
Lists
|-
Map
| FileIncluded ||
Material
|-
MaterialList
| Float ||
Matrix
|-
PartShape
| FloatConstraint ||
Path
|-
Percent
| FloatList ||
Placement
|-
PlacementLink
| Font ||
PlacementList
|-
Position
| Force ||
Precision
|-
Pressure
| Frequency || 1/Hz
PythonObject
|-
Quantity
| Geometry ||
QuantityConstraint
|-
Rotation
| Integer ||
Speed
|-
Stiffness
| IntegerConstraint ||
String
|-
StringList
| IntegerList ||
VacuumPermittivity
|-
Vector
| IntegerSet ||
VectorDistance
|-
VectorList
| Length || mm
Volume
|-
}}
| Link ||
|-
| LinkList ||
|-
| LinkSubList ||
|-
| Lists ||
|-
| Map ||
|-
| Material ||
|-
| MaterialList ||
|-
| Matrix ||
|-
| PartShape ||
|-
| Path ||
|-
| Percent ||
|-
| Placement ||
|-
| PlacementLink ||
|-
| PlacementList ||
|-
| Position ||
|-
| Precision ||
|-
| Pressure || Pa
|-
| PythonObject ||
|-
| Quantity ||
|-
| QuantityConstraint ||
|-
| Rotation ||
|-
| Speed || mm/s
|-
| Stiffness || mm/s^2
|-
| String ||
|-
| StringList ||
|-
| VacuumPermittivity || s^4*A^2 / (m^3*kg)
|-
Vector ||
|-
| VectorDistance ||
|-
| VectorList ||
|-
| Volume || mm^3
|}
<translate>
<translate>



Revision as of 20:47, 26 February 2023

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. See also FeaturePython Custom Properties and PropertyLink: InList and OutList

All property types

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

Vector ||
Caption text
Name Unit (if any) Annotation
Acceleration
Angle °
Area mm^2
Bool
BoolList
Color
ColorList
Direction
Distance mm
ElectricPotential V
Enumeration
ExpressionContainer
ExpressionEngine
File
FileIncluded
Float
FloatConstraint
FloatList
Font
Force
Frequency 1/Hz
Geometry
Integer
IntegerConstraint
IntegerList
IntegerSet
Length mm
Link
LinkList
LinkSubList
Lists
Map
Material
MaterialList
Matrix
PartShape
Path
Percent
Placement
PlacementLink
PlacementList
Position
Precision
Pressure Pa
PythonObject
Quantity
QuantityConstraint
Rotation
Speed mm/s
Stiffness mm/s^2
String
StringList
VacuumPermittivity s^4*A^2 / (m^3*kg)
VectorDistance
VectorList
Volume mm^3

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

App::PropertyBool
App::PropertyFloat
App::PropertyFloatList
...

Remember that these are property types. A single object may have many properties of the same type, but with different names.

For example:

obj.addProperty("App::PropertyFloat", "Length")
obj.addProperty("App::PropertyFloat", "Width")
obj.addProperty("App::PropertyFloat", "Height")

This indicates an object with three properties of type "Float", named "Length", "Width", and "Height", respectively.

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")

In general, Data properties are assigned by using the object's addProperty() method. On the other hand, View properties are normally provided automatically by the parent object from which the scripted object is derived.

For example:

  • Deriving from App::FeaturePython provides only 4 View properties: "Display Mode", "On Top When Selected", "Show In Tree", and "Visibility".
  • Deriving from Part::Feature provides 17 View properties: the previous four, plus "Angular Deflection", "Bounding Box", "Deviation", "Draw Style", "Lighting", "Line Color", "Line Width", "Point Color", "Point Size", "Selectable", "Selection Style", "Shape Color", and "Transparency".

Nevertheless, View properties can also be assigned using the view provider object's addProperty() method.

obj.ViewObject.addProperty("App::PropertyBool", "SuperVisibility", "Base", "Make the object glow")

Source code

In the source code, properties are located in various src/App/Property* files.

They are imported and initialized in src/App/Application.cpp.

#include "Property.h"
#include "PropertyContainer.h"
#include "PropertyUnits.h"
#include "PropertyFile.h"
#include "PropertyLinks.h"
#include "PropertyPythonObject.h"
#include "PropertyExpressionEngine.h"