From 9e26bd35ecfa5b7c4b5bd03bbb92b2dd35294f01 Mon Sep 17 00:00:00 2001 From: Justin Lin Date: Thu, 2 May 2019 10:44:19 +0800 Subject: [PATCH] add since: --- docs/lib-m_mirror.md | 2 ++ docs/lib-m_multiply.md | 2 ++ docs/lib-m_rotation.md | 2 ++ docs/lib-m_scaling.md | 2 ++ docs/lib-m_shearing.md | 2 ++ docs/lib-m_translation.md | 2 ++ docs/lib-rotate_p.md | 2 +- docs/lib-shear.md | 3 +++ 8 files changed, 16 insertions(+), 1 deletion(-) diff --git a/docs/lib-m_mirror.md b/docs/lib-m_mirror.md index eab48baa..6280c53f 100644 --- a/docs/lib-m_mirror.md +++ b/docs/lib-m_mirror.md @@ -2,6 +2,8 @@ Generate a 4x4 transformation matrix which can pass into `multmatrix` to mirror the child element on a plane through the origin. +**Since:** 1.1 + ## Parameters - `v` : The normal vector of a plane intersecting the origin through which to mirror the object. diff --git a/docs/lib-m_multiply.md b/docs/lib-m_multiply.md index 0b9a4eee..788d9a9a 100644 --- a/docs/lib-m_multiply.md +++ b/docs/lib-m_multiply.md @@ -2,6 +2,8 @@ Multiply two 4x4 transformation matrice. +**Since:** 1.1 + ## Parameters - `ma`, `mb` : Two 4x4 transformation matrice. diff --git a/docs/lib-m_rotation.md b/docs/lib-m_rotation.md index 9c7d0771..5fc24248 100644 --- a/docs/lib-m_rotation.md +++ b/docs/lib-m_rotation.md @@ -2,6 +2,8 @@ Generate a 4x4 transformation matrix which can pass into `multmatrix` to rotate the child element about the axis of the coordinate system or around an arbitrary axis. +**Since:** 1.1 + ## Parameters - `a` : If it's `[deg_x, deg_y, deg_z]`, the rotation is applied in the order `x`, `y`, `z`. If it's `[deg_x, deg_y]`, the rotation is applied in the order `x`, `y`. If it's`[deg_x]`, the rotation is only applied to the `x` axis. If it's an number, the rotation is only applied to the `z` axis or an arbitrary axis. diff --git a/docs/lib-m_scaling.md b/docs/lib-m_scaling.md index 97f0913a..ad695763 100644 --- a/docs/lib-m_scaling.md +++ b/docs/lib-m_scaling.md @@ -2,6 +2,8 @@ Generate a 4x4 transformation matrix which can pass into `multmatrix` to scale its child elements using the specified vector. +**Since:** 1.1 + ## Parameters - `v` : Elements will be scaled using the vector. diff --git a/docs/lib-m_shearing.md b/docs/lib-m_shearing.md index f471fd3d..6f3a6868 100644 --- a/docs/lib-m_shearing.md +++ b/docs/lib-m_shearing.md @@ -2,6 +2,8 @@ Generate a 4x4 transformation matrix which can pass into `multmatrix` to shear all child elements along the X-axis, Y-axis, or Z-axis in 3D. +**Since:** 1.1 + ## Parameters - `sx` : An array `[SHy, SHz]`. The new coordinates of child elements are `(x + SHy * y + SHz * z, y, z)`. diff --git a/docs/lib-m_translation.md b/docs/lib-m_translation.md index d4a78a04..0c5f300e 100644 --- a/docs/lib-m_translation.md +++ b/docs/lib-m_translation.md @@ -2,6 +2,8 @@ Generate a 4x4 transformation matrix which can pass into `multmatrix` to translates (moves) its child elements along the specified vector. +**Since:** 1.1 + ## Parameters - `v` : Elements will be translated along the vector. diff --git a/docs/lib-rotate_p.md b/docs/lib-rotate_p.md index 63b5bf80..463b02ff 100644 --- a/docs/lib-rotate_p.md +++ b/docs/lib-rotate_p.md @@ -6,7 +6,7 @@ Rotates a point `a` degrees about the axis of the coordinate system or around an - `point` : A 3D point `[x, y, z]` or a 2D point `[x, y]`. - `a` : If it's `[deg_x, deg_y, deg_z]`, the rotation is applied in the order `x`, `y`, `z`. If it's `[deg_x, deg_y]`, the rotation is applied in the order `x`, `y`. If it's`[deg_x]`, the rotation is only applied to the `x` axis. If it's an number, the rotation is only applied to the `z` axis or an arbitrary axis. -- `v`: A vector allows you to set an arbitrary axis about which the object will be rotated. When `a` is an array, the `v` argument is ignored. +- `v`: A vector allows you to set an arbitrary axis about which the object will be rotated. When `a` is an array, the `v` argument is ignored. **Since:** 1.1. ## Examples diff --git a/docs/lib-shear.md b/docs/lib-shear.md index 66c069d5..f790a4c2 100644 --- a/docs/lib-shear.md +++ b/docs/lib-shear.md @@ -2,6 +2,9 @@ Shear all child elements along the X-axis, Y-axis, or Z-axis in 3D. +**Since:** 1.1 + + ## Parameters - `sx` : An array `[SHy, SHz]`. The new coordinates of child elements are `(x + SHy * y + SHz * z, y, z)`.