TechDraw DetailView: Difference between revisions

From FreeCAD Documentation
m (wording)
No edit summary
 
(59 intermediate revisions by 8 users not shown)
Line 1: Line 1:
<languages/>
<languages/>
<translate>
<translate>

<!--T:19-->
<!--T:19-->
{{Docnav
{{Docnav
|[[TechDraw_ComplexSection|ComplexSection]]
|[[TechDraw_SectionView|Insert Section View]]
|[[TechDraw_DraftView|Insert Draft Workbench Object]]
|[[TechDraw_DraftView|DraftView]]
|[[TechDraw_Module|TechDraw]]
|[[TechDraw_Workbench|TechDraw]]
|IconL=TechDraw_SectionView.svg
|IconL=TechDraw_ComplexSection.svg
|IconC=Workbench_TechDraw.svg
|IconR=TechDraw DraftView.svg
|IconR=TechDraw DraftView.svg
|IconC=Workbench_TechDraw.svg
}}
}}


Line 14: Line 15:
{{GuiCommand
{{GuiCommand
|Name=TechDraw DetailView
|Name=TechDraw DetailView
|MenuLocation=TechDraw → Insert Detail View
|MenuLocation=TechDraw → TechDraw Views → Insert Detail View
|Workbenches=[[TechDraw Module|TechDraw]]
|Workbenches=[[TechDraw_Workbench|TechDraw]]
|SeeAlso=[[TechDraw_View|Insert View]], [[TechDraw_ProjectionGroup|Insert Projection Group]]
|SeeAlso=[[TechDraw_View|TechDraw View]], [[TechDraw_ProjectionGroup|TechDraw ProjectionGroup]]
}}
}}


Line 22: Line 23:


<!--T:10-->
<!--T:10-->
The Detail tool creates a view of small area of an existing view.
The '''TechDraw DetailView''' tool creates a view of a small area of an existing view.


</translate>
[[Image:ViewDetail.png|thumb|center|Detail view with circular viewbox of an existing view]]
[[Image:ViewDetail.png]]
<translate>
<!--T:11-->
{{Caption|Detail view with a circular outline}}


==Usage== <!--T:3-->
==Usage== <!--T:3-->


<!--T:12-->
<!--T:12-->
# Select a part view in the 3D window or tree.
# Select a base view for the detail view.
# There are several ways to invoke the tool:
# If you have multiple drawing pages in your document, you will also need to select the desired page in the tree.
# Press the {{Button|[[Image:TechDraw_DetailView.svg|16px]] [[TechDraw_DetailView|Insert Detail View]]}} button to create the section view.
#* Press the {{Button|[[Image:TechDraw_DetailView.svg|16px]] [[TechDraw_DetailView|Insert Detail View]]}} button.
#* Select the {{MenuCommand|TechDraw → TechDraw Views → [[Image:TechDraw_DetailView.svg|16px]] Insert Detail View}} option from the menu.
# select the created view in the tree and change its properties {{PropertyData|Anchor Point}}, {{PropertyData|Radius}} and/or {{PropertyData|Scale}} to adjust the position, size and magnification of the base view area that should be displayed in the detail view.
# A highlight outline is added to the base view, a detail view is added to the page, and a task panel opens.
# For clarity it is best to move the detail view so that it no longer overlaps the base view: hold down the left mouse button on its frame or label and drag it to a new position.
# To change the position of the highlight outline do one of the following:
#* Move the outline by dragging:
#*# Press the {{Button|Drag Highlight}} button.
#*# The outline is marked on the page and a temporary ''drag'' label is added.
#*# Hold down the left mouse button on the outline itself, or on that label, and drag the outline to a new position.
#* Move the outline by coordinate input:
#*# Change the X and Y coordinates in the task panel. The coordinates are relative to the center of the base view.
# Optionally change the '''Radius''' of the detail view.
# Optionally change the '''Scale Type''' and '''Scale Factor''' of the detail view. See [[TechDraw_View#Properties|TechDraw View]] for more information.
# Specify a '''Reference''' label. This label will be displayed near the highlight outline.
# Press the {{Button|OK}} button.


<!--T:13-->
==Notes== <!--T:30-->
The Detail view can be displayed within a round or square viewbox. This is controlled by the [[TechDraw_Preferences#Annotation|preferences]] setting '''Detail View Outline Shape'''.


==Properties== <!--T:5-->
<!--T:37-->
* To edit a detail view double-click it in the [[Tree_view|Tree view]].
* The outlines of detail views can be round or square. This is controlled by the '''Detail View Outline Shape''' [[TechDraw_Preferences#Annotation|preference]].
* [https://www.forum.freecadweb.org/viewtopic.php?f=35&t=34055#p285281 Forum topic with a good discussion about setting the anchor.]


<!--T:14-->
== Properties Detail View == <!--T:31-->
* {{PropertyData|BaseView}}: The view on which this Detail view is based.
* {{PropertyData|Anchor Point}}: The center of the Detail view within the {{PropertyData|BaseView}}.
* {{PropertyData|Radius}}: The size of the area in the {{PropertyData|BaseView}} that is displayed in the Detail view.
* {{PropertyData|Scale}}: Magnification level.
* {{PropertyData|Reference}}: An identifier to indicate the area of the {{PropertyData|BaseView}} that is displayed.


<!--T:9-->
<!--T:32-->
See also [[TechDraw_View#Properties|TechDraw View]].
''Note:'' A Detail view inherits all applicable {{PropertyData|BaseView}} properties.


==Scripting== <!--T:6-->
=== Data === <!--T:33-->


<!--T:15-->
<!--T:34-->
{{TitleProperty|Detail}}
{{Emphasis|See also:}} [[TechDraw API|TechDraw API]] and [[FreeCAD Scripting Basics|FreeCAD Scripting Basics]].


<!--T:16-->
<!--T:35-->
* {{PropertyData|Base View|Link}}: The view on which the detail view is based.
The Detail tool can be used in [[macros|macros]] and from the [[Python|Python]] console by using the following functions:
* {{PropertyData|Anchor Point|Vector}}: The center of the detail view within the {{PropertyData|Base View}}.
* {{PropertyData|Radius|Float}}: The size of the area in the {{PropertyData|Base View}} that is displayed in the detail view.
* {{PropertyData|Reference|String}}: An identifier for the detail view in the {{PropertyData|Base View}}.


== Properties Base View == <!--T:36-->
</translate>

{{Code|code=
<!--T:9-->
Detail = FreeCAD.ActiveDocument.addObject('TechDraw::DrawViewDetail','Detail')
A detail view inherits all applicable properties of its {{PropertyData|Base View}}. In the properties of that view you can change the appearance of the detail outline:
...TBA

}}
=== View === <!--T:38-->
<translate>

<!--T:39-->
{{TitleProperty|Hightlight}}

<!--T:26-->
* {{PropertyView|Highlight Adjust|Float}}: See [[TechDraw_View#View|TechDraw View]]
* {{PropertyView|Highlight Line Color|Color}}: Idem.
* {{PropertyView|Highlight Line Style|Enumeration}}: Idem.


==Notes== <!--T:20-->
* [https://www.forum.freecadweb.org/viewtopic.php?f=35&t=34055#p285281 A good discussion about setting the Anchor]


<!--T:21-->
<!--T:21-->
{{Docnav
{{Docnav
|[[TechDraw_ComplexSection|ComplexSection]]
|[[TechDraw_SectionView|Insert Section View]]
|[[TechDraw_DraftView|Insert Draft Workbench Object]]
|[[TechDraw_DraftView|DraftView]]
|[[TechDraw_Module|TechDraw]]
|[[TechDraw_Workbench|TechDraw]]
|IconL=TechDraw_SectionView.svg
|IconL=TechDraw_ComplexSection.svg
|IconC=Workbench_TechDraw.svg
|IconR=TechDraw DraftView.svg
|IconR=TechDraw DraftView.svg
|IconC=Workbench_TechDraw.svg
}}
}}


Line 80: Line 104:
{{TechDraw Tools navi{{#translation:}}}}
{{TechDraw Tools navi{{#translation:}}}}
{{Userdocnavi{{#translation:}}}}
{{Userdocnavi{{#translation:}}}}
{{clear}}

Latest revision as of 14:57, 27 July 2023

TechDraw DetailView

Menu location
TechDraw → TechDraw Views → Insert Detail View
Workbenches
TechDraw
Default shortcut
None
Introduced in version
-
See also
TechDraw View, TechDraw ProjectionGroup

Description

The TechDraw DetailView tool creates a view of a small area of an existing view.

Detail view with a circular outline

Usage

  1. Select a base view for the detail view.
  2. There are several ways to invoke the tool:
    • Press the Insert Detail View button.
    • Select the TechDraw → TechDraw Views → Insert Detail View option from the menu.
  3. A highlight outline is added to the base view, a detail view is added to the page, and a task panel opens.
  4. For clarity it is best to move the detail view so that it no longer overlaps the base view: hold down the left mouse button on its frame or label and drag it to a new position.
  5. To change the position of the highlight outline do one of the following:
    • Move the outline by dragging:
      1. Press the Drag Highlight button.
      2. The outline is marked on the page and a temporary drag label is added.
      3. Hold down the left mouse button on the outline itself, or on that label, and drag the outline to a new position.
    • Move the outline by coordinate input:
      1. Change the X and Y coordinates in the task panel. The coordinates are relative to the center of the base view.
  6. Optionally change the Radius of the detail view.
  7. Optionally change the Scale Type and Scale Factor of the detail view. See TechDraw View for more information.
  8. Specify a Reference label. This label will be displayed near the highlight outline.
  9. Press the OK button.

Notes

Properties Detail View

See also TechDraw View.

Data

Detail

  • DataBase View (Link): The view on which the detail view is based.
  • DataAnchor Point (Vector): The center of the detail view within the DataBase View.
  • DataRadius (Float): The size of the area in the DataBase View that is displayed in the detail view.
  • DataReference (String): An identifier for the detail view in the DataBase View.

Properties Base View

A detail view inherits all applicable properties of its DataBase View. In the properties of that view you can change the appearance of the detail outline:

View

Hightlight

  • ViewHighlight Adjust (Float): See TechDraw View
  • ViewHighlight Line Color (Color): Idem.
  • ViewHighlight Line Style (Enumeration): Idem.