Files
modeling-app/docs/kcl/import.md
Nick Cameron df278c7e6a Various hover improvements (#5617)
* Show more info on hover for variables

Signed-off-by: Nick Cameron <nrc@ncameron.org>

* Move hover impls to lsp module

Signed-off-by: Nick Cameron <nrc@ncameron.org>

* Make hover work on names inside calls, fix doc line breaking, trim docs in tool tips

Signed-off-by: Nick Cameron <nrc@ncameron.org>

* Test the new hovers; fix signature syntax

Signed-off-by: Nick Cameron <nrc@ncameron.org>

* Hover tips for kwargs

Signed-off-by: Nick Cameron <nrc@ncameron.org>

---------

Signed-off-by: Nick Cameron <nrc@ncameron.org>
2025-03-04 09:53:31 +00:00

486 KiB

title, excerpt, layout
title excerpt layout
import Import a CAD file. manual

WARNING: This function is deprecated.

Import a CAD file.

DEPRECATED Prefer to use import statements.

For formats lacking unit data (such as STL, OBJ, or PLY files), the default unit of measurement is millimeters. Alternatively you may specify the unit by passing your desired measurement unit in the options parameter. When importing a GLTF file, the bin file will be imported as well. Import paths are relative to the current project directory.

Note: The import command currently only works when using the native Modeling App.

import(
  filePath: String,
  options?: ImportFormat,
): ImportedGeometry

Arguments

Name Type Description Required
filePath String Yes
options ImportFormat Import format specifier No

Returns

ImportedGeometry - Data for an imported geometry.

Examples

model = import("tests/inputs/cube.obj")

Rendered example of import 0

model = import("tests/inputs/cube.obj", { format = "obj", units = "m" })

Rendered example of import 1

model = import("tests/inputs/cube.gltf")

Rendered example of import 2

model = import("tests/inputs/cube.sldprt")

Rendered example of import 3

model = import("tests/inputs/cube.step")

Rendered example of import 4

import height, buildSketch from "common.kcl"

plane = 'XZ'
margin = 2
s1 = buildSketch(plane, [0, 0])
s2 = buildSketch(plane, [0, height() + margin])

Rendered example of import 5