SeriesRenderer.h

Go to the documentation of this file.

//=======================================================================
//  Filename:       SeriesRenderer.h
//  Date:           2008-10-06
//  Authors:        Bing Huang, Liang Liu

//  Copyright (C) 1997-2008 MicroStrategy Incorporated
//  All rights reserved
//=======================================================================

#ifndef MsiChart_SeriesRenderer_h
#define MsiChart_SeriesRenderer_h

#include "PDCHeader/PDCset"

#include "GraphCollectionObject.h"
#include "GraphObjectManager.h"
#include "Legend.h"
#include "TrendLineObject.h"
#include "Plot.h"
#include "Vector2D.h"
#include "TextObject.h"
#include "PiePlotRenderer.h"

namespace MsiChart
{
    //enumerations and structs
        
    struct SeriesInfo
    {
        SeriesInfo(Int32 iSeriesId, Int32 iSeriesIndex, Int32 iDataIndex, EnumValueAxis iValueAxis)
            : mSeriesId(iSeriesId),
            mSeriesIndex(iSeriesIndex),
            mDataIndex(iDataIndex),
            mValueAxis(iValueAxis)
        {}

        Int32 mSeriesId;
        Int32 mSeriesIndex;
        Int32 mDataIndex;
        EnumValueAxis mValueAxis;
        
    };
    
    //pre-declarations
    class ABLPlot;
    struct ABLPlotContext;

    class SeriesRenderer : public GraphObjectManager
    {
    public:
        typedef MSynch::SmartPtr<SeriesRenderer> Ptr;

        SeriesRenderer(const TripleId& irTripleId, GraphObjectManager* ipManager, Dataset::Ptr iDatasetPtr, Legend::Ptr iLegendPtr);
        
        virtual void GetOptions(Int32 iSeriesId, Int32 iPropertyId, CComVariant* opValue) const;

        virtual bool GetToolTipData(Int32 iSeriesID, Int32 iGroupID, double& orValue, double& orPercentValue, Int32 iOffset = 0);

        virtual void GenerateByValueAxis(EnumValueAxis iValueAxis, std::vector<GraphObject::Ptr>& iorGraphObjectList) = 0;

        void AddSeries(Int32 iSeriesId, Int32 iSeriesIndex, Int32 iDataIndex, EnumValueAxis iValueAxis);
        
        void UpdateCumulateData(EnumValueAxis iValueAxis);
        void GetCumulateData(EnumValueAxis iValueAxis, std::vector<double>& iorCumulatedValue);
        
        void AddBaseToCumulateData(EnumValueAxis iValueAxis, double iBaseValue);

        void GetMinMaxValue(EnumValueAxis iValueAxis, double& iorMin, double& iorMax, bool& iorAreInitialized, Int32 iValueAxisDirection = 1);

        virtual void SetDeviceDataArea(const Rect2D& irDeviceDataArea); 

        virtual void AddTextToMapAndList(std::map<TripleId, GraphObject::Ptr>& iorGraphObjectMap, std::vector<GraphObject::Ptr>& iorGraphObjectList);

        void MoveLabel(Int32 iGroupId, TextObject::Ptr iTextObjectPtr, const Point2D& irMax, const Point2D& irMin, Int32 iInfoIndex);
        
        virtual void UpdateGroupStackInfoWithBase(double& orBaseValue,double& orOffsetValue,EnumValueAxis iValueIndex,Int32 iSeriseID,Int32 iGroupID,double iAxisOriginValue);
        virtual void AddObjectsToDataLabelManager(DataLabelManager::Ptr iDataLabelManagerPtr);
        
        void GetReferenceLineData(int iSeriesID, int iGroupID, std::string &orRefLineType, int& orMetricIndex, std::string &orValue);
        void hCreateDataMarkerForDataLabel(bool iOnlyForDisplayedDataLable = true);
    protected:
        Int32 GetIndexFromSeriesId(Int32 iSeriesId) const;

        bool GetTrendlLinePoint(Int32 iInfoIndex, Int32 iGroupId, Point<double>& orPoint) const;

        bool GetData(Int32 iInfoIndex, Int32 iGroupId, double& orValue, bool iPreValue = false, Int32 iDataGroup = 0) const;

        void hGetAccompanyPoints(bool iIsVertical, const Point2D& irBasePoint, double lOffset, Point2D& orLowPoint, Point2D& orHighPoint);
        
        void CreateAllSeriesTrendLines();
        
        void CreateRefLines();

        TextObject::Ptr hCreateRefLineLable(Int32 iSeriesInfo, Int32 iRefLineIndex);
        
        void CreateGMSeriesTrendLines();
        std::vector<Point2D> hProcessPointsForTrendline(const std::vector<Point2D>& irPoints);
        bool hCalcTrendLinePoint(Point2D& iorPoint, Int32 iInfoIndex, Int32 iGroupId, double lValue);
        
        void CreateTrendLine(Int32 iInfoIndex, std::vector<double>& irCategory, std::vector<double>& irValue);

        void AddLegendMarkerToCollection(Int32 iSeriesIndex, GraphCollectionObject* ipRiserCollection, bool iIsLineCollection = false, bool iIsShownMarker = true, unsigned char iMarkerShape = 1, bool iIsShownLine = true);

        bool IsReverseSeriesOrder(EnumValueAxis iValueAxisIndex);

        bool IsReverseGroupOrder();

        bool PriorToNextSeries(const TVector2D<Int32>& iSideDirection, Int32 iGroupId);


        TextObject::Ptr CreateRiserLabel(const Int32 iInfoIndex, const Int32 iGroupId, GraphCollectionObject::Ptr iTextCollectionPtr);

        
        void CreateMarkerForDataLabel(Int32 iInfoIndex, Int32 iGroupId, GraphCollectionObject::Ptr iMarkerCollectionPtr, Point2D& irCenterPoint, bool isAreaChart);
        TextObject::Ptr hCreateDataLabelForGraphMatrix(const Int32 iSeriesId, const Int32 iGroupId,const double &irValue, GraphCollectionObject *ipCollection);
        bool hIsUseCustomMinMax(const EnumValueAxis iValueAxis);
        bool hIsDataLabelInDataArea(const Rect2D& iDLRect);
        
        TextObject::Ptr CreateTotalLabel(const EnumValueAxis iValueAxis, const Int32 iGroupId, GraphCollectionObject::Ptr iTotalCollectionPtr);

        const Int32 GetUpmostIndexByValueAxisAndGroup(const EnumValueAxis iValueAxis, const Int32 iGroupId) const;
        
        Rect2D mDeviceDataArea;
        ABLPlot* mpABLPlot;
        Int32 mGroupCount;
        Int32 mSeriesCount;
        Dataset::Ptr mDatasetPtr;
        Legend::Ptr mLegendPtr;
        std::vector<SeriesInfo> mSeriesInfo;
        //data for Y1 and Y2, cumulate or not
        std::vector<double> mCumulateData[2];
        //series count for each axis
        Int32 mSeriesNumber[2];
        //for text collection
        std::vector<GraphCollectionObject::Ptr> mTextCollection;
        std::vector<TrendLineObject::Ptr> mTrendLineObjects;
        std::vector<TextObject::Ptr> mTrendLineTextObjects;

        // The following data members are added for access convenience. These data members are used frequently in renderers.
        ABLPlotContext* mpABLPlotContext;
        bool mIsVertical;
        bool mUseDepth;
        //Indicate whether the renderer has negative value
        //Tt will be initialized in UpdateCumulateData() since it is used in Stacked/Percent Depth Chart only
        bool mHasNegativeValue;
        Int32 mDepth;
        Int32 mDepthDirection;
        Int32 mStartLevel;          

        //For Graph Matrix.
        mutable std::map<Int32, Int32> mGroupIdMapPerSeries;                 //<the current map for current continus section.   
        Int32 hGetCorrectGroupIdInSeriesPoints(Int32 iIndex, Int32 iCandidate) const;
        GraphObject::Ptr hDrawSingleShape(const TripleId& irTripleId, const Point2D& irPoint, bool iIsLineAsDots = false);
        
        // GM Combination Support
        Int32 hConvertCEShapeToGMShape(Int32 iSeriesType);
        
        std::vector<GraphObject::Ptr > hDrawSingleDataPoint(const TripleId& irTripleId, Int32 iSeriesInfo, const Point2D& irPoint, bool iIsLineAsDots = false);
        Point2D hGetPieCenter(Int32 iGroupId, Int32 iSeriesId, Int32 iAngleIndex);
        bool hGetGMPiePositon(Point2D& orCood, Int32 iInfoIndex, double iXInput, double iYInput, Int32 iXSubIndex, Int32 iYSubIndex, Int32 iXSectionCount, Int32 iYSectionCount);
        Int32 hInitMaxPieRadius();
        std::map<TripleId, Point2D> mPieCentersPool;
    
        PiePlotRenderer::Ptr mPieRender;

        
    private:
        double hGetCumulateData(EnumValueAxis iValueAxis, Int32 iDataIndex, Int32 iGroupId) const;
        //void hUpdateTrendLineFormatLine(TrendLineObject::Ptr iTrendLinePtr);
    };
}

#endif