From 14a8d550d373ba6043bee1bb7aca4b056d9259ac Mon Sep 17 00:00:00 2001 From: HactarCE <6060305+HactarCE@users.noreply.github.com> Date: Thu, 1 Aug 2024 23:39:44 -0400 Subject: [PATCH] Document custom symmetries and transformable regions --- docs/hsc/lua/geometry/symmetry.md | 6 ++++++ docs/hsc/lua/geometry/transform.md | 2 ++ 2 files changed, 8 insertions(+) diff --git a/docs/hsc/lua/geometry/symmetry.md b/docs/hsc/lua/geometry/symmetry.md index fa67217..0e933e6 100644 --- a/docs/hsc/lua/geometry/symmetry.md +++ b/docs/hsc/lua/geometry/symmetry.md @@ -44,6 +44,12 @@ This diagram describes the Coxeter groups graphically, with labels representing ![Finite Coxeter groups](https://assets.hypercubing.xyz/img/dev/cd-indices.png) +### `symmetry()` + +`symmetry()` constructs a group from generators. It takes a single argument: a sequential table of generator [transforms](transform.md). [Twists](../puzzle-construction/twists.md) are automatically converted to transforms. + +The fields `.mirror_vectors`, `.chiral`, and `.is_chiral` and the method `:vec()` are not supported on symmetries constructed using `symmetry()`. + ## Fields Symmetries have the following fields: diff --git a/docs/hsc/lua/geometry/transform.md b/docs/hsc/lua/geometry/transform.md index 296ee8c..c5f6ac1 100644 --- a/docs/hsc/lua/geometry/transform.md +++ b/docs/hsc/lua/geometry/transform.md @@ -12,6 +12,7 @@ A **transform** is a combination of some sequence of translations, rotations, an [point]: blade.md#points [vector]: blade.md#vectors [hyperplane]: hyperplane.md +[region]: region.md ## Why not matrices? @@ -113,6 +114,7 @@ Below is a list of all types that can be transformed: - [Blades][blade], including [vectors][vector] and [points][point] - [Hyperplanes][hyperplane] +- [Regions][region] - Other transforms - [Axes](../puzzle-construction/axes.md) - [Colors](../puzzle-construction/colors.md)