Std ViewScreenShot: Difference between revisions

From FreeCAD Documentation
No edit summary
mNo edit summary
(10 intermediate revisions by 3 users not shown)
Line 1: Line 1:
<languages/>
<languages/>

{{Page in progress}}

<translate>
<translate>


<!--T:18-->
{{Docnav
{{Docnav
|[[Std_DlgParameter|Std DlgParameter]]
|[[Std_DlgParameter|DlgParameter]]
|[[Std_SceneInspector|Std SceneInspector]]
|[[Std_SceneInspector|SceneInspector]]
|[[Std_Tools_Menu|Std Tools Menu]]
|[[Std_Tools_Menu|Std Tools Menu]]
|IconL=Std_DlgParameter.svg
|IconL=Std_DlgParameter.svg
|IconR=
|IconR=Std_SceneInspector.svg
|IconC=Freecad.svg
|IconC=Freecad.svg
}}
}}
Line 25: Line 23:


<!--T:2-->
<!--T:2-->
The '''Std ViewScreenShot''' command opens a dialog box to create an image file from the content of the current [[3D_view|3D view]].
The '''Std ViewScreenShot''' command opens a dialog box to create an image file, a screenshot, from the active [[3D_view|3D view]].


</translate>
</translate>
[[Image:Save_picture.png]]
[[Image:Save_picture.png|800px]]
<translate>
<translate>
<!--T:19-->
{{Caption|The Save picture dialog box after pressing the Extended button}}
{{Caption|The Save picture dialog box after pressing the Extended button}}


Line 35: Line 34:


<!--T:15-->
<!--T:15-->
# Select the {{MenuCommand|View → [[Image:Std_ViewScreenShot.svg|16px]] Save picture...}} option from the menu.
# Select the {{MenuCommand|Tools → [[Image:Std_ViewScreenShot.svg|16px]] Save picture...}} option from the menu.
# The Save picture dialog box pops up.
# The Save picture dialog box opens.
# Optionally press the {{Button|Extended}} button to reveal an additional panel in the dialog box. For more information see [[#Options|Options]].
# Optionally press the {{Button|Extended}} button to reveal an additional panel in the dialog box. For more information see [[#Options|Options]].
# Optionally browse to the correct folder.
# Optionally browse to the correct folder.
Line 44: Line 43:
==Options== <!--T:16-->
==Options== <!--T:16-->


===Image dimensions===
===Image dimensions=== <!--T:20-->


<!--T:21-->
* Select a standard size from the '''Standard sizes''' dropdown list. Or specify the '''Width''' and '''Height''' for a custom size.
# Select a standard size from the '''Standard sizes''' dropdown list. Or specify the '''Width''' and '''Height''' for a custom size.
* Optionally press an '''Aspect ratio''' button to set the width-to-height ratio of the image. If the '''Width''' input box has the focus the height of the image will change and vice versa.
# Optionally press an '''Aspect ratio''' button to set the width-to-height ratio of the image. If the '''Width''' input box has the focus the height of the image will change and vice versa.


===Image properties===
===Image properties=== <!--T:22-->


<!--T:23-->
* Select an option from the '''Background''' dropdown list:
** '''Current'''. This option uses the background of the 3D view.
# Select an option from the '''Background''' dropdown list:
#* {{Value|Current}} This option uses the background of the 3D view.
** '''White'''.
#* {{Value|White}}
** '''Black'''.
#* {{Value|Black}}
** '''Transparent'''. Not all image formats support transparency.
#* {{Value|Transparent}} Not all image formats support transparency.
* Select an option from the '''Creation method''' dropdown list:
# Select an option from the '''Creation method''' dropdown list:
** '''Offscreen (New)'''. This is the default method. This method supports [https://en.wikipedia.org/wiki/Multisample_anti-aliasing anti-aliasing]. ''Technical information: The most important classes for this method are Qt's QOffscreenSurface and QOpenGLFramebufferObject.''
** '''Offscreen (Old)'''. This method does not work on many modern Linux systems as it relies on the graphics driver. This method does not support anti-aliasing. ''Technical information: This is a real off-screen rendering method that only uses functions from the Coin3d library.''
#* {{Value|Offscreen (New)}} This is the default method. This method supports [https://en.wikipedia.org/wiki/Multisample_anti-aliasing anti-aliasing]. ''Technical information: The most important classes for this method are Qt's QOffscreenSurface and QOpenGLFramebufferObject.''
#* {{Value|Offscreen (Old)}} This method does not work on many modern Linux systems as it relies on the graphics driver. This method does not support anti-aliasing. ''Technical information: This is a real off-screen rendering method that only uses functions from the Coin3d library.''
** '''Framebuffer (custom)'''. This method supports anti-aliasing. ''Technical information: If anti-aliasing is off, this method reads the image directly from the graphics renderer, else it renders to a framebuffer and gets the image from there. The key part of this method is Qt's QOpenGLFramebufferObject class.''
** '''Framebuffer (as is)'''. This method uses the same techniques as '''Framebuffer (custom)'''. It also supports anti-aliasing but has some limitations related to custom sizes and always uses the current background of the 3D view.
#* {{Value|Framebuffer (custom)}} This method supports anti-aliasing. ''Technical information: If anti-aliasing is off, this method reads the image directly from the graphics renderer, else it renders to a framebuffer and gets the image from there. The key part of this method is Qt's QOpenGLFramebufferObject class.''
#* {{Value|Framebuffer (as is)}} This method uses the same techniques as '''Framebuffer (custom)'''. It also supports anti-aliasing but has some limitations related to custom sizes and always uses the current background of the 3D view.


===Image comment===
===Image comment=== <!--T:24-->


<!--T:25-->
* Select the {{RadioButton|TRUE|Insert MIBA}} option to add [[MIBA]] information to the file. Not all image formats support this.
* Or select the {{RadioButton|TRUE|Insert comment}} option and type a comment in the text field to embed a comment in the file. Not all image formats support this.
# Select the {{RadioButton|TRUE|Insert MIBA}} option to add [[MIBA]] information to the file. Not all image formats support this.
# Or select the {{RadioButton|TRUE|Insert comment}} option and type a comment in the text field to embed a comment in the file. Not all image formats support this.
* Check the {{CheckBox|TRUE|Add watermark}} checkbox to add a watermark. The watermark is placed in the lower left corner of the image and consists of the FreeCAD logo and name above the main FreeCAD URL: [http://www.freecadweb.org www.freecadweb.org].
# Check the {{CheckBox|TRUE|Add watermark}} checkbox to add a watermark. The watermark is placed in the lower left corner of the image and consists of the FreeCAD logo and name above the main FreeCAD URL: [http://www.freecadweb.org www.freecadweb.org].


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


<!--T:27-->
* The number of available image file formats may vary depending on your OS.
* The number of available image file formats may vary depending on your OS.
* Some OpenGL drivers don't allow renderings above a certain maximum size.
* Some OpenGL drivers don't allow renderings above a certain maximum size.


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


<!--T:29-->
* The 3D view background can be changed in the preferences: {{MenuCommand|Edit → Preferences... → Display → Colors → Background color}}. See [[Preferences_Editor#Colors|Preferences Editor]].
* The 3D view background can be changed in the preferences: {{MenuCommand|Edit → Preferences... → Display → Colors → Background color}}. See [[Preferences_Editor#Colors|Preferences Editor]].
* To change the 3D view anti-aliasing: {{MenuCommand|Edit → Preferences... → Display → 3D view → Rendering → Anti-Aliasing}}. See [[Preferences_Editor#3D_View|Preferences Editor]].
* To change the 3D view anti-aliasing: {{MenuCommand|Edit → Preferences... → Display → 3D view → Rendering → Anti-Aliasing}}. See [[Preferences_Editor#3D_View|Preferences Editor]].


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


<!--T:31-->
It is also possible to create screenshots with python code.
It is possible to create screenshots with python code.


</translate>
</translate>
Line 88: Line 93:
<translate>
<translate>


<!--T:32-->
This script saves a series of screenshots of different sizes and from different directions. The camera type, orthographic or perspective, is also changed.
This script saves a series of screenshots of different sizes and from different directions. The camera type, orthographic or perspective, is also changed.


Line 111: Line 117:
<translate>
<translate>



<!--T:33-->
{{Docnav
{{Docnav
|[[Std_DlgParameter|Std DlgParameter]]
|[[Std_DlgParameter|DlgParameter]]
|[[Std_SceneInspector|Std SceneInspector]]
|[[Std_SceneInspector|SceneInspector]]
|[[Std_Tools_Menu|Std Tools Menu]]
|[[Std_Tools_Menu|Std Tools Menu]]
|IconL=Std_DlgParameter.svg
|IconL=Std_DlgParameter.svg
|IconR=
|IconR=Std_SceneInspector.svg
|IconC=Freecad.svg
|IconC=Freecad.svg
}}
}}

Revision as of 15:43, 29 December 2020

Std ViewScreenShot

Menu location
Tools → Save picture...
Workbenches
All
Default shortcut
None
Introduced in version
-
See also
Std Print, Std PrintPdf

Description

The Std ViewScreenShot command opens a dialog box to create an image file, a screenshot, from the active 3D view.

The Save picture dialog box after pressing the Extended button

Usage

  1. Select the Tools → Save picture... option from the menu.
  2. The Save picture dialog box opens.
  3. Optionally press the Extended button to reveal an additional panel in the dialog box. For more information see Options.
  4. Optionally browse to the correct folder.
  5. Enter a filename and select the file type.
  6. Press the Save button to create the image file and close the dialog box.

Options

Image dimensions

  1. Select a standard size from the Standard sizes dropdown list. Or specify the Width and Height for a custom size.
  2. Optionally press an Aspect ratio button to set the width-to-height ratio of the image. If the Width input box has the focus the height of the image will change and vice versa.

Image properties

  1. Select an option from the Background dropdown list:
    • Current This option uses the background of the 3D view.
    • White
    • Black
    • Transparent Not all image formats support transparency.
  2. Select an option from the Creation method dropdown list:
    • Offscreen (New) This is the default method. This method supports anti-aliasing. Technical information: The most important classes for this method are Qt's QOffscreenSurface and QOpenGLFramebufferObject.
    • Offscreen (Old) This method does not work on many modern Linux systems as it relies on the graphics driver. This method does not support anti-aliasing. Technical information: This is a real off-screen rendering method that only uses functions from the Coin3d library.
    • Framebuffer (custom) This method supports anti-aliasing. Technical information: If anti-aliasing is off, this method reads the image directly from the graphics renderer, else it renders to a framebuffer and gets the image from there. The key part of this method is Qt's QOpenGLFramebufferObject class.
    • Framebuffer (as is) This method uses the same techniques as Framebuffer (custom). It also supports anti-aliasing but has some limitations related to custom sizes and always uses the current background of the 3D view.

Image comment

  1. Select the Insert MIBA option to add MIBA information to the file. Not all image formats support this.
  2. Or select the Insert comment option and type a comment in the text field to embed a comment in the file. Not all image formats support this.
  3. Check the Add watermark checkbox to add a watermark. The watermark is placed in the lower left corner of the image and consists of the FreeCAD logo and name above the main FreeCAD URL: www.freecadweb.org.

Notes

  • The number of available image file formats may vary depending on your OS.
  • Some OpenGL drivers don't allow renderings above a certain maximum size.

Preferences

  • The 3D view background can be changed in the preferences: Edit → Preferences... → Display → Colors → Background color. See Preferences Editor.
  • To change the 3D view anti-aliasing: Edit → Preferences... → Display → 3D view → Rendering → Anti-Aliasing. See Preferences Editor.

Scripting

It is possible to create screenshots with python code.

Gui.ActiveDocument.ActiveView.saveImage('C:/temp/test.png',1656,783,'Current')

This script saves a series of screenshots of different sizes and from different directions. The camera type, orthographic or perspective, is also changed.

import Part, PartGui
# Loading test part
Part.open('C:/Documents and Settings/jriegel/My Documents/Projects/FreeCAD/data/Blade.stp')
OutDir = 'C:/temp/'
 
# Creating images with different Views, Cameras and sizes
for p in ['PerspectiveCamera','OrthographicCamera']:
    Gui.SendMsgToActiveView(p)
    for f in ['ViewAxo','ViewFront','ViewTop']:
        Gui.SendMsgToActiveView(f)
        for x,y in [[500,500],[1000,3000],[3000,1000],[3000,3000],[8000,8000]]:
            Gui.ActiveDocument.ActiveView.saveImage(OutDir + 'Blade_' + p +'_' + f + '_' + `x` + '_' + `y` + '.jpg',x,y,'White')
            Gui.ActiveDocument.ActiveView.saveImage(OutDir + 'Blade_' + p +'_' + f + '_' + `x` + '_' + `y` + '.png',x,y,'Transparent')

# Close active document
App.closeDocument(App.ActiveDocument.Name)