File indexing completed on 2024-06-23 04:27:03

 /* This file is part of the KDE project
  * SPDX-FileCopyrightText: 2007 Jan Hambrecht <jaham@gmx.net>
  *
  * SPDX-License-Identifier: LGPL-2.0-or-later
  */
 
 #ifndef KOENHANCEDPATHHANDLE_H
 #define KOENHANCEDPATHHANDLE_H
 
 #include <QPointF>
 #include <QDomDocument>
 
 class EnhancedPathShape;
 class EnhancedPathParameter;
 class KoShapeSavingContext;
 class KoShapeLoadingContext;
 
 /**
  * An interaction handle used by the EnhancedPathShape for
  * changing the shape interactively.
  */
 class EnhancedPathHandle
 {
 public:
     /**
      * Constructs a new empty handle;
      *
      * Note that an empty handle is not valid, as long as there are no
      * positional parameters set with setPosition.
     */
     explicit EnhancedPathHandle(EnhancedPathShape *parent);
 
     /// Destroys the handle
     ~EnhancedPathHandle();
 
     /**
      * Evaluates the position of the handle.
      * @return the actual handle position
      */
     QPointF position();
 
     /**
      * Attempts to changes the position of the handle.
      * Only the coordinates of the handle which reference a modifier
      * can be changed. The new position is automatically stored into
      * the modifier of the given enhanced path.
      *
      * @param position the new position the handle to set
      * @param path the enhanced path the handle is referenced from
      */
     void changePosition(const QPointF &position);
 
     /// Returns if the handle has valid positional parameters.S
     bool hasPosition() const;
 
     /**
      * Sets the positional parameters, making the handle valid.
      *
      * It replaces the actual positional parameters.
      *
      * @param positionX the x-coordinate of the handle position
      * @param positionY the y-coordinate of the handle position
      */
     void setPosition(EnhancedPathParameter *positionX, EnhancedPathParameter *positionY);
 
     /**
      * Sets the range of the handles x-coordinate.
      *
      * A zero pointer has the effect of no maximum/minimum value.
      *
      * @param minX the minimum x-coordinate
      * @param maxX the maximum x-coordinate
      */
     void setRangeX(EnhancedPathParameter *minX, EnhancedPathParameter *maxX);
 
     /**
      * Sets the range of the handles y-coordinate.
      *
      * A zero pointer has the effect of no maximum/minimum value.
      *
      * @param minY the minimum y-coordinate
      * @param maxY the maximum y-coordinate
      */
     void setRangeY(EnhancedPathParameter *minY, EnhancedPathParameter *maxY);
 
     /**
      * Sets the center of a polar handle.
      *
      * If both parameters are valid pointers, then the handle behaves like
      * a polar handle. This means the x-coordinate of the position represents
      * an angle in degree and the y-coordinate a radius.
      *
      * @param polarX the polar center x-coordinate
      * @param polarY the polar center y-coordinate
      */
     void setPolarCenter(EnhancedPathParameter *polarX, EnhancedPathParameter *polarY);
 
     /**
      * Sets the range of the radius for polar handles.
      * @param minRadius the minimum polar radius
      * @param maxRadius the maximum polar radius
      */
     void setRadiusRange(EnhancedPathParameter *minRadius, EnhancedPathParameter *maxRadius);
 
 private:
     /// Returns if handle is polar
     bool isPolar() const;
     EnhancedPathShape *m_parent; ///< the enhanced path shape owning this handle
     EnhancedPathParameter *m_positionX; ///< the position x-coordinate
     EnhancedPathParameter *m_positionY; ///< the position y-coordinate
     EnhancedPathParameter *m_minimumX;  ///< the minimum x-coordinate
     EnhancedPathParameter *m_minimumY;  ///< the minimum y-coordinate
     EnhancedPathParameter *m_maximumX;  ///< the maximum x-coordinate
     EnhancedPathParameter *m_maximumY;  ///< the maximum y-coordinate
     EnhancedPathParameter *m_polarX;    ///< the polar center x-coordinate
     EnhancedPathParameter *m_polarY;    ///< the polar center y-coordinate
     EnhancedPathParameter *m_minRadius; ///< the minimum polar radius
     EnhancedPathParameter *m_maxRadius; ///< the maximum polar radius
 };
 
 #endif // KOENHANCEDPATHHANDLE_H