#ifndef __BRAIN_OPEN_G_L_ANNOTATION_DRAWING_FIXED_PIPELINE_H__
#define __BRAIN_OPEN_G_L_ANNOTATION_DRAWING_FIXED_PIPELINE_H__

/*LICENSE_START*/
/*
 *  Copyright (C) 2015 Washington University School of Medicine
 *
 *  This program is free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation; either version 2 of the License, or
 *  (at your option) any later version.
 *
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License along
 *  with this program; if not, write to the Free Software Foundation, Inc.,
 *  51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 */
/*LICENSE_END*/

#include <memory>
#include <set>
#include <stdint.h>

#include "AnnotationCoordinateSpaceEnum.h"
#include "AnnotationSizingHandleTypeEnum.h"
#include "AnnotationSurfaceOffsetVectorTypeEnum.h"
#include "BrainOpenGLFixedPipeline.h"
#include "BrainOpenGLTextRenderInterface.h"
#include "CaretObject.h"
#include "CaretOpenGLInclude.h"
#include "FileInformation.h"
#include "HistologySpaceKey.h"
#include "Plane.h"
#include "SpacerTabIndex.h"
#include "Vector3D.h"


namespace caret {

    class Annotation;
    class AnnotationBox;
    class AnnotationBrowserTab;
    class AnnotationColorBar;
    class AnnotationCoordinate;
    class AnnotationFile;
    class AnnotationImage;
    class AnnotationLine;
    class AnnotationMultiCoordinateShape;
    class AnnotationMultiPairedCoordinateShape;
    class AnnotationTwoCoordinateShape;
    class AnnotationOval;
    class AnnotationPolyhedron;
    class AnnotationPolyLine;
    class AnnotationScaleBar;
    class AnnotationText;
    class AnnotationOneCoordinateShape;
    class Brain;
    class BrainOpenGLFixedPipeline;
    class EventOpenGLObjectToWindowTransform;
    class GraphicsPrimitive;
    class Surface;
    
    class BrainOpenGLAnnotationDrawingFixedPipeline : public CaretObject {
        
    public:
        class Inputs {
        public:
            enum WindowDrawingMode {
                WINDOW_DRAWING_NO,
                WINDOW_DRAWING_YES
            };
            
            Inputs(Brain* brain,
                   const BrainOpenGLFixedPipeline::Mode drawingMode,
                   const float centerToEyeDistance,
                   const int32_t windowIndex,
                   const int32_t tabIndex,
                   const SpacerTabIndex &spacerTabIndex,
                   const WindowDrawingMode windowDrawingMode,
                   const std::set<AString>& mediaFileNames,
                   const bool annotationUserInputModeFlag,
                   const bool tileTabsManualLayoutUserInputModeFlag)
            : m_brain(brain),
            m_drawingMode(drawingMode),
            m_centerToEyeDistance(centerToEyeDistance),
            m_windowIndex(windowIndex),
            m_tabIndex(tabIndex),
            m_spacerTabIndex(spacerTabIndex),
            m_windowDrawingMode(windowDrawingMode),
            m_mediaFileNames(mediaFileNames),
            m_annotationUserInputModeFlag(annotationUserInputModeFlag),
            m_tileTabsManualLayoutUserInputModeFlag(tileTabsManualLayoutUserInputModeFlag)
            {
                for (const auto& name : m_mediaFileNames) {
                    m_mediaFileNamesNoPath.insert(FileInformation(name).getFileName());
                }
            }
            
            void setHistologySpaceKey(const HistologySpaceKey& histologySpaceKey) {
                m_histologySpaceKey = histologySpaceKey;
            }
            
            Brain* m_brain;
            const BrainOpenGLFixedPipeline::Mode m_drawingMode;
            const float m_centerToEyeDistance;
            const int32_t m_windowIndex;
            const int32_t m_tabIndex;
            const SpacerTabIndex m_spacerTabIndex;
            const WindowDrawingMode m_windowDrawingMode;
            HistologySpaceKey m_histologySpaceKey;
            const std::set<AString> m_mediaFileNames;
            std::set<AString> m_mediaFileNamesNoPath;
            const bool m_annotationUserInputModeFlag;
            const bool m_tileTabsManualLayoutUserInputModeFlag;
        };
        
        BrainOpenGLAnnotationDrawingFixedPipeline(BrainOpenGLFixedPipeline* brainOpenGLFixedPipeline);
        
        virtual ~BrainOpenGLAnnotationDrawingFixedPipeline();
        
        void drawAnnotations(Inputs* inputs,
                             const AnnotationCoordinateSpaceEnum::Enum drawingCoordinateSpace,
                             std::vector<AnnotationColorBar*>& colorBars,
                             std::vector<AnnotationScaleBar*>& scaleBars,
                             std::vector<Annotation*>& notInFileAnnotations,
                             const Surface* surfaceDisplayed,
                             const float surfaceViewScaling);

        void drawModelSpaceSamplesOnVolumeSlice(Inputs* inputs,
                                                const Plane& plane,
                                                const float sliceThickness);

        void drawModelSpaceAnnotationsOnVolumeSlice(Inputs* inputs,
                                                    const Plane& plane,
                                                    const float sliceThickness);
        
        void drawModelSpaceAnnotationsOnHistologySlice(Inputs* inputs,
                                                       const HistologySlice* histologySlice,
                                                       const float sliceThickness);
        
        void drawModelSpaceSamplesOnHistologySlice(Inputs* inputs,
                                                   const HistologySlice* histologySlice,
                                                   const float sliceThickness);

        // ADD_NEW_METHODS_HERE

        virtual AString toString() const;
        
        static void drawTabBounds(const float bottomLeft[3],
                                  const float bottomRight[3],
                                  const float topRight[3],
                                  const float topLeft[3],
                                  uint8_t foregroundRGBA[4]);

    private:
        class SelectionInfo {
        public:
            SelectionInfo(AnnotationFile* annotationFile,
                          Annotation* annotation,
                          AnnotationSizingHandleTypeEnum::Enum sizingHandle,
                          int32_t polyLineCoordinateIndex,
                          const float windowXYZ[3],
                          const std::vector<Vector3D>& coordsInWindowXYZ)
            : SelectionInfo(annotationFile,
                            annotation,
                            sizingHandle,
                            polyLineCoordinateIndex,
                            windowXYZ) {
                m_coordsInWindowXYZ = coordsInWindowXYZ;
                
                validate();
            }

            AnnotationFile* m_annotationFile;
            
            Annotation* m_annotation;
            
            AnnotationSizingHandleTypeEnum::Enum m_sizingHandle;
            
            int32_t m_polyLineCoordinateIndex;
            
            double m_windowXYZ[3];
            
            std::vector<Vector3D> m_coordsInWindowXYZ;
        
        private:
            SelectionInfo(AnnotationFile* annotationFile,
                          Annotation* annotation,
                          AnnotationSizingHandleTypeEnum::Enum sizingHandle,
                          int32_t polyLineCoordinateIndex,
                          const float windowXYZ[3]) {
                m_annotationFile = annotationFile;
                m_annotation     = annotation;
                m_sizingHandle   = sizingHandle;
                m_polyLineCoordinateIndex = polyLineCoordinateIndex;
                m_windowXYZ[0]   = windowXYZ[0];
                m_windowXYZ[1]   = windowXYZ[1];
                m_windowXYZ[2]   = windowXYZ[2];
            }
            
            bool validate();

        };
        
        class ColorBarLine {
        public:
            ColorBarLine(const std::vector<float>& lineCoords,
                         const float rgba[4]) {
                m_lineCoords = lineCoords;
                m_rgba[0] = rgba[0];
                m_rgba[1] = rgba[1];
                m_rgba[2] = rgba[2];
                m_rgba[3] = rgba[3];
            }
            
            std::vector<float> m_lineCoords;
            float m_rgba[4];
        };
        
        /**
         * Used to save viewport, model view, projection
         */
        class TransformationInfo {
        public:
            void save();
            void restore();
            
            GLint m_viewport[4];
            GLdouble m_modelViewMatrix[16];
            GLdouble m_projectionMatrix[16];
            bool m_valid = false;
        };
        
        /**
         * Type of data drawing
         */
        enum class DrawingDataType {
            /** Invalid */
            INVALID,
            /** Annotations */
            ANNOTATIONS,
            /** Samples */
            SAMPLES
        };
        
        BrainOpenGLAnnotationDrawingFixedPipeline(const BrainOpenGLAnnotationDrawingFixedPipeline&);

        BrainOpenGLAnnotationDrawingFixedPipeline& operator=(const BrainOpenGLAnnotationDrawingFixedPipeline&);
        
        void drawAnnotationsInternal(const DrawingDataType drawingDataType,
                                     const AnnotationCoordinateSpaceEnum::Enum drawingCoordinateSpace,
                                     std::vector<AnnotationColorBar*>& colorBars,
                                     std::vector<AnnotationScaleBar*>& scaleBars,
                                     std::vector<Annotation*>& viewportAnnotations,
                                     const Surface* surfaceDisplayed,
                                     const float sliceThickness);
        
        bool getAnnotationDrawingSpaceCoordinate(const Annotation* annotation,
                                                 const AnnotationCoordinate* coordinate,
                                                 const Surface* surfaceDisplayed,
                                                 float xyzOut[3]) const;
        
        bool getAnnotationTwoDimShapeBounds(const AnnotationOneCoordinateShape* annotation2D,
                                 const float windowXYZ[3],
                                 float bottomLeftOut[3],
                                 float bottomRightOut[3],
                                 float topRightOut[3],
                                 float topLeftOut[3]) const;
        
        void applyRotationToShape(const float rotationAngle,
                                  const float rotationPoint[3],
                                  float bottomLeftOut[3],
                                  float bottomRightOut[3],
                                  float topRightOut[3],
                                  float topLeftOut[3]) const;
        
        void drawAnnotation(AnnotationFile* annotationFile,
                            Annotation* annotation,
                            const Surface* surfaceDisplayed);
        
        bool drawOneCoordinateAnnotationSurfaceTangentOffset(AnnotationFile* annotationFile,
                                                      AnnotationOneCoordinateShape* annotation,
                                                      const Surface* surfaceDisplayed);
        
        bool drawTwoCoordinateAnnotationSurfaceTangentOffset(AnnotationFile* annotationFile,
                                                      AnnotationTwoCoordinateShape* annotation,
                                                      const Surface* surfaceDisplayed);
        
        bool drawMultiCoordinateAnnotationSurfaceTangentOffset(AnnotationFile* annotationFile,
                                                   AnnotationMultiCoordinateShape* annotation,
                                                   const Surface* surfaceDisplayed);
        
        void drawColorBar(AnnotationFile* annotationFile,
                          AnnotationColorBar* colorBar);
        
        bool drawBox(AnnotationFile* annotationFile,
                     AnnotationBox* box,
                       const Surface* surfaceDisplayed);
        
        bool drawBrowserTab(AnnotationFile* annotationFile,
                            AnnotationBrowserTab* browserTab);
        
        bool drawBoxSurfaceTangentOffset(AnnotationFile* annotationFile,
                                         AnnotationBox* box,
                                         const float surfaceExtentZ,
                                         const float vertexXYZ[3]);

        bool drawImage(AnnotationFile* annotationFile,
                       AnnotationImage* image,
                       const Surface* surfaceDisplayed);
        
        bool drawImageSurfaceTangentOffset(AnnotationFile* annotationFile,
                                           AnnotationImage* image,
                                           const float surfaceExtentZ,
                                           const float vertexXYZ[3]);
        
        bool drawLine(AnnotationFile* annotationFile,
                      AnnotationLine* line,
                      const Surface* surfaceDisplayed);
        
        bool drawLineSurfaceTangentOffset(AnnotationFile* annotationFile,
                                          AnnotationLine* line,
                                          const Surface* surfaceDisplayed,
                                          const float surfaceExtentZ);
        
        bool drawOval(AnnotationFile* annotationFile,
                      AnnotationOval* oval,
                      const Surface* surfaceDisplayed);
        
        bool drawMultiPairedCoordinateShape(AnnotationFile* annotationFile,
                                            AnnotationMultiPairedCoordinateShape* multiPairedCoordShape,
                                            const Surface* surfaceDisplayed);

        bool drawPolyhedronEdgesOnPlane(AnnotationFile* annotationFile,
                                        AnnotationPolyhedron* polyhedron,
                                        const Plane& plane,
                                        const uint8_t foregroundRGBA[4]);

        void drawPolyhedronName(AnnotationFile* annotationFile,
                                AnnotationPolyhedron* polyhedron,
                                const std::vector<Vector3D>& verticesWindowXYZ,
                                const Vector3D& nameXYZ,
                                const AnnotationSizingHandleTypeEnum::Enum sizeHandleType,
                                const bool selectionFlag);
        
        bool drawMultiCoordinateShape(AnnotationFile* annotationFile,
                                      AnnotationMultiCoordinateShape* multiCoordShape,
                                      const Surface* surfaceDisplayed);
        
        bool drawMultiCoordinateShapeSurfaceTangentOffset(AnnotationFile* annotationFile,
                                                          AnnotationMultiCoordinateShape* multiCoordShape,
                                                          const Surface* surfaceDisplayed,
                                                          const float surfaceExtentZ);

        bool drawOvalSurfaceTangentOffset(AnnotationFile* annotationFile,
                                          AnnotationOval* oval,
                                          const float surfaceExtentZ,
                                          const float vertexXYZ[3]);
        
        void drawScaleBar(AnnotationFile* annotationFile,
                          AnnotationScaleBar* scaleBar);
        
        bool drawText(AnnotationFile* annotationFile,
                      AnnotationText* text,
                       const Surface* surfaceDisplayed);
        
        bool drawTextSurfaceTangentOffset(AnnotationFile* annotationFile,
                                          AnnotationText* text,
                                          const float surfaceExtentZ,
                                          const float vertexXYZ[3],
                                          const float vertexNormalXYZ[3]);
        
        void drawColorBarSections(const AnnotationColorBar* colorBar,
                                  const float bottomLeft[3],
                                  const float bottomRight[3],
                                  const float topRight[3],
                                  const float topLeft[3],
                                  const float sectionsHeightInPixels);
        
        void drawColorBarText(const AnnotationColorBar* colorBar,
                               const float bottomLeft[3],
                               const float bottomRight[3],
                               const float topRight[3],
                               const float topLeft[3],
                               const float textHeightInPixels,
                               const float offsetFromTopInPixels);

        void drawColorBarTickMarks(const AnnotationColorBar* colorBar,
                                   const float bottomLeft[3],
                                   const float bottomRight[3],
                                   const float topRight[3],
                                   const float topLeft[3],
                                   const float tickMarksHeightInPixels,
                                   const float offsetFromBottomInPixels);

        void drawSizingHandle(const AnnotationSizingHandleTypeEnum::Enum handleType,
                              AnnotationFile* annotationFile,
                              Annotation* annotation,
                              const std::vector<Vector3D>& verticesWindowXYZ,
                              const float xyz[3],
                              const float halfWidthHeight,
                              const float rotationAngle,
                              const int32_t polyLineCoordinateIndex);
        
        void drawAnnotationTwoDimShapeSizingHandles(AnnotationFile* annotationFile,
                                                    Annotation* annotation,
                                                    const std::vector<Vector3D>& verticesWindowXYZ,
                                                    const float bottomLeft[3],
                                                    const float bottomRight[3],
                                                    const float topRight[3],
                                                    const float topLeft[3],
                                                    const float lineThickness,
                                                    const float rotationAngle);

        void drawAnnotationLineSizingHandles(AnnotationFile* annotationFile,
                                               Annotation* annotation,
                                             const std::vector<Vector3D>& verticesWindowXYZ,
                                               const float firstPoint[3],
                                               const float secondPoint[3],
                                               const float lineThickness);
        
        void drawAnnotationMultiCoordShapeSizingHandles(AnnotationFile* annotationFile,
                                                        AnnotationMultiCoordinateShape* multiCoordShape,
                                                        const std::vector<Vector3D>& verticesWindowXYZ,
                                                        const GraphicsPrimitive* primitive,
                                                        const float lineThickness);

        void drawAnnotationMultiPairedCoordShapeSizingHandles(const AnnotationSizingHandleTypeEnum::Enum sizingHandleType,
                                                              AnnotationFile* annotationFile,
                                                              AnnotationMultiPairedCoordinateShape* multiPairedCoordShape,
                                                              const std::vector<Vector3D>& verticesWindowXYZ,
                                                              const GraphicsPrimitive* primitive,
                                                              const float lineThickness);

        bool isDrawnWithDepthTesting(const Annotation* annotation,
                                     const Surface* surface);
        
        bool setDepthTestingStatus(const bool newDepthTestingStatus);
        
        void getIdentificationColor(uint8_t identificationColorOut[4]);
        
        bool convertModelToWindowCoordinate(const float modelXYZ[3],
                                            float windowXYZOut[3]) const;
        
        void viewportToOpenGLWindowCoordinate(const float viewportXYZ[3],
                                              float openGLXYZOut[3]) const;
        
        void createLineCoordinates(const float lineHeadXYZ[3],
                                   const float lineTailXYZ[3],
                                   const float lineThickness,
                                   const bool validStartArrow,
                                   const bool validEndArrow,
                                   std::vector<float>& lineCoordinatesOut,
                                   std::vector<float>& startArrowCoordinatesOut,
                                   std::vector<float>& endArrowCoordinatesOut) const;
        
        void getTextLineToBrainordinateLineCoordinates(const AnnotationText* text,
                                                       const Surface* surfaceDisplayed,
                                                       const float bottomLeft[3],
                                                       const float bottomRight[3],
                                                       const float topRight[3],
                                                       const float topLeft[3],
                                                       std::vector<float>& lineCoordinatesOut,
                                                       std::vector<float>& arrowCoordinatesOut) const;
                
        void setSelectionBoxColor(const Annotation* annotation);
        
        void startOpenGLForDrawing(GLint* savedShadeModelOut,
                                   GLboolean* savedLightingEnabledOut);
        
        void endOpenGLForDrawing(GLint savedShadeModel,
                                 GLboolean savedLightingEnabled);
        
        void clipLineAtTextBox(const float bottomLeft[3],
                               const float bottomRight[3],
                               const float topRight[3],
                               const float topLeft[3],
                               const float startXYZ[3],
                               float endXYZ[3]) const;
        
        void setPrimitiveLineWidthInPixels(const Annotation* annotation,
                                           const Vector3D& windowXY,
                                           GraphicsPrimitive* primitive) const;
        
        void convertObsoleteLineWidthPixelsToPercentageWidth(const Annotation* annotation) const;
        
        float getLineWidthFromPercentageHeight(const float percentageHeight) const;
        
        float getLineWidthPercentageInSelectionMode(const Annotation* annotation) const;
        
        float estimateColorBarWidth(const AnnotationColorBar* colorBar,
                                    const float textHeightInPixels) const;
        
        void getSurfaceNormalVector(const Surface* surfaceDisplayed,
                                    const int32_t vertexIndex,
                                    float normalVectorOut[3]) const;
        
        bool isBackFacing(const float xyz[3],
                          const float normal[3]) const;
        
        float computePolySizeHandleDiameter(const GraphicsPrimitive* primitive) const;
        
        float getLineWidthMultiplierForAnnotationBeingDrawn(const Annotation* annotation) const;
        
        float getDotsPerInch() const;
        
        BrainOpenGLFixedPipeline* m_brainOpenGLFixedPipeline;
        
        Inputs* m_inputs;
        
        float m_surfaceViewScaling;
        
        bool m_displaySampleNamesFlag = false;
        
        /**
         * Dummy annotation file is used for annotations that 
         * do not belong to a file.  This includes the 
         * "annotation being drawn" and AnnotationColorBar's.
         */
        AnnotationFile* m_dummyAnnotationFile;
        
        Annotation* m_annotationBeingDrawn = NULL;
        
        float m_annotationBeingDrawnViewportHeight = 0.0;
        
        bool m_annotationBeingDrawnIsSelectableFlag = false;
        
        /** Tracks items drawn for selection */
        std::vector<SelectionInfo> m_selectionInfo;
        
        /** In selection mode */
        bool m_selectionModeFlag;
        
        /** OpenGL Model Matrix */
        GLdouble m_modelSpaceModelMatrix[16];
        
        /** OpenGL Projection Matrix */
        GLdouble m_modelSpaceProjectionMatrix[16];
        
        /** OpenGL Viewport */
        GLint m_modelSpaceViewport[4];
        
        /** volume space plane initialized to an invalid plane */
        Plane m_volumeSpacePlane = Plane();
        
        /** histology slice plane initialized to invalid plane */
        Plane m_histologySpacePlane = Plane();
        
        /** Thickness of volume slice when drawing annotations on volume slices */
        float m_volumeSliceThickness = 0.0;
        
        /** Histology slice used when stereotaxic annotations are drawn on histology slice*/
        const HistologySlice* m_histologySlice = NULL;
        
        /** Validity of histology space plane */
        bool m_histologySpacePlaneValid = false;;
        
        /** Thickness of histology slice when drawing annotations on histology slices */
        float m_histologySliceThickness = 0.0;
        
        /** Color for selection box and sizing handles */
        uint8_t m_foregroundRGBA[4];
        
        /** Background color */
        uint8_t m_backgroundRGBA[4];
        
        float m_lineWidthMinimum = 1.0f;
        
        BrainOpenGLTextRenderInterface::DrawingFlags m_textDrawingFlags;
        
        std::unique_ptr<EventOpenGLObjectToWindowTransform> m_transformEvent;
        
        mutable float m_dotsPerInch = -1.0;
        
        mutable bool m_triedToGetDotsPerInchFlag = false;
        
        static const float s_sizingHandleLineWidthInPixels;
        static const float s_selectionLineMinimumPixelWidth;
        static const float s_polyCoordLastSizeHandleScaleFactor;
        
        // ADD_NEW_MEMBERS_HERE

    };
    
#ifdef __BRAIN_OPEN_G_L_ANNOTATION_DRAWING_FIXED_PIPELINE_DECLARE__
    const float BrainOpenGLAnnotationDrawingFixedPipeline::s_sizingHandleLineWidthInPixels  = 2.0f;
    const float BrainOpenGLAnnotationDrawingFixedPipeline::s_selectionLineMinimumPixelWidth = 5.0f;
    const float BrainOpenGLAnnotationDrawingFixedPipeline::s_polyCoordLastSizeHandleScaleFactor = 1.5f;
#endif // __BRAIN_OPEN_G_L_ANNOTATION_DRAWING_FIXED_PIPELINE_DECLARE__

} // namespace
#endif  //__BRAIN_OPEN_G_L_ANNOTATION_DRAWING_FIXED_PIPELINE_H__
