ChartCanvas.h

Go to the documentation of this file.

//==============================================================================================
//  FILENAME    :   ChartCanvas.h
//  AUTHOR      :   Xinpan Xiao
//  CREATION    :   2010-11-12
//  Copyright (C) MicroStrategy Incorporated 2010
//  All Rights Reserved
//==============================================================================================
#ifndef MsiChart_ChartCanvas_h
#define MsiChart_ChartCanvas_h 

#include "StdAfx.h"
#include "PDCHeader/PDCvector"
#include "Base/Base/BaseString.h"
#include "FormatFill.h"
#include "FormatLine.h"
#include "FormatFont.h"


namespace MsiChart
{
#ifndef _VE_CE
    enum EnumLineJoinType
    {
        LJT_MITER = 0,
        LJT_BEVEL = 1,
        LJT_ROUND = 2,
    };
#endif
    class ChartContext;
    class RGBColor;

    class ChartCanvas
    {
    public:
        ChartCanvas();
        ChartCanvas(ChartContext *ipContext);
        virtual ~ChartCanvas();

        virtual bool SaveToString(std::string& orGraphDesc) = 0;
#ifdef _VE_CE

        virtual bool SaveToVEObjects(std::vector<MVE::VEFormatList>& ioFormatList, std::vector<MVE::VEUnitList>& ioUnitList) = 0;
#endif

        virtual void SaveState() = 0;
        
        virtual void RestoreState() = 0;
        
        virtual void Clip() = 0;
        
        virtual void Scale(const double iX, const double iY) = 0;
        
        virtual void Rotate(const Point2D& irAnchor, double iRadian) = 0;

        virtual void NewPath() = 0;
        
        virtual void ClosePath() = 0;
        
        virtual void MoveTo(double iX, double iY, bool iIsCurveAnimation = false, FPoint2D* iBasePoint = NULL) = 0;

        virtual void LineTo(double iX, double iY, bool iIsCurveAnimation = false, FPoint2D* iBasePoint = NULL) = 0;

        virtual void BezierCurveTo(double iCP1X, double iCP1Y, double iCP2X, double iCP2Y, double iX, double iY) = 0;

        virtual void AddRect(float iX, float iY, float iW, float iH) = 0;

        virtual void AddArc(float iX, float iY, float iRadius, float iStartAngle, float iEndAngle, bool bAntiClockwise) = 0;

        virtual void AddNeedle(char iNeedleStyle, Point2D iBasePoint, short iAngle, float iSize) = 0;
        
        virtual void AddString(const Point2D& irPoint, const char* ipString) = 0;

        virtual void SetLineDash(double* ipLinePattern, short iDashNumber) = 0;
        
        virtual void SetLineWidth(double iLineWidth) = 0;

        virtual void SetFontSize(short iFontSize) = 0;

        virtual void SetLineJoin(EnumLineJoinType iLineJoinType) = 0;

        virtual void SetRGBAFillColor(float iRed, float iGreen, float iBlue, float iAlpha) = 0;

        virtual void SetRGBAStrokeColor(float iRed, float iGreen, float iBlue, float iAlpha) = 0;

        virtual void FillPath() = 0;

        virtual void StrokePath() = 0;

        virtual void FillSimple(const FormatFill* ipFill, float iDarkerFactor, RGBColor* iColor = NULL, bool iHasExtraPara = false) = 0;

        virtual void FillPattern(const FormatFill* ipFill) = 0;

        virtual void FillGradient(const FormatFill* ipFill, const Rect2D& irBoundingRect, float iDarkerFactor) = 0;

        virtual void FillEdgeType(const FormatFill* ipFill, const std::vector<Point2D>& irPolygon) = 0;
        
        virtual void FillRadientGradient(const FormatFill* ipFill, EnumRadientGradientUsage iRGUsage, double iCPX, double iCPY, double iInnerRadius, double iOuterRadius, bool iHasExtraPara = false, int iExtraDepth = 0, int iExtraIntensity = 0) = 0;
        
        virtual void FillBorderMetallic(const FormatFill* ipFill, short iBorderUse, double iCPX, double iCPY, double iRadius, double iThickness) = 0;

        virtual void FillDonutOrSphere(const FormatFill* ipFill, const Rect2D& irBoundingRect, bool iIsCircularShape) = 0;
        
        virtual void MakeDarker(const FormatFill* ipFill, float iFactor) = 0;
        
        virtual void RestoreColor(const FormatFill* ipFill) = 0;
        
        virtual void ApplyLineFormat(const FormatLine* ipLine) = 0;
        
        virtual void AddFormatedText(const FormatFont* ipFont, const Point2D& irStartPoint, const std::string& irText) = 0;
        
        virtual void ApplyBeveledFrameToRectangle(const Rect2D& irRect, double iRotationAngle, short iBevelDepth, 
                                                  const RGBColor& irLTColor, short iLTAlpha, 
                                                  const RGBColor& irRBColor, short iRBAlpha) = 0;
        
        //Draw gauge marker
        virtual void DrawGaugeMarker(FPoint2D* iBasePoint, Int32& iMarkerSize, Int32& iMarkerShape, float iAngle, short iNeedSize) = 0;

        // fill donut to rectangle
        virtual void ApplyDonutToRect(const Point<double>& irStartPoint, const Point<double>& irEndPoint, const FormatFill* ipFill) = 0;

        virtual void BeginFirstFrame() = 0;
        
        virtual void BeginLastFrame() = 0;
        
        virtual void EndFrame() = 0;

        virtual void EndUnit() = 0;

        virtual void SetContext(ChartContext *ipContext);
        
        virtual ChartContext* GetContext();
        
#ifndef _VE_CE
        virtual CGPoint GetCurrentPoint();
#endif

    protected:
        ChartContext *mpContext;
    };
}
#endif //MsiChart_ChartCanvas_h