Touchable

https://pub.dev/documentation/touchable/latest/
Admin
Touchable is a Flutter library that adds gesture callbacks and touch detection to shapes drawn on...
Tokens:25,515
Snippets:124
Trust Score:9.9
Update:5 months ago
Show doc for...
Tokens:
Raw
### MyPainter Example

Source: https://pub.dev/documentation/touchable/latest

A complete CustomPainter example demonstrating the use of TouchyCanvas to draw shapes with gesture callbacks.

```dart
class MyPainter extends CustomPainter {

  final BuildContext context ;
  MyPainter(this.context); // context from CanvasTouchDetector

  @override
  void paint(Canvas canvas, Size size) {
    var myCanvas = TouchyCanvas(context,canvas); 

    myCanvas.drawCircle(Offset(10, 10), 60, Paint()..color=Colors.orange ,
        onTapDown: (tapdetail) {
         print("orange Circle touched");
       },
        onPanDown:(tapdetail){
          print("orange circle swiped");
        }
    );

    myCanvas.drawLine(
        Offset(0, 0),
        Offset(size.width - 100, size.height - 100),
        Paint()
          ..color = Colors.black
          ..strokeWidth = 50, 
        onPanUpdate: (detail) {
            print('Black line Swiped'); //do cooler things here. Probably change app state or animate
    });
  }
}
```

--------------------------------

### Example createState Implementation

Source: https://pub.dev/documentation/touchable/latest/touchable/CanvasTouchDetector/createState.html

Subclasses should override this method to return a newly created instance of their associated State subclass. The framework can call this method multiple times.

```dart
@override
State<SomeWidget> createState() => _SomeWidgetState();

```

```dart
@override
_CanvasTouchDetectorState createState() => _CanvasTouchDetectorState();

```

--------------------------------

### Draw Circle with Gesture Callbacks

Source: https://pub.dev/documentation/touchable/latest

Example of drawing a circle using TouchyCanvas and attaching onTapDown and onPanDown callbacks for interaction.

```dart
myCanvas.drawCircle(Offset(10, 10), 60, Paint()..color=Colors.orange ,
    onTapDown: (tapdetail) {
     print("orange Circle touched");
   },
    onPanDown:(tapdetail){
      print("orange circle swiped");
    }
);
```

--------------------------------

### Draw Line with Pan Update Callback

Source: https://pub.dev/documentation/touchable/latest

Example of drawing a thick line with TouchyCanvas and attaching an onPanUpdate callback for swipe gestures.

```dart
myCanvas.drawLine(
    Offset(0, 0),
    Offset(size.width - 100, size.height - 100),
    Paint()
      ..color = Colors.black
      ..strokeWidth = 50, 
    onPanUpdate: (detail) {
        print('Black line Swiped'); //do cooler things here. Probably change app state or animate
});
```

--------------------------------

### Get Touchable Controller

Source: https://pub.dev/documentation/touchable/latest/touchable/TouchDetectionController/controller.html

Access the StreamController for gesture events. This is used internally to manage and broadcast gesture data.

```dart
StreamController<Gesture> get controller => _controller;
```

--------------------------------

### TouchDetectionController Constructor

Source: https://pub.dev/documentation/touchable/latest/touchable/TouchDetectionController/TouchDetectionController.html

Initializes a new instance of the TouchDetectionController class.

```APIDOC
## TouchDetectionController.new

### Description
Constructs a new TouchDetectionController.

### Parameters
- `_controller` (StreamController<Gesture>) - The stream controller for gestures.
- `addListener` (Function) - A function to add listeners for touch events.
- `child` (Widget) - The child widget to be wrapped.
```

--------------------------------

### Gesture Constructor

Source: https://pub.dev/documentation/touchable/latest/touchable/Gesture/Gesture.html

Initializes a new Gesture object with a gesture type and optional details.

```APIDOC
## Gesture Constructor

### Description
Initializes a new Gesture object.

### Parameters
- **gestureType** (GestureType) - The type of gesture.
- **gestureDetail** (dynamic) - Optional details about the gesture.

### Implementation
```dart
Gesture(this.gestureType, this.gestureDetail);
```
```

--------------------------------

### TouchyCanvas Constructor

Source: https://pub.dev/documentation/touchable/latest/touchable/TouchyCanvas/TouchyCanvas.html

Initializes a TouchyCanvas instance. It requires a BuildContext and a Canvas object. Optional parameters include a ScrollController and the scroll direction.

```APIDOC
## TouchyCanvas Constructor

### Description
TouchyCanvas helps you add gesture callbacks to the shapes you draw. `context` is the BuildContext that is obtained from the CanvasTouchDetector widget's builder function. The parameter `canvas` is the Canvas object that you get in your `paint` method inside CustomPainter.

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Method Signature
TouchyCanvas(
  BuildContext context,
  Canvas _canvas,
  {
  ScrollController? scrollController,
  AxisDirection scrollDirection = AxisDirection.down,
}
)

### Implementation Details
```dart
TouchyCanvas(
  BuildContext context,
  this._canvas, {
  ScrollController? scrollController,
  AxisDirection scrollDirection = AxisDirection.down,
}) {
  var touchController = TouchDetectionController.of(context);
  touchController?.addListener((event) {
    _shapeHandler.handleGestureEvent(
      event,
      scrollController: scrollController,
      direction: scrollDirection,
    );
  });
}
```
```

--------------------------------

### TouchDetectionController Constructor Implementation

Source: https://pub.dev/documentation/touchable/latest/touchable/TouchDetectionController/TouchDetectionController.html

Provides the implementation of the TouchDetectionController constructor, initializing its fields and calling the superclass constructor.

```dart
const TouchDetectionController(this._controller, this.addListener,
    {required Widget child})
    : super(child: child);
```

--------------------------------

### drawArc Method Signature

Source: https://pub.dev/documentation/touchable/latest/touchable/TouchyCanvas/drawArc.html

The drawArc method draws an arc on the canvas and registers it for touch event handling. It takes a Rect, start and sweep angles, a boolean to indicate if the center should be used, a Paint object, and optional gesture callbacks.

```APIDOC
## drawArc

### Description
Draws an arc on the canvas and handles touch events.

### Method Signature
```dart
void drawArc(
  Rect rect,
  double startAngle,
  double sweepAngle,
  bool useCenter,
  Paint paint,
  {
    HitTestBehavior? hitTestBehavior,
    GestureTapDownCallback? onTapDown,
    PaintingStyle? paintStyleForTouch,
    GestureTapUpCallback? onTapUp,
    GestureLongPressStartCallback? onLongPressStart,
    GestureLongPressEndCallback? onLongPressEnd,
    GestureLongPressMoveUpdateCallback? onLongPressMoveUpdate,
    GestureForcePressStartCallback? onForcePressStart,
    GestureForcePressEndCallback? onForcePressEnd,
    GestureForcePressPeakCallback? onForcePressPeak,
    GestureForcePressUpdateCallback? onForcePressUpdate,
    GestureDragStartCallback? onPanStart,
    GestureDragUpdateCallback? onPanUpdate,
    GestureDragDownCallback? onPanDown,
    GestureTapDownCallback? onSecondaryTapDown,
    GestureTapUpCallback? onSecondaryTapUp,
  }
)
```

### Parameters
*   **rect** (Rect) - The bounding rectangle for the arc.
*   **startAngle** (double) - The starting angle of the arc in radians.
*   **sweepAngle** (double) - The sweep angle of the arc in radians.
*   **useCenter** (bool) - Whether to draw a line from the center to the arc.
*   **paint** (Paint) - The Paint object to use for drawing the arc.
*   **hitTestBehavior** (HitTestBehavior?, optional) - The behavior for hit testing.
*   **onTapDown** (GestureTapDownCallback?, optional) - Callback for tap down gesture.
*   **paintStyleForTouch** (PaintingStyle?, optional) - The painting style for touch interactions.
*   **onTapUp** (GestureTapUpCallback?, optional) - Callback for tap up gesture.
*   **onLongPressStart** (GestureLongPressStartCallback?, optional) - Callback for long press start gesture.
*   **onLongPressEnd** (GestureLongPressEndCallback?, optional) - Callback for long press end gesture.
*   **onLongPressMoveUpdate** (GestureLongPressMoveUpdateCallback?, optional) - Callback for long press move update gesture.
*   **onForcePressStart** (GestureForcePressStartCallback?, optional) - Callback for force press start gesture.
*   **onForcePressEnd** (GestureForcePressEndCallback?, optional) - Callback for force press end gesture.
*   **onForcePressPeak** (GestureForcePressPeakCallback?, optional) - Callback for force press peak gesture.
*   **onForcePressUpdate** (GestureForcePressUpdateCallback?, optional) - Callback for force press update gesture.
*   **onPanStart** (GestureDragStartCallback?, optional) - Callback for pan start gesture.
*   **onPanUpdate** (GestureDragUpdateCallback?, optional) - Callback for pan update gesture.
*   **onPanDown** (GestureDragDownCallback?, optional) - Callback for pan down gesture.
*   **onSecondaryTapDown** (GestureTapDownCallback?, optional) - Callback for secondary tap down gesture.
*   **onSecondaryTapUp** (GestureTapUpCallback?, optional) - Callback for secondary tap up gesture.
```

--------------------------------

### TouchDetectionController Constructor

Source: https://pub.dev/documentation/touchable/latest/touchable/TouchDetectionController-class.html

Initializes a new instance of the TouchDetectionController. It requires a StreamController for gestures, a listener function, and a child widget.

```APIDOC
## TouchDetectionController(StreamController<Gesture> _controller, Function addListener, {required Widget child})

### Description
Initializes a new instance of the TouchDetectionController.

### Parameters
- **_controller** (StreamController<Gesture>) - The stream controller to manage gesture events.
- **addListener** (Function) - A function to add a listener for gestures.
- **child** (Widget) - The widget below this widget in the tree.
```

--------------------------------

### Gesture Constructor

Source: https://pub.dev/documentation/touchable/latest/touchable/Gesture-class.html

Constructs a new Gesture object with a specified gesture type and detail.

```APIDOC
## Gesture(GestureType gestureType, dynamic gestureDetail)

### Description
Creates an instance of the Gesture class.

### Parameters
- **gestureType** (GestureType) - Required - The type of the gesture.
- **gestureDetail** (dynamic) - Required - The details associated with the gesture.
```

--------------------------------

### Gesture Methods

Source: https://pub.dev/documentation/touchable/latest/touchable/Gesture-class.html

Methods available for the Gesture class.

```APIDOC
## Gesture Methods

### toString()
- **Returns**: String
- **Description**: A string representation of this object.

### noSuchMethod(Invocation invocation)
- **Returns**: dynamic
- **Description**: Invoked when a nonexistent method or property is accessed.
```

--------------------------------

### TouchyCanvas Constructor Implementation

Source: https://pub.dev/documentation/touchable/latest/touchable/TouchyCanvas/TouchyCanvas.html

Initializes TouchyCanvas by attaching a listener to the TouchDetectionController to handle gesture events. Use this when creating a TouchyCanvas instance within a CustomPainter.

```dart
TouchyCanvas(
  BuildContext context,
  this._canvas, {
  ScrollController? scrollController,
  AxisDirection scrollDirection = AxisDirection.down,
}) {
  var touchController = TouchDetectionController.of(context);
  touchController?.addListener((event) {
    _shapeHandler.handleGestureEvent(
      event,
      scrollController: scrollController,
      direction: scrollDirection,
    );
  });
}
```

--------------------------------

### TouchDetectionController.of

Source: https://pub.dev/documentation/touchable/latest/touchable/TouchDetectionController-class.html

A static method to find the nearest TouchDetectionController instance that is an ancestor of the given context.

```APIDOC
## of(BuildContext context) → TouchDetectionController?

### Description
Finds the nearest TouchDetectionController instance that is an ancestor of the given context.

### Parameters
- **context** (BuildContext) - The build context to search from.

### Returns
- (TouchDetectionController?) - The found TouchDetectionController instance, or null if none is found.
```

--------------------------------

### ClipShapeItem Constructor

Source: https://pub.dev/documentation/touchable/latest/touchable/ClipShapeItem/ClipShapeItem.html

Initializes a new instance of the ClipShapeItem class with a specified clip shape and position.

```APIDOC
## ClipShapeItem(ClipShape clipShape, int position)

### Description
Constructs a ClipShapeItem with a given clip shape and its position.

### Parameters
#### Path Parameters
- **clipShape** (ClipShape) - Required - The clip shape to be used.
- **position** (int) - Required - The position of the item.

### Implementation
```dart
ClipShapeItem(this.clipShape, this.position);
```
```

--------------------------------

### ClipShapeItem Constructor

Source: https://pub.dev/documentation/touchable/latest/touchable/ClipShapeItem-class.html

Initializes a new instance of the ClipShapeItem class with a specified clip shape and position.

```APIDOC
## ClipShapeItem(ClipShape clipShape, int position)

### Description
Constructs a ClipShapeItem with the given clip shape and position.

### Parameters
#### Path Parameters
- **clipShape** (ClipShape) - Required - The clip shape for the item.
- **position** (int) - Required - The position of the item.
```

--------------------------------

### drawPath Method Implementation

Source: https://pub.dev/documentation/touchable/latest/touchable/TouchyCanvas/drawPath.html

This method draws a path on the canvas and registers it with a shape handler to enable touch interactions. It accepts a Path, Paint, and various gesture callbacks.

```dart
void drawPath(
  Path path,
  Paint paint, {
  HitTestBehavior? hitTestBehavior,
  GestureTapDownCallback? onTapDown,
  PaintingStyle? paintStyleForTouch,
  GestureTapUpCallback? onTapUp,
  GestureLongPressStartCallback? onLongPressStart,
  GestureLongPressEndCallback? onLongPressEnd,
  GestureLongPressMoveUpdateCallback? onLongPressMoveUpdate,
  GestureForcePressStartCallback? onForcePressStart,
  GestureForcePressEndCallback? onForcePressEnd,
  GestureForcePressPeakCallback? onForcePressPeak,
  GestureForcePressUpdateCallback? onForcePressUpdate,
  GestureDragStartCallback? onPanStart,
  GestureDragUpdateCallback? onPanUpdate,
  GestureDragDownCallback? onPanDown,
  GestureTapDownCallback? onSecondaryTapDown,
  GestureTapUpCallback? onSecondaryTapUp,
}) {
  _canvas.drawPath(path, paint);
  _shapeHandler.addShape(PathShape(path,
      paint: paint,
      hitTestBehavior: hitTestBehavior,
      gestureMap: TouchCanvasUtil.getGestureCallbackMap(
        onTapDown: onTapDown,
        onTapUp: onTapUp,
        onLongPressStart: onLongPressStart,
        onLongPressEnd: onLongPressEnd,
        onLongPressMoveUpdate: onLongPressMoveUpdate,
        onForcePressStart: onForcePressStart,
        onForcePressEnd: onForcePressEnd,
        onForcePressPeak: onForcePressPeak,
        onForcePressUpdate: onForcePressUpdate,
        onPanStart: onPanStart,
        onPanUpdate: onPanUpdate,
        onPanDown: onPanDown,
        onSecondaryTapDown: onSecondaryTapDown,
        onSecondaryTapUp: onSecondaryTapUp,
      )));
}
```

--------------------------------

### ClipShapeItem Constructor Implementation

Source: https://pub.dev/documentation/touchable/latest/touchable/ClipShapeItem/ClipShapeItem.html

This is the Dart implementation of the ClipShapeItem constructor. It takes a clipShape and a position as arguments.

```dart
ClipShapeItem(this.clipShape, this.position);
```

--------------------------------

### TouchyCanvas Constructor

Source: https://pub.dev/documentation/touchable/latest/touchable/TouchyCanvas-class.html

Initializes a new instance of the TouchyCanvas class. This constructor is used to attach gesture handling capabilities to a canvas, optionally with scroll support.

```APIDOC
## TouchyCanvas(BuildContext context, Canvas _canvas, {ScrollController? scrollController, AxisDirection scrollDirection = AxisDirection.down})

### Description
TouchyCanvas helps you add gesture callbacks to the shapes you draw.

### Parameters
#### Path Parameters
- **context** (BuildContext) - Required - The build context for the widget.
- **_canvas** (Canvas) - Required - The canvas object to attach gesture callbacks to.

#### Optional Parameters
- **scrollController** (ScrollController?) - Optional - A controller for scrollable content.
- **scrollDirection** (AxisDirection) - Optional - The direction of scrolling, defaults to AxisDirection.down.
```

--------------------------------

### Declare CustomTouchPaintBuilder

Source: https://pub.dev/documentation/touchable/latest/touchable/CanvasTouchDetector/builder.html

Declare the builder property for customizing touch paint behavior.

```dart
final CustomTouchPaintBuilder builder;
```

--------------------------------

### ClipShapeItem Methods

Source: https://pub.dev/documentation/touchable/latest/touchable/ClipShapeItem-class.html

Provides methods for interacting with ClipShapeItem objects.

```APIDOC
## ClipShapeItem Methods

### toString()
- **Returns**: String
- **Description**: Returns a string representation of the ClipShapeItem object.
```

--------------------------------

### TouchDetectionController Constructor Signature

Source: https://pub.dev/documentation/touchable/latest/touchable/TouchDetectionController/TouchDetectionController.html

Defines the signature of the TouchDetectionController constructor, specifying its parameters.

```dart
const TouchDetectionController(
  1. StreamController<Gesture> _controller, 
  2. Function addListener, {
  3. required Widget child,

}) 
```

--------------------------------

### Access TouchDetectionController Instance

Source: https://pub.dev/documentation/touchable/latest/touchable/TouchDetectionController/of.html

Use this static method to retrieve the nearest TouchDetectionController inherited widget from the given BuildContext. Ensure a TouchDetectionController is provided higher up in the widget tree.

```dart
static TouchDetectionController? of(BuildContext context) =>
    context.dependOnInheritedWidgetOfExactType<TouchDetectionController>();
```

--------------------------------

### CanvasTouchDetector Constructor

Source: https://pub.dev/documentation/touchable/latest/touchable/CanvasTouchDetector-class.html

Initializes a new instance of the CanvasTouchDetector class. You must provide a builder function for handling touch events and can optionally specify a list of gestures to override.

```APIDOC
## CanvasTouchDetector

### Description
Initializes a new instance of the CanvasTouchDetector class.

### Parameters
- **key** (Key?): Optional key for widget identification.
- **builder** (CustomTouchPaintBuilder): Required. A function that builds the CustomPaint widget and handles touch events.
- **gesturesToOverride** (List<GestureType>): Optional. A list of gesture types to listen for. Defaults to all gesture types.
```

--------------------------------

### drawShadow Method

Source: https://pub.dev/documentation/touchable/latest/touchable/TouchyCanvas/drawShadow.html

Draws a shadow for the given path with specified color, elevation, and transparency settings.

```APIDOC
## drawShadow Method

### Description
Draws a shadow for the given path with specified color, elevation, and transparency settings.

### Signature
`void drawShadow(Path path, Color color, double elevation, bool transparentOccluder)`

### Parameters
#### Path Parameters
- **path** (Path) - The path to draw the shadow for.
- **color** (Color) - The color of the shadow.
- **elevation** (double) - The elevation of the shadow, affecting its size and blur.
- **transparentOccluder** (bool) - If true, the occluder is transparent, affecting how the shadow is rendered.
```

--------------------------------

### TouchDetectionController.of

Source: https://pub.dev/documentation/touchable/latest/touchable/TouchDetectionController/of.html

Retrieves the nearest TouchDetectionController instance from the widget tree. This is a static method that requires a BuildContext to search for the controller.

```APIDOC
## TouchDetectionController.of

### Description
Retrieves the nearest inherited widget of the specified type.

### Method
static

### Signature
TouchDetectionController? of(BuildContext context)

### Parameters
#### Path Parameters
- **context** (BuildContext) - Required - The build context to search within.
```

--------------------------------

### drawImage Method Implementation

Source: https://pub.dev/documentation/touchable/latest/touchable/TouchyCanvas/drawImage.html

This is the implementation of the drawImage method. It draws the image on the canvas and registers it with the shape handler for gesture detection. Ensure all necessary gesture callbacks are provided if gesture interaction is required.

```dart
void drawImage(
  Image image,
  Offset p,
  Paint paint, {
  HitTestBehavior? hitTestBehavior,
  GestureTapDownCallback? onTapDown,
  PaintingStyle? paintStyleForTouch,
  GestureTapUpCallback? onTapUp,
  GestureLongPressStartCallback? onLongPressStart,
  GestureLongPressEndCallback? onLongPressEnd,
  GestureLongPressMoveUpdateCallback? onLongPressMoveUpdate,
  GestureForcePressStartCallback? onForcePressStart,
  GestureForcePressEndCallback? onForcePressEnd,
  GestureForcePressPeakCallback? onForcePressPeak,
  GestureForcePressUpdateCallback? onForcePressUpdate,
  GestureDragStartCallback? onPanStart,
  GestureDragUpdateCallback? onPanUpdate,
  GestureDragDownCallback? onPanDown,
  GestureTapDownCallback? onSecondaryTapDown,
  GestureTapUpCallback? onSecondaryTapUp,
}) {
  _canvas.drawImage(image, p, paint);
  _shapeHandler.addShape(Rectangle(Rect.fromLTWH(p.dx, p.dy, image.width.toDouble(), image.height.toDouble()),
      paint: paint,
      hitTestBehavior: hitTestBehavior,
      gestureMap: TouchCanvasUtil.getGestureCallbackMap(
        onTapDown: onTapDown,
        onTapUp: onTapUp,
        onLongPressStart: onLongPressStart,
        onLongPressEnd: onLongPressEnd,
        onLongPressMoveUpdate: onLongPressMoveUpdate,
        onForcePressStart: onForcePressStart,
        onForcePressEnd: onForcePressEnd,
        onForcePressPeak: onForcePressPeak,
        onForcePressUpdate: onForcePressUpdate,
        onPanStart: onPanStart,
        onPanUpdate: onPanUpdate,
        onPanDown: onPanDown,
        onSecondaryTapDown: onSecondaryTapDown,
        onSecondaryTapUp: onSecondaryTapUp,
      )));
}
```

--------------------------------

### Gesture Properties

Source: https://pub.dev/documentation/touchable/latest/touchable/Gesture-class.html

Properties of the Gesture class.

```APIDOC
## Gesture Properties

### gestureDetail
- **Type**: dynamic
- **Description**: The details associated with the gesture.

### gestureType
- **Type**: GestureType
- **Description**: The type of the gesture.
```

--------------------------------

### drawImage

Source: https://pub.dev/documentation/touchable/latest/touchable/TouchyCanvas/drawImage.html

Draws an image at the specified offset with optional gesture handling. The image is drawn using the provided Paint object. Gesture callbacks can be attached to handle various user interactions like taps, long presses, and drags.

```APIDOC
## drawImage

### Description
Draws an image onto the canvas at a given position with specified paint properties and optional gesture callbacks.

### Method Signature
```dart
void drawImage(
  Image image,
  Offset p,
  Paint paint,
  { HitTestBehavior? hitTestBehavior,
    GestureTapDownCallback? onTapDown,
    PaintingStyle? paintStyleForTouch,
    GestureTapUpCallback? onTapUp,
    GestureLongPressStartCallback? onLongPressStart,
    GestureLongPressEndCallback? onLongPressEnd,
    GestureLongPressMoveUpdateCallback? onLongPressMoveUpdate,
    GestureForcePressStartCallback? onForcePressStart,
    GestureForcePressEndCallback? onForcePressEnd,
    GestureForcePressPeakCallback? onForcePressPeak,
    GestureForcePressUpdateCallback? onForcePressUpdate,
    GestureDragStartCallback? onPanStart,
    GestureDragUpdateCallback? onPanUpdate,
    GestureDragDownCallback? onPanDown,
    GestureTapDownCallback? onSecondaryTapDown,
    GestureTapUpCallback? onSecondaryTapUp,
  }
)
```

### Parameters
*   **image** (Image) - The image to draw.
*   **p** (Offset) - The position (top-left corner) where the image will be drawn.
*   **paint** (Paint) - The paint style to use for drawing the image.
*   **hitTestBehavior** (HitTestBehavior?, optional) - Defines how hit tests are performed on the drawn image.
*   **onTapDown** (GestureTapDownCallback?, optional) - Callback for when a tap down event occurs on the image.
*   **paintStyleForTouch** (PaintingStyle?, optional) - Specifies the painting style for touch interactions.
*   **onTapUp** (GestureTapUpCallback?, optional) - Callback for when a tap up event occurs on the image.
*   **onLongPressStart** (GestureLongPressStartCallback?, optional) - Callback for when a long press starts on the image.
*   **onLongPressEnd** (GestureLongPressEndCallback?, optional) - Callback for when a long press ends on the image.
*   **onLongPressMoveUpdate** (GestureLongPressMoveUpdateCallback?, optional) - Callback for when the finger moves during a long press.
*   **onForcePressStart** (GestureForcePressStartCallback?, optional) - Callback for when a force press starts.
*   **onForcePressEnd** (GestureForcePressEndCallback?, optional) - Callback for when a force press ends.
*   **onForcePressPeak** (GestureForcePressPeakCallback?, optional) - Callback for when the force press reaches its peak.
*   **onForcePressUpdate** (GestureForcePressUpdateCallback?, optional) - Callback for when the force press value updates.
*   **onPanStart** (GestureDragStartCallback?, optional) - Callback for when a drag (pan) starts.
*   **onPanUpdate** (GestureDragUpdateCallback?, optional) - Callback for when the finger moves during a drag.
*   **onPanDown** (GestureDragDownCallback?, optional) - Callback for when a drag down event occurs.
*   **onSecondaryTapDown** (GestureTapDownCallback?, optional) - Callback for when a secondary tap down event occurs.
*   **onSecondaryTapUp** (GestureTapUpCallback?, optional) - Callback for when a secondary tap up event occurs.
```

--------------------------------

### drawLine Method Implementation

Source: https://pub.dev/documentation/touchable/latest/touchable/TouchyCanvas/drawLine.html

This implementation draws a line on the canvas and registers it with the shape handler for touch interactions. It maps various gesture callbacks to the shape's gesture map.

```dart
void drawLine(
  Offset p1,
  Offset p2,
  Paint paint, {
  HitTestBehavior? hitTestBehavior,
  GestureTapDownCallback? onTapDown,
  PaintingStyle? paintStyleForTouch,
  GestureTapUpCallback? onTapUp,
  GestureLongPressStartCallback? onLongPressStart,
  GestureLongPressEndCallback? onLongPressEnd,
  GestureLongPressMoveUpdateCallback? onLongPressMoveUpdate,
  GestureForcePressStartCallback? onForcePressStart,
  GestureForcePressEndCallback? onForcePressEnd,
  GestureForcePressPeakCallback? onForcePressPeak,
  GestureForcePressUpdateCallback? onForcePressUpdate,
  GestureDragStartCallback? onPanStart,
  GestureDragUpdateCallback? onPanUpdate,
  GestureDragDownCallback? onPanDown,
  GestureTapDownCallback? onSecondaryTapDown,
  GestureTapUpCallback? onSecondaryTapUp,
}) {
  _canvas.drawLine(p1, p2, paint);
  _shapeHandler.addShape(Line(p1, p2,
      paint: paint,
      hitTestBehavior: hitTestBehavior,
      gestureMap: TouchCanvasUtil.getGestureCallbackMap(
        onTapDown: onTapDown,
        onTapUp: onTapUp,
        onLongPressStart: onLongPressStart,
        onLongPressEnd: onLongPressEnd,
        onLongPressMoveUpdate: onLongPressMoveUpdate,
        onForcePressStart: onForcePressStart,
        onForcePressEnd: onForcePressEnd,
        onForcePressPeak: onForcePressPeak,
        onForcePressUpdate: onForcePressUpdate,
        onPanStart: onPanStart,
        onPanUpdate: onPanUpdate,
        onPanDown: onPanDown,
        onSecondaryTapDown: onSecondaryTapDown,
        onSecondaryTapUp: onSecondaryTapUp,
      )));
}
```

--------------------------------

### drawPath Method Signature

Source: https://pub.dev/documentation/touchable/latest/touchable/TouchyCanvas/drawPath.html

Defines the signature for the drawPath method, including path, paint, and optional gesture callbacks.

```APIDOC
void drawPath(
  Path path,
  Paint paint,
  {
    HitTestBehavior? hitTestBehavior,
    GestureTapDownCallback? onTapDown,
    PaintingStyle? paintStyleForTouch,
    GestureTapUpCallback? onTapUp,
    GestureLongPressStartCallback? onLongPressStart,
    GestureLongPressEndCallback? onLongPressEnd,
    GestureLongPressMoveUpdateCallback? onLongPressMoveUpdate,
    GestureForcePressStartCallback? onForcePressStart,
    GestureForcePressEndCallback? onForcePressEnd,
    GestureForcePressPeakCallback? onForcePressPeak,
    GestureForcePressUpdateCallback? onForcePressUpdate,
    GestureDragStartCallback? onPanStart,
    GestureDragUpdateCallback? onPanUpdate,
    GestureDragDownCallback? onPanDown,
    GestureTapDownCallback? onSecondaryTapDown,
    GestureTapUpCallback? onSecondaryTapUp,
  }
)
```

--------------------------------

### Gesture Constructor Implementation

Source: https://pub.dev/documentation/touchable/latest/touchable/Gesture/Gesture.html

This is the Dart implementation of the Gesture constructor. It initializes a Gesture object with a gesture type and associated details.

```dart
Gesture(this.gestureType, this.gestureDetail);
```

--------------------------------

### Draw Shadow Implementation

Source: https://pub.dev/documentation/touchable/latest/touchable/TouchyCanvas/drawShadow.html

This snippet shows the implementation of the drawShadow method, which calls the canvas's drawShadow function. It is used to apply shadows to shapes on the canvas.

```dart
void drawShadow(Path path, Color color, double elevation, bool transparentOccluder) {
  _canvas.drawShadow(path, color, elevation, transparentOccluder);
  // _shapeHandler.addShape(PathShape(path));
}
```

--------------------------------

### Draw Points Implementation

Source: https://pub.dev/documentation/touchable/latest/touchable/TouchyCanvas/drawPoints.html

This method draws points on the canvas and registers them with a shape handler for touch interactions. It maps various gesture callbacks to a unified gesture map.

```dart
void drawPoints(
  PointMode pointMode,
  List<Offset> points,
  Paint paint, {
  HitTestBehavior? hitTestBehavior,
  GestureTapDownCallback? onTapDown,
  PaintingStyle? paintStyleForTouch,
  GestureTapUpCallback? onTapUp,
  GestureLongPressStartCallback? onLongPressStart,
  GestureLongPressEndCallback? onLongPressEnd,
  GestureLongPressMoveUpdateCallback? onLongPressMoveUpdate,
  GestureForcePressStartCallback? onForcePressStart,
  GestureForcePressEndCallback? onForcePressEnd,
  GestureForcePressPeakCallback? onForcePressPeak,
  GestureForcePressUpdateCallback? onForcePressUpdate,
  GestureDragStartCallback? onPanStart,
  GestureDragUpdateCallback? onPanUpdate,
  GestureDragDownCallback? onPanDown,
  GestureTapDownCallback? onSecondaryTapDown,
  GestureTapUpCallback? onSecondaryTapUp,
}) {
  _canvas.drawPoints(pointMode, points, paint);
  _shapeHandler.addShape(Point(pointMode, points,
      paint: paint,
      hitTestBehavior: hitTestBehavior,
      gestureMap: TouchCanvasUtil.getGestureCallbackMap(
        onTapDown: onTapDown,
        onTapUp: onTapUp,
        onLongPressStart: onLongPressStart,
        onLongPressEnd: onLongPressEnd,
        onLongPressMoveUpdate: onLongPressMoveUpdate,
        onForcePressStart: onForcePressStart,
        onForcePressEnd: onForcePressEnd,
        onForcePressPeak: onForcePressPeak,
        onForcePressUpdate: onForcePressUpdate,
        onPanStart: onPanStart,
        onPanUpdate: onPanUpdate,
        onPanDown: onPanDown,
        onSecondaryTapDown: onSecondaryTapDown,
        onSecondaryTapUp: onSecondaryTapUp,
      )));
}
```

--------------------------------

### drawCircle Method

Source: https://pub.dev/documentation/touchable/latest/touchable/TouchyCanvas/drawCircle.html

Draws a circle on the canvas and registers gesture callbacks for interaction.

```APIDOC
## drawCircle Method

### Description
Draws a circle on the canvas at the specified center with the given radius and paint style. It also supports various gesture callbacks for user interaction.

### Parameters
- **c** (Offset) - The center point of the circle.
- **radius** (double) - The radius of the circle.
- **paint** (Paint) - The paint style for the circle.
- **hitTestBehavior** (HitTestBehavior?, optional) - Defines how hit tests are performed on the circle.
- **onTapDown** (GestureTapDownCallback?, optional) - Callback for when a tap down event occurs.
- **onTapUp** (GestureTapUpCallback?, optional) - Callback for when a tap up event occurs.
- **onLongPressStart** (GestureLongPressStartCallback?, optional) - Callback for when a long press starts.
- **onLongPressEnd** (GestureLongPressEndCallback?, optional) - Callback for when a long press ends.
- **onLongPressMoveUpdate** (GestureLongPressMoveUpdateCallback?, optional) - Callback for when the finger moves during a long press.
- **onForcePressStart** (GestureForcePressStartCallback?, optional) - Callback for when a force press starts.
- **onForcePressEnd** (GestureForcePressEndCallback?, optional) - Callback for when a force press ends.
- **onForcePressPeak** (GestureForcePressPeakCallback?, optional) - Callback for when the force press reaches its peak.
- **onForcePressUpdate** (GestureForcePressUpdateCallback?, optional) - Callback for when the force press value updates.
- **onPanStart** (GestureDragStartCallback?, optional) - Callback for when a pan (drag) gesture starts.
- **onPanUpdate** (GestureDragUpdateCallback?, optional) - Callback for when a pan (drag) gesture updates.
- **onPanDown** (GestureDragDownCallback?, optional) - Callback for when a pan (drag) gesture is initiated.
- **onSecondaryTapDown** (GestureTapDownCallback?, optional) - Callback for when a secondary tap down event occurs.
- **onSecondaryTapUp** (GestureTapUpCallback?, optional) - Callback for when a secondary tap up event occurs.

### Implementation Details
This method internally uses the canvas's `drawCircle` method and adds the circle shape with its associated gesture callbacks to a shape handler.
```

--------------------------------

### controller property

Source: https://pub.dev/documentation/touchable/latest/touchable/TouchDetectionController/controller.html

Exposes the StreamController for gesture events. This controller allows for listening to and managing the stream of gestures detected by the controller.

```APIDOC
## controller property

### Description
Provides access to the `StreamController` which manages the stream of `Gesture` objects detected by the controller.

### Method Signature
`StreamController<Gesture> get controller`

### Implementation
```dart
StreamController<Gesture> get controller => _controller;
```
```

--------------------------------

### CanvasTouchDetector Constructor

Source: https://pub.dev/documentation/touchable/latest/touchable/CanvasTouchDetector/CanvasTouchDetector.html

Initializes a new instance of the CanvasTouchDetector class. This detector allows for custom handling of touch gestures on a canvas.

```APIDOC
## CanvasTouchDetector constructor

const CanvasTouchDetector({
  Key? key,
  required CustomTouchPaintBuilder builder,
  List<GestureType> gesturesToOverride = GestureType.values,
})

### Parameters

- **key** (Key?) - Optional - The key for the widget.
- **builder** (CustomTouchPaintBuilder) - Required - The builder for custom touch paints.
- **gesturesToOverride** (List<GestureType>) - Optional - A list of gesture types to override. Defaults to all gesture types.
```

--------------------------------

### clipPath Method Implementation

Source: https://pub.dev/documentation/touchable/latest/touchable/TouchyCanvas/clipPath.html

This is the implementation of the clipPath method. It uses the canvas's clipPath function and adds a ClipPathShape to the shape handler.

```dart
void clipPath(Path path, {bool doAntiAlias = true}) {
  _canvas.clipPath(path, doAntiAlias: doAntiAlias);
  _shapeHandler.addShape(ClipPathShape(path));
}
```

--------------------------------

### clipPath Method

Source: https://pub.dev/documentation/touchable/latest/touchable/TouchyCanvas/clipPath.html

Clips the canvas to the given path. Subsequent drawing operations will be constrained to the area within this path. You can optionally disable anti-aliasing.

```APIDOC
## clipPath Method

### Description
Clips the canvas to the given path. Subsequent drawing operations will be constrained to the area within this path. You can optionally disable anti-aliasing.

### Signature
```dart
void clipPath(Path path, {bool doAntiAlias = true})
```

### Parameters
#### Path Parameters
- **path** (Path) - Required - The path to clip the canvas to.
- **doAntiAlias** (bool) - Optional - Defaults to `true`. If `true`, anti-aliasing is enabled for the clipping path.
```

--------------------------------

### GestureType Enum Methods

Source: https://pub.dev/documentation/touchable/latest/touchable/GestureType.html

This section outlines the methods available for the GestureType enum, such as noSuchMethod and toString.

```APIDOC
## GestureType Enum Methods

### Methods

noSuchMethod(Invocation invocation) → dynamic
     Invoked when a nonexistent method or property is accessed.
inherited

toString() → String
     A string representation of this object.
inherited
```

--------------------------------

### Gesture Operators

Source: https://pub.dev/documentation/touchable/latest/touchable/Gesture-class.html

Operators available for the Gesture class.

```APIDOC
## Gesture Operators

### operator ==(Object other)
- **Returns**: bool
- **Description**: The equality operator.
```

--------------------------------

### Add Touchable Dependency

Source: https://pub.dev/documentation/touchable/latest

Add the touchable package as a dependency in your pubspec.yaml file to use its features.

```yaml
dependencies:
  touchable:
```

--------------------------------

### drawPoints

Source: https://pub.dev/documentation/touchable/latest/touchable/TouchyCanvas-class.html

Draws a series of points on the canvas with support for touch event callbacks.

```APIDOC
## drawPoints

### Description
Draws a series of points on the canvas. This method also allows for various touch event callbacks to be registered.

### Signature
drawPoints(PointMode pointMode, List<Offset> points, Paint paint, {HitTestBehavior? hitTestBehavior, GestureTapDownCallback? onTapDown, PaintingStyle? paintStyleForTouch, GestureTapUpCallback? onTapUp, GestureLongPressStartCallback? onLongPressStart, GestureLongPressEndCallback? onLongPressEnd, GestureLongPressMoveUpdateCallback? onLongPressMoveUpdate, GestureForcePressStartCallback? onForcePressStart, GestureForcePressEndCallback? onForcePressEnd, GestureForcePressPeakCallback? onForcePressPeak, GestureForcePressUpdateCallback? onForcePressUpdate, GestureDragStartCallback? onPanStart, GestureDragUpdateCallback? onPanUpdate, GestureDragDownCallback? onPanDown, GestureTapDownCallback? onSecondaryTapDown, GestureTapUpCallback? onSecondaryTapUp})

### Parameters
- **pointMode** (PointMode) - The mode for drawing points.
- **points** (List<Offset>) - A list of Offset objects representing the points to draw.
- **paint** (Paint) - The Paint object used for drawing.
- **hitTestBehavior** (HitTestBehavior?, optional) - Determines how hit tests are performed.
- **onTapDown** (GestureTapDownCallback?, optional) - Callback for tap down gesture.
- **paintStyleForTouch** (PaintingStyle?, optional) - The painting style to use for touch interactions.
- **onTapUp** (GestureTapUpCallback?, optional) - Callback for tap up gesture.
- **onLongPressStart** (GestureLongPressStartCallback?, optional) - Callback for long press start gesture.
- **onLongPressEnd** (GestureLongPressEndCallback?, optional) - Callback for long press end gesture.
- **onLongPressMoveUpdate** (GestureLongPressMoveUpdateCallback?, optional) - Callback for long press move update gesture.
- **onForcePressStart** (GestureForcePressStartCallback?, optional) - Callback for force press start gesture.
- **onForcePressEnd** (GestureForcePressEndCallback?, optional) - Callback for force press end gesture.
- **onForcePressPeak** (GestureForcePressPeakCallback?, optional) - Callback for force press peak gesture.
- **onForcePressUpdate** (GestureForcePressUpdateCallback?, optional) - Callback for force press update gesture.
- **onPanStart** (GestureDragStartCallback?, optional) - Callback for pan start gesture.
- **onPanUpdate** (GestureDragUpdateCallback?, optional) - Callback for pan update gesture.
- **onPanDown** (GestureDragDownCallback?, optional) - Callback for pan down gesture.
- **onSecondaryTapDown** (GestureTapDownCallback?, optional) - Callback for secondary tap down gesture.
- **onSecondaryTapUp** (GestureTapUpCallback?, optional) - Callback for secondary tap up gesture.

### Returns
void
```

--------------------------------

### Draw Paragraph Implementation

Source: https://pub.dev/documentation/touchable/latest/touchable/TouchyCanvas/drawParagraph.html

This snippet shows the implementation of the drawParagraph method, which calls the canvas's drawParagraph function. It also includes a commented-out line for potentially adding shape handling.

```dart
void drawParagraph(Paragraph paragraph, Offset offset) {
  _canvas.drawParagraph(paragraph, offset);
  // _shapeHandler.addShape(Rectangle(Rect.fromLTWH(offset.dx, offset.dy, paragraph.width, paragraph.height),
  //     paint: Paint(), gestureMap: {}));
}
```

--------------------------------

### clipPath

Source: https://pub.dev/documentation/touchable/latest/touchable/TouchyCanvas-class.html

Clips the canvas to the given path. Subsequent drawing operations will be clipped to this path.

```APIDOC
## clipPath

### Description
Clips the canvas to the given path. Subsequent drawing operations will be clipped to this path.

### Method Signature
clipPath(Path path, {bool doAntiAlias = true}) → void

### Parameters
- **path** (Path) - The path to clip to.
- **doAntiAlias** (bool, optional) - Whether to enable anti-aliasing for the clipping path. Defaults to true.
```

--------------------------------

### Wrap CustomPaint with CanvasTouchDetector

Source: https://pub.dev/documentation/touchable/latest/touchable/touchable-library.html

Wrap your CustomPaint widget with CanvasTouchDetector to enable gesture detection. The builder function provides the context needed for the painter.

```dart
CanvasTouchDetector(
   builder: (context) =>
       CustomPaint(
           painter: MyPainter(context)
       )
)
```

--------------------------------

### drawOval Method

Source: https://pub.dev/documentation/touchable/latest/touchable/TouchyCanvas/drawOval.html

Draws an oval on the canvas and associates gesture callbacks with it. The oval's appearance is defined by the Paint object, and its position and size are determined by the Rect. Various gesture callbacks can be provided to handle user interactions like taps, long presses, and drags.

```APIDOC
## drawOval Method

### Description
Draws an oval on the canvas and registers gesture callbacks for interaction.

### Signature
```dart
void drawOval(
  Rect rect,
  Paint paint,
  {
    HitTestBehavior? hitTestBehavior,
    GestureTapDownCallback? onTapDown,
    PaintingStyle? paintStyleForTouch,
    GestureTapUpCallback? onTapUp,
    GestureLongPressStartCallback? onLongPressStart,
    GestureLongPressEndCallback? onLongPressEnd,
    GestureLongPressMoveUpdateCallback? onLongPressMoveUpdate,
    GestureForcePressStartCallback? onForcePressStart,
    GestureForcePressEndCallback? onForcePressEnd,
    GestureForcePressPeakCallback? onForcePressPeak,
    GestureForcePressUpdateCallback? onForcePressUpdate,
    GestureDragStartCallback? onPanStart,
    GestureDragUpdateCallback? onPanUpdate,
    GestureDragDownCallback? onPanDown,
    GestureTapDownCallback? onSecondaryTapDown,
    GestureTapUpCallback? onSecondaryTapUp,
  }
)
```

### Parameters
#### Path Parameters
* **rect** (Rect) - Required - Defines the bounding box of the oval.
* **paint** (Paint) - Required - Defines the visual style of the oval (color, stroke, etc.).

#### Optional Parameters
* **hitTestBehavior** (HitTestBehavior?) - Optional - Determines how the shape should be hit-tested.
* **onTapDown** (GestureTapDownCallback?) - Optional - Callback for when a tap down event occurs on the oval.
* **paintStyleForTouch** (PaintingStyle?) - Optional - Specifies the painting style for touch interactions.
* **onTapUp** (GestureTapUpCallback?) - Optional - Callback for when a tap up event occurs on the oval.
* **onLongPressStart** (GestureLongPressStartCallback?) - Optional - Callback for when a long press starts on the oval.
* **onLongPressEnd** (GestureLongPressEndCallback?) - Optional - Callback for when a long press ends on the oval.
* **onLongPressMoveUpdate** (GestureLongPressMoveUpdateCallback?) - Optional - Callback for when the finger moves during a long press.
* **onForcePressStart** (GestureForcePressStartCallback?) - Optional - Callback for when a force press starts.
* **onForcePressEnd** (GestureForcePressEndCallback?) - Optional - Callback for when a force press ends.
* **onForcePressPeak** (GestureForcePressPeakCallback?) - Optional - Callback for when the force press reaches its peak.
* **onForcePressUpdate** (GestureForcePressUpdateCallback?) - Optional - Callback for updates during a force press.
* **onPanStart** (GestureDragStartCallback?) - Optional - Callback for when a drag (pan) starts.
* **onPanUpdate** (GestureDragUpdateCallback?) - Optional - Callback for updates during a drag (pan).
* **onPanDown** (GestureDragDownCallback?) - Optional - Callback for when a drag (pan) begins.
* **onSecondaryTapDown** (GestureTapDownCallback?) - Optional - Callback for when a secondary tap down event occurs.
* **onSecondaryTapUp** (GestureTapUpCallback?) - Optional - Callback for when a secondary tap up event occurs.
```
Tokens:
Raw