Merge pull request #43 from anpawo/rework/position_&_rotation

Rework/position & rotation

Author: anpawo

.clang-format

@@ -37,7 +37,7 @@ BraceWrapping:
     AfterEnum: false
     AfterFunction: true
     AfterObjCDeclaration: false
-    AfterStruct: false
+    AfterStruct: true
     AfterUnion: false
     AfterExternBlock: false
     BeforeCatch: false

Makefile

@@ -99,6 +99,7 @@ SRC_TSF			=	$(SRC_TSF_POS)		\
 
 
 SRC_TSF_POS		=	src/transformation/position/translate.cpp		\
+					src/transformation/position/move.cpp			\
 
 
 SRC_TSF_COLOR	=	src/transformation/color/fade.cpp				\

README.md

@@ -9,10 +9,8 @@ from frontend.VideoCode import *
 
 v1 = video("video/v.mp4")
 
-v1[:20].apply(fadeIn())
-v1[-20:].apply(fadeOut())
-
-v1.add()
+v1[0:20].apply(fadeIn()).add()
+v1[20:40].apply(fadeOut()).add()
 ```
 
 <img src="docs/readme/example.gif" style="width: 50%;">

docs/readme/02_code.md

@@ -5,8 +5,6 @@ from frontend.VideoCode import *
 
 v1 = video("video/v.mp4")
 
-v1[:20].apply(fadeIn())
-v1[-20:].apply(fadeOut())
-
-v1.add()
+v1[0:20].apply(fadeIn()).add()
+v1[20:40].apply(fadeOut()).add()
 ```

docs/readme/example.gif

@@ -88,7 +88,7 @@ def __getitem__(self, i: int | slice[int | None, int | None, None]) -> Slice:
         ---
         ### Example
         >>> v = video("test.mp4")
-        >>> v[0:20].fade() # fade in during the first 20 frames.
+        >>> v[0:20].apply(fadeIn()) # fade in during the first 20 frames.
         >>> v.add() # adds it to the timeline
 
         """

frontend/input/Input.py

@@ -6,32 +6,35 @@
 
 
 class fade(Transformation):
-    def __init__(self, sides: list[side] = ALL, startOpacity: uint = 0, endOpacity: uint = 255) -> None:
-        """
-        `Fade` from `sides`.
+    """
+    `Fade` from `sides`.
+
+    Modify `opacity` for a `Fade in` or a `Fade out`.
 
-        Modify `opacity` for a `Fade in` or a `Fade out`.
+    Default: `Fade in`.
+    """
 
-        Default: `Fade in`.
-        """
+    def __init__(self, sides: list[side] = ALL, startOpacity: uint = 0, endOpacity: uint = 255) -> None:
         self.sides = sides
         self.startOpacity = startOpacity
         self.endOpacity = endOpacity
 
 
 class fadeIn:
+    """
+    `Fade in` from `sides`.
+    """
+
     def __new__(cls, sides: list[side] = ALL) -> fade:
-        """
-        `Fade in` from `sides`.
-        """
         return fade(sides, startOpacity=0, endOpacity=255)
 
 
 class fadeOut:
+    """
+    `Fade out` from `sides`.
+    """
+
     def __new__(cls, sides: list[side] = ALL) -> fade:
-        """
-        `Fade out` from `sides`.
-        """
         return fade(sides, startOpacity=255, endOpacity=0)
 
 

frontend/transformation/color/Fade.py

@@ -4,7 +4,8 @@
 
 
 class grayscale(Transformation):
-    def __init__(self) -> None:
-        """
-        `Grayscale` `Transformation`.
-        """
+    """
+    `Grayscale` `Transformation`.
+    """
+
+    def __init__(self) -> None: ...

frontend/transformation/color/Grayscale.py

@@ -4,9 +4,12 @@
 
 
 class move(Transformation):
+    """
+    `Moves` an `Input` by `x` `y`, you will arrive at `x` `y` at the last frame.
+
+    The position of the `Input` changes over time.
+    """
+
     def __init__(self, x: int, y: int) -> None:
-        """
-        `Moves` an `Input` by `x` `y`, you will arrive at `x` `y` at the last frame.
-        """
         self.x = x
         self.y = y

frontend/transformation/position/Move.py

@@ -4,9 +4,14 @@
 
 
 class translate(Transformation):
+    """
+    `Translates` an `Input` by `x` `y`.
+
+    This takes action on all frames instantly, there is no delay.
+
+    For a movement over time, see `Move`.
+    """
+
     def __init__(self, x: int, y: int) -> None:
-        """
-        `Translates` an `Input` by `x` `y`.
-        """
         self.x = x
         self.y = y