Image CreateImagePlane: Difference between revisions

From FreeCAD Documentation
(New button, image, and use)
No edit summary
(23 intermediate revisions by 7 users not shown)
Line 1: Line 1:
<languages/>
<languages/>
<translate>
<translate>
<!--T:14-->
{{Docnav
|[[Image_Open|Open]]
|[[Image_Scaling|Scaling]]
|[[Image_Module|Image]]
|IconL=Image-import.svg
|IconR=Image-scale.svg
|IconC=Workbench_Image.svg
}}

<!--T:1-->
<!--T:1-->
{{GuiCommand
{{GuiCommand
|Name=Image CreateImagePlane
|Name=Image CreateImagePlane
|MenuLocation=Image → Create a planar image in the 3D space
|MenuLocation=Toolbars → Create a planar image in the 3D space
|Workbenches=[[Image Workbench|Image]]
|Workbenches=[[Image_Workbench|Image]]
|SeeAlso=[[Image Open]], [[Image Scaling]]
|SeeAlso=[[Image_Open|Image Open]], [[Image_Scaling|Image Scaling]]
}}
}}


==Description== <!--T:2-->
== Description == <!--T:2-->
The [[Image CreateImagePlane|CreateImagePlane]] tool imports an [[bitmap]] image and places it on one of the XY, YZ or XZ planes.


==How to use== <!--T:3-->
<!--T:3-->
The [[Image_CreateImagePlane|CreateImagePlane]] tool imports a [[bitmap|bitmap]] image and places it on one of the XY, YZ or XZ planes.
# Press on the {{Button|[[Image:Image CreateImagePlane.svg|32px]] [[Image CreateImagePlane|Image Plane]]}}.
# Select the image in the dialog.
# Choose the plane where the image will be placed, as well as its offset.


==Properties== <!--T:4-->
==Usage== <!--T:4-->
* The image can be scaled by editing the {{PropertyData|XSize}} and {{PropertyData|YSize}} values in the [[Property editor|Property editor]].
* The image can be moved in the 3D view by editing the {{PropertyData|Placement}} in the [[Property editor|Property editor]].
* The image can be rotated around any axis by using the [[Property editor|Property editor]].


==Notes== <!--T:5-->
<!--T:5-->
# Press the {{Button|[[Image:Image CreateImagePlane.svg|16px]] [[Image_CreateImagePlane|Image Plane]]}} button.
Selecting the image in the tree view and activating its data-tab in the property view lets you select size<br />
and orientation of the image.
# Select the desired image in your system.
# Choose the plane where the image will be placed, give an offset value, and press {{Button|OK}}.
Specifying a small offset of 0,1 mm on import will make it easier to trace the image.
<br />


<!--T:6-->
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.

<!--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.

<!--T:8-->
If no offset is given to the image initially, its position can still be adjusted in the [[Property_editor|property editor]].

==Properties== <!--T:9-->

<!--T:10-->
{{Properties Title|Base}}
* {{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|Axis}}: specifies the axis used for the rotation angle.

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


<!--T:12-->
{{Docnav
|[[Image_Open|Open]]
|[[Image_Scaling|Scaling]]
|[[Image_Module|Image]]
|IconL=Image-import.svg
|IconR=Image-scale.svg
|IconC=Workbench_Image.svg
}}


</translate>
</translate>
{{Image Tools navi{{#translation:}}}}
{{Userdocnavi{{#translation:}}}}
{{clear}}
{{clear}}

Revision as of 21:41, 30 November 2020

Image CreateImagePlane

Menu location
Toolbars → Create a planar image in the 3D space
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 Plane 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

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