Files
modeling-app/docs/kcl/ft.md
Jess Frazelle be047f5111 add unit functions (#3604)
* add unit functions

Signed-off-by: Jess Frazelle <github@jessfraz.com>

* add tests

Signed-off-by: Jess Frazelle <github@jessfraz.com>

* update docs

Signed-off-by: Jess Frazelle <github@jessfraz.com>

* updates

Signed-off-by: Jess Frazelle <github@jessfraz.com>

* A snapshot a day keeps the bugs away! 📷🐛 (OS: windows-latest)

* empty

* A snapshot a day keeps the bugs away! 📷🐛 (OS: windows-latest)

---------

Signed-off-by: Jess Frazelle <github@jessfraz.com>
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
2024-08-21 12:12:56 -07:00

27 KiB

title, excerpt, layout
title excerpt layout
ft Feet conversion factor for current projects units. manual

Feet conversion factor for current projects units.

No matter what units the current project uses, this function will always return the conversion factor to feet. For example, if the current project uses inches, this function will return 12. If the current project uses millimeters, this function will return 304.8. If the current project uses feet, this function will return 1. Caution: This function is only intended to be used when you absolutely MUST have different units in your code than the project settings. Otherwise, it is a bad pattern to use this function. We merely provide these functions for convenience and readability, as 10 * ft() is more readable that your intent is "I want 10 feet" than 10 * 304.8, if the project settings are in millimeters.

ft() -> number

Tags

  • units

Examples

const totalWidth = 10 * ft()

Rendered example of ft 0

Arguments

Returns

number