Arch SectionPlane: Difference between revisions

From FreeCAD Documentation
(adding <translate>)
No edit summary
(48 intermediate revisions by 10 users not shown)
Line 1: Line 1:
<languages/>
<translate>
<translate>
<!--T:23-->
{{GuiCommand|Name=Arch SectionPlane|Workbenches=[[Arch Module|Arch]]|MenuLocation=Arch -> Section Plane|Shortcut=S P}}
{{Docnav
|[[Arch_Window|Window]]
|[[Arch_CompAxis|CompAxis]]
|[[Arch_Workbench|Arch]]
|IconL=Arch_Window.svg
|IconR=Arch_CompAxis.png
|IconC=Workbench_Arch.svg
}}


<!--T:1-->
==Description==
{{GuiCommand
|Name=Arch SectionPlane
|MenuLocation=Arch → Section Plane
|Workbenches=[[Arch_Workbench|Arch]]
|Shortcut={{KEY|S}} {{KEY|P}}
|SeeAlso=[[Draft_Shape2DView|Draft Shape2DView]], [[TechDraw_ArchView|TechDraw ArchView]]
}}


==Description== <!--T:2-->
This tool places in the current Document a section plane gizmo, which defines a section or view plane. The gizmo can be relocated and reoriented by moving and rotating it, until it describes the 2D view you want to obtain. The Section plane object will only consider objects that were selected when it got created. Objects can later be added or removed from a SectionPlane object with the [[Arch Add]] and [[Arch Remove]] tools.


<!--T:3-->
Upon creation, SectionPlane objects also insert a [[Drawing View|view]] of themselves into the active [[Drawing Module|Drawing page]], or create a new page if none exist. You can also add views of Section planes directly in the document, by using the [[Draft Shape2DView]] tool with a section plane selected.
This tool places in the current document a section plane "thing", which defines a section or view plane. The "thing" takes its placement according to the current [[Draft_SelectPlane|Draft Working Plane]] and can be relocated and reoriented by moving and rotating it, until it describes the 2D view you want to obtain. The Section plane object will only consider a certain set of objects. Objects that are selected when you create a Section Plane will be added to that set automatically. Other objects can later be added or removed from a SectionPlane object with the [[Arch Add|Arch Add component]] and [[Arch Remove|Arch Remove component]] tools, or by double-clicking the Section Plane in the tree view.
</translate>

<!--T:4-->
The Section Plane alone won't create any view of its objects set. For that, you must create a [[TechDraw_ArchView|TechDraw ArchView]] to create a view in a [[TechDraw_Workbench|TechDraw page]].


<!--T:16-->
[[Image:Arch SectionPlane example.jpg|600px]]
[[Image:Arch SectionPlane example.jpg|600px]]


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


<!--T:6-->
# Select objects you want to be included in your section view
# Optionally, set the [[Draft_SelectPlane|Draft Working Plane]] to reflect the plane where you want to place the Section Plane.
# Press the {{KEY|[[Image:Arch SectionPlane.png|16px]] '''SectionPlane'''}} button or press {{KEY|S}} then {{KEY|P}} keys
# Select objects you want to be included in your section view.
# [[Draft Move|Move]]/[[Draft Rotate|rotate]] the Section Plane into correct position
# Press the {{KEY|[[Image:Std Recompute.png|16px]] '''Recompute'''}} button to update the view
# Press the {{Button|[[Image:Arch SectionPlane.svg|16px]] [[Arch SectionPlane|Section Plane]]}} button or press {{KEY|S}} then {{KEY|P}} keys.
# [[Draft Move|Move]]/[[Draft Rotate|rotate]] the Section Plane into correct position if needed.
# Select the Section Plane if not selected already.
# Use either <s>[[Draft_Drawing|Drawing DraftView]],</s> [[Draft Shape2DView|Draft Shape2DView]] or [[TechDraw_ArchView|TechDraw ArchView]] to create a view.


==Options==
==Options== <!--T:7-->


<!--T:19-->
* With a section plane object selected, use the [[Draft Shape2DView]] tool to create a shape object representing the section view in the document
* The Section plane object will only consider a certain set of objects, not all the objects of the document. Objects can be added or removed from a SectionPlane object by using the [[Arch Add|Arch Add]] and [[Arch Remove|Arch Remove]] tools, or by double-clicking the Section Plane in the tree view, selecting objects either in the list of in the 3D scene, and pressing the '''add''' or remove '''buttons'''.
</translate>

<!--T:8-->
* With a section plane object selected, use the [[Draft Shape2DView|Draft Shape2DView]] tool to create a shape object representing the section view in the document


<!--T:17-->
[[Image:Arch Section example2.jpg|600px]]
[[Image:Arch Section example2.jpg|600px]]


<!--T:9-->
<translate>
* Create [[Draft_Drawing|Drawing DraftViews]] if you are working with the <s>[[Drawing Workbench|Drawing Workbench]]</s>, or [[TechDraw_ArchView|TechDraw ArchView]] if you are using the [[TechDraw_Workbench|TechDraw Workbench]].
* Create additional [[Drawing View|views]] of a section plane by selecting it, then using the [[Draft Drawing]] tool
</translate>


<!--T:18-->
[[Image:Arch Section example3.jpg|600px]]
[[Image:Arch Section example3.jpg|600px]]


<!--T:20-->
<translate>
* The Section Plane can also be used to show the entire 3D view cut by an infinite plane. This is only visual, and won't affect the geometry of the objects being cut.
==Properties==


<!--T:21-->
* {{PropertyView|Display Size}}: The size of the section plane gizmo in the 3D view
[[Image:Arch SectionPlane CutView.jpg|600px]]


==Properties== <!--T:10-->
==Scripting==

<!--T:11-->
* {{PropertyData|Only Solids}}: If this is True, non-solid objects in the set will be disregarded
* {{PropertyView|Display Length}}: The length of the section plane gizmo in the 3D view. Doesn't affect the resulting view
* {{PropertyView|Display Height}}: The height of the section plane gizmo in the 3D view. Doesn't affect the resulting view
* {{PropertyView|Arrow Size}}: The size of the arrows of the section plane gizmo in the 3D view. Doesn't affect the resulting view
* {{PropertyView|Cut View}}: If this is {{TRUE}}, the whole 3D view will be cut at the location of this section plane.
* {{PropertyView|Clip view}}: if this is {{TRUE}}, it will clip the view to the display height and length of the section plane. This effectively turns the section plane into an orthographic camera, limiting the field of view. {{version|0.19}}

<!--T:26-->
[[Image:Arch_SectionPlane_ClipView.png|600px]]

<!--T:27-->
{{Caption|The Arch SectionPlane with the clip view option will behave like a camera, limiting the field of view.}}

==Tweaks== <!--T:28-->

<!--T:29-->
* Adding manually a property named '''RotateSolidRender''' of type '''App::PropertyAngle''' to the section plane's '''View''' properties (right-click the properties view -> show all, right-click again -> add property) allows to rotate the render when using Solid mode. This is useful when a rendered view has for example both Arch and Draft elements, and the rendering of the Arch elements is rotated in relation to the Draft elements. {{version|0.19}}

==Scripting== <!--T:12-->
{{Emphasis|See also:}} [[Arch API|Arch API]] and [[FreeCAD Scripting Basics|FreeCAD Scripting Basics]].

<!--T:13-->
The SectionPlane tool can be used in [[macros|macros]] and from the [[Python|Python]] console by using the following function:


The Section Plane tool can by used in [[macros]] and from the python console by using the following function:
</translate>
</translate>
{{Code|code=
<syntaxhighlight>
Section = makeSectionPlane(objectslist=None, name="Section")
makeSectionPlane ([objectslist])
}}
</syntaxhighlight>
<translate>
<translate>
Creates a Section plane objects including the given objects.


<!--T:14-->
* Creates a {{incode|Section}} object from {{incode|objectslist}}, which is a list of objects.

<!--T:15-->
Example:
Example:

</translate>
</translate>
{{Code|code=
<syntaxhighlight>
import FreeCAD, Draft, Arch
import FreeCAD, Draft, Arch

trace = Part.Line(FreeCAD.Vector (0, 0, 0),FreeCAD.Vector (2, 2, 0))
p1 = FreeCAD.Vector(0, 0, 0)
wall = Arch.makeWall(trace,width=0.1,height=1,align="Center")
p2 = FreeCAD.Vector(2000, 0, 0)
Arch.makeSectionPlane([wall])
baseline = Draft.makeLine(p1, p2)
</syntaxhighlight>
baseline2 = Draft.makeLine(p1, -1*p2)
<languages/>

Wall1 = Arch.makeWall(baseline, length=None, width=150, height=2000)
Wall2 = Arch.makeWall(baseline2, length=None, width=150, height=1800)
Structure = Arch.makeStructure(length=1000, width=1000, height=200)
FreeCAD.ActiveDocument.recompute()

BuildingPart = Arch.makeBuildingPart([Wall1, Wall2])

Floor = Arch.makeFloor([BuildingPart])
Building = Arch.makeBuilding([Floor, Structure])
Site = Arch.makeSite(Building)
FreeCAD.ActiveDocument.recompute()

Section1 = Arch.makeSectionPlane([Wall1, Wall2])
Section2 = Arch.makeSectionPlane([Structure])
Section3 = Arch.makeSectionPlane([Site])
FreeCAD.ActiveDocument.recompute()
}}
<translate>

<!--T:22-->
{{Docnav
|[[Arch_Window|Window]]
|[[Arch_CompAxis|CompAxis]]
|[[Arch_Workbench|Arch]]
|IconL=Arch_Window.svg
|IconR=Arch_CompAxis.png
|IconC=Workbench_Arch.svg
}}

</translate>
{{Arch Tools navi{{#translation:}}}}

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

Revision as of 16:07, 23 August 2021

Arch SectionPlane

Menu location
Arch → Section Plane
Workbenches
Arch
Default shortcut
S P
Introduced in version
-
See also
Draft Shape2DView, TechDraw ArchView

Description

This tool places in the current document a section plane "thing", which defines a section or view plane. The "thing" takes its placement according to the current Draft Working Plane and can be relocated and reoriented by moving and rotating it, until it describes the 2D view you want to obtain. The Section plane object will only consider a certain set of objects. Objects that are selected when you create a Section Plane will be added to that set automatically. Other objects can later be added or removed from a SectionPlane object with the Arch Add component and Arch Remove component tools, or by double-clicking the Section Plane in the tree view.

The Section Plane alone won't create any view of its objects set. For that, you must create a TechDraw ArchView to create a view in a TechDraw page.

Usage

  1. Optionally, set the Draft Working Plane to reflect the plane where you want to place the Section Plane.
  2. Select objects you want to be included in your section view.
  3. Press the Section Plane button or press S then P keys.
  4. Move/rotate the Section Plane into correct position if needed.
  5. Select the Section Plane if not selected already.
  6. Use either Drawing DraftView, Draft Shape2DView or TechDraw ArchView to create a view.

Options

  • The Section plane object will only consider a certain set of objects, not all the objects of the document. Objects can be added or removed from a SectionPlane object by using the Arch Add and Arch Remove tools, or by double-clicking the Section Plane in the tree view, selecting objects either in the list of in the 3D scene, and pressing the add or remove buttons.
  • With a section plane object selected, use the Draft Shape2DView tool to create a shape object representing the section view in the document

  • The Section Plane can also be used to show the entire 3D view cut by an infinite plane. This is only visual, and won't affect the geometry of the objects being cut.

Properties

  • DataOnly Solids: If this is True, non-solid objects in the set will be disregarded
  • ViewDisplay Length: The length of the section plane gizmo in the 3D view. Doesn't affect the resulting view
  • ViewDisplay Height: The height of the section plane gizmo in the 3D view. Doesn't affect the resulting view
  • ViewArrow Size: The size of the arrows of the section plane gizmo in the 3D view. Doesn't affect the resulting view
  • ViewCut View: If this is true, the whole 3D view will be cut at the location of this section plane.
  • ViewClip view: if this is true, it will clip the view to the display height and length of the section plane. This effectively turns the section plane into an orthographic camera, limiting the field of view. introduced in version 0.19

The Arch SectionPlane with the clip view option will behave like a camera, limiting the field of view.

Tweaks

  • Adding manually a property named RotateSolidRender of type App::PropertyAngle to the section plane's View properties (right-click the properties view -> show all, right-click again -> add property) allows to rotate the render when using Solid mode. This is useful when a rendered view has for example both Arch and Draft elements, and the rendering of the Arch elements is rotated in relation to the Draft elements. introduced in version 0.19

Scripting

See also: Arch API and FreeCAD Scripting Basics.

The SectionPlane tool can be used in macros and from the Python console by using the following function:

Section = makeSectionPlane(objectslist=None, name="Section")
  • Creates a Section object from objectslist, which is a list of objects.

Example:

import FreeCAD, Draft, Arch

p1 = FreeCAD.Vector(0, 0, 0)
p2 = FreeCAD.Vector(2000, 0, 0)
baseline = Draft.makeLine(p1, p2)
baseline2 = Draft.makeLine(p1, -1*p2)

Wall1 = Arch.makeWall(baseline, length=None, width=150, height=2000)
Wall2 = Arch.makeWall(baseline2, length=None, width=150, height=1800)
Structure = Arch.makeStructure(length=1000, width=1000, height=200)
FreeCAD.ActiveDocument.recompute()

BuildingPart = Arch.makeBuildingPart([Wall1, Wall2])

Floor = Arch.makeFloor([BuildingPart])
Building = Arch.makeBuilding([Floor, Structure])
Site = Arch.makeSite(Building)
FreeCAD.ActiveDocument.recompute()

Section1 = Arch.makeSectionPlane([Wall1, Wall2])
Section2 = Arch.makeSectionPlane([Structure])
Section3 = Arch.makeSectionPlane([Site])
FreeCAD.ActiveDocument.recompute()