flutter_quad_annotator 0.1.0

A Flutter package for quadrilateral annotation with draggable vertices and edges, featuring magnifier, grid assistance, and highly customizable styling options.

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

0.1.0 - 2024-12-19

🔄 Major Refactoring

• BREAKING CHANGE: Refactored breathing animation and magnifier parameters into dedicated configuration objects
• Replaced scattered parameters with BreathingAnimation and MagnifierConfiguration classes
• Improved code organization and maintainability

✨ New Features

• BreathingAnimation Configuration:

  • Added BreathingAnimation class for centralized breathing effect configuration
  • Configurable breathing color, duration, opacity range, spacing, and stroke width
  • Enhanced visual feedback with customizable breathing light effects

• MagnifierConfiguration Enhancement:

  • Added MagnifierConfiguration class for comprehensive magnifier settings
  • Support for multiple magnifier shapes (circle, square)
  • Configurable position modes (edge, corner, follow)
  • Customizable crosshair appearance and border styling
  • Enhanced magnifier positioning with corner and edge offset options

🛠️ API Improvements

• Simplified API with grouped configuration parameters
• Better type safety with dedicated configuration classes
• Improved extensibility for future feature additions
• Enhanced code reusability across different use cases
• Dynamic Size Detection: Width and height parameters are now optional, supporting automatic size detection
• Enhanced Magnifier Positioning: edgeOffset parameter type changed from double to Offset for 2D positioning (edgeOffset 参数类型从 double 变为 Offset 以支持二维定位)

📚 Documentation

• Updated README.md with new API structure
• Added comprehensive configuration examples
• Removed outdated grid assistance feature documentation
• Enhanced API documentation with parameter tables

🔧 Developer Experience

• Better IntelliSense support with structured configuration objects
• Cleaner code organization in example applications
• Improved maintainability with logical parameter grouping

⚠️ Migration Guide

To migrate from 0.0.1 to 0.1.0:

// Old API (0.0.1)
QuadAnnotatorBox(
  enableBreathing: true,
  breathingColor: Colors.white,
  enableMagnifier: true,
  magnifierRadius: 60.0,
)

// New API (0.1.0)
QuadAnnotatorBox(
  breathing: const BreathingAnimation(
    enabled: true,
    color: Colors.white,
  ),
  magnifier: const MagnifierConfiguration(
    enabled: true,
    radius: 60.0,
  ),
)

0.0.1 - 2024-12-19

Added

• 🎉 Initial release of Flutter Quad Annotator package

• ✨ Core Features:

  • Draggable quadrilateral vertices for precise shape adjustment
  • Draggable edges for moving entire quadrilateral
  • Interactive magnifier with customizable size and scale
  • Optional grid overlay for alignment assistance
  • Single-touch gesture recognition to avoid multi-touch interference

• 🎨 Customization Options:

  • Configurable vertex colors, sizes, and styles
  • Customizable edge colors and widths
  • Adjustable background colors
  • Grid spacing and appearance settings
  • Magnifier positioning and behavior options

• 📱 Event System:

  • onVerticesChanged - Triggered when quadrilateral shape changes
  • onVertexDragStart / onVertexDragEnd - Vertex drag lifecycle events
  • onEdgeDragStart / onEdgeDragEnd - Edge drag lifecycle events

• 🔧 Developer Experience:

  • Comprehensive example application
  • Interactive control panel for testing all features
  • Real-time coordinate display
  • Well-documented API with inline comments

• 🏗️ Architecture:

  • QuadAnnotatorBox - Main annotation widget
  • QuadAnnotatorController - State management
  • RectangleFeature - Quadrilateral data model
  • QuadrilateralPainter - Custom rendering engine
  • SingleTouchPanGestureRecognizer - Gesture handling

• 🎯 Additional Features:

  • Auto-detection support with rectangle_detector integration
  • Preview mode for read-only display
  • Flexible initialization with custom or auto-detected rectangles
  • Optimized performance with efficient rendering

Technical Details

• Flutter SDK: >=1.17.0
• Dart SDK: ^3.8.1
• Dependencies: rectangle_detector ^1.0.0
• Platform Support: iOS, Android, Web, Desktop

Documentation

• Comprehensive README with usage examples
• API documentation with parameter descriptions
• Example application demonstrating all features
• MIT License for open-source usage

---

[Unreleased]

Planned Features

• ❌ Undo/Redo functionality
• ❌ Keyboard shortcuts support
• ❌ Export/Import quadrilateral data
• ❌ Multiple quadrilateral support
• ❌ Animation transitions
• ❌ Accessibility improvements
• ❌ Performance optimizations
• ❌ Additional gesture recognizers

---

Note: This changelog follows the Keep a Changelog format. For migration guides and breaking changes, please refer to the documentation.