#ifndef UPEM_MORPHING_PITUREFRAME
#define UPEM_MORPHING_PITUREFRAME

/**
 * File: pictureframe.h
 * Pictures handling.
 *
 * Author:
 *   Adam NAILI
 */

#include "gui/component.h"
#include "morpher/morphing.h"
#include "painter/canvas.h"

/*
 * Needed storage point to share memory between the origin PictureFrame and the target PictureFrame.
 * It ables to cancel the Add constraint functionality
 */
CartesianVector savedPoint;

/**
 * Type: CartesianMappingDivision
 * Type of functions needed to split CartesianMapping and keep only the CartesianVector needed, related to the type of PictureFrame involved
 */
typedef CartesianVector (*CartesianMappingDivision)(const CartesianMapping *cartesianMapping);

/**
 * Struct: PictureFrame
 * Represents a component to print pictures.
 *
 * Fields:
 *  component - inherent component management of the PictureFrame
 *  morphing - abstract coordinate transform
 *  canvas - image that will be printed
 *  cartesianMappingDivision - pointer of function that gives the role of the current PictureFrame to retrieve the right CartesianVector related to its usage
 */
typedef struct {
  Component component;
  Morphing *morphing;
  Canvas *canvas;
  CartesianMappingDivision cartesianMappingDivision;
} PictureFrame;

/**
 * Function: pictureframe_origin_split
 * Splits the CartesianMapping to get the CartesianVector related to the origin PictureFrame.
 *
 * Parameters:
 *  *cartesianMapping - CartesianMapping that contains the origin and target CartesianVector needed to be split
 */
CartesianVector pictureframe_origin_split(const CartesianMapping *cartesianMapping);

/**
 * Function: pictureframe_target_split
 * Splits the CartesianMapping to get the CartesianVector related to the target PictureFrame.
 *
 * Parameters:
 *  *cartesianMapping - CartesianMapping that contains the origin and target CartesianVector needed to be split
 */
CartesianVector pictureframe_target_split(const CartesianMapping *cartesianMapping);

/**
 * Function: pictureframe_create
 * Allocates and initializes the PictureFrame.
 *
 * Parameters:
 *  width - width of the current picture
 *  height - height of the current picture
 *  x_pos - position of the button on x axis
 *  y_pos - position of the button on y axis
 *  cartesianMappingDivision - pointer of function needed to select the right CartesianVector inside the morphing's CartesianMapping
 *  *morphing - pointer to the morphing
 *  *canvas - pointer to the canvas
 *  clickHandler - pointer of function that will be loaded inside our pictureframe
 *
 * Returns:
 *  A pointer of PictureFrame
 */
PictureFrame *pictureframe_create(int width, int height, int x_pos, int y_pos,
                                  CartesianMappingDivision cartesianMappingDivision, Morphing *morphing, Canvas *canvas,
                                  ClickHandler clickHandler);

/**
 * Function: pictureframe_destroy
 * Frees the current PictureFrame
 *
 * Parameters:
 *  *pictureframe - pointer to the current PictureFrame
 */
void pictureframe_destroy(PictureFrame *pictureFrame);

/**
 * Function: pictureframe_draw_canvas
 * Draws the contained Canvas of the PictureFrame.
 *
 * Parameters:
 *  *pictureFrame - current PictureFrame containing the Canvas to print.
 */
void pictureframe_draw_canvas(PictureFrame *pictureFrame);


/**
 * Function: pictureframe_click_handler_origin
 * Adds a point on the coordinate of the picture that the mouse is pointing.
 *
 * Parameters:
 *  x_pos - coordinate on x axis of the mouse
 *  y_pos - coordinate on y axis of the mouse
 *  *parameterSelf - pointer that will be casted into a PictureFrame
 */
void pictureframe_click_handler_origin(int x_pos, int y_pos, Component *parameterSelf);

/**
 * Function: pictureframe_click_handler_target
 * Adds a point on the coordinate of the picture that the mouse is pointing.
 *
 * Parameters:
 *  x_pos - coordinate on x axis of the mouse
 *  y_pos - coordinate on y axis of the mouse
 *  *parameterSelf - pointer that will be casted into a PictureFrame
 */
void pictureframe_click_handler_target(int x_pos, int y_pos, Component *parameterSelf);

#endif