App GeoFeature: Difference between revisions

From FreeCAD Documentation
No edit summary
(28 intermediate revisions by 5 users not shown)
Line 1: Line 1:
<languages/>
<languages/>
{{TOCright}}
<translate>
<translate>


Line 9: Line 10:


<!--T:2-->
<!--T:2-->
An [[App_GeoFeature|App GeoFeature]] object, or formally an {{incode|App::GeoFeature}}, is the base class of most objects that will display geometrical elements in the [[3D view|3D view]] because it includes the {{PropertyData|Placement}} property.
An [[App_GeoFeature|App GeoFeature]] object, or formally an {{incode|App::GeoFeature}}, is the base class of most objects that will display geometrical elements in the [[3D_view|3D view]] because it includes a {{PropertyData|Placement}} property.


<!--T:3-->
<!--T:3-->
Line 15: Line 16:


<!--T:4-->
<!--T:4-->
{{Caption|Simplified diagram of the relationships between the core objects in the program. The {{incode|App::GeoFeature}} class is the base class of essentially all objects in the software that will display geometry in the [[3D view|3D view]].}}
{{Caption|Simplified diagram of the relationships between the core objects in FreeCAD}}


== How to use == <!--T:5-->
== Usage == <!--T:5-->


<!--T:6-->
<!--T:6-->
Line 26: Line 27:
* The [[Part_Feature|Part Feature]] class, the parent of most objects with 2D and 3D [[Part_TopoShape|topological shapes]].
* The [[Part_Feature|Part Feature]] class, the parent of most objects with 2D and 3D [[Part_TopoShape|topological shapes]].
* The [[Mesh_Feature|Mesh Feature]] class, the parent of most objects made from [[Mesh_MeshObject|meshes]], not solids.
* The [[Mesh_Feature|Mesh Feature]] class, the parent of most objects made from [[Mesh_MeshObject|meshes]], not solids.
* The [[Fem_FemMeshObject|Fem FemMeshObject]] class, the parent of finite element meshes created with the [[FEM_Workbench|FEM Workbench]].
* The [[FEM_Mesh|Fem FemMeshObject]] class, the parent of finite element meshes created with the [[FEM_Workbench|FEM Workbench]].
* The [[Path_Feature|Path Feature]] class, the parent of paths created with the [[Path_Workbench|Path Workbench]] for use in CNC machining.
* The [[Path_Feature|Path Feature]] class, the parent of paths created with the [[Path_Workbench|Path Workbench]] for use in CNC machining.
* The [[App_Part|App Part]] class, which defines [[Std_Part|Std Parts]] that can be used as containers of bodies to perform assemblies.
* The [[App_Part|App Part]] class, which defines [[Std_Part|Std Parts]] that can be used as containers of bodies to perform assemblies.
Line 33: Line 34:
When creating this object in [[Python|Python]], instead of sub-classing {{incode|App::GeoFeature}}, you should sub-class {{incode|App::GeometryPython}} because the latter includes a default view provider, and {{incode|Proxy}} attributes for the object itself, and its view provider. See [[App_GeoFeature#Scripting|Scripting]].
When creating this object in [[Python|Python]], instead of sub-classing {{incode|App::GeoFeature}}, you should sub-class {{incode|App::GeometryPython}} because the latter includes a default view provider, and {{incode|Proxy}} attributes for the object itself, and its view provider. See [[App_GeoFeature#Scripting|Scripting]].


== Properties == <!--T:8-->
== Properties App GeoFeature == <!--T:34-->

<!--T:11-->
See [[Property|Property]] for all property types that scripted objects can have.


<!--T:9-->
<!--T:9-->
An [[App_GeoFeature|App GeoFeature]] ({{incode|App::GeoFeature}} class) is derived from the basic [[App_DocumentObject|App DocumentObject]] ({{incode|App::DocumentObject}} class), therefore it shares all the latter's properties.
The [[App_GeoFeature|App GeoFeature]] ({{incode|App::GeoFeature}} class) is derived from the basic [[App_DocumentObject|App DocumentObject]] ({{incode|App::DocumentObject}} class) and inherits all its properties. In addition it has a {{PropertyData|Placement}} property, which controls its position in the [[3D_view|3D view]].


== Properties App GeometryPython == <!--T:35-->
<!--T:10-->
In addition to the properties described in [[App_DocumentObject|App DocumentObject]], the GeoFeature has the {{PropertyData|Placement}} property, which controls its position in the [[3D view|3D view]].


<!--T:11-->
<!--T:36-->
See [[Property|Property]] for all property types that scripted objects can have.
See [[Property|Property]] for all property types that scripted objects can have.

<!--T:37-->
The [[App_GeoFeature|App GeometryPython]] ({{incode|App::GeometryPython}} class) is derived from the basic [[App_GeoFeature|App GeoFeature]] ({{incode|App::GeoFeature}} class) and inherits all its properties. It also has several additional properties.


<!--T:12-->
<!--T:12-->
These are the properties available in the [[property editor|property editor]]. Hidden properties can be shown by using the {{MenuCommand|Show all}} command in the context menu of the [[property editor|property editor]].
These are the properties available in the [[Property_editor|property editor]]. Hidden properties can be shown by using the {{MenuCommand|Show all}} command in the context menu of the [[Property_editor|property editor]].


=== Data === <!--T:13-->
=== Data === <!--T:13-->
Line 53: Line 59:


<!--T:15-->
<!--T:15-->
* {{PropertyData|Proxy|PythonObject|Hidden}}: a custom class associated with this object.
* {{PropertyData|Placement|Placement}}: the position of the object in the [[3D view|3D view]]. The placement is defined by a {{incode|Base}} point (vector), and a {{incode|Rotation}} (axis and angle). See [[Placement|Placement]].
* {{PropertyData|Placement|Placement}}: the position of the object in the [[3D_view|3D view]]. The placement is defined by a {{incode|Base}} point (vector), and a {{incode|Rotation}} (axis and angle). See [[Placement|Placement]].
** {{PropertyData|Angle}}: the angle of rotation around the {{PropertyData|Axis}}. By default, it is {{value|0°}} (zero degrees).
** {{PropertyData|Angle}}: the angle of rotation around the {{PropertyData|Axis}}. By default, it is {{value|0°}} (zero degrees).
** {{PropertyData|Axis}}: the unit vector that defines the axis of rotation for the placement. Each component is a floating point value between {{value|0}} and {{value|1}}. If any value is above {{value|1}}, the vector is normalized so that the magnitude of the vector is {{value|1}}. By default, it is the positive Z axis, {{value|(0, 0, 1)}}.
** {{PropertyData|Axis}}: the unit vector that defines the axis of rotation for the placement. Each component is a floating point value between {{value|0}} and {{value|1}}. If any value is above {{value|1}}, the vector is normalized so that the magnitude of the vector is {{value|1}}. By default, it is the positive Z axis, {{value|(0, 0, 1)}}.
** {{PropertyData|Position}}: a vector with the 3D coordinates of the base point. By default, it is the origin {{value|(0, 0, 0)}}.
** {{PropertyData|Position}}: a vector with the 3D coordinates of the base point. By default, it is the origin {{value|(0, 0, 0)}}.
* {{PropertyData|Label|String}}: the user editable name of this object, it is an arbitrary UTF8 string.
* {{PropertyData|Label|String}}: the user editable name of this object, it is an arbitrary UTF8 string.
* {{PropertyData|Label2|String|Hidden}}: a longer, user editable description of this object, it is an arbitrary UTF8 string that may include newlines. By default, it is an empty string {{value|""}}.

* {{PropertyData|Expression Engine|ExpressionEngine|Hidden}}: a list of expressions. By default, it is empty {{value|[]}}.
==== Hidden properties Data ==== <!--T:30-->
* {{PropertyData|Visibility|Bool|Hidden}}: whether to display the object or not.

<!--T:31-->
* {{PropertyData|Expression Engine|ExpressionEngine}}: a list of expressions. By default, it is empty {{value|[]}}.
* {{PropertyData|Label2|String}}: a longer, user editable description of this object, it is an arbitrary UTF8 string. By default, it is an empty string {{value|""}}.
* {{PropertyData|Proxy|PythonObject}}: a custom class associated with this object.
* {{PropertyData|Visibility|Bool}}: whether to display the object or not.


=== View === <!--T:16-->
=== View === <!--T:16-->


<!--T:17-->
<!--T:20-->
{{TitleProperty|Base}}
{{TitleProperty|Base}}
* {{PropertyView|Proxy|PythonObject|Hidden}}: a custom [[Viewprovider|viewprovider]] class associated with this object.


<!--T:18-->
<!--T:18-->
{{TitleProperty|Display Options}}
* {{PropertyView|Bounding Box|Bool}}: if it is {{TRUE}}, the object will show the bounding box in the [[3D view|3D view]].
* {{PropertyView|Display Mode|Enumeration}}: it is empty by default.
* {{PropertyView|Bounding Box|Bool}}: if it is {{TRUE}}, the object will show the bounding box in the [[3D_view|3D view]].
* {{PropertyView|On Top When Selected|Enumeration}}: {{value|Disabled}} (default), {{value|Enabled}}, {{value|Object}}, {{value|Element}}.
* {{PropertyView|Display Mode|Enumeration}}: see the information in [[App_FeaturePython|App FeaturePython]].
* {{PropertyView|Show In Tree|Bool}}: see the information in [[App_FeaturePython|App FeaturePython]].
* {{PropertyView|Selectable|Bool}}: if it is {{TRUE}}, the object can be picked with the pointer in the [[3D view|3D view]]. Otherwise, the object cannot be selected until this option is set to {{TRUE}}.
* {{PropertyView|Visibility|Bool}}: see the information in [[App_FeaturePython|App FeaturePython]].
* {{PropertyView|Selection Style|Enumeration}}: {{value|Shape}} (default), {{value|BoundBox}}. If the option is {{value|Shape}}, the entire shape (vertices, edges, and faces) will be highlighted in the [[3D view|3D view]]; if it is {{value|BoundBox}} only the bounding box will be highlighted.
* {{PropertyView|Shape Color|Color}}: a tuple of three floating point RGB values {{value|(r,g,b)}} to define the color of the faces in the [[3D view|3D view]]; by default it is {{value|(0.8, 0.8, 0.8)}}, which is displayed as {{value|[204,204,204]}} on base 255, a <span style="background-color:#ccc; width:3em; height:12pt; padding: 2px 1em 2px;"> light gray </span>.
* {{PropertyView|Show In Tree|Bool}}: if it is {{TRUE}}, the object appears in the [[tree view|tree view]]. Otherwise, it is set as invisible.
* {{PropertyView|Transparency|Percent}}: an integer from {{value|0}} to {{value|100}} that determines the level of transparency of the faces in the [[3D view|3D view]]. A value of {{value|100}} indicates completely invisible faces; the faces are invisible but they can still be picked as long as {{PropertyView|Selectable}} is {{TRUE}}.
* {{PropertyView|Visibility|Bool}}: if it is {{TRUE}}, the object appears in the [[3D view|3D view]]; otherwise it is invisible. By default this property can be toggled on and off by pressing the {{KEY|Space}} bar in the keyboard.


==== Hidden properties View ==== <!--T:19-->
<!--T:32-->
{{TitleProperty|Object Style}}
* {{PropertyView|Shape Color|Color}}: a tuple of three floating point RGB values {{value|(r,g,b)}} to define the color of the faces in the [[3D_view|3D view]]; by default it is {{value|(0.8, 0.8, 0.8)}}, which is displayed as {{value|[204, 204, 204]}} on base 255, a <span style="background-color:#ccc; width:3em; height:12pt; padding: 2px 1em 2px;"> light gray </span>.
* {{PropertyView|Shape Material|Material|Hidden}}: an [[App_Material|App Material]] associated with this object. By default it is empty.
* {{PropertyView|Transparency|Percent}}: an integer from {{value|0}} to {{value|100}} that determines the level of transparency of the faces in the [[3D_view|3D view]]. A value of {{value|100}} indicates completely invisible faces; the faces are invisible but they can still be picked as long as {{PropertyView|Selectable}} is {{TRUE}}.


<!--T:20-->
<!--T:33-->
{{TitleProperty|Selection}}
* {{PropertyView|Proxy|PythonObject}}: a custom view provider class associated with this object. By default it is empty.
* {{PropertyView|On Top When Selected|Enumeration}}: see the information in [[App_FeaturePython|App FeaturePython]].
* {{PropertyView|Shape Material|Material}}: an [[App_Material|App Material]] associated with this object. By default it is empty.
* {{PropertyView|Selectable|Bool}}: if it is {{TRUE}}, the object can be picked with the pointer in the [[3D_view|3D view]]. Otherwise, the object cannot be selected until this option is set to {{TRUE}}.
* {{PropertyView|Selection Style|Enumeration}}: see the information in [[App_FeaturePython|App FeaturePython]].


== Scripting == <!--T:21-->
== Scripting == <!--T:21-->


<!--T:22-->
<!--T:22-->
{{Emphasis|See also:}} [[FreeCAD Scripting Basics|FreeCAD Scripting Basics]], and [[scripted objects|scripted objects]].
{{Emphasis|See also:}} [[FreeCAD_Scripting_Basics|FreeCAD Scripting Basics]] and [[Scripted_objects|scripted objects]].


<!--T:23-->
<!--T:23-->
See [[Part_Feature|Part Feature]] for the general information on adding objects to the program
See [[Part_Feature|Part Feature]] for the general information on adding objects to the document.


<!--T:24-->
<!--T:24-->
A GeoFeature is created with the {{incode|addObject()}} method of the document. If you would like to create an object with a 2D or 3D [[Part_TopoShape|topological shape]], it may be better to create one of the sub-classes specialized for that, for example, [[Part_Feature|Part Feature]] or [[Part_Part2DObject|Part Part2DObject]].
A GeoFeature is created with the {{incode|addObject()}} method of the document. If you would like to create an object with a 2D or 3D [[Part_TopoShape|topological shape]], it may be better to create one of the sub-classes specialized for handling shapes, for example [[Part_Feature|Part Feature]] or [[Part_Part2DObject|Part Part2DObject]].


</translate>
</translate>
Line 109: Line 114:
}}
}}
<translate>
<translate>

<!--T:25-->
This basic {{incode|App::GeoFeature}} doesn't have a default view provider, so no icon will be displayed on the [[tree view|tree view]], and no {{MenuCommand|View}} properties will be available.


<!--T:26-->
<!--T:26-->
Therefore, for [[Python|Python]] scripting, the recommendation is to create the {{incode|App::GeometryPython}} object.
For [[Python|Python]] subclassing you should create the {{incode|App::GeometryPython}} object.


</translate>
</translate>
Line 126: Line 128:
<translate>
<translate>


<!--T:27-->
For example, the [[Arch_BuildingPart|Arch BuildingPart]] element of the [[Arch_Workbench|Arch Workbench]] is an {{incode|App::GeometryPython}} object with a custom icon.

<!--T:28-->
{{Userdocnavi}}


</translate>
</translate>
{{Document_objects_navi{{#translation:}}}}
{{Userdocnavi{{#translation:}}}}

Revision as of 07:43, 22 February 2022

Introduction

An App GeoFeature object, or formally an App::GeoFeature, is the base class of most objects that will display geometrical elements in the 3D view because it includes a DataPlacement property.

Simplified diagram of the relationships between the core objects in FreeCAD

Usage

The App GeoFeature is an internal object, so it cannot be created from the graphical interface. It is generally not meant to be used directly, rather it can be sub-classed to get a bare-bones object that only has a basic DataPlacement property to define its position in the 3D view.

Some of the most important derived objects are the following:

When creating this object in Python, instead of sub-classing App::GeoFeature, you should sub-class App::GeometryPython because the latter includes a default view provider, and Proxy attributes for the object itself, and its view provider. See Scripting.

Properties App GeoFeature

See Property for all property types that scripted objects can have.

The App GeoFeature (App::GeoFeature class) is derived from the basic App DocumentObject (App::DocumentObject class) and inherits all its properties. In addition it has a DataPlacement property, which controls its position in the 3D view.

Properties App GeometryPython

See Property for all property types that scripted objects can have.

The App GeometryPython (App::GeometryPython class) is derived from the basic App GeoFeature (App::GeoFeature class) and inherits all its properties. It also has several additional properties.

These are the properties available in the property editor. Hidden properties can be shown by using the Show all command in the context menu of the property editor.

Data

Base

  • Data (Hidden)Proxy (PythonObject): a custom class associated with this object.
  • DataPlacement (Placement): the position of the object in the 3D view. The placement is defined by a Base point (vector), and a Rotation (axis and angle). See Placement.
    • DataAngle: the angle of rotation around the DataAxis. By default, it is (zero degrees).
    • DataAxis: the unit vector that defines the axis of rotation for the placement. Each component is a floating point value between 0 and 1. If any value is above 1, the vector is normalized so that the magnitude of the vector is 1. By default, it is the positive Z axis, (0, 0, 1).
    • DataPosition: a vector with the 3D coordinates of the base point. By default, it is the origin (0, 0, 0).
  • DataLabel (String): the user editable name of this object, it is an arbitrary UTF8 string.
  • Data (Hidden)Label2 (String): a longer, user editable description of this object, it is an arbitrary UTF8 string that may include newlines. By default, it is an empty string "".
  • Data (Hidden)Expression Engine (ExpressionEngine): a list of expressions. By default, it is empty [].
  • Data (Hidden)Visibility (Bool): whether to display the object or not.

View

Base

  • View (Hidden)Proxy (PythonObject): a custom viewprovider class associated with this object.

Display Options

  • ViewBounding Box (Bool): if it is true, the object will show the bounding box in the 3D view.
  • ViewDisplay Mode (Enumeration): see the information in App FeaturePython.
  • ViewShow In Tree (Bool): see the information in App FeaturePython.
  • ViewVisibility (Bool): see the information in App FeaturePython.

Object Style

  • ViewShape Color (Color): a tuple of three floating point RGB values (r,g,b) to define the color of the faces in the 3D view; by default it is (0.8, 0.8, 0.8), which is displayed as [204, 204, 204] on base 255, a light gray .
  • View (Hidden)Shape Material (Material): an App Material associated with this object. By default it is empty.
  • ViewTransparency (Percent): an integer from 0 to 100 that determines the level of transparency of the faces in the 3D view. A value of 100 indicates completely invisible faces; the faces are invisible but they can still be picked as long as ViewSelectable is true.

Selection

  • ViewOn Top When Selected (Enumeration): see the information in App FeaturePython.
  • ViewSelectable (Bool): if it is true, the object can be picked with the pointer in the 3D view. Otherwise, the object cannot be selected until this option is set to true.
  • ViewSelection Style (Enumeration): see the information in App FeaturePython.

Scripting

See also: FreeCAD Scripting Basics and scripted objects.

See Part Feature for the general information on adding objects to the document.

A GeoFeature is created with the addObject() method of the document. If you would like to create an object with a 2D or 3D topological shape, it may be better to create one of the sub-classes specialized for handling shapes, for example Part Feature or Part Part2DObject.

import FreeCAD as App

doc = App.newDocument()
obj = App.ActiveDocument.addObject("App::GeoFeature", "Name")
obj.Label = "Custom label"

For Python subclassing you should create the App::GeometryPython object.

import FreeCAD as App

doc = App.newDocument()
obj = App.ActiveDocument.addObject("App::GeometryPython", "Name")
obj.Label = "Custom label"