Image CreateImagePlane: Difference between revisions

From FreeCAD Documentation
No edit summary
m (to match with propety name)
 
(6 intermediate revisions by 3 users not shown)
Line 1: Line 1:
<languages/>
<languages/>
<translate>
<translate>

<!--T:14-->
<!--T:14-->
{{Docnav
{{Docnav
|[[Image_Open|Open]]
|[[Image_Open|Open]]
|[[Image_Scaling|Scaling]]
|[[Image_Scaling|Scaling]]
|[[Image_Module|Image]]
|[[Image_Workbench|Image]]
|IconL=Image-import.svg
|IconL=Image_Open.svg
|IconR=Image-scale.svg
|IconR=Image_Scaling.svg
|IconC=Workbench_Image.svg
|IconC=Workbench_Image.svg
}}
}}
Line 14: Line 15:
{{GuiCommand
{{GuiCommand
|Name=Image CreateImagePlane
|Name=Image CreateImagePlane
|MenuLocation=Toolbars → Create a planar image in the 3D space
|MenuLocation=
|Workbenches=[[Image_Workbench|Image]]
|Workbenches=[[Image_Workbench|Image]]
|SeeAlso=[[Image_Open|Image Open]], [[Image_Scaling|Image Scaling]]
|SeeAlso=[[Image_Open|Image Open]], [[Image_Scaling|Image Scaling]]
Line 27: Line 28:


<!--T:5-->
<!--T:5-->
# Press the {{Button|[[Image:Image CreateImagePlane.svg|16px]] [[Image_CreateImagePlane|Image Plane]]}} button.
# Press the {{Button|[[Image:Image_CreateImagePlane.svg|16px]] [[Image_CreateImagePlane|Image CreateImagePlane]]}} button.
# Select the desired image in your system.
# Select the desired image in your system.
# Choose the plane where the image will be placed, give an offset value, and press {{Button|OK}}.
# Choose the plane where the image will be placed, give an offset value, and press {{Button|OK}}.
Line 35: Line 36:


<!--T:7-->
<!--T:7-->
When importing the image, you may wish to add an offset of {{incode|-0.1 mm}} in order to place the image slightly behind the working plane; this will make it easy to trace (draw on top) the image with the [[Draft_Module|Draft]] or [[Sketcher_Workbench|Sketcher]] tools.
When importing the image, you may wish to add an offset of {{incode|-0.1 mm}} in order to place the image slightly behind the working plane; this will make it easy to trace (draw on top) the image with the [[Draft_Workbench|Draft]] or [[Sketcher_Workbench|Sketcher]] tools.


<!--T:8-->
<!--T:8-->
Line 42: Line 43:
==Properties== <!--T:9-->
==Properties== <!--T:9-->


<!--T:10-->
<!--T:17-->
{{Properties Title|Base}}
{{Properties Title|Base}}

<!--T:10-->
* {{PropertyData|Position}}: specifies the coordinates of the base point of the image plane.
* {{PropertyData|Position}}: specifies the coordinates of the base point of the image plane.
* {{PropertyData|Angle}}: specifies the angle of rotation of the image plane.
* {{PropertyData|Angle}}: specifies the angle of rotation of the image plane.
* {{PropertyData|Axis}}: specifies the axis used for the rotation angle.
* {{PropertyData|Axis}}: specifies the axis used for the rotation angle.


<!--T:11-->
<!--T:18-->
{{Properties Title|Image Plane}}
{{Properties Title|Image Plane}}

<!--T:11-->
* {{PropertyData|Image File}}: specifies the image to use for this plane.
* {{PropertyData|XSize}}: specifies the width of the image plane.
* {{PropertyData|XSize}}: specifies the width of the image plane.
* {{PropertyData|YSize}}: specifies the height of the image plane.
* {{PropertyData|YSize}}: specifies the height of the image plane.
* {{PropertyData|Image Plane}}: specifies the image to use for this plane.




Line 59: Line 64:
|[[Image_Open|Open]]
|[[Image_Open|Open]]
|[[Image_Scaling|Scaling]]
|[[Image_Scaling|Scaling]]
|[[Image_Module|Image]]
|[[Image_Workbench|Image]]
|IconL=Image-import.svg
|IconL=Image_Open.svg
|IconR=Image-scale.svg
|IconR=Image_Scaling.svg
|IconC=Workbench_Image.svg
|IconC=Workbench_Image.svg
}}
}}
Line 68: Line 73:
{{Image Tools navi{{#translation:}}}}
{{Image Tools navi{{#translation:}}}}
{{Userdocnavi{{#translation:}}}}
{{Userdocnavi{{#translation:}}}}
{{clear}}

Latest revision as of 13:59, 2 February 2022

Image CreateImagePlane

Menu location
None
Workbenches
Image
Default shortcut
None
Introduced in version
-
See also
Image Open, Image Scaling

Description

The CreateImagePlane tool imports a bitmap image and places it on one of the XY, YZ or XZ planes.

Usage

  1. Press the Image CreateImagePlane button.
  2. Select the desired image in your system.
  3. Choose the plane where the image will be placed, give an offset value, and press OK.

The resulting ImagePlane object uses the ratio of 1 pixel to 1 millimeter; in order for the image to display well, it should have enough resolution.

When importing the image, you may wish to add an offset of -0.1 mm in order to place the image slightly behind the working plane; this will make it easy to trace (draw on top) the image with the Draft or Sketcher tools.

If no offset is given to the image initially, its position can still be adjusted in the property editor.

Properties

Base

  • DataPosition: specifies the coordinates of the base point of the image plane.
  • DataAngle: specifies the angle of rotation of the image plane.
  • DataAxis: specifies the axis used for the rotation angle.

Image Plane

  • DataImage File: specifies the image to use for this plane.
  • DataXSize: specifies the width of the image plane.
  • DataYSize: specifies the height of the image plane.