VGDevice.h

Go to the documentation of this file.

#ifndef VGDevice_H
#define VGDevice_H

/*
  GUIDO Library
  Copyright (C) 2003--2006  Grame

  This Source Code Form is subject to the terms of the Mozilla Public
  License, v. 2.0. If a copy of the MPL was not distributed with this
  file, You can obtain one at http://mozilla.org/MPL/2.0/.

  Grame Research Laboratory, 11, cours de Verdun Gensoul 69002 Lyon - France
  research@grame.fr

*/

#include "VGColor.h"

class VGFont;
class VGSystem;

// --------------------------------------------------------------
//      VGDevice class
// --------------------------------------------------------------
class VGDevice
{

    friend class VGFont;    //to use GetNativeContext()
    friend class DecoratorDevice;

    public:

                enum VRasterOpMode {
                        kUnknown        = 0,    // unknown mode, use default
                        kOpCopy         = 1,    // direct copy
                        kOpAnd          = 2,    // AND
                        kOpXOr          = 4,    // XOR = src invert
                        kOpInvert       = 8,    // dest invert
                        kOpOr           = 16    // OR
                };

                enum VTextAlignMode {
                        kAlignBase      = 1,
                        kAlignBottom    = 2,
                        kAlignTop       = 4,
                        kAlignCenter    = 8,
                        kAlignLeft      = 16,
                        kAlignRight     = 32,
                        kAlignBaseLeft  = kAlignLeft | kAlignBase
                };

        virtual                 ~VGDevice() {}

        virtual bool            IsValid() const = 0;


        // - Drawing services ------------------------------------------------

        virtual bool            BeginDraw() = 0;

        virtual void            EndDraw() = 0;

        virtual void            InvalidateRect( float left, float top,
                                       float right, float bottom ) = 0;

                    // - Standard graphic primitives -------------------------

        virtual void            MoveTo( float x, float y ) = 0;

        virtual void            LineTo( float x, float y ) = 0;

        virtual void            Line( float x1, float y1,
                                      float x2, float y2 ) = 0;

        virtual void            Frame( float left, float top,
                                       float right, float bottom ) = 0;

        virtual void            Arc( float left,   float top,
                                     float right,  float bottom,
                                     float startX, float startY,
                                     float endX,   float endY ) = 0;

                    // - Filled surfaces --------------------------------------
                    // The raster op mode for color filling should be specified
                    // with SetRasterOpMode() before using one of these.

        virtual void            Triangle( float x1, float y1,
                                          float x2, float y2,
                                          float x3, float y3 ) = 0;

        virtual void            Polygon( const float * xCoords,
                                         const float * yCoords, int count ) = 0;

        virtual void            Rectangle( float left,  float top,
                                           float right, float bottom ) = 0;

        // - Font services ---------------------------------------------------

        virtual void            SetMusicFont( const VGFont * font ) = 0;

        virtual const VGFont *  GetMusicFont() const = 0;

        virtual void            SetTextFont( const VGFont * font ) = 0;

        virtual const VGFont *  GetTextFont() const = 0;

        virtual void            selectfont(int) {};


        // - Pen & brush services --------------------------------------------

        virtual void            SelectPen( const VGColor & inColor,
                                           float witdh ) = 0;

        virtual void            SelectFillColor( const VGColor & c ) = 0;

        virtual void            PushPen( const VGColor & inColor,
                                         float inWidth ) = 0;

        virtual void            PopPen() = 0;

        virtual void            PushFillColor( const VGColor & inColor ) = 0;

        virtual void            PopFillColor() = 0;

        virtual void            SetRasterOpMode( VRasterOpMode ROpMode) = 0;

        virtual VRasterOpMode   GetRasterOpMode() const = 0;


        // - Bitmap services (bit-block copy methods) --------------------------

        virtual bool            CopyPixels( VGDevice* pSrcDC, float alpha = -1.0) = 0;

        virtual bool            CopyPixels( int xDest, int yDest,
                                            VGDevice* pSrcDC,
                                            int xSrc, int ySrc,
                                            int nSrcWidth, int nSrcHeight, float alpha = -1.0) = 0;

        // only for \DrHoos and \DrRenz
        virtual bool            CopyPixels( int xDest, int yDest,
                                            int dstWidth, int dstHeight,
                                            VGDevice* pSrcDC, float alpha = -1.0) = 0;

        virtual bool            CopyPixels( int xDest, int yDest,
                                            int dstWidth, int dstHeight,
                                            VGDevice* pSrcDC,
                                            int xSrc, int ySrc,
                                            int nSrcWidth, int nSrcHeight, float alpha = -1.0) = 0;

        // - Coordinate services ------------------------------------------------

        virtual void            SetScale( float x, float y ) = 0;

        virtual void            SetOrigin( float x, float y ) = 0;

        virtual void            OffsetOrigin( float x, float y ) = 0;

        virtual void            LogicalToDevice( float * x, float * y ) const = 0;

        virtual void            DeviceToLogical( float * x, float * y ) const = 0;

        virtual float           GetXScale() const = 0;
        virtual float           GetYScale() const = 0;
        virtual float           GetXOrigin() const = 0;
        virtual float           GetYOrigin() const = 0;

        virtual void            NotifySize( int inWidth, int inHeight ) = 0;

        virtual int             GetWidth() const = 0;

        virtual int             GetHeight() const = 0;


        // - Text and music symbols services -------------------------------------

        virtual void            DrawMusicSymbol(float x, float y,
                                                unsigned int inSymbolID ) = 0;

        virtual void            DrawString( float x, float y,
                                            const char * s,
                                            int inCharCount ) = 0;

        virtual void            SetFontColor( const VGColor & inColor ) = 0;

        virtual VGColor         GetFontColor() const = 0;

        virtual void            SetFontBackgroundColor( const VGColor & inColor ) = 0;

        virtual VGColor         GetFontBackgroundColor() const = 0;

        virtual void            SetFontAlign( unsigned int inAlign ) = 0;

        virtual unsigned int    GetFontAlign() const = 0;

        // - Printer informations services ----------------------------------------

        virtual void            SetDPITag( float inDPI ) = 0;
        virtual float           GetDPITag() const = 0;

        virtual void*           GetBitMapPixels() = 0;
        virtual void            ReleaseBitMapPixels() = 0;

        virtual const char*     GetImageData(const char* & outDataPtr, int& outLength) = 0;
        virtual void            ReleaseImageData(const char *) const = 0;

        virtual VGSystem *      getVGSystem() const = 0;

        // - Data export services ----------------------------------------
//      virtual void            ExportToFile( const char * inFilePath ) = 0;


        virtual void *          GetNativeContext() const = 0;


    public:

        // - VGDevice extension --------------------------------------------
        virtual void            SelectPenColor( const VGColor & inColor) = 0;
        
        virtual void            SelectPenWidth( float witdh) = 0;

        virtual void            PushPenColor( const VGColor & inColor) = 0;
        virtual void            PopPenColor() = 0;
        
        virtual void            PushPenWidth( float width) = 0;
        virtual void            PopPenWidth() = 0;

};

#endif