Mesh Feature: Difference between revisions
m (Tweek) |
(Marked this version for translation) |
||
(19 intermediate revisions by 4 users not shown) | |||
Line 1: | Line 1: | ||
<languages/> |
<languages/> |
||
{{TOCright}} |
|||
<translate> |
<translate> |
||
== Introduction == <!--T:14--> |
== Introduction == <!--T:14--> |
||
</translate> |
|||
[[File:Mesh_Tree.svg|32px]] |
|||
<translate> |
|||
<!--T:15--> |
<!--T:15--> |
||
A |
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--> |
<!--T:16--> |
||
Line 11: | Line 16: | ||
<!--T:17--> |
<!--T:17--> |
||
Please note that the |
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--> |
<!--T:18--> |
||
Line 17: | Line 22: | ||
<!--T:19--> |
<!--T:19--> |
||
{{Caption|Simplified diagram of the relationships between the core objects in |
{{Caption|Simplified diagram of the relationships between the core objects in FreeCAD}} |
||
== Usage == <!--T:20--> |
== Usage == <!--T:20--> |
||
<!--T:21--> |
<!--T:21--> |
||
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--> |
<!--T:22--> |
||
The {{incode|Mesh::Feature}} is defined in the [[ |
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--> |
<!--T:23--> |
||
A {{incode|Mesh::Feature}} has simple properties like a [[Placement|placement]], and visual properties to define the appearance of its edges and faces |
A {{incode|Mesh::Feature}} has simple properties like a [[Placement|placement]], and visual properties to define the appearance of its edges and faces. |
||
== Properties == <!--T:24--> |
== Properties == <!--T:24--> |
||
⚫ | |||
⚫ | |||
⚫ | |||
In addition to the properties described in [[App_GeoFeature|App GeoFeature]], the Mesh Feature has the {{PropertyData|Mesh}} property, which stores the [[Mesh_MeshObject|Mesh MeshObject]] of this element; this is the geometry that is shown in the [[3D view|3D view]]. |
|||
⚫ | |||
Other properties that this object has are those related to the appearance of its [[Mesh_MeshObject|Mesh MeshObject]], including {{PropertyView|Crease Angle}}, {{PropertyView|Lighting}}, {{PropertyView|Line Color}}, {{PropertyView|Line Transparency}}, {{PropertyView|Line Width}}, {{PropertyView|Open Edges}}, {{PropertyView|Point Size}}, and also the hidden property {{PropertyView|Coloring}}. |
|||
<!--T:28--> |
<!--T:28--> |
||
See [[Property|Property]] for all property types that scripted objects can have. |
See [[Property|Property]] for all property types that scripted objects can have. |
||
⚫ | |||
⚫ | The [[Mesh_Feature|Mesh Feature]] ({{incode|Mesh::Feature}} 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. Notably a {{PropertyData|Mesh}} property, which stores its [[Mesh_MeshObject|Mesh MeshObject]]. This is the geometry that is shown in the [[3D_view|3D view]]. |
||
<!--T:29--> |
<!--T:29--> |
||
These are the properties available in the [[ |
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:30--> |
=== Data === <!--T:30--> |
||
Line 53: | Line 52: | ||
<!--T:32--> |
<!--T:32--> |
||
⚫ | |||
* {{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|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 [[ |
* {{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. |
||
⚫ | |||
⚫ | |||
==== Hidden properties Data ==== <!--T:33--> |
|||
⚫ | |||
⚫ | |||
⚫ | |||
⚫ | |||
⚫ | |||
⚫ | |||
=== View === <!--T:35--> |
=== View === <!--T:35--> |
||
⚫ | |||
Most objects in FreeCAD have what is called a "view provider", which is a class that defines the visual appearance of the object in the [[3D view|3D view]], and in the [[tree view|tree view]]. The default view provider of Mesh Feature objects defines the following properties. Scripted objects that are derived from Mesh Feature will have access to these properties as well. |
|||
<!--T:37--> |
<!--T:37--> |
||
{{TitleProperty|Base}} |
{{TitleProperty|Base}} |
||
⚫ | |||
* {{PropertyView|Proxy|PythonObject|Hidden}}: a custom [[Viewprovider|viewprovider]] class associated with this object. This only exists for the [[Python|Python]] version. See [[#Scripting|Scripting]]. |
|||
⚫ | |||
{{TitleProperty|Display Options}} |
|||
⚫ | |||
* {{PropertyView|Bounding Box|Bool}}: if it is {{TRUE}}, the object will show the bounding box in the [[3D_view|3D view]]. |
|||
⚫ | |||
⚫ | |||
⚫ | |||
⚫ | |||
{{TitleProperty|Object Style}} |
|||
<!--T:38--> |
<!--T:38--> |
||
* {{PropertyView| |
* {{PropertyView|Coloring|Bool|Hidden}}: it defaults to {{FALSE}}. |
||
* {{PropertyView|Crease Angle|FloatConstraint}}: |
* {{PropertyView|Crease Angle|FloatConstraint}}: |
||
* {{PropertyView| |
* {{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|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 |
* {{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 |
* {{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|Open Edges|Bool}}: it defaults to {{FALSE}}. |
||
* {{PropertyView|Point Size|FloatConstraint}}: similar to {{PropertyView|Line Width}}, defines the size of the vertices. |
* {{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 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| |
* {{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 [[ |
* {{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: |
<!--T:54--> |
||
* {{PropertyView| |
* {{PropertyView|On Top When Selected|Enumeration}}: {{value|Disabled}} (default), {{value|Enabled}}, {{value|Object}}, {{value|Element}}. |
||
* {{PropertyView| |
* {{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|Shape Material|Material}}: an [[App_Material|App Material]] associated with this object. By default it is empty. |
|||
== Scripting == <!--T:41--> |
== Scripting == <!--T:41--> |
||
<!--T:42--> |
<!--T:42--> |
||
{{Emphasis|See also:}} [[ |
{{Emphasis|See also:}} [[FreeCAD_Scripting_Basics|FreeCAD Scripting Basics]] and [[Scripted_objects|scripted objects]]. |
||
<!--T:43--> |
<!--T:43--> |
||
See [[Part_Feature|Part Feature]] for the general information on adding objects to the |
See [[Part_Feature|Part Feature]] for the general information on adding objects to the document. |
||
<!--T:44--> |
<!--T:44--> |
||
A Mesh Feature is created with the {{incode|addObject()}} method of the document. |
A Mesh Feature is created with the {{incode|addObject()}} method of the document. |
||
</translate> |
</translate> |
||
{{Code|code= |
{{Code|code= |
||
Line 120: | Line 124: | ||
}} |
}} |
||
<translate> |
<translate> |
||
<!--T:45--> |
|||
This basic {{incode|Mesh::Feature}} doesn't have a Proxy object so it can't be fully used for sub-classing. |
|||
<!--T:46--> |
<!--T:46--> |
||
For [[Python|Python]] subclassing you should create the {{incode|Mesh::FeaturePython}} object. |
|||
</translate> |
</translate> |
||
{{Code|code= |
{{Code|code= |
||
Line 136: | Line 138: | ||
<translate> |
<translate> |
||
<!--T:13--> |
|||
{{Mesh Tools navi}} |
|||
{{Document objects navi}} |
|||
⚫ | |||
</translate> |
</translate> |
||
{{Mesh_Tools_navi{{#translation:}}}} |
|||
{{Document_objects_navi{{#translation:}}}} |
|||
⚫ | |||
[[Category:Glossary{{#translation:}}]] |
Latest revision as of 07:53, 22 February 2022
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 ofPoints
,Edges
, andFaces
of the mesh. - DataPlacement (
Placement
): the position of the object in the 3D view. The placement is defined by aBase
point (vector), and aRotation
(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
and1
. If any value is above1
, the vector is normalized so that the magnitude of the vector is1
. 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)
.
- DataAngle: the angle of rotation around the DataAxis. By default, it is
- 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 istrue
, 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 istrue
, the object appears in the Tree view. Otherwise, it is set as invisible. - ViewVisibility (
Bool
): if it istrue
, 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 tofalse
. - 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 from0
to100
(a percentage) that determines the level of transparency of the edges in the 3D view. A value of100
indicates completely invisible edges; the edges are invisible but they can still be picked as long as ViewSelectable istrue
. - ViewLine Width (
FloatConstraint
): a float that determines the width in pixels of the edges in the 3D view. It defaults to1.0
. - ViewOpen Edges (
Bool
): it defaults tofalse
. - 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 from0
to100
(a percentage) that determines the level of transparency of the faces in the 3D view. A value of100
indicates completely invisible faces; the faces are invisible but they can still be picked as long as ViewSelectable istrue
.
Selection
- ViewOn Top When Selected (
Enumeration
):Disabled
(default),Enabled
,Object
,Element
. - ViewSelectable (
Bool
): if it istrue
, the object can be picked with the pointer in the 3D view. Otherwise, the object cannot be selected until this option is set totrue
. - ViewSelection Style (
Enumeration
):Shape
(default),BoundBox
. If the option isShape
, the entire shape (vertices, edges, and faces) will be highlighted in the 3D view; if it isBoundBox
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"
- 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
- 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
- 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
- Hubs: User hub, Power users hub, Developer hub