App GeoFeature/it: Difference between revisions

From FreeCAD Documentation
(Created page with "App GeoFeature")
 
(Updating to match new version of source page)
 
(38 intermediate revisions by 3 users not shown)
Line 1: Line 1:
<languages/>
<languages/>
{{TOCright}}


== Introduction ==
<span id="Introduction"></span>
== Introduzione ==


[[File:Feature.svg|32px]]
[[File:Feature.svg|32px]]


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]].
Un oggetto [[App_GeoFeature/it|App GeoFeature]], o formalmente un {{incode|App::GeoFeature}}, è la classe base della maggior parte degli oggetti che visualizzano elementi geometrici nella [[3D_view/it|vista 3D]] perché include una proprietà {{PropertyData/it|Posizionamento}}.


[[File:FreeCAD_core_objects.svg|800px]]
[[File:FreeCAD_core_objects.svg|800px]]


{{Caption|Diagramma semplificato delle relazioni tra gli oggetti principali in FreeCAD}}
{{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 a shape in the [[3D view|3D view]].}}


<span id="Usage"></span>
== How to use ==
==Utilizzo==


The [[App_GeoFeature|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 defines a bare-bones object that only has a basic [[Placement|Placement]] property to define its position in the [[3D_view|3D view]].
[[App_GeoFeature/it|App GeoFeature]] è un oggetto interno, quindi non può essere creato dall'interfaccia grafica. In genere non è pensato per essere utilizzato direttamente, ma può essere suddiviso in sottoclassi per ottenere un oggetto vuoto che ha solo la proprietà di base {{PropertyData|Placement}} per definire la sua posizione nella [[3D_view/it|vista 3D]] .


<div class="mw-translate-fuzzy">
One of the most important GeoFeatures is the [[Part_Feature|Part Feature]] class, which is the parent of most objects with 2D and 3D [[Part_TopoShape|topological shapes]].
Alcuni degli oggetti derivati più importanti sono i seguenti:
* La classe [[Part_Feature/it|Part Feature]], il genitore della maggior parte degli oggetti con [[Part_TopoShape/it|forme topologiche]] 2D e 3D.
* La classe [[Mesh_Feature/it|Mesh Feature]], il genitore della maggior parte degli oggetti realizzati da [[Mesh_MeshObject/it|mesh]], non solidi.
* La classe [[FEM_Mesh/it|Fem FemMeshObject]], il genitore delle mesh di elementi finiti create con l'ambiente [[FEM_Workbench/it|FEM]].
* La classe [[Path_Feature/it|Path Feature]], il genitore dei percorsi creati con l'ambiente [[Path_Workbench/it|Path]] per l'uso nella lavorazione CNC.
* La classe [[App_Part/it|App Part]], che definisce [[Std_Part/it|Std Parts]] che può essere utilizzato come contenitore di corpi per eseguire assiemi.
</div>


Quando si crea questo oggetto in [[Python/it|Python]], invece di sottoclassare {{incode|App::GeoFeature}}, è necessario sottoclassare {{incode|App::GeometryPython}} perché quest'ultimo include di default un provider di visualizzazione e gli attributi {{incode|Proxy}} per l'oggetto stesso e il relativo provider di visualizzazione. Vedere [[App_GeoFeature/it#Script|Script]].
== Properties ==


<span id="Properties_App_GeoFeature"></span>
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.
== Proprietà App GeoFeature ==


Vedere [[Property/it|Proprietà]] per tutti i tipi di proprietà che possono avere gli oggetti con script.
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]].


L'oggetto [[App_GeoFeature/it|App GeoFeature]] (classe {{incode|App::GeoFeature}}) è derivato dall'oggetto base [[App_DocumentObject/it|App DocumentObject]] (classe {{incode|App::DocumentObject}}) ed eredita tutte le sue proprietà. Inoltre ha una proprietà {{PropertyData|Placement}}, che controlla la sua posizione nella [[3D_view|3D view]].
See [[Property|Property]] for all property types that scripted objects can have.


<span id="Properties_App_GeometryPython"></span>
These are the properties available in the [[property editor|property editor]].
== Proprietà App GeometryPython ==


Vedere [[Property/it|Proprietà]] per tutti i tipi di proprietà che possono avere gli oggetti con script.
=== Data ===

La classe [[App_GeoFeature|App GeometryPython]] ({{incode|App::GeometryPython}}) è derivata dalla classe di base [[App_GeoFeature|App GeoFeature]] ({{incode|App::GeoFeature}}) ed eredita tutte le sue proprietà. Ha anche diverse proprietà aggiuntive.

<div class="mw-translate-fuzzy">
Queste sono le proprietà disponibili nell'[[property editor/it|editor delle proprietà]]. Le proprietà nascoste possono essere mostrate usando il comando {{MenuCommand|Mostra tutto}} nel menu contestuale dell'[[property editor/it|editor delle proprietà]].
</div>

<span id="Data"></span>
=== Dati ===


{{TitleProperty|Base}}
{{TitleProperty|Base}}


* {{PropertyData|Proxy|PythonObject|Hidden}}: a custom class associated with this object.
* {{PropertyData|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}}.
** {{PropertyData|Axis}}: the unit vector that defines the axis of rotation for the placement. Each value is between 0 and 1. If any value is above 1, the vector is normalized so that the magnitude of the vector is 1.
** {{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|Position}}: the 3D coordinates of the base point of the placement.
* {{PropertyData|Label}}: the user editable name of this object, it is an arbitrary UTF8 string.
** {{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|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|[]}}.
* {{PropertyData|Visibility|Bool|Hidden}}: whether to display the object or not.


<span id="View"></span>
=== View ===
===Vista===


{{TitleProperty|Base}}
{{TitleProperty|Base}}
* {{PropertyView|Proxy|PythonObject|Hidden}}: a custom [[Viewprovider|viewprovider]] class associated with this object.


{{TitleProperty|Display Options}}
* {{PropertyView|Bounding Box}}: if it is {{TRUE}}, the object will show the bounding box in the [[3D view|3D view]].
* {{PropertyView|Display Mode}}: 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|Display Mode|Enumeration}}: see the information in [[App_FeaturePython|App FeaturePython]].
* {{PropertyView|On Top When Selected}}: {{value|Disabled}}, {{value|Enabled}}, {{value|Object}}, {{value|Element}}.
* {{PropertyView|Show In Tree|Bool}}: see the information in [[App_FeaturePython|App FeaturePython]].
* {{PropertyView|Selectable}}: 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}}: {{value|Shape}}, {{value|BoundBox}}.
* {{PropertyView|Visibility|Bool}}: see the information in [[App_FeaturePython|App FeaturePython]].
* {{PropertyView|Shape Color}}: a tuple of three 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 light gray <span style="display:inline-block; background-color:#ddd; width:3em; height:12pt;"></span>.
* {{PropertyView|Show In Tree}}: if it is {{TRUE}}, the object appears in the [[tree view|tree view]]. Otherwise, it is set as invisible.
* {{PropertyView|Transparency}}: a float from 0 to 100 that determines the level of transparency of the faces in the [[3D view|3D view]]. A value of 100 indicates completely invisible faces; the faces are invisible but they can still be picked as long as {{PropertyView|Selectable}} is {{TRUE}}.
* {{PropertyView|Visibility}}: 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.


{{TitleProperty|Object Style}}
==== Hidden properties View ====
* {{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}}.


{{TitleProperty|Selection}}
* {{PropertyView|Proxy}}: a class associated with this view provider.
* {{PropertyView|Shape Material}}: a material associated with this object.
* {{PropertyView|On Top When Selected|Enumeration}}: 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|Selection Style|Enumeration}}: see the information in [[App_FeaturePython|App FeaturePython]].


== Scripting ==
<span id="Scripting"></span>
== Script ==


{{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]].


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.


A GeoFeature is created with the {{incode|addObject()}} method of the document. If you would like to create an object with 2D or 3D geometry, it may be better to create one of the sub-classes specialized for those shapes, 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]].


{{Code|code=
{{Code|code=
Line 72: Line 101:
}}
}}


For [[Python|Python]] subclassing you should create the {{incode|App::GeometryPython}} object.
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.

Therefore, for Python scripting, the recommendation is to add the {{incode|App::GeometryPython}} object.


{{Code|code=
{{Code|code=
Line 84: Line 111:
}}
}}


For example, the [[Arch BuildingPart|Arch BuildingPart]] element is an {{incode|App::GeometryPython}} object with a custom icon.


{{Document_objects_navi{{#translation:}}}}
{{Userdocnavi}}
{{Userdocnavi{{#translation:}}}}

Latest revision as of 17:42, 18 April 2024

Introduzione

Un oggetto App GeoFeature, o formalmente un App::GeoFeature, è la classe base della maggior parte degli oggetti che visualizzano elementi geometrici nella vista 3D perché include una proprietà DatiPosizionamento.

Diagramma semplificato delle relazioni tra gli oggetti principali in FreeCAD

Utilizzo

App GeoFeature è un oggetto interno, quindi non può essere creato dall'interfaccia grafica. In genere non è pensato per essere utilizzato direttamente, ma può essere suddiviso in sottoclassi per ottenere un oggetto vuoto che ha solo la proprietà di base DatiPlacement per definire la sua posizione nella vista 3D .

Alcuni degli oggetti derivati più importanti sono i seguenti:

  • La classe Part Feature, il genitore della maggior parte degli oggetti con forme topologiche 2D e 3D.
  • La classe Mesh Feature, il genitore della maggior parte degli oggetti realizzati da mesh, non solidi.
  • La classe Fem FemMeshObject, il genitore delle mesh di elementi finiti create con l'ambiente FEM.
  • La classe Path Feature, il genitore dei percorsi creati con l'ambiente Path per l'uso nella lavorazione CNC.
  • La classe App Part, che definisce Std Parts che può essere utilizzato come contenitore di corpi per eseguire assiemi.

Quando si crea questo oggetto in Python, invece di sottoclassare App::GeoFeature, è necessario sottoclassare App::GeometryPython perché quest'ultimo include di default un provider di visualizzazione e gli attributi Proxy per l'oggetto stesso e il relativo provider di visualizzazione. Vedere Script.

Proprietà App GeoFeature

Vedere Proprietà per tutti i tipi di proprietà che possono avere gli oggetti con script.

L'oggetto App GeoFeature (classe App::GeoFeature) è derivato dall'oggetto base App DocumentObject (classe App::DocumentObject) ed eredita tutte le sue proprietà. Inoltre ha una proprietà DatiPlacement, che controlla la sua posizione nella 3D view.

Proprietà App GeometryPython

Vedere Proprietà per tutti i tipi di proprietà che possono avere gli oggetti con script.

La classe App GeometryPython (App::GeometryPython) è derivata dalla classe di base App GeoFeature (App::GeoFeature) ed eredita tutte le sue proprietà. Ha anche diverse proprietà aggiuntive.

Queste sono le proprietà disponibili nell'editor delle proprietà. Le proprietà nascoste possono essere mostrate usando il comando Mostra tutto nel menu contestuale dell'editor delle proprietà.

Dati

Base

  • Dati (Hidden)Proxy (PythonObject): a custom class associated with this object.
  • DatiPlacement (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.
    • DatiAngle: the angle of rotation around the DatiAxis. By default, it is (zero degrees).
    • DatiAxis: 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).
    • DatiPosition: a vector with the 3D coordinates of the base point. By default, it is the origin (0, 0, 0).
  • DatiLabel (String): the user editable name of this object, it is an arbitrary UTF8 string.
  • Dati (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 "".
  • Dati (Hidden)Expression Engine (ExpressionEngine): a list of expressions. By default, it is empty [].
  • Dati (Hidden)Visibility (Bool): whether to display the object or not.

Vista

Base

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

Display Options

  • VistaBounding Box (Bool): if it is true, the object will show the bounding box in the 3D view.
  • VistaDisplay Mode (Enumeration): see the information in App FeaturePython.
  • VistaShow In Tree (Bool): see the information in App FeaturePython.
  • VistaVisibility (Bool): see the information in App FeaturePython.

Object Style

  • VistaShape 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 .
  • Vista (Hidden)Shape Material (Material): an App Material associated with this object. By default it is empty.
  • VistaTransparency (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 VistaSelectable is true.

Selection

  • VistaOn Top When Selected (Enumeration): see the information in App FeaturePython.
  • VistaSelectable (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.
  • VistaSelection Style (Enumeration): see the information in App FeaturePython.

Script

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"