GLDriverQt.h

//
//###########################################################################
//                            GLDriverQt.h
//###########################################################################
// 
//                  HEADER FILE FOR CLASS GLDriverQt        
//
//###########################################################################
//
//###########################################################################
//
// 
#include <QtOpenGL>

#include "ucdriverex.h"

class GLDisplayListWidget;

#ifndef __GLDriverQtQt__
#define __GLDriverQtQt__


#define ENSUREMINMAX(A,B,MIN,MAX) MIN = (A < B) ? A : B;MAX = (A < B) ? B : A
#define SETSCALE(MIN,MAX,SCALEVAR) SCALEVAR = MAX-MIN

/*! 
    \class GLDriverQt
        \brief This class is implements a UCdriver (and UCdriverEx) 
    interface to a GLDisplayListWidget class instance. It manages an openGL
    display list (this is a GL thing) that is then displayed on 
    each repaint pass by the associated GLDisplayListWidget.
    <p>
    A GLDriverQt class instance is contained within an 
    GLDisplayListWidget and  therefore access to the UCdriver (UCdriverEx) 
    interface is made through a pointer to this instance. Since GLdriverQt is 
    derived from UCdriverEx (and hence UCdriver) the pointer to the contained
    GLDriverQt can be passed to any routines written in terms of UCdriverEx 
    (or UCdriver) and the results of those routines will be displayed in 
    the GLDisplayListWidget child window. 

    Sample Code Fragment:
\code
//   Instantiate a GLDisplayListWidget in the containing window constructor 

     glWidget = new GLDisplayListWidget;     

//
//   Elsewhere in containing window class (typically in a response function)
//   capture the GLDriverQt pointer. 
//
     GLDriverQt* Gldriver = glWidget->getGLDriverQtPtr(); 

//   Use the  start() to open up a GL display list and then create
//   graphics by calling UCdriver or UCdriverEx methods. Close
//   the list and induce a repaint of glWidget by calling frame(). 

     Gldriver->start();
     
     Gldriver->point(...);          //           
     Gldriver->lines(...);          // UCdriver or UCdriverEx calls
     Gldriver->pointEx(...);        //

     Gldriver->frame();
 
\endcode
    
<i>Source</i>: 
<A HREF="../GLDriverQt.h">GLDriverQt.h</A>, 
<A HREF="../GLDriverQt.cpp">GLDriverQt.cpp</A><p>

@author Chris Anderson (C) UCLA 2007-09 
@version 2/16/09 
*/

class GLDriverQt : public UCdriverEx  
{

public:

        GLDriverQt(int DisplayList);
        GLDriverQt();

    GLuint getDisplayList(){return displayListIndex;};
        virtual ~GLDriverQt();


/** 
Starts a new frame (or plot). 
*/
    void start();
/** 
Clears the current plot. 
*/
    void clearFrame();
    
private :

        /// the associated GLDisplayListWidget
        
    GLDisplayListWidget* m_glWnd;
    
    /// the display list index 
    
    GLuint displayListIndex;
        
    /// currently not used. originally destined for use with the text output functions
        unsigned int textBase;
        
        ///define the current alpha level
        double m_dAlpha;

        ///define the range of the X axis
        double m_dXMin,m_dXMax;double m_dXScale;

        ///define the range of the Y axis
        double m_dYMin,m_dYMax;double m_dYScale;

        ///define the range of the Z axis
        double m_dZMin,m_dZMax;double m_dZScale;

        ///normalize an x coordinate
        inline double NORMX(double x) { return (x*m_dXScale)+m_dXMin; }

        ///normalize a y coordinate
        inline double NORMY(double y) { return (y*m_dYScale)+m_dYMin; }

        ///normalize a z coordinate
        inline double NORMZ(double z) { return (z*m_dZScale)+m_dZMin; }

        /** Set the color according to the rules defined by UCdriver.
                WARNING: There is no sanity checking for the value of the RGB
                array if the USER_RGB option is used.

                @param color the UCdriver defined color
                @param RGB      an array of 3 double values that define an RGB color.
        */
        inline void SetColor(unsigned int color,double* RGB);
        /** Set the line stippling to correspond with the values in UCdriver.
                User defined patterns are currently unsupported.

                @param stipple the stipple pattern to use
                @param user_pattern the user defined stipple pattern. Currently not supported
        */
        inline void SetStipple(unsigned int stipple,unsigned int user_pattern);

/** 
Opens up a new GL list for capturing plotting commands.. 
*/
        void OpenList();
/** 
Closes the current GL list. 
*/
        void CloseList();
/**
Deletes the elements of the input display list. 
*/
    void DeleteList();


//UCdriver
public:
        
        virtual void line(double x1,double y1, double x2,double y2, int dash_pattern,
                      unsigned int user_pattern, double width, int color,double *RGB);
        
        
        virtual void lines(double* X,double* Y,long npoints, int dash_pattern,
                       unsigned int user_pattern,double width,int color,double* RGB);
        
    
        virtual void point(double x,double y, char chr,const char *font,double size, int color,
    double *RGB);

        virtual void points(double *X,double *Y,long npoints, char chr,const char* font,double dsize,
                                int color,double *RGB);

        virtual void text(
                double x,double y,const char* s,const char* font,double size,double rotation,
                double horiz_just,double vert_just,
                int color,double *RGB);

/**  Not implemented for GLDriverQt */

    virtual void region(double *X, double *Y, long npoints, double *RGB) 
        {
        return;
        // Currently ignored parameters //
        X       = 0;
        Y       = 0;
        npoints = 0;
        RGB     = 0;
        //////////////////////////////////
        };

        virtual void frame(); 

//UCdriverEx

public:

        virtual double alphaEx(double alpha=1.0)
        {
                double old = m_dAlpha;
                m_dAlpha = alpha;
                return old;
        }

        virtual void lineEx(
                double x1,double y1,
                double x2,double y2,
                int dash_pattern,unsigned int user_pattern,
                double width,
                int color,double *RGB);

        virtual void lineEx(
                double x1,double y1,double z1,
                double x2,double y2,double z2,
                int dash_pattern,unsigned int user_pattern,
                double width,
                int color,double *RGB);

        virtual void linesEx(
                double* X,double* Y,long npoints,
                int dash_pattern,unsigned int user_pattern,
                double width,int color,double* RGB);

        virtual void linesEx(
                double* X,double* Y,double* Z,long npoints,
                int dash_pattern,unsigned int user_pattern,
                double width,int color,double* RGB);

        virtual void textEx(double x,double y,double z, double nx, double ny, double nz, 
                const char* s,const char* font, double size, double rotation, double horiz_just, 
        double vert_just, int color,double *RGB);

        virtual void pointEx(
                double x,double y,
                char chr,const char* font,double size,
                int color,double* RGB);

        virtual void pointEx(double x,double y,double z,char chr,const char* font,
    double size, int color,double* RGB);

    protected : 

    void plotHText(double x, double y, const char *s, const char *font, double size, 
    double rotation, double horiz_just, double vert_just, int color, double *rgb);

    void plotHText(double x, double y, double z,
    double nx, double ny, double nz, const char *s, const char *font, double size, 
    double rotation, double horiz_just, double vert_just, int color, double *rgb);
    
    public :
    
// GLDisplayListWidget  helper 

/** 
Associates a GLDisplayListWidget parent object with the driver. 
*/
        void SetGLDisplayListWidget(GLDisplayListWidget* a);
};

#endif 

---