Draft Shape2DView: Difference between revisions

From FreeCAD Documentation
m (grammar)
(Button text.)
 
(77 intermediate revisions by 8 users not shown)
Line 1: Line 1:
<languages/>
<languages/>
<translate>
<translate>

<!--T:20-->
{{Docnav
|[[Draft_FlipDimension|FlipDimension]]
|[[Draft_SelectPlane|SelectPlane]]
|[[Draft_Workbench|Draft]]
|IconL=Draft_FlipDimension.svg
|IconR=Draft_SelectPlane.svg
|IconC=Workbench_Draft.svg
}}

<!--T:1-->
<!--T:1-->
{{GuiCommand
{{GuiCommand
|Name=Draft Shape2DView
|Name=Draft Shape2DView
|MenuLocation=Draft → Shape 2D View
|MenuLocation=Modification → Shape 2D view
|Workbenches=[[Draft Module|Draft]], [[Arch Module|Arch]]
|Workbenches=[[Draft_Workbench|Draft]], [[Arch_Workbench|Arch]]
|SeeAlso=[[TechDraw_ProjectShape|TechDraw ProjectShape]]
|SeeAlso=[[Part Workbench]], [[Arch Workbench]]
}}
}}


Line 12: Line 23:


<!--T:3-->
<!--T:3-->
The [[Image:Draft_Shape2DView.svg|24px]] '''Draft Shape2DView''' command creates 2D projections from selected objects, usually 3D solids or [[Arch_SectionPlane|Arch SectionPlanes]]. The projections are placed in the [[3D_view|3D view]].
This tool produces a 2D projection from a selected 3D solid object such as those created with the [[Part Workbench|Part]], [[PartDesign Workbench|PartDesign]], and [[Arch Workbench]]es.


<!--T:14-->
The resulting projection is a Draft object and is placed in the 3D view. This object can be displayed on a [[TechDraw Workbench]] Page, using the [[TechDraw NewDraft]] tool. Alternatively, TechDraw has its own tools to create projected views in [[TechDraw NewView]] and [[TechDraw NewProjGroup]]; however, these tools are meant for preparing technical drawings, so they create the views only in the drawing page, and not in the 3D view.
Draft Shape2DView projections can be displayed on a [[TechDraw_Workbench|TechDraw Workbench]] page using the [[TechDraw_DraftView|TechDraw DraftView]] command. Alternatively the [[TechDraw_Workbench|TechDraw Workbench]] offer its own projection commands. But these create projections that are only displayed on the drawing page and not in the [[3D_view|3D view]].


</translate>
</translate>
[[Image:Draft_Shape2DView_example.jpg]]
[[Image:Draft_Shape2DView_example.jpg]]
<translate>
<translate>
<!--T:15-->
{{Caption|Projection of solid shapes onto the XY plane}}


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


<!--T:5-->
<!--T:5-->
# Optionally rotate the [[3D_view|3D view]]. The camera direction in the [[3D_view|3D view]] determines the projection vector. For example, a [[Std_ViewTop|top view]] will project onto the XY plane. The projection vector is ignored for projections created from [[Arch_SectionPlane|Arch SectionPlanes]].
# Select the object you want to extract a 2D view from
# Optionally select one or more objects.
# Rotate the view (or use the view presets shortcuts) so it reflects the direction you want to project the object to. For example, using a Top view will project the object on the XY plane, vertically along the Z axis like on the image above.
# There are several ways to invoke the command:
# Press the {{KEY|[[Image:Draft Shape2DView.png|16px]] [[Draft Shape2DView]]}} button
#* Press the {{Button|[[Image:Draft_Shape2DView.svg|16px]] [[Draft_Shape2DView|Shape 2D view]]}} button.
#* Select the {{MenuCommand|Modification → [[Image:Draft_Shape2DView.svg|16px]] Shape 2D view}} option from the menu.
# If you have not yet selected an object: select an object in the [[3D_view|3D view]].
# The projected objects are created on the XY plane.


==How to produce plans and sections with different linewidths== <!--T:31-->
The default projection direction is along the current view.


==Options== <!--T:6-->
<!--T:32-->
[[Image:Draft_shape2dview_example_plan.png|700px]]


<!--T:7-->
<!--T:33-->
Drawings with different linewidths for viewed and cut lines can easily be produced by using two shape2Dview objects from a same [[Arch_SectionPlane|Arch SectionPlane]]. One of the shape2Dview objects has its projection mode set to '''Solid''', which renders the viewed lines, and another set to '''Cut lines''' or '''Cut faces''' to render the cut lines. The two shape2Dviews are then placed at the same location, one on top of the other.
* If the selected object is an [[Arch SectionPlane]], the 2D projection will be of the contents of the Section plane, and the projection vector will be taken from the section plane instead of the Projection property below.
* The normal operating mode is '''Solid''', which projects the whole shape, but, if you selected some faces of the base object when creating the 2D view, you can also set the '''Individual Faces''' mode, which will project only the faces that were selected.
* If the selected object is an [[Arch SectionPlane]], '''Cutlines''' and '''Cutfaces''' projection mode are also available, which project only the edges being cut by the section plane. Cutfaces mode displays the cut areas of solids as faces.


==Properties== <!--T:8-->
==Properties== <!--T:8-->

<!--T:24-->
See also: [[Property_editor|Property editor]].

<!--T:25-->
A Draft Shape2DView object is derived from a [[Part_Part2DObject|Part Part2DObject]] and inherits all its properties. It also has the following additional properties:

===Data=== <!--T:26-->

<!--T:27-->
{{TitleProperty|Draft}}


<!--T:9-->
<!--T:9-->
* {{PropertyData|Auto Update|Bool}}: specifies if the projection should be automatically recomputed if the {{PropertyData|Base}} object changes. Selecting {{False}} can be useful if there are many Draft Shape2DViews in a document or if they are complex. If set to {{False}} the [[Std_Refresh|Std Refresh]] command must be used to update the projection. {{Version|0.20}}
* {{PropertyData|Projection}}: The direction of the projection.
* {{PropertyData|Projection Mode}}: The mode of the projection: solid, individual faces, or cutlines.
* {{PropertyData|Base|Link}}: specifies the object to be projected.
* {{PropertyData|Face Numbers|IntegerList}}: specifies the indices of the faces to be projected. Only works if {{PropertyData|Projection Mode}} is {{Value|Individual Faces}}.
* {{PropertyData|In Place}}: If this is True, when using Cutlines or Cutfaces mode ([[Arch SectionPlane]] only), the result will appear at the cut plane location instead of the ground plane {{Version|0.17}}
* {{PropertyData|HiddenLines}}: Shows hidden lines or not
* {{PropertyData|Fuse Arch|Bool}}: specifies if [[Arch Workbench|Arch objects]] of the same type and material are fused or not.
* {{PropertyData|Tessellation}}: Tessellate Ellipses and BSplines into line segments
* {{PropertyData|Hidden Lines|Bool}}: specifies if hidden lines are shown or not.
* {{PropertyData|In Place|Bool}}: only works if the selected object is an [[Arch_SectionPlane|Arch SectionPlane]], and {{PropertyData|Projection Mode}} is {{Value|Cutlines}} or {{Value|Cutfaces}}, specifies if the projection will appear co-planar with the section plane.
* {{PropertyData|Segment Length}}: The size of segments if Tessellation is turned on
* {{PropertyData|Visible Only}}: If True, this view will be recomputed only if it is visible
* {{PropertyData|Projection|Vector}}: specifies the direction of the projection. Ignored if {{PropertyData|Base}} is an [[Arch_SectionPlane|Arch SectionPlane]].
* {{PropertyData|Projection Mode|Enumeration}}: specifies the projection mode. The following modes are available:
** {{Value|Solid}}: projects the entire selected object.
** {{Value|Individual Faces}}: only projects the faces in the {{PropertyData|Face Numbers}} list.
** {{Value|Cutlines}}: only works if the selected object is an [[Arch_SectionPlane|Arch SectionPlane]], projects only the edges cut by the section plane.
** {{Value|Cutfaces}}: only works if the selected object is an [[Arch_SectionPlane|Arch SectionPlane]], projects the areas cut through solids by the section plane as faces.
** {{Value|Solid faces}}: projects the entire selected object by cutting faces one by one. Can be used if the {{Value|Solid}} mode gives wrong results. {{Version|0.20}}
* {{PropertyData|Segment Length|Float}}: specifies the size in millimeters of linear segments if {{PropertyData|Tessellation}} is {{TRUE}}.
* {{PropertyData|Tessellation|Bool}}: specifies if tessellation should be performed. Tessellation means that curves are replaced by sequences of line segments. This can be computationally intensive if the {{PropertyData|Segment Length}} is too short.
* {{PropertyData|Visible Only|Bool}}: specifies if the projection should only be recomputed if it is visible.
* {{PropertyData|Exclusion Points|Vector list}}: A list of exclusion points. Any edge passing through any of those points will not be drawn. {{Version|0.20}}
* {{PropertyData|Exclusion Names|String list}}: A list of object names. Any viewed or cut child object with a name in that list will not be drawn. {{Version|0.21}}


==Scripting== <!--T:10-->
===View=== <!--T:28-->

<!--T:29-->
{{TitleProperty|Draft}}

<!--T:30-->
* {{PropertyView|Pattern|Enumeration}}: not used.
* {{PropertyView|Pattern Size|Float}}: not used.

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

<!--T:10-->
See also: [https://freecad.github.io/SourceDoc/ Autogenerated API documentation] and [[FreeCAD_Scripting_Basics|FreeCAD Scripting Basics]].


<!--T:11-->
<!--T:11-->
To create a 2D projection use the {{incode|make_shape2dview}} method ({{Version|0.19}}) of the Draft module. This method replaces the deprecated {{incode|makeShape2DView}} method.
The Draft Shape2DView tool can by used in [[macros]] and from the python console by using the following function:


</translate>
</translate>
{{Code|code=
{{Code|code=
makeShape2DView (object,[projection],[facenumbers])
shape2dview = make_shape2dview(baseobj, projectionVector=None, facenumbers=[])
}}
}}
<translate>
<translate>

<!--T:12-->
<!--T:12-->
* {{incode|baseobj}} is the object to be projected.
* Adds a 2D shape to the document, which is a 2D projection of the given object.
* A specific projection vector can also be given.
* {{incode|projectionVector}} is the projection vector. If not supplied the Z axis is used.
* {{incode|facenumbers}} is a list of face numbers (0-based). If supplied only these faces are considered.
* Returns the generated object.
* {{incode|shape2dview}} is returned with the created 2D projection.
* You can also provide a list of face numbers to be considered.

<!--T:18-->
Change the {{incode|ProjectionMode}} property of the created object if required. It can be: {{incode|"Solid"}}, {{incode|"Individual Faces"}}, {{incode|"Cutlines"}}, {{incode|"Cutfaces"}} or {{incode|"Solid faces"}}.


<!--T:13-->
<!--T:13-->
Line 68: Line 123:
</translate>
</translate>
{{Code|code=
{{Code|code=
import FreeCAD,Draft
import FreeCAD as App
import Draft
Draft.makeShape2DView(FreeCAD.ActiveDocument.ActiveObject)

doc = App.newDocument()

box = doc.addObject("Part::Box", "Box")
box.Length = 2300
box.Width = 500
box.Height = 1000

shape1 = Draft.make_shape2dview(box)

shape2 = Draft.make_shape2dview(box, App.Vector(1, -1, 1))

shape3 = Draft.make_shape2dview(box, App.Vector(-1, 1, 1), [0, 5])
shape3.ProjectionMode = "Individual Faces"

doc.recompute()
}}
}}
<translate>


<!--T:19-->
{{Docnav
|[[Draft_FlipDimension|FlipDimension]]
|[[Draft_SelectPlane|SelectPlane]]
|[[Draft_Workbench|Draft]]
|IconL=Draft_FlipDimension.svg
|IconR=Draft_SelectPlane.svg
|IconC=Workbench_Draft.svg
}}

</translate>
{{Draft Tools navi{{#translation:}}}}
{{Userdocnavi{{#translation:}}}}

Latest revision as of 17:13, 3 December 2023

Draft Shape2DView

Menu location
Modification → Shape 2D view
Workbenches
Draft, Arch
Default shortcut
None
Introduced in version
-
See also
TechDraw ProjectShape

Description

The Draft Shape2DView command creates 2D projections from selected objects, usually 3D solids or Arch SectionPlanes. The projections are placed in the 3D view.

Draft Shape2DView projections can be displayed on a TechDraw Workbench page using the TechDraw DraftView command. Alternatively the TechDraw Workbench offer its own projection commands. But these create projections that are only displayed on the drawing page and not in the 3D view.

Projection of solid shapes onto the XY plane

Usage

  1. Optionally rotate the 3D view. The camera direction in the 3D view determines the projection vector. For example, a top view will project onto the XY plane. The projection vector is ignored for projections created from Arch SectionPlanes.
  2. Optionally select one or more objects.
  3. There are several ways to invoke the command:
    • Press the Shape 2D view button.
    • Select the Modification → Shape 2D view option from the menu.
  4. If you have not yet selected an object: select an object in the 3D view.
  5. The projected objects are created on the XY plane.

How to produce plans and sections with different linewidths

Drawings with different linewidths for viewed and cut lines can easily be produced by using two shape2Dview objects from a same Arch SectionPlane. One of the shape2Dview objects has its projection mode set to Solid, which renders the viewed lines, and another set to Cut lines or Cut faces to render the cut lines. The two shape2Dviews are then placed at the same location, one on top of the other.

Properties

See also: Property editor.

A Draft Shape2DView object is derived from a Part Part2DObject and inherits all its properties. It also has the following additional properties:

Data

Draft

  • DataAuto Update (Bool): specifies if the projection should be automatically recomputed if the DataBase object changes. Selecting false can be useful if there are many Draft Shape2DViews in a document or if they are complex. If set to false the Std Refresh command must be used to update the projection. introduced in version 0.20
  • DataBase (Link): specifies the object to be projected.
  • DataFace Numbers (IntegerList): specifies the indices of the faces to be projected. Only works if DataProjection Mode is Individual Faces.
  • DataFuse Arch (Bool): specifies if Arch objects of the same type and material are fused or not.
  • DataHidden Lines (Bool): specifies if hidden lines are shown or not.
  • DataIn Place (Bool): only works if the selected object is an Arch SectionPlane, and DataProjection Mode is Cutlines or Cutfaces, specifies if the projection will appear co-planar with the section plane.
  • DataProjection (Vector): specifies the direction of the projection. Ignored if DataBase is an Arch SectionPlane.
  • DataProjection Mode (Enumeration): specifies the projection mode. The following modes are available:
    • Solid: projects the entire selected object.
    • Individual Faces: only projects the faces in the DataFace Numbers list.
    • Cutlines: only works if the selected object is an Arch SectionPlane, projects only the edges cut by the section plane.
    • Cutfaces: only works if the selected object is an Arch SectionPlane, projects the areas cut through solids by the section plane as faces.
    • Solid faces: projects the entire selected object by cutting faces one by one. Can be used if the Solid mode gives wrong results. introduced in version 0.20
  • DataSegment Length (Float): specifies the size in millimeters of linear segments if DataTessellation is true.
  • DataTessellation (Bool): specifies if tessellation should be performed. Tessellation means that curves are replaced by sequences of line segments. This can be computationally intensive if the DataSegment Length is too short.
  • DataVisible Only (Bool): specifies if the projection should only be recomputed if it is visible.
  • DataExclusion Points (Vector list): A list of exclusion points. Any edge passing through any of those points will not be drawn. introduced in version 0.20
  • DataExclusion Names (String list): A list of object names. Any viewed or cut child object with a name in that list will not be drawn. introduced in version 0.21

View

Draft

  • ViewPattern (Enumeration): not used.
  • ViewPattern Size (Float): not used.

Scripting

See also: Autogenerated API documentation and FreeCAD Scripting Basics.

To create a 2D projection use the make_shape2dview method (introduced in version 0.19) of the Draft module. This method replaces the deprecated makeShape2DView method.

shape2dview = make_shape2dview(baseobj, projectionVector=None, facenumbers=[])
  • baseobj is the object to be projected.
  • projectionVector is the projection vector. If not supplied the Z axis is used.
  • facenumbers is a list of face numbers (0-based). If supplied only these faces are considered.
  • shape2dview is returned with the created 2D projection.

Change the ProjectionMode property of the created object if required. It can be: "Solid", "Individual Faces", "Cutlines", "Cutfaces" or "Solid faces".

Example:

import FreeCAD as App
import Draft

doc = App.newDocument()

box = doc.addObject("Part::Box", "Box")
box.Length = 2300
box.Width = 500
box.Height = 1000

shape1 = Draft.make_shape2dview(box)

shape2 = Draft.make_shape2dview(box, App.Vector(1, -1, 1))

shape3 = Draft.make_shape2dview(box, App.Vector(-1, 1, 1), [0, 5])
shape3.ProjectionMode = "Individual Faces"

doc.recompute()