Std ViewScreenShot: Difference between revisions

From FreeCAD Documentation
(add more info)
(Marked this version for translation)
(9 intermediate revisions by 3 users not shown)
Line 2: Line 2:
<translate>
<translate>
<!--T:1-->
<!--T:1-->
{{GuiCommand
{{GuiCommand|Name=Std ViewScreenShot|MenuLocation=[[Std Tools Menu|Tools]] → Save picture...|Workbenches=All|SeeAlso=...}}
|Name=Std ViewScreenShot
|MenuLocation={{StdMenu|[[Std Tools Menu|Tools]]}} → Save picture...
|Workbenches=All
|SeeAlso=...
}}


==== Synopsis ==== <!--T:2-->
== Description == <!--T:17-->

This command opens a dialog to save the current content of the 3D view to a file. It can save to various image formats. Additionally, you can change the aspect ratio and the resolution of the screen shot using the "Options" button to get access to more parameters.
<!--T:2-->
This command opens a dialog to save the current content of the [[3D view]] to a file. It can save to various image formats. Additionally, you can change the aspect ratio and the resolution of the screen shot using the "Options" button to get access to more parameters.


<!--T:3-->
<!--T:3-->
This command can also use the image comment field of some image formats, like PNG or JPEG to save [[MIBA]] information along with the picture.
This command can also use the image comment field of some image formats, like PNG or JPEG to save [[MIBA]] information along with the picture.


==== Image formats ==== <!--T:4-->
==Usage== <!--T:14-->

<!--T:15-->
# There are several ways to invoke this command:
#* Pressing the {{KEY|[[File:Std ViewScreenShot.svg|16px|Std ViewScreenShot|link=Std ViewScreenShot]] [[Std ViewScreenShot|Std ViewScreenShot]]}} button in the toolbar
#* Using the {{MenuCommand|{{StdMenu|[[Std Tools Menu|Tools]]}} → Save picture...}} menu.
#* via [[#Scripting|Python scripting]]
'''Result:''' A dialog will open requesting some parameters

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

===Image formats === <!--T:4-->
FreeCAD uses the QT built-in image types and some QT plugins in the bin/imageformats directory to save pictures. So how many and what formats you can choose depends on your platform.
FreeCAD uses the QT built-in image types and some QT plugins in the bin/imageformats directory to save pictures. So how many and what formats you can choose depends on your platform.
==== Dialog ====
=== Dialog ===


<!--T:5-->
<!--T:5-->
Line 31: Line 49:
* '''Transparent''' creates a transparent background on image formats which support transparency
* '''Transparent''' creates a transparent background on image formats which support transparency


===== Creation method =====
===== Creation method ===== <!--T:12-->
With this combo box you can set how the image data is collected (rendered):
With this combo box you can set how the image data is collected (rendered):
* '''Framebuffer (custom)''': It uses the same technique as '''Framebuffer (as is)'''. Additionally it allows to set custom sizes and the background.
* '''Framebuffer (custom)''': It uses the same technique as '''Framebuffer (as is)'''. Additionally it allows to set custom sizes and the background.
* '''Framebuffer (as is)''': If multi-sampling is off (i.e. no anti-aliasing) then it reads the image directly from the graphic renderer. If multi-sampling is on, it renders to a framebuffer and gets the image from there.
* '''Framebuffer (as is)''': If [https://en.wikipedia.org/wiki/Multisample_anti-aliasing multi-sampling anti-aliasing] is off, it reads the image directly from the graphic renderer. If multi-sampling is on, it renders to a framebuffer and gets the image from there. (The key part of this method is Qt's QOpenGLFramebufferObject class.)
* '''Offscreen (new)''': This is the default method. It is a replacement/alternative for the '''Offscreen (old)''' rendering. Additionally it supports multi-sampling. (The most important classes are Qt's QOffscreenSurface and QOpenGLFramebufferObject.)
* '''Offscreen (new)''': This is the default method. It is a replacement/alternative for the '''Offscreen (old)''' rendering. Additionally it supports multi-sampling. (The most important classes are Qt's QOffscreenSurface and QOpenGLFramebufferObject.)
* '''Offscreen (old)''': It only uses functions from the library Coin3d. This method does not support multi-sampling, relies heavily on graphic driver and on many modern Linux systems it does not work. It is a real off-screen rendering method that doesn't require an OpenGL window.
* '''Offscreen (old)''': It only uses functions from the library Coin3d. This method does not support multi-sampling, relies heavily on graphic driver and on many modern Linux systems it does not work. It is a real off-screen rendering method that doesn't require an OpenGL window.

<!--T:13-->
To turn on multi-sampling (anti-aliasing), use the option '''[[Preferences_Editor#3D_View|Anti-Aliasing]]''' in the [[Preferences_Editor|preferences]].


===== Comment ===== <!--T:9-->
===== Comment ===== <!--T:9-->
Some image formats can transport a comment along the picture. In case you choose one of this formats you can insert a comment or use the comment field for the [[MIBA]] information.
Some image formats can embed a comment in to the picture. In case you choose one of this formats you can insert a comment or use the comment field for the '''[[MIBA]]''' information.


==== Scripting ==== <!--T:10-->
== Scripting == <!--T:10-->
It's also possible to save the screen by python:
It's also possible to save the screen via python:
</translate>
</translate>
{{Code|code=
{{Code|code=
Line 72: Line 93:
}}
}}


{{Std Base navi}}
{{Userdocnavi}}
{{clear}}
{{clear}}

{{Std Base navi{{#translation:}}}} <!--Do not add this line inside of translation tags -->

{{Userdocnavi{{#translation:}}}} <!--Do not add this line inside of translation tags -->

Revision as of 22:01, 23 March 2020

Std ViewScreenShot

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

Description

This command opens a dialog to save the current content of the 3D view to a file. It can save to various image formats. Additionally, you can change the aspect ratio and the resolution of the screen shot using the "Options" button to get access to more parameters.

This command can also use the image comment field of some image formats, like PNG or JPEG to save MIBA information along with the picture.

Usage

  1. There are several ways to invoke this command:

Result: A dialog will open requesting some parameters

Options

Image formats

FreeCAD uses the QT built-in image types and some QT plugins in the bin/imageformats directory to save pictures. So how many and what formats you can choose depends on your platform.

Dialog

Image Size

The image size parameters are set to the screen size of the active 3D view. But you can change it to any value you like. Some OpenGL drivers don't allow renderings greater then 8000 pixels. It depends on your system.

With the four buttons you can change the aspect to a certain value.

Image background

With this combo box you can choose the background of the picture you make.

  • Current use the current view background (as chosen in the preferences)
  • White creates a plain white background (for e.g. printings)
  • Black plain black background
  • Transparent creates a transparent background on image formats which support transparency
Creation method

With this combo box you can set how the image data is collected (rendered):

  • Framebuffer (custom): It uses the same technique as Framebuffer (as is). Additionally it allows to set custom sizes and the background.
  • Framebuffer (as is): If multi-sampling anti-aliasing is off, it reads the image directly from the graphic renderer. If multi-sampling is on, it renders to a framebuffer and gets the image from there. (The key part of this method is Qt's QOpenGLFramebufferObject class.)
  • Offscreen (new): This is the default method. It is a replacement/alternative for the Offscreen (old) rendering. Additionally it supports multi-sampling. (The most important classes are Qt's QOffscreenSurface and QOpenGLFramebufferObject.)
  • Offscreen (old): It only uses functions from the library Coin3d. This method does not support multi-sampling, relies heavily on graphic driver and on many modern Linux systems it does not work. It is a real off-screen rendering method that doesn't require an OpenGL window.

To turn on multi-sampling (anti-aliasing), use the option Anti-Aliasing in the preferences.

Comment

Some image formats can embed a comment in to the picture. In case you choose one of this formats you can insert a comment or use the comment field for the MIBA information.

Scripting

It's also possible to save the screen via python:

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

This script makes a series of pictures of different sizes and from different points of view. The type of the camera, i.e. orthographic or perspective can also be 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)