aboutsummaryrefslogtreecommitdiff
path: root/src/transformable.rs
diff options
context:
space:
mode:
authorArne Dußin2020-12-21 01:22:15 +0100
committerArne Dußin2020-12-21 21:15:55 +0100
commitd7e9c3cc46d616c2fcd1a6e9f73adbb79c6570b4 (patch)
treee5633f4d3b18472922c943d759e9f58722ba4405 /src/transformable.rs
parent48f321a80970ebeb8374072b1d2e0a4d297aa348 (diff)
downloadgraf_karto-d7e9c3cc46d616c2fcd1a6e9f73adbb79c6570b4.tar.gz
graf_karto-d7e9c3cc46d616c2fcd1a6e9f73adbb79c6570b4.zip
Add previously missing docs where appropriate
Diffstat (limited to 'src/transformable.rs')
-rw-r--r--src/transformable.rs9
1 files changed, 9 insertions, 0 deletions
diff --git a/src/transformable.rs b/src/transformable.rs
index c181bd6..b8212f9 100644
--- a/src/transformable.rs
+++ b/src/transformable.rs
@@ -1,3 +1,12 @@
+//! Traits for items that can be modified using a variety of matrix transformations.
+//!
+//! Items in the world may be resizable or rotateable etc. in a variety of different ways. This
+//! module contains the traits that are used to interact with such objects in a way, that ensures the
+//! item is not transformed illegaly. For example, an item may be scaleable by a factor, but that does
+//! not necessarily mean that it can be scaled by different factors in x and y direction (stretched).
+//! If need be, this module contains the different types of transformations and transformation
+//! restrictions to make these features available and restricting them reliably.
+
use nalgebra::Matrix3;
/// Trait for things that can be stretched and rotated etc. as one pleases without