Docs, change notTransformed to transformed

Author: Mr-Pine

zoomables/src/main/kotlin/de/mr_pine/zoomables/ZoomableImage.kt

@@ -23,7 +23,7 @@ import kotlinx.coroutines.CoroutineScope
  * @param contentDescription text for accessibility see [Image] for further info
  * @param onSwipeLeft Optional function to run when user swipes from right to left - does nothing by default
  * @param onSwipeRight Optional function to run when user swipes from left to right - does nothing by default
- * @param dragGestureMode A function with a [ZoomableState] scope that returns a boolean value to enable/disable dragging gestures (swiping and panning). Returns `true` by default. *Note*: For some use cases it may be required that only panning is possible. Use `{!notTransformed}` in that case
+ * @param dragGestureMode A function with a [ZoomableState] scope that returns a [DragGestureMode] value that signals which drag gesture should currently be active. By default panning is enabled when zoomed, else swipe gestures are enabled.
  * @param onDoubleTap Optional function to run when user double taps. Zooms in by 2x when scale is currently 1 and zooms out to scale = 1 when zoomed in when null (default)
  */
 @Composable
@@ -60,7 +60,7 @@ public fun ZoomableImage(
  * @param contentDescription text for accessibility see [Image] for further info
  * @param onSwipeLeft Optional function to run when user swipes from right to left - does nothing by default
  * @param onSwipeRight Optional function to run when user swipes from left to right - does nothing by default
- * @param dragGestureMode A function with a [ZoomableState] scope that returns a boolean value to enable/disable dragging gestures (swiping and panning). Returns `true` by default. *Note*: For some use cases it may be required that only panning is possible. Use `{!notTransformed}` in that case
+ * @param dragGestureMode A function with a [ZoomableState] scope that returns a [DragGestureMode] value that signals which drag gesture should currently be active. By default panning is enabled when zoomed, else swipe gestures are enabled.
  * @param onDoubleTap Optional function to run when user double taps. Zooms in by 2x when scale is currently 1 and zooms out to scale = 1 when zoomed in when null (default)
  */
 @Composable
@@ -101,7 +101,7 @@ public fun ZoomableImage(
  * @param contentDescription text for accessibility see [Image] for further info
  * @param onSwipeLeft Optional function to run when user swipes from right to left - does nothing by default
  * @param onSwipeRight Optional function to run when user swipes from left to right - does nothing by default
- * @param dragGestureMode A function with a [ZoomableState] scope that returns a boolean value to enable/disable dragging gestures (swiping and panning). Returns `true` by default. *Note*: For some use cases it may be required that only panning is possible. Use `{!notTransformed}` in that case
+ * @param dragGestureMode A function with a [ZoomableState] scope that returns a [DragGestureMode] value that signals which drag gesture should currently be active. By default panning is enabled when zoomed, else swipe gestures are enabled.
  * @param onDoubleTap Optional function to run when user double taps. Zooms in by 2x when scale is currently 1 and zooms out to scale = 1 when zoomed in when null (default)
  */
 @Composable

zoomables/src/main/kotlin/de/mr_pine/zoomables/ZoomableState.kt

@@ -23,6 +23,8 @@ private const val zoomedThreshold = 1.0E-3f
  * An implementation of [TransformableState] containing the values for the current [scale], [offset] and [rotation]. It's normally obtained using [rememberTransformableState]
  * Other than [TransformableState] obtained by [rememberTransformableState], [ZoomableState] exposes [scale], [offset] and [rotation]
  *
+ * As
+ *
  * @param scale [MutableState]<[Float]> of the scale this state is initialized with
  * @param offset [MutableState]<[Offset]> of the offset this state is initialized with
  * @param rotation [MutableState]<[Float]> in degrees of the rotation this state is initialized with
@@ -34,7 +36,8 @@ private const val zoomedThreshold = 1.0E-3f
  * @property scale The current scale as [MutableState]<[Float]>
  * @property offset The current offset as [MutableState]<[Offset]>
  * @property rotation The current rotation in degrees as [MutableState]<[Float]>
- * @property notTransformed `true` if [scale] is `1`, [offset] is [Offset.Zero] and [rotation] is `0`
+ * @property transformed `false` if [scale] is `1`, [offset] is [Offset.Zero] and [rotation] is `0`
+ * @property zoomed Whether the content is zoomed (in or out)
  */
 public class ZoomableState(
     public var scale: MutableState<Float>,
@@ -47,10 +50,8 @@ public class ZoomableState(
     public val zoomed: Boolean
         get() = scale.value in (1 - zoomedThreshold)..(1 + zoomedThreshold)
 
-    public val notTransformed: Boolean
-        get() {
-            return zoomed && offset.value.getDistanceSquared() in -1.0E-6f..1.0E-6f && rotation.value in -1.0E-3f..1.0E-3f
-        }
+    public val transformed: Boolean
+        get() = zoomed || offset.value.getDistanceSquared() !in -1.0E-6f..1.0E-6f || rotation.value !in -1.0E-3f..1.0E-3f
 
     private val transformScope: TransformScope = object : TransformScope {
         override fun transformBy(zoomChange: Float, panChange: Offset, rotationChange: Float) =

zoomables/src/main/kotlin/de/mr_pine/zoomables/Zoomables.kt

@@ -37,7 +37,7 @@ import kotlin.math.*
  *
  * @param coroutineScope used for smooth asynchronous zoom/pan/rotation animations
  * @param zoomableState Contains the current transform states - obtained via [rememberZoomableState]
- * @param dragGestureMode A function with a [ZoomableState] scope that returns a boolean value to enable/disable dragging gestures (swiping and panning). Returns `true` by default. *Note*: For some use cases it may be required that only panning is possible. Use `{!notTransformed}` in that case
+ * @param dragGestureMode A function with a [ZoomableState] scope that returns a [DragGestureMode] value that signals which drag gesture should currently be active. By default panning is enabled when zoomed, else swipe gestures are enabled.
  * @param onSwipeLeft Optional function to run when user swipes from right to left - does nothing by default
  * @param onSwipeRight Optional function to run when user swipes from left to right - does nothing by default
  * @param minimumSwipeDistance Minimum distance the user has to travel on the screen for it to count as swiping