Files
modeling-app/docs/kcl/m.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
m Meters conversion factor for current projects units. manual

Meters conversion factor for current projects units.

No matter what units the current project uses, this function will always return the conversion factor to meters. For example, if the current project uses inches, this function will return 39.3701. If the current project uses millimeters, this function will return 1000. If the current project uses meters, 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 * m() is more readable that your intent is "I want 10 meters" than 10 * 1000, if the project settings are in millimeters.

m() -> number

Tags

  • units

Examples

const totalWidth = 10 * m()

Rendered example of m 0

Arguments

Returns

number