@bitbybit-dev/base 0.20.13 → 0.20.14

package/lib/api/services/text.js

@@ -8,7 +8,8 @@ export class TextBitByBit {
         this.point = point;
     }
     /**
-     * Creates a text
+     * Creates and returns a text string (pass-through for text input).
+     * Example: text='Hello World' → 'Hello World'
      * @param inputs a text
      * @returns text
      * @group create
@@ -19,7 +20,8 @@ export class TextBitByBit {
         return inputs.text;
     }
     /**
-    * Split the text to multiple pieces by a separator
+    * Splits text into multiple pieces using a separator string.
+    * Example: text='apple,banana,cherry', separator=',' → ['apple', 'banana', 'cherry']
     * @param inputs a text
     * @returns text
     * @group transform
@@ -30,7 +32,8 @@ export class TextBitByBit {
         return inputs.text.split(inputs.separator);
     }
     /**
-    * Replace all occurrences of a text by another text
+    * Replaces all occurrences of a search string with a replacement string.
+    * Example: text='hello hello', search='hello', replaceWith='hi' → 'hi hi'
     * @param inputs a text
     * @returns text
     * @group transform
@@ -41,7 +44,8 @@ export class TextBitByBit {
         return inputs.text.split(inputs.search).join(inputs.replaceWith);
     }
     /**
-    * Join multiple items by a separator into text
+    * Joins multiple items into a single text string using a separator.
+    * Example: list=['apple', 'banana', 'cherry'], separator=', ' → 'apple, banana, cherry'
     * @param inputs a list of items
     * @returns text
     * @group transform
@@ -74,7 +78,8 @@ export class TextBitByBit {
         return inputs.list.map(i => i.toString());
     }
     /**
-     * Format a text with values
+     * Formats text with placeholder values using {0}, {1}, etc. syntax.
+     * Example: text='Point: ({0}, {1})', values=[10, 5] → 'Point: (10, 5)'
      * @param inputs a text and values
      * @returns formatted text
      * @group transform
@@ -87,7 +92,343 @@ export class TextBitByBit {
         });
     }
     /**
-     * Creates a vector segments for character and includes width and height information
+     * Checks if text contains a search string.
+     * Example: text='hello world', search='world' → true
+     * @param inputs a text and search string
+     * @returns boolean
+     * @group query
+     * @shortname includes
+     * @drawable false
+     */
+    includes(inputs) {
+        return inputs.text.includes(inputs.search);
+    }
+    /**
+     * Checks if text starts with a search string.
+     * Example: text='hello world', search='hello' → true
+     * @param inputs a text and search string
+     * @returns boolean
+     * @group query
+     * @shortname starts with
+     * @drawable false
+     */
+    startsWith(inputs) {
+        return inputs.text.startsWith(inputs.search);
+    }
+    /**
+     * Checks if text ends with a search string.
+     * Example: text='hello world', search='world' → true
+     * @param inputs a text and search string
+     * @returns boolean
+     * @group query
+     * @shortname ends with
+     * @drawable false
+     */
+    endsWith(inputs) {
+        return inputs.text.endsWith(inputs.search);
+    }
+    /**
+     * Returns the index of the first occurrence of a search string.
+     * Example: text='hello world', search='world' → 6
+     * @param inputs a text and search string
+     * @returns index or -1 if not found
+     * @group query
+     * @shortname index of
+     * @drawable false
+     */
+    indexOf(inputs) {
+        return inputs.text.indexOf(inputs.search);
+    }
+    /**
+     * Returns the index of the last occurrence of a search string.
+     * Example: text='hello world hello', search='hello' → 12
+     * @param inputs a text and search string
+     * @returns index or -1 if not found
+     * @group query
+     * @shortname last index of
+     * @drawable false
+     */
+    lastIndexOf(inputs) {
+        return inputs.text.lastIndexOf(inputs.search);
+    }
+    /**
+     * Extracts a section of text between two indices.
+     * Example: text='hello world', start=0, end=5 → 'hello'
+     * @param inputs a text, start and end indices
+     * @returns extracted text
+     * @group transform
+     * @shortname substring
+     * @drawable false
+     */
+    substring(inputs) {
+        return inputs.text.substring(inputs.start, inputs.end);
+    }
+    /**
+     * Extracts a section of text and returns a new string.
+     * Example: text='hello world', start=0, end=5 → 'hello'
+     * @param inputs a text, start and end indices
+     * @returns extracted text
+     * @group transform
+     * @shortname slice
+     * @drawable false
+     */
+    slice(inputs) {
+        return inputs.text.slice(inputs.start, inputs.end);
+    }
+    /**
+     * Returns the character at the specified index.
+     * Example: text='hello', index=1 → 'e'
+     * @param inputs a text and index
+     * @returns character
+     * @group query
+     * @shortname char at
+     * @drawable false
+     */
+    charAt(inputs) {
+        return inputs.text.charAt(inputs.index);
+    }
+    /**
+     * Removes whitespace from both ends of text.
+     * Example: text='  hello  ' → 'hello'
+     * @param inputs a text
+     * @returns trimmed text
+     * @group transform
+     * @shortname trim
+     * @drawable false
+     */
+    trim(inputs) {
+        return inputs.text.trim();
+    }
+    /**
+     * Removes whitespace from the start of text.
+     * Example: text='  hello  ' → 'hello  '
+     * @param inputs a text
+     * @returns trimmed text
+     * @group transform
+     * @shortname trim start
+     * @drawable false
+     */
+    trimStart(inputs) {
+        return inputs.text.trimStart();
+    }
+    /**
+     * Removes whitespace from the end of text.
+     * Example: text='  hello  ' → '  hello'
+     * @param inputs a text
+     * @returns trimmed text
+     * @group transform
+     * @shortname trim end
+     * @drawable false
+     */
+    trimEnd(inputs) {
+        return inputs.text.trimEnd();
+    }
+    /**
+     * Pads text from the start to reach target length.
+     * Example: text='x', length=3, padString='a' → 'aax'
+     * @param inputs a text, target length and pad string
+     * @returns padded text
+     * @group transform
+     * @shortname pad start
+     * @drawable false
+     */
+    padStart(inputs) {
+        return inputs.text.padStart(inputs.length, inputs.padString);
+    }
+    /**
+     * Pads text from the end to reach target length.
+     * Example: text='x', length=3, padString='a' → 'xaa'
+     * @param inputs a text, target length and pad string
+     * @returns padded text
+     * @group transform
+     * @shortname pad end
+     * @drawable false
+     */
+    padEnd(inputs) {
+        return inputs.text.padEnd(inputs.length, inputs.padString);
+    }
+    /**
+     * Converts text to uppercase.
+     * Example: text='hello' → 'HELLO'
+     * @param inputs a text
+     * @returns uppercase text
+     * @group transform
+     * @shortname to upper case
+     * @drawable false
+     */
+    toUpperCase(inputs) {
+        return inputs.text.toUpperCase();
+    }
+    /**
+     * Converts text to lowercase.
+     * Example: text='HELLO' → 'hello'
+     * @param inputs a text
+     * @returns lowercase text
+     * @group transform
+     * @shortname to lower case
+     * @drawable false
+     */
+    toLowerCase(inputs) {
+        return inputs.text.toLowerCase();
+    }
+    /**
+     * Capitalizes the first character of text.
+     * Example: text='hello world' → 'Hello world'
+     * @param inputs a text
+     * @returns text with first character uppercase
+     * @group transform
+     * @shortname capitalize first
+     * @drawable false
+     */
+    toUpperCaseFirst(inputs) {
+        if (!inputs.text)
+            return inputs.text;
+        return inputs.text.charAt(0).toUpperCase() + inputs.text.slice(1);
+    }
+    /**
+     * Lowercases the first character of text.
+     * Example: text='Hello World' → 'hello World'
+     * @param inputs a text
+     * @returns text with first character lowercase
+     * @group transform
+     * @shortname uncapitalize first
+     * @drawable false
+     */
+    toLowerCaseFirst(inputs) {
+        if (!inputs.text)
+            return inputs.text;
+        return inputs.text.charAt(0).toLowerCase() + inputs.text.slice(1);
+    }
+    /**
+     * Repeats text a specified number of times.
+     * Example: text='ha', count=3 → 'hahaha'
+     * @param inputs a text and count
+     * @returns repeated text
+     * @group transform
+     * @shortname repeat
+     * @drawable false
+     */
+    repeat(inputs) {
+        return inputs.text.repeat(inputs.count);
+    }
+    /**
+     * Reverses the characters in text.
+     * Example: text='hello' → 'olleh'
+     * @param inputs a text
+     * @returns reversed text
+     * @group transform
+     * @shortname reverse
+     * @drawable false
+     */
+    reverse(inputs) {
+        return inputs.text.split("").reverse().join("");
+    }
+    /**
+     * Returns the length of text.
+     * Example: text='hello' → 5
+     * @param inputs a text
+     * @returns length
+     * @group query
+     * @shortname length
+     * @drawable false
+     */
+    length(inputs) {
+        return inputs.text.length;
+    }
+    /**
+     * Checks if text is empty or only whitespace.
+     * Example: text='   ' → true
+     * @param inputs a text
+     * @returns boolean
+     * @group query
+     * @shortname is empty
+     * @drawable false
+     */
+    isEmpty(inputs) {
+        return !inputs.text || inputs.text.trim().length === 0;
+    }
+    /**
+     * Concatenates multiple text strings.
+     * Example: texts=['hello', ' ', 'world'] → 'hello world'
+     * @param inputs array of texts
+     * @returns concatenated text
+     * @group transform
+     * @shortname concat
+     * @drawable false
+     */
+    concat(inputs) {
+        return inputs.texts.join("");
+    }
+    /**
+     * Tests if text matches a regular expression pattern.
+     * Example: text='hello123', pattern='[0-9]+' → true
+     * @param inputs a text and regex pattern
+     * @returns boolean
+     * @group regex
+     * @shortname test regex
+     * @drawable false
+     */
+    regexTest(inputs) {
+        const regex = new RegExp(inputs.pattern, inputs.flags);
+        return regex.test(inputs.text);
+    }
+    /**
+     * Matches text against a regular expression and returns matches.
+     * Example: text='hello123world456', pattern='[0-9]+', flags='g' → ['123', '456']
+     * @param inputs a text and regex pattern
+     * @returns array of matches or null
+     * @group regex
+     * @shortname regex match
+     * @drawable false
+     */
+    regexMatch(inputs) {
+        const regex = new RegExp(inputs.pattern, inputs.flags);
+        const result = inputs.text.match(regex);
+        return result ? Array.from(result) : null;
+    }
+    /**
+     * Replaces text matching a regular expression pattern.
+     * Example: text='hello123world456', pattern='[0-9]+', flags='g', replaceWith='X' → 'helloXworldX'
+     * @param inputs a text, regex pattern, and replacement
+     * @returns text with replacements
+     * @group regex
+     * @shortname regex replace
+     * @drawable false
+     */
+    regexReplace(inputs) {
+        const regex = new RegExp(inputs.pattern, inputs.flags);
+        return inputs.text.replace(regex, inputs.replaceWith);
+    }
+    /**
+     * Searches text for a regular expression pattern and returns the index.
+     * Example: text='hello123', pattern='[0-9]+' → 5
+     * @param inputs a text and regex pattern
+     * @returns index or -1 if not found
+     * @group regex
+     * @shortname regex search
+     * @drawable false
+     */
+    regexSearch(inputs) {
+        const regex = new RegExp(inputs.pattern, inputs.flags);
+        return inputs.text.search(regex);
+    }
+    /**
+     * Splits text using a regular expression pattern.
+     * Example: text='a1b2c3', pattern='[0-9]+' → ['a', 'b', 'c']
+     * @param inputs a text and regex pattern
+     * @returns array of split strings
+     * @group regex
+     * @shortname regex split
+     * @drawable false
+     */
+    regexSplit(inputs) {
+        const regex = new RegExp(inputs.pattern, inputs.flags);
+        return inputs.text.split(regex);
+    }
+    /**
+     * Converts a character to vector paths (polylines) with width and height data for rendering.
+     * Uses simplex stroke font to generate 2D line segments representing the character shape.
+     * Example: char='A', height=10 → {width:8, height:10, paths:[[points forming A shape]]}
      * @param inputs a text
      * @returns width, height and segments as json
      * @group vector
@@ -123,7 +464,9 @@ export class TextBitByBit {
         return { width, height, paths };
     }
     /**
-     * Creates a vector text lines for a given text and includes width and height information
+     * Converts multi-line text to vector paths (polylines) with alignment and spacing controls.
+     * Supports line breaks, letter spacing, line spacing, horizontal alignment, and origin centering.
+     * Example: text='Hello\nWorld', height=10, align=center → [{line1 chars}, {line2 chars}]
      * @param inputs a text as string
      * @returns segments
      * @group vector

package/lib/api/services/transforms.d.ts

@@ -12,7 +12,9 @@ export declare class Transforms {
     private readonly math;
     constructor(vector: Vector, math: MathBitByBit);
     /**
-     * Creates a rotation transformations around the center and an axis
+     * Creates rotation transformations around a center point and custom axis.
+     * Combines translation to origin, axis rotation, then translation back.
+     * Example: center=[5,0,0], axis=[0,1,0], angle=90° → rotates around vertical axis through point [5,0,0]
      * @param inputs Rotation around center with an axis information
      * @returns array of transformations
      * @group rotation
@@ -21,7 +23,8 @@ export declare class Transforms {
      */
     rotationCenterAxis(inputs: Inputs.Transforms.RotationCenterAxisDto): Base.TransformMatrixes;
     /**
-     * Creates a rotation transformations around the center and an X axis
+     * Creates rotation transformations around a center point along the X axis.
+     * Example: center=[5,5,5], angle=90° → rotates 90° around X axis through point [5,5,5]
      * @param inputs Rotation around center with an X axis information
      * @returns array of transformations
      * @group rotation
@@ -30,7 +33,8 @@ export declare class Transforms {
      */
     rotationCenterX(inputs: Inputs.Transforms.RotationCenterDto): Base.TransformMatrixes;
     /**
-     * Creates a rotation transformations around the center and an Y axis
+     * Creates rotation transformations around a center point along the Y axis.
+     * Example: center=[0,0,0], angle=45° → rotates 45° around Y axis through origin
      * @param inputs Rotation around center with an Y axis information
      * @returns array of transformations
      * @group rotation
@@ -39,7 +43,8 @@ export declare class Transforms {
      */
     rotationCenterY(inputs: Inputs.Transforms.RotationCenterDto): Base.TransformMatrixes;
     /**
-     * Creates a rotation transformations around the center and an Z axis
+     * Creates rotation transformations around a center point along the Z axis.
+     * Example: center=[10,10,0], angle=180° → rotates 180° around Z axis through point [10,10,0]
      * @param inputs Rotation around center with an Z axis information
      * @returns array of transformations
      * @group rotation
@@ -48,7 +53,9 @@ export declare class Transforms {
      */
     rotationCenterZ(inputs: Inputs.Transforms.RotationCenterDto): Base.TransformMatrixes;
     /**
-     * Creates a rotation transformations with yaw pitch and roll
+     * Creates rotation transformations using yaw-pitch-roll (Euler angles) around a center point.
+     * Yaw → Y axis rotation, Pitch → X axis rotation, Roll → Z axis rotation.
+     * Example: center=[0,0,0], yaw=90°, pitch=0°, roll=0° → rotates 90° around Y axis
      * @param inputs Yaw pitch roll rotation information
      * @returns array of transformations
      * @group rotation
@@ -57,16 +64,18 @@ export declare class Transforms {
      */
     rotationCenterYawPitchRoll(inputs: Inputs.Transforms.RotationCenterYawPitchRollDto): Base.TransformMatrixes;
     /**
-     * Scale transformation around center and xyz directions
+     * Creates non-uniform scale transformation around a center point (different scale per axis).
+     * Example: center=[5,5,5], scaleXyz=[2,1,0.5] → doubles X, keeps Y, halves Z around point [5,5,5]
      * @param inputs Scale center xyz trnansformation
      * @returns array of transformations
-     * @group rotation
+     * @group scale
      * @shortname center xyz
      * @drawable false
      */
     scaleCenterXYZ(inputs: Inputs.Transforms.ScaleCenterXYZDto): Base.TransformMatrixes;
     /**
-     * Creates the scale transformation in x, y and z directions
+     * Creates non-uniform scale transformation from origin (different scale per axis).
+     * Example: scaleXyz=[2,3,1] → doubles X, triples Y, keeps Z unchanged
      * @param inputs Scale XYZ number array information
      * @returns transformation
      * @group scale
@@ -75,9 +84,9 @@ export declare class Transforms {
      */
     scaleXYZ(inputs: Inputs.Transforms.ScaleXYZDto): Base.TransformMatrixes;
     /**
-     * Creates a stretch transformation along a specific direction, relative to a center point.
-     * This scales points along the given direction vector while leaving points in the
-     * plane perpendicular to the direction (passing through the center) unchanged.
+     * Creates directional stretch transformation that scales along a specific direction from a center point.
+     * Points move only along the direction vector; perpendicular plane remains unchanged.
+     * Example: center=[0,0,0], direction=[1,0,0], scale=2 → stretches 2× along X axis only
      * @param inputs Defines the center, direction, and scale factor for the stretch.
      * @returns Array of transformations: [Translate To Origin, Stretch, Translate Back].
      * @group scale
@@ -86,7 +95,8 @@ export declare class Transforms {
      */
     stretchDirFromCenter(inputs: Inputs.Transforms.StretchDirCenterDto): Base.TransformMatrixes;
     /**
-     * Creates uniform scale transformation
+     * Creates uniform scale transformation from origin (same scale on all axes).
+     * Example: scale=2 → doubles size in all directions (X, Y, Z)
      * @param inputs Scale Dto
      * @returns transformation
      * @group scale
@@ -95,7 +105,8 @@ export declare class Transforms {
      */
     uniformScale(inputs: Inputs.Transforms.UniformScaleDto): Base.TransformMatrixes;
     /**
-     * Creates uniform scale transformation from the center
+     * Creates uniform scale transformation around a center point (same scale on all axes).
+     * Example: center=[5,5,5], scale=0.5 → halves size in all directions around point [5,5,5]
      * @param inputs Scale Dto with center point information
      * @returns array of transformations
      * @group scale
@@ -104,7 +115,8 @@ export declare class Transforms {
      */
     uniformScaleFromCenter(inputs: Inputs.Transforms.UniformScaleFromCenterDto): Base.TransformMatrixes;
     /**
-     * Creates the translation transformation
+     * Creates translation transformation (moves objects in space).
+     * Example: translation=[10,5,0] → moves object 10 units in X, 5 in Y, 0 in Z
      * @param inputs Translation information
      * @returns transformation
      * @group translation
@@ -113,7 +125,8 @@ export declare class Transforms {
      */
     translationXYZ(inputs: Inputs.Transforms.TranslationXYZDto): Base.TransformMatrixes;
     /**
-    * Creates the translation transformation
+    * Creates multiple translation transformations (batch move operations).
+    * Example: translations=[[1,0,0], [0,2,0]] → generates two transforms: move +X, move +Y
     * @param inputs Translation information
     * @returns transformation
      * @group translations
@@ -122,7 +135,8 @@ export declare class Transforms {
     */
     translationsXYZ(inputs: Inputs.Transforms.TranslationsXYZDto): Base.TransformMatrixes[];
     /**
-     * Creates the identity transformation
+     * Creates identity transformation matrix (no transformation - leaves objects unchanged).
+     * Returns 4×4 matrix: [1,0,0,0, 0,1,0,0, 0,0,1,0, 0,0,0,1]
      * @returns transformation
      * @group identity
      * @shortname identity

package/lib/api/services/transforms.js

@@ -9,7 +9,9 @@ export class Transforms {
         this.math = math;
     }
     /**
-     * Creates a rotation transformations around the center and an axis
+     * Creates rotation transformations around a center point and custom axis.
+     * Combines translation to origin, axis rotation, then translation back.
+     * Example: center=[5,0,0], axis=[0,1,0], angle=90° → rotates around vertical axis through point [5,0,0]
      * @param inputs Rotation around center with an axis information
      * @returns array of transformations
      * @group rotation
@@ -24,7 +26,8 @@ export class Transforms {
         ];
     }
     /**
-     * Creates a rotation transformations around the center and an X axis
+     * Creates rotation transformations around a center point along the X axis.
+     * Example: center=[5,5,5], angle=90° → rotates 90° around X axis through point [5,5,5]
      * @param inputs Rotation around center with an X axis information
      * @returns array of transformations
      * @group rotation
@@ -39,7 +42,8 @@ export class Transforms {
         ];
     }
     /**
-     * Creates a rotation transformations around the center and an Y axis
+     * Creates rotation transformations around a center point along the Y axis.
+     * Example: center=[0,0,0], angle=45° → rotates 45° around Y axis through origin
      * @param inputs Rotation around center with an Y axis information
      * @returns array of transformations
      * @group rotation
@@ -54,7 +58,8 @@ export class Transforms {
         ];
     }
     /**
-     * Creates a rotation transformations around the center and an Z axis
+     * Creates rotation transformations around a center point along the Z axis.
+     * Example: center=[10,10,0], angle=180° → rotates 180° around Z axis through point [10,10,0]
      * @param inputs Rotation around center with an Z axis information
      * @returns array of transformations
      * @group rotation
@@ -69,7 +74,9 @@ export class Transforms {
         ];
     }
     /**
-     * Creates a rotation transformations with yaw pitch and roll
+     * Creates rotation transformations using yaw-pitch-roll (Euler angles) around a center point.
+     * Yaw → Y axis rotation, Pitch → X axis rotation, Roll → Z axis rotation.
+     * Example: center=[0,0,0], yaw=90°, pitch=0°, roll=0° → rotates 90° around Y axis
      * @param inputs Yaw pitch roll rotation information
      * @returns array of transformations
      * @group rotation
@@ -84,10 +91,11 @@ export class Transforms {
         ];
     }
     /**
-     * Scale transformation around center and xyz directions
+     * Creates non-uniform scale transformation around a center point (different scale per axis).
+     * Example: center=[5,5,5], scaleXyz=[2,1,0.5] → doubles X, keeps Y, halves Z around point [5,5,5]
      * @param inputs Scale center xyz trnansformation
      * @returns array of transformations
-     * @group rotation
+     * @group scale
      * @shortname center xyz
      * @drawable false
      */
@@ -99,7 +107,8 @@ export class Transforms {
         ];
     }
     /**
-     * Creates the scale transformation in x, y and z directions
+     * Creates non-uniform scale transformation from origin (different scale per axis).
+     * Example: scaleXyz=[2,3,1] → doubles X, triples Y, keeps Z unchanged
      * @param inputs Scale XYZ number array information
      * @returns transformation
      * @group scale
@@ -110,9 +119,9 @@ export class Transforms {
         return [this.scaling(inputs.scaleXyz[0], inputs.scaleXyz[1], inputs.scaleXyz[2])];
     }
     /**
-     * Creates a stretch transformation along a specific direction, relative to a center point.
-     * This scales points along the given direction vector while leaving points in the
-     * plane perpendicular to the direction (passing through the center) unchanged.
+     * Creates directional stretch transformation that scales along a specific direction from a center point.
+     * Points move only along the direction vector; perpendicular plane remains unchanged.
+     * Example: center=[0,0,0], direction=[1,0,0], scale=2 → stretches 2× along X axis only
      * @param inputs Defines the center, direction, and scale factor for the stretch.
      * @returns Array of transformations: [Translate To Origin, Stretch, Translate Back].
      * @group scale
@@ -127,7 +136,8 @@ export class Transforms {
         ];
     }
     /**
-     * Creates uniform scale transformation
+     * Creates uniform scale transformation from origin (same scale on all axes).
+     * Example: scale=2 → doubles size in all directions (X, Y, Z)
      * @param inputs Scale Dto
      * @returns transformation
      * @group scale
@@ -138,7 +148,8 @@ export class Transforms {
         return [this.scaling(inputs.scale, inputs.scale, inputs.scale)];
     }
     /**
-     * Creates uniform scale transformation from the center
+     * Creates uniform scale transformation around a center point (same scale on all axes).
+     * Example: center=[5,5,5], scale=0.5 → halves size in all directions around point [5,5,5]
      * @param inputs Scale Dto with center point information
      * @returns array of transformations
      * @group scale
@@ -153,7 +164,8 @@ export class Transforms {
         ];
     }
     /**
-     * Creates the translation transformation
+     * Creates translation transformation (moves objects in space).
+     * Example: translation=[10,5,0] → moves object 10 units in X, 5 in Y, 0 in Z
      * @param inputs Translation information
      * @returns transformation
      * @group translation
@@ -164,7 +176,8 @@ export class Transforms {
         return [this.translation(inputs.translation[0], inputs.translation[1], inputs.translation[2])];
     }
     /**
-    * Creates the translation transformation
+    * Creates multiple translation transformations (batch move operations).
+    * Example: translations=[[1,0,0], [0,2,0]] → generates two transforms: move +X, move +Y
     * @param inputs Translation information
     * @returns transformation
      * @group translations
@@ -175,7 +188,8 @@ export class Transforms {
         return inputs.translations.map(translation => [this.translation(translation[0], translation[1], translation[2])]);
     }
     /**
-     * Creates the identity transformation
+     * Creates identity transformation matrix (no transformation - leaves objects unchanged).
+     * Returns 4×4 matrix: [1,0,0,0, 0,1,0,0, 0,0,1,0, 0,0,0,1]
      * @returns transformation
      * @group identity
      * @shortname identity