Macro Screen Wiki

{{Macro |Name=Macro Screen Wiki |Icon=Macro_Screen_Wiki.png |Description=Special macro for the Wiki user. This macro allows to save the 3D view in the desired format. The 3D view or the full 3D window of FreeCAD takes the desired dimensions. A rotation of the selected object or of the 3D view is possible to give a rotation angle the number of images is calculated automatically it is possible to give a departure angle and an arrival angle. You must use another Gimp example program to assemble the images and create the animated file. |Author=Mario52 |Version=00.06c |Date=2024/10/10 |FCVersion=0.19 and more |Download=[https://wiki.freecad.org/https://raw.githubusercontent.com/FreeCAD/FreeCAD-documentation/master/wiki/images/f/f5/Macro_Screen_Wiki.png ToolBar Icon] |SeeAlso=Macro Copy3DViewToClipboard, Macro Snip }}

Description

This macro allows the user save the 3D view in a desired format. The 3D view or the full 3D window of FreeCAD takes the desired dimensions. A rotation of the selected object or of the 3D view is possible to give a rotation angle the number of images is calculated automatically it is possible to give a departure angle and an arrival angle. You must use another Gimp example program to assemble the images and create the animated file.

{{Codeextralink|https://gist.githubusercontent.com/mario52a/61571ce0bd41af0471995df7c3ea855f/raw/14deef95d2276c1095ea7eefb75dc5b5e4be4e04/Macro_Screen_Wiki.FCMacro}}

Macro Screen Wiki Image and configuration window

Macro Screen Wiki Rotation window

Usage

Image options

Definition

1. {{RadioButton|400x200}}

2. {{RadioButton|TRUE|600x400}}(Default)

3. {{RadioButton|1024x768}}

4. {{RadioButton|320x240 (QVGA)}}

5. {{RadioButton|320x480 (HVGA)}}

6. {{RadioButton|400x300}}

7. {{RadioButton|480x360}}

8. {{RadioButton|640x480 (VGA)}}

9. {{RadioButton|768x576 (PAL)}}

10. {{RadioButton|800x600 (SVGA)}}

11. {{RadioButton|960x720}}

12. {{RadioButton|1024x768 (XGA)}}

Format image

1. {{SpinBox|600 px}}Length (Default: 600 px)

2. {{SpinBox|400 px}}Height (Default: 400 px)

Window

1. {{RadioButton|Window FC}}: The complete FreeCAD window

2. {{RadioButton|TRUE|Screen 3D}}: The 3D view of FreeCAD

BackGround Color

1. {{RadioButton|TRUE|Current}}(Default)

2. {{RadioButton|Color}}

3. {{RadioButton|Transparent}}

4. Restore

Command

1. Set Screen: Docked window

2. Tile Screen: Fly window

3. Save Image: Save the image, for ex: imageBox_000.png (the _000 is incremented with each new image)

4. Follow: After saving the first image, press this button to save the next image with the same name. The images saved is incremented, for ex: imageBox_001.png, imageBox_002.png, imageBox_003.png, etc...

5. New Image: Save one new image without change the counter

6. Rotation: Access to the rotation menu (the title of the section \"Image options\" change to \"Rotation options\"

7. Quit: ___ScreenWiki end_________\

8. ToolBar: Reduce the image window in a toolBar, the Rotation option is not available in this mode

   1. 
   2. The button [[Image:Macro_Screen_Wiki_ToolBar_04_6.png]] Flip/Flop Y/N the mini toolBar

Rotation options

Rotation on

1. {{RadioButton|3D View}}: The complete view is rotated

2. {{RadioButton|TRUE|Object}}: The object selected is rotated

Axis

:
{{RadioButton|TRUE| {{ColoredText||red|'''X'''}}}}: Rotation on X axis

:
{{RadioButton| {{ColoredText||Green|'''Y'''}}}}: Rotation on Y axis

:
{{RadioButton| {{ColoredText||Blue|'''Z'''}}}}: Rotation on Z axis

:
{{RadioButton| {{ColoredText||#995500|'''D'''}}}}: Rotation on Direction.

  - To use this option: select first the object, then afterwards select the wire guideline. If {{RadioButton|TRUE|{{ColoredText||#995500|'''D'''}}}} is checked and no wire is selected the direction is `Vector(0, 0, 0)`

Point Rotation BoundBox

1. Object: Rotation on the BoundBox center of the object selected
2. Sub Object: Rotation on the BoundBox center of the sub object selected

Angles

• Angle Rotation

1. -: Decrease the value by 10 degrees

2. {{SpinBox|0 Degrees}}: Value

3. +: Increase the value by 10 degrees

• Number images

1. -: Decrease the value by 10 images

2. {{SpinBox|0 Images (+1)}}: Value

3. +: Increase the value by 10 images

• Angle Begin Rotation

1. -: Decrease the value by 10 degrees

2. {{SpinBox|0 Degrees}}: Value: Angle of the starting rotation

3. +: Increase the value by 10 degrees

• Degrees Angle End Rotation

1. -: Decrease the value by 10 degrees

2. {{SpinBox|360 Degrees}}: Value: Angle of the end rotation

3. +: Increase the value by 10 degrees

Command

• Delay between 2 images

1. {{SpinBox|0,00 Delay second}}: If there is a problem saving images due to speed, then add a delay of X seconds.

2. {{CheckBox|Reverse}}: Checked, this option reverses the rotation 3D view or Object

3. Point center: Visualize the point center of rotation, if the point is visible the point is include in the image (PS: the point can be hidden by an object)

4. {{CheckBox|TRUE|Original position}}: This option restores the original position of the 3D View or the Object rotated. Instead fo the 3D view or the Object staying in the last position of the rotation.

5. Test Rot.: Testing the rotation without saving images

6. Save the animation: Save the animation

Examples

Captured screen with dimensions of `640px x 400px`

Same dimensions as the previous image, this one is captured as 'Tile Screen'.

Animation mode: Object selected and direction BoundBox center Object.
The images must be assembled with a 3rd party application to create an animated .gif
such as [https://daviesmediadesign.com/project/make-animated-gif-gimp/ GIMP] or [https://www.screentogif.com ScreenToGif]

Animation mode: Object Direction SubObject selected.
The images must be assembled with a 3rd party application that creates an animated .gif
such as [https://daviesmediadesign.com/project/make-animated-gif-gimp/ GIMP] or [https://www.screentogif.com ScreenToGif]

The FreeCAD window resized. The dimension may be different from the definition (depending on the Widget, title bar etc... used.)

Versions

Version=00.06c: 10/10/2024 : delete \"import WebGui\"

Version=00.06: Version=00.06b: 2023/06/26 : adding select number image, button test rotation, button visualize the point rotation, adding code by wmayer center rotation on center screen :

                #https://forum.freecadweb.org/viewtopic.php?f=22&t=10157
                cam = Gui.ActiveDocument.ActiveView.getCameraNode()
                position = cam.position.getValue()
                orient = cam.orientation.getValue()
                focalDistance = cam.focalDistance.getValue()
                viewdir = coin.SbVec3f(0, 0, -1)
                viewdir = orient.multVec(viewdir)
                pointRotation = position + viewdir * focalDistance
                pointRotation = pointRotation2 = App.Vector(pointRotation.getValue()[0], pointRotation.getValue()[1], pointRotation.getValue()[2])

Version=00.05: 2021/05/21 : adding code in Save file section for Linux Mint QFileDialog ignore the extension. Only the Path+name is displayed

global switchQFileDialogMint
                ####  mint
                if switchQFileDialogMint == True:   #
                    Filter = Filter[Filter.find("."):Filter.find(")")]
                    SaveName = SaveName + Filter
                ####  mint
``` Version=00.04: 2021/01/13 : adding mini ToolBar

Version=0.03: 2020/10/30 : create a tool bar for the image and new button for unique image

Version=0.02: 2020/05/04 : correct bug color button (self.PB_01_Color obsolete)

Version=0.01: 2020/03/21



---
⏵ [documentation index](wiki-test2.php?gitpage=../README) > Macro Screen Wiki

This page is retrieved from https://github.com/FreeCAD/FreeCAD-documentation/blob/main/wiki/Macro_Screen_Wiki.md