modeling-app/docs/kcl/fromCm.md

title, excerpt, layout

title	excerpt	layout
fromCm	Converts a number from centimeters to the current default unit.	manual

Converts a number from centimeters to the current default unit.

No matter what units the current file uses, this function will always return a number equivalent to the input in centimeters.

For example, if the current project uses inches, fromCm will return 0.393701. If the current project uses millimeters, fromCm will return 10. If the current project uses centimeters, fromCm 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 fromCm(10) is more readable that your intent is "I want 10 centimeters" than 10 * 10, if the project settings are in millimeters.

fromCm(input: number): number

Tags

• units

Arguments

Name	Type	Description	Required
input	number		Yes

Returns

number

Examples

totalWidth = fromCm(10)