Mesh Feature: Difference between revisions

Latest revision as of 07:53, 22 February 2022

Other languages:

Introduction

A Mesh Feature object, or formally a Mesh::Feature, is a simple element with an associated mesh object that can be displayed in the 3D view.

A Mesh Feature is similar conceptually to a Part Feature; the former is the base object for elements with "mesh" information, while the latter is the base object for elements with "geometrical shape" information.

Please note that the FEM Workbench also uses meshes, but it uses a different object, called FEM FemMeshObject (Fem::FemMeshObject class). This object is not derived from the Mesh Feature and has different properties.

Simplified diagram of the relationships between the core objects in FreeCAD

Usage

Almost all mesh objects created by the commands available in the Mesh Workbench are Mesh Features. The parametric mesh objects created by the Mesh BuildRegularSolid command are the only exception. A Mesh Feature can also be created from the Python console as described in the Scripting section.

The Mesh::Feature is defined in the Mesh Workbench but can be used as the base class for scripted objects in all workbenches that produce 2D and 3D meshes.

A Mesh::Feature has simple properties like a placement, and visual properties to define the appearance of its edges and faces.

Properties

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

The Mesh Feature (Mesh::Feature class) is derived from the basic App GeoFeature (App::GeoFeature class) and inherits all its properties. It also has several additional properties. Notably a DataMesh property, which stores its Mesh MeshObject. This is the geometry that is shown in the 3D view.

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. This only exists for the Python version. See Scripting.
DataMesh (MeshKernel): a Mesh MeshObject class associated with this object. It lists the number of Points, Edges, and Faces of the mesh.
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 0° (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. This only exists for the Python version. See Scripting.

Display Options

ViewBounding Box (Bool): if it is true, the object will show the bounding box in the 3D view.
ViewDisplay Mode (Enumeration): Shaded (no edges), Wireframe (no faces), Flat Lines (regular visualization), Points (only vertices).
ViewShow In Tree (Bool): if it is true, the object appears in the Tree view. Otherwise, it is set as invisible.
ViewVisibility (Bool): if it is true, the object appears in the 3D view; otherwise it is invisible. By default this property can be toggled on and off by pressing the Space bar.

Object Style

View (Hidden)Coloring (Bool): it defaults to false.
ViewCrease Angle (FloatConstraint):
ViewLighting (Enumeration): One side (default), Two side; the illumination comes from two sides or one side in the 3D view.
ViewLine Color (Color): a tuple of three floating point RGB values (r,g,b) to define the color of the edges in the 3D view; by default it is (0.0, 0.0, 0.0), which is displayed as [0,0,0] on base 255, completely black .
ViewLine Transparency (Percent): an integer from 0 to 100 (a percentage) that determines the level of transparency of the edges in the 3D view. A value of 100 indicates completely invisible edges; the edges are invisible but they can still be picked as long as ViewSelectable is true.
ViewLine Width (FloatConstraint): a float that determines the width in pixels of the edges in the 3D view. It defaults to 1.0.
ViewOpen Edges (Bool): it defaults to false.
ViewPoint Size (FloatConstraint): similar to ViewLine Width, defines the size of the vertices.
ViewShape Color (Color): similar to ViewLine Color, defines the color of the faces. It defaults to (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 (a percentage) 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): Disabled (default), Enabled, Object, Element.
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): Shape (default), BoundBox. If the option is Shape, the entire shape (vertices, edges, and faces) will be highlighted in the 3D view; if it is BoundBox only the bounding box will be highlighted.

Scripting

See also: FreeCAD Scripting Basics and scripted objects.

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

A Mesh Feature is created with the addObject() method of the document.

import FreeCAD as App

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

For Python subclassing you should create the Mesh::FeaturePython object.

import FreeCAD as App

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

Mesh

Miscellaneous: Import mesh, Export mesh, Create mesh from shape, Regular solid, Unwrap Mesh, Unwrap Face
Modifying: Harmonize normals, Flip normals, Fill holes, Close hole, Add triangle, Remove components, Remove components by hand, Smooth, Refinement, Decimation, Scale

Boolean: Union, Intersection, Difference
Cutting: Cut mesh, Trim mesh, Trim mesh with a plane, Create section from mesh and plane, Cross-sections
Components and segments: Merge, Split by components, Create mesh segments, Create mesh segments from best-fit surfaces

Analyze: Evaluate and repair mesh, Face info, Curvature plot, Curvature info, Check solid mesh, Boundings info
Additional: Import Export Preferences, OpenSCAD Workbench, Mesh Scripting

Document objects

Core: App DocumentObject
Basic: App FeaturePython, App GeoFeature, Part Feature, Mesh Feature, Fem FemMeshObject
Internal shapes: Part TopoShape, Mesh MeshObject, Fem FemMesh

Structure: App DocumentObjectGroup (Std Group), App Part (Std Part), App Link (Std LinkMake)
Derived: Part Part2DObject, Sketcher SketchObject, PartDesign Body, PartDesign Feature

Explanation: Model, Shape, Body, Feature, Part, Assembly, Mesh, Sketch, Drawing, Datum

User documentation

Getting started
Installation: Download, Windows, Linux, Mac, Additional components, Docker, AppImage, Ubuntu Snap
Basics: About FreeCAD, Interface, Mouse navigation, Selection methods, Object name, Preferences, Workbenches, Document structure, Properties, Help FreeCAD, Donate

Help: Tutorials, Video tutorials
Workbenches: Std Base, Arch, Assembly, CAM, Draft, FEM, Inspection, Mesh, OpenSCAD, Part, PartDesign, Points, Reverse Engineering, Robot, Sketcher, Spreadsheet, Start, Surface, TechDraw, Test Framework, Web

Addons: Addon Manager, External workbenches, Scripting and macros

Hubs: User hub, Power users hub, Developer hub

@@ Line 4: / Line 4: @@
 == Introduction == <!--T:14-->
+</translate>
+[[File:Mesh_Tree.svg|32px]]
+<translate>
 <!--T:15-->
-A [[Image:Mesh_Tree.svg|32px]] [[Mesh Feature|Mesh Feature]] object, or formally a {{incode|Mesh::Feature}}, is a simple element with a [[Mesh_MeshObject|mesh object]] associated to it that can be displayed in the [[3D view|3D view]].
+A [[Mesh Feature|Mesh Feature]] object, or formally a {{incode|Mesh::Feature}}, is a simple element with an associated [[Mesh_MeshObject|mesh object]] that can be displayed in the [[3D_view|3D view]].
 <!--T:16-->
@@ Line 12: / Line 16: @@
 <!--T:17-->
-Please note that the {{Button|[[Image:Workbench_FEM.svg|16px]] [[FEM_Workbench|FEM Workbench]]}} also uses meshes, but in this case it uses a different object, called [[FEM_Mesh|FEM FemMeshObject]] ({{incode|Fem::FemMeshObject}} class). This object is not derived from Mesh Feature so it has different properties.
+Please note that the [[FEM_Workbench|FEM Workbench]] also uses meshes, but it uses a different object, called [[FEM_Mesh|FEM FemMeshObject]] ({{incode|Fem::FemMeshObject}} class). This object is not derived from the Mesh Feature and has different properties.
 <!--T:18-->
@@ Line 18: / Line 22: @@
 <!--T:19-->
-{{Caption|Simplified diagram of the relationships between the core objects in the program. The {{incode|Mesh::Feature}} class is the origin of most objects that posses a [[Mesh_MeshObject|triangular mesh]]. These objects are created from the [[Mesh Workbench|Mesh Workbench]] or by importing STL, OBJ, and similar mesh format files.}}
+{{Caption|Simplified diagram of the relationships between the core objects in FreeCAD}}
 == Usage == <!--T:20-->
 <!--T:21-->
-Almost all mesh objects created by the commands available in the [[Mesh Workbench|Mesh Workbench]] graphical interface are [[Mesh Feature|Mesh Features]]. The parametric mesh objects created by the [[Mesh_BuildRegularSolid|Mesh BuildRegularSolid]] command are the only exception. A [[Mesh Feature|Mesh Feature]] can also be created from the [[Python console|Python console]] as described in the [[#Scripting|Scripting]] section.
+Almost all mesh objects created by the commands available in the [[Mesh_Workbench|Mesh Workbench]] are [[Mesh_Feature|Mesh Features]]. The parametric mesh objects created by the [[Mesh_BuildRegularSolid|Mesh BuildRegularSolid]] command are the only exception. A [[Mesh_Feature|Mesh Feature]] can also be created from the [[Python_console|Python console]] as described in the [[#Scripting|Scripting]] section.
 <!--T:22-->
-The {{incode|Mesh::Feature}} is defined in the [[Mesh Workbench|Mesh Workbench]] but can be used as the base class for [[Scripted_objects|scripted objects]] in all [[Workbenches|workbenches]] that produce 2D and 3D meshes.
+The {{incode|Mesh::Feature}} is defined in the [[Mesh_Workbench|Mesh Workbench]] but can be used as the base class for [[Scripted_objects|scripted objects]] in all [[Workbenches|workbenches]] that produce 2D and 3D meshes.
 <!--T:23-->
@@ Line 50: / Line 54: @@
 * {{PropertyData|Proxy|PythonObject|Hidden}}: a custom class associated with this object. This only exists for the [[Python|Python]] version. See [[#Scripting|Scripting]].
 * {{PropertyData|Mesh|MeshKernel}}: a [[Mesh_MeshObject|Mesh MeshObject]] class associated with this object. It lists the number of {{Value|Points}}, {{Value|Edges}}, and {{Value|Faces}} of the mesh.
-* {{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|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)}}.
@@ Line 64: / Line 68: @@
 {{TitleProperty|Base}}
+<!--T:49-->
-* {{PropertyView|Proxy|PythonObject|Hidden}}: a custom [[viewprovider|viewprovider]] class associated with this object. This only exists for the [[Python|Python]] version. See [[#Scripting|Scripting]].
+* {{PropertyView|Proxy|PythonObject|Hidden}}: a custom [[Viewprovider|viewprovider]] class associated with this object. This only exists for the [[Python|Python]] version. See [[#Scripting|Scripting]].
+<!--T:50-->
 {{TitleProperty|Display Options}}
+<!--T:51-->
-* {{PropertyView|Bounding Box|Bool}}: if it is {{TRUE}}, the object will show the bounding box in the [[3D view|3D view]].
+* {{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}}: {{value|Shaded}} (no edges), {{value|Wireframe}} (no faces), {{value|Flat Lines}} (regular visualization), {{value|Points}} (only vertices).
-* {{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|Show In Tree|Bool}}: if it is {{TRUE}}, the object appears in the [[Tree_view|Tree view]]. Otherwise, it is set as invisible.
-* {{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.
+* {{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.
+<!--T:52-->
 {{TitleProperty|Object Style}}
@@ Line 78: / Line 86: @@
 * {{PropertyView|Coloring|Bool|Hidden}}: it defaults to {{FALSE}}.
 * {{PropertyView|Crease Angle|FloatConstraint}}:
-* {{PropertyView|Lighting|Enumeration}}: {{value|One side}} (default), {{value|Two side}}; the illumination comes from two sides or one side in the [[3D view|3D view]].
+* {{PropertyView|Lighting|Enumeration}}: {{value|One side}} (default), {{value|Two side}}; the illumination comes from two sides or one side in the [[3D_view|3D view]].
-* {{PropertyView|Line Color|Color}}: a tuple of three floating point RGB values {{value|(r,g,b)}} to define the color of the edges in the [[3D view|3D view]]; by default it is {{value|(0.0, 0.0, 0.0)}}, which is displayed as {{value|[0,0,0]}} on base 255, <span style="background-color:#000; color:#eee; width:3em; height:12pt; padding: 2px 1em 2px;">completely black </span>.
+* {{PropertyView|Line Color|Color}}: a tuple of three floating point RGB values {{value|(r,g,b)}} to define the color of the edges in the [[3D_view|3D view]]; by default it is {{value|(0.0, 0.0, 0.0)}}, which is displayed as {{value|[0,0,0]}} on base 255, <span style="background-color:#000; color:#eee; width:3em; height:12pt; padding: 2px 1em 2px;">completely black </span>.
-* {{PropertyView|Line Transparency|Percent}}: an integer from {{value|0}} to {{value|100}} (a percentage) that determines the level of transparency of the edges in the [[3D view|3D view]]. A value of {{value|100}} indicates completely invisible edges; the edges are invisible but they can still be picked as long as {{PropertyView|Selectable}} is {{TRUE}}.
+* {{PropertyView|Line Transparency|Percent}}: an integer from {{value|0}} to {{value|100}} (a percentage) that determines the level of transparency of the edges in the [[3D_view|3D view]]. A value of {{value|100}} indicates completely invisible edges; the edges are invisible but they can still be picked as long as {{PropertyView|Selectable}} is {{TRUE}}.
-* {{PropertyView|Line Width|FloatConstraint}}: a float that determines the width in pixels of the edges in the [[3D view|3D view]]. It defaults to {{value|1.0}}.
+* {{PropertyView|Line Width|FloatConstraint}}: a float that determines the width in pixels of the edges in the [[3D_view|3D view]]. It defaults to {{value|1.0}}.
 * {{PropertyView|Open Edges|Bool}}: it defaults to {{FALSE}}.
 * {{PropertyView|Point Size|FloatConstraint}}: similar to {{PropertyView|Line Width}}, defines the size of the vertices.
 * {{PropertyView|Shape Color|Color}}: similar to {{PropertyView|Line Color}}, defines the color of the faces. It defaults to {{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}} (a percentage) 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|Transparency|Percent}}: an integer from {{value|0}} to {{value|100}} (a percentage) 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:53-->
 {{TitleProperty|Selection}}
+<!--T:54-->
 * {{PropertyView|On Top When Selected|Enumeration}}: {{value|Disabled}} (default), {{value|Enabled}}, {{value|Object}}, {{value|Element}}.
-* {{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|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}}: {{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|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.
 == Scripting == <!--T:41-->
 <!--T:42-->
-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:43-->
@@ Line 130: / Line 140: @@
 </translate>
-{{Mesh Tools navi{{#translation:}}}}
+{{Mesh_Tools_navi{{#translation:}}}}
-{{Document objects navi{{#translation:}}}}
+{{Document_objects_navi{{#translation:}}}}
 {{Userdocnavi{{#translation:}}}}
 [[Category:Glossary{{#translation:}}]]