PAINTROID-796 add clip area command

Author: Amit-Matth

lib/core/commands/command_factory/command_factory.dart

@@ -1,5 +1,6 @@
 import 'dart:ui';
 
+import 'package:paintroid/core/commands/command_implementation/graphic/clip_area_command.dart';
 import 'package:paintroid/core/commands/command_implementation/graphic/clip_path_command.dart';
 import 'package:paintroid/core/commands/command_implementation/graphic/line_command.dart';
 import 'package:paintroid/core/commands/command_implementation/graphic/path_command.dart';
@@ -57,4 +58,10 @@ class CommandFactory {
   SprayCommand createSprayCommand(List<Offset> points, Paint paint) {
     return SprayCommand(points, paint);
   }
+
+  ClipAreaCommand createClipAreaCommand(
+    PathWithActionHistory path,
+    Paint paint,
+  ) =>
+      ClipAreaCommand(path, paint);
 }

lib/core/commands/command_implementation/graphic/clip_area_command.dart

@@ -0,0 +1,69 @@
+import 'dart:ui';
+
+import 'package:json_annotation/json_annotation.dart';
+import 'package:paintroid/core/commands/command_implementation/graphic/graphic_command.dart';
+import 'package:paintroid/core/commands/path_with_action_history.dart';
+import 'package:paintroid/core/json_serialization/converter/paint_converter.dart';
+import 'package:paintroid/core/json_serialization/converter/path_with_action_history_converter.dart';
+import 'package:paintroid/core/json_serialization/versioning/serializer_version.dart';
+import 'package:paintroid/core/json_serialization/versioning/version_strategy.dart';
+
+part 'clip_area_command.g.dart';
+
+@JsonSerializable()
+class ClipAreaCommand extends GraphicCommand {
+  @JsonKey(includeToJson: true, includeFromJson: true)
+  final String type;
+  @JsonKey(includeToJson: true, includeFromJson: true)
+  final int version;
+
+  @PathWithActionHistoryConverter()
+  final PathWithActionHistory clipPathData;
+
+  ClipAreaCommand(
+    this.clipPathData,
+    Paint paint, {
+    this.type = SerializerType.CLIP_AREA_COMMAND,
+    int? version,
+  })  : version = version ??
+            VersionStrategyManager.strategy.getClipAreaCommandVersion(),
+        super(paint);
+
+  @override
+  void call(Canvas canvas) {
+    final Rect canvasBounds = canvas.getLocalClipBounds();
+
+    Path areaToClear = Path.combine(
+      PathOperation.difference,
+      Path()..addRect(canvasBounds),
+      clipPathData.path,
+    );
+
+    canvas.drawPath(
+        areaToClear,
+        Paint()
+          ..blendMode = BlendMode.clear
+          ..style = PaintingStyle.fill);
+  }
+
+  @override
+  List<Object?> get props => [paint, clipPathData, type, version];
+
+  factory ClipAreaCommand.fromJson(Map<String, dynamic> json) {
+    int version = json['version'] as int;
+
+    switch (version) {
+      case Version.v1:
+        return _$ClipAreaCommandFromJson(json);
+      case Version.v2:
+      // For different versions of ClipAreaCommand the deserialization
+      // has to be implemented manually.
+      // Autogenerated code can only be used for one version
+      default:
+        return _$ClipAreaCommandFromJson(json);
+    }
+  }
+
+  @override
+  Map<String, dynamic> toJson() => _$ClipAreaCommandToJson(this);
+}

lib/core/commands/command_implementation/graphic/clip_area_command.g.dart

@@ -22,13 +22,19 @@ class CommandManager {
     _undoStack.add(command);
   }
 
+  void removeCommand(Command commandToRemove) {
+    _undoStack.remove(commandToRemove);
+  }
+
   void setUndoStack(List<Command> commands) {
     _undoStack.clear();
     _undoStack.addAll(commands);
   }
 
   void executeLastCommand(Canvas canvas) {
-    if (_undoStack.isEmpty) return;
+    if (_undoStack.isEmpty) {
+      return;
+    }
     final lastCommand = _undoStack.last;
     if (lastCommand is GraphicCommand) {
       lastCommand.call(canvas);
@@ -44,7 +50,9 @@ class CommandManager {
   }
 
   void discardLastCommand() {
-    if (_undoStack.isNotEmpty) _undoStack.removeLast();
+    if (_undoStack.isNotEmpty) {
+      _undoStack.removeLast();
+    }
   }
 
   void clearUndoStack({Iterable<Command>? newCommands}) {
@@ -110,8 +118,7 @@ class CommandManager {
       return ToolData.SHAPES;
     } else if (command.runtimeType == CircleShapeCommand) {
       return ToolData.SHAPES;
-    }
-    else if (command.runtimeType == SprayCommand) {
+    } else if (command.runtimeType == SprayCommand) {
       return ToolData.SPRAY;
     } else {
       return ToolData.BRUSH;

lib/core/commands/command_manager/command_manager.dart

@@ -7,6 +7,7 @@ class SerializerVersion {
   static const int CIRCLE_SHAPE_COMMAND_VERSION = Version.v1;
   static const int SPRAY_COMMAND_VERSION = Version.v1;
   static const int CLIP_PATH_COMMAND_VERSION = Version.v1;
+  static const int CLIP_AREA_COMMAND_VERSION = Version.v1;
 }
 
 class Version {
@@ -25,4 +26,5 @@ class SerializerType {
   static const String CIRCLE_SHAPE_COMMAND = 'CircleShapeCommand';
   static const String SPRAY_COMMAND = 'SprayCommand';
   static const String CLIP_PATH_COMMAND = 'DashedPathCommand';
+  static const String CLIP_AREA_COMMAND = 'ClipAreaCommand';
 }

lib/core/json_serialization/versioning/serializer_version.dart

@@ -14,6 +14,8 @@ abstract class IVersionStrategy {
   int getSprayCommandVersion();
 
   int getClipPathCommandVersion();
+
+  int getClipAreaCommandVersion();
 }
 
 class ProductionVersionStrategy implements IVersionStrategy {
@@ -40,6 +42,10 @@ class ProductionVersionStrategy implements IVersionStrategy {
   @override
   int getClipPathCommandVersion() =>
       SerializerVersion.CLIP_PATH_COMMAND_VERSION;
+
+  @override
+  int getClipAreaCommandVersion() =>
+      SerializerVersion.CLIP_AREA_COMMAND_VERSION;
 }
 
 class VersionStrategyManager {

lib/core/json_serialization/versioning/version_strategy.dart

@@ -5,6 +5,7 @@ import 'package:paintroid/core/commands/command_manager/command_manager_provider
 import 'package:paintroid/core/commands/graphic_factory/graphic_factory_provider.dart';
 import 'package:paintroid/core/enums/tool_types.dart';
 import 'package:paintroid/core/tools/implementation/clipping_tool.dart';
+import 'package:paintroid/core/providers/object/tools/clipping_tool_state_provider.dart';
 
 part 'clipping_tool_provider.g.dart';
 
@@ -16,7 +17,8 @@ class ClippingToolProvider extends _$ClippingToolProvider {
       commandManager: ref.watch(commandManagerProvider),
       commandFactory: ref.watch(commandFactoryProvider),
       graphicFactory: ref.watch(graphicFactoryProvider),
-      type: ToolType.CLIPPING, // Ensure ToolType.CLIPPING is defined
+      clippingToolState: ref.watch(clippingToolState.notifier),
+      type: ToolType.CLIPPING,
     );
   }
 }

lib/core/providers/object/tools/clipping_tool_provider.dart

@@ -0,0 +1,21 @@
+import 'package:riverpod_annotation/riverpod_annotation.dart';
+
+part 'clipping_tool_state_provider.g.dart';
+
+@riverpod
+class ClippingToolState extends _$ClippingToolState {
+  @override
+  bool build() {
+    return false;
+  }
+
+  void setHasActiveClipPath(bool hasActive) {
+    state = hasActive;
+  }
+
+  void clearClipPath() {
+    state = false;
+  }
+
+  bool get hasActiveClipPath => state;
+}