#ifndef IMAGE_VECTORVIS_H
#define IMAGE_VECTORVIS_H

namespace sofa
{

namespace defaulttype
{

/**
 * Holds data regarding visualization of vector data so that it can be accessed and manipulated by the VectorVisualizationDataWidget
 */
class VectorVis
{
protected:
    /**
    * One shape is drawn every subsampleXY values in both the X plane and the Y plane. So, as subsampleXY is increased, the density of the shapes decreases.
    */
    int subsampleXY;

    /**
    * One shape is drawn every subsampleZ values in Z plane. So, as subsampleZ is increased, the density of the shapes decreases.
    */
    int subsampleZ;

    /**
    * The size of the shape is multiplied by this value before it is drawn.
    */
    int shapeScale;

    /**
    * When true, a 3 channel image is displayed as an RGB image. When false, the image is displayed in greyscale, with the value being the norm of the 3 channels.
    */
    bool rgb;

    /**
    * When true, a shape is drawn representing the data. In a 3 channel image, that shape is an arrow, and in a 6 channel image, the shape is an ellipsoid.
    */
    bool shape;

    /**
    * Specifies the order that tensor information is encoded. Possible values are LowerTriRowMajor, UpperTriRowMajor, DiagonalFirst
    */
    std::string tensorOrder;


public:

    static const char* Name() { return "Vectors";}

    VectorVis(int _subsampleXY=5, int _subsampleZ=5, int _shapeScale=10, bool _rgb=true, bool _shape=false, std::string _tensorOrder="LowerTriRowMajor")
        :subsampleXY(_subsampleXY), subsampleZ(_subsampleZ), shapeScale(_shapeScale), rgb(_rgb), shape(_shape), tensorOrder(_tensorOrder)
    { }


    /**
    * @name Accessor/Getter functions
    */
    /**@{*/
    int getSubsampleXY() const { return subsampleXY; }
    int getSubsampleZ() const { return subsampleZ; }
    int getShapeScale() const {return shapeScale; }
    bool getRgb() const {return rgb; }
    bool getShape() const {return shape;}
    std::string getTensorOrder() const {return tensorOrder;}
    /**@}*/

    /**
    * @name Mutator/Setter functions
    */
    /**@{*/
    void setSubsampleXY(int _subsampleXY) { subsampleXY = _subsampleXY; }
    void setSubsampleZ(int _subsampleZ) {subsampleZ = _subsampleZ; }
    void setShapeScale(int scale) { shapeScale = scale; }
    void setRgb(bool _rgb) {rgb = _rgb;}
    void setShape(bool vis) { shape = vis; }
    void setTensorOrder(std::string _tensorOrder) { tensorOrder = _tensorOrder;}
    /**@}*/

    /**
    * Stream operator that allows data to be recieved from the GUI
    */
    inline friend std::istream& operator >> (std::istream& in, VectorVis& v)
    {
        int subsampleXY;
        int subsampleZ;
        int shapeScale;
        bool rgb;
        bool shape;
        std::string tensorOrder;
        in >> subsampleXY >> subsampleZ >> shapeScale >> rgb >> shape >> tensorOrder;

        v.setSubsampleXY(subsampleXY);
        v.setSubsampleZ(subsampleZ);
        v.setShapeScale(shapeScale);
        v.setRgb(rgb);
        v.setShape(shape);
        v.setTensorOrder(tensorOrder);

        return in;
    }

    /**
    * Stream operator that allows data to be sent to the GUI
    */
    friend std::ostream& operator << (std::ostream& out, const VectorVis& v)
    {
        out << v.getSubsampleXY() << v.getSubsampleZ() << v.getShapeScale() << v.getRgb() << v.getShape() << v.getTensorOrder() ;
        return out;
    }


};

}
}
#endif //IMAGE_VECTORVIS_H
