Std Import: Difference between revisions

From FreeCAD Documentation
(Adding Image Plane info...)
mNo edit summary
 
(27 intermediate revisions by 2 users not shown)
Line 1: Line 1:
<languages/>
<languages/>
<translate>
<translate>

<!--T:8-->
<!--T:8-->
{{Docnav
{{Docnav
Line 25: Line 26:
The '''Std Import''' command imports geometry from a different file format into the active document. Many file formats are supported and for some formats multiple import options exist. See [[Import_Export|Import Export]] for more information.
The '''Std Import''' command imports geometry from a different file format into the active document. Many file formats are supported and for some formats multiple import options exist. See [[Import_Export|Import Export]] for more information.


<!--T:16-->
{{Version|1.0}} If an image format is selected the command will create an [[#Image_Plane|Image Plane]].
{{Version|0.21}}: If an image format is selected the command will create an [[#Image_Plane|Image Plane]].


==Usage== <!--T:7-->
==Usage== <!--T:7-->
Line 42: Line 44:
* Press {{KEY|Esc}} or the {{Button|Cancel}} button to abort the command.
* Press {{KEY|Esc}} or the {{Button|Cancel}} button to abort the command.


==Notes== <!--T:9-->
==Image Plane==

<!--T:10-->
* To convert an imported [[Mesh_Workbench|mesh object]] into a solid see the [[Import_from_STL_or_OBJ|Import from STL or OBJ]] tutorial.
* To import into a new document you can use the [[Std_Open|Std Open]] command.
* Some workbenches have additional import commands. See [[Import_Export|Import Export]].

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

<!--T:12-->
* See [[Import_Export_Preferences|Import Export Preferences]].

==Image Plane== <!--T:17-->


<!--T:18-->
An Image Plane is a planar representation of an image in the [[3D_view|3D view]]. It can for example be used when creating a model based on photographs of an existing object.
An Image Plane is a planar representation of an image in the [[3D_view|3D view]]. It can for example be used when creating a model based on photographs of an existing object.


<!--T:19-->
By default an Image Plane is placed on the global XY plane. The initial size of an Image Plane is calculated using a 96 px/inch resolution for BMP images. Image Planes based on SVG images have a default size of 100 mm x 100 mm, the SVG's aspect ratio is ignored.
By default an Image Plane is placed on the global XY plane. The initial size of an Image Plane is calculated using a 96px/inch resolution.


===Edit===
===Edit=== <!--T:20-->


<!--T:21-->
# To edit an Image Plane do one of the following:
# To edit an Image Plane do one of the following:
#* Double-click the Image Plane in the [[Tree_view|Tree view]].
#* Double-click the Image Plane in the [[Tree_view|Tree view]].
#* Right-click the Image Plane in the Tree view and select {{MenuCommand|[[Image:Image-scaling.svg|16px]] Change image...}} from the context menu.
#* Right-click the Image Plane in the Tree view and select {{MenuCommand|[[Image:Image-scaling.svg|16px]] Change image...}} from the context menu.
# If the Image Plane is not plane-parallel to the XY, XZ or YZ plane of the global coordinate system, it is realigned to be plane-parallel to the XY plane.
# A task panel opens.
# {{MenuCommand|Choose orientation}} options:
# The {{MenuCommand|Image plane settings}} task panel opens.
## Select the {{MenuCommand|XY}}, {{MenuCommand|XZ}} or {{MenuCommand|YZ}} plane of the global coordinate system.
# Optionally select the {{MenuCommand|XY-Plane}}, {{MenuCommand|XZ-Plane}} or {{MenuCommand|YZ-Plane}} of the global coordinate system.
## Check {{MenuCommand|Reverse direction}} to mirror the image.
# Check {{MenuCommand|Reverse direction}} to rotate the Image Plane 180°. The rotation axis depends on the selected plane. For the XY plane it is the global X axis. For the XZ and YZ plane it is the global Z axis.
## Optionally change the {{MenuCommand|Offset}}. A small negative offset can be useful when tracing a photograph with a [[Sketcher_Workbench|sketch]] or [[Draft_Workbench|Draft]] geometry.
# The {{MenuCommand|Offset}}, {{MenuCommand|X distance}} and {{MenuCommand|Y distance}} are relative to the coordinate system of the Image Plane. A small negative offset can be useful when tracing the image with a [[Sketcher_Workbench|sketch]] or [[Draft_Workbench|Draft]] geometry.
# {{MenuCommand|Scale image}} options:
# Optionally change the {{MenuCommand|Transparency}}.
# {{MenuCommand|Image size}} options:
#* Scale by numerical input:
#* Scale by numerical input:
#*# Optionally uncheck {{MenuCommand|Keep aspect ratio}} for unequal scaling.
#*# Optionally uncheck {{MenuCommand|Keep aspect ratio}} for unequal scaling.
#*# Enter a {{MenuCommand|Width}} and/or {{MenuCommand|Height}}.
#*# Enter a {{MenuCommand|Width}} and/or {{MenuCommand|Height}}.
#* Scale by picking points in the 3D view:
#* Scale by picking points:
#*# Press the {{Button|Calibrate}} button.
#*# Optionally check {{MenuCommand|Allow points outside the image}}.
#*# Pick two points inside the image.
#*# Press the {{Button|Interactive}} button.
#*# A dimension line is displayed.
#*# Select two points.
#*# Enter the {{MenuCommand|Desired distance}}.
#*# Enter the desired dimension.
#*# Press the {{Button|Accept}} button.
#*# Press {{KEY|Enter}} or the {{Button|Apply}} button.
# Press the {{Button|OK}} button to confirm the changes and close the task panel.


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


<!--T:23-->
See also: [[Property_editor|Property editor]].


<!--T:24-->
An Image Plane object is derived from an [[App_GeoFeature|App GeoFeature]] object and inherits all its properties. It also has the following additional properties:


====Data==== <!--T:25-->


<!--T:26-->
{{TitleProperty|Image Plane}}


<!--T:27-->
* {{PropertyData|Image File|FileIncluded}}: The image file used for the Image Plane. This file is stored in the {{FileName|.FCStd}} file.
* {{PropertyData|XSize|Length}}: The width of the Image Plane.
* {{PropertyData|YSize|Length}}: The height of the Image Plane.


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


==Notes== <!--T:9-->
<!--T:29-->
{{TitleProperty|Object Style}}


<!--T:10-->
<!--T:30-->
* {{PropertyView|Lighting|Enumeration}}: How the Image Plane is illuminated in the [[3D_view|3D view]]. Can be {{value|Two side}} or {{value|One side}}.
* To convert an imported [[Mesh_Workbench|mesh object]] into a solid see the [[Import_from_STL_or_OBJ|Import from STL or OBJ]] tutorial.
* To import into a new document you can use the [[Std_Open|Std Open]] command.
* Some workbenches have additional import commands. See: [[Import_Export|Import Export]].

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

<!--T:12-->
* See: [[Import_Export_Preferences|Import Export Preferences]].
* The last used file location is stored: {{MenuCommand|Tools → Edit parameters... → BaseApp → Preferences → General → FileOpenSavePath}}.
* The last used import filter is stored: {{MenuCommand|Tools → Edit parameters... → BaseApp → Preferences → General → FileImportFilter}}.




Line 102: Line 126:


</translate>
</translate>
{{Std Base navi{{#translation:}}}}
{{Std_Base_navi{{#translation:}}}}
{{Userdocnavi{{#translation:}}}}
{{Userdocnavi{{#translation:}}}}
[[Category:File_Formats{{#translation:}}]]
[[Category:File_Formats{{#translation:}}]]
{{clear}}

Latest revision as of 20:04, 20 April 2024

Std Import

Menu location
File → Import...
Workbenches
All
Default shortcut
Ctrl+I
Introduced in version
-
See also
Std Open, Import Export, Import Export Preferences

Description

The Std Import command imports geometry from a different file format into the active document. Many file formats are supported and for some formats multiple import options exist. See Import Export for more information.

introduced in version 0.21: If an image format is selected the command will create an Image Plane.

Usage

  1. There are several ways to invoke the command:
    • Select the File → Import... option from the menu.
    • Use the keyboard shortcut: Ctrl+I.
  2. Optionally select the correct file format in the dialog box.
  3. Select a file.
  4. Press the Open button.

Options

  • Press Esc or the Cancel button to abort the command.

Notes

Preferences

Image Plane

An Image Plane is a planar representation of an image in the 3D view. It can for example be used when creating a model based on photographs of an existing object.

By default an Image Plane is placed on the global XY plane. The initial size of an Image Plane is calculated using a 96px/inch resolution.

Edit

  1. To edit an Image Plane do one of the following:
    • Double-click the Image Plane in the Tree view.
    • Right-click the Image Plane in the Tree view and select Change image... from the context menu.
  2. If the Image Plane is not plane-parallel to the XY, XZ or YZ plane of the global coordinate system, it is realigned to be plane-parallel to the XY plane.
  3. The Image plane settings task panel opens.
  4. Optionally select the XY-Plane, XZ-Plane or YZ-Plane of the global coordinate system.
  5. Check Reverse direction to rotate the Image Plane 180°. The rotation axis depends on the selected plane. For the XY plane it is the global X axis. For the XZ and YZ plane it is the global Z axis.
  6. The Offset, X distance and Y distance are relative to the coordinate system of the Image Plane. A small negative offset can be useful when tracing the image with a sketch or Draft geometry.
  7. Optionally change the Transparency.
  8. Image size options:
    • Scale by numerical input:
      1. Optionally uncheck Keep aspect ratio for unequal scaling.
      2. Enter a Width and/or Height.
    • Scale by picking points:
      1. Press the Calibrate button.
      2. Pick two points inside the image.
      3. A dimension line is displayed.
      4. Enter the desired dimension.
      5. Press Enter or the Apply button.
  9. Press the OK button to confirm the changes and close the task panel.

Properties

See also: Property editor.

An Image Plane object is derived from an App GeoFeature object and inherits all its properties. It also has the following additional properties:

Data

Image Plane

  • DataImage File (FileIncluded): The image file used for the Image Plane. This file is stored in the .FCStd file.
  • DataXSize (Length): The width of the Image Plane.
  • DataYSize (Length): The height of the Image Plane.

View

Object Style

  • ViewLighting (Enumeration): How the Image Plane is illuminated in the 3D view. Can be Two side or One side.